Merge pull request #143 from getclave/feat/allow-string-amount

feat: allow string type on `prepareDepositTxs`
peanutprotocol · Aug 24, 2024 · 0e27966 · 0e27966
2 parents c0db3fd + 89d8969
commit 0e27966
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/src/consts/interfaces.consts.ts b/src/consts/interfaces.consts.ts
@@ -30,7 +30,7 @@ export enum EPeanutLinkType {
 
 export interface IPeanutLinkDetails {
 	chainId: string
-	tokenAmount: number
+	tokenAmount: number | string
 	tokenType?: EPeanutLinkType
 	tokenAddress?: string
 	tokenId?: number

diff --git a/src/index.ts b/src/index.ts
@@ -793,6 +793,14 @@ function trim_decimal_overflow(_n: number, decimals: number) {
 	return arr[0] + '.' + fraction
 }
 
+function getStringAmount(amount: interfaces.IPeanutLinkDetails['tokenAmount'], decimals: number) {
+	if (typeof amount === 'string') {
+		return amount
+	} else {
+		return trim_decimal_overflow(amount, decimals)
+	}
+}
+
 /**
  * Returns an array of transactions necessary to create a link (e.g. 1. approve, 2. makeDeposit)
  * all values obligatory.
@@ -827,7 +835,7 @@ async function prepareDepositTxs({
 			'Error validating link details: please make sure all required fields are provided and valid'
 		)
 	}
-	const tokenAmountString = trim_decimal_overflow(linkDetails.tokenAmount, linkDetails.tokenDecimals!)
+	const tokenAmountString = getStringAmount(linkDetails.tokenAmount, linkDetails.tokenDecimals!)
 	const tokenAmountBigNum = ethers.utils.parseUnits(tokenAmountString, linkDetails.tokenDecimals)
 	const totalTokenAmount = tokenAmountBigNum.mul(numberOfLinks)
 
@@ -1267,7 +1275,7 @@ async function validateLinkDetails(
 		throw new Error('need to provide tokenAddress if tokenType is not 0')
 	}
 
-	const tokenAmountString = trim_decimal_overflow(linkDetails.tokenAmount, linkDetails.tokenDecimals!)
+	const tokenAmountString = getStringAmount(linkDetails.tokenAmount, linkDetails.tokenDecimals!)
 	const tokenAmountBigNum = ethers.utils.parseUnits(tokenAmountString, linkDetails.tokenDecimals) // v5
 	assert(tokenAmountBigNum.gt(0), 'tokenAmount must be greater than 0')
 
@@ -3217,4 +3225,5 @@ export {
 	getTxReceiptFromHash,
 	getTokenBalance,
 	compareVersions,
+	getStringAmount,
 }
diff --git a/src/raffle.ts b/src/raffle.ts
@@ -15,7 +15,7 @@ import {
 	getLinksFromTx,
 	interfaces,
 	prepareApproveERC20Tx,
-	trim_decimal_overflow,
+	getStringAmount,
 } from '.'
 import { getRawParamsFromLink, validateUserName, compareVersions } from './util'
 import {
@@ -174,7 +174,7 @@ export async function prepareRaffleDepositTxs({
 
 	// Convert linkDetails.tokenAmount to BigNumber.
 	// Used only for ETH and ERC20 raffles.
-	const tokenAmountString = trim_decimal_overflow(linkDetails.tokenAmount, linkDetails.tokenDecimals)
+	const tokenAmountString = getStringAmount(linkDetails.tokenAmount, linkDetails.tokenDecimals)
 	const tokenAmountBigNum = ethers.utils.parseUnits(tokenAmountString, linkDetails.tokenDecimals)
 
 	const peanutVaultAddress = getContractAddress(linkDetails.chainId, peanutContractVersion)