Skip to content

deployContract

Deploys a contract to the network, given bytecode & constructor arguments by using EIP712 transaction.

Usage

example.ts
import { wagmiAbi } from './abi'
import { account, walletClient } from './config'
 
const hash = await walletClient.deployContract({
  abi,
  account,
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})

Deploying with Constructor Args

example.ts
import { deployContract } from 'viem'
import { wagmiAbi } from './abi'
import { account, walletClient } from './config'
 
const hash = await walletClient.deployContract({
  abi,
  account,
  args: [69420],
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})

Deploying with Factory Deps

example.ts
import { deployContract } from 'viem'
import { wagmiAbi } from './abi'
import { account, walletClient } from './config'
 
const hash = await walletClient.deployContract({
  abi,
  account,
  args: [69420],
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
  factoryDeps: [
    '0x702040405260405161083e38038061083e833981016040819123456...', 
    '0x102030405260405161083e38038061083e833981016040819112233...'
  ]
})

Returns

Hash

The Transaction hash.

Parameters

abi

The contract's ABI.

const hash = await walletClient.deployContract({
  abi: wagmiAbi, 
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})

account

  • Type: Account | Address

The Account to deploy the contract from.

Accepts a JSON-RPC Account or Local Account (Private Key, etc).

const hash = await walletClient.deployContract({
  abi: wagmiAbi, 
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', 
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})

bytecode

The contract's bytecode.

const hash = await walletClient.deployContract({
  abi: wagmiAbi,
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...', 
})

args

  • Type: Inferred from ABI.

Constructor arguments to call upon deployment.

const hash = await walletClient.deployContract({
  abi: wagmiAbi,
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
  args: [69] 
})

deploymentType (optional)

  • Type: 'create' | 'create2' | 'createAccount' | 'create2Account'

Specifies the type of contract deployment. Defaults to 'create'.

const hash = await walletClient.deployContract({
  abi: wagmiAbi,
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
  args: [69],
  deploymentType: 'create2'
})

salt (optional)

Specifies a unique identifier for the contract deployment.

const hash = await walletClient.deployContract({
  abi: wagmiAbi,
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
  args: [69],
  salt: '0x201050...'
})

gasPerPubdata (optional)

  • Type: bigint

The amount of gas for publishing one byte of data on Ethereum.

const hash = await walletClient.sendTransaction({
  account,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  gasPerPubdata: 50000, 
  nonce: 69,
  value: 1000000000000000000n
})

paymaster (optional)

  • Type: Account | Address

Address of the paymaster account that will pay the fees. The paymasterInput field is required with this one.

const hash = await walletClient.sendTransaction({
  account,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  paymaster: '0x4B5DF730c2e6b28E17013A1485E5d9BC41Efe021', 
  paymasterInput: '0x8c5a...'
  nonce: 69,
  value: 1000000000000000000n
})

paymasterInput (optional)

  • Type: 0x${string}

Input data to the paymaster. The paymaster field is required with this one.

const hash = await walletClient.sendTransaction({
  account,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  paymaster: '0x4B5DF730c2e6b28E17013A1485E5d9BC41Efe021', 
  paymasterInput: '0x8c5a...'
  nonce: 69,
  value: 1000000000000000000n
})