API Reference

Get full TransferSpec by transferSpecHash

gethttps://gateway-api-testnet.circle.com/v1/transferSpec/{transferSpecHash}

Reference
Playground

Retrieve the full TransferSpec for a given transferSpecHash.

Path parameters

transferSpecHash

string

Required

The keccak256 hash of the TransferSpec

Response

200

Response Body

object

version

integer

Required

Version of the transfer spec (uint32).

sourceDomain

integer

Required

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

destinationDomain

integer

Required

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

sourceContract

string

Required

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

destinationContract

string

Required

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

sourceToken

string

Required

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

destinationToken

string

Required

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

sourceDepositor

string

Required

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

destinationRecipient

string

Required

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

sourceSigner

string

Required

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

destinationCaller

string

Required

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

value

string

Required

The amount to be transferred.

salt

string

Required

The salt value used in the transfer spec.

hookData

string

Required

Additional hook data for the transfer spec.

RequestChoose a language

ResponseChoose an example

1{
2  "version": 1,
3  "sourceDomain": 0,
4  "destinationDomain": 4,
5  "sourceContract": "0x000000000000000000000000557777735b1dd18194f1b84256be2a3cdee6cb6f",
6  "destinationContract": "0x000000000000000000000000552222279206cb0434128e0cae4558a25779c79f",
7  "sourceToken": "0x0000000000000000000000001c7d4b196cb0c7b01d743fbc6116a902379c7238",
8  "destinationToken": "0x000000000000000000000000036cbd53842c5426634e7929541ec2318f3dcf7e",
9  "sourceDepositor": "0x0000000000000000000000002b45eF6A547A73eA248A1bCED808575c5a4839eE",
10  "destinationRecipient": "0x0000000000000000000000008BA1f109551bD432803012645Hac136c95e5431",
11  "sourceSigner": "0x000000000000000000000000742d35Cc6623C026c893b7c2FD85c4E4A0EF4321",
12  "destinationCaller": "0x0000000000000000000000000000000000000000000000000000000000000000",
13  "value": "1000000",
14  "salt": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
15  "hookData": "0x"
16}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy