viem-goviem-go

writeContractSync

Executes a write function on a contract synchronously

A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a Transaction is needed to be broadcast in order to change the state.

Internally, encodes the function call using the ABI and delegates to sendTransactionSync with the ABI-encoded data.

:::warning This internally sends a transaction – it does not validate if the contract write will succeed. It is highly recommended to simulate the contract write first. :::

:::warning This Action is only recommended to be used on chains with low block times and fast finality (most chains apart from mainnet). :::

Import

Import the wallet actions package so you can call this action synchronously.

import "github.com/ChefBingbong/viem-go/actions/wallet"

Usage

See how to construct a wallet client and call this action.

import (
  "context"
  "log"


  "github.com/ChefBingbong/viem-go/actions/wallet"
  "github.com/ChefBingbong/viem-go/client"
  "github.com/ChefBingbong/viem-go/client/transport"
  "github.com/ChefBingbong/viem-go/chain/definitions"
)


ctx := context.Background()


walletClient, err := client.CreateWalletClient(client.WalletClientConfig{
  Chain:     definitions.Mainnet,
  Transport: transport.HTTP("https://eth.llamarpc.com"),
})
if err != nil {
  log.Fatal(err)
}
defer func() { _ = walletClient.Close() }()


receipt, err := wallet.WriteContractSync(ctx, walletClient, wallet.WriteContractSyncParameters{
  WriteContractParameters: wallet.WriteContractParameters{
      Address:      "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
      ABI:          mintABI,
      FunctionName: "mint",
      Args:         []any{uint32(69420)},
  },
})
if err != nil {
  log.Fatal(err)
}
log.Printf("Transaction receipt: %+v", receipt)

Returns

*formatters.TransactionReceipt

The transaction receipt after the transaction is included in a block.

Parameters

All parameters from writeContract are supported, plus:

PollingInterval

Control how frequently the transaction receipt is polled.

  • Type: time.Duration

  • Default: client.PollingInterval()

  • Optional

The polling interval to poll for the transaction receipt.

ThrowOnReceiptRevert

  • Type: *bool

  • Default: true

  • Optional

When true, throws an error if the transaction was detected as reverted.

Timeout

  • Type: *time.Duration

  • Default: max(chain.blockTime * 3, 5000ms)

  • Optional

The timeout to wait for a response.

JSON-RPC Methods