Interface IPNS

routers

publish

• publish(
      keyName: string,
      value:
          | string
          | CID<unknown, number, number, Version>
          | PeerId
          | PublicKey
          | MultihashDigest<0 | 18>,
      options?: PublishOptions,
  ): Promise<IPNSPublishResult>

  Creates and publishes an IPNS record that will resolve the passed value signed by a key stored in the libp2p keychain under the passed key name.

  It is possible to create a recursive IPNS record by passing:

  • A PeerId,
  • A PublicKey
  • A CID with the libp2p-key codec and Identity or SHA256 hash algorithms
  • A Multihash with the Identity or SHA256 hash algorithms
  • A string IPNS key (e.g. /ipns/Qmfoo)

  Parameters

  • keyName: string
  • value:
        | string
        | CID<unknown, number, number, Version>
        | PeerId
        | PublicKey
        | MultihashDigest<0 | 18>
  • Optionaloptions: PublishOptions

  Returns Promise<IPNSPublishResult>

  Example

  import { createHelia } from 'helia'
  import { ipns } from '@helia/ipns'
  
  const helia = await createHelia()
  const name = ipns(helia)
  
  const result = await name.publish('my-key-name', cid, {
    signal: AbortSignal.timeout(5_000)
  })
  
  console.info(result) // { answer: ... }
  Copy

resolve

• resolve(
      key:
          | CID<unknown, 114, 0 | 18, 1>
          | PeerId
          | PublicKey
          | MultihashDigest<0 | 18>,
      options?: ResolveOptions,
  ): Promise<IPNSResolveResult>

  Accepts a libp2p public key, a CID with the libp2p-key codec and either the identity hash (for Ed25519 and secp256k1 public keys) or a SHA256 hash (for RSA public keys), or the multihash of a libp2p-key encoded CID, or a Ed25519, secp256k1 or RSA PeerId and recursively resolves the IPNS record corresponding to that key until a value is found.

  Parameters

  • key: CID<unknown, 114, 0 | 18, 1> | PeerId | PublicKey | MultihashDigest<0 | 18>
  • Optionaloptions: ResolveOptions

  Returns Promise<IPNSResolveResult>

unpublish

• unpublish(keyName: string, options?: AbortOptions): Promise<void>

  Stop republishing of an IPNS record

  This will delete the last signed IPNS record from the datastore, but the key will remain in the keychain.

  Note that the record may still be resolved by other peers until it expires or is no longer valid.

  Parameters

  • keyName: string
  • Optionaloptions: AbortOptions

  Returns Promise<void>