@0xpolygonid/js-sdk 1.12.0 → 1.13.0

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

@@ -0,0 +1,100 @@
+import { BasicMessage, IPackageManager, PackerParams } from '../types';
+import { DID } from '@iden3/js-iden3-core';
+import { AbstractMessageHandler, IProtocolMessageHandler } from './message-handler';
+import { PaymentInfo, PaymentMessage, PaymentRequestDataInfo, PaymentRequestInfo, PaymentRequestMessage } from '../types/protocol/payment';
+/**
+ * @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`
+ */
+export declare function createPaymentRequest(sender: DID, receiver: DID, agent: string, payments: PaymentRequestInfo[]): PaymentRequestMessage;
+/**
+ * @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`
+ */
+export declare function createPayment(sender: DID, receiver: DID, payments: PaymentInfo[]): PaymentMessage;
+/**
+ * @beta
+ * Interface that allows the processing of the payment-request and payment protocol messages
+ *
+ * @interface IPaymentHandler
+ */
+export interface IPaymentHandler {
+    /**
+     * @beta
+     * unpacks payment-request
+     * @param {Uint8Array} request - raw byte message
+     * @returns `Promise<PaymentRequestMessage>`
+     */
+    parsePaymentRequest(request: Uint8Array): Promise<PaymentRequestMessage>;
+    /**
+     *  @beta
+     * handle payment-request
+     * @param {Uint8Array} request - raw byte message
+     * @param {PaymentRequestMessageHandlerOptions} opts - handler options
+     * @returns {Promise<Uint8Array>} - agent message or null
+     */
+    handlePaymentRequest(request: Uint8Array, opts: PaymentRequestMessageHandlerOptions): Promise<Uint8Array | null>;
+    /**
+     * @beta
+     * handle payment protocol message
+     * @param {PaymentMessage} payment  - payment message
+     * @param {PaymentHandlerOptions} opts - options
+     * @returns `Promise<void>`
+     */
+    handlePayment(payment: PaymentMessage, opts: PaymentHandlerOptions): Promise<void>;
+}
+/** @beta PaymentRequestMessageHandlerOptions represents payment-request handler options */
+export type PaymentRequestMessageHandlerOptions = {
+    paymentHandler: (data: PaymentRequestDataInfo) => Promise<string>;
+};
+/** @beta PaymentHandlerOptions represents payment handler options */
+export type PaymentHandlerOptions = {
+    paymentRequest: PaymentRequestMessage;
+    paymentValidationHandler: (txId: string, data: PaymentRequestDataInfo) => Promise<void>;
+};
+/** @beta PaymentHandlerParams represents payment handler params */
+export type PaymentHandlerParams = {
+    packerParams: PackerParams;
+};
+/**
+ *
+ * Allows to process PaymentRequest protocol message
+ * @beta
+ * @class PaymentHandler
+ * @implements implements IPaymentHandler interface
+ */
+export declare class PaymentHandler extends AbstractMessageHandler implements IPaymentHandler, IProtocolMessageHandler {
+    private readonly _packerMgr;
+    private readonly _params;
+    /**
+     * @beta Creates an instance of PaymentHandler.
+     * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
+     * @param {PaymentHandlerParams} _params - payment handler params
+     *
+     */
+    constructor(_packerMgr: IPackageManager, _params: PaymentHandlerParams);
+    handle(message: BasicMessage, context: PaymentRequestMessageHandlerOptions | PaymentHandlerOptions): Promise<BasicMessage | null>;
+    /**
+     * @inheritdoc IPaymentHandler#parsePaymentRequest
+     */
+    parsePaymentRequest(request: Uint8Array): Promise<PaymentRequestMessage>;
+    private handlePaymentRequestMessage;
+    /**
+     * @inheritdoc IPaymentHandler#handlePaymentRequest
+     */
+    handlePaymentRequest(request: Uint8Array, opts: PaymentRequestMessageHandlerOptions): Promise<Uint8Array | null>;
+    /**
+     * @inheritdoc IPaymentHandler#handlePayment
+     */
+    handlePayment(payment: PaymentMessage, opts: PaymentHandlerOptions): Promise<void>;
+    private packMessage;
+}

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

@@ -5,5 +5,6 @@ export * from './protocol/proof';
 export * from './protocol/revocation';
 export * from './protocol/contract-request';
 export * from './protocol/proposal-request';
+export * from './protocol/payment';
 export * from './packer';
 export * from './packageManager';

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

@@ -0,0 +1,47 @@
+import { BasicMessage } from '../';
+import { PaymentRequestDataType, PaymentRequestType, PaymentType } from '../../../verifiable';
+/** @beta PaymentRequestMessage is struct the represents payment-request message */
+export type PaymentRequestMessage = BasicMessage & {
+    body?: PaymentRequestMessageBody;
+};
+/** @beta PaymentRequestMessageBody is struct the represents body for payment-request */
+export type PaymentRequestMessageBody = {
+    agent: string;
+    payments: PaymentRequestInfo[];
+};
+/** @beta PaymentRequestInfo is struct the represents payment info for payment-request */
+export type PaymentRequestInfo = {
+    credentials: {
+        type: string;
+        context: string;
+    }[];
+    type: PaymentRequestType;
+    data: PaymentRequestDataInfo;
+    expiration: number;
+    description: string;
+};
+/** @beta PaymentRequestDataInfo is struct the represents payment data info for payment-request */
+export type PaymentRequestDataInfo = {
+    type: PaymentRequestDataType;
+    amount: string;
+    id: number;
+    chainId: number;
+    address: string;
+    signature?: string;
+};
+/** @beta  PaymentMessage is struct the represents payment message */
+export type PaymentMessage = BasicMessage & {
+    body?: PaymentMessageBody;
+};
+/** @beta  PaymentMessageBody is struct the represents body for payment message */
+export type PaymentMessageBody = {
+    payments: PaymentInfo[];
+};
+/** @beta PaymentInfo is struct the represents payment info for payment */
+export type PaymentInfo = {
+    id: number;
+    type: PaymentType;
+    paymentData: {
+        txId: string;
+    };
+};

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

@@ -85,3 +85,27 @@ export declare enum SubjectPosition {
 export declare enum RefreshServiceType {
     Iden3RefreshService2023 = "Iden3RefreshService2023"
 }
+/**
+ * PaymentRequestType type for payment requests
+ *
+ * @enum {string}
+ */
+export declare enum PaymentRequestType {
+    PaymentRequest = "PaymentRequest"
+}
+/**
+ * PaymentRequestDataType type for payment requests
+ *
+ * @enum {string}
+ */
+export declare enum PaymentRequestDataType {
+    Iden3PaymentRequestCryptoV1 = "Iden3PaymentRequestCryptoV1"
+}
+/**
+ * PaymentType type for payment responses
+ *
+ * @enum {string}
+ */
+export declare enum PaymentType {
+    Iden3PaymentCryptoV1 = "Iden3PaymentCryptoV1"
+}

package/package.json

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