Aero

Aero is a TypeScript SDK, the aero CLI and a terminal UI for Aerodrome on Base and the Velodrome deployments on nine other chains.

On this page

Aero is one package, @beegreat/sugar, with three ways in.

PartWhat it does
SDKTypeScript client for pools, quotes, swaps, liquidity, veNFTs and tokenized stocks. Returns reads and unsigned transactions.
aero CLIRuns the same actions from a terminal. Prints reads as JSON, connects a wallet, shows each plan and asks before it broadcasts.
aero tuiFull-screen terminal UI with browse screens, guided forms, analytics and signing.

The SDK is a TypeScript port of the Velodrome Python Sugar SDK. It uses Viem to read chain state from the Sugar contracts and to encode transactions.

The SDK never signs#

Read methods return typed data. Write methods return an ordered list of unsigned transactions shaped { from, to, data, value }, with any approvals before the final action. The SDK has no private key input and never broadcasts anything. You sign and send the list yourself, in order.

Signing lives in the CLI wallet flow. The aero CLI and TUI can sign with a browser wallet, a WalletConnect wallet or an encrypted local wallet, and they show a summary and ask before each step. See Wallets and Transactions.

Supported chains#

Every entry point defaults to Base, chain ID 8453, where Aerodrome runs. The SDK also supports OP Mainnet (10), Unichain (130), Fraxtal (252), Lisk (1135), Soneium (1868), Superseed (5330), Mode (34443), Celo (42220) and Ink (57073).

Some features are narrower. veNFT locks and voting work on Base and OP Mainnet only. Tokenized stocks are Base only. Cross-chain Superswap covers OP Mainnet, Lisk and Unichain. Chains has the full table.

Where to go next#

PageCovers
InstallAdding the package, running the CLI from a clone, the build step
ClientSugarClient, options, tokens, balances, prices and unit helpers
SwapsQuotes, routing, swap plans, slippage and approvals
LiquidityPools, epochs, positions, deposits, withdrawals, staking and claims
veNFTsLocks, voting, rewards, rebases, managed veNFTs and pool incentives
StocksTokenized stock prices, trades and index rebalances from the SDK
ActionsThe JSON action interface the CLI and TUI are built on
ChainsChain IDs, chain classes, Superswap and Supersim
ConfigurationEnvironment variables, RPC retries, errors and failover
CLIRunning the aero command
CLI referenceEvery command and flag
WalletsBrowser, WalletConnect and local wallets
TransactionsPlan review, signing, dry runs and interrupted plans
Stocks and indicesStock trades and saved indices in the CLI and TUI
TUIThe terminal UI
AnalyticsThe TUI analytics screens
ALMThe self-hosted liquidity manager behind aero serve
LicensingWhich license covers which part of the code