@0xpolygonid/js-sdk 1.6.1 → 1.7.0

package/dist/types/identity/identity-wallet.d.ts

@@ -1,20 +1,21 @@
 import { KMS, KmsKeyId, KmsKeyType } from '../kms';
 import { Claim, DID } from '@iden3/js-iden3-core';
 import { Signature } from '@iden3/js-crypto';
-import { IDataStorage } from '../storage/interfaces/data-storage';
+import { IDataStorage, Profile } from '../storage';
 import { W3CCredential, MerkleTreeProofWithTreeState, CredentialStatusType, ProofQuery } from '../verifiable';
 import { CredentialRequest, ICredentialWallet, TreesModel } from '../credentials';
 import { TreeState } from '../circuits';
 import { Options } from '@iden3/js-jsonld-merklization';
-import { Profile } from '../storage';
+import { TransactionReceipt } from 'ethers';
+import { CredentialStatusPublisherRegistry } from '../credentials/status/credential-status-publisher';
 /**
  * DID creation options
- * seed - seed to generate BJJ keypair
+ * seed - seed to generate BJJ key pair
  * revocationOpts -
 
- * @interface IdentityCreationOptions
+ * @type IdentityCreationOptions
  */
-export interface IdentityCreationOptions {
+export type IdentityCreationOptions = {
     method?: string;
     blockchain?: string;
     networkId?: string;
@@ -22,9 +23,23 @@ export interface IdentityCreationOptions {
         id: string;
         type: CredentialStatusType;
         nonce?: number;
+        onChain?: {
+            txCallback?: (tx: TransactionReceipt) => Promise<void>;
+        };
     };
     seed?: Uint8Array;
-}
+};
+/**
+ * Options for RevocationInfoOptions.
+ */
+export type RevocationInfoOptions = {
+    revokedNonces?: number[];
+    treeModel?: TreesModel;
+    rhsUrl?: string;
+    onChain?: {
+        txCallback?: (tx: TransactionReceipt) => Promise<void>;
+    };
+};
 /**
  *  Proof creation result
  *
@@ -151,23 +166,32 @@ export interface IIdentityWallet {
      */
     addCredentialsToMerkleTree(credentials: W3CCredential[], issuerDID: DID): Promise<Iden3ProofCreationResult>;
     /**
+     * Publishes issuer state to the reverse hash service by given URL
      *
-     *
+     * @deprecated use publishRevocationInfoByCredentialStatusType instead with the same arguments in opts
      * @param {DID} issuerDID - issuer did
      * @param {string} rhsURL - reverse hash service URL
      * @param {number[]} [revokedNonces] - revoked nonces for the period from the last published
      * @returns `Promise<void>`
      */
-    publishStateToRHS(issuerDID: DID, rhsURL: string, revokedNonces?: number[]): Promise<void>;
+    publishStateToRHS(issuerDID: DID, rhsURL: string, revokedNonces?: number[], opts?: object): Promise<void>;
     /**
-     *
-     *
+     * Publishes specific state to the reverse hash service by given URL
+     * @deprecated use publishRevocationInfoByCredentialStatusType instead with the same arguments in opts
      * @param {TreesModel} treeModel - trees model to publish
      * @param {string} rhsURL - reverse hash service URL
      * @param {number[]} [revokedNonces] - revoked nonces for the period from the last published
      * @returns `Promise<void>`
      */
-    publishSpecificStateToRHS(treeModel: TreesModel, rhsURL: string, revokedNonces?: number[]): Promise<void>;
+    publishSpecificStateToRHS(treeModel: TreesModel, rhsURL: string, revokedNonces?: number[], opts?: object): Promise<void>;
+    /**
+     * Publishes revocation info by credential status predefined publishers
+     *
+     * @param {(RevocationInfoOptions)} opts
+     * @returns {Promise<void>}
+     * @memberof IIdentityWallet
+     */
+    publishRevocationInfoByCredentialStatusType(issuerDID: DID, credentialStatusType: CredentialStatusType, opts?: RevocationInfoOptions): Promise<void>;
     /**
      * Extracts core claim from signature or merkle tree proof. If both proof persists core claim must be the same
      *
@@ -237,6 +261,8 @@ export declare class IdentityWallet implements IIdentityWallet {
     private readonly _kms;
     private readonly _storage;
     private readonly _credentialWallet;
+    private readonly _opts?;
+    private readonly _credentialStatusPublisherRegistry;
     /**
      * Constructs a new instance of the `IdentityWallet` class
      *
@@ -245,7 +271,9 @@ export declare class IdentityWallet implements IIdentityWallet {
      * @param {ICredentialWallet} _credentialWallet - credential wallet instance to quickly access credential CRUD functionality
      * @public
      */
-    constructor(_kms: KMS, _storage: IDataStorage, _credentialWallet: ICredentialWallet);
+    constructor(_kms: KMS, _storage: IDataStorage, _credentialWallet: ICredentialWallet, _opts?: {
+        credentialStatusPublisherRegistry?: CredentialStatusPublisherRegistry | undefined;
+    } | undefined);
     /**
      * {@inheritDoc IIdentityWallet.createIdentity}
      */
@@ -293,7 +321,8 @@ export declare class IdentityWallet implements IIdentityWallet {
     publishSpecificStateToRHS(treeModel: TreesModel, rhsURL: string, revokedNonces?: number[]): Promise<void>;
     /** {@inheritDoc IIdentityWallet.publishStateToRHS} */
     publishStateToRHS(issuerDID: DID, rhsURL: string, revokedNonces?: number[]): Promise<void>;
-    private getKMSIdByAuthCredential;
+    /** {@inheritDoc IIdentityWallet.publishRevocationInfoByCredentialStatusType} */
+    publishRevocationInfoByCredentialStatusType(issuerDID: DID, credentialStatusType: CredentialStatusType, opts?: RevocationInfoOptions): Promise<void>;
     getCoreClaimFromCredential(credential: W3CCredential): Promise<Claim>;
     findOwnedCredentialsByDID(did: DID, query: ProofQuery): Promise<W3CCredential[]>;
     /** {@inheritDoc IIdentityWallet.updateIdentityState} */

package/dist/types/storage/blockchain/index.d.ts

@@ -1,2 +1,3 @@
 export * from './state';
 export * from './onchain-zkp-verifier';
+export * from './onchain-revocation';

package/dist/types/storage/blockchain/onchain-revocation.d.ts

@@ -1,4 +1,5 @@
 import { RevocationStatus } from '../../verifiable';
+import { Signer, TransactionReceipt } from 'ethers';
 import { EthConnectionConfig } from './state';
 /**
  * OnChainRevocationStore is a class that allows to interact with the onchain contract
@@ -8,8 +9,10 @@ import { EthConnectionConfig } from './state';
  * @class OnChainIssuer
  */
 export declare class OnChainRevocationStorage {
-    private readonly onchainContract;
-    private readonly provider;
+    private readonly _config;
+    private _signer?;
+    private readonly _contract;
+    private readonly _provider;
     /**
      *
      * Creates an instance of OnChainIssuer.
@@ -17,7 +20,7 @@ export declare class OnChainRevocationStorage {
      * @param {string} - onhcain contract address
      * @param {string} - rpc url to connect to the blockchain
      */
-    constructor(config: EthConnectionConfig, contractAddress: string);
+    constructor(_config: EthConnectionConfig, contractAddress: string, _signer?: Signer | undefined);
     /**
      * Get revocation status by issuerId, issuerState and nonce from the onchain.
      * @public
@@ -30,6 +33,7 @@ export declare class OnChainRevocationStorage {
      * @returns Promise<RevocationStatus>
      */
     getRevocationStatus(issuerID: bigint, nonce: number): Promise<RevocationStatus>;
+    saveNodes(payload: bigint[][]): Promise<TransactionReceipt>;
     private static convertIssuerInfo;
     private static convertSmtProofToProof;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xpolygonid/js-sdk",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "SDK to work with Polygon ID",
   "main": "dist/node/cjs/index.js",
   "module": "dist/node/esm/index.js",