Estimate fees and expiration block heights for a transfer

curl --request POST \
  --url https://gateway-api-testnet.circle.com/v1/estimate \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "spec": {
      "version": 1,
      "sourceDomain": 0,
      "destinationDomain": 4,
      "sourceContract": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "destinationContract": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "sourceToken": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "destinationToken": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "sourceDepositor": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "destinationRecipient": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "sourceSigner": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "destinationCaller": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "value": "1000000000000000000",
      "salt": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "hookData": "0x1a2b3c4d"
    },
    "maxBlockHeight": "1000000000000000000",
    "maxFee": "1000000000000000000"
  }
]
'

[
  {
    "burnIntent": {
      "maxBlockHeight": "1000000000000000000",
      "maxFee": "1000000000000000000",
      "spec": {
        "version": 1,
        "sourceDomain": 0,
        "destinationDomain": 4,
        "sourceContract": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "destinationContract": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "sourceToken": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "destinationToken": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "sourceDepositor": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "destinationRecipient": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "sourceSigner": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "destinationCaller": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "value": "1000000000000000000",
        "salt": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "hookData": "0x1a2b3c4d"
      }
    }
  }
]

POST

estimate

curl --request POST \
  --url https://gateway-api-testnet.circle.com/v1/estimate \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "spec": {
      "version": 1,
      "sourceDomain": 0,
      "destinationDomain": 4,
      "sourceContract": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "destinationContract": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "sourceToken": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "destinationToken": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "sourceDepositor": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "destinationRecipient": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "sourceSigner": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "destinationCaller": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "value": "1000000000000000000",
      "salt": "0x1234567890123456789012345678901234567890123456789012345678901234",
      "hookData": "0x1a2b3c4d"
    },
    "maxBlockHeight": "1000000000000000000",
    "maxFee": "1000000000000000000"
  }
]
'

[
  {
    "burnIntent": {
      "maxBlockHeight": "1000000000000000000",
      "maxFee": "1000000000000000000",
      "spec": {
        "version": 1,
        "sourceDomain": 0,
        "destinationDomain": 4,
        "sourceContract": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "destinationContract": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "sourceToken": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "destinationToken": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "sourceDepositor": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "destinationRecipient": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "sourceSigner": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "destinationCaller": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "value": "1000000000000000000",
        "salt": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "hookData": "0x1a2b3c4d"
      }
    }
  }
]

Query Parameters

maxAttestationSize

integer

Maximum allowed size (in bytes) for the encoded attestation.

Required range: x >= 1

Body

application/json

Minimum array length: 1

Option 1
Option 2

A burn intent for estimation purposes without signatures. Optional maxBlockHeight and maxFee for cost estimation.

spec

object

required

Show child attributes

spec.version

integer

required

Version of the transfer spec (uint32).

Required range: 0 <= x <= 4294967295

Example:

1

spec.sourceDomain

integer

required

The domain of the wallet contract this transfer came from (uint32).

Required range: 0 <= x <= 4294967295

Example:

0

spec.destinationDomain

integer

required

The domain of the minter contract this transfer is valid for (uint32).

Required range: 0 <= x <= 4294967295

Example:

4

spec.sourceContract

string

required

The address of the wallet contract on the source domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.destinationContract

string

required

The address of the minter contract on the destination domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.sourceToken

string

required

The token address on the source domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.destinationToken

string

required

The token address on the destination domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.sourceDepositor

string

required

The address to debit within the wallet contract on the source domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.destinationRecipient

string

required

The address that should receive the funds on the destination domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.sourceSigner

string

required

The signer who signed for the transfer (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.destinationCaller

string

required

The address of the caller who may use the attestation, 0 address if any caller (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.value

string

required

The amount to be transferred.

Example:

"1000000000000000000"

spec.salt

string

required

An arbitrary value chosen by the user to be unique.

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

spec.hookData

string

Arbitrary bytes that may be used for onchain composition (optional).

Example:

"0x1a2b3c4d"

maxBlockHeight

string

The maximum block height at which this burn is valid (optional for estimation).

Example:

"1000000000000000000"

maxFee

string

The maximum fee the user is willing to pay (optional for estimation).

Example:

"1000000000000000000"

Response

Successfully calculated the estimated fees and expiration block heights

Option 1
Option 2

burnIntent

object

required

Show child attributes

burnIntent.maxBlockHeight

string

required

The maximum block height at which this burn is valid.

Example:

"1000000000000000000"

burnIntent.maxFee

string

required

The maximum fee the user is willing to pay.

Example:

"1000000000000000000"

burnIntent.spec

object

required

Show child attributes

burnIntent.spec.version

integer

required

Version of the transfer spec (uint32).

Required range: 0 <= x <= 4294967295

Example:

1

burnIntent.spec.sourceDomain

integer

required

The domain of the wallet contract this transfer came from (uint32).

Required range: 0 <= x <= 4294967295

Example:

0

burnIntent.spec.destinationDomain

integer

required

The domain of the minter contract this transfer is valid for (uint32).

Required range: 0 <= x <= 4294967295

Example:

4

burnIntent.spec.sourceContract

string

required

The address of the wallet contract on the source domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.destinationContract

string

required

The address of the minter contract on the destination domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.sourceToken

string

required

The token address on the source domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.destinationToken

string

required

The token address on the destination domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.sourceDepositor

string

required

The address to debit within the wallet contract on the source domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.destinationRecipient

string

required

The address that should receive the funds on the destination domain (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.sourceSigner

string

required

The signer who signed for the transfer (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.destinationCaller

string

required

The address of the caller who may use the attestation, 0 address if any caller (32-byte padded).

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.value

string

required

The amount to be transferred.

Example:

"1000000000000000000"

burnIntent.spec.salt

string

required

An arbitrary value chosen by the user to be unique.

Example:

"0x1234567890123456789012345678901234567890123456789012345678901234"

burnIntent.spec.hookData

string

Arbitrary bytes that may be used for onchain composition (optional).

Example:

"0x1a2b3c4d"

Get token balances for specified addresses

Get Gateway info for supported domains and tokens