settleRailCall

settleRailCall(options): OutputType

Defined in: packages/synapse-core/src/pay/settle-rail.ts:200

Create a call to the settleRail function

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

Parameters

Parameter	Type	Description
options	{ chain: Chain; contractAddress?: `0x${string}`; railId: bigint; untilEpoch: bigint; }	settleRailCall.OptionsType
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.railId	bigint	The rail ID to settle
options.untilEpoch	bigint	The epoch to settle up to. If not provided, the current epoch will be used.

Returns

OutputType

The call to the settleRail function settleRailCall.OutputType

Throws

Errors settleRailCall.ErrorType

Example

import { settleRailCall } from '@filoz/synapse-core/pay'
import { createWalletClient, http } 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, settleRailCall({
  chain: calibration,
  railId: 1n,
  untilEpoch: 1000n,
}))

console.log(request)

Copy to clipboard