@libp2p/peer-id-factory

@libp2p/peer-id-factory

Create PeerId instances

Table of contents

• Install
  • Browser <script> tag
• Description
• Example
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/peer-id-factory

Browser <script> tag

Loading this module through a script tag will make it's exports available as Libp2pPeerIdFactory in the global namespace.

<script src="https://unpkg.com/@libp2p/peer-id-factory/dist/index.min.js"></script>

Description

Generate, import, and export PeerIDs, for use with IPFS.

A Peer ID is the SHA-256 multihash of a public key.

The public key is a base64 encoded string of a protobuf containing an RSA DER buffer. This uses a node buffer to pass the base64 encoded public key protobuf to the multihash for ID generation.

Example

import { createEd25519PeerId } from '@libp2p/peer-id-factory'

const peerId = await createEd25519PeerId()
console.log(id.toString())

12D3KooWRm8J3iL796zPFi2EtGGtUJn58AG67gcqzMFHZnnsTzqD

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_peer_id_factory.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.