@0xpolygonid/js-sdk 1.12.0 → 1.13.0

package/dist/browser/esm/index.js

@@ -7443,6 +7443,33 @@ var RefreshServiceType;
 (function (RefreshServiceType) {
     RefreshServiceType["Iden3RefreshService2023"] = "Iden3RefreshService2023";
 })(RefreshServiceType || (RefreshServiceType = {}));
+/**
+ * PaymentRequestType type for payment requests
+ *
+ * @enum {string}
+ */
+var PaymentRequestType;
+(function (PaymentRequestType) {
+    PaymentRequestType["PaymentRequest"] = "PaymentRequest";
+})(PaymentRequestType || (PaymentRequestType = {}));
+/**
+ * PaymentRequestDataType type for payment requests
+ *
+ * @enum {string}
+ */
+var PaymentRequestDataType;
+(function (PaymentRequestDataType) {
+    PaymentRequestDataType["Iden3PaymentRequestCryptoV1"] = "Iden3PaymentRequestCryptoV1";
+})(PaymentRequestDataType || (PaymentRequestDataType = {}));
+/**
+ * PaymentType type for payment responses
+ *
+ * @enum {string}
+ */
+var PaymentType;
+(function (PaymentType) {
+    PaymentType["Iden3PaymentCryptoV1"] = "Iden3PaymentCryptoV1";
+})(PaymentType || (PaymentType = {}));
 
 /**
  * Iden3SparseMerkleProof is a iden3 protocol merkle tree proof
@@ -53483,7 +53510,11 @@ const PROTOCOL_MESSAGE_TYPE = Object.freeze({
     // ProposalRequestMessageType is type for proposal-request message
     PROPOSAL_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/proposal-request',
     // ProposalMessageType is type for proposal message
-    PROPOSAL_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/proposal'
+    PROPOSAL_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/proposal',
+    // PaymentRequestMessageType is type for payment-request message
+    PAYMENT_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/payment-request',
+    // PaymentMessageType is type for payment message
+    PAYMENT_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/payment'
 });
 /**
  * Media types for iden3 comm communication protocol
@@ -58138,5 +58169,201 @@ class CredentialProposalHandler extends AbstractMessageHandler {
     }
 }
 
-export { AbstractMessageHandler, AbstractPrivateKeyStore, AgentResolver, AtomicQueryMTPV2Inputs, AtomicQueryMTPV2OnChainInputs, AtomicQueryMTPV2OnChainPubSignals, AtomicQueryMTPV2PubSignals, AtomicQuerySigV2Inputs, AtomicQuerySigV2OnChainCircuitInputs, AtomicQuerySigV2OnChainInputs, AtomicQuerySigV2OnChainPubSignals, AtomicQuerySigV2PubSignals, AtomicQueryV3Inputs, AtomicQueryV3OnChainInputs, AtomicQueryV3OnChainPubSignals, AtomicQueryV3PubSignals, AuthHandler, AuthV2Inputs, AuthV2PubSignals, BJJSignatureProof2021, BaseConfig, BjjProvider, BrowserDataSource, CircuitClaim, CircuitError, CircuitId, CircuitStorage, ContractRequestHandler, CredentialProposalHandler, CredentialStatusPublisherRegistry, CredentialStatusResolverRegistry, CredentialStatusType, CredentialStorage, CredentialWallet, DIDDocumentJSONSchema, DataPrepareHandlerFunc, Ed25519Provider, ErrorEmptyAuthClaimNonRevProof, ErrorEmptyAuthClaimProof, ErrorEmptyChallengeSignature, ErrorEmptyClaimNonRevProof, ErrorEmptyClaimProof, ErrorEmptyClaimSignature, ErrorEmptyIssuerAuthClaimNonRevProof, ErrorEmptyIssuerAuthClaimProof, ErrorUserStateInRelayClaimProof, EthStateStorage, FSCircuitStorage, FetchHandler, FilterQuery, Iden3OnchainSmtCredentialStatusPublisher, Iden3SmtRhsCredentialStatusPublisher, Iden3SparseMerkleTreeProof, IdentityStorage, IdentityWallet, InMemoryDataSource, InMemoryMerkleTreeStorage, InMemoryPrivateKeyStore, IndexedDBDataSource, IndexedDBPrivateKeyStore, InputGenerator, IssuerResolver, JSON_SCHEMA_VALIDATORS_REGISTRY, JWSPacker, JsonSchemaValidator, KMS, KmsKeyType, LDParser, LinkedMultiQueryInputs, LinkedMultiQueryPubSignals, LocalStoragePrivateKeyStore, MerkleTreeIndexedDBStorage, MerkleTreeLocalStorage, MerkleTreeType, MerklizedRootPosition, MessageBus, MessageHandler, NativeProver, OnChainResolver, OnChainRevocationStorage, OnChainZKPVerifier, Operators, constants as PROTOCOL_CONSTANTS, PackageManager, Parser, PlainPacker, ProofNode, ProofPurpose, ProofService, ProofType, PubSignalsVerifier, Query, QueryOperators, RHSResolver, RefreshHandler, RefreshServiceType, RevocationStatusHandler, SDK_EVENTS, Scalar, SearchError, Sec256k1Provider, StandardJSONCredentialsQueryFilter, StateTransitionInputs, StateTransitionPubSignals, SubjectPosition, TransactionService, ValueProof, Vector, VerifiableConstants, VerificationHandlerFunc, W3CCredential, XSDNS, ZKPPacker, availableTypesOperators, base58ToBytes$1 as base58ToBytes, base64ToBytes$1 as base64ToBytes, base64UrlToBytes, bigIntArrayToStringArray, bigIntCompare, buildDIDFromEthPubKey, buildFieldPath, buildTreeState, buildVerifierId, byteDecoder, byteEncoder, bytesToBase58$1 as bytesToBase58, bytesToBase64, bytesToBase64url$1 as bytesToBase64url, bytesToHex$3 as bytesToHex, cacheLoader, calculateCoreSchemaHash, calculateQueryHashV2, calculateQueryHashV3, checkCircuitOperator, checkCircuitQueriesLength, checkDataInField, checkQueryRequest, circuitValidator, comparatorOptions, createAuthorizationRequest, createAuthorizationRequestWithMessage, createProposal, createProposalRequest, createSchemaHash, createVerifiablePresentation, credentialSubjectKey, dataFillsSlot, decodeBase64url$1 as decodeBase64url, defaultEthConnectionConfig, defaultMTLevels, defaultMTLevelsClaim, defaultMTLevelsOnChain, defaultValueArraySize, defineMerklizedRootPosition, encodeBase64url, existenceToInt, extractProof, extractPublicKeyBytes, factoryComparer, fieldToByteArray, fieldValueFromVerifiablePresentation, fillCoreClaimSlot, fillSlot, findCredentialType, findValue, generateProfileDID, getFieldSlotIndex, getKMSIdByAuthCredential, getNodeAuxValue, getNodesRepresentation, getOperatorNameByValue, getProperties, getSerializationAttrFromContext, getSerializationAttrFromParsedContext, getUserDIDFromCredential, hexToBytes$3 as hexToBytes, isEthereumIdentity, isGenesisState, isGenesisStateId, isIssuerGenesis, isValidOperation, keyPath, mergeObjects, parseCoreClaimSlots, parseCredentialSubject, parseQueriesMetadata, parseQueryMetadata, parseSerializationAttr, prepareCircuitArrayValues, prepareSiblingsStr, processZeroKnowledgeProofRequests, pushHashesToRHS, resolveDIDDocumentAuth, resolvePath, resolveVerificationMethods, strMTHex, stringByPath, subjectPositionIndex, swapEndianness, toClaimNonRevStatus, toGISTProof, toRevocationStatus, transformQueryValueToBigInts, userStateError, validateDIDDocumentAuth, validateDisclosureNativeSDSupport, validateDisclosureV2Circuit, validateEmptyCredentialSubjectNoopNativeSupport, validateEmptyCredentialSubjectV2Circuit, validateOperators, validateTreeState, verifyFieldValueInclusionNativeExistsSupport, verifyFieldValueInclusionV2, witnessBuilder };
+/**
+ * @beta
+ * createPaymentRequest is a function to create protocol payment-request message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {string} agent - agent URL
+ * @param {PaymentRequestInfo[]} payments - payments
+ * @returns `PaymentRequestMessage`
+ */
+function createPaymentRequest(sender, receiver, agent, payments) {
+    const uuidv4 = v4();
+    const request = {
+        id: uuidv4,
+        thid: uuidv4,
+        from: sender.string(),
+        to: receiver.string(),
+        typ: MediaType.PlainMessage,
+        type: PROTOCOL_MESSAGE_TYPE.PAYMENT_REQUEST_MESSAGE_TYPE,
+        body: {
+            agent,
+            payments
+        }
+    };
+    return request;
+}
+/**
+ * @beta
+ * createPayment is a function to create protocol payment message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {PaymentInfo[]} payments - payments
+ * @returns `PaymentMessage`
+ */
+function createPayment(sender, receiver, payments) {
+    const uuidv4 = v4();
+    const request = {
+        id: uuidv4,
+        thid: uuidv4,
+        from: sender.string(),
+        to: receiver.string(),
+        typ: MediaType.PlainMessage,
+        type: PROTOCOL_MESSAGE_TYPE.PAYMENT_MESSAGE_TYPE,
+        body: {
+            payments
+        }
+    };
+    return request;
+}
+/**
+ *
+ * Allows to process PaymentRequest protocol message
+ * @beta
+ * @class PaymentHandler
+ * @implements implements IPaymentHandler interface
+ */
+class PaymentHandler extends AbstractMessageHandler {
+    /**
+     * @beta Creates an instance of PaymentHandler.
+     * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
+     * @param {PaymentHandlerParams} _params - payment handler params
+     *
+     */
+    constructor(_packerMgr, _params) {
+        super();
+        this._packerMgr = _packerMgr;
+        this._params = _params;
+    }
+    async handle(message, context) {
+        switch (message.type) {
+            case PROTOCOL_MESSAGE_TYPE.PAYMENT_REQUEST_MESSAGE_TYPE:
+                return await this.handlePaymentRequestMessage(message, context);
+            case PROTOCOL_MESSAGE_TYPE.PAYMENT_MESSAGE_TYPE:
+                await this.handlePayment(message, context);
+                return null;
+            default:
+                return super.handle(message, context);
+        }
+    }
+    /**
+     * @inheritdoc IPaymentHandler#parsePaymentRequest
+     */
+    async parsePaymentRequest(request) {
+        const { unpackedMessage: message } = await this._packerMgr.unpack(request);
+        const paymentRequest = message;
+        if (message.type !== PROTOCOL_MESSAGE_TYPE.PAYMENT_REQUEST_MESSAGE_TYPE) {
+            throw new Error('Invalid media type');
+        }
+        return paymentRequest;
+    }
+    async handlePaymentRequestMessage(paymentRequest, ctx) {
+        if (!paymentRequest.to) {
+            throw new Error(`failed request. empty 'to' field`);
+        }
+        if (!paymentRequest.from) {
+            throw new Error(`failed request. empty 'from' field`);
+        }
+        if (!paymentRequest.body?.payments?.length) {
+            throw new Error(`failed request. no 'payments' in body`);
+        }
+        if (!ctx.paymentHandler) {
+            throw new Error(`please provide payment handler in context`);
+        }
+        const senderDID = DID.parse(paymentRequest.to);
+        const receiverDID = DID.parse(paymentRequest.from);
+        const payments = [];
+        for (let i = 0; i < paymentRequest.body.payments.length; i++) {
+            const paymentReq = paymentRequest.body.payments[i];
+            if (paymentReq.type !== PaymentRequestType.PaymentRequest) {
+                throw new Error(`failed request. not supported '${paymentReq.type}' payment type `);
+            }
+            if (paymentReq.data.type !== PaymentRequestDataType.Iden3PaymentRequestCryptoV1) {
+                throw new Error(`failed request. not supported '${paymentReq.data.type}' payment type `);
+            }
+            const txId = await ctx.paymentHandler(paymentReq.data);
+            payments.push({
+                id: paymentReq.data.id,
+                type: PaymentType.Iden3PaymentCryptoV1,
+                paymentData: {
+                    txId
+                }
+            });
+        }
+        const paymentMessage = createPayment(senderDID, receiverDID, payments);
+        const response = await this.packMessage(paymentMessage, senderDID);
+        const agentResult = await fetch(paymentRequest.body.agent, {
+            method: 'POST',
+            body: response,
+            headers: {
+                'Content-Type': 'application/octet-stream'
+            }
+        });
+        const arrayBuffer = await agentResult.arrayBuffer();
+        if (!arrayBuffer.byteLength) {
+            return null;
+        }
+        const { unpackedMessage } = await this._packerMgr.unpack(new Uint8Array(arrayBuffer));
+        return unpackedMessage;
+    }
+    /**
+     * @inheritdoc IPaymentHandler#handlePaymentRequest
+     */
+    async handlePaymentRequest(request, opts) {
+        if (this._params.packerParams.mediaType === MediaType.SignedMessage &&
+            !this._params.packerParams.packerOptions) {
+            throw new Error(`jws packer options are required for ${MediaType.SignedMessage}`);
+        }
+        const paymentRequest = await this.parsePaymentRequest(request);
+        if (!paymentRequest.from) {
+            throw new Error(`failed request. empty 'from' field`);
+        }
+        if (!paymentRequest.to) {
+            throw new Error(`failed request. empty 'to' field`);
+        }
+        const agentMessage = await this.handlePaymentRequestMessage(paymentRequest, opts);
+        if (!agentMessage) {
+            return null;
+        }
+        const senderDID = DID.parse(paymentRequest.to);
+        return this.packMessage(agentMessage, senderDID);
+    }
+    /**
+     * @inheritdoc IPaymentHandler#handlePayment
+     */
+    async handlePayment(payment, opts) {
+        if (opts.paymentRequest.from !== payment.to) {
+            throw new Error(`sender of the request is not a target of response - expected ${opts.paymentRequest.from}, given ${payment.to}`);
+        }
+        if (!payment.body?.payments.length) {
+            throw new Error(`failed request. empty 'payments' field in body`);
+        }
+        for (let i = 0; i < payment.body.payments.length; i++) {
+            const p = payment.body?.payments[i];
+            const paymentRequestData = opts.paymentRequest.body?.payments.find((r) => r.data.id === p.id);
+            if (!paymentRequestData) {
+                throw new Error(`can't find payment request for payment id ${p.id}`);
+            }
+            if (!opts.paymentValidationHandler) {
+                throw new Error(`please provide payment validation handler in options`);
+            }
+            await opts.paymentValidationHandler(p.paymentData.txId, paymentRequestData.data);
+        }
+    }
+    async packMessage(message, senderDID) {
+        const responseEncoded = byteEncoder.encode(JSON.stringify(message));
+        const packerOpts = this._params.packerParams.mediaType === MediaType.SignedMessage
+            ? this._params.packerParams.packerOptions
+            : {
+                provingMethodAlg: proving.provingMethodGroth16AuthV2Instance.methodAlg
+            };
+        return await this._packerMgr.pack(this._params.packerParams.mediaType, responseEncoded, {
+            senderDID,
+            ...packerOpts
+        });
+    }
+}
+
+export { AbstractMessageHandler, AbstractPrivateKeyStore, AgentResolver, AtomicQueryMTPV2Inputs, AtomicQueryMTPV2OnChainInputs, AtomicQueryMTPV2OnChainPubSignals, AtomicQueryMTPV2PubSignals, AtomicQuerySigV2Inputs, AtomicQuerySigV2OnChainCircuitInputs, AtomicQuerySigV2OnChainInputs, AtomicQuerySigV2OnChainPubSignals, AtomicQuerySigV2PubSignals, AtomicQueryV3Inputs, AtomicQueryV3OnChainInputs, AtomicQueryV3OnChainPubSignals, AtomicQueryV3PubSignals, AuthHandler, AuthV2Inputs, AuthV2PubSignals, BJJSignatureProof2021, BaseConfig, BjjProvider, BrowserDataSource, CircuitClaim, CircuitError, CircuitId, CircuitStorage, ContractRequestHandler, CredentialProposalHandler, CredentialStatusPublisherRegistry, CredentialStatusResolverRegistry, CredentialStatusType, CredentialStorage, CredentialWallet, DIDDocumentJSONSchema, DataPrepareHandlerFunc, Ed25519Provider, ErrorEmptyAuthClaimNonRevProof, ErrorEmptyAuthClaimProof, ErrorEmptyChallengeSignature, ErrorEmptyClaimNonRevProof, ErrorEmptyClaimProof, ErrorEmptyClaimSignature, ErrorEmptyIssuerAuthClaimNonRevProof, ErrorEmptyIssuerAuthClaimProof, ErrorUserStateInRelayClaimProof, EthStateStorage, FSCircuitStorage, FetchHandler, FilterQuery, Iden3OnchainSmtCredentialStatusPublisher, Iden3SmtRhsCredentialStatusPublisher, Iden3SparseMerkleTreeProof, IdentityStorage, IdentityWallet, InMemoryDataSource, InMemoryMerkleTreeStorage, InMemoryPrivateKeyStore, IndexedDBDataSource, IndexedDBPrivateKeyStore, InputGenerator, IssuerResolver, JSON_SCHEMA_VALIDATORS_REGISTRY, JWSPacker, JsonSchemaValidator, KMS, KmsKeyType, LDParser, LinkedMultiQueryInputs, LinkedMultiQueryPubSignals, LocalStoragePrivateKeyStore, MerkleTreeIndexedDBStorage, MerkleTreeLocalStorage, MerkleTreeType, MerklizedRootPosition, MessageBus, MessageHandler, NativeProver, OnChainResolver, OnChainRevocationStorage, OnChainZKPVerifier, Operators, constants as PROTOCOL_CONSTANTS, PackageManager, Parser, PaymentHandler, PaymentRequestDataType, PaymentRequestType, PaymentType, PlainPacker, ProofNode, ProofPurpose, ProofService, ProofType, PubSignalsVerifier, Query, QueryOperators, RHSResolver, RefreshHandler, RefreshServiceType, RevocationStatusHandler, SDK_EVENTS, Scalar, SearchError, Sec256k1Provider, StandardJSONCredentialsQueryFilter, StateTransitionInputs, StateTransitionPubSignals, SubjectPosition, TransactionService, ValueProof, Vector, VerifiableConstants, VerificationHandlerFunc, W3CCredential, XSDNS, ZKPPacker, availableTypesOperators, base58ToBytes$1 as base58ToBytes, base64ToBytes$1 as base64ToBytes, base64UrlToBytes, bigIntArrayToStringArray, bigIntCompare, buildDIDFromEthPubKey, buildFieldPath, buildTreeState, buildVerifierId, byteDecoder, byteEncoder, bytesToBase58$1 as bytesToBase58, bytesToBase64, bytesToBase64url$1 as bytesToBase64url, bytesToHex$3 as bytesToHex, cacheLoader, calculateCoreSchemaHash, calculateQueryHashV2, calculateQueryHashV3, checkCircuitOperator, checkCircuitQueriesLength, checkDataInField, checkQueryRequest, circuitValidator, comparatorOptions, createAuthorizationRequest, createAuthorizationRequestWithMessage, createPayment, createPaymentRequest, createProposal, createProposalRequest, createSchemaHash, createVerifiablePresentation, credentialSubjectKey, dataFillsSlot, decodeBase64url$1 as decodeBase64url, defaultEthConnectionConfig, defaultMTLevels, defaultMTLevelsClaim, defaultMTLevelsOnChain, defaultValueArraySize, defineMerklizedRootPosition, encodeBase64url, existenceToInt, extractProof, extractPublicKeyBytes, factoryComparer, fieldToByteArray, fieldValueFromVerifiablePresentation, fillCoreClaimSlot, fillSlot, findCredentialType, findValue, generateProfileDID, getFieldSlotIndex, getKMSIdByAuthCredential, getNodeAuxValue, getNodesRepresentation, getOperatorNameByValue, getProperties, getSerializationAttrFromContext, getSerializationAttrFromParsedContext, getUserDIDFromCredential, hexToBytes$3 as hexToBytes, isEthereumIdentity, isGenesisState, isGenesisStateId, isIssuerGenesis, isValidOperation, keyPath, mergeObjects, parseCoreClaimSlots, parseCredentialSubject, parseQueriesMetadata, parseQueryMetadata, parseSerializationAttr, prepareCircuitArrayValues, prepareSiblingsStr, processZeroKnowledgeProofRequests, pushHashesToRHS, resolveDIDDocumentAuth, resolvePath, resolveVerificationMethods, strMTHex, stringByPath, subjectPositionIndex, swapEndianness, toClaimNonRevStatus, toGISTProof, toRevocationStatus, transformQueryValueToBigInts, userStateError, validateDIDDocumentAuth, validateDisclosureNativeSDSupport, validateDisclosureV2Circuit, validateEmptyCredentialSubjectNoopNativeSupport, validateEmptyCredentialSubjectV2Circuit, validateOperators, validateTreeState, verifyFieldValueInclusionNativeExistsSupport, verifyFieldValueInclusionV2, witnessBuilder };
 //# sourceMappingURL=index.js.map