@0xpolygonid/js-sdk 1.21.3 → 1.24.1

package/dist/types/storage/blockchain/erc20-helper.d.ts

@@ -0,0 +1,19 @@
+import { Signer, ethers } from 'ethers';
+/**
+ * @beta
+ * getPermitSignature is a function to create EIP712 Permit signature
+ * @param {Signer} signer - User who owns the tokens
+ * @param {string} tokenAddress - EIP-2612 contract address
+ * @param {string} spender -  The contract address that will spend tokens
+ * @param {bigint} value - Amount of tokens to approve
+ * @param {number} deadline - Timestamp when the permit expires
+ * @returns {Promise<PaymentRequestMessage>}
+ */
+export declare function getPermitSignature(signer: Signer, tokenAddress: string, spender: string, value: bigint, deadline: number): Promise<string>;
+/**
+ * @beta
+ * getERC20Decimals is a function to retrieve the number of decimals of an ERC20 token
+ * @param {string} tokenAddress - Token address
+ * @param {ethers.ContractRunner} runner - Contract runner
+ */
+export declare function getERC20Decimals(tokenAddress: string, runner: ethers.ContractRunner): Promise<number>;

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

@@ -1,3 +1,6 @@
 export * from './state';
 export * from './onchain-zkp-verifier';
 export * from './onchain-revocation';
+export * from './onchain-issuer';
+export * from './did-resolver-readonly-storage';
+export * from './erc20-helper';

package/dist/types/storage/blockchain/onchain-issuer-adapter/non-merklized/version/v0.0.1/onchain-non-merklized-issuer-adapter.d.ts

@@ -0,0 +1,66 @@
+import { DID, Id } from '@iden3/js-iden3-core';
+import { INonMerklizedIssuer } from '@iden3/onchain-non-merklized-issuer-base-abi';
+import { W3CCredential } from '../../../../../../verifiable';
+import { Options } from '@iden3/js-jsonld-merklization';
+import { EthConnectionConfig } from '../../../../state';
+/**
+ * `OnchainNonMerklizedIssuerAdapter` provides functionality to interact with a non-merklized on-chain credential issuer.
+ * This adapter enables interface detection, credential retrieval, and conversion to the W3C Verifiable Credential format.
+ *
+ * @public
+ * @beta
+ * @class OnchainNonMerklizedIssuerAdapter
+ */
+export declare class OnchainNonMerklizedIssuerAdapter {
+    private readonly _contract;
+    private readonly _contractAddress;
+    private readonly _chainId;
+    private readonly _issuerDid;
+    private readonly _merklizationOptions?;
+    /**
+     * Initializes an instance of `OnchainNonMerklizedIssuerAdapter`.
+     *
+     * @param ethConnectionConfig The configuration for the Ethereum connection.
+     * @param issuerDid The decentralized identifier (DID) of the issuer.
+     * @param merklizationOptions Optional settings for merklization.
+     */
+    constructor(ethConnectionConfig: EthConnectionConfig, issuerDid: DID, options?: {
+        merklizationOptions?: Options;
+    });
+    /**
+     * Checks if the contract supports required interfaces.
+     * Throws an error if any required interface is unsupported.
+     *
+     * @throws Error - If required interfaces are not supported.
+     */
+    isInterfaceSupported(): Promise<void>;
+    /**
+     * Retrieves a credential from the on-chain non-merklized contract.
+     * @param userId The user's core.Id.
+     * @param credentialId The unique identifier of the credential.
+     */
+    getCredential(userId: Id, credentialId: bigint): Promise<{
+        credentialData: INonMerklizedIssuer.CredentialDataStructOutput;
+        coreClaimBigInts: bigint[];
+        credentialSubjectFields: INonMerklizedIssuer.SubjectFieldStructOutput[];
+    }>;
+    /**
+     * Retrieves the credential IDs of a user.
+     * @param userId The user's core.Id.
+     * @returns An array of credential IDs.
+     */
+    getUserCredentialsIds(userId: Id): Promise<bigint[]>;
+    /**
+     * Converts on-chain credential to a verifiable credential.
+     *
+     * @param credentialData Data structure of the credential from the contract.
+     * @param coreClaimBigInts Claim data in bigint format.
+     * @param credentialSubjectFields Subject fields of the credential.
+     */
+    convertOnChainInfoToW3CCredential(credentialData: INonMerklizedIssuer.CredentialDataStructOutput, coreClaimBigInts: bigint[], credentialSubjectFields: INonMerklizedIssuer.SubjectFieldStructOutput[]): Promise<W3CCredential>;
+    private credentialId;
+    private convertCredentialSubject;
+    private existenceProof;
+    private validateSourceValue;
+    private convertDisplayMethod;
+}

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

@@ -0,0 +1,40 @@
+import { DID } from '@iden3/js-iden3-core';
+import { Options } from '@iden3/js-jsonld-merklization';
+import { W3CCredential } from '../../verifiable';
+import { EthConnectionConfig } from './state';
+import { IOnchainIssuer } from '../interfaces/onchain-issuer';
+interface OnchainIssuerOptions {
+    merklizationOptions?: Options;
+}
+/**
+ * Represents an adapter for interacting with on-chain issuers.
+ *
+ * @public
+ * @beta
+ * @class OnchainIssuer
+ */
+export declare class OnchainIssuer implements IOnchainIssuer {
+    private readonly _ethConnectionConfig;
+    private readonly _onchainIssuerOptions?;
+    /**
+     * Initializes an instance of `Adapter`.
+     * @param config The configuration for the Ethereum connection.
+     * @param merklizationOptions Optional settings for merklization.
+     */
+    constructor(config: EthConnectionConfig[], options?: OnchainIssuerOptions);
+    /**
+     * Retrieves a credential from the on-chain issuer.
+     * @param issuerDID The issuer's core.DID.
+     * @param userId The user's core.Id.
+     * @param credentialId The unique identifier of the credential.
+     */
+    getCredential(issuerDID: DID, userDID: DID, credentialId: bigint): Promise<W3CCredential>;
+    /**
+     * Retrieves the credential identifiers for a user from the on-chain issuer.
+     * @param issuerDID The issuer's core.DID.
+     * @param userId The user's core.Id.
+     */
+    getUserCredentialIds(issuerDID: DID, userDID: DID): Promise<bigint[]>;
+    private getContractConnection;
+}
+export {};

package/dist/types/storage/blockchain/onchain-zkp-verifier.d.ts

@@ -2,6 +2,7 @@ import { Signer } from 'ethers';
 import { EthConnectionConfig } from './state';
 import { IOnChainZKPVerifier } from '../interfaces/onchain-zkp-verifier';
 import { ContractInvokeTransactionData, JsonDocumentObjectValue, ZeroKnowledgeProofResponse } from '../../iden3comm';
+import { GlobalStateUpdate } from '../entities/state';
 /**
  * Supported function signature for SubmitZKPResponse
  */
@@ -33,11 +34,7 @@ export declare class OnChainZKPVerifier implements IOnChainZKPVerifier {
     /**
      * supported circuits
      */
-    private readonly _supportedCircuits;
-    /**
-     * abi coder to encode/decode structures to solidity bytes
-     */
-    private readonly _abiCoder;
+    private static readonly _supportedCircuits;
     /**
      *
      * Creates an instance of OnChainZKPVerifier.
@@ -45,6 +42,7 @@ export declare class OnChainZKPVerifier implements IOnChainZKPVerifier {
      * @param {EthConnectionConfig[]} - array of ETH configs
      */
     constructor(_configs: EthConnectionConfig[], _opts?: OnChainZKPVerifierOptions | undefined);
+    static prepareTxArgsSubmitV1(txData: ContractInvokeTransactionData, zkProofResponse: ZeroKnowledgeProofResponse): Promise<JsonDocumentObjectValue[]>;
     /**
      * {@inheritDoc IOnChainZKPVerifier.prepareTxArgsSubmitV1}
      */
@@ -57,12 +55,13 @@ export declare class OnChainZKPVerifier implements IOnChainZKPVerifier {
      * {@inheritDoc IOnChainZKPVerifier.submitZKPResponseV2}
      */
     submitZKPResponseV2(ethSigner: Signer, txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<Map<string, ZeroKnowledgeProofResponse[]>>;
+    static prepareTxArgsSubmitV2(resolverUrl: string, txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<JsonDocumentObjectValue[]>;
     prepareTxArgsSubmitV2(txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<JsonDocumentObjectValue[]>;
-    private packZkpProof;
-    private packCrossChainProofs;
-    private packGlobalStateMsg;
-    private packIdentityStateMsg;
-    private packMetadatas;
-    private getOnChainGistRootStatePubSignals;
-    private resolveDidDocumentEip712MessageAndSignature;
+    private static packZkpProof;
+    private static packCrossChainProofs;
+    static packGlobalStateMsg(msg: GlobalStateUpdate): string;
+    private static packIdentityStateMsg;
+    private static packMetadatas;
+    private static getOnChainGistRootStatePubSignals;
+    private static resolveDidDocumentEip712MessageAndSignature;
 }

package/dist/types/storage/entities/state.d.ts

@@ -1,3 +1,4 @@
+import { ProofJSON } from '@iden3/js-merkletree';
 /**
  * state information of identity from chain.
  *
@@ -42,6 +43,7 @@ export interface RootInfo {
     replacedAtTimestamp: bigint;
     createdAtBlock: bigint;
     replacedAtBlock: bigint;
+    proof?: ProofJSON;
 }
 /**
  * identity state message

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

@@ -7,3 +7,4 @@ export * from './data-source';
 export * from './circuits';
 export * from './onchain-zkp-verifier';
 export * from './onchain-revocation';
+export * from './onchain-issuer';

package/dist/types/storage/interfaces/onchain-issuer.d.ts

@@ -0,0 +1,12 @@
+import { DID } from '@iden3/js-iden3-core';
+import { W3CCredential } from '../../verifiable';
+/**
+ * Interface that allows the processing of the on-chain issuer
+ *
+ * @beta
+ * @interface IOnchainIssuer
+ */
+export interface IOnchainIssuer {
+    getCredential(issuerDID: DID, userDID: DID, credentialId: bigint): Promise<W3CCredential>;
+    getUserCredentialIds(issuerDID: DID, userDID: DID): Promise<bigint[]>;
+}

package/dist/types/verifiable/constants.d.ts

@@ -87,37 +87,54 @@ export declare enum RefreshServiceType {
     Iden3RefreshService2023 = "Iden3RefreshService2023"
 }
 /**
- * PaymentRequestType type for payment requests
+ * PaymentRequestDataType type for payment requests
  * @beta
  * @enum {string}
  */
-export declare enum PaymentRequestType {
-    PaymentRequest = "PaymentRequest"
+export declare enum PaymentRequestDataType {
+    Iden3PaymentRequestCryptoV1 = "Iden3PaymentRequestCryptoV1",
+    Iden3PaymentRailsRequestV1 = "Iden3PaymentRailsRequestV1",
+    Iden3PaymentRailsERC20RequestV1 = "Iden3PaymentRailsERC20RequestV1"
 }
 /**
- * PaymentRequestDataType type for payment requests
+ * PaymentType type for payment responses
  * @beta
  * @enum {string}
  */
-export declare enum PaymentRequestDataType {
-    Iden3PaymentRequestCryptoV1 = "Iden3PaymentRequestCryptoV1"
+export declare enum PaymentType {
+    Iden3PaymentCryptoV1 = "Iden3PaymentCryptoV1",
+    Iden3PaymentRailsV1 = "Iden3PaymentRailsV1",
+    Iden3PaymentRailsERC20V1 = "Iden3PaymentRailsERC20V1"
 }
 /**
- * PaymentType type for payment responses
+ * SupportedPaymentProofType type for payment proofs
  * @beta
  * @enum {string}
  */
-export declare enum PaymentType {
-    Iden3PaymentCryptoV1 = "Iden3PaymentCryptoV1"
+export declare enum SupportedPaymentProofType {
+    EthereumEip712Signature2021 = "EthereumEip712Signature2021"
 }
 /**
  * Media types for Payment supported currencies
  * @beta
- * @enum {number}
+ * @enum {string}
  */
 export declare enum SupportedCurrencies {
     ETH = "ETH",
-    MATIC = "MATIC"
+    ETH_WEI = "ETHWEI",
+    ETH_GWEI = "ETHGWEI",
+    MATIC = "MATIC",
+    POL = "POL",
+    USDT = "USDT",
+    USDC = "USDC"
+}
+/**
+ * Supported features for payment-request
+ * @beta
+ * @enum {string}
+ */
+export declare enum PaymentFeatures {
+    EIP_2612 = "EIP-2612"
 }
 /**
  * DisplayMethodType type for display method

package/dist/types/verifiable/credential.d.ts

@@ -1,8 +1,8 @@
 import { BJJSignatureProof2021, Iden3SparseMerkleTreeProof, CredentialStatus, RefreshService, DisplayMethod } from './proof';
-import { Claim } from '@iden3/js-iden3-core';
+import { Claim, DID } from '@iden3/js-iden3-core';
 import { Proof } from '@iden3/js-merkletree';
 import { Merklizer, Options } from '@iden3/js-jsonld-merklization';
-import { CredentialStatusResolverRegistry } from '../credentials';
+import { CredentialRequest, CredentialStatusResolverRegistry } from '../credentials';
 import { ProofType } from './constants';
 import { CoreClaimCreationOptions } from './core-utils';
 import { JsonDocumentObject } from '../iden3comm';
@@ -26,6 +26,19 @@ export declare class W3CCredential {
     issuer: string;
     credentialSchema: CredentialSchema;
     proof?: object | unknown[];
+    /**
+     *
+     * @param issuer - DID of the issuer
+     * @param request - Credential request
+     * @returns - W3C Credential
+     */
+    static fromCredentialRequest(issuer: DID, request: CredentialRequest): W3CCredential;
+    /**
+     * Builds credential status
+     * @param {CredentialRequest} request
+     * @returns `CredentialStatus`
+     */
+    private static buildCredentialStatus;
     toJSON(): this & {
         proof: any;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xpolygonid/js-sdk",
-  "version": "1.21.3",
+  "version": "1.24.1",
   "description": "SDK to work with Polygon ID",
   "main": "dist/node/cjs/index.js",
   "module": "dist/node/esm/index.js",
@@ -51,7 +51,6 @@
   "homepage": "https://github.com/0xPolygonID/js-sdk#readme",
   "devDependencies": {
     "@cspell/eslint-plugin": "^8.14.2",
-    "@gr2m/fetch-mock": "9.11.0-pull-request-644.1",
     "@iden3/eslint-config": "https://github.com/iden3/eslint-config",
     "@microsoft/api-documenter": "^7.8.20",
     "@microsoft/api-extractor": "^7.9.0",
@@ -80,6 +79,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
     "mocha": "10.2.0",
+    "nock": "^14.0.0-beta.16",
     "prettier": "^2.7.1",
     "rimraf": "^5.0.5",
     "rollup": "^4.14.3",
@@ -98,6 +98,7 @@
     "snarkjs": "0.7.4"
   },
   "dependencies": {
+    "@iden3/onchain-non-merklized-issuer-base-abi": "^0.0.3",
     "@noble/curves": "^1.4.0",
     "ajv": "8.12.0",
     "ajv-formats": "2.1.1",