# ssb-bendy-butt

> A boring butt feed format for meta feeds in SSB

Latest version **1.0.2** (published 2022-11-03) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install ssb-bendy-butt
pnpm add ssb-bendy-butt
yarn add ssb-bendy-butt
bun add ssb-bendy-butt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-11-03 |
| First published | 2021-06-15 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 35 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Anders Rune Jensen |
| Maintainers | staltz, arj03, mycognosist |

## Links

- npm: https://www.npmjs.com/package/ssb-bendy-butt
- Repository: https://github.com/ssb-ngi-pointer/ssb-bendy-butt
- Issues: https://github.com/ssb-ngi-pointer/ssb-bendy-butt/issues
- npm.io page: https://npm.io/package/ssb-bendy-butt

## Dependencies (4)

- [bencode](https://npm.io/package/bencode.md) ^2.0.1
- [ssb-bfe](https://npm.io/package/ssb-bfe.md) ^3.3.0
- [ssb-keys](https://npm.io/package/ssb-keys.md) ^8.4.0
- [ssb-uri2](https://npm.io/package/ssb-uri2.md) ^2.0.0

## Recent versions

- 1.0.2 (latest) — 2022-11-03
- 1.0.1 — 2022-07-14
- 1.0.0 — 2022-06-18
- 0.12.5 — 2022-02-28
- 0.12.4 — 2021-10-08
- 0.12.3 — 2021-09-08
- 0.12.2 — 2021-09-03
- 0.12.1 — 2021-08-31
- 0.12.0 — 2021-08-23
- 0.11.0 — 2021-08-13
- 0.10.0 — 2021-07-26
- 0.9.0 — 2021-07-20
- 0.8.0 — 2021-07-16
- 0.7.0 — 2021-07-15
- 0.6.0 — 2021-07-13
- … 5 more at https://npm.io/package/ssb-bendy-butt/versions

## README

<!--
SPDX-FileCopyrightText: 2021 Anders Rune Jensen

SPDX-License-Identifier: CC0-1.0
-->

# SSB Bendy Butt

Implementation of [bendy butt] in JS.

You can use this module as an ssb-db2 plugin, or you can use it as a standalone tool to generate and validate bendybutt messages.

## Installation

```bash
npm install ssb-bendy-butt
```

Requires Node.js 12 or higher.

## Usage in ssb-db2

- Requires **Node.js 12** or higher
- Requires `secret-stack@^6.2.0`
- Requires `ssb-db2@>=5.0.0`

```diff
 SecretStack({appKey: require('ssb-caps').shs})
   .use(require('ssb-master'))
+  .use(require('ssb-db2'))
+  .use(require('ssb-bendy-butt'))
   .use(require('ssb-conn'))
   .use(require('ssb-blobs'))
   .call(null, config)
```

Now you can call ssb-db2's `create(opts)` API providing `opts.feedFormat` as `"bendybutt-v1"`.

## Usage as a standalone

Notice you import the `/format` from the module.

```js
const ssbKeys = require('ssb-keys');
const bendyButtFormat = require('ssb-bendy-butt/format');

const msgVal = bendyButtFormat.newNativeMsg({
  keys: ssbKeys.generate(null, null, 'bendybutt-v1'),
  content: {
    type: 'post',
    text: 'Hello, world!',
  },
  timestamp: Date.now(),
  previous: null,
  hmacKey: null,
});
```

This module conforms with [ssb-feed-format](https://github.com/ssbc/ssb-feed-format) so with ssb-bendy-butt you can use all the methods specified by ssb-feed-format.

[bendy butt]: https://github.com/ssb-ngi-pointer/bendy-butt-spec

---
_Source: https://npm.io/package/ssb-bendy-butt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._