aggregate

docs/docs/03-sdk/04-methods-reference/_how-to-gas-limit.md

@@ -6,7 +6,7 @@ import TabItem from '@theme/TabItem';
 The following examples demonstrate how to estimate the `gasLimit` parameter required for interacting with a staking smart contract. We provide examples using different web3 libraries: Web3JS, Viem, and Ethers. 
 
 :::note
-To ensure that the transaction has enough gas, we recommend using the estimated gas limit from the provider, adding 25% as a buffer, and then adding an additional 200,000 units for fail-safe calculations. This ensures the transaction won’t run out of gas, even for complex contract interactions.
+To ensure that the transaction has enough gas, we recommend using the estimated gas limit from the provider, adding 25% as a buffer, and then adding an additional 100,000 units for fail-safe calculations. This ensures the transaction won’t run out of gas, even for complex contract interactions.
 :::
 
 <details>
@@ -105,7 +105,7 @@ To ensure that the transaction has enough gas, we recommend using the estimated
 
     async function estimateGas() {
       const estimatedGas = await stakingContract.methods.stake(100).estimateGas({ from: account });
-      const gasLimit = Math.floor(estimatedGas * 1.25) + 200000; // Add 25% and 200k for safety
+      const gasLimit = Math.floor(estimatedGas * 1.25) + 100000; // Add 25% and 100k for safety
       console.log('Estimated Gas Limit:', gasLimit);
     }
 

docs/docs/03-sdk/04-methods-reference/bridge-aggregate/bridgeAggregateBalanceAndCall.md

@@ -18,7 +18,13 @@ This behavior is generally fine for operations like staking or liquidity deposit
 
 ## Usage
 
-### Example: Token Transfer with Contract Call and `transferFrom` Approval
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="call-type" queryString>
+  <TabItem value="token" label="Token Transfer with Contract Call">
+
+In this example, a token transfer (e.g., `USDC`) is aggregated from multiple source chains, followed by a contract call on the destination chain. You need to provide `outputTokenAddress` and `approvalAddress` to allow the contract to move tokens on behalf of the user.
 
 ```typescript
 import { Sprinter } from '@chainsafe/sprinter-sdk';
@@ -39,15 +45,19 @@ const settings = {
     outputTokenAddress: '0xOutputTokenAddressHere',  // Where tokens will be sent
     approvalAddress: '0xApprovalAddressHere'  // Contract that needs approval to transfer tokens
   },
+  recipient: '0xRecipientAddress',  // Optional recipient of leftover tokens
   sourceChains: [84532, 1993],  // Optional: List of source chains to be considered
 };
 
 sprinter.bridgeAggregateBalanceAndCall(settings).then(solution => {
   console.log(solution);
 });
 ```
+  </TabItem>
 
-### Example: Native Token Transfer with Contract Call
+  <TabItem value="native" label="Native Token Transfer with Contract Call">
+
+In this example, a native token (e.g., `ETH`) is aggregated from multiple source chains, followed by a contract call on the destination chain.
 
 ```typescript
 const settings = {
@@ -59,15 +69,26 @@ const settings = {
     contractAddress: '0xContractAddressHere',
     callData: '0xSomeCallData',  // Encoded contract interaction data
     gasLimit: 21000,  // Standard gas limit for ETH transfers
-    recipient: '0xRecipientAddressHere'  // The recipient of the native token transfer
   },
+  recipient: '0xRecipientAddressHere',  // The recipient of the native token transfer
   sourceChains: [84532, 1993]  // Optional: List of source chains to be considered
 };
 
 sprinter.bridgeAggregateBalanceAndCall(settings).then(solution => {
   console.log(solution);
 });
 ```
+  </TabItem>
+</Tabs>
+
+:::note
+You can limit the solution to a specific source chain using the `sourceChains` field. For example, to use only `BaseSepolia` (chain ID `84532`) and another chain, provide it as an array like this:
+
+```typescript
+sourceChains: [84532, 1993];
+```
+If omitted, Sprinter will consider all available source chains.
+:::
 
 ### Example: Using `fetchOptions`
 
@@ -89,22 +110,27 @@ sprinter.bridgeAggregateBalanceAndCall(settings, { baseUrl: 'https://custom.api.
             - `contractAddress`: The contract address on the destination chain.
             - `callData`: The data to interact with the contract, in hex format.
             - `gasLimit`: The maximum amount of gas to use for the contract call.
-            - `recipient`: The recipient address for the native asset transfer.
         - **Token Contract Call**:
             - `contractAddress`: The contract address on the destination chain.
             - `callData`: The data to interact with the contract, in hex format.
             - `gasLimit`: The maximum amount of gas to use for the contract call.
             - `outputTokenAddress?`: *(Optional)* The token address where tokens will be sent after the contract call.
             - `approvalAddress?`: *(Optional)* The contract address that requires approval to transfer tokens (e.g., for `transferFrom`).
+    - `recipient?`: *(Optional)* The address of the recipient of any leftover tokens.
     - `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.
 
 import HowToCallData from "../_how-to-calldata.md"
 
 <HowToCallData />
 
+import GasLimit from "../_how-to-gas-limit.md"
+
+<GasLimit />
+
+<hr />
+
 ## Response
 
 Returns a promise that resolves to a `SolutionResponse`.
@@ -138,6 +164,9 @@ import GasTip from "../_gas-tip.md"
 
 <GasTip />
 
+<Tabs groupId="response-type" queryString>
+  <TabItem value="token" label="Token Transfer with Contract Call Response">
+
 ```json
 [
   {
@@ -161,7 +190,9 @@ import GasTip from "../_gas-tip.md"
     "amount": "100000000",
     "duration": 60000000000,
     "transaction": {
-      "data": "0x73c45c98000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000012000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000540000000000000000000000000000000000000000000000000000000005f5e10000000000000000000000000000000000000000000000000000000000000000143e101ec02e7a48d16dade204c96bff842e7e251900000000000000000000000000000000000000000000000000000000000000000000000000000000000000023078000000000000000000000000000000000000000000000000000000000000",
+      "data": "0x73c45c98000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000012000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000540000000000000000000000000000000000000000000000000000000005f5e10000000000000000000000000000000000000000000000000000000000000000143e101ec02e7a48d16dade204c96bff842e7e251900000000000000000000000000000000000000000000000000000000000000000000000000000000000000023078000000000
+
+000000000000000000000000000000000000000000000000000",
       "to": "0x9D5C332Ebe0DaE36e07a4eD552Ad4d8c5067A61F",
       "from": "0x3E101Ec02e7A48D16DADE204C96bFF842E7E2519",
       "value": "0x38d7ea4c68000",
@@ -180,12 +211,53 @@ import GasTip from "../_gas-tip.md"
         "chainId": 84532
       }
     ]
-
+  }
+]
+```
 
- }
+  </TabItem>
+
+  <TabItem value="native" label="Native Token Transfer with Contract Call Response">
+
+```json
+[
+  {
+    "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": null
+  }
 ]
 ```
 
+</TabItem>
+</Tabs>
+
 ---
 
 For more details on other methods, check out the [Methods Reference](./methods-reference.md).