Add withdrawals collector script

Author: remollemo

.github/workflows/run-ticker-script.yml

@@ -0,0 +1,32 @@
+name: Run Collect Withdrawals Script
+
+on:
+  schedule:
+    # Every 15 minutes (UTC)
+    - cron: "*/15 * * * *"
+  workflow_dispatch:  # allow manual trigger from Actions tab
+
+jobs:
+  run-script:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run Collect Withdrawals Script
+        env:
+          PK: ${{ secrets.MN_COLLECTOR_PK }}
+          INFURA_KEY: ${{ secrets.INFURA_KEY }}
+        run: python scripts/ticker.py
+

requirements.txt

@@ -7,3 +7,4 @@ requests
 pathlib
 pytest-xdist
 git+https://github.com/starkware-libs/starkware-starknet-utils.git@main#egg=test_utils&subdirectory=python
+web3==5.31.3

scripts/tikcer.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python3.9
+
+import os
+import argparse
+from web3 import Web3, Account, HTTPProvider, eth
+from web3.middleware import (
+    buffered_gas_estimate_middleware,
+    construct_sign_and_send_raw_middleware,
+)
+
+node_uri_pat = "https://{chain}.infura.io/v3/{infura_key}"
+batcher_abi = [
+    {
+        "inputs": [],
+        "name": "tick",
+        "outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
+        "stateMutability": "nonpayable",
+        "type": "function",
+    }
+]
+
+default_batcher_address = "0x613d088F2e5a2ED91635016483dAFa3cd47a8964"
+
+
+def new_wallet_account(w3: Web3, eth_private_key):
+    return new_wallet_account_list(w3, [eth_private_key])[0]
+
+
+def new_wallet_account_list(w3: Web3, eth_private_keys, name=None):
+    """
+    Creates new eth accounts and registers them (including the private keys).
+    The new accounts may have no funds.
+    This function is more efficient than calling new_wallet_account() many times
+    as it creates only one middleware layer.
+    """
+    accounts = [Account.from_key(eth_private_key) for eth_private_key in eth_private_keys]
+
+    w3.middleware_onion.add(construct_sign_and_send_raw_middleware(accounts), name=name)
+    w3.middleware_onion.remove("gas_estimate")
+    w3.middleware_onion.add(buffered_gas_estimate_middleware, name="gas_estimate")
+    return [account.address for account in accounts]
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        description="Collect pending withdrawals waiting for l1_recipient"
+    )
+    parser.add_argument(
+        "--chain",
+        type=str,
+        choices=["mainnet", "sepolia"],
+        default="mainnet",
+        help="Select Ethereum chain (default: mainnet)",
+    )
+    parser.add_argument(
+        "--batcher_contract",
+        type=str,
+        default=default_batcher_address,
+        help="L1 withdrawal batching contract",
+    )
+    args = parser.parse_args()
+    args.batcher_contract = Web3.toChecksumAddress(args.batcher_contract)
+    return args
+
+
+def main():
+    args = parse_args()
+    account = Account.from_key(os.environ["PK"])
+    node_uri = node_uri_pat.format(chain=args.chain, infura_key=os.environ["INFURA_KEY"])
+    w3 = Web3(HTTPProvider(node_uri))
+
+    assert w3.isConnected()
+    w3.eth.default_account = new_wallet_account(w3, account.key)
+    batcher = w3.eth.contract(address=args.batcher_contract, abi=batcher_abi)
+    print(w3.eth.default_account, batcher.address)
+
+    pending_funds = batcher.functions.tick().call()
+    if pending_funds:
+        print(f"Awaiting {pending_funds//10**6} withdrawal waiting.")
+        th = batcher.functions.tick().transact()
+        print(f"Pending withdrawal collected, tx hash: {th.hex()}")
+    else:
+        print("nothing to tick")
+
+
+if __name__ == "__main__":
+    main()