Class Groups

constructor

• new Groups(client: SignifyClient): Groups

  Groups

  Parameters

  • client: SignifyClient

  Returns Groups

client

getRequest

• getRequest(
      said?: string,
  ): Promise<
      {
          exn: | {
              a: unknown;
              d: string;
              dt: string;
              e: { [key: string]: unknown };
              i: string;
              p: string;
              q: { [key: string]: unknown };
              r: string;
              rp: string;
              t: string;
              v: string;
          }
          | {
              a: unknown;
              d: string;
              dt: string;
              i: string;
              p: string;
              q: { [key: string]: unknown };
              r: string;
              t: string;
              v: string;
              x: string;
          };
          groupName?: string;
          memberName?: string;
          paths: { [key: string]: unknown };
          sender?: string;
      }[],
  >

  Get group request messages

  Parameters

  • Optionalsaid: string

    SAID of exn message to load

  Returns Promise<
      {
          exn: | {
              a: unknown;
              d: string;
              dt: string;
              e: { [key: string]: unknown };
              i: string;
              p: string;
              q: { [key: string]: unknown };
              r: string;
              rp: string;
              t: string;
              v: string;
          }
          | {
              a: unknown;
              d: string;
              dt: string;
              i: string;
              p: string;
              q: { [key: string]: unknown };
              r: string;
              t: string;
              v: string;
              x: string;
          };
          groupName?: string;
          memberName?: string;
          paths: { [key: string]: unknown };
          sender?: string;
      }[],
  >

  A promise to the list of replay messages

  Async

join

• join(
      name?: string,
      rot?: any,
      sigs?: any,
      gid?: string,
      smids?: string[],
      rmids?: string[],
  ): Promise<
      | { done: false; metadata?: { pre: string; sn: number }; name: string }
      | {
          done: true;
          metadata?: { pre: string; sn: number };
          name: string;
          response:
              | {
                  a: unknown;
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { pre: string; sn: number };
          name: string;
      },
  >

  Join multisig group using rotation event. This can be used by participants being asked to contribute keys to a rotation event to join an existing group.

  Parameters

  • Optionalname: string

    human readable name of group AID

  • Optionalrot: any

    rotation event

  • Optionalsigs: any

    signatures

  • Optionalgid: string

    prefix

  • Optionalsmids: string[]

    array of particpants

  • Optionalrmids: string[]

    array of particpants

  Returns Promise<
      | { done: false; metadata?: { pre: string; sn: number }; name: string }
      | {
          done: true;
          metadata?: { pre: string; sn: number };
          name: string;
          response:
              | {
                  a: unknown;
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string
                  | string[]
                  | string[][];
                  n: string[];
                  nt: string | string[] | string[][];
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { pre: string; sn: number };
          name: string;
      },
  >

  A promise to the list of replay messages

  Async

sendRequest

• sendRequest(
      name?: string,
      exn?:
          | {
              a: unknown;
              d: string;
              dt: string;
              e: { [key: string]: unknown };
              i: string;
              p: string;
              q: { [key: string]: unknown };
              r: string;
              rp: string;
              t: string;
              v: string;
          }
          | {
              a: unknown;
              d: string;
              dt: string;
              i: string;
              p: string;
              q: { [key: string]: unknown };
              r: string;
              t: string;
              v: string;
              x: string;
          },
      sigs?: string[],
      atc?: string,
  ): Promise<
      | {
          a: unknown;
          d: string;
          dt: string;
          e: { [key: string]: unknown };
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          rp: string;
          t: string;
          v: string;
      }
      | {
          a: unknown;
          d: string;
          dt: string;
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          t: string;
          v: string;
          x: string;
      },
  >

  Send multisig exn request messages to other group members

  Parameters

  • Optionalname: string

    human readable name of group AID

  • Optionalexn:
        | {
            a: unknown;
            d: string;
            dt: string;
            e: { [key: string]: unknown };
            i: string;
            p: string;
            q: { [key: string]: unknown };
            r: string;
            rp: string;
            t: string;
            v: string;
        }
        | {
            a: unknown;
            d: string;
            dt: string;
            i: string;
            p: string;
            q: { [key: string]: unknown };
            r: string;
            t: string;
            v: string;
            x: string;
        }

    exn message to send to other members

  • Optionalsigs: string[]

    signature of the participant over the exn

  • Optionalatc: string

    additional attachments from embedded events in exn

  Returns Promise<
      | {
          a: unknown;
          d: string;
          dt: string;
          e: { [key: string]: unknown };
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          rp: string;
          t: string;
          v: string;
      }
      | {
          a: unknown;
          d: string;
          dt: string;
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          t: string;
          v: string;
          x: string;
      },
  >

  A promise to the list of replay messages

  Async