Skip to main content

writeContract

Executes a program function on-chain and returns the transaction id.

The workhorse write action: use it when the transaction id is enough and the function's outputs are not needed. Use executeContract for outputs, simulateContract for a dry run. Signs, proves, and broadcasts, so it hits the network and costs a fee. Returns as soon as the transaction is submitted — it does not wait for acceptance; poll transactionStatus for the outcome. Exported as executeTransaction too, matching Aleo wallet-adapter terminology.

Usage​

import { createWalletClient, http } from '@provablehq/veil-core'
import { loadNetwork } from '@provablehq/veil-aleo-sdk'

const aleo = await loadNetwork('testnet')
const account = aleo.privateKeyToAccount('APrivateKey1...')

const client = createWalletClient({
  account,
  transport: http('https://edge.provable.com/api/v2', { network: 'testnet' }),
  proving: aleo.createProvingConfig({
    mode: 'delegated',
    networkUrl: 'https://edge.provable.com/api/v2',
    proverUrl: 'https://edge.provable.com/api/prove',
    account,
  }),
})

const txId = await client.writeContract({
  program: 'token.aleo',
  function: 'transfer_public',
  inputs: ['aleo1...', '100u64'],
  onProgress(event) {
    console.log(event.type)
  },
})
// 'at1...'

Account type differences​

A wallet-adapter (RPC) account hands the call to the connected wallet, which proves, signs, and broadcasts in one step and prompts the user. A local SDK account builds and proves the transaction through the client's proving config — in process for mode: 'local', via a delegated prover for mode: 'delegated' — then broadcasts the proved transaction through the client's transport. The delegated prover does not broadcast for writeContract. Delegated mode uses proverUrl on the proving config, which defaults to the hosted Provable prover and needs no credentials; local mode needs no prover at all. Either way the fee comes out of the account. useFeeMaster defaults to false; enable it only when the configured prover service has explicitly granted FeeMaster access.

onProgress is awaited at available proving and submission boundaries. Local accounts may report request-built, prover-submitted, prover-returned, transaction-prepared, and transaction-submitted. The transaction-prepared event includes the fully proved transaction before the transport broadcasts it, allowing durable recovery without proving a replacement. Wallet-adapter accounts generally expose only transaction-submitted because their request combines proving and broadcast.

inputs may contain record and address InputRequests only on the wallet-adapter path — the wallet resolves them without exposing private data to the caller. The local-proving path only accepts Aleo-encoded literal strings and throws if it sees an InputRequest; supply record inputs directly, as described in Working with records.

Returns​

string

The transaction id (at1...) of the broadcast execution.

Parameters​

program​

  • Type: string

Program id, e.g. token.aleo.

function​

  • Type: string

Function or transition name to invoke within program.

inputs​

  • Type: (string | InputRequest)[]

Function inputs: Aleo-encoded literal strings ('100u64', 'aleo1...'), or InputRequest objects a wallet-adapter account fulfills — see Working with records.

privateFee​

  • Type: boolean
  • Default: false

Pays the fee from a private record instead of the public credits balance. The fee record is resolved through the client's record provider; the caller does not supply one.

imports​

  • Type: string[]

Names of programs reached through dynamic dispatch that the prover or wallet cannot discover statically. Programs declared in program's own import block are discovered automatically and do not need listing here.