@0xpolygonid/js-sdk/src/iden3comm/types/packer.ts

SDK to work with Polygon ID

import { DID } from '@iden3/js-iden3-core';
import { DataPrepareHandlerFunc, VerificationHandlerFunc } from '../packers';
import { ProvingMethodAlg } from '@iden3/js-jwz';
import { CircuitId } from '../../circuits';
import { MediaType, PROTOCOL_MESSAGE_TYPE } from '../constants';
import { DIDDocument, VerificationMethod } from 'did-resolver';
import { StateVerificationOpts } from './models';
import { Attachment } from './protocol/attachment';

/**
 *  Protocol message type
 */
export type ProtocolMessage = (typeof PROTOCOL_MESSAGE_TYPE)[keyof typeof PROTOCOL_MESSAGE_TYPE];

/**
 * JSONValue
 */
export type JSONValue = string | number | boolean | object | Array<object>;

/**
 * JSON object
 */
export type JSONObject = {
  [x: string]: JSONValue;
};

/**
 * JSON document object
 */
export type JsonDocumentObject = { [key: string]: JsonDocumentObjectValue };

/**
 * JSON document object allowed values
 */
export type JsonDocumentObjectValue =
  | string
  | number
  | boolean
  | JsonDocumentObject
  | JsonDocumentObjectValue[];

/**
 * Basic message with all possible fields optional
 */
export type BasicMessage = {
  id: string;
  typ?: MediaType;
  type: ProtocolMessage;
  thid?: string;
  body?: unknown;
  from?: string;
  to?: string;
  created_time?: number;
  expires_time?: number;
  attachments?: Attachment[];
};

/**
 * Basic message with all possible fields required
 */
export type RequiredBasicMessage = Omit<
  Required<BasicMessage>,
  'created_time' | 'expires_time' | 'attachments'
> & {
  created_time?: number;
  expires_time?: number;
  attachments?: Attachment[];
};

/**
 *  parameters for any packer
 */
export type PackerParams = {
  [key in string]: any; //eslint-disable-line @typescript-eslint/no-explicit-any
};
/**
 *  parameters for zkp packer
 */
export type ZKPPackerParams = PackerParams & {
  senderDID: DID;
  /** @deprecated */
  profileNonce?: number | string;
  provingMethodAlg: ProvingMethodAlg;
};

/**
 *  SignerFn Is function to sign data with a verification method
 *  @returns Promise of signature bytes;
 */
export type SignerFn = (vm: VerificationMethod, dataToSign: Uint8Array) => Promise<Uint8Array>;

/**
 *  JWSPackerParams are parameters for JWS packer
 */
export type JWSPackerParams = PackerParams & {
  alg: string;
  kid?: string;
  didDocument?: DIDDocument;
  signer?: SignerFn;
};

/**
 *  parameters for plain packer
 */
export type PlainPackerParams = PackerParams;
/**
 *  signature of auth signals function preparer
 */
export type AuthDataPrepareFunc = (
  hash: Uint8Array,
  did: DID,
  circuitId: CircuitId
) => Promise<Uint8Array>;

/**
 *  signature of state function verifier
 */
export type StateVerificationFunc = (
  id: string,
  pubSignals: Array<string>,
  opts?: StateVerificationOpts
) => Promise<boolean>;

/**
 * Defines method that must be implemented by any packer
 *
 * @public
 * @interface   IPacker
 */
export interface IPacker {
  /**
   * Packs the given payload and returns a promise that resolves to the packed data.
   * @param payload - The payload to be packed.
   * @param param - The packing parameters.
   * @returns A promise that resolves to the packed data as a Uint8Array.
   */
  pack(payload: Uint8Array, param: PackerParams): Promise<Uint8Array>;

  /**
   * Packs the given message and returns a promise that resolves to the packed data.
   * @param msg - The message to be packed.
   * @param param - The packing parameters.
   * @returns A promise that resolves to the packed data as a Uint8Array.
   */
  packMessage(msg: BasicMessage, param: PackerParams): Promise<Uint8Array>;

  /**
   * Unpacks the given envelope and returns a promise that resolves to the unpacked message.
   * @param envelope - The envelope to be unpacked.
   * @returns A promise that resolves to the unpacked message as a BasicMessage.
   */
  unpack(envelope: Uint8Array): Promise<BasicMessage>;

  /**
   * Returns the media type associated with the packer.
   * @returns The media type as a MediaType.
   */
  mediaType(): MediaType;

  /**
   * gets packer envelope (supported profiles) with options
   *
   * @returns {string}
   */
  getSupportedProfiles(): string[];

  /**
   * returns true if profile is supported by packer
   *
   * @param {string} profile
   * @returns {boolean}
   */
  isProfileSupported(profile: string): boolean;
}
/**
 * Params for verification of auth circuit public signals
 */
export type VerificationParams = {
  key: Uint8Array;
  verificationFn: VerificationHandlerFunc;
};

/**
 * Params for generation of proof for auth circuit
 */
export type ProvingParams = {
  dataPreparer: DataPrepareHandlerFunc;
  provingKey: Uint8Array;
  wasm: Uint8Array;
};