peer-crdt-ipfs

IPFS network and storage adapter for peer-crdt.

Install

$ npm install ipfs peer-crdt peer-crdt-ipfs

Setup

const IPFS = require('ipfs')
const PeerCRDT = require('peer-crdt')
const PeerCrdtIpfs = require('peer-crdt-ipfs')

// Create an IPFS node
ipfs = new IPFS({
  EXPERIMENTAL: {
    pubsub: true
  },
  config: {
    Addresses: {
      Swarm: [
        '/dns4/ws-star.discovery.libp2p.io/tcp/443/wss/p2p-websocket-star',
        '/dns4/ws-star-signal-2.servep2p.com/tcp/443/wss/p2p-websocket-star'
      ]
    }
  }

})

const signAndEncrypt = async (value) => {
  return await somehowSignAndEncrypt(value)
}

const decryptAndVerify = async (buffer) => {
  return await somehowDecryptAndVerify(buffer)
}

const options = {
  signAndEncrypt,
  decryptAndVerify
}

// Create a peer-crdt-ifps config object:
const peerCrdtIpfs = PeerCrdtIpfs(ipfs)

// Use it to configure peer-crdt
const CRDT = PeerCRDT
  .defaults(peerCrdtIpfs)
  .defaults(options)

// Create and use a CRDT at will
const crdt = CRDT.create(type, id)
// ...

peer-crdt API docs are here

Options

The constructor exposed in peer-crdt-ipfs accepts, as the second argument, an object with the following options (defaults in parenthesis):

• minBroadcastInterval (1000)
• maxBroadcastInterval (5000)
• totalNetworkBroadcastInterval (1000)
• dag - object with:
  • format ('dag-cbor')
  • hashAlg ('sha2-256')
• maxAncestorsBroadcast (10)
• debounceSetHeadMS (500)

License

MIT