Interface IPNS

interface IPNS {
    publish(key, value, options?): Promise<IPNSRecord>;
    republish(options?): void;
    republishRecord(key, record, options?): Promise<void>;
    resolve(key, options?): Promise<IPNSResolveResult>;
    resolveDNSLink(domain, options?): Promise<DNSLinkResolveResult>;
}

Index

Methods

publish republish republishRecord resolve resolveDNSLink

Methods

publish

publish(key, value, options?): Promise<IPNSRecord>
Creates an IPNS record signed by the passed PeerId that will resolve to the passed value

If the value is a PeerId, a recursive IPNS record will be created.
Parameters
- key: PrivateKey
- value: string | PublicKey | MultihashDigest<0 | 18> | CID<unknown, number, number, Version>
- Optional options: PublishOptions
Returns Promise<IPNSRecord>
- Defined in packages/ipns/src/index.ts:449

republish

republish(options?): void
Periodically republish all IPNS records found in the datastore
Parameters
- Optional options: RepublishOptions
Returns void
- Defined in packages/ipns/src/index.ts:465

republishRecord

republishRecord(key, record, options?): Promise<void>
Republish an existing IPNS record without the private key.

Before republishing the record will be validated to ensure it has a valid signature and lifetime(validity) in the future. The key is a multihash of the public key or a string representation of the PeerID (either base58btc encoded multihash or base36 encoded CID)
Parameters
- key: string | MultihashDigest<0 | 18>
- record: IPNSRecord
- Optional options: RepublishRecordOptions
Returns Promise<void>
- Defined in packages/ipns/src/index.ts:473

resolve

resolve(key, options?): Promise<IPNSResolveResult>
Accepts a public key formatted as a libp2p PeerID and resolves the IPNS record corresponding to that public key until a value is found
Parameters
- key: PublicKey | MultihashDigest<0 | 18>
- Optional options: ResolveOptions
Returns Promise<IPNSResolveResult>
- Defined in packages/ipns/src/index.ts:455

resolveDNSLink

resolveDNSLink(domain, options?): Promise<DNSLinkResolveResult>
Resolve a CID from a dns-link style IPNS record
Parameters
- domain: string
- Optional options: ResolveDNSLinkOptions
Returns Promise<DNSLinkResolveResult>
- Defined in packages/ipns/src/index.ts:460