@0xpolygonid/js-sdk 1.24.1 → 1.26.0

package/dist/types/iden3comm/handlers/discovery-protocol.d.ts

@@ -0,0 +1,100 @@
+import { BasicMessage, IPackageManager, ProtocolMessage } from '../types';
+import { DiscoverFeatureDiscloseMessage, DiscoverFeatureDisclosure, DiscoverFeatureQueriesMessage, DiscoverFeatureQuery } from '../types/protocol/discovery-protocol';
+import { AbstractMessageHandler, BasicHandlerOptions, IProtocolMessageHandler } from './message-handler';
+/**
+ * @beta
+ * DiscoveryProtocolOptions contains options for DiscoveryProtocolHandler
+ * @public
+ * @interface   DiscoveryProtocolOptions
+ */
+export interface DiscoveryProtocolOptions {
+    packageManager: IPackageManager;
+    protocols?: Array<ProtocolMessage>;
+    goalCodes?: Array<string>;
+    headers?: Array<string>;
+}
+/**
+ *
+ * Options to pass to discovery-protocol handler
+ *
+ * @beta
+ * @public
+ * @type DiscoveryProtocolHandlerOptions
+ */
+export type DiscoveryProtocolHandlerOptions = BasicHandlerOptions & {
+    disclosureExpiresDate?: Date;
+};
+/**
+ * @beta
+ * createDiscoveryFeatureQueryMessage is a function to create didcomm protocol discovery-feature query message
+ * @param opts - discovery-feature query options
+ * @returns `DiscoverFeatureQueriesMessage`
+ */
+export declare function createDiscoveryFeatureQueryMessage(queries: DiscoverFeatureQuery[], opts?: {
+    from?: string;
+    to?: string;
+    expires_time?: number;
+}): DiscoverFeatureQueriesMessage;
+/**
+ * @beta
+ * createDiscoveryFeatureDiscloseMessage is a function to create didcomm protocol discovery-feature disclose message
+ * @param {DiscoverFeatureDisclosure[]} disclosures - array of disclosures
+ * @param opts - basic message options
+ * @returns `DiscoverFeatureQueriesMessage`
+ */
+export declare function createDiscoveryFeatureDiscloseMessage(disclosures: DiscoverFeatureDisclosure[], opts?: {
+    from?: string;
+    to?: string;
+    expires_time?: number;
+}): DiscoverFeatureDiscloseMessage;
+/**
+ * Interface to work with discovery protocol handler
+ *
+ * @beta
+ * @public
+ * @interface IDiscoveryProtocolHandler
+ */
+export interface IDiscoveryProtocolHandler {
+    /**
+     * handle discovery query message
+     *
+     * @param {DiscoverFeatureQueriesMessage} message - discover feature queries message
+     * @param {{ expires_time?: number}} opts - discover feature handle options
+     * @returns {Promise<DiscoverFeatureDiscloseMessage>} - discover feature disclose message
+     */
+    handleDiscoveryQuery(message: DiscoverFeatureQueriesMessage, opts?: DiscoveryProtocolHandlerOptions): Promise<DiscoverFeatureDiscloseMessage>;
+}
+/**
+ *
+ * Handler for discovery protocol
+ *
+ * @public
+ * @beta
+ * @class DiscoveryProtocolHandler
+ * @implements implements DiscoveryProtocolHandler interface
+ */
+export declare class DiscoveryProtocolHandler extends AbstractMessageHandler implements IDiscoveryProtocolHandler, IProtocolMessageHandler {
+    private readonly _options;
+    /**
+     * Creates an instance of DiscoveryProtocolHandler.
+     * @param {DiscoveryProtocolOptions} _options - discovery protocol options
+     */
+    constructor(_options: DiscoveryProtocolOptions);
+    /**
+     * @inheritdoc IProtocolMessageHandler#handle
+     */
+    handle(message: BasicMessage, context: {
+        [key: string]: unknown;
+    }): Promise<BasicMessage | null>;
+    /**
+     * @inheritdoc IDiscoveryProtocolHandler#handleDiscoveryQuery
+     */
+    handleDiscoveryQuery(message: DiscoverFeatureQueriesMessage, opts?: DiscoveryProtocolHandlerOptions): Promise<DiscoverFeatureDiscloseMessage>;
+    private handleQuery;
+    private handleAcceptQuery;
+    private handleProtocolQuery;
+    private handleGoalCodeQuery;
+    private handleHeaderQuery;
+    private handleMatch;
+    private wildcardToRegExp;
+}

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

@@ -7,3 +7,4 @@ export * from './common';
 export * from './credential-proposal';
 export * from './message-handler';
 export * from './payment';
+export * from './discovery-protocol';

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

@@ -2,7 +2,6 @@ import { BasicMessage, IPackageManager, PackerParams } from '../types';
 import { DID } from '@iden3/js-iden3-core';
 import { AbstractMessageHandler, BasicHandlerOptions, IProtocolMessageHandler } from './message-handler';
 import { Iden3PaymentRailsERC20RequestV1, Iden3PaymentRailsRequestV1, MultiChainPaymentConfig, PaymentMessage, PaymentRequestInfo, PaymentRequestMessage, PaymentRequestTypeUnion, PaymentTypeUnion } from '../types/protocol/payment';
-import { PaymentFeatures, PaymentRequestDataType, SupportedCurrencies } from '../../verifiable';
 import { Signer } from 'ethers';
 import { Resolvable } from 'did-resolver';
 /** @beta PaymentRequestCreationOptions represents payment-request creation options */
@@ -24,7 +23,6 @@ export type PaymentCreationOptions = {
  */
 export declare function createPaymentRequest(sender: DID, receiver: DID, agent: string, payments: PaymentRequestInfo[], opts?: PaymentRequestCreationOptions): PaymentRequestMessage;
 export declare function verifyEIP712TypedData(data: Iden3PaymentRailsRequestV1 | Iden3PaymentRailsERC20RequestV1, resolver: Resolvable): Promise<string>;
-export declare function convertPaymentAmount(amount: string, currency: SupportedCurrencies): Promise<bigint>;
 /**
  * @beta
  * PaymentRailsInfo represents payment info for payment rails
@@ -35,20 +33,18 @@ export type PaymentRailsInfo = {
         context: string;
     }[];
     description?: string;
-    chains: PaymentRailsChainInfo[];
+    options: PaymentRailsOptionInfo[];
 };
 /**
  * @beta
- * PaymentRailsChainInfo represents chain info for payment rails
+ * PaymentRailsOptionInfo represents option info for payment rails
  */
-export type PaymentRailsChainInfo = {
+export type PaymentRailsOptionInfo = {
+    optionId: string;
+    chainId: string;
     nonce: bigint;
     amount: string;
-    currency: SupportedCurrencies | string;
-    chainId: string;
     expirationDate?: Date;
-    features?: PaymentFeatures[];
-    type: PaymentRequestDataType.Iden3PaymentRailsRequestV1 | PaymentRequestDataType.Iden3PaymentRailsERC20RequestV1;
 };
 /**
  * @beta

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

@@ -13,6 +13,8 @@ export declare class PackageManager implements IPackageManager {
      * Creates an instance of PackageManager.
      */
     constructor();
+    /** {@inheritDoc IPackageManager.getSupportedProfiles} */
+    getSupportedProfiles(): string[];
     /** {@inheritDoc IPackageManager.isProfileSupported} */
     isProfileSupported(mediaType: MediaType, profile: string): boolean;
     /** {@inheritDoc IPackageManager.getSupportedMediaTypes} */

package/dist/types/iden3comm/packers/jws.d.ts

@@ -12,6 +12,8 @@ import { Resolvable } from 'did-resolver';
 export declare class JWSPacker implements IPacker {
     private readonly _kms;
     private readonly _documentResolver;
+    private readonly supportedAlgorithms;
+    private readonly supportedProtocolVersions;
     /**
      * Creates an instance of JWSPacker.
      *
@@ -48,7 +50,6 @@ export declare class JWSPacker implements IPacker {
     getSupportedProfiles(): string[];
     /** {@inheritDoc IPacker.isProfileSupported} */
     isProfileSupported(profile: string): boolean;
-    private getSupportedAlgorithms;
     private resolveDidDoc;
     private packInternal;
 }

package/dist/types/iden3comm/packers/plain.d.ts

@@ -8,6 +8,7 @@ import { MediaType } from '../constants';
  * @implements implements IPacker interface
  */
 export declare class PlainPacker implements IPacker {
+    private readonly supportedProtocolVersions;
     /**
      * Packs a basic message using the specified parameters.
      *

package/dist/types/iden3comm/packers/zkp.d.ts

@@ -58,6 +58,9 @@ export declare class ZKPPacker implements IPacker {
     readonly provingParamsMap: Map<string, ProvingParams>;
     readonly verificationParamsMap: Map<string, VerificationParams>;
     private readonly _opts;
+    private readonly supportedProtocolVersions;
+    private readonly supportedAlgorithms;
+    private readonly supportedCircuitIds;
     /**
      * Creates an instance of ZKPPacker.
      * @param {Map<string, ProvingParams>} provingParamsMap - string is derived by JSON.parse(ProvingMethodAlg)
@@ -91,6 +94,4 @@ export declare class ZKPPacker implements IPacker {
     getSupportedProfiles(): string[];
     /** {@inheritDoc IPacker.isProfileSupported} */
     isProfileSupported(profile: string): boolean;
-    private getSupportedAlgorithms;
-    private getSupportedCircuitIds;
 }

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

@@ -7,6 +7,7 @@ export * from './protocol/contract-request';
 export * from './protocol/proposal-request';
 export * from './protocol/payment';
 export * from './protocol/accept-profile';
+export * from './protocol/discovery-protocol';
 export * from './packer';
 export * from './models';
 export * from './packageManager';

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

@@ -70,6 +70,12 @@ export interface IPackageManager {
      * @returns MediaType[]
      */
     getSupportedMediaTypes(): MediaType[];
+    /**
+     * gets supported accept profiles by packer manager
+     *
+     * @returns string[]
+     */
+    getSupportedProfiles(): string[];
     /**
      * returns true if media type and algorithms supported by packer manager
      *

package/dist/types/iden3comm/types/protocol/discovery-protocol.d.ts

@@ -0,0 +1,41 @@
+import { PROTOCOL_MESSAGE_TYPE } from '../../constants';
+import { BasicMessage } from '../packer';
+/** @beta DiscoverFeatureQueryType is enum for query type fields */
+export declare enum DiscoverFeatureQueryType {
+    FeatureType = "feature-type"
+}
+/** @beta DiscoveryProtocolFeatureType is enum for supported feature-types */
+export declare enum DiscoveryProtocolFeatureType {
+    Accept = "accept",
+    Protocol = "protocol",
+    GoalCode = "goal-code",
+    Header = "header"
+}
+/** @beta DiscoverFeatureQueriesMessage is struct the represents discover feature queries message */
+export type DiscoverFeatureQueriesMessage = BasicMessage & {
+    body: DiscoverFeatureQueriesBody;
+    type: typeof PROTOCOL_MESSAGE_TYPE.DISCOVERY_PROTOCOL_QUERIES_MESSAGE_TYPE;
+};
+/** @beta DiscoverFeatureQueriesBody is struct the represents discover feature queries body */
+export type DiscoverFeatureQueriesBody = {
+    queries: DiscoverFeatureQuery[];
+};
+/** @beta DiscoverFeatureQuery is struct the represents discover feature query */
+export type DiscoverFeatureQuery = {
+    [DiscoverFeatureQueryType.FeatureType]: DiscoveryProtocolFeatureType;
+    match?: string;
+};
+/** @beta DiscoverFeatureDiscloseMessage is struct the represents discover feature disclose message */
+export type DiscoverFeatureDiscloseMessage = BasicMessage & {
+    body: DiscoverFeatureDiscloseBody;
+    type: typeof PROTOCOL_MESSAGE_TYPE.DISCOVERY_PROTOCOL_DISCLOSE_MESSAGE_TYPE;
+};
+/** @beta DiscoverFeatureDiscloseBody is struct the represents discover feature disclose body */
+export type DiscoverFeatureDiscloseBody = {
+    disclosures: DiscoverFeatureDisclosure[];
+};
+/** @beta DiscoverFeatureDisclosure is struct the represents discover feature disclosure */
+export type DiscoverFeatureDisclosure = {
+    [DiscoverFeatureQueryType.FeatureType]: DiscoveryProtocolFeatureType;
+    id: string;
+};

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

@@ -36,7 +36,6 @@ export type Iden3PaymentRailsRequestV1 = {
     '@context': string | (string | object)[];
     recipient: string;
     amount: string;
-    currency: SupportedCurrencies | string;
     expirationDate: string;
     nonce: string;
     metadata: string;
@@ -106,11 +105,13 @@ export type Iden3PaymentRailsERC20V1 = {
 /** @beta MultiChainPaymentConfig is struct that represents payments contracts information for different chains */
 export type MultiChainPaymentConfig = {
     chainId: string;
-    paymentContract: string;
+    paymentRails: string;
     recipient: string;
-    erc20TokenAddressArr: {
-        symbol: string;
-        address: string;
+    options: {
+        id: string;
+        type: PaymentRequestDataType.Iden3PaymentRailsRequestV1 | PaymentRequestDataType.Iden3PaymentRailsERC20RequestV1;
+        contractAddress?: string;
+        features?: PaymentFeatures[];
     }[];
 };
 /**

package/dist/types/iden3comm/utils/contract-request.utils.d.ts

@@ -0,0 +1,20 @@
+import { CircuitId } from '../../circuits';
+import { DID } from '@iden3/js-iden3-core';
+import { IProofService } from '../../proof';
+import { ZeroKnowledgeProofResponse } from '../types';
+/**
+ * @beta
+ * Retrieves the request ID from circuit string.
+ * CircuitId.AuthV2 - 940499666
+ * @returns The request ID.
+ */
+export declare function calculateRequestIdForCircuit(circuitId: CircuitId): number;
+/**
+ * Prepares the zero-knowledge proof response for the AuthV2 circuit.
+ * @beta
+ * @param address - The address associated with the request.
+ * @param senderDid - The sender's decentralized identifier (DID).
+ * @param proofService - The proof service used to generate the proof.
+ * @returns A promise that resolves to an array of ZeroKnowledgeProofResponse objects.
+ */
+export declare function prepareAuthV2ZeroKnowledgeResponse(address: string, senderDid: DID, proofService: IProofService): Promise<ZeroKnowledgeProofResponse[]>;

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

@@ -1,4 +1,5 @@
 export * from './envelope';
 export * from './message';
 export * from './did';
+export * from './contract-request.utils';
 export * from './accept-profile';

package/dist/types/proof/proof-service.d.ts

@@ -73,6 +73,14 @@ export interface IProofService {
      * @returns `Promise<Uint8Array>`
      */
     generateAuthV2Inputs(hash: Uint8Array, did: DID, circuitId: CircuitId): Promise<Uint8Array>;
+    /**
+     * generates auth inputs
+     *
+     * @param {Uint8Array} hash - challenge that will be signed
+     * @param {DID} did - identity that will generate a proof
+     * @returns `Promise<ZKProof>`
+     */
+    generateAuthV2Proof(hash: Uint8Array, did: DID): Promise<ZKProof>;
     /**
      * state verification function
      *
@@ -138,6 +146,8 @@ export declare class ProofService implements IProofService {
     private loadLdContext;
     /** {@inheritdoc IProofService.generateAuthV2Inputs} */
     generateAuthV2Inputs(hash: Uint8Array, did: DID, circuitId: CircuitId): Promise<Uint8Array>;
+    /** {@inheritdoc IProofService.generateAuthV2Proof} */
+    generateAuthV2Proof(challenge: Uint8Array, did: DID): Promise<ZKProof>;
     verifyState(circuitId: string, pubSignals: string[], opts?: StateVerificationOpts): Promise<boolean>;
     findCredentialByProofQuery(did: DID, query: ProofQuery): Promise<{
         cred: W3CCredential;

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

@@ -35,6 +35,7 @@ export declare class OnChainZKPVerifier implements IOnChainZKPVerifier {
      * supported circuits
      */
     private static readonly _supportedCircuits;
+    private static readonly _supportedCircuitsPubSignalsMap;
     /**
      *
      * Creates an instance of OnChainZKPVerifier.
@@ -55,6 +56,7 @@ export declare class OnChainZKPVerifier implements IOnChainZKPVerifier {
      * {@inheritDoc IOnChainZKPVerifier.submitZKPResponseV2}
      */
     submitZKPResponseV2(ethSigner: Signer, txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<Map<string, ZeroKnowledgeProofResponse[]>>;
+    private static getCrossChainResolvers;
     static prepareTxArgsSubmitV2(resolverUrl: string, txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<JsonDocumentObjectValue[]>;
     prepareTxArgsSubmitV2(txData: ContractInvokeTransactionData, zkProofResponses: ZeroKnowledgeProofResponse[]): Promise<JsonDocumentObjectValue[]>;
     private static packZkpProof;

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

@@ -117,6 +117,7 @@ export declare enum SupportedPaymentProofType {
 /**
  * Media types for Payment supported currencies
  * @beta
+ * @deprecated
  * @enum {string}
  */
 export declare enum SupportedCurrencies {
@@ -124,9 +125,7 @@ export declare enum SupportedCurrencies {
     ETH_WEI = "ETHWEI",
     ETH_GWEI = "ETHGWEI",
     MATIC = "MATIC",
-    POL = "POL",
-    USDT = "USDT",
-    USDC = "USDC"
+    POL = "POL"
 }
 /**
  * Supported features for payment-request

package/package.json

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