Gearbox Permissionless scripts

Environment Variables

Ensure the following environment variables are properly configured:

• RPC_URL – RPC URL
• ANVIL_URL – Testnet RPC URL for txs simulations and batching
• ADDRESS_PROVIDER – Address of the "Address Provider" contract
  • The address for the Mainnet Address Provider:

    0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38

• PRIVATE_KEY – Private key
• PINATA_JWT – Pinata JWT token for IPFS upload
• PINATA_GATEWAY – Pinata gateway URL

Scripts arguments

Ensure the following environment variables are properly configured:

• -r, --rpc-url Mainnet RPC URL. If not provided, the script assumes you're using a testnet.
  Env var: RPC_URL

• --anvil-url (mandatory)
  RPC URL for testnet simulations and batching.
  Env var: ANVIL_URL

• -p, --address-provider>
  Address of the AddressProvider contract.
  Env var: ADDRESS_PROVIDER

• -k, --private-key
  Private key for mainnet transactions.
  Env var: PRIVATE_KEY

• -a, --account
  Testnet account address. Defaults to the InstanceManager owner if not provided.

• -o, --out-dir
  Directory path to save output results.
  Env var: OUTPUT_DIR

• --testnet
  Flag to indicate usage of a testnet.

• --execute
  Actually execute the prepared transactions.

• --force
  Force transaction execution, ignoring safety checks.

• --timelock
  Wrap transactions using queueTransaction (timelock logic).

• -s, --skip-batching
  Skip batching transactions. Useful to debug Anvil issues.
  Default: false

• -c, --config
  Path to the configuration file.
  Default: undefined

• -e, --eta (mandatory for --timelock)
  ETA timestamp for queued transactions.
  Default: undefined

• -m, --market-configurator(mandatory for --timelock)
  Address of the MarketConfigurator contract.

• -u, --upload Upload transactions to ipfs

Scripts Information

• Update price feeds

  pnpm start update-feeds

  Update price feeds.

• Batch txs

  pnpm start batch-txs -t "path/to/txs"

  Simaulte and convert RawTxs from json to Safe Bathces.

• Execute batches

  pnpm start execute-batches

  Create execute txs for queued batches

Router Deployment and Setup

To deploy and configure the Router, follow these steps.

Configuration file: src/commands/configs/routerConfig.ts

Prerequisites

0. Configure router for your network Edit src/commands/configs/routerConfig.ts and add/update the configuration for your chain ID with the required workers.

1. Start Anvil fork

   anvil --fork-url <YOUR_RPC_URL>

2. Configure environment variables Ensure all variables from .env.example are set:

   • RPC_URL – RPC URL
   • ANVIL_URL – Testnet RPC URL for simulations (e.g., http://127.0.0.1:8545)
   • ADDRESS_PROVIDER – Address of the AddressProvider contract
   • PRIVATE_KEY – Private key for transactions
   • PINATA_JWT – Pinata JWT token for IPFS upload
   • PINATA_GATEWAY – Pinata gateway URL

Deploy Router

pnpm start deploy-router --execute

Restart Anvil

After deployment, restart the Anvil fork before running setup:

# Stop current Anvil instance (Ctrl+C) and start again
anvil --fork-url <YOUR_RPC_URL>

Setup Router

pnpm start setup-router --testnet --execute --upload

Withdrawal Compressor Deployment and Setup

To deploy and configure the Withdrawal Compressor, follow these steps.

Configuration file: src/commands/configs/withdrawalCompressorConfig.ts

Prerequisites

0. Configure withdrawal compressor for your network Edit src/commands/configs/withdrawalCompressorConfig.ts and add/update the configuration for your chain ID with the required subcompressors.

1. Start Anvil fork

   anvil --fork-url <YOUR_RPC_URL>

2. Configure environment variables Ensure all variables from .env.example are set:

   • RPC_URL – RPC URL
   • ANVIL_URL – Testnet RPC URL for simulations (e.g., http://127.0.0.1:8545)
   • ADDRESS_PROVIDER – Address of the AddressProvider contract
   • PRIVATE_KEY – Private key for transactions
   • PINATA_JWT – Pinata JWT token for IPFS upload
   • PINATA_GATEWAY – Pinata gateway URL

Deploy Withdrawal Compressor

pnpm start deploy-withdrawal-compressor --execute

Restart Anvil

After deployment, restart the Anvil fork before running setup:

# Stop current Anvil instance (Ctrl+C) and start again
anvil --fork-url <YOUR_RPC_URL>

Setup Withdrawal Compressor

pnpm start setup-withdrawal-compressor --testnet --execute --upload