Estimate a contract deployment

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

X-Request-Id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support. A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Body

application/json

Estimate a transaction fee for deploying a smart contract

bytecode

string

required

Bytecode of the contract being deployed.

Minimum string length: 1

Example:

"0x60806040523480156200001157600080fd5b50604051806040..."

abiJson

string

The contract's ABI in a JSON stringified format.

Example:

"[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},..."

blockchain

enum<string>

The blockchain network that the resource is to be created on or is currently on. Required along with sourceAddress if you don't provide walletId. The blockchain and walletId fields are mutually exclusive.

Available options:

ETH,

ETH-SEPOLIA,

MATIC,

MATIC-AMOY,

ARB,

ARB-SEPOLIA,

UNI,

UNI-SEPOLIA,

BASE,

BASE-SEPOLIA,

OP,

OP-SEPOLIA

Example:

"MATIC-AMOY"

constructorSignature

string

Signature of the constructor if the contract has one. constructor() by default.

Required string length: 1 - 1000

Example:

"constructor(string ticker, uint256 totalSupply)"

constructorParameters

any[]

A list of arguments to pass to the contract's constructor function. Must be an empty array if there are no constructor parameters.

Can be any value - string, number, boolean, array or object.

Example:

["TICK", 10000]

sourceAddress

string

Source address of the transaction. Required along with blockchain if walletId is not provided. The sourceAddress and walletId fields are mutually exclusive.

Example:

"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c"

walletId

string<uuid>

Unique system generated identifier of the wallet. For contract deploys this wallet ID will be used as the source.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

Response

Estimate is successful.

data

object

required

Show child attributes

data.high

object

Show child attributes

data.high.gasLimit

string

The maximum units of gas to use for the transaction. Required if feeLevel is not provided. Estimates for this limit can be obtained through the POST /transactions/transfer/estimateFee API. GasLimit override (only supported for EOA wallets): Using gasLimit together with feeLevel, the provided gasLimit is required to be greater or equal to feeLevel estimation and will override the estimation's gasLimit.

Example:

"21000"

data.high.gasPrice

string

For blockchains without EIP-1559 support, the maximum price of gas, in gwei, to use per each unit of gas (see gasLimit). Requires gasLimit. Cannot be used with feeLevel, priorityFee, or maxFee. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

data.high.maxFee

string

For blockchains with EIP-1559 support, the maximum price per unit of gas (see gasLimit), in gwei. Requires priorityFee, and gasLimit to be present. Cannot be used with feeLevel or gasPrice. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

Example:

"5.935224468"

data.high.priorityFee

string

For blockchains with EIP-1559 support, the “tip”, in gwei, to add to the base fee as an incentive for validators. Please note that the maxFee and gasLimit parameters are required alongside the priorityFee. The feeLevel and gasPrice parameters cannot be used with the priorityFee. Estimations for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

Example:

"1.022783914"

data.high.baseFee

string

For blockchains with EIP-1559 support, the estimated base fee represents the minimum fee required for a transaction to be included in a block on the blockchain. It is measured in gwei and compensates for the computational resources validators consume to process the transaction. The base fee is supplemented by a separate "tip" called the priority fee, which acts as an extra incentive for validators to prioritize the transaction. The priority fee is added to the base fee to calculate the final transaction fee.

Example:

"1.022783914"

data.high.networkFee

string

The estimated network fee is the maximum amount of cryptocurrency (such as ETH, ARB, or SOL) that you will pay for your transaction. This fee depends on the parameters you set, including Gas Limit, Priority Fee, and Max Fee. It compensates for the computational resources that validators consume to process the transaction. It is measured in native token such as ETH, SOL. For blockchains with L1 data fees such as OP/BASE, the network fee is a combination of the Execution Gas Fee and the L1 Data Fee. Each blockchain might use different formula for network fee. Refer to each specific blockchain's documentation to understand how networkFee is calculated.

Example:

"0.0001246397138"

data.high.networkFeeRaw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

Example:

"0.0001246397138"

data.high.l1Fee

string

This fee represents the Layer 1 (L1) rollup charge associated with transactions on Layer 2 blockchains. The amount is expressed in the native currency, such as ETH. This field is relevant for Layer 2 blockchains utilizing a rollup mechanism and for specific account types, such as externally owned accounts (EOAs) on the Optimism (OP) blockchain.

Example:

"0.000000000000140021"

data.low

object

Show child attributes

data.low.gasLimit

string

Example:

"21000"

data.low.gasPrice

string

data.low.maxFee

string

Example:

"5.935224468"

data.low.priorityFee

string

Example:

"1.022783914"

data.low.baseFee

string

Example:

"1.022783914"

data.low.networkFee

string

Example:

"0.0001246397138"

data.low.networkFeeRaw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

Example:

"0.0001246397138"

data.low.l1Fee

string

Example:

"0.000000000000140021"

data.medium

object

Show child attributes

data.medium.gasLimit

string

Example:

"21000"

data.medium.gasPrice

string

data.medium.maxFee

string

Example:

"5.935224468"

data.medium.priorityFee

string

Example:

"1.022783914"

data.medium.baseFee

string

Example:

"1.022783914"

data.medium.networkFee

string

Example:

"0.0001246397138"

data.medium.networkFeeRaw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

Example:

"0.0001246397138"

data.medium.l1Fee

string

Example:

"0.000000000000140021"

API Overview

Contracts

Estimate a contract deployment

Authorizations

Headers

Body

Response