Interface IPNS

routers

publish

• publish(
      keyName: string,
      value:
          | string
          | MultihashDigest<number>
          | CID<unknown, number, number, Version>
          | PublicKey,
      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.

  If the key does not exist, a new Ed25519 key will be created. To use a different key types, ensure the key is created and stored in the keychain before invoking this method.

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

  • A CID with the libp2p-key codec
  • A Multihash
  • A string IPNS key (e.g. /ipns/Qmfoo)

  Parameters

  • keyName: string
  • value:
        | string
        | MultihashDigest<number>
        | CID<unknown, number, number, Version>
        | PublicKey
  • 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(
      name:
          | string
          | MultihashDigest<number>
          | CID<unknown, number, number, Version>
          | PublicKey,
      options?: IPNSResolveOptions,
  ): AsyncGenerator<IPNSResolveResult>

  Accepts a multihash of a public key, a libp2p-key CID containing the multihash of a public key, or an IPNS name in it's string representation and recursively resolves IPNS records until a non-recursive record is found (e.g. the value can be parsed as a string that does not start with /ipns/).

  Parameters

  • name:
        | string
        | MultihashDigest<number>
        | CID<unknown, number, number, Version>
        | PublicKey
  • Optionaloptions: IPNSResolveOptions

  Returns AsyncGenerator<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.

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

  Parameters

  • keyName: string
  • Optionaloptions: AbortOptions

  Returns Promise<void>