https://github.com/ssbc/ssb-private
scuttlebot plugin for indexed private messages
https://github.com/ssbc/ssb-private
Last synced: 11 months ago
JSON representation
scuttlebot plugin for indexed private messages
- Host: GitHub
- URL: https://github.com/ssbc/ssb-private
- Owner: ssbc
- Created: 2017-06-12T01:25:22.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-06-27T05:47:29.000Z (about 6 years ago)
- Last Synced: 2025-07-08T08:22:55.372Z (12 months ago)
- Language: JavaScript
- Size: 31.3 KB
- Stars: 8
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ssb-private
[scuttlebot](http://scuttlebutt.nz/) plugin for indexed private messages.
## Versions
Please note that 0.2.0 requires scuttlebot 11.3
## API
### `private.publish(content, recipients, callback)` (async)
Publish encrypted private messages to one or more recipients. Behaves similar to Scuttlesbot's `publish` method, but also takes an array of recipients (ssb public keys).
### `private.unbox(message)` (sync)
Decrypt a private message using your private key. Returns the decrypted message.
### `read(opts)` (sync)
Returns a stream of private messages. Takes query options similar to [ssb-query](https://github.com/dominictarr/ssb-query).
## License
MIT