signify-ts
    Preparing search index...

    Class GroupIdentifierManager

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

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Parameters

      • manager: IdentifierManagerFactory
      • mhab: {
            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;
                };
            }
        )
        • 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[];
          }
          • b: string[]
          • bt: string
            0
            
          • c: string[]
          • d: string
            
            
          • di: string
            
            
          • dt: string
            
            
          • ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }
            • Optionalba?: unknown[]
            • Optionalbr?: unknown[]
            • d: string
              
              
            • s: string
              0
              
          • et: string
            
            
          • f: string
            0
            
          • i: string
            
            
          • k: string[]
          • kt: string
            0
            
          • n: string[]
          • nt: string
            0
            
          • p: string
            
            
          • s: string
            0
            
          • Optionalvn?: number[]
        • transferable: null | boolean
          null
          
        • windexes: null | string[]
          null
          
        • {
              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 } }
      • states:
            | undefined
            | {
                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[];
            }[] = undefined
        • undefined
        • {
              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
            0
            
          • c: string[]
          • d: string
            
            
          • di: string
            
            
          • dt: string
            
            
          • ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }
            • Optionalba?: unknown[]
            • Optionalbr?: unknown[]
            • d: string
              
              
            • s: string
              0
              
          • et: string
            
            
          • f: string
            0
            
          • i: string
            
            
          • k: string[]
          • kt: string
            0
            
          • n: string[]
          • nt: string
            0
            
          • p: string
            
            
          • s: string
            0
            
          • Optionalvn?: number[]
      • rstates:
            | undefined
            | {
                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[];
            }[] = undefined
        • undefined
        • {
              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
            0
            
          • c: string[]
          • d: string
            
            
          • di: string
            
            
          • dt: string
            
            
          • ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }
            • Optionalba?: unknown[]
            • Optionalbr?: unknown[]
            • d: string
              
              
            • s: string
              0
              
          • et: string
            
            
          • f: string
            0
            
          • i: string
            
            
          • k: string[]
          • kt: string
            0
            
          • n: string[]
          • nt: string
            0
            
          • p: string
            
            
          • s: string
            0
            
          • Optionalvn?: number[]
      • keys: string[] = []
      • ndigs: string[] = []

      Returns GroupIdentifierManager

    Properties

    algo: Algos = Algos.group
    signers: Signer[]

    Methods

    • Returns {
          keys: string[];
          mhab: {
              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;
                  };
              }
          );
          ndigs: string[];
      }

    • Performs a multisig rotation

      Parameters

      • _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[];
        }[]
        • b: string[]
        • bt: string
          0
          
        • c: string[]
        • d: string
          
          
        • di: string
          
          
        • dt: string
          
          
        • ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }
          • Optionalba?: unknown[]
          • Optionalbr?: unknown[]
          • d: string
            
            
          • s: string
            0
            
        • et: string
          
          
        • f: string
          0
          
        • i: string
          
          
        • k: string[]
        • kt: string
          0
          
        • n: string[]
        • nt: string
          0
          
        • p: string
          
          
        • s: string
          0
          
        • Optionalvn?: 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[];
        }[]

        key state records for the prior establishment event indicating next key digests. You should pass in the current key

        • b: string[]
        • bt: string
          0
          
        • c: string[]
        • d: string
          
          
        • di: string
          
          
        • dt: string
          
          
        • ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }
          • Optionalba?: unknown[]
          • Optionalbr?: unknown[]
          • d: string
            
            
          • s: string
            0
            
        • et: string
          
          
        • f: string
          0
          
        • i: string
          
          
        • k: string[]
        • kt: string
          0
          
        • n: string[]
        • nt: string
          0
          
        • p: string
          
          
        • s: string
          0
          
        • Optionalvn?: number[]

      Returns Promise<IdentifierManagerResult>