funding.createPolicy

Creates a funding policy for token routes. The policy stores its administrators and a hash of its rules. Retain the full rules from the PolicyCreated event for later discovery.

Usage

import { Addresses, FundingSource } from 'viem/tempo'
import { client } from './viem.config'
 
const { policyId, rulesHash } = await client.funding.createPolicySync({
  admins: [client.account.address],
  rules: {
    maxSlippageBps: 100,
    sources: {
      [Addresses.pathUsd]: [FundingSource.dex({ tokenIn: Addresses.alphaUsd })],
    },
  },
})
{ policyId: 1n, rulesHash: '0x...' }

import { Account, createClient } from 'viem/tempo'
 
export const client = createClient({
  account: Account.fromSecp256k1('0x...'),
})

The asynchronous createPolicy variant returns a transaction hash. Use Actions.funding.createPolicy.extractEvent(receipt.logs) to read the ID and rules from its receipt.

Standalone Action

import { Actions, Addresses, FundingSource } from 'viem/tempo'
import { client } from './viem.config'
 
const { policyId, rulesHash } = await Actions.funding.createPolicySync(client, {
  admins: [client.account.address],
  rules: {
    maxSlippageBps: 100,
    sources: {
      [Addresses.pathUsd]: [FundingSource.dex({ tokenIn: Addresses.alphaUsd })],
    },
  },
})
{ policyId: 1n, rulesHash: '0x...' }

import { Account, createClient } from 'viem/tempo'
 
export const client = createClient({
  account: Account.fromSecp256k1('0x...'),
})

Return Value

createPolicy

type ReturnType = Hash

createPolicySync

type ReturnType = {
  policyId: bigint
  updater: Address
  rulesHash: Hex
  rules: FundingPolicy.Rules
  receipt: TransactionReceipt
}

Parameters

admins

• Type: Address[]

Addresses permitted to update this policy.

await client.funding.createPolicySync({
  admins: [client.account.address], 
  rules: { maxSlippageBps: 0, sources: {} },
})

rules

• Type: FundingPolicy.Rules

Token-keyed source routes and the maximum aggregate slippage. Source order within each route is preserved.

await client.funding.createPolicySync({
  admins: [client.account.address],
  rules: { 
    maxSlippageBps: 100, 
    sources: { 
      [Addresses.pathUsd]: [FundingSource.dex({ tokenIn: Addresses.alphaUsd })], 
    }, 
  }, 
})

account (optional)

• Type: Account | Address

Account that sends the transaction. For a coordinated multisig transaction, pass the multisig account.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be an unpaused USD-denominated TIP-20 token address or ID. Use client.fee.validateToken({ token }) to validate a token before submitting a transaction or setting it as a fee preference.

feePayer (optional)

• Type: Account | true

Fee payer for the transaction.

Can be a Viem Account, or true if a Fee Payer Service will be used.

gas (optional)

• Type: bigint

Gas limit for the transaction.

maxFeePerGas (optional)

• Type: bigint

Max fee per gas for the transaction.

maxPriorityFeePerGas (optional)

• Type: bigint

Max priority fee per gas for the transaction.

nonce (optional)

• Type: number

Nonce for the transaction.

nonceKey (optional)

• Type: 'expiring' | bigint

Nonce key for the transaction. Use 'expiring' to use expiring nonces (TIP-1009), which enables concurrent transaction submission without nonce ordering.

owner (optional)

• Type: Account | Address

Local owner that signs one coordinated multisig approval.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to *Sync actions.