remove currency from multichain payment, refactor config (#293)

* remove currency from multichain payment, refactor config

Author: volodymyr-basiuk

package-lock.json

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

package.json

@@ -30,10 +30,9 @@ import {
   PaymentFeatures,
   PaymentRequestDataType,
   PaymentType,
-  SupportedCurrencies,
   SupportedPaymentProofType
 } from '../../verifiable';
-import { Signer, ethers, parseEther, parseUnits } from 'ethers';
+import { Signer, ethers } from 'ethers';
 import { Resolvable } from 'did-resolver';
 import { verifyExpiresTime } from './common';
 
@@ -85,23 +84,19 @@ export async function verifyEIP712TypedData(
   data: Iden3PaymentRailsRequestV1 | Iden3PaymentRailsERC20RequestV1,
   resolver: Resolvable
 ): Promise<string> {
-  const convertedAmount = await convertPaymentAmount(
-    data.amount,
-    data.currency as SupportedCurrencies
-  );
   const paymentData =
     data.type === PaymentRequestDataType.Iden3PaymentRailsRequestV1
       ? {
           recipient: data.recipient,
-          amount: convertedAmount,
+          amount: data.amount,
           expirationDate: getUnixTimestamp(new Date(data.expirationDate)),
           nonce: data.nonce,
           metadata: '0x'
         }
       : {
           tokenAddress: data.tokenAddress,
           recipient: data.recipient,
-          amount: convertedAmount,
+          amount: data.amount,
           expirationDate: getUnixTimestamp(new Date(data.expirationDate)),
           nonce: data.nonce,
           metadata: '0x'
@@ -134,34 +129,6 @@ export async function verifyEIP712TypedData(
   throw new Error(`failed request. no matching verificationMethod`);
 }
 
-export async function convertPaymentAmount(
-  amount: string,
-  currency: SupportedCurrencies
-): Promise<bigint> {
-  let convertedAmount = 0n;
-  switch (currency) {
-    case SupportedCurrencies.ETH:
-    case SupportedCurrencies.POL:
-    case SupportedCurrencies.MATIC:
-      convertedAmount = parseEther(amount.toString());
-      break;
-    case SupportedCurrencies.ETH_WEI:
-      convertedAmount = parseUnits(amount.toString(), 'wei');
-      break;
-    case SupportedCurrencies.ETH_GWEI:
-      convertedAmount = parseUnits(amount.toString(), 'gwei');
-      break;
-    case SupportedCurrencies.USDC:
-    case SupportedCurrencies.USDT: {
-      convertedAmount = parseUnits(amount.toString(), 6);
-      break;
-    }
-    default:
-      throw new Error(`failed request. unsupported currency ${currency}`);
-  }
-  return convertedAmount;
-}
-
 /**
  * @beta
  * PaymentRailsInfo represents payment info for payment rails
@@ -172,23 +139,19 @@ 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;
 };
 
 /**
@@ -530,43 +493,47 @@ export class PaymentHandler
     for (let i = 0; i < payments.length; i++) {
       const { credentials, description } = payments[i];
       const dataArr: (Iden3PaymentRailsRequestV1 | Iden3PaymentRailsERC20RequestV1)[] = [];
-      for (let j = 0; j < payments[i].chains.length; j++) {
-        const { features, nonce, amount, currency, chainId, expirationDate, type } =
-          payments[i].chains[j];
+      for (let j = 0; j < payments[i].options.length; j++) {
+        const { nonce, amount, chainId, optionId, expirationDate } = payments[i].options[j];
 
         const multiChainConfig = this._params.multiChainPaymentConfig?.find(
           (c) => c.chainId === chainId
         );
         if (!multiChainConfig) {
           throw new Error(`failed request. no config for chain ${chainId}`);
         }
-        const { recipient, paymentContract, erc20TokenAddressArr } = multiChainConfig;
+        const { recipient, paymentRails, options } = multiChainConfig;
 
-        const tokenAddress = erc20TokenAddressArr.find((t) => t.symbol === currency)?.address;
-        if (type === PaymentRequestDataType.Iden3PaymentRailsERC20RequestV1 && !tokenAddress) {
-          throw new Error(`failed request. no token address for currency ${currency}`);
+        const option = options.find((t) => t.id === optionId);
+        if (!option) {
+          throw new Error(`failed request. no option for id ${optionId}`);
+        }
+        if (
+          option.type === PaymentRequestDataType.Iden3PaymentRailsERC20RequestV1 &&
+          !option.contractAddress
+        ) {
+          throw new Error(`failed request. no token address for option id ${optionId}`);
         }
         const expirationDateRequired =
           expirationDate ?? new Date(new Date().setHours(new Date().getHours() + 1));
-        const typeUrl = `https://schema.iden3.io/core/json/${type}.json`;
+        const typeUrl = `https://schema.iden3.io/core/json/${option.type}.json`;
         const typesFetchResult = await fetch(typeUrl);
         const types = await typesFetchResult.json();
         delete types.EIP712Domain;
 
-        const convertedAmount = await convertPaymentAmount(amount, currency as SupportedCurrencies);
         const paymentData =
-          type === PaymentRequestDataType.Iden3PaymentRailsRequestV1
+          option.type === PaymentRequestDataType.Iden3PaymentRailsRequestV1
             ? {
                 recipient,
-                amount: convertedAmount,
+                amount: amount,
                 expirationDate: getUnixTimestamp(expirationDateRequired),
                 nonce,
                 metadata: '0x'
               }
             : {
-                tokenAddress,
+                tokenAddress: option.contractAddress,
                 recipient,
-                amount: convertedAmount,
+                amount: amount,
                 expirationDate: getUnixTimestamp(expirationDateRequired),
                 nonce,
                 metadata: '0x'
@@ -576,7 +543,7 @@ export class PaymentHandler
           name: 'MCPayment',
           version: '1.0.0',
           chainId,
-          verifyingContract: paymentContract
+          verifyingContract: paymentRails
         };
         const signature = await signer.signTypedData(domain, types, paymentData);
         const proof: EthereumEip712Signature2021[] = [
@@ -597,21 +564,25 @@ export class PaymentHandler
         const d: Iden3PaymentRailsRequestV1 = {
           type: PaymentRequestDataType.Iden3PaymentRailsRequestV1,
           '@context': [
-            `https://schema.iden3.io/core/jsonld/payment.jsonld#${type}`,
+            `https://schema.iden3.io/core/jsonld/payment.jsonld#${option.type}`,
             'https://w3id.org/security/suites/eip712sig-2021/v1'
           ],
           recipient,
           amount: amount.toString(),
-          currency,
           expirationDate: expirationDateRequired.toISOString(),
           nonce: nonce.toString(),
           metadata: '0x',
           proof
         };
         dataArr.push(
-          type === PaymentRequestDataType.Iden3PaymentRailsRequestV1
+          option.type === PaymentRequestDataType.Iden3PaymentRailsRequestV1
             ? d
-            : { ...d, type, tokenAddress: tokenAddress || '', features: features || [] }
+            : {
+                ...d,
+                type: option.type,
+                tokenAddress: option.contractAddress || '',
+                features: option.features || []
+              }
         );
       }
       paymentRequestInfo.push({

src/iden3comm/handlers/payment.ts

@@ -52,7 +52,6 @@ export type Iden3PaymentRailsRequestV1 = {
   '@context': string | (string | object)[];
   recipient: string;
   amount: string;
-  currency: SupportedCurrencies | string;
   expirationDate: string;
   nonce: string;
   metadata: string;
@@ -130,11 +129,15 @@ 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[];
   }[];
 };
 

src/iden3comm/types/protocol/payment.ts

@@ -147,16 +147,15 @@ export enum SupportedPaymentProofType {
 /**
  * Media types for Payment supported currencies
  * @beta
+ * @deprecated
  * @enum {string}
  */
 export enum SupportedCurrencies {
   ETH = 'ETH',
   ETH_WEI = 'ETHWEI',
   ETH_GWEI = 'ETHGWEI',
   MATIC = 'MATIC',
-  POL = 'POL',
-  USDT = 'USDT',
-  USDC = 'USDC'
+  POL = 'POL'
 }
 
 /**