add amount conversion (#292)

* add amount convertion and fix expirationDate (unix not ISO string)

package.json

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

src/iden3comm/handlers/payment.ts

@@ -33,7 +33,7 @@ import {
   SupportedCurrencies,
   SupportedPaymentProofType
 } from '../../verifiable';
-import { Signer, ethers } from 'ethers';
+import { Signer, ethers, parseEther, parseUnits } from 'ethers';
 import { Resolvable } from 'did-resolver';
 import { verifyExpiresTime } from './common';
 
@@ -85,20 +85,24 @@ 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: data.amount,
-          expirationDate: new Date(data.expirationDate).getTime(),
+          amount: convertedAmount,
+          expirationDate: getUnixTimestamp(new Date(data.expirationDate)),
           nonce: data.nonce,
           metadata: '0x'
         }
       : {
           tokenAddress: data.tokenAddress,
           recipient: data.recipient,
-          amount: data.amount,
-          expirationDate: new Date(data.expirationDate).getTime(),
+          amount: convertedAmount,
+          expirationDate: getUnixTimestamp(new Date(data.expirationDate)),
           nonce: data.nonce,
           metadata: '0x'
         };
@@ -130,6 +134,34 @@ 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
@@ -149,10 +181,10 @@ export type PaymentRailsInfo = {
  */
 export type PaymentRailsChainInfo = {
   nonce: bigint;
-  amount: bigint;
+  amount: string;
   currency: SupportedCurrencies | string;
   chainId: string;
-  expirationDate?: string;
+  expirationDate?: Date;
   features?: PaymentFeatures[];
   type:
     | PaymentRequestDataType.Iden3PaymentRailsRequestV1
@@ -514,27 +546,28 @@ export class PaymentHandler
         if (type === PaymentRequestDataType.Iden3PaymentRailsERC20RequestV1 && !tokenAddress) {
           throw new Error(`failed request. no token address for currency ${currency}`);
         }
-        const expirationTime = expirationDate
-          ? new Date(expirationDate).getTime()
-          : new Date(new Date().setHours(new Date().getHours() + 1)).getTime();
+        const expirationDateRequired =
+          expirationDate ?? new Date(new Date().setHours(new Date().getHours() + 1));
         const typeUrl = `https://schema.iden3.io/core/json/${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
             ? {
                 recipient,
-                amount,
-                expirationDate: expirationTime,
+                amount: convertedAmount,
+                expirationDate: getUnixTimestamp(expirationDateRequired),
                 nonce,
                 metadata: '0x'
               }
             : {
                 tokenAddress,
                 recipient,
-                amount,
-                expirationDate: expirationTime,
+                amount: convertedAmount,
+                expirationDate: getUnixTimestamp(expirationDateRequired),
                 nonce,
                 metadata: '0x'
               };
@@ -570,7 +603,7 @@ export class PaymentHandler
           recipient,
           amount: amount.toString(),
           currency,
-          expirationDate: new Date(expirationTime).toISOString(),
+          expirationDate: expirationDateRequired.toISOString(),
           nonce: nonce.toString(),
           metadata: '0x',
           proof

src/storage/blockchain/abi/ERC20.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"uint256","name":"initialSupply","type":"uint256"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"allowance","type":"uint256"},{"internalType":"uint256","name":"needed","type":"uint256"}],"name":"ERC20InsufficientAllowance","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint256","name":"balance","type":"uint256"},{"internalType":"uint256","name":"needed","type":"uint256"}],"name":"ERC20InsufficientBalance","type":"error"},{"inputs":[{"internalType":"address","name":"approver","type":"address"}],"name":"ERC20InvalidApprover","type":"error"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"ERC20InvalidReceiver","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"}],"name":"ERC20InvalidSender","type":"error"},{"inputs":[{"internalType":"address","name":"spender","type":"address"}],"name":"ERC20InvalidSpender","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]

src/storage/blockchain/erc20-permit-sig.ts → src/storage/blockchain/erc20-helper.ts

@@ -1,6 +1,7 @@
-import { Contract, Signer } from 'ethers';
+import { Contract, Signer, ethers } from 'ethers';
 
-import abi from './abi/ERC20Permit.json';
+import permitAbi from './abi/ERC20Permit.json';
+import erc20Abi from './abi/ERC20.json';
 
 /**
  * @beta
@@ -19,7 +20,7 @@ export async function getPermitSignature(
   value: bigint,
   deadline: number
 ) {
-  const erc20PermitContract = new Contract(tokenAddress, abi, signer);
+  const erc20PermitContract = new Contract(tokenAddress, permitAbi, signer);
   const nonce = await erc20PermitContract.nonces(await signer.getAddress());
   const domainData = await erc20PermitContract.eip712Domain();
   const domain = {
@@ -49,3 +50,17 @@ export async function getPermitSignature(
 
   return signer.signTypedData(domain, types, message);
 }
+
+/**
+ * @beta
+ * getERC20Decimals is a function to retrieve the number of decimals of an ERC20 token
+ * @param {string} tokenAddress - Token address
+ * @param {ethers.ContractRunner} runner - Contract runner
+ */
+export async function getERC20Decimals(
+  tokenAddress: string,
+  runner: ethers.ContractRunner
+): Promise<number> {
+  const erc20Contract = new Contract(tokenAddress, erc20Abi, runner);
+  return erc20Contract.decimals();
+}

src/storage/blockchain/index.ts

@@ -2,4 +2,4 @@ export * from './state';
 export * from './onchain-zkp-verifier';
 export * from './onchain-revocation';
 export * from './did-resolver-readonly-storage';
-export * from './erc20-permit-sig';
+export * from './erc20-helper';

src/verifiable/constants.ts

@@ -154,6 +154,7 @@ export enum SupportedCurrencies {
   ETH_WEI = 'ETHWEI',
   ETH_GWEI = 'ETHGWEI',
   MATIC = 'MATIC',
+  POL = 'POL',
   USDT = 'USDT',
   USDC = 'USDC'
 }