@biconomy/abstractjs
Version:
SDK for Biconomy integration with support for account abstraction, smart accounts, ERC-4337.
113 lines • 4.38 kB
JavaScript
import { encodeFunctionData, erc20Abi } from "viem";
import { isComposableCallRequired, isRuntimeComposableValue } from "../../../modules/utils/composabilityCalls.js";
import { getFunctionContextFromAbi } from "../../../modules/utils/runtimeAbiEncoding.js";
import { buildComposableCall } from "./buildComposable.js";
/**
* Builds an instruction for transferring tokens using transferFrom. This function is used
* when transferring tokens from an address that has approved the spender.
*
* @param baseParams - Base configuration for the instruction
* @param baseParams.account - The account that will execute the transfer
* @param baseParams.currentInstructions - Optional array of existing instructions to append to
* @param parameters - Parameters for the transferFrom
* @param parameters.chainId - Chain ID where the transfer will be executed
* @param parameters.tokenAddress - Address of the token to transfer
* @param parameters.amount - Amount to transfer
* @param [parameters.gasLimit] - Optional gas limit for the transfer
* @param [parameters.owner] - Optional owner address (defaults to signer)
* @param [parameters.recipient] - Optional recipient address
*
* @returns Promise resolving to array of instructions
*
* @example
* ```typescript
* const instructions = await buildTransferFrom(
* { accountAddress: '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' },
* {
* chainId: 1,
* tokenAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
* amount: 1000000n, // 1 USDC
* gasLimit: 75000n,
* owner: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
* recipient: "0x1234567890123456789012345678901234567890"
* }
* );
* ```
*/
export const buildTransferFrom = async (baseParams, parameters, composabilityParams) => {
const { currentInstructions = [] } = baseParams;
const { chainId, tokenAddress, amount, gasLimit, sender, recipient, metadata, lowerBoundTimestamp, upperBoundTimestamp, executionSimulationRetryDelay, simulationOverrides } = parameters;
const { forceComposableEncoding } = composabilityParams ?? {
forceComposableEncoding: false
};
const abi = erc20Abi;
const functionSig = "transferFrom";
const args = [
sender,
recipient,
amount
];
const functionContext = getFunctionContextFromAbi(functionSig, abi);
// Check for the runtime arguments and detect the need for composable call
const isComposableCall = forceComposableEncoding
? true
: isComposableCallRequired(functionContext, args);
let transferFromCall;
// If the composable call is detected ? The call needs to composed with runtime encoding
if (isComposableCall) {
if (!composabilityParams) {
throw new Error("Composability params are required to build a composable call");
}
const composableCallParams = {
to: tokenAddress,
functionName: functionSig,
args: args,
abi,
chainId,
...(gasLimit ? { gasLimit } : {})
};
transferFromCall = await buildComposableCall(composableCallParams, composabilityParams);
}
else {
transferFromCall = [
{
to: tokenAddress,
data: encodeFunctionData({
abi,
functionName: functionSig,
args: args
}),
...(gasLimit ? { gasLimit } : {})
}
];
}
const defaultMetadata = [
{
type: "TRANSFER",
tokenAddress: isRuntimeComposableValue(tokenAddress)
? "RUNTIME_VALUE"
: tokenAddress,
fromAddress: sender,
toAddress: recipient,
amount: isRuntimeComposableValue(amount)
? "RUNTIME_VALUE"
: amount,
chainId
}
];
return [
...currentInstructions,
{
calls: transferFromCall,
chainId,
isComposable: isComposableCall,
metadata: metadata || defaultMetadata,
lowerBoundTimestamp,
upperBoundTimestamp,
executionSimulationRetryDelay,
simulationOverrides
}
];
};
export default buildTransferFrom;
//# sourceMappingURL=buildTransferFrom.js.map