@0xpolygonid/js-sdk 1.21.1 → 1.23.0

package/dist/types/iden3comm/types/packer.d.ts

@@ -29,6 +29,9 @@ export type JsonDocumentObject = {
  * 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;
@@ -37,6 +40,15 @@ export type BasicMessage = {
     body?: unknown;
     from?: string;
     to?: string;
+    created_time?: number;
+    expires_time?: number;
+};
+/**
+ * Basic message with all possible fields required
+ */
+export type RequiredBasicMessage = Omit<Required<BasicMessage>, 'created_time' | 'expires_time'> & {
+    created_time?: number;
+    expires_time?: number;
 };
 /**
  *  parameters for any packer
@@ -111,6 +123,19 @@ export interface IPacker {
      * @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

package/dist/types/iden3comm/types/protocol/accept-profile.d.ts

@@ -0,0 +1,7 @@
+import { AcceptAuthCircuits, AcceptJwsAlgorithms, AcceptJwzAlgorithms, MediaType, ProtocolVersion } from '../../constants';
+export type AcceptProfile = {
+    protocolVersion: ProtocolVersion;
+    env: MediaType;
+    circuits?: AcceptAuthCircuits[];
+    alg?: AcceptJwsAlgorithms[] | AcceptJwzAlgorithms[];
+};

package/dist/types/iden3comm/types/protocol/auth.d.ts

@@ -31,6 +31,7 @@ export type AuthorizationRequestMessageBody = {
     message?: string;
     did_doc?: DIDDocument;
     scope: Array<ZeroKnowledgeProofRequest>;
+    accept?: string[];
 };
 /** ZeroKnowledgeProofRequest represents structure of zkp request object */
 export type ZeroKnowledgeProofRequest = {

package/dist/types/iden3comm/types/protocol/credentials.d.ts

@@ -1,6 +1,6 @@
 import { W3CCredential } from '../../../verifiable';
 import { PROTOCOL_MESSAGE_TYPE } from '../../constants';
-import { BasicMessage, JsonDocumentObject } from '../packer';
+import { BasicMessage, JsonDocumentObject, RequiredBasicMessage } from '../packer';
 import { ContractInvokeTransactionData } from './contract-request';
 /** CredentialIssuanceRequestMessageBody represents data for credential issuance request */
 export type CredentialIssuanceRequestMessageBody = {
@@ -9,12 +9,12 @@ export type CredentialIssuanceRequestMessageBody = {
     expiration: number;
 };
 /** CredentialIssuanceRequestMessage represent Iden3message for credential request */
-export type CredentialIssuanceRequestMessage = Required<BasicMessage> & {
+export type CredentialIssuanceRequestMessage = RequiredBasicMessage & {
     body: CredentialIssuanceRequestMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.CREDENTIAL_ISSUANCE_REQUEST_MESSAGE_TYPE;
 };
 /** CredentialsOfferMessage represent Iden3message for credential offer */
-export type CredentialsOfferMessage = Required<BasicMessage> & {
+export type CredentialsOfferMessage = RequiredBasicMessage & {
     body: CredentialsOfferMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.CREDENTIAL_OFFER_MESSAGE_TYPE;
 };
@@ -24,7 +24,7 @@ export type CredentialsOfferMessageBody = {
     credentials: CredentialOffer[];
 };
 /** CredentialsOnchainOfferMessage represent Iden3message for credential onchain offer message */
-export type CredentialsOnchainOfferMessage = Required<BasicMessage> & {
+export type CredentialsOnchainOfferMessage = RequiredBasicMessage & {
     body: CredentialsOnchainOfferMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.CREDENTIAL_ONCHAIN_OFFER_MESSAGE_TYPE;
 };
@@ -46,7 +46,7 @@ export type CredentialOffer = {
     status?: CredentialOfferStatus;
 };
 /** CredentialIssuanceMessage represent Iden3message for credential issuance */
-export type CredentialIssuanceMessage = Required<BasicMessage> & {
+export type CredentialIssuanceMessage = RequiredBasicMessage & {
     body: IssuanceMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.CREDENTIAL_ISSUANCE_RESPONSE_MESSAGE_TYPE;
 };
@@ -70,7 +70,7 @@ export type Schema = {
     type: string;
 };
 /** CredentialRefreshMessage represent Iden3message for credential refresh request */
-export type CredentialRefreshMessage = Required<BasicMessage> & {
+export type CredentialRefreshMessage = RequiredBasicMessage & {
     body: CredentialRefreshMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.CREDENTIAL_REFRESH_MESSAGE_TYPE;
 };

package/dist/types/iden3comm/types/protocol/messages.d.ts

@@ -1,7 +1,7 @@
-import { BasicMessage } from '../';
+import { RequiredBasicMessage } from '../';
 import { PROTOCOL_MESSAGE_TYPE } from '../../constants';
 /**  MessageFetchRequestMessage represent Iden3message for message fetch request. */
-export type MessageFetchRequestMessage = Required<BasicMessage> & {
+export type MessageFetchRequestMessage = RequiredBasicMessage & {
     body: MessageFetchRequestMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.CREDENTIAL_FETCH_REQUEST_MESSAGE_TYPE;
 };

package/dist/types/iden3comm/types/protocol/payment.d.ts

@@ -1,5 +1,5 @@
 import { BasicMessage } from '../';
-import { PaymentRequestDataType, PaymentRequestType, PaymentType, SupportedCurrencies } from '../../../verifiable';
+import { PaymentFeatures, PaymentRequestDataType, SupportedCurrencies, SupportedPaymentProofType } from '../../../verifiable';
 import { PROTOCOL_MESSAGE_TYPE } from '../../constants';
 /** @beta PaymentRequestMessage is struct the represents payment-request message */
 export type PaymentRequestMessage = BasicMessage & {
@@ -17,20 +17,52 @@ export type PaymentRequestInfo = {
         type: string;
         context: string;
     }[];
-    type: PaymentRequestType;
-    data: PaymentRequestDataInfo;
-    expiration?: string;
+    data: Iden3PaymentRequestCryptoV1 | (Iden3PaymentRequestCryptoV1 | Iden3PaymentRailsRequestV1 | Iden3PaymentRailsERC20RequestV1)[];
     description?: string;
 };
-/** @beta PaymentRequestDataInfo is struct the represents payment data info for payment-request */
-export type PaymentRequestDataInfo = {
-    type: PaymentRequestDataType;
+/** @beta Iden3PaymentRequestCryptoV1 is struct the represents payment data info for payment-request */
+export type Iden3PaymentRequestCryptoV1 = {
+    type: PaymentRequestDataType.Iden3PaymentRequestCryptoV1;
+    '@context'?: string | (string | object)[];
     amount: string;
     id: string;
     chainId: string;
     address: string;
-    currency: SupportedCurrencies;
-    signature?: string;
+    currency: SupportedCurrencies | string;
+    expiration?: string;
+};
+export type Iden3PaymentRailsRequestV1 = {
+    type: PaymentRequestDataType.Iden3PaymentRailsRequestV1;
+    '@context': string | (string | object)[];
+    recipient: string;
+    amount: string;
+    currency: SupportedCurrencies | string;
+    expirationDate: string;
+    nonce: string;
+    metadata: string;
+    proof: EthereumEip712Signature2021 | EthereumEip712Signature2021[];
+};
+export type Iden3PaymentRailsERC20RequestV1 = Omit<Required<Iden3PaymentRailsRequestV1>, 'type'> & {
+    tokenAddress: string;
+    features?: PaymentFeatures[];
+    type: PaymentRequestDataType.Iden3PaymentRailsERC20RequestV1;
+};
+export type EthereumEip712Signature2021 = {
+    type: SupportedPaymentProofType.EthereumEip712Signature2021;
+    proofPurpose: string;
+    proofValue: string;
+    verificationMethod: string;
+    created: string;
+    eip712: {
+        types: string;
+        primaryType: string;
+        domain: {
+            name: string;
+            version: string;
+            chainId: string;
+            verifyingContract: string;
+        };
+    };
 };
 /** @beta  PaymentMessage is struct the represents payment message */
 export type PaymentMessage = BasicMessage & {
@@ -39,13 +71,55 @@ export type PaymentMessage = BasicMessage & {
 };
 /** @beta  PaymentMessageBody is struct the represents body for payment message */
 export type PaymentMessageBody = {
-    payments: PaymentInfo[];
+    payments: PaymentTypeUnion[];
 };
-/** @beta PaymentInfo is struct the represents payment info for payment */
-export type PaymentInfo = {
+/** @beta Iden3PaymentCryptoV1 is struct the represents payment info for payment */
+export type Iden3PaymentCryptoV1 = {
     id: string;
-    type: PaymentType;
+    type: 'Iden3PaymentCryptoV1';
+    '@context'?: string | (string | object)[];
+    paymentData: {
+        txId: string;
+    };
+};
+/** @beta Iden3PaymentRailsV1 is struct the represents payment info for Iden3PaymentRailsRequestV1 */
+export type Iden3PaymentRailsV1 = {
+    nonce: string;
+    type: 'Iden3PaymentRailsV1';
+    '@context': string | (string | object)[];
     paymentData: {
         txId: string;
+        chainId: string;
     };
 };
+/** @beta Iden3PaymentRailsERC20V1 is struct the represents payment info for Iden3PaymentRailsERC20RequestV1 */
+export type Iden3PaymentRailsERC20V1 = {
+    nonce: string;
+    type: 'Iden3PaymentRailsERC20V1';
+    '@context': string | (string | object)[];
+    paymentData: {
+        txId: string;
+        chainId: string;
+        tokenAddress: string;
+    };
+};
+/** @beta MultiChainPaymentConfig is struct that represents payments contracts information for different chains */
+export type MultiChainPaymentConfig = {
+    chainId: string;
+    paymentContract: string;
+    recipient: string;
+    erc20TokenAddressArr: {
+        symbol: string;
+        address: string;
+    }[];
+};
+/**
+ * @beta
+ * PaymentRequestTypeUnion is a type of supported payment request types
+ */
+export type PaymentRequestTypeUnion = Iden3PaymentRequestCryptoV1 | Iden3PaymentRailsRequestV1 | Iden3PaymentRailsERC20RequestV1;
+/**
+ * @beta
+ * PaymentTypeUnion is a type of supported payment types
+ */
+export type PaymentTypeUnion = Iden3PaymentCryptoV1 | Iden3PaymentRailsV1 | Iden3PaymentRailsERC20V1;

package/dist/types/iden3comm/types/protocol/proof.d.ts

@@ -1,8 +1,8 @@
-import { BasicMessage } from '../';
+import { RequiredBasicMessage } from '../';
 import { PROTOCOL_MESSAGE_TYPE } from '../../constants';
 import { ZeroKnowledgeProofRequest, ZeroKnowledgeProofResponse } from './auth';
 /** ProofGenerationRequestMessage is struct the represents body for proof generation request */
-export type ProofGenerationRequestMessage = Required<BasicMessage> & {
+export type ProofGenerationRequestMessage = RequiredBasicMessage & {
     body: ProofGenerationRequestMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.PROOF_GENERATION_REQUEST_MESSAGE_TYPE;
 };
@@ -11,7 +11,7 @@ export type ProofGenerationRequestMessageBody = {
     scope: Array<ZeroKnowledgeProofRequest>;
 };
 /** ProofGenerationResponseMessage is struct the represents body for proof generation request */
-export type ProofGenerationResponseMessage = Required<BasicMessage> & {
+export type ProofGenerationResponseMessage = RequiredBasicMessage & {
     body: ResponseMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.PROOF_GENERATION_RESPONSE_MESSAGE_TYPE;
 };

package/dist/types/iden3comm/types/protocol/revocation.d.ts

@@ -1,4 +1,4 @@
-import { BasicMessage } from '../';
+import { BasicMessage, RequiredBasicMessage } from '../';
 import { RevocationStatus } from '../../../verifiable';
 import { PROTOCOL_MESSAGE_TYPE } from '../../constants';
 /** RevocationStatusRequestMessage is struct the represents body for proof generation request */
@@ -11,7 +11,7 @@ export type RevocationStatusRequestMessageBody = {
     revocation_nonce: number;
 };
 /** RevocationStatusResponseMessage is struct the represents body for proof generation request */
-export type RevocationStatusResponseMessage = Required<BasicMessage> & {
+export type RevocationStatusResponseMessage = RequiredBasicMessage & {
     body: RevocationStatusResponseMessageBody;
     type: typeof PROTOCOL_MESSAGE_TYPE.REVOCATION_STATUS_RESPONSE_MESSAGE_TYPE;
 };

package/dist/types/iden3comm/utils/accept-profile.d.ts

@@ -0,0 +1,3 @@
+import { AcceptProfile } from '../types';
+export declare const buildAccept: (profiles: AcceptProfile[]) => string[];
+export declare const parseAcceptProfile: (profile: string) => AcceptProfile;

package/dist/types/iden3comm/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './envelope';
 export * from './message';
 export * from './did';
+export * from './accept-profile';

package/dist/types/storage/blockchain/erc20-permit-sig.d.ts

@@ -0,0 +1,12 @@
+import { Signer } 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>;

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

@@ -1,3 +1,4 @@
 export * from './state';
 export * from './onchain-zkp-verifier';
 export * from './onchain-revocation';
+export * from './erc20-permit-sig';

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

@@ -87,37 +87,53 @@ 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",
+    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xpolygonid/js-sdk",
-  "version": "1.21.1",
+  "version": "1.23.0",
   "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.15",
     "prettier": "^2.7.1",
     "rimraf": "^5.0.5",
     "rollup": "^4.14.3",