/orbitdb-orbit-crypto

Crypto primitives for Orbit

Primary LanguageJavaScriptMIT LicenseMIT

orbitdb-orbit-crypto

Gitter npm version

Crypto primitives for Orbit

Install

This project uses npm and nodejs.

$ npm install orbitdb-orbit-crypto

Usage

const Crypto = require('orbit-crypto')

Static Methods

  • useKeyStore(directory = './')
  • importKeyFromIpfs(ipfs, hash)
  • exportKeyToIpfs(ipfs, key)
  • getKey(id = 'default')
  • generateKey()
  • exportPublicKey(key)
  • exportPrivateKey(key)
  • importPublicKey(key)
  • importPrivateKey(key)
  • sign(key, data)
  • verify(signature, key, data)

Contribute

We would be happy to accept PRs! If you want to work on something, it'd be good to talk beforehand to make sure nobody else is working on it. You can reach us on Gitter, or in the issues section.

We also have regular community calls, which we announce in the issues in the @orbitdb welcome repository. Join us!

For specific guidelines for contributing to this repository, check out the Contributing guide. For more on contributing to OrbitDB in general, take a look at the @OrbitDB welcome repository. Please note that all interactions in @OrbitDB fall under our Code of Conduct.

License

MIT © Protocol Labs Inc, Haja Networks Oy.