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

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,
  ): Promise<
      {
          icp_dt: string;
          name: string;
          prefix: string;
          state: {
              b: string[];
              bt: string;
              c: string[];
              d: string;
              di: string;
              dt: string;
              ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
              et: string;
              f: string;
              i: string;
              k: string[];
              kt: string;
              n: string[];
              nt: string;
              p: string;
              s: string;
              vn?: number[];
          };
          transferable: null
          | boolean;
          windexes: null | string[];
      } & (
          | {
              salty: {
                  dcode: string;
                  icodes: string[];
                  kidx: number;
                  ncodes: string[];
                  pidx: number;
                  stem: string;
                  sxlt: string;
                  tier: Tier;
                  transferable: boolean;
              };
          }
          | { randy: { nxts: string[]; prxs: string[] } }
          | {
              group: {
                  keys: string[];
                  mhab: { name: string; prefix: string; icp_dt: string; state: { vn?: number[] | undefined; i: string; s: string; p: string; d: string; f: string; dt: string; et: string; kt: string; k: string[]; nt: string; n: string[]; bt: string; b: string[]; c: string[]; ee: { ...; }; di: string; }; transferable: boolean | null; windexe...;
                  ndigs: string[];
              };
          }
          | {
              extern: { extern_type: string; pidx: number } & {
                  [key: string]: unknown;
              };
          }
      ),
  >

  Get information for a managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  Returns Promise<
      {
          icp_dt: string;
          name: string;
          prefix: string;
          state: {
              b: string[];
              bt: string;
              c: string[];
              d: string;
              di: string;
              dt: string;
              ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
              et: string;
              f: string;
              i: string;
              k: string[];
              kt: string;
              n: string[];
              nt: string;
              p: string;
              s: string;
              vn?: number[];
          };
          transferable: null
          | boolean;
          windexes: null | string[];
      } & (
          | {
              salty: {
                  dcode: string;
                  icodes: string[];
                  kidx: number;
                  ncodes: string[];
                  pidx: number;
                  stem: string;
                  sxlt: string;
                  tier: Tier;
                  transferable: boolean;
              };
          }
          | { randy: { nxts: string[]; prxs: string[] } }
          | {
              group: {
                  keys: string[];
                  mhab: { name: string; prefix: string; icp_dt: string; state: { vn?: number[] | undefined; i: string; s: string; p: string; d: string; f: string; dt: string; et: string; kt: string; k: string[]; nt: string; n: string[]; bt: string; b: string[]; c: string[]; ee: { ...; }; di: string; }; transferable: boolean | null; windexe...;
                  ndigs: string[];
              };
          }
          | {
              extern: { extern_type: string; pidx: number } & {
                  [key: string]: unknown;
              };
          }
      ),
  >

  A promise to the identifier information

  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]: string };
                  controller: null | { [key: string]: string };
                  judge: null | { [key: string]: string };
                  juror: null | { [key: string]: string };
                  mailbox: null | { [key: string]: string };
                  peer: null | { [key: string]: string };
                  registrar: null | { [key: string]: string };
                  watcher: null | { [key: string]: string };
                  witness: null | { [key: string]: string };
              };
          }[];
          signing: {
              aid: string;
              ends: {
                  agent: null
                  | { [key: string]: string };
                  controller: null | { [key: string]: string };
                  judge: null | { [key: string]: string };
                  juror: null | { [key: string]: string };
                  mailbox: null | { [key: string]: string };
                  peer: null | { [key: string]: string };
                  registrar: null | { [key: string]: string };
                  watcher: null | { [key: string]: string };
                  witness: null | { [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]: string };
                  controller: null | { [key: string]: string };
                  judge: null | { [key: string]: string };
                  juror: null | { [key: string]: string };
                  mailbox: null | { [key: string]: string };
                  peer: null | { [key: string]: string };
                  registrar: null | { [key: string]: string };
                  watcher: null | { [key: string]: string };
                  witness: null | { [key: string]: string };
              };
          }[];
          signing: {
              aid: string;
              ends: {
                  agent: null
                  | { [key: string]: string };
                  controller: null | { [key: string]: string };
                  judge: null | { [key: string]: string };
                  juror: null | { [key: string]: string };
                  mailbox: null | { [key: string]: string };
                  peer: null | { [key: string]: string };
                  registrar: null | { [key: string]: string };
                  watcher: null | { [key: string]: string };
                  witness: null | { [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,
  ): Promise<
      {
          icp_dt: string;
          name: string;
          prefix: string;
          state: {
              b: string[];
              bt: string;
              c: string[];
              d: string;
              di: string;
              dt: string;
              ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
              et: string;
              f: string;
              i: string;
              k: string[];
              kt: string;
              n: string[];
              nt: string;
              p: string;
              s: string;
              vn?: number[];
          };
          transferable: null
          | boolean;
          windexes: null | string[];
      } & (
          | {
              salty: {
                  dcode: string;
                  icodes: string[];
                  kidx: number;
                  ncodes: string[];
                  pidx: number;
                  stem: string;
                  sxlt: string;
                  tier: Tier;
                  transferable: boolean;
              };
          }
          | { randy: { nxts: string[]; prxs: string[] } }
          | {
              group: {
                  keys: string[];
                  mhab: { name: string; prefix: string; icp_dt: string; state: { vn?: number[] | undefined; i: string; s: string; p: string; d: string; f: string; dt: string; et: string; kt: string; k: string[]; nt: string; n: string[]; bt: string; b: string[]; c: string[]; ee: { ...; }; di: string; }; transferable: boolean | null; windexe...;
                  ndigs: string[];
              };
          }
          | {
              extern: { extern_type: string; pidx: number } & {
                  [key: string]: unknown;
              };
          }
      ),
  >

  Update managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • info: IdentifierInfo

    Information to update for the given identifier

  Returns Promise<
      {
          icp_dt: string;
          name: string;
          prefix: string;
          state: {
              b: string[];
              bt: string;
              c: string[];
              d: string;
              di: string;
              dt: string;
              ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
              et: string;
              f: string;
              i: string;
              k: string[];
              kt: string;
              n: string[];
              nt: string;
              p: string;
              s: string;
              vn?: number[];
          };
          transferable: null
          | boolean;
          windexes: null | string[];
      } & (
          | {
              salty: {
                  dcode: string;
                  icodes: string[];
                  kidx: number;
                  ncodes: string[];
                  pidx: number;
                  stem: string;
                  sxlt: string;
                  tier: Tier;
                  transferable: boolean;
              };
          }
          | { randy: { nxts: string[]; prxs: string[] } }
          | {
              group: {
                  keys: string[];
                  mhab: { name: string; prefix: string; icp_dt: string; state: { vn?: number[] | undefined; i: string; s: string; p: string; d: string; f: string; dt: string; et: string; kt: string; k: string[]; nt: string; n: string[]; bt: string; b: string[]; c: string[]; ee: { ...; }; di: string; }; transferable: boolean | null; windexe...;
                  ndigs: string[];
              };
          }
          | {
              extern: { extern_type: string; pidx: number } & {
                  [key: string]: unknown;
              };
          }
      ),
  >

  A promise to the identifier information after updating

  Async