FundingRequirement.toRpc

Converts a funding requirement to RPC quantities.

Imports

import { FundingRequirement } from 'ox/tempo'

Examples

import { FundingRequirement } from 'ox/tempo'
 
const token = '0x20c0000000000000000000000000000000000001' as const
FundingRequirement.toRpc({ token, amount: 50n, sources: [] })

Definition

function toRpc(
  value: FundingRequirement<bigint | number | Hex.Hex, number | Hex.Hex>,
): Rpc

Source: src/tempo/FundingRequirement.ts

Parameters

value

• Type: FundingRequirement<bigint | number | Hex.Hex, number | Hex.Hex>

value.amount

• Type: bigintType

Target balance, including existing funds, in token base units.

value.policyRules

• Type: 0x${string}
• Optional

Canonical policy rules for access key funding. Owners omit this field.

value.slippageBps

• Type: numberType
• Optional

Aggregate slippage in basis points. Omission uses the protocol default.

value.sources

• Type: readonly Source[]

Sources attempted in order.

value.token

• Type: abitype_Address

Requested output token.

Return Type

Rpc