bridgeAggregateBalance

The bridgeAggregateBalance method generates a solution for aggregating fungible token balances across multiple source chains and transferring them to a specified destination chain. This method calculates the best combination of single-hop transfers from available source chains.

Usage

import { Sprinter } from '@chainsafe/sprinter-sdk';

const sprinter = new Sprinter({
  baseUrl: 'https://api.test.sprinter.buildwithsygma.com',  // Testnet URL
});

const settings = {
  account: '0xYourAddressHere',
  destinationChain: 11155111,  // Sepolia testnet
  token: 'USDC',
  amount: 1000000,  // Targeted balance on the destination chain, in the smallest denomination
  sourceChains: [84532, 1993],  // Optional: List of source chains to be considered
};

sprinter.bridgeAggregateBalance(settings).then(solution => {
  console.log(solution);
});

Parameters

• settings: (Required) An object containing the following fields:

  • account: The user’s address.
  • destinationChain: The ID of the destination chain.
  • token: The symbol of the token to be aggregated and transferred (e.g., USDC, ETH).
  • amount: The target amount of the token on the destination chain, in the smallest denomination (e.g., for USDC with 6 decimals, 1 USDC = 1,000,000).
  • sourceChains?: (Optional) An array of source chain IDs to be considered for aggregation. If omitted, Sprinter will use all available source chains.
  • threshold?: (Optional) The minimum amount of the token to leave on the source chain, in the smallest denomination (useful for avoiding emptying the source chain completely).

• fetchOptions?: (Optional) An object containing baseUrl to override the default API endpoint for this request.

Example: Aggregating from Multiple Chains

In this example, balances from multiple source chains (e.g., BaseSepolia and B3Sepolia) are aggregated to the destination chain (Sepolia).

const settings = {
  account: '0xYourAddressHere',
  destinationChain: 11155111,  // Sepolia testnet
  token: 'USDC',
  amount: 1000000,  // Target balance on destination chain
  sourceChains: [84532, 1993]  // BaseSepolia and B3Sepolia as source chains
};

sprinter.bridgeAggregateBalance(settings).then(solution => {
  console.log(solution);
});

Example: Using fetchOptions

sprinter.bridgeAggregateBalance(settings, { baseUrl: 'https://custom.api.url' }).then(solution => {
  console.log(solution);
});

Response

Returns a promise that resolves to a SolutionResponse.

type SolutionResponse = Array<Solution> | FailedSolution;

interface Solution {
  destinationChain: number;
  destinationTokenAddress: string;
  duration: number;  // Time estimate in seconds
  fee: Amount;
  gasCost: Amount;
  senderAddress: string;
  sourceChain: number;
  sourceTokenAddress: string;
  amount: string;
  tool: Tool;
  transaction: Transaction;
  approvals?: Array<Transaction>;
}

interface FailedSolution {
  error: string;
}

Example Response

Gas Estimation Tip

For better accuracy when dealing with contract calls and transactions, it’s recommended to estimate the gasPrice and gasLimit using your own blockchain provider. This ensures that the values reflect the current network conditions and avoid overpaying or underestimating gas fees.

[
  {
    "sourceChain": 84532,
    "destinationChain": 11155111,
    "sourceTokenAddress": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
    "destinationTokenAddress": "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238",
    "senderAddress": "0x3e101ec02e7a48d16dade204c96bff842e7e2519",
    "tool": {
      "name": "Sygma-Testnet",
      "logoURI": "https://scan.buildwithsygma.com/assets/images/logo1.svg"
    },
    "gasCost": {
      "amount": "221055913000",
      "amountUSD": 0
    },
    "fee": {
      "amount": "1000000000000000",
      "amountUSD": 0
    },
    "amount": "100000000",
    "duration": 60000000000,
    "transaction": {
      "data": "0x73c45c98000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000012000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000540000000000000000000000000000000000000000000000000000000005f5e10000000000000000000000000000000000000000000000000000000000000000143e101ec02e7a48d16dade204c96bff842e7e251900000000000000000000000000000000000000000000000000000000000000000000000000000000000000023078000000000000000000000000000000000000000000000000000000000000",
      "to": "0x9D5C332Ebe0DaE36e07a4eD552Ad4d8c5067A61F",
      "from": "0x3E101Ec02e7A48D16DADE204C96bFF842E7E2519",
      "value": "0x38d7ea4c68000",
      "gasPrice": "0xf433d",
      "gasLimit": "0x35f48",
      "chainId": 84532
    },
    "approvals": [
      {
        "data": "0x095ea7b30000000000000000000000003b0f996c474c91de56617da13a52b22bb659d18e0000000000000000000000000000000000000000000000000000000005f5e100",
        "to": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
        "from": "0x3E101Ec02e7A48D16DADE204C96bFF842E7E2519",
        "value": "0x0",
        "gasPrice": "0xf433d",
        "gasLimit": "0xe484",
        "chainId": 84532
      }
    ]
  }
]

---

For more details on other methods, check out the Methods Reference.