Skip to content

FundingRequirement.toRpcRequest

Encodes unsigned funding intent without filling omitted fields.

Imports

Named
import { FundingRequirement } from 'ox/tempo'

Examples

import { FundingRequirement } from 'ox/tempo'
 
FundingRequirement.toRpcRequest({ amount: 50n })

Definition

function toRpcRequest(
  value: Request<bigint | number | Hex.Hex, number | Hex.Hex>,
): RequestRpc

Source: src/tempo/FundingRequirement.ts

Parameters

value

  • Type: Request<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

RequestRpc