Class IpnsAPI

constructor

• new IpnsAPI(client): IpnsAPI

• Parameters

  • client: Client

  Returns IpnsAPI

Static ReadonlyLOCALITIES

createName

• createName(request): Promise<Name>

• Create a new name. You can use the ipns key command to list and generate more names and their respective keys.

  Parameters

  • request: Readonly<IpnsApiCreateNameRequest>

    The request IpnsApiCreateNameRequest

  Returns Promise<Name>

  A Promise of Name

deleteName

• deleteName(request): Promise<void>

• Delete an existing name. Delete a name by its ID.

  Parameters

  • request: Readonly<IpnsApiDeleteNameRequest>

    The request IpnsApiDeleteNameRequest

  Returns Promise<void>

exportKeyName

• exportKeyName(request): Promise<ExportKeyNameResponse>

• Export your private key. Export a private key by its ID.

  Parameters

  • request: Readonly<IpnsApiExportKeyNameRequest>

    The request IpnsApiExportKeyNameRequest

  Returns Promise<ExportKeyNameResponse>

  A Promise of ExportKeyNameResponse

getName

• getName(request): Promise<Name>

• Get information about a name. Retrieve information about a specific name.

  Parameters

  • request: Readonly<IpnsApiGetNameRequest>

    The request IpnsApiGetNameRequest

  Returns Promise<Name>

  A Promise of Name

importKeyName

• importKeyName(request): Promise<Name>

• Import your private key. Import a private key.

  Parameters

  • request: Readonly<IpnsApiImportKeyNameRequest>

    The request IpnsApiImportKeyNameRequest

  Returns Promise<Name>

  A Promise of Name

listNames

• listNames(request?): Promise<ListNamesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Name[], void, void>);
      all: (() => Promise<Name[]>);
  }

• List all names by a Project ID. Retrieve information about all names from a Project ID.

  Parameters

  • request: Readonly<IpnsApiListNamesRequest> = {}

    The request IpnsApiListNamesRequest

  Returns Promise<ListNamesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Name[], void, void>);
      all: (() => Promise<Name[]>);
  }

  A Promise of ListNamesResponse

updateName

• updateName(request): Promise<Name>

• Update name information. Update name information (CID, tag, name...).

  Parameters

  • request: Readonly<IpnsApiUpdateNameRequest>

    The request IpnsApiUpdateNameRequest

  Returns Promise<Name>

  A Promise of Name

waitForName

• waitForName(request, options?): Promise<Name>

• Waits for Name to be in a final state.

  Parameters

  • request: Readonly<IpnsApiGetNameRequest>

    The request IpnsApiGetNameRequest
  • Optionaloptions: Readonly<WaitForOptions<Name>>

    The waiting options

  Returns Promise<Name>

  A Promise of Name