@0xpolygonid/js-sdk 1.9.4 → 1.10.1

package/README.md

@@ -14,7 +14,13 @@ Installation:
 npm install @0xpolygonid/js-sdk
 ```
 
-See [tests](/tests) for examples on how to use SDK.
+## Circuits
+
+And place actual circuits to `test/proofs/testdata`
+
+```bash
+curl -LO https://iden3-circuits-bucket.s3.eu-west-1.amazonaws.com/latest.zip
+```
 
 ## Tests
 
@@ -35,10 +41,11 @@ export RHS_URL="..reverse hash service url"
 export IPFS_URL="url for ipfs"
 export STATE_CONTRACT_ADDRESS="state contract address"
 export RHS_CONTRACT_ADDRESS="reverse hash service contract address"
-
 ```
 
-And place actual circuits to `test/proofs/testdata`
+## Examples
+
+Please see [examples](https://github.com/0xPolygonID/js-sdk-examples) for visit examples information.
 
 ## Documentation
 

package/dist/browser/esm/index.js

@@ -5,7 +5,7 @@ import { Path, Merklizer, getDocumentLoader } from '@iden3/js-jsonld-merklizatio
 import * as jsJsonldMerklization from '@iden3/js-jsonld-merklization';
 export { jsJsonldMerklization as jsonLDMerklizer };
 import { PrivateKey, Hex, base58ToBytes as base58ToBytes$2, base58FromBytes, Signature as Signature$5, PublicKey, poseidon, sha256 as sha256$3, getRandomBytes, Poseidon } from '@iden3/js-crypto';
-import { Hash as Hash$2, Proof, verifyProof, rootFromProof, ZERO_HASH, swapEndianness as swapEndianness$1, newHashFromString, Merkletree, InMemoryDB, str2Bytes, LocalStorageDB, IndexedDBStorage, testBit, NodeLeaf, NODE_TYPE_LEAF, hashElems } from '@iden3/js-merkletree';
+import { Hash as Hash$2, Proof, verifyProof, rootFromProof, ZERO_HASH, swapEndianness as swapEndianness$1, Merkletree, InMemoryDB, str2Bytes, LocalStorageDB, IndexedDBStorage, testBit, NodeLeaf, NODE_TYPE_LEAF, hashElems } from '@iden3/js-merkletree';
 import { groth16 } from 'snarkjs';
 import { getCurveFromName } from 'ffjavascript';
 import { Token, Header, ProvingMethodAlg, proving } from '@iden3/js-jwz';
@@ -59183,7 +59183,7 @@ class AtomicQuerySigV2OnChainPubSignals extends BaseConfig {
         this.circuitQueryHash = BigInt(sVals[fieldIdx]);
         fieldIdx++;
         // - issuerAuthState
-        this.issuerAuthState = newHashFromString(sVals[fieldIdx]);
+        this.issuerAuthState = Hash$2.fromString(sVals[fieldIdx]);
         fieldIdx++;
         // - requestID
         this.requestID = BigInt(sVals[fieldIdx]);
@@ -59192,7 +59192,7 @@ class AtomicQuerySigV2OnChainPubSignals extends BaseConfig {
         this.challenge = BigInt(sVals[fieldIdx]);
         fieldIdx++;
         // - gistRoot
-        this.gistRoot = newHashFromString(sVals[fieldIdx]);
+        this.gistRoot = Hash$2.fromString(sVals[fieldIdx]);
         fieldIdx++;
         // - issuerID
         this.issuerID = Id.fromBigInt(BigInt(sVals[fieldIdx]));
@@ -59201,7 +59201,7 @@ class AtomicQuerySigV2OnChainPubSignals extends BaseConfig {
         this.isRevocationChecked = parseInt(sVals[fieldIdx]);
         fieldIdx++;
         // - issuerClaimNonRevState
-        this.issuerClaimNonRevState = newHashFromString(sVals[fieldIdx]);
+        this.issuerClaimNonRevState = Hash$2.fromString(sVals[fieldIdx]);
         fieldIdx++;
         //  - timestamp
         this.timestamp = parseInt(sVals[fieldIdx]);
@@ -59373,8 +59373,8 @@ class StateTransitionPubSignals {
             throw new Error(`invalid number of Output values expected ${fieldLength} got ${sVals.length}`);
         }
         this.userId = Id.fromBigInt(BigInt(sVals[0]));
-        this.oldUserState = newHashFromString(sVals[1]);
-        this.newUserState = newHashFromString(sVals[2]);
+        this.oldUserState = Hash$2.fromString(sVals[1]);
+        this.newUserState = Hash$2.fromString(sVals[2]);
         this.isOldStateGenesis = BigInt(sVals[3]) === BigInt(1);
         return this;
     }
@@ -62889,7 +62889,11 @@ const PROTOCOL_MESSAGE_TYPE = Object.freeze({
     // ContractInvokeRequestMessageType is type for request of contract invoke request
     CONTRACT_INVOKE_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'proofs/1.0/contract-invoke-request',
     // CredentialOnchainOfferMessageType is type of message with credential onchain offering
-    CREDENTIAL_ONCHAIN_OFFER_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/onchain-offer'
+    CREDENTIAL_ONCHAIN_OFFER_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/onchain-offer',
+    // 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'
 });
 /**
  * Media types for iden3 comm communication protocol
@@ -63474,7 +63478,7 @@ class IdentityWallet {
         const tmpIdentifier = opts.seed ? v5(Hex.encode(sha256$3(opts.seed)), nil) : v4();
         opts.method = opts.method ?? DidMethod.Iden3;
         opts.blockchain = opts.blockchain ?? Blockchain.Polygon;
-        opts.networkId = opts.networkId ?? NetworkId.Mumbai;
+        opts.networkId = opts.networkId ?? NetworkId.Amoy;
         await this._storage.mt.createIdentityMerkleTrees(tmpIdentifier);
         opts.seed = opts.seed ?? getRandomBytes(32);
         const keyId = await this._kms.createKeyFromSeed(KmsKeyType.BabyJubJub, opts.seed);
@@ -66990,5 +66994,184 @@ class RevocationStatusHandler {
     }
 }
 
-export { 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, 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, 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, ValueProof, Vector, VerifiableConstants, VerificationHandlerFunc, W3CCredential, XSDNS, ZKPPacker, availableTypesOperators, base58ToBytes$1 as base58ToBytes, base64ToBytes$1 as base64ToBytes, base64UrlToBytes, bigIntArrayToStringArray, bigIntCompare, buildFieldPath, buildTreeState, buildVerifierId, byteDecoder, byteEncoder, bytesToBase58$1 as bytesToBase58, bytesToBase64, bytesToBase64url$1 as bytesToBase64url, bytesToHex$2 as bytesToHex, cacheLoader, calculateCoreSchemaHash, calculateQueryHashV2, calculateQueryHashV3, checkCircuitOperator, checkCircuitQueriesLength, checkDataInField, checkQueryRequest, circuitValidator, comparatorOptions, createAuthorizationRequest, createAuthorizationRequestWithMessage, 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$2 as hexToBytes, 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
+ * createProposalRequest is a function to create protocol proposal-request protocol message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {ProposalRequestCreationOptions} opts - creation options
+ * @returns `Promise<ProposalRequestMessage>`
+ */
+function createProposalRequest(sender, receiver, opts) {
+    const uuidv4 = v4();
+    const request = {
+        id: uuidv4,
+        thid: uuidv4,
+        from: sender.string(),
+        to: receiver.string(),
+        typ: MediaType.PlainMessage,
+        type: PROTOCOL_MESSAGE_TYPE.PROPOSAL_REQUEST_MESSAGE_TYPE,
+        body: opts
+    };
+    return request;
+}
+/**
+ * @beta
+ * createProposal is a function to create protocol proposal protocol message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {Proposal[]} proposals - proposals
+ * @returns `Promise<ProposalRequestMessage>`
+ */
+function createProposal(sender, receiver, proposals) {
+    const uuidv4 = v4();
+    const request = {
+        id: uuidv4,
+        thid: uuidv4,
+        from: sender.string(),
+        to: receiver.string(),
+        typ: MediaType.PlainMessage,
+        type: PROTOCOL_MESSAGE_TYPE.PROPOSAL_MESSAGE_TYPE,
+        body: {
+            proposals: proposals || []
+        }
+    };
+    return request;
+}
+/**
+ *
+ * Allows to process ProposalRequest protocol message
+ * @beta
+ * @class CredentialProposalHandler
+ * @implements implements ICredentialProposalHandler interface
+ */
+class CredentialProposalHandler {
+    /**
+     * @beta Creates an instance of CredentialProposalHandler.
+     * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
+     * @param {IIdentityWallet} _identityWallet - identity wallet
+     * @param {CredentialProposalHandlerParams} _params - credential proposal handler params
+     *
+     */
+    constructor(_packerMgr, _identityWallet, _params) {
+        this._packerMgr = _packerMgr;
+        this._identityWallet = _identityWallet;
+        this._params = _params;
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#parseProposalRequest
+     */
+    async parseProposalRequest(request) {
+        const { unpackedMessage: message } = await this._packerMgr.unpack(request);
+        const proposalRequest = message;
+        if (message.type !== PROTOCOL_MESSAGE_TYPE.PROPOSAL_REQUEST_MESSAGE_TYPE) {
+            throw new Error('Invalid media type');
+        }
+        return proposalRequest;
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#handleProposalRequest
+     */
+    async handleProposalRequest(request, 
+    //eslint-disable-next-line @typescript-eslint/no-unused-vars
+    opts) {
+        if (this._params.packerParams.mediaType === MediaType.SignedMessage &&
+            !this._params.packerParams.packerOptions) {
+            throw new Error(`jws packer options are required for ${MediaType.SignedMessage}`);
+        }
+        const proposalRequest = await this.parseProposalRequest(request);
+        if (!proposalRequest.to) {
+            throw new Error(`failed request. empty 'to' field`);
+        }
+        if (!proposalRequest.from) {
+            throw new Error(`failed request. empty 'from' field`);
+        }
+        if (!proposalRequest.body?.credentials?.length) {
+            throw new Error(`failed request. no 'credentials' in body`);
+        }
+        const senderDID = DID.parse(proposalRequest.from);
+        let credOfferMessage = undefined;
+        let proposalMessage = undefined;
+        for (let i = 0; i < proposalRequest.body.credentials.length; i++) {
+            const cred = proposalRequest.body.credentials[i];
+            // check if there is credentials in the wallet
+            let credsFromWallet = [];
+            try {
+                credsFromWallet = await this._identityWallet.findOwnedCredentialsByDID(senderDID, {
+                    type: cred.type,
+                    context: cred.context
+                });
+            }
+            catch (e) {
+                if (e.message !== 'no credential satisfied query') {
+                    throw e;
+                }
+            }
+            if (credsFromWallet.length) {
+                const guid = v4();
+                if (!credOfferMessage) {
+                    credOfferMessage = {
+                        id: guid,
+                        typ: this._params.packerParams.mediaType,
+                        type: PROTOCOL_MESSAGE_TYPE.CREDENTIAL_OFFER_MESSAGE_TYPE,
+                        thid: proposalRequest.thid ?? guid,
+                        body: {
+                            url: this._params.agentUrl,
+                            credentials: []
+                        },
+                        from: proposalRequest.to,
+                        to: proposalRequest.from
+                    };
+                }
+                credOfferMessage.body.credentials.push(...credsFromWallet.map((c) => ({
+                    id: c.id,
+                    description: ''
+                })));
+                continue;
+            }
+            // credential not found in the wallet, prepare proposal protocol message
+            const proposal = await this._params.proposalResolverFn(cred.context, cred.type);
+            if (!proposal) {
+                throw new Error(`can't resolve Proposal for type: ${cred.type}, context: ${cred.context}`);
+            }
+            if (!proposalMessage) {
+                const guid = v4();
+                proposalMessage = {
+                    id: guid,
+                    typ: this._params.packerParams.mediaType,
+                    type: PROTOCOL_MESSAGE_TYPE.PROPOSAL_MESSAGE_TYPE,
+                    thid: proposalRequest.thid ?? guid,
+                    body: {
+                        proposals: []
+                    },
+                    from: proposalRequest.to,
+                    to: proposalRequest.from
+                };
+            }
+            proposalMessage.body?.proposals.push(proposal);
+        }
+        // if there is credentials in the wallet, return offer protocol message, otherwise proposal
+        const response = byteEncoder.encode(JSON.stringify(proposalMessage ?? credOfferMessage));
+        const packerOpts = this._params.packerParams.mediaType === MediaType.SignedMessage
+            ? this._params.packerParams.packerOptions
+            : {
+                provingMethodAlg: proving.provingMethodGroth16AuthV2Instance.methodAlg
+            };
+        return this._packerMgr.pack(this._params.packerParams.mediaType, response, {
+            senderDID,
+            ...packerOpts
+        });
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#handleProposal
+     */
+    async handleProposal(proposal, opts) {
+        if (opts?.proposalRequest && opts.proposalRequest.from !== proposal.to) {
+            throw new Error(`sender of the request is not a target of response - expected ${opts.proposalRequest.from}, given ${proposal.to}`);
+        }
+        return { proposal };
+    }
+}
+
+export { 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, 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, ValueProof, Vector, VerifiableConstants, VerificationHandlerFunc, W3CCredential, XSDNS, ZKPPacker, availableTypesOperators, base58ToBytes$1 as base58ToBytes, base64ToBytes$1 as base64ToBytes, base64UrlToBytes, bigIntArrayToStringArray, bigIntCompare, buildFieldPath, buildTreeState, buildVerifierId, byteDecoder, byteEncoder, bytesToBase58$1 as bytesToBase58, bytesToBase64, bytesToBase64url$1 as bytesToBase64url, bytesToHex$2 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$2 as hexToBytes, 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