# ssb-classic

> The original SSB feed format, for ssb-db2

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

## Install

```sh
npm install ssb-classic
pnpm add ssb-classic
yarn add ssb-classic
bun add ssb-classic
```

## 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.1.0 |
| Published | 2022-10-11 |
| First published | 2022-06-15 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 4 |
| Unpacked size | 33.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Andre Staltz |
| Maintainers | staltz |
| Keywords | ssb |

## Links

- npm: https://www.npmjs.com/package/ssb-classic
- Repository: https://github.com/ssbc/ssb-classic
- Homepage: https://github.com/ssbc/ssb-classic#readme
- Issues: https://github.com/ssbc/ssb-classic/issues
- npm.io page: https://npm.io/package/ssb-classic

## Dependencies (4)

- [bipf](https://npm.io/package/bipf.md) ^1.9.0
- [ssb-ref](https://npm.io/package/ssb-ref.md) ^2.16.0
- [ssb-keys](https://npm.io/package/ssb-keys.md) ^8.1.0
- [is-canonical-base64](https://npm.io/package/is-canonical-base64.md) ^1.1.1

## Recent versions

- 1.1.0 (latest) — 2022-10-11
- 1.0.3 — 2022-06-20
- 1.0.2 — 2022-06-17
- 1.0.1 — 2022-06-15
- 1.0.0 — 2022-06-15

## README

<!--
SPDX-FileCopyrightText: 2022 Andre 'Staltz' Medeiros <contact@staltz.com>

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

# ssb-classic

This module is a plugin for ssb-db2 which implements the classic SSB feed format. You can use this module as an ssb-db2 plugin, or you can use it as a standalone tool to generate and validate classic messages.

## Installation

```bash
npm install ssb-classic
```

## Usage in ssb-db2

YOU MOST LIKELY DON'T NEED TO DO THIS, because ssb-db2 bundles ssb-classic already. But maybe one day ssb-db2 won't bundle it anymore, and then you _would_ have to do this.

- 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-classic'))
   .use(require('ssb-conn'))
   .use(require('ssb-blobs'))
   .call(null, config)
```

## Usage as a standalone

```js
const ssbKeys = require('ssb-keys');
const classicFormat = require('ssb-classic');

const msgVal = classicFormat.newNativeMsg({
  keys: ssbKeys.generate(),
  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-classic you can use all the methods specified by ssb-feed-format.

## License

LGPL-3.0-only

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