chore: added a script for gas update limit

    Ticket: WIN-6723

Author: yogeshwar-bitgo

.github/workflows/update_transfer_gas_limit.yml

@@ -0,0 +1,48 @@
+name: Update Batcher transferGasLimit
+on:
+  workflow_dispatch:
+    inputs:
+      environment:
+        description: "Target environment"
+        required: true
+        type: choice
+        options:
+          - testnet
+          - mainnet
+      network:
+        description: "Hardhat network (e.g., tstt, stt)"
+        required: true
+        type: string
+      gas_limit:
+        description: "transferGasLimit to set (required)"
+        required: true
+        default: '300000'
+        type: string
+      batcher_address:
+        description: "Batcher contract address (required)"
+        required: true
+        default: ''
+        type: string
+
+jobs:
+  run-update:
+    runs-on: ubuntu-latest
+  environment: "${{ inputs.environment }}"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: 'npm'
+      - run: npm install
+      - name: Run update script
+        run: |
+          export BATCHER_ADDRESS="${{ inputs.batcher_address }}"
+          export TRANSFER_GAS_LIMIT="${{ inputs.gas_limit }}"
+          npm run update-gas-limit -- ${{ inputs.network }}
+        env:
+          MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+          TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+          PRIVATE_KEY_FOR_V4_CONTRACT_DEPLOYMENT: ${{ secrets.PRIVATE_KEY_FOR_V4_CONTRACT_DEPLOYMENT }}
+          PRIVATE_KEY_FOR_BATCHER_CONTRACT_DEPLOYMENT: ${{ secrets.PRIVATE_KEY_FOR_BATCHER_CONTRACT_DEPLOYMENT }}

README.md

@@ -107,15 +107,79 @@ Forwarder function. Initializes with a parent and a fee address. It will forward
 
 Factory to create updated forwarder (contracts/ForwarderV4.sol). Deploys a small proxy which utilizes the implementation of a single forwarder contract.
 
+## Batcher gas params and admin script
+
+Centralized defaults used when deploying a new Batcher:
+- Per-chain constructor defaults: `config/configGasParams.ts`
+
+Deploying Batcher (uses `config/configGasParams.ts` for constructor args):
+```sh
+npm run deploy-batcher -- --network <network>
+```
+
+Optional constructor override during deploy:
+- `TRANSFER_GAS_LIMIT` or `BATCHER_TRANSFER_GAS_LIMIT` to set a custom initial transferGasLimit.
+Notes:
+- On Somnia (testnet/mainnet), the deploy script automatically enforces a high gasLimit floor and sets robust fee params; no action needed.
+
+Updating transferGasLimit on an existing Batcher (env-only, simplified):
+- Required envs:
+  - `BATCHER_ADDRESS` — the deployed Batcher address
+  - `TRANSFER_GAS_LIMIT` — the new per-recipient gas stipend (number)
+- Behavior:
+  - Uses signers[0] for the selected Hardhat network.
+  - Verifies there is contract code at `BATCHER_ADDRESS` and that signers[0] is the on-chain owner; otherwise exits early.
+  - Gas params come from `scripts/chainConfig.ts` per chain; Somnia gets high gasLimit automatically.
+```sh
+BATCHER_ADDRESS=0xYourBatcher \
+TRANSFER_GAS_LIMIT=300000 \
+npm run update-gas-limit -- --network <network>
+```
+Ensure the first account in `networks.<name>.accounts` (Hardhat config) is the Batcher owner on that chain.
+
+### Testing tools: GasHeavy end-to-end retest
+
+Run the GasHeavy scenario tool (low limit fails, high limit succeeds):
+```sh
+BATCHER_ADDRESS=0xYourBatcherAddress \
+npx hardhat run test/tools/retestGasHeavy.ts --network tstt
+```
+
+Important:
+- The tool reads `BATCHER_ADDRESS` from the environment (Hardhat doesn’t forward unknown CLI flags).
+- Optional envs:
+  - `OWNER_PRIVATE_KEY=0x...` to perform owner-only updates inside the tool; if omitted, owner updates are skipped and the test proceeds with current limits.
+  - `GAS_HEAVY=0x...` to reuse a pre-deployed GasHeavy. On Somnia (50312/5031), the tool enforces a high gasLimit floor during deployment and will retry code detection; providing `GAS_HEAVY` skips deploy variance.
+  - `LOW_LIMIT=2300`, `HIGH_LIMIT=300000`, `AMOUNT_WEI=100000000000000` to tweak behavior.
+- Tools under `test/tools` are not part of the Mocha test run; execute them with `hardhat run` as shown.
+- To change transferGasLimit for real, use the admin script in the previous section.
+
+### GitHub Actions: update_transfer_gas_limit
+
+Trigger a transferGasLimit update via the workflow dispatch:
+
+1. In GitHub, run the workflow: Actions > "Update Batcher transferGasLimit" > Run workflow
+   - Inputs (required):
+     - `environment`: `testnet` or `mainnet`
+     - `network`: Hardhat network name (e.g., `tstt`, `stt`)
+     - `batcher_address`: the deployed Batcher address
+     - `gas_limit`: the new transferGasLimit value
+
+Behavior:
+- The workflow exports `BATCHER_ADDRESS` and `TRANSFER_GAS_LIMIT` for the script.
+- The script uses the first configured signer on that network; make sure that signer is the on-chain owner or the run will fail.
+     
+
+
 ## Installation
 
-NodeJS 16 is required.
+NodeJS 18+ is required.
 
 ```shell
-yarn
+npm install
 ```
 
-This installs hardhat.
+This installs dependencies including Hardhat.
 
 ## Wallet Solidity Contract
 

config/coinBatcherLimits.ts

@@ -0,0 +1,40 @@
+/*
+  Coin registry: coin -> chainId -> { batcher?, transferGasLimit? }.
+  Keep addresses as constants here (defaults). The admin script uses these unless overridden by:
+    - CLI flag: --batcher 0x...
+    - Env var: BATCHER_ADDRESS (e.g., set by the GitHub workflow per network)
+    - Legacy: BATCHER (env)
+  If unset everywhere, it will error and ask to add the address here.
+*/
+type Limits = Record<number, { batcher?: string; transferGasLimit?: number }>;
+import { CHAIN_IDS } from './chainIds';
+
+// Fill with deployed Batcher addresses.
+const SOMNIA_TESTNET_BATCHER: string | undefined =
+  '0xebe27913fcc7510eAdf10643A8F86Bf5492A9541';
+const SOMNIA_MAINNET_BATCHER: string | undefined =
+  '0x3E1e5d78e44f15593B3B61ED278f12C27F0fF33e';
+
+// Somnia (stt)
+const STT: Limits = {
+  [CHAIN_IDS.SOMNIA_TESTNET]: {
+    batcher: SOMNIA_TESTNET_BATCHER,
+    // Default stipend per recipient; set here to override per-coin/chain.
+    // Otherwise per-chain defaults come from configGasParams.
+    transferGasLimit: 300000
+  },
+  [CHAIN_IDS.SOMNIA]: {
+    batcher: SOMNIA_MAINNET_BATCHER,
+    transferGasLimit: 300000
+  }
+};
+
+const REGISTRY: Record<string, Limits> = {
+  stt: STT
+  // Add more coins here, e.g., 'eth': { ... }
+};
+
+export function getCoinLimits(coin: string): Limits {
+  // Case-insensitive lookup; returns {} when unknown (caller uses fallbacks).
+  return REGISTRY[coin.toLowerCase()] || {};
+}

config/configGasParams.ts

@@ -0,0 +1,31 @@
+import { CHAIN_IDS } from './chainIds';
+
+// Defaults; add overrides only when required by a chain.
+export type BatcherGasParams = {
+  transferGasLimit: number; // stipend per recipient for native transfers
+  erc20BatchLimit: number; // max recipients per ERC20 batch
+  nativeBatchTransferLimit: number; // max recipients per native batch
+};
+
+const DEFAULTS: BatcherGasParams = {
+  transferGasLimit: 300_000,
+  erc20BatchLimit: 256,
+  nativeBatchTransferLimit: 256
+};
+
+// Chain-specific overrides.
+const OVERRIDES: Partial<Record<number, Partial<BatcherGasParams>>> = {
+  // Somnia requires higher limits
+  [CHAIN_IDS.SOMNIA]: { transferGasLimit: 800_000 },
+  [CHAIN_IDS.SOMNIA_TESTNET]: { transferGasLimit: 800_000 }
+};
+
+export function getBatcherGasParams(chainId: number): BatcherGasParams {
+  const o = OVERRIDES[chainId] || {};
+  return {
+    transferGasLimit: o.transferGasLimit ?? DEFAULTS.transferGasLimit,
+    erc20BatchLimit: o.erc20BatchLimit ?? DEFAULTS.erc20BatchLimit,
+    nativeBatchTransferLimit:
+      o.nativeBatchTransferLimit ?? DEFAULTS.nativeBatchTransferLimit
+  };
+}

package.json

@@ -12,6 +12,7 @@
     "deploy-prod": "hardhat run scripts/deploy.ts --network",
     "deploy-test": "hardhat run scripts/deploy.ts --network",
     "deploy-batcher": "hardhat run scripts/deployBatcherContract.ts --network",
+    "update-gas-limit": "hardhat run scripts/updateTransferGasLimit.ts --network",
     "test": "hardhat test",
     "coverage": "hardhat coverage",
     "solhint": "./node_modules/.bin/solhint --fix 'contracts/**/*.sol'",