@libp2p/config

Helper functions to make dealing with libp2p config easier

About

Utilities to make working with libp2p configuration simpler.

Example - Load or create the "self" private key in a datastore

Most nodes will want to persist the same private key between restarts so this function helps you extract one from a datastore if it exists, otherwise it will create a new one and save it in the keystore.

The options you pass to this function should be the same as those passed to the @libp2p/keychain service you configure your node with.

import { loadOrCreateSelfKey } from '@libp2p/config'
import { keychain } from '@libp2p/keychain'
import { LevelDatastore } from 'datastore-level'
import { createLibp2p } from 'libp2p'

const datastore = new LevelDatastore('/path/to/db')
await datastore.open()

const keychainInit = {
 pass: 'yes-yes-very-secure'
}

const privateKey = await loadOrCreateSelfKey(datastore, keychainInit)

const node = await createLibp2p({
  privateKey,
  datastore,
  services: {
    keychain: keychain(keychainInit)
  }
})
Copy

Install

$ npm i @libp2p/config
Copy

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_config.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.