encodeDeployData #

Encodes deploy data (bytecode & constructor args) into an ABI encoded value.

Install #

import { encodeDeployData } from 'viem/contract'

Usage #

Below is a very basic example of how to encode deploy data.

import { encodeDeployData } from 'viem/contract'

const data = encodeDeployData({
  abi: wagmiAbi,
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...'
})
// 0x608060405260405161083e38038061083e833981016040819052610...

export const wagmiAbi = [
  ...
  { 
    inputs: [], 
    stateMutability: 'nonpayable', 
    type: 'constructor' 
  },
  ...
] as const;

import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

export const publicClient = createPublicClient({
  chain: mainnet,
  transport: http()
})

Passing Arguments #

If your constructor requires argument(s), you can pass them through with the args attribute.

TypeScript types for args will be inferred from the constructor & ABI, to guard you from inserting the wrong values.

For example, the constructor below requires an address argument, and it is typed as ["0x${string}"].

import { encodeFunctionData } from 'viem/contract'
import { publicClient } from './client'
import { wagmiAbi } from './abi'

const data = encodeFunctionData({
  abi: wagmiAbi,
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
  args: ['0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC']
})
// 0x608060405260405161083e38038061083e833981016040819052610...00000000000000000000000000000000a5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC

export const wagmiAbi = [
  ...
  {
    inputs: [{ name: 'owner', type: 'address' }],
    stateMutability: 'nonpayable',
    type: 'constructor',
  },
  ...
] as const;

import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

export const publicClient = createPublicClient({
  chain: mainnet,
  transport: http()
})

Return Value #

Hex

ABI encoded data (bytecode & constructor arguments).

Parameters #

abi #

• Type: Abi

The contract's ABI.

const data = encodeFunctionData({
  abi: wagmiAbi, 
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
  args: ['0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC']
})

bytecode #

• Type: Hex

Contract bytecode.

const data = encodeFunctionData({
  abi: wagmiAbi,
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...', 
  args: ['0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC']
})

args (optional) #

• Type: Inferred from ABI.

Arguments to pass to function call.

const data = encodeFunctionData({
  abi: wagmiAbi,
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
  args: ['0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC'] 
})