chore: review comments #506

Author: DanielSchiavini

README.md

@@ -1206,9 +1206,9 @@ import curve from "@curvefi/api";
     await curve.router.getBestRouteAndOutput('DAI', 'CRV', '1000');
     
     // Then get calldata
-    const calldata = await curve.router.swapCalldata('DAI', 'CRV', '1000', 0.5);
-    // OR const calldata = await curve.router.swapCalldata('0x6B175474E89094C44Da98b954EedeAC495271d0F', '0xD533a949740bb3306d119CC777fa900bA034cd52', '1000', 0.5);
-    console.log(calldata);
+    const { data, to, from, amount } = await curve.router.populateSwap('DAI', 'CRV', '1000', 0.5);
+    // OR const tx = await curve.router.populateSwap('0x6B175474E89094C44Da98b954EedeAC495271d0F', '0xD533a949740bb3306d119CC777fa900bA034cd52', '1000', 0.5);
+    console.log(data);
     // 0x8f726f1c000000000000000000000000...
 })()
 ```

src/index.ts

@@ -18,7 +18,7 @@ import {
     swapApprove,
     swapEstimateGas,
     swap,
-    swapCalldata,
+    populateSwap,
     getSwappedAmount,
 } from "./router.js";
 import { Curve } from "./curve.js";
@@ -354,7 +354,7 @@ export const createCurve = () => {
             isApproved: swapIsApproved.bind(_curve),
             approve: swapApprove.bind(_curve),
             swap: swap.bind(_curve),
-            swapCalldata: swapCalldata.bind(_curve),
+            populateSwap: populateSwap.bind(_curve),
             getSwappedAmount: getSwappedAmount.bind(_curve),
             estimateGas: {
                 approve: swapApproveEstimateGas.bind(_curve),

src/router.ts

@@ -1,5 +1,5 @@
 import BigNumber from "bignumber.js";
-import {ethers} from "ethers";
+import {ethers, TransactionLike} from "ethers";
 import {type Curve, OLD_CHAINS} from "./curve.js";
 import {IChainId, IDict, IRoute, IRouteOutputAndCost, IRouteStep} from "./interfaces";
 import {
@@ -459,7 +459,7 @@ export async function swap(this: Curve, inputCoin: string, outputCoin: string, a
     }
 }
 
-export async function swapCalldata(this: Curve, inputCoin: string, outputCoin: string, amount: number | string, slippage = 0.5): Promise<string> {
+export async function populateSwap(this: Curve, inputCoin: string, outputCoin: string, amount: number | string, slippage = 0.5): Promise<TransactionLike> {
     console.log(inputCoin, outputCoin, amount, slippage);
     const [inputCoinAddress, outputCoinAddress] = _getCoinAddresses.call(this, inputCoin, outputCoin);
     const [inputCoinDecimals, outputCoinDecimals] = _getCoinDecimals.call(this, inputCoinAddress, outputCoinAddress);
@@ -476,16 +476,7 @@ export async function swapCalldata(this: Curve, inputCoin: string, outputCoin: s
     const _minRecvAmount = fromBN(minRecvAmountBN, outputCoinDecimals);
 
     const contract = this.contracts[this.constants.ALIASES.router].contract;
-    const value = isEth(inputCoinAddress) ? _amount : this.parseUnits("0");
-
-    let populatedTx;
-    if (_pools) {
-        populatedTx = await contract.exchange.populateTransaction(_route, _swapParams, _amount, _minRecvAmount, _pools, { value });
-    } else {
-        populatedTx = await contract.exchange.populateTransaction(_route, _swapParams, _amount, _minRecvAmount, { value });
-    }
-    
-    return populatedTx.data as string;
+    return await contract.exchange.populateTransaction(...[_route, _swapParams, _amount, _minRecvAmount, ..._pools ? [_pools] : [], { value: isEth(inputCoinAddress) ? _amount : this.parseUnits("0") }])
 }
 
 export async function getSwappedAmount(this: Curve, tx: ethers.ContractTransactionResponse, outputCoin: string): Promise<string> {