@0xpolygonid/js-sdk/src/credentials/status/credential-status-publisher.ts

SDK to work with Polygon ID

import { TransactionReceipt } from 'ethers';
import { JSONObject } from '../../iden3comm';
import { OnChainRevocationStorage } from '../../storage';
import { CredentialStatusType } from '../../verifiable';
import { ProofNode } from './reverse-sparse-merkle-tree';
import { MessageBus, SDK_EVENTS } from '../../utils';
import { PublishMode } from '../models';

/**
 * Represents a credential status publisher.
 */
export interface ICredentialStatusPublisher {
  /**
   * Publishes the credential status.
   * @param params - The parameters for publishing the status.
   * @returns A promise that resolves when the status is published.
   */
  publish(params: JSONObject): Promise<void>;
}

/**
 * Registry for managing credential status publishers.
 */
export class CredentialStatusPublisherRegistry {
  private _publishers: Map<CredentialStatusType, ICredentialStatusPublisher[]> = new Map();

  /**
   * Registers one or more credential status publishers for a given type.
   * @param type - The credential status type.
   * @param publisher - One or more credential status publishers.
   */
  public register(type: CredentialStatusType, ...publisher: ICredentialStatusPublisher[]): void {
    const publishers = this._publishers.get(type) ?? [];
    publishers.push(...publisher);
    this._publishers.set(type, publishers);
  }

  /**
   * Retrieves the credential status publishers for a given type.
   * @param type - The credential status type.
   * @returns An array of credential status publishers or undefined if none are registered for the given type.
   */
  public get(type: CredentialStatusType): ICredentialStatusPublisher[] | undefined {
    return this._publishers.get(type);
  }
}

/**
 * Implementation of the ICredentialStatusPublisher interface for publishing on-chain credential status.
 */
export class Iden3OnchainSmtCredentialStatusPublisher implements ICredentialStatusPublisher {
  constructor(private readonly _storage: OnChainRevocationStorage) {}

  /**
   * Publishes the credential status to the blockchain.
   * @param params - The parameters for publishing the credential status.
   */
  public async publish(params: {
    nodes: ProofNode[];
    credentialStatusType: CredentialStatusType;
    onChain?: {
      txCallback?: (tx: TransactionReceipt) => Promise<void>;
      publishMode?: PublishMode;
    };
  }): Promise<void> {
    if (
      ![CredentialStatusType.Iden3OnchainSparseMerkleTreeProof2023].includes(
        params.credentialStatusType
      )
    ) {
      throw new Error(
        `On-chain publishing is not supported for credential status type ${params.credentialStatusType}`
      );
    }
    const nodesBigInts = params.nodes.map((n) => n.children.map((c) => c.bigInt()));

    const txPromise = this._storage.saveNodes(nodesBigInts);

    let publishMode = params.onChain?.publishMode ?? 'sync';
    if (params.onChain?.txCallback) {
      publishMode = 'callback';
    }

    switch (publishMode) {
      case 'sync':
        await txPromise;
        break;
      case 'callback': {
        if (!params.onChain?.txCallback) {
          throw new Error('txCallback is required for publishMode "callback"');
        }
        const cb = params.onChain?.txCallback;
        txPromise.then((receipt) => cb(receipt));
        break;
      }
      case 'async': {
        const mb = MessageBus.getInstance();
        txPromise.then((receipt) => mb.publish(SDK_EVENTS.TX_RECEIPT_ACCEPTED, receipt));
        break;
      }
      default:
        throw new Error(`Invalid publishMode: ${publishMode}`);
    }
  }
}

/**
 * Implementation of the ICredentialStatusPublisher interface for publishing off-chain credential status.
 */
export class Iden3SmtRhsCredentialStatusPublisher implements ICredentialStatusPublisher {
  /**
   * Publishes the credential status to a specified node URL.
   * @param params - The parameters for publishing the credential status.
   * @param params.nodes - The proof nodes to be published.
   * @param params.rhsUrl - The URL of the node to publish the credential status to.
   * @returns A promise that resolves when the credential status is successfully published.
   * @throws An error if the publishing fails.
   */
  public async publish(params: {
    nodes: ProofNode[];
    credentialStatusType: CredentialStatusType;

    rhsUrl: string;
  }): Promise<void> {
    if (
      ![CredentialStatusType.Iden3ReverseSparseMerkleTreeProof].includes(
        params.credentialStatusType
      )
    ) {
      throw new Error(
        `On-chain publishing is not supported for credential status type ${params.credentialStatusType}`
      );
    }
    const nodesJSON = params.nodes.map((n) => n.toJSON());
    const resp = await fetch(params.rhsUrl + '/node', {
      method: 'post',
      body: JSON.stringify(nodesJSON)
    });
    if (resp.status !== 200) {
      throw new Error(`Failed to publish credential status. Status: ${resp.status}`);
    }
  }
}