Skip to content

Commit

Permalink
docs: Add JSDoc documentation to confiPump.ts
Browse files Browse the repository at this point in the history
  • Loading branch information
madjin committed Dec 29, 2024
1 parent ba750e0 commit 7b61579
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions packages/plugin-conflux/src/actions/confiPump.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ import MEMEABI from "../abi/meme";
import ERC20ABI from "../abi/erc20";

// Helper function to check and approve token allowance if needed
/**
* Ensure that the account has enough allowance for a specified amount of tokens to be transferred to a meme address.
*
* @param {WalletClient} walletClient - The wallet client used to send transactions.
* @param {string} rpcUrl - The URL of the RPC node.
* @param {Account} account - The account for which the allowance is being checked.
* @param {string} tokenAddress - The address of the token contract.
* @param {string} memeAddress - The address of the meme contract.
* @param {bigint} amount - The amount of tokens to be transferred.
*/
async function ensureAllowance(
walletClient: WalletClient,
rpcUrl: string,
Expand Down

0 comments on commit 7b61579

Please sign in to comment.