y-ipfs-connector
IPFS Connector for Yjs
Use it!
Retrieve this with npm:
$ npm install y-ipfs-connector --save
Example
// you need to create and inject a IPFS objectconst IPFS = const Y = Y // other Yjs deps:YYY // create IPFS nodeconst ipfs = EXPERIMENTAL: pubsub: true // need this to work
Signature
options.sign
You can sign messages. For that, you have to provide a sign
option, which needs to be a function that accepts a message (string) and calls back with a buffer containing the signature for it (string):
Using this, messages will be sent alongside with a signature, which can be validated.
options.verifySignature
You can also verify a signature for a given message by providing a function like this:
options.encode
Optional function that receives the message and encodes it. Useful if you want to encrypt the content before sending.
options { return }
options.decode
Optional function that receives the message and decodes it. Useful if you want to decrypt the content after receiving.
options { return }
Debug
Activate y-ipfs-connector
on debug
to see log messages.
License
MIT
Contribute
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.