Migrator API

API for Migration calls.

To get the token balances of an address on a specific chain.

post

/migrator/balances

Header parameters

x-api-keystringrequired

Aarc API Key

Body

addressstring

The address for which the balances are to be fetched

Example: 0x98150396C356C55a848B2baBA6aC7614615a595b

chainIdstring

The chain id for which the balances are to be fetched

Example: 1

onlyBalancesboolean

If true, only the balances are returned else additional information is also returned

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://migrator.aarc.xyz/migrator/balances' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "0x98150396C356C55a848B2baBA6aC7614615a595b",
    "chainId": "1",
    "onlyBalances": false
  }'

200

200

{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "decimals": 6,
      "native_token": false,
      "name": "Tether USD",
      "symbol": "USDT",
      "token_address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
      "balance": "1000000000000000000",
      "type": "stablecoin",
      "nft_data": "text",
      "permit2Allowance": "0",
      "isGasless": false,
      "permitExist": false
    }
  ]
}

Successful Response

Forward Transactions (pay with Stables)

Generate calldata

To generate the forward calldata for migration.

post

/migrate/forward-calldata

Header parameters

x-api-keystringrequired

Aarc API Key

Body

chainIdstring

The chain id for which the forward calldata is to be generated

Example: 137

ownerstring

The owner of the tokens

Example: 0x98150396C356C55a848B2baBA6aC7614615a595b

receiverAddressstring

The receiver address for the tokens

Example: 0x98150396C356C55a848B2baBA6aC7614615a595b

tokenListobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://migrator.aarc.xyz/migrate/forward-calldata' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "chainId": "137",
    "owner": "0x98150396C356C55a848B2baBA6aC7614615a595b",
    "receiverAddress": "0x98150396C356C55a848B2baBA6aC7614615a595b",
    "tokenList": [
      {
        "tokenAddress": "0xc8c53856eb36a55b92f4b005672443ecf945fbda",
        "amount": "10000000000"
      }
    ]
  }'

200

200

{
  "code": 200,
  "message": "Success",
  "data": {
    "txIndexes": [
      1
    ],
    "forwardCallDataResponse": [
      {
        "target": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
        "data": "{\"permitBatchTransferFrom\":{\"permitted\":[{\"token\":\"0xc8c53856eb36a55b92f4b005672443ecf945fbda\",\"amount\":\"49997809030\"},{\"token\":\"0xc8c53856eb36a55b92f4b005672443ecf945fbda\",\"amount\":\"2190970\"}],\"spender\":\"0x75ba5af8effdcfca32e1e288806d54277d1fde99\",\"deadline\":1707830776,\"nonce\":4564},\"tokenPermissions\":[{\"to\":\"0x786e6045eacb96cae0259cd761e151b68b85bda7\",\"requestedAmount\":\"49997809030\"},{\"to\":\"0xfa59d56b4bb6bdbd28883eef1b7bdf504a124f64\",\"requestedAmount\":\"2190970\"}],\"owner\":\"0x4186cac380734d5da981d702a4bfffb41bc626a6\"}",
        "txType": "PERMIT2_BATCH",
        "amount": "0",
        "message": "Permit Batch",
        "tokenAddress": [
          "0xc8c53856eb36a55b92f4b005672443ecf945fbda",
          "0xc8c53856eb36a55b92f4b005672443ecf945fbda"
        ],
        "tokenInfo": [
          {
            "tokenAddress": "0xc8c53856eb36a55b92f4b005672443ecf945fbda",
            "amount": "49997809030"
          },
          {
            "tokenAddress": "0xc8c53856eb36a55b92f4b005672443ecf945fbda",
            "amount": "2190970"
          }
        ],
        "eip712Struct": {
          "domain": {
            "name": "Permit2",
            "chainId": 137,
            "verifyingContract": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
          },
          "types": {
            "PermitBatchTransferFrom": [
              {
                "name": "permitted",
                "type": "TokenPermissions[]"
              },
              {
                "name": "spender",
                "type": "address"
              },
              {
                "name": "nonce",
                "type": "uint256"
              },
              {
                "name": "deadline",
                "type": "uint256"
              }
            ],
            "TokenPermissions": [
              {
                "name": "token",
                "type": "address"
              },
              {
                "name": "amount",
                "type": "uint256"
              }
            ]
          },
          "value": {
            "spender": "0x75ba5af8effdcfca32e1e288806d54277d1fde99",
            "deadline": 1707830776,
            "nonce": 4564,
            "permitted": [
              {
                "token": "0xc8c53856eb36a55b92f4b005672443ecf945fbda",
                "amount": "49997809030"
              },
              {
                "token": "0xc8c53856eb36a55b92f4b005672443ecf945fbda",
                "amount": "2190970"
              }
            ]
          }
        }
      },
      {
        "target": "",
        "data": "",
        "txType": "ERC20_TRANSFER",
        "amount": "0x0110d9316ec000",
        "message": "Token not supported for forward",
        "tokenAddress": [
          "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7"
        ]
      }
    ]
  }
}

Successful Response

Execute calldata

After receiving the calldata from the /migrate/forward-calldata, it needs to be signed by the signer for different approvals.

To do that, you will need to get each item in the forwardCallDataReponse signed by the signer and then passed as trxList and the txnIndexes with it. Learn how to do this here.

To execute the forward calldata for migration.

post

/migrate/forward-calldata-trx

Header parameters

x-api-keystringrequired

Aarc API Key

Body

chainIdstringrequired

trxListobject[]required

txIndexesinteger[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://migrator.aarc.xyz/migrate/forward-calldata-trx' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "chainId": "137",
    "txIndexes": [
      1
    ],
    "trxList": [
      {
        "target": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
        "data": "{\"permitBatchTransferFrom\":{\"permitted\":[{\"token\":\"0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7\",\"amount\":\"300000000000000\"},{\"token\":\"0xc8c53856eb36a55b92f4b005672443ecf945fbda\",\"amount\":\"50000000000\"}],\"spender\":\"0x75ba5af8effdcfca32e1e288806d54277d1fde99\",\"deadline\":1707235435,\"nonce\":4042},\"tokenPermissions\":[{\"to\":\"0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7\",\"requestedAmount\":\"300000000000000\"},{\"to\":\"0xc8c53856eb36a55b92f4b005672443ecf945fbda\",\"requestedAmount\":\"50000000000\"}],\"owner\":\"0x4186cac380734d5da981d702a4bfffb41bc626a6\",\"signature\":\"0xca733fd70e5c2d1b221a424866dbaf791a390b0b207702906529d8cb85b40c0c64956ea593a5aa807f60df675658f03371ecf812beee997ae0bc417368679aef1c\"}",
        "txType": "PERMIT2_BATCH",
        "amount": "0",
        "message": "Permit Batch",
        "tokenAddress": [
          "0x0000000000000000000000000000000000001010"
        ],
        "eip712Struct": {
          "domain": {
            "name": "Permit2",
            "chainId": 137,
            "verifyingContract": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
          },
          "types": {
            "PermitBatchTransferFrom": [
              {
                "name": "permitted",
                "type": "TokenPermissions[]"
              },
              {
                "name": "spender",
                "type": "address"
              },
              {
                "name": "nonce",
                "type": "uint256"
              },
              {
                "name": "deadline",
                "type": "uint256"
              }
            ],
            "TokenPermissions": [
              {
                "name": "token",
                "type": "address"
              },
              {
                "name": "amount",
                "type": "uint256"
              }
            ]
          },
          "value": {
            "spender": "0x75ba5af8effdcfca32e1e288806d54277d1fde99",
            "deadline": 1707235435,
            "nonce": 4042,
            "permitted": [
              {
                "token": "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7",
                "amount": "300000000000000"
              },
              {
                "token": "0xc8c53856eb36a55b92f4b005672443ecf945fbda",
                "amount": "50000000000"
              }
            ]
          }
        }
      }
    ]
  }'

200

200

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "type": "PERMIT2_BATCH",
      "taskId": "1b9a02f4-ffbb-46be-8a5b-9475d412d2ab",
      "status": "Transaction Added to Queue"
    }
  ]
}

Successful Response

Gasless Transactions (pay NO Gas)

Generate calldata

To generate the gasless calldata for migration.

post

/migrate/gasless-calldata

Header parameters

x-api-keystringrequired

Aarc API Key

Body

chainIdstring

ownerstring

receiverAddressstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://migrator.aarc.xyz/migrate/gasless-calldata' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "chainId": "137",
    "owner": "0x4186CaC380734D5dA981D702a4bFfFB41Bc626a6",
    "receiverAddress": "0x786E6045eacb96cAe0259cd761e151b68B85bdA7"
  }'

200

200

{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "tokenAddress": "0x0000000000000000000000000000000000001010",
      "data": "",
      "amount": "9922946298484695970",
      "txType": "NATIVE_TRANSFER",
      "message": "Native token transfer"
    },
    {
      "data": "{\"permitBatchTransferFrom\":{\"permitted\":[{\"token\":\"0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7\",\"amount\":\"6999999999999999999999999999999999999999999999999999999998500000000000000\"},{\"token\":\"0x5191950f9f0b364137d945e55e0d90bec88be48f\",\"amount\":\"6000000000000000000000000000000000000000000000000000000000000000000000000\"}],\"spender\":\"0x75ba5af8effdcfca32e1e288806d54277d1fde99\",\"deadline\":1707736657,\"nonce\":3066}",
      "txType": "PERMIT2_BATCH",
      "amount": "0",
      "message": "Permit Batch",
      "tokenAddress": [
        "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7",
        "0x5191950f9f0b364137d945e55e0d90bec88be48f",
        "0xb6d4b00f579513086be28d835293ddb74e0aabec",
        "0xc8c53856eb36a55b92f4b005672443ecf945fbda"
      ],
      "domain": {
        "name": "Permit2",
        "chainId": 137,
        "verifyingContract": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
      },
      "tokenInfo": [
        {
          "tokenAddress": "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7",
          "amount": "6999999999999999999999999999999999999999999999999999999998500000000000000"
        }
      ],
      "types": {
        "PermitBatchTransferFrom": [
          {
            "name": "permitted",
            "type": "TokenPermissions[]"
          },
          {
            "name": "spender",
            "type": "address"
          },
          {
            "name": "nonce",
            "type": "uint256"
          },
          {
            "name": "deadline",
            "type": "uint256"
          }
        ]
      },
      "value": {
        "permitted": [
          {
            "token": "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7",
            "amount": "6999999999999999999999999999999999999999999999999999999998500000000000000"
          },
          {
            "token": "0x5191950f9f0b364137d945e55e0d90bec88be48f",
            "amount": "6000000000000000000000000000000000000000000000000000000000000000000000000"
          }
        ]
      }
    }
  ]
}

Successful Response

Execute calldata

After receiving the calldata from the /migrate/gasless-calldata, it needs to be signed by the signer for different approvals.

To do that, you will need to get each item in the forwardCallDataReponse signed by the signer and then passed as trxList and the txnIndexes with it. Learn how to do this here.

To execute the gasless calldata for migration.

post

/migrate/gasless-calldata-trx

Header parameters

x-api-keystringrequired

Aarc API Key

Body

chainIdstringrequired

trxListobject[]required

txIndexesinteger[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://migrator.aarc.xyz/migrate/gasless-calldata-trx' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "chainId": "137",
    "txIndexes": [
      1
    ],
    "trxList": [
      {
        "target": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
        "data": "{\"permitBatchTransferFrom\":{\"permitted\":[{\"token\":\"0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7\",\"amount\":\"300000000000000\"},{\"token\":\"0xc8c53856eb36a55b92f4b005672443ecf945fbda\",\"amount\":\"50000000000\"}],\"spender\":\"0x75ba5af8effdcfca32e1e288806d54277d1fde99\",\"deadline\":1707235435,\"nonce\":4042},\"tokenPermissions\":[{\"to\":\"0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7\",\"requestedAmount\":\"300000000000000\"},{\"to\":\"0xc8c53856eb36a55b92f4b005672443ecf945fbda\",\"requestedAmount\":\"50000000000\"}],\"owner\":\"0x4186cac380734d5da981d702a4bfffb41bc626a6\",\"signature\":\"0xca733fd70e5c2d1b221a424866dbaf791a390b0b207702906529d8cb85b40c0c64956ea593a5aa807f60df675658f03371ecf812beee997ae0bc417368679aef1c\"}",
        "txType": "PERMIT2_BATCH",
        "amount": "0",
        "message": "Permit Batch",
        "tokenAddress": [
          "0x0000000000000000000000000000000000001010"
        ],
        "eip712Struct": {
          "domain": {
            "name": "Permit2",
            "chainId": 137,
            "verifyingContract": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
          },
          "types": {
            "PermitBatchTransferFrom": [
              {
                "name": "permitted",
                "type": "TokenPermissions[]"
              },
              {
                "name": "spender",
                "type": "address"
              },
              {
                "name": "nonce",
                "type": "uint256"
              },
              {
                "name": "deadline",
                "type": "uint256"
              }
            ],
            "TokenPermissions": [
              {
                "name": "token",
                "type": "address"
              },
              {
                "name": "amount",
                "type": "uint256"
              }
            ]
          },
          "value": {
            "spender": "0x75ba5af8effdcfca32e1e288806d54277d1fde99",
            "deadline": 1707235435,
            "nonce": 4042,
            "permitted": [
              {
                "token": "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7",
                "amount": "300000000000000"
              },
              {
                "token": "0xc8c53856eb36a55b92f4b005672443ecf945fbda",
                "amount": "50000000000"
              }
            ]
          }
        }
      }
    ]
  }'

200

200

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "type": "PERMIT2_BATCH",
      "taskId": "1b9a02f4-ffbb-46be-8a5b-9475d412d2ab",
      "status": "Transaction Added to Queue"
    }
  ]
}

Successful Response

Non-gasless Transactions (pay Gas)

To generate the non-gasless calldata for migration.

post

/migrate/non-gasless-calldata

Header parameters

x-api-keystringrequired

Aarc API Key

Body

chainIdstring

ownerstring

receiverAddressstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://migrator.aarc.xyz/migrate/non-gasless-calldata' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "chainId": "137",
    "owner": "0x4186CaC380734D5dA981D702a4bFfFB41Bc626a6",
    "receiverAddress": "0x786E6045eacb96cAe0259cd761e151b68B85bdA7"
  }'

200

200

{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "tokenAddress": "0x0000000000000000000000000000000000001010",
      "data": "",
      "amount": "9922946298484695970",
      "txType": "NATIVE_TRANSFER",
      "message": "Native token transfer"
    },
    {
      "data": "{\"permitBatchTransferFrom\":{\"permitted\":[{\"token\":\"0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7\",\"amount\":\"6999999999999999999999999999999999999999999999999999999998500000000000000\"},{\"token\":\"0x5191950f9f0b364137d945e55e0d90bec88be48f\",\"amount\":\"6000000000000000000000000000000000000000000000000000000000000000000000000\"}],\"spender\":\"0x75ba5af8effdcfca32e1e288806d54277d1fde99\",\"deadline\":1707736657,\"nonce\":3066}",
      "txType": "PERMIT2_BATCH",
      "amount": "0",
      "message": "Permit Batch",
      "tokenAddress": [
        "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7",
        "0x5191950f9f0b364137d945e55e0d90bec88be48f",
        "0xb6d4b00f579513086be28d835293ddb74e0aabec",
        "0xc8c53856eb36a55b92f4b005672443ecf945fbda"
      ],
      "domain": {
        "name": "Permit2",
        "chainId": 137,
        "verifyingContract": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
      },
      "tokenInfo": [
        {
          "tokenAddress": "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7",
          "amount": "6999999999999999999999999999999999999999999999999999999998500000000000000"
        }
      ],
      "types": {
        "PermitBatchTransferFrom": [
          {
            "name": "permitted",
            "type": "TokenPermissions[]"
          },
          {
            "name": "spender",
            "type": "address"
          },
          {
            "name": "nonce",
            "type": "uint256"
          },
          {
            "name": "deadline",
            "type": "uint256"
          }
        ]
      },
      "value": {
        "permitted": [
          {
            "token": "0x0537a0f2e1373886a3d4f0e2b24c026ffa6f16f7",
            "amount": "6999999999999999999999999999999999999999999999999999999998500000000000000"
          },
          {
            "token": "0x5191950f9f0b364137d945e55e0d90bec88be48f",
            "amount": "6000000000000000000000000000000000000000000000000000000000000000000000000"
          }
        ]
      }
    }
  ]
}

Successful Response