Interface IdentifierManager<T>

Interface for KERI identifier (prefix) creation, rotation, and signing.

interface IdentifierManager<
    T extends IdentifierManagerParams = IdentifierManagerParams,
> {
    algo: Algos;
    signers: Signer[];
    incept(transferable: boolean): Promise<IdentifierManagerResult>;
    params(): T;
    rotate(
        ncodes: string[],
        transferable: boolean,
        states?: {
            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[];
        }[],
        rstates?: {
            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[];
        }[],
    ): Promise<IdentifierManagerResult>;
    sign(
        ser: Uint8Array,
        indexed?: boolean,
        indices?: number[],
        ondices?: number[],
    ): Promise<SignResult>;
}

Type Parameters

T extends IdentifierManagerParams = IdentifierManagerParams
Type of the key keeper

Implemented by

Index

Properties

algo signers

Methods

incept params rotate sign

Properties

algo

algo: Algos

signers

signers: Signer[]

Methods

incept

incept(transferable: boolean): Promise<IdentifierManagerResult>
Parameters
- transferable: boolean
Returns Promise<IdentifierManagerResult>
- Defined in keri/core/keeping.ts:71

params

params(): T
Returns T
- Defined in keri/core/keeping.ts:70

rotate

rotate(
    ncodes: string[],
    transferable: boolean,
    states?: {
        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[];
    }[],
    rstates?: {
        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[];
    }[],
): Promise<IdentifierManagerResult>
Parameters
- ncodes: string[]
- transferable: boolean
- Optionalstates: {
      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[];
  }[]
  - b: string[]
  - bt: string
    Default
    0
  - c: string[]
  - d: string
    Default
  - di: string
    Default
  - dt: string
    Default
  - ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }
    Optionalba?: unknown[]
    Optionalbr?: unknown[]
    d: string
    Default
    
    s: string
    Default
    0
  - et: string
    Default
  - f: string
    Default
    0
  - i: string
    Default
  - k: string[]
  - kt: string
    Default
    0
  - n: string[]
  - nt: string
    Default
    0
  - p: string
    Default
  - s: string
    Default
    0
  - Optionalvn?: number[]
- Optionalrstates: {
      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[];
  }[]
  - b: string[]
  - bt: string
    Default
    0
  - c: string[]
  - d: string
    Default
  - di: string
    Default
  - dt: string
    Default
  - ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }
    Optionalba?: unknown[]
    Optionalbr?: unknown[]
    d: string
    Default
    
    s: string
    Default
    0
  - et: string
    Default
  - f: string
    Default
    0
  - i: string
    Default
  - k: string[]
  - kt: string
    Default
    0
  - n: string[]
  - nt: string
    Default
    0
  - p: string
    Default
  - s: string
    Default
    0
  - Optionalvn?: number[]
Returns Promise<IdentifierManagerResult>
- Defined in keri/core/keeping.ts:72

sign

sign(
    ser: Uint8Array,
    indexed?: boolean,
    indices?: number[],
    ondices?: number[],
): Promise<SignResult>
Parameters
- ser: Uint8Array
- Optionalindexed: boolean
- Optionalindices: number[]
- Optionalondices: number[]
Returns Promise<SignResult>
- Defined in keri/core/keeping.ts:78

Interface IdentifierManager<T>

Type Parameters

Implemented by

Index

Properties

Methods

Properties

algo

signers

Methods

incept

Parameters

Returns Promise<IdentifierManagerResult>

params

Returns T

rotate

Parameters

b: string[]

bt: string

Default

c: string[]

d: string

Default

di: string

Default

dt: string

Default

ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }

Optionalba?: unknown[]

Optionalbr?: unknown[]

d: string

Default

s: string

Default

et: string

Default

f: string

Default

i: string

Default

k: string[]

kt: string

Default

n: string[]

nt: string

Default

p: string

Default

s: string

Default

Optionalvn?: number[]

b: string[]

bt: string

Default

c: string[]

d: string

Default

di: string

Default

dt: string

Default

ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }

Optionalba?: unknown[]

Optionalbr?: unknown[]

d: string

Default

s: string

Default

et: string

Default

f: string

Default

i: string

Default

k: string[]

kt: string

Default

n: string[]

nt: string

Default

`Optional`ba?: unknown[]

`Optional`br?: unknown[]

`Optional`vn?: number[]

`Optional`ba?: unknown[]

`Optional`br?: unknown[]

`Optional`vn?: number[]