estimate_contract_template_deploy

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Health

Webhook Subscriptions

Monitor Tokens

Developer Account

Faucet

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

estimate_contract_template_deployPython,latest

Go to PyPI

Estimate the fee required to deploy contract by template.

Parameters

ContractDeploymentEstimateRequest

object

Required

Show 4 properties

blockchain

string

Required

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.

Allowed valuesETHETH-SEPOLIAMATICMATIC-AMOYARBARB-SEPOLIAUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

source_address

string

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

template_parameters

object

JSON object that contains the template deployment parameters used to initialize the contract(s) on-chain.

wallet_id

string

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

string

Required

The universally unique identifier of the resource.

x_request_id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Responses

200FeeEstimationResponse

Response Body

object

data

object

Required

Show 3 properties

high

object

Show 8 properties

gas_limit

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.

gas_price

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.

max_fee

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.

priority_fee

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.

base_fee

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.

network_fee

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.

network_fee_raw

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.

l_1_fee

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.

low

object

Show 8 properties

gas_limit

string

gas_price

string

max_fee

string

priority_fee

string

base_fee

string

network_fee

string

network_fee_raw

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.

l_1_fee

string

medium

object

Show 8 properties

gas_limit

string

gas_price

string

max_fee

string

priority_fee

string

base_fee

string

network_fee

string

network_fee_raw

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.

l_1_fee

string

400Error

Example

1from circle.web3 import smart_contract_platform
2from circle.web3 import utils
3
4client = utils.init_smart_contract_platform_client(api_key=key, entity_secret=entitySecret)
5
6api_instance = smart_contract_platform.TemplatesApi(client)
7request = smart_contract_platform.ContractDeploymentEstimateRequest.from_dict({
8    "blockchain": "ETH-SEPOLIA",
9    "sourceAddress": "0x1b44F3514812d835EB1BDB0acB33d3fA3351Ee43",
10})
11response = api_instance.estimate_contract_template_deploy(id="a2b66f87-3131-2832-bcd3-175a36a4d442", contract_deployment_estimate_request=request)
12print(response.json())
13

ResponseChoose an example

1{
2  "data": {
3    "high": {
4      "gas_limit": "21000",
5      "gas_price": "",
6      "max_fee": "5.935224468",
7      "priority_fee": "1.022783914",
8      "base_fee": "1.022783914",
9      "network_fee": "0.0001246397138",
10      "network_fee_raw": "0.0001246397138",
11      "l_1_fee": "0.000000000000140021"
12    },
13    "low": {
14      "gas_limit": "21000",
15      "gas_price": "",
16      "max_fee": "5.935224468",
17      "priority_fee": "1.022783914",
18      "base_fee": "1.022783914",
19      "network_fee": "0.0001246397138",
20      "network_fee_raw": "0.0001246397138",
21      "l_1_fee": "0.000000000000140021"
22    },
23    "medium": {
24      "gas_limit": "21000",
25      "gas_price": "",
26      "max_fee": "5.935224468",
27      "priority_fee": "1.022783914",
28      "base_fee": "1.022783914",
29      "network_fee": "0.0001246397138",
30      "network_fee_raw": "0.0001246397138",
31      "l_1_fee": "0.000000000000140021"
32    }
33  }
34}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy