ipns

IPNS record definitions

About

Implements parsing and serialization of IPNS Records.

Example - Create record

import { createIPNSRecord } from 'ipns'
import { generateKeyPair } from '@libp2p/crypto/keys'

const privateKey = await generateKeyPair('Ed25519')
const value = 'hello world'
const sequenceNumber = 0
const lifetime = 3_600_000 // ms, e.g. one hour

const ipnsRecord = await createIPNSRecord(privateKey, value, sequenceNumber, lifetime)

Example - Validate record against public key

import { validate } from 'ipns/validator'
import { generateKeyPair } from '@libp2p/crypto/keys'

const privateKey = await generateKeyPair('Ed25519')
const publicKey = privateKey.publicKey
const marshalledRecord = Uint8Array.from([0, 1, 2, 3])

await validate(publicKey, marshalledRecord)
// if no error thrown, the record is valid

Example - Validate record against routing key

This is useful when validating IPNS names that use RSA keys, whose public key is embedded in the record (rather than in the routing key as with Ed25519).

import { ipnsValidator } from 'ipns/validator'
import { multihashToIPNSRoutingKey } from 'ipns'
import { generateKeyPair } from '@libp2p/crypto/keys'

const privateKey = await generateKeyPair('Ed25519')
const routingKey = multihashToIPNSRoutingKey(privateKey.publicKey.toMultihash())
const marshalledRecord = Uint8Array.from([0, 1, 2, 3])

await ipnsValidator(routingKey, marshalledRecord)

Example - Extract public key from record

import { extractPublicKeyFromIPNSRecord, createIPNSRecord } from 'ipns'
import { generateKeyPair } from '@libp2p/crypto/keys'

const privateKey = await generateKeyPair('Ed25519')
const record = await createIPNSRecord(privateKey, 'hello world', 0, 3_600_000)

const publicKey = await extractPublicKeyFromIPNSRecord(record)

Example - Marshal data with proto buffer

import { createIPNSRecord, marshalIPNSRecord } from 'ipns'
import { generateKeyPair } from '@libp2p/crypto/keys'

const privateKey = await generateKeyPair('Ed25519')
const record = await createIPNSRecord(privateKey, 'hello world', 0, 3_600_000)
// ...
const marshalledData = marshalIPNSRecord(record)
// ...

Returns the record data serialized.

Example - Unmarshal data from proto buffer

import { unmarshalIPNSRecord } from 'ipns'

const storedData = Uint8Array.from([0, 1, 2, 3, 4])
const ipnsRecord = unmarshalIPNSRecord(storedData)

Returns the IPNSRecord after being deserialized.

Install

$ npm i ipns

Browser <script> tag

Loading this module through a script tag will make its exports available as Ipns in the global namespace.

<script src="https://unpkg.com/ipns/dist/index.min.js"></script>

API Docs

• https://ipfs.github.io/js-ipns

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)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

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.