Class Identifier

constructor

• new Identifier(client: IdentifierDeps): Identifier

  Identifier

  Parameters

  • client: IdentifierDeps

  Returns Identifier

client

addEndRole

• addEndRole(
      name: string,
      role: string,
      eid?: string,
      stamp?: string,
  ): Promise<EventResult>

  Authorize an endpoint provider in a given role for a managed identifier

  Parameters

  • name: string

    Name or alias of the identifier

  • role: string

    Authorized role for eid

  • Optionaleid: string

    Optional qb64 of endpoint provider to be authorized

  • Optionalstamp: string

    Optional date-time-stamp RFC-3339 profile of iso8601 datetime. Now is the default if not provided

  Returns Promise<EventResult>

  A promise to the result of the authorization

  Remarks

  Typically used to authorize the agent to be the endpoint provider for the identifier in the role of agent

  Async

addLocScheme

• addLocScheme(name: string, args: LocSchemeArgs): Promise<EventResult>

  Authorises a new location scheme (endpoint) for a particular endpoint identifier.

  Parameters

  • name: string

    Name or alias of the identifier to sign reply message

  • args: LocSchemeArgs

  Returns Promise<EventResult>

  A promise to the result of the authorization

create

• create(name: string, kargs?: CreateIdentiferArgs): Promise<EventResult>

  Create a managed identifier

  Parameters

  • name: string

    Name or alias of the identifier

  • Optionalkargs: CreateIdentiferArgs = {}

    Optional parameters to create the identifier

  Returns Promise<EventResult>

  The inception result

  Async

createInteract

• createInteract(
      name: string,
      data?: any,
  ): Promise<{ jsondata: any; serder: any; sigs: any }>

  Parameters

  • name: string
  • Optionaldata: any

  Returns Promise<{ jsondata: any; serder: any; sigs: any }>

get

• get(name: string, requireAccepted?: true): Promise<HabState>

  Get information for a managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • OptionalrequireAccepted: true

    When true, requires key state to be present and throws otherwise. Key state is absent only for a multisig group whose inception is still collecting member signatures; pass false to fetch such a pending group.

  Returns Promise<HabState>

  A promise to the identifier information, narrowed to HabState unless requireAccepted is false

  Async

• get(name: string, requireAccepted: false): Promise<HabState | PendingHabState>

  Get information for a managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • requireAccepted: false

    When true, requires key state to be present and throws otherwise. Key state is absent only for a multisig group whose inception is still collecting member signatures; pass false to fetch such a pending group.

  Returns Promise<HabState | PendingHabState>

  A promise to the identifier information, narrowed to HabState unless requireAccepted is false

  Async

• get(name: string, requireAccepted: boolean): Promise<HabState | PendingHabState>

  Get information for a managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • requireAccepted: boolean

    When true, requires key state to be present and throws otherwise. Key state is absent only for a multisig group whose inception is still collecting member signatures; pass false to fetch such a pending group.

  Returns Promise<HabState | PendingHabState>

  A promise to the identifier information, narrowed to HabState unless requireAccepted is false

  Async

interact

• interact(name: string, data?: any): Promise<EventResult>

  Generate an interaction event in a managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • Optionaldata: any

    Option data to be anchored in the interaction event

  Returns Promise<EventResult>

  A promise to the interaction event result

  Async

list

• list(start?: number, end?: number): Promise<any>

  List managed identifiers

  Parameters

  • Optionalstart: number = 0

    Start index of list of notifications, defaults to 0

  • Optionalend: number = 24

    End index of list of notifications, defaults to 24

  Returns Promise<any>

  A promise to the list of managed identifiers

  Async

members

• members(
      name: string,
  ): Promise<
      {
          rotation: {
              aid: string;
              ends: {
                  agent: null
                  | { [key: string]: { [key: string]: string } };
                  controller: null | { [key: string]: { [key: string]: string } };
                  judge: null | { [key: string]: { [key: string]: string } };
                  juror: null | { [key: string]: { [key: string]: string } };
                  mailbox: null | { [key: string]: { [key: string]: string } };
                  peer: null | { [key: string]: { [key: string]: string } };
                  registrar: null | { [key: string]: { [key: string]: string } };
                  watcher: null | { [key: string]: { [key: string]: string } };
                  witness: null | { [key: string]: { [key: string]: string } };
              };
          }[];
          signing: {
              aid: string;
              ends: {
                  agent: null
                  | { [key: string]: { [key: string]: string } };
                  controller: null | { [key: string]: { [key: string]: string } };
                  judge: null | { [key: string]: { [key: string]: string } };
                  juror: null | { [key: string]: { [key: string]: string } };
                  mailbox: null | { [key: string]: { [key: string]: string } };
                  peer: null | { [key: string]: { [key: string]: string } };
                  registrar: null | { [key: string]: { [key: string]: string } };
                  watcher: null | { [key: string]: { [key: string]: string } };
                  witness: null | { [key: string]: { [key: string]: string } };
              };
          }[];
      },
  >

  Get the members of a group identifier

  Parameters

  • name: string

    Name or alias of the identifier

  Returns Promise<
      {
          rotation: {
              aid: string;
              ends: {
                  agent: null
                  | { [key: string]: { [key: string]: string } };
                  controller: null | { [key: string]: { [key: string]: string } };
                  judge: null | { [key: string]: { [key: string]: string } };
                  juror: null | { [key: string]: { [key: string]: string } };
                  mailbox: null | { [key: string]: { [key: string]: string } };
                  peer: null | { [key: string]: { [key: string]: string } };
                  registrar: null | { [key: string]: { [key: string]: string } };
                  watcher: null | { [key: string]: { [key: string]: string } };
                  witness: null | { [key: string]: { [key: string]: string } };
              };
          }[];
          signing: {
              aid: string;
              ends: {
                  agent: null
                  | { [key: string]: { [key: string]: string } };
                  controller: null | { [key: string]: { [key: string]: string } };
                  judge: null | { [key: string]: { [key: string]: string } };
                  juror: null | { [key: string]: { [key: string]: string } };
                  mailbox: null | { [key: string]: { [key: string]: string } };
                  peer: null | { [key: string]: { [key: string]: string } };
                  registrar: null | { [key: string]: { [key: string]: string } };
                  watcher: null | { [key: string]: { [key: string]: string } };
                  witness: null | { [key: string]: { [key: string]: string } };
              };
          }[];
      },
  >

  • A promise to the list of members

  Async

rotate

• rotate(name: string, kargs?: RotateIdentifierArgs): Promise<EventResult>

  Generate a rotation event in a managed identifier

  Parameters

  • name: string

    Name or alias of the identifier

  • Optionalkargs: RotateIdentifierArgs = {}

    Optional parameters requiered to generate the rotation event

  Returns Promise<EventResult>

  A promise to the rotation event result

update

• update(
      name: string,
      info: IdentifierInfo,
      requireAccepted?: true,
  ): Promise<HabState>

  Update managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • info: IdentifierInfo

    Information to update for the given identifier

  • OptionalrequireAccepted: true

    When true, requires key state to be present on the updated identifier and throws otherwise; pass false to update a still-pending multisig group.

  Returns Promise<HabState>

  A promise to the identifier information after updating, narrowed to HabState unless requireAccepted is false

  Async

• update(
      name: string,
      info: IdentifierInfo,
      requireAccepted: false,
  ): Promise<HabState | PendingHabState>

  Update managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • info: IdentifierInfo

    Information to update for the given identifier

  • requireAccepted: false

    When true, requires key state to be present on the updated identifier and throws otherwise; pass false to update a still-pending multisig group.

  Returns Promise<HabState | PendingHabState>

  A promise to the identifier information after updating, narrowed to HabState unless requireAccepted is false

  Async

• update(
      name: string,
      info: IdentifierInfo,
      requireAccepted: boolean,
  ): Promise<HabState | PendingHabState>

  Update managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • info: IdentifierInfo

    Information to update for the given identifier

  • requireAccepted: boolean

    When true, requires key state to be present on the updated identifier and throws otherwise; pass false to update a still-pending multisig group.

  Returns Promise<HabState | PendingHabState>

  A promise to the identifier information after updating, narrowed to HabState unless requireAccepted is false

  Async