Class Ipex

constructor

• new Ipex(client: SignifyClient): Ipex

  Schemas

  Parameters

  • client: SignifyClient

  Returns Ipex

client

admit

• admit(args: IpexAdmitArgs): Promise<[Serder, string[], string]>

  Create an IPEX admit EXN message

  Parameters

  • args: IpexAdmitArgs

  Returns Promise<[Serder, string[], string]>

agree

• agree(args: IpexAgreeArgs): Promise<[Serder, string[], string]>

  Create an IPEX agree EXN message

  Parameters

  • args: IpexAgreeArgs

  Returns Promise<[Serder, string[], string]>

apply

• apply(args: IpexApplyArgs): Promise<[Serder, string[], string]>

  Create an IPEX apply EXN message

  Parameters

  • args: IpexApplyArgs

  Returns Promise<[Serder, string[], string]>

grant

• grant(args: IpexGrantArgs): Promise<[Serder, string[], string]>

  Create an IPEX grant EXN message

  Parameters

  • args: IpexGrantArgs

  Returns Promise<[Serder, string[], string]>

offer

• offer(args: IpexOfferArgs): Promise<[Serder, string[], string]>

  Create an IPEX offer EXN message

  Parameters

  • args: IpexOfferArgs

  Returns Promise<[Serder, string[], string]>

submitAdmit

• submitAdmit(
      name: string,
      exn: Serder,
      sigs: string[],
      atc: string,
      recp: string[],
  ): Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

  Parameters

  • name: string
  • exn: Serder
  • sigs: string[]
  • atc: string
  • recp: string[]

  Returns Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

submitAgree

• submitAgree(
      name: string,
      exn: Serder,
      sigs: string[],
      recp: string[],
  ): Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

  Parameters

  • name: string
  • exn: Serder
  • sigs: string[]
  • recp: string[]

  Returns Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

submitApply

• submitApply(
      name: string,
      exn: Serder,
      sigs: string[],
      recp: string[],
  ): Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

  Parameters

  • name: string
  • exn: Serder
  • sigs: string[]
  • recp: string[]

  Returns Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

submitGrant

• submitGrant(
      name: string,
      exn: Serder,
      sigs: string[],
      atc: string,
      recp: string[],
  ): Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

  Parameters

  • name: string
  • exn: Serder
  • sigs: string[]
  • atc: string
  • recp: string[]

  Returns Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

submitOffer

• submitOffer(
      name: string,
      exn: Serder,
      sigs: string[],
      atc: string,
      recp: string[],
  ): Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >

  Parameters

  • name: string
  • exn: Serder
  • sigs: string[]
  • atc: string
  • recp: string[]

  Returns Promise<
      | { done: false; metadata?: { said: string }; name: string }
      | {
          done: true;
          metadata?: { said: string };
          name: string;
          response: { said: string };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { said: string };
          name: string;
      },
  >