approveSync

approveSync(client, options): Promise<OutputType>

Defined in: packages/synapse-core/src/erc20/approve.ts:137

Approve an ERC20 token allowance and wait for confirmation

Approves a spender to transfer tokens and waits for the transaction to be confirmed. Returns the receipt with the Approval event.

Parameters

Parameter	Type	Description
client	Client<Transport, Chain, Account>	The viem client with account to use for the transaction.
options	{ amount: bigint; onHash?: (hash) => void; spender?: `0x${string}`; token?: `0x${string}`; }	approveSync.OptionsType
options.amount	bigint	The amount to approve (in token base units).
options.onHash?	(hash) => void	Callback function called with the transaction hash before waiting for the receipt.
options.spender?	`0x${string}`	The address of the spender to approve. If not provided, the Filecoin Pay contract address will be used.
options.token?	`0x${string}`	The address of the ERC20 token to approve. If not provided, the USDFC token address will be used.

Returns

Promise<OutputType>

The transaction receipt and extracted event approveSync.OutputType

Throws

Errors approveSync.ErrorType

Example

import { approveSync } from '@filoz/synapse-core/erc20'
import { createWalletClient, http, parseUnits } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
import { calibration } from '@filoz/synapse-core/chains'

const account = privateKeyToAccount('0x...')
const client = createWalletClient({
  account,
  chain: calibration,
  transport: http(),
})

const { receipt, event } = await approveSync(client, {
  amount: parseUnits('100', 18),
  onHash: (hash) => console.log('Transaction sent:', hash),
})

console.log('Approved amount:', event.args.value)
console.log('Spender:', event.args.spender)

Copy to clipboard