Interface IPNS

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

Index

Methods

publish republish 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:411

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:427

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:417

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:422