Module index

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)
Copy

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
Copy

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)
Copy

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)
Copy

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)
// ...
Copy

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)
Copy

Returns the IPNSRecord after being deserialized.