depositCall

depositCall(options): OutputType

Defined in: packages/synapse-core/src/pay/deposit.ts:209

Create a call to the deposit function

This function is used to create a call to the deposit function for use with sendCalls, sendTransaction, multicall, estimateContractGas, or simulateContract.

Parameters

Parameter	Type	Description
options	{ amount: bigint; chain: Chain; contractAddress?: `0x${string}`; to: `0x${string}`; token?: `0x${string}`; }	depositCall.OptionsType
options.amount	bigint	The amount to deposit (in token base units). Must be greater than 0.
options.chain	Chain	The chain to use to make the call.
options.contractAddress?	`0x${string}`	Payments contract address. If not provided, the default is the payments contract address for the chain.
options.to	`0x${string}`	The recipient address for the deposit. If not provided, the sender’s address will be used.
options.token?	`0x${string}`	The address of the ERC20 token to deposit. If not provided, the USDFC token address will be used.

Returns

OutputType

The call to the deposit function depositCall.OutputType

Throws

Errors depositCall.ErrorType

Example

import { depositCall } from '@filoz/synapse-core/pay'
import { createWalletClient, http, parseUnits } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
import { simulateContract } from 'viem/actions'
import { calibration } from '@filoz/synapse-core/chains'

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

// Use with simulateContract
const { request } = await simulateContract(client, depositCall({
  chain: calibration,
  to: account.address,
  amount: parseUnits('100', 18),
}))

console.log(request)