We refreshed our doc site!
Bookmarked links may have changed
Read release notesPOSThttps://api.circle.com/v1/w3s/templates/{id}/deploy
Deploy a smart contract using a template.
The universally unique identifier (UUID v4) of the resource.
A base64 string expression of the entity secret ciphertext. The entity secret should be encrypted by the entity public key. Circle mandates that the entity secret ciphertext is unique for each API request.
Name of the contract in your Circle console.
System-generated unique identifier of the resource.
The blockchain network that the resource is to be created on or is currently on.
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.
Description of the contract.
JSON object that contains the template deployment parameters used to initialize the contract(s) on-chain.
A dynamic blockchain fee level setting (LOW
, MEDIUM
, or HIGH
) that will be used to pay gas for the transaction. Calculated based on network traffic, supply of validators, and demand for transaction verification. Cannot be used with gasPrice
, priorityFee
, or maxFee
.
Estimates for each fee level can be obtained through the POST /transactions/transfer/estimateFee
API.
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.
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.
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.
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.
RefID is a custom label field.
1{
2 "data": {
3 "contractIds": [],
4 "transactionId": ""
5 }
6}