Token and pool data, swap quotes, and unsigned transaction plans for Ekubo and other DeFi protocols.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Decode the packed bytes32 extension, exact uint64 Q64 fee, concentrated/stableswap discriminator, and tick spacing or stableswap parameters. The fee is never returned as a JSON number.
bytes32 hex
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http ekubo https://mcp.ekubo.org/mcp
Decode the packed bytes32 extension, exact uint64 Q64 fee, concentrated/stableswap discriminator, and tick spacing or stableswap parameters. The fee is never returned as a JSON number.
| Argument | Type | Description |
|---|---|---|
| config* | string | bytes32 hex |
{
"type": "object",
"required": [
"config"
],
"properties": {
"config": {
"type": "string",
"description": "bytes32 hex"
}
}
}Decode the packed PositionInfo returned by wallet reads into signed tick bounds, subscriber flag and the truncated pool-ID prefix. This is local integer decoding, not a state query.
| Argument | Type | Description |
|---|---|---|
| info* | string | decimal integer |
{
"type": "object",
"required": [
"info"
],
"properties": {
"info": {
"type": "string",
"description": "decimal integer"
}
}
}Pack or accept an exact PoolKey config and derive pool_id = keccak256(abi.encode(PoolKey)). The uint64 Q64 fee is string-only so JavaScript cannot silently round it.
| Argument | Type | Description |
|---|---|---|
| pool_key* | object |
{
"type": "object",
"required": [
"pool_key"
],
"properties": {
"pool_key": {
"type": "object",
"required": [
"token0",
"token1"
],
"properties": {
"fee": {
"type": "string",
"description": "uint64 Q64 fee as a string, never a JSON number (decimal or 0x-hex integer)"
},
"config": {
"type": "string",
"description": "bytes32 hex"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"extension": {
"type": "string",
"description": "address"
},
"tick_spacing": {
"type": [
"integer",
"string"
],
"minimum": 1,
"description": "decimal or 0x-hex integer"
},
"stableswap_params": {
"type": "object",
"required": [
"center_tick",
"amplification"
],
"properties": {
"center_tick": {
"type": "integer"
},
"amplification": {
"type": "integer",
"maximum": 127,
"minimum": 0
}
}
}
}
}
}
}Fetch indexed V2, V3 or V4 pools ranked by TVL from Uniswap's interface API. Filter by chain and token; paginate using the last pool's TVL as tvl_cursor. Returns token symbols and decimals, liquidity and daily volume.
| Argument | Type | Description |
|---|---|---|
| first | integer | |
| version* | string | |
| chain_id* | string | |
| tvl_cursor | number | |
| token_address | string | address |
{
"type": "object",
"required": [
"chain_id",
"version"
],
"properties": {
"first": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"version": {
"enum": [
"v2",
"v3",
"v4"
],
"type": "string"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"tvl_cursor": {
"type": "number",
"minimum": 0
},
"token_address": {
"type": "string",
"description": "address"
}
}
}Return a token_list_reference envelope (chain ID, address, symbol, name, decimals) and its count, with no entries, so a wallet can import token names; pass it unchanged as the wallet tool's reference argument. complete=false means the export is a prefix of the chain's list. Use list_tokens to read entries yourself.
| Argument | Type | Description |
|---|---|---|
| chain_id | integer | string | Export only this chain; almost always pass it, since a wallet holds names for the chain it is on. Ethereum alone has about 5,600 tokens |
| max_tokens | integer | Defaults to 1,000, what a wallet accepts in one import; a larger export is refused whole, not truncated |
{
"type": "object",
"properties": {
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Export only this chain; almost always pass it, since a wallet holds names for the chain it is on. Ethereum alone has about 5,600 tokens"
},
"max_tokens": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Defaults to 1,000, what a wallet accepts in one import; a larger export is refused whole, not truncated"
}
}
}Locally return six major Aave V3 core deployments and a bounded set of popular reserve, aToken, and variable-debt-token addresses from a pinned official Aave address-book snapshot. This tool makes no RPC, indexer, API, or other network request. For live rates, caps, pause state, liquidity, collateral settings, eMode categories, and account data, an agent may call Aave's public GraphQL API at https://api.v3.aave.com/graphql directly; this server is not in that data path. Intersect the API result with this fixed list before calling a preparation tool.
| Argument | Type | Description |
|---|---|---|
| chain_id | integer | string | Optional exact chain filter. Omit to return every fixed Aave V3 core market supported by the preparation tools. |
{
"type": "object",
"properties": {
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Optional exact chain filter. Omit to return every fixed Aave V3 core market supported by the preparation tools."
}
}
}Locally return Aerodrome's Base contracts (AERO, veAERO, Voter, Router, v2 factory, RewardsDistributor, Slipstream, Sugar lenses), derived on chain from the Voter, plus the protocol behaviour an agent must respect. No API or RPC request. Aerodrome is Base-only; Velodrome is not prepared here.
| Argument | Type | Description |
|---|---|---|
| chain_id | integer | string | Optional chain to check against Aerodrome's Base-only deployment |
{
"type": "object",
"properties": {
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Optional chain to check against Aerodrome's Base-only deployment"
}
}
}Locally return canonical Ethereum stETH, wstETH, and WithdrawalQueueERC721 addresses plus direct wallet-read guidance. This server makes no Lido API, RPC, or indexer request.
No arguments.
{
"type": "object",
"properties": {}
}Return the interface's boosted-fee, incentive and projected ve(3,3)-emission opportunities ranked by APR, with actionable pools or pool-discovery handoffs, freshness and risk context. Call this before asking the user to choose a pair. APR is an annualized snapshot, not guaranteed yield: show its components, denominator, freshness, and range and impermanent-loss risk. If ranking_complete=false, run local_read_requirement through the wallet, decode it locally, and call again with ve33_emission_state.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| token | string | Token in the pair (EVM or Starknet) (hex) |
| types | array | Defaults to all |
| min_apr | number | APR ratio floor; 1.0 = 100% |
| chain_id | integer | string | Omit for every chain |
| ve33_emission_state | object | {current_timestamp, current_emission_rate, total_remaining_emissions}: decimal strings decoded locally from getEmissionState (rate is Q32) via local_read_requirement; omit on the first call |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 1
},
"token": {
"type": "string",
"description": "Token in the pair (EVM or Starknet) (hex)"
},
"types": {
"type": "array",
"items": {
"enum": [
"boosted_fees",
"incentive",
"ve33_emissions"
],
"type": "string"
},
"default": [
"boosted_fees",
"incentive",
"ve33_emissions"
],
"minItems": 1,
"description": "Defaults to all"
},
"min_apr": {
"type": "number",
"minimum": 0,
"description": "APR ratio floor; 1.0 = 100%"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Omit for every chain"
},
"ve33_emission_state": {
"type": "object",
"description": "{current_timestamp, current_emission_rate, total_remaining_emissions}: decimal strings decoded locally from getEmissionState (rate is Q32) via local_read_requirement; omit on the first call"
}
}
}Locally return the Merkl Distributor address, the chains it is verified on, and how Merkl's reward fields behave; preparation is limited to those chains. No Merkl API, RPC, or indexer request.
| Argument | Type | Description |
|---|---|---|
| chain_id | integer | string | Optional chain to check against the verified Merkl Distributor catalog |
{
"type": "object",
"properties": {
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Optional chain to check against the verified Merkl Distributor catalog"
}
}
}Locally return a bounded, pinned catalog of listed Morpho Vault V2 deployments plus official direct-discovery guidance. This tool makes no API, RPC, indexer, or other network request. The agent must query Morpho's public GraphQL API and current onchain state directly, then intersect the result with the fixed chain, vault, and asset addresses before preparation.
| Argument | Type | Description |
|---|---|---|
| chain_id | integer | string | Optional exact chain filter for the fixed Morpho Vault V2 catalog |
{
"type": "object",
"properties": {
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Optional exact chain filter for the fixed Morpho Vault V2 catalog"
}
}
}Resolve a chain/core/pool ID to its verified PoolKey, decoded config and indexed pool state. For fresh sqrtRatio, tick and liquidity, pass current_state_query.read_calls_reference unchanged to wallet_batch_eth_call.
| Argument | Type | Description |
|---|---|---|
| pool_id* | string | Pool ID (decimal or 0x-hex integer) |
| chain_id* | integer | string | EVM chain ID |
| core_address* | string | address |
{
"type": "object",
"required": [
"chain_id",
"core_address",
"pool_id"
],
"properties": {
"pool_id": {
"type": "string",
"description": "Pool ID (decimal or 0x-hex integer)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"core_address": {
"type": "string",
"description": "address"
}
}
}Return tick-level net liquidity deltas for one exact chain/core/pool ID. Accumulate the deltas in ascending tick order to reconstruct active liquidity depth.
| Argument | Type | Description |
|---|---|---|
| pool_id* | string | Pool ID (decimal or 0x-hex integer) |
| chain_id* | integer | string | EVM chain ID |
| core_address* | string | address |
{
"type": "object",
"required": [
"chain_id",
"core_address",
"pool_id"
],
"properties": {
"pool_id": {
"type": "string",
"description": "Pool ID (decimal or 0x-hex integer)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"core_address": {
"type": "string",
"description": "address"
}
}
}Hydrate one owner position: pool key, bounds, liquidity, pool state, NFT metadata, history, rewards, token prices, and a pending read of current principal, fees or Ve33 rewards and owner. Pass current_state_query.read_calls_reference as a value to wallet_batch_eth_call in the same code block; current_state_query.state_call_id joins results[].id.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Current owner (address) |
| chain_id* | integer | string | EVM chain ID |
| token_id* | string | Position NFT ID (decimal or 0x-hex integer) |
| positions_address* | string | Ekubo Positions or Ve33Positions manager (address) |
{
"type": "object",
"required": [
"owner",
"chain_id",
"positions_address",
"token_id"
],
"properties": {
"owner": {
"type": "string",
"description": "Current owner (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"token_id": {
"type": "string",
"description": "Position NFT ID (decimal or 0x-hex integer)"
},
"positions_address": {
"type": "string",
"description": "Ekubo Positions or Ve33Positions manager (address)"
}
}
}List indexed pools for a token pair with verified PoolKeys and pool IDs, Core generation, pool type, extension, 24-hour TVL/volume/fee stats and the right Positions or Ve33Positions manager.
| Argument | Type | Description |
|---|---|---|
| token_a* | string | Either order (address) |
| token_b* | string | address |
| chain_id* | integer | string | EVM chain ID |
| extension | string | address |
| pool_type | string | |
| min_tvl_usd | number | TVL floor; default 0 keeps tiny pools visible |
| core_address | string | address |
{
"type": "object",
"required": [
"chain_id",
"token_a",
"token_b"
],
"properties": {
"token_a": {
"type": "string",
"description": "Either order (address)"
},
"token_b": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"extension": {
"type": "string",
"description": "address"
},
"pool_type": {
"enum": [
"concentrated",
"stableswap"
],
"type": "string"
},
"min_tvl_usd": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "TVL floor; default 0 keeps tiny pools visible"
},
"core_address": {
"type": "string",
"description": "address"
}
}
}Enumerate an owner's indexed Ekubo position NFTs with pool keys, bounds, liquidity, indexed pool state and rewards. For fresh onchain state, pass each current_state_reads[].read_calls_reference to wallet_batch_eth_call as a value in the same code block; each position's current_state.state_call_id joins results[].id.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| owner* | string | address |
| state | string | |
| chain_id | integer | string | EVM chain ID |
| page_size | integer |
{
"type": "object",
"required": [
"owner"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1
},
"owner": {
"type": "string",
"description": "address"
},
"state": {
"enum": [
"opened",
"closed"
],
"type": "string"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"page_size": {
"type": "integer",
"default": 50,
"maximum": 200,
"minimum": 1
}
}
}A quote, execution plan, simulation or wallet approval is not permission to trade. Robinhood Stock Tokens are tokenised debt securities subject to issuer restrictions and applicable law. Before requesting signatures or submitting approvals or trades, establish the user's relevant jurisdiction and eligibility, including location, residence or entity incorporation, US-person status under Regulation S, any person for whose account or benefit the transaction is made, and issuer Prohibited Investor restrictions. Never infer these facts from an agent or server IP. If required facts or asset-policy coverage are unknown, do not proceed. Only the user or an authorized representative of the actual investor may provide an explicit factual attestation; an agent must not attest on their behalf. A known prohibited fact cannot be overridden by attestation. An attestation is not a license, legal exemption or substitute for required screening. Keep the attestation client-side; do not send it to the quote API or MCP server. No blanket disposal exemption applies. Quote EVM swaps: Ekubo/0x same-chain; Across/LayerZero/LI.FI cross-chain. For plans, supply sender and exactly one protection: whole slippage_bps or exact-input max_output_loss in output base units. Omit all three for indicative quotes. Pass the chosen execution.execution_plan_reference unchanged to wallet simulation; show that result and send the same simulation for owner authorization. Re-quote only after revert, expiry or changed request; never retry reverted bytes or widen protection. For all/max swaps use the wallet's exact balance. Compare amount_out and native_fee (LayerZero charges it separately). Track LayerZero/LI.FI delivery with get_value_transfer_status. unavailable_sources reports provider failures; execution_unavailable reports plan failures.
| Argument | Type | Description |
|---|---|---|
| amount* | string | Base units (positive decimal integer) |
| sender | string |
Fetch canonical reward-claim records and supply the exact per-chain isClaimed/isAvailable eth_call list used by the interface before preparing claim transactions.
| Argument | Type | Description |
|---|---|---|
| owner* | string | address |
{
"type": "object",
"required": [
"owner"
],
"properties": {
"owner": {
"type": "string",
"description": "address"
}
}
}Locally return the canonical Ethereum USDS and sUSDS addresses and direct wallet-read guidance. This server does not proxy Sky, an RPC, an indexer, or any third-party API.
No arguments.
{
"type": "object",
"properties": {}
}Return a provider-neutral STONX allocation recommendation with an emissions_efficiency KPI per pool and an executable target list (exactly 10,000 bps, at most 25 Ve33 pools). The snapshot refreshes daily; read snapshot_age_seconds. voter with ve33_emission_state makes targets voter-optimal and keeps the neutral plan as provider_targets; without the emission state, execution_ready is false and local_read_requirement says what to read. The tool constructs no transaction. To apply it, require execution_ready=true, then pass its targets, the state_id from get_ve33_allocations for the connected wallet, and strategy=compact_max_lock to prepare_ve33_reallocation.
| Argument | Type | Description |
|---|---|---|
| voter | object | With ve33_emission_state, makes targets voter-optimal |
| ve33_emission_state | object | {current_timestamp, current_emission_rate, total_remaining_emissions}: decimal strings decoded locally from getEmissionState (rate is Q32) via local_read_requirement; omit on the first call |
| prune_low_efficiency | boolean | Withhold prune candidates and redistribute their weight |
| max_emission_share_per_fee_share | number | Prune above this emission share / retained fee share; default 3 |
{
"type": "object",
"properties": {
"voter": {
"type": "object",
"required": [
"vote_weight",
"pools"
],
"properties": {
"pools": {
"type": "array",
"items": {
"type": "object",
"required": [
"pool_key_id",
"lp_share"
],
"properties": {
"lp_share": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "Voter's share of the pool's emission-earning liquidity"
},
"pool_key_id": {
"type": "string",
"description": "Ve33 pool_key_id (decimal integer)"
},
"current_vote_weight": {
"type": "string",
"pattern": "^(?:0|[1-9][0-9]{0,77})$",
"description": "Defaults to 0"
}
}
}
},
"vote_weight": {
"type": "string",
"pattern": "^(?:0|[1-9][0-9]{0,77})$",
"description": "Total applied vote weight from get_ve33_allocations"
}
},
"description": "With ve33_emission_state, makes targets voter-optimal"
},
"ve33_emission_state": {
"type": "object",
"description": "{current_timestamp, current_emission_rate, total_remaining_emissions}: decimal strings decoded locally from getEmissionState (rate is Q32) via local_read_requirement; omit on the first call"
},
"prune_low_efficiency": {
"type": "boolean",
"default": false,
"description": "Withhold prune candidates and redistribute their weight"
},
"max_emission_share_per_fee_share": {
"type": "number",
"maximum": 100,
"minimum": 1,
"description": "Prune above this emission share / retained fee share; default 3"
}
}
}Fetch canonical token metadata for an exact chain and address.
| Argument | Type | Description |
|---|---|---|
| address* | string | EVM or Starknet token address (hex) |
| chain_id* | integer | string | EVM chain ID |
{
"type": "object",
"required": [
"chain_id",
"address"
],
"properties": {
"address": {
"type": "string",
"description": "EVM or Starknet token address (hex)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
}
}
}Fetch canonical metadata for up to 1,000 token identifiers in one batch request, preserving input order; identifiers absent from the canonical list are omitted.
| Argument | Type | Description |
|---|---|---|
| tokens* | array | Entries may span chains |
{
"type": "object",
"required": [
"tokens"
],
"properties": {
"tokens": {
"type": "array",
"items": {
"type": "object",
"required": [
"chain_id",
"address"
],
"properties": {
"address": {
"type": "string",
"description": "EVM or Starknet token address (hex)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
}
}
},
"minItems": 1,
"description": "Entries may span chains"
}
}
}Fetch timestamped token0/token1 prices and USD volume history over the requested duration from the same GraphQL fields as the open source Uniswap interface. Empty series means no indexed data, never zero volume.
| Argument | Type | Description |
|---|---|---|
| pool* | string | |
| version* | string | |
| chain_id* | string | |
| duration | string |
{
"type": "object",
"required": [
"chain_id",
"version",
"pool"
],
"properties": {
"pool": {
"type": "string",
"pattern": "^0x(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$"
},
"version": {
"enum": [
"v2",
"v3",
"v4"
],
"type": "string"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"duration": {
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR",
"MAX"
],
"type": "string",
"default": "WEEK"
}
}
}Canonical V2/V3/V4 contracts on Ethereum, Optimism, Base, Arbitrum, Unichain and Robinhood, including Permit2 and wrapped native addresses.
No arguments.
{
"type": "object",
"properties": {}
}Fetch indexed pool details, currencies, fee, TVL, volume and supplies. V4 takes a bytes32 pool ID; V2/V3 take an address. Use prepare_uniswap_reads for current chain state.
| Argument | Type | Description |
|---|---|---|
| pool* | string | |
| version* | string | |
| chain_id* | string |
{
"type": "object",
"required": [
"chain_id",
"version",
"pool"
],
"properties": {
"pool": {
"type": "string",
"pattern": "^0x(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$"
},
"version": {
"enum": [
"v2",
"v3",
"v4"
],
"type": "string"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
}
}
}Fetch paginated initialized ticks and exact liquidityNet/liquidityGross strings for V3/V4 liquidity depth charts. first/skip bound each request; combine with current pool liquidity and tick from prepare_uniswap_reads. Indexer data can lag.
| Argument | Type | Description |
|---|---|---|
| pool* | string | |
| skip | integer | |
| first | integer | |
| version* | string | |
| chain_id* | string |
{
"type": "object",
"required": [
"chain_id",
"version",
"pool"
],
"properties": {
"pool": {
"type": "string",
"pattern": "^0x(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$"
},
"skip": {
"type": "integer",
"default": 0,
"minimum": 0
},
"first": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1
},
"version": {
"enum": [
"v3",
"v4"
],
"type": "string"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
}
}
}Report whether an executed LayerZero or LI.FI transfer has been delivered; its origin receipt alone does not mean the user has the funds. Poll every 15 to 30 seconds while settled is false (it draws on the quote budget). UNKNOWN or NOT_FOUND right after submission usually means not yet indexed. For LI.FI, read substatus: REFUNDED and PARTIAL report as status DONE. Across transfers are not tracked here.
| Argument | Type | Description |
|---|---|---|
| source | string | The executed quote's source; defaults to layerzero |
| quote_id | string | The executed option's provider_quote_id; required for layerzero |
| origin_chain_id | integer | string | Origin chain; lifi only, narrows the lookup |
| transaction_hash | string | Origin transaction hash; required for lifi, and pass it for layerzero once known (some routes need it) (bytes32 hex) |
| destination_chain_id | integer | string | Destination chain; lifi only |
{
"type": "object",
"properties": {
"source": {
"enum": [
"layerzero",
"lifi"
],
"type": "string",
"description": "The executed quote's source; defaults to layerzero"
},
"quote_id": {
"type": "string",
"minLength": 1,
"description": "The executed option's provider_quote_id; required for layerzero"
},
"origin_chain_id": {
"type": [
"integer",
"string"
],
"description": "Origin chain; lifi only, narrows the lookup"
},
"transaction_hash": {
"type": "string",
"description": "Origin transaction hash; required for lifi, and pass it for layerzero once known (some routes need it) (bytes32 hex)"
},
"destination_chain_id": {
"type": [
"integer",
"string"
],
"description": "Destination chain; lifi only"
}
}
}Use for requests such as 'show all my Ekubo STONX allocations'. The production Ekubo ve(3,3) deployment is the STONX voting system, so pass only owner to select its production chain and canonical VeToken automatically. Returns every pool, selected swap fee, NFT, applied vote weight, totals, state_id, and an onchain_validation request explicitly marked not_executed until the client runs its eth_call. Pass chain_id and ve_token together only for another deployment.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Connected EVM wallet whose complete Ekubo STONX/VeToken allocation should be shown; the server cannot infer 'my', so ask the user when no wallet address is available |
| chain_id | integer | string | Optional with ve_token; omit both for the production Ekubo STONX deployment |
| ve_token | string | Optional with chain_id; omit both for the canonical STONX VeToken 0x9d7008E169D040B6c0140eb92E7cA82B12643497 (address) |
{
"type": "object",
"required": [
"owner"
],
"properties": {
"owner": {
"type": "string",
"description": "Connected EVM wallet whose complete Ekubo STONX/VeToken allocation should be shown; the server cannot infer 'my', so ask the user when no wallet address is available"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Optional with ve_token; omit both for the production Ekubo STONX deployment"
},
"ve_token": {
"type": "string",
"description": "Optional with chain_id; omit both for the canonical STONX VeToken 0x9d7008E169D040B6c0140eb92E7cA82B12643497 (address)"
}
}
}Discover initialized pools for one chain and Core deployment, ordered by pool_id with keyset pagination, optionally filtered by token, pair or extension. Each pool_id is re-derived from its PoolKey and each row carries the indexed state (null until indexed).
| Argument | Type | Description |
|---|---|---|
| token_a | string | Pools containing this token (address) |
| token_b | string | With token_a, the exact pair (address) |
| chain_id* | integer | string | EVM chain ID |
| extension | string | Zero address = extensionless |
| page_size | integer | Pools per page |
| core_address* | string | Core deployment (address) |
| after_pool_id | string | Previous page's next_after_pool_id (decimal or 0x-hex integer) |
{
"type": "object",
"required": [
"chain_id",
"core_address"
],
"properties": {
"token_a": {
"type": "string",
"description": "Pools containing this token (address)"
},
"token_b": {
"type": "string",
"description": "With token_a, the exact pair (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"extension": {
"type": "string",
"description": "Zero address = extensionless"
},
"page_size": {
"type": "integer",
"default": 100,
"maximum": 200,
"minimum": 1,
"description": "Pools per page"
},
"core_address": {
"type": "string",
"description": "Core deployment (address)"
},
"after_pool_id": {
"type": "string",
"description": "Previous page's next_after_pool_id (decimal or 0x-hex integer)"
}
}
}First step for symbol-based swaps, including tokenized stocks and stablecoins: list canonical Ekubo tokens by descending visibility_priority, so the preferred token wins an ambiguous symbol. Use search for a symbol prefix or suffix and min_visibility_priority to reach tokens the interface hides.
| Argument | Type | Description |
|---|---|---|
| search | string | Case-insensitive token symbol prefix or suffix match; omit to list the whole canonical set. Symbols only, not names or addresses |
| chain_id | integer | string | Restrict the list to one EVM chain; omit to list tokens across every indexed chain |
| page_size | integer | Maximum tokens to return; defaults to 20 |
| after_token | string | Keep only tokens whose (chain_id, address) pair sorts after this <chain_id>:<address> identifier. Results are ordered by visibility_priority rather than by that pair, so this filters the candidate set instead of continuing a page boundary |
| min_visibility_priority | integer | Lowest visibility_priority to include; defaults to 0, the interface threshold. Pass a negative value to reach tokens the interface hides |
{
"type": "object",
"properties": {
"search": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "Case-insensitive token symbol prefix or suffix match; omit to list the whole canonical set. Symbols only, not names or addresses"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Restrict the list to one EVM chain; omit to list tokens across every indexed chain"
},
"page_size": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Maximum tokens to return; defaults to 20"
},
"after_token": {
"type": "string",
"pattern": "^(?:[1-9][0-9]*|0x[0-9a-fA-F]+):0x[0-9a-fA-F]+$",
"description": "Keep only tokens whose (chain_id, address) pair sorts after this <chain_id>:<address> identifier. Results are ordered by visibility_priority rather than by that pair, so this filters the candidate set instead of continuing a page boundary"
},
"min_visibility_priority": {
"type": "integer",
"maximum": 100,
"minimum": -100,
"description": "Lowest visibility_priority to include; defaults to 0, the interface threshold. Pass a negative value to reach tokens the interface hides"
}
}
}Prepare a direct Aave V3 variable-rate borrow from a supported fixed reserve, including optional on-behalf-of credit delegation. This server does not query collateral, delegation, health factor, caps, or available liquidity.
| Argument | Type | Description |
|---|---|---|
| asset* | string | Exact underlying ERC-20 address from the selected market's fixed major-reserve list |
| amount* | string | Positive borrow amount in base units (positive decimal integer) |
| sender* | string | Wallet that will execute the Aave action (address) |
| chain_id* | integer | string | Chain of a fixed Aave V3 core market returned by get_aave_v3_markets |
| on_behalf_of | string | Debt owner; defaults to sender. A different owner must already have delegated variable debt to sender. (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"asset",
"amount"
],
"properties": {
"asset": {
"type": "string",
"description": "Exact underlying ERC-20 address from the selected market's fixed major-reserve list"
},
"amount": {
"type": "string",
"description": "Positive borrow amount in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Aave action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain of a fixed Aave V3 core market returned by get_aave_v3_markets"
},
"on_behalf_of": {
"type": "string",
"description": "Debt owner; defaults to sender. A different owner must already have delegated variable debt to sender. (address)"
}
}
}Prepare setUserUseReserveAsCollateral for a supported fixed reserve. Disabling collateral can reduce health factor or revert when open debt needs it, so exact wallet simulation is mandatory.
| Argument | Type | Description |
|---|---|---|
| asset* | string | Exact underlying ERC-20 address from the selected market's fixed major-reserve list |
| sender* | string | Wallet that will execute the Aave action (address) |
| chain_id* | integer | string | Chain of a fixed Aave V3 core market returned by get_aave_v3_markets |
| use_as_collateral* | boolean | True enables this supplied reserve as collateral; false disables it |
{
"type": "object",
"required": [
"chain_id",
"sender",
"asset",
"use_as_collateral"
],
"properties": {
"asset": {
"type": "string",
"description": "Exact underlying ERC-20 address from the selected market's fixed major-reserve list"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Aave action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain of a fixed Aave V3 core market returned by get_aave_v3_markets"
},
"use_as_collateral": {
"type": "boolean",
"description": "True enables this supplied reserve as collateral; false disables it"
}
}
}Prepare setUserEMode with a caller-supplied current uint8 category ID; zero disables eMode. Discover live category configuration through Aave's public GraphQL API directly, because this server makes no data or RPC request.
| Argument | Type | Description |
|---|---|---|
| sender* | string | Wallet whose eMode selection will change (address) |
| chain_id* | integer | string | Chain of a fixed Aave V3 core market returned by get_aave_v3_markets |
| category_id* | integer | Current onchain Aave eMode category; zero disables eMode. Obtain nonzero category IDs from Aave's public GraphQL API, because this server does not query them. |
{
"type": "object",
"required": [
"chain_id",
"sender",
"category_id"
],
"properties": {
"sender": {
"type": "string",
"description": "Wallet whose eMode selection will change (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain of a fixed Aave V3 core market returned by get_aave_v3_markets"
},
"category_id": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"description": "Current onchain Aave eMode category; zero disables eMode. Obtain nonzero category IDs from Aave's public GraphQL API, because this server does not query them."
}
}
}Prepare variable-debt repayment with underlying tokens or sender-owned aTokens. Underlying repayment carries an exact ERC-20 approval and cleanup in one atomic plan; uint256 maximum requests all available debt.
| Argument | Type | Description |
|---|---|---|
| asset* | string | Exact underlying ERC-20 address from the selected market's fixed major-reserve list |
| amount* | string | Positive repayment amount in base units; uint256 maximum requests all available variable debt (positive decimal integer) |
| sender* | string | Wallet that will execute the Aave action (address) |
| chain_id* | integer | string | Chain of a fixed Aave V3 core market returned by get_aave_v3_markets |
| on_behalf_of | string | Debt owner; defaults to sender (address) |
| funding_source | string | Use underlying ERC-20 with a temporary exact Pool approval, or burn sender-owned aTokens with repayWithATokens |
{
"type": "object",
"required": [
"chain_id",
"sender",
"asset",
"amount"
],
"properties": {
"asset": {
"type": "string",
"description": "Exact underlying ERC-20 address from the selected market's fixed major-reserve list"
},
"amount": {
"type": "string",
"description": "Positive repayment amount in base units; uint256 maximum requests all available variable debt (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Aave action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain of a fixed Aave V3 core market returned by get_aave_v3_markets"
},
"on_behalf_of": {
"type": "string",
"description": "Debt owner; defaults to sender (address)"
},
"funding_source": {
"enum": [
"underlying",
"a_token"
],
"type": "string",
"default": "underlying",
"description": "Use underlying ERC-20 with a temporary exact Pool approval, or burn sender-owned aTokens with repayWithATokens"
}
}
}Prepare a fixed-market Aave V3 Pool supply with an exact ERC-20 approval, supply calldata, and allowance cleanup as one atomic wallet plan. No live balance, allowance, reserve, cap, pause, or rate data is queried.
| Argument | Type | Description |
|---|---|---|
| asset* | string | Exact underlying ERC-20 address from the selected market's fixed major-reserve list |
| amount* | string | Positive underlying-token amount in base units (positive decimal integer) |
| sender* | string | Wallet that will execute the Aave action (address) |
| chain_id* | integer | string | Chain of a fixed Aave V3 core market returned by get_aave_v3_markets |
| on_behalf_of | string | aToken recipient; defaults to sender (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"asset",
"amount"
],
"properties": {
"asset": {
"type": "string",
"description": "Exact underlying ERC-20 address from the selected market's fixed major-reserve list"
},
"amount": {
"type": "string",
"description": "Positive underlying-token amount in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Aave action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain of a fixed Aave V3 core market returned by get_aave_v3_markets"
},
"on_behalf_of": {
"type": "string",
"description": "aToken recipient; defaults to sender (address)"
}
}
}Prepare a direct Aave V3 Pool withdrawal for a supported fixed reserve. Pass uint256 maximum as amount to request the available aToken balance. The wallet establishes balance, health-factor, collateral, and liquidity validity by exact simulation.
| Argument | Type | Description |
|---|---|---|
| asset* | string | Exact underlying ERC-20 address from the selected market's fixed major-reserve list |
| amount* | string | Positive underlying-token amount in base units; uint256 maximum requests all available balance (positive decimal integer) |
| sender* | string | Wallet that will execute the Aave action (address) |
| chain_id* | integer | string | Chain of a fixed Aave V3 core market returned by get_aave_v3_markets |
| recipient | string | Underlying-token recipient; defaults to sender (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"asset",
"amount"
],
"properties": {
"asset": {
"type": "string",
"description": "Exact underlying ERC-20 address from the selected market's fixed major-reserve list"
},
"amount": {
"type": "string",
"description": "Positive underlying-token amount in base units; uint256 maximum requests all available balance (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Aave action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain of a fixed Aave V3 core market returned by get_aave_v3_markets"
},
"recipient": {
"type": "string",
"description": "Underlying-token recipient; defaults to sender (address)"
}
}
}Claim accrued AERO from a gauge. getReward credits its account argument rather than the sender, so a claim can pay a different address than the one paying gas; the plan states which. A claim with nothing earned succeeds and transfers nothing.
| Argument | Type | Description |
|---|---|---|
| gauge* | string | Gauge from a Sugar pools read (address) |
| sender* | string | address |
| account | string | Account whose emissions are claimed; defaults to sender. getReward credits this address, so a non-sender value pays someone else. |
| chain_id* | integer | string | Base (8453) only |
{
"type": "object",
"required": [
"chain_id",
"sender",
"gauge"
],
"properties": {
"gauge": {
"type": "string",
"description": "Gauge from a Sugar pools read (address)"
},
"sender": {
"type": "string",
"description": "address"
},
"account": {
"type": "string",
"description": "Account whose emissions are claimed; defaults to sender. getReward credits this address, so a non-sender value pays someone else."
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
}
}
}Stake v2 LP tokens into a pool's gauge to earn AERO emissions, with the LP-token approval the gauge needs and an allowance cleanup after. Phased, because which token the gauge pulls is its own stakingToken: call it without lp_token to get that read back, then again with the resolved address for the complete atomic plan. Staking redirects that position's trading fees to the pool's voters, so it trades fee income for emissions rather than adding to it. A dead gauge accepts the stake and pays nothing, so check gauge_alive. Size amount from the live LP balance, not from an earlier deposit simulation.
| Argument | Type | Description |
|---|---|---|
| gauge* | string | Gauge from a Sugar pools read (address) |
| amount* | string | Exact LP token amount to stake in base units (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | Base (8453) only |
| lp_token | string | Gauge stakingToken from this tool's first-phase read; omit to get that read, supply it for the full plan (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"gauge",
"amount"
],
"properties": {
"gauge": {
"type": "string",
"description": "Gauge from a Sugar pools read (address)"
},
"amount": {
"type": "string",
"description": "Exact LP token amount to stake in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
},
"lp_token": {
"type": "string",
"description": "Gauge stakingToken from this tool's first-phase read; omit to get that read, supply it for the full plan (address)"
}
}
}Unstake v2 LP tokens from a gauge. This returns the LP token, not the underlying pair, and it does not claim AERO: the read bundle reports what is still earned so it is not silently left behind.
| Argument | Type | Description |
|---|---|---|
| gauge* | string | Gauge from a Sugar pools read (address) |
| amount* | string | Exact LP token amount to unstake in base units (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | Base (8453) only |
{
"type": "object",
"required": [
"chain_id",
"sender",
"gauge",
"amount"
],
"properties": {
"gauge": {
"type": "string",
"description": "Gauge from a Sugar pools read (address)"
},
"amount": {
"type": "string",
"description": "Exact LP token amount to unstake in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
}
}
}Claim a veNFT's voting rewards — trading fees, bribes, or both — and optionally the RewardsDistributor rebase, as one plan. The fee and bribe contract addresses are required inputs because they are per-pool contracts that only a Sugar rewards read returns; this server cannot derive them, and a wrong address claims nothing rather than failing loudly. Distinct from prepare_aerodrome_gauge_claim, which collects an LP's emissions rather than a voter's rewards.
| Argument | Type | Description |
|---|---|---|
| fees | array | Fee contracts and their tokens, taken from a Sugar venft_rewards read |
| bribes | array | Bribe contracts and their tokens, taken from a Sugar venft_rewards read |
| sender* | string | address |
| chain_id* | integer | string | Base (8453) only |
| venft_id* | string | veNFT token id whose rewards are claimed (positive decimal integer) |
| claim_rebase | boolean | Also claim the RewardsDistributor rebase, which compounds into the lock |
{
"type": "object",
"required": [
"chain_id",
"sender",
"venft_id"
],
"properties": {
"fees": {
"type": "array",
"items": {
"type": "object",
"required": [
"contract",
"tokens"
],
"properties": {
"tokens": {
"type": "array",
"items": {
"type": "string",
"description": "address"
},
"minItems": 1,
"description": "Reward tokens to claim from this contract"
},
"contract": {
"type": "string",
"description": "Fee or bribe contract from a Sugar rewards read (address)"
}
}
},
"description": "Fee contracts and their tokens, taken from a Sugar venft_rewards read"
},
"bribes": {
"type": "array",
"items": {
"type": "object",
"required": [
"contract",
"tokens"
],
"properties": {
"tokens": {
"type": "array",
"items": {
"type": "string",
"description": "address"
},
"minItems": 1,
"description": "Reward tokens to claim from this contract"
},
"contract": {
"type": "string",
"description": "Fee or bribe contract from a Sugar rewards read (address)"
}
}
},
"description": "Bribe contracts and their tokens, taken from a Sugar venft_rewards read"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
},
"venft_id": {
"type": "string",
"description": "veNFT token id whose rewards are claimed (positive decimal integer)"
},
"claim_rebase": {
"type": "boolean",
"description": "Also claim the RewardsDistributor rebase, which compounds into the lock"
}
}
}Prepare a v2 addLiquidity through Aerodrome's Router with exact approvals and allowance cleanup. The read bundle quotes the actual split and resolves the pool, so a pair with no pool is caught before a deposit sets its price. LP tokens earn no AERO until staked with prepare_aerodrome_gauge_deposit.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| stable* | boolean | Stable (true) or volatile pool; with the pair it identifies the pool |
| token_a* | string | address |
| token_b* | string | address |
| chain_id* | integer | string | Base (8453) only |
| deadline* | string | Near-term unix timestamp; a past one makes the plan revert (positive decimal integer) |
| recipient | string | Defaults to sender (address) |
| amount_a_min* |
Prepare a v2 removeLiquidity that burns LP tokens back into the underlying pair, with the LP-token approval the router needs and an allowance cleanup after. Phased, because the token being approved is the pool and this server resolves Aerodrome addresses by reading them: call it without lp_token to get the pool read back, then again with the resolved address for the complete atomic plan. An LP balance short of the requested liquidity usually means the rest is staked in the gauge and needs unstaking first.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| stable* | boolean | Stable (true) or volatile pool |
| token_a* | string | address |
| token_b* | string | address |
| chain_id* | integer | string | Base (8453) only |
| deadline* | string | Near-term unix timestamp; a past one makes the plan revert (positive decimal integer) |
| lp_token | string | Pool address from this tool's first-phase read; omit to get that read, supply it for the full plan |
Build one veAERO escrow action: create a lock, add AERO to one, extend it, switch permanent locking on or off, or withdraw an expired one. Durations are measured from now and floored to a week boundary, so anything under a week is refused rather than signed. The read bundle returns ownership and the lock's (amount, end, isPermanent) so an impossible action — withdrawing an unexpired or permanent lock, extending past nothing — is caught before signing.
| Argument | Type | Description |
|---|---|---|
| action* | string | Which veAERO lock action to build |
| amount | string | AERO amount in base units; required for create and increase_amount (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | Base (8453) only |
| venft_id | string | veNFT token id; required for every action but create (positive decimal integer) |
| lock_duration | string | Lock length in seconds measured from now, required for create and extend. The escrow floors it to a week boundary and caps it at four years. (positive decimal integer) |
Build the eth_call bundle and decode plan for one Sugar dataset (pools, positions, veNFTs, epochs, rewards) for the wallet to run against the user's RPC; Sugar has no API. The pool, gauge, fee and bribe addresses and veNFT ids it returns are the inputs to the other prepare_aerodrome_* tools.
| Argument | Type | Description |
|---|---|---|
| pool | string | Required for pool_epochs and venft_pool_rewards (address) |
| limit | integer | Page size; at most 500 pools or 200 positions |
| offset | integer | |
| account | string | Required for positions and venfts_by_account (address) |
| dataset* | string | Sugar dataset |
| chain_id* | integer | string | Base (8453) only |
| venft_id | string | Required for venft_by_id, venft_rewards, and venft_pool_rewards (positive decimal integer) |
{
"type": "object",
"required": [
"chain_id",
"dataset"
],
"properties": {
"pool": {
"type": "string",
"description": "Required for pool_epochs and venft_pool_rewards (address)"
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Page size; at most 500 pools or 200 positions"
},
"offset": {
"type": "integer",
"minimum": 0
},
"account": {
"type": "string",
"description": "Required for positions and venfts_by_account (address)"
},
"dataset": {
"enum": [
"pools",
"positions",
"venfts_by_account",
"venft_by_id",
"latest_epochs",
"pool_epochs",
"venft_rewards",
"venft_pool_rewards"
],
"type": "string",
"description": "Sugar dataset"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
},
"venft_id": {
"type": "string",
"description": "Required for venft_by_id, venft_rewards, and venft_pool_rewards (positive decimal integer)"
}
}
}Cast one veNFT's gauge vote, or reset it. Weights are relative shares of voting power, not amounts, and the allocation replaces any previous vote entirely — a pool left out is voted zero. A veNFT may vote once per weekly epoch and reverts on a second attempt, so the read bundle returns lastVoted along with each pool's gauge and liveness. Voting also locks the NFT against withdrawal until it is reset.
| Argument | Type | Description |
|---|---|---|
| pools | array | The complete allocation. It replaces any previous vote, so a pool left out is voted zero rather than left alone. |
| reset | boolean | Clear this NFT's votes instead of casting new ones; required before withdrawing a voted NFT |
| sender* | string | address |
| chain_id* | integer | string | Base (8453) only |
| venft_id* | string | veNFT token id casting the vote (positive decimal integer) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"venft_id"
],
"properties": {
"pools": {
"type": "array",
"items": {
"type": "object",
"required": [
"pool",
"weight"
],
"properties": {
"pool": {
"type": "string",
"description": "Pool address to vote for"
},
"weight": {
"type": "string",
"description": "Relative share of this NFT's voting power. Only the ratio matters, so [1,1] and [50,50] are the same vote. (positive decimal integer)"
}
}
},
"description": "The complete allocation. It replaces any previous vote, so a pool left out is voted zero rather than left alone."
},
"reset": {
"type": "boolean",
"description": "Clear this NFT's votes instead of casting new ones; required before withdrawing a voted NFT"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
},
"venft_id": {
"type": "string",
"description": "veNFT token id casting the vote (positive decimal integer)"
}
}
}Prepare every approve(spender,0) as an exact ordered multi-transaction execution plan. The wallet must not discover or construct the transaction list.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| approvals* | array |
{
"type": "object",
"required": [
"chain_id",
"sender",
"approvals"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"approvals": {
"type": "array",
"items": {
"type": "object",
"required": [
"token",
"spender"
],
"properties": {
"token": {
"type": "string",
"description": "address"
},
"spender": {
"type": "string",
"description": "address"
}
}
},
"minItems": 1
}
}
}Prepare permissionless auction completion and, when necessary, graduation-pool initialization in the same atomic batch.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| token_id* | string | decimal or 0x-hex integer |
| auction_key* | object | PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config |
| launch_pool_tick | integer | |
| graduation_pool_initialized* | boolean |
{
"type": "object",
"required": [
"chain_id",
"sender",
"token_id",
"auction_key",
"graduation_pool_initialized"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"token_id": {
"type": "string",
"description": "decimal or 0x-hex integer"
},
"auction_key": {
"type": "object",
"description": "PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config"
},
"launch_pool_tick": {
"type": "integer"
},
"graduation_pool_initialized": {
"type": "boolean"
}
}
}Pack the exact interface auction config and prepare mint plus sellAmountByAuction, including approval or native value and deterministic token ID.
| Argument | Type | Description |
|---|---|---|
| salt* | string | bytes32 hex |
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| buy_token* | string | Token; zero address = native |
| sell_token* | string | Token; zero address = native |
| start_time* | string | decimal integer |
| sell_amount* | string | Base units (positive decimal integer) |
| creator_fee_q32* | string | decimal integer |
| auction_duration |
Prepare collection of creator proceeds for an auction NFT with pending owner validation.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| token_id* | string | decimal or 0x-hex integer |
| auction_key* | object | PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config |
{
"type": "object",
"required": [
"chain_id",
"sender",
"token_id",
"auction_key"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"token_id": {
"type": "string",
"description": "decimal or 0x-hex integer"
},
"auction_key": {
"type": "object",
"description": "PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config"
}
}
}Run the interface-equivalent phased fix-price workflow: provide exact pending pool-price read calldata, then exact router quote calldata, then approvals and target-price execution calldata. The wallet never constructs a route or transaction.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| pool_id* | string | decimal or 0x-hex integer |
| chain_id* | integer | string | EVM chain ID |
| base_token* | string | Token; zero address = native |
| core_address* | string | address |
| quote_result | object | |
| target_price* | string | |
| swap_deadline_minutes | integer | Ekubo router route deadline; default 30 |
Prepare the canonical Lido submit call with exact native ETH value and an explicit or zero referral. The agent must read current staking pause and limit state directly; the wallet then simulates the exact transaction.
| Argument | Type | Description |
|---|---|---|
| amount* | string | Exact native ETH stake amount in wei (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | Must be Ethereum chain 1 |
| referral | string | Optional Lido referral address; defaults to zero address |
{
"type": "object",
"required": [
"chain_id",
"sender",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Exact native ETH stake amount in wei (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Must be Ethereum chain 1"
},
"referral": {
"type": "string",
"description": "Optional Lido referral address; defaults to zero address"
}
}
}Prepare a direct wstETH unwrap call for an exact share amount, returning rebasing stETH to the sender.
| Argument | Type | Description |
|---|---|---|
| amount* | string | Exact wstETH amount to unwrap in base units (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | Must be Ethereum chain 1 |
{
"type": "object",
"required": [
"chain_id",
"sender",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Exact wstETH amount to unwrap in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Must be Ethereum chain 1"
}
}
}Prepare claimWithdrawal for one finalized, unclaimed unstETH request ID owned by the sender. The agent must verify ownership and finalization directly through the user's wallet/RPC before preparation.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | Must be Ethereum chain 1 |
| request_id* | string | Finalized, unclaimed unstETH NFT request ID owned by sender (positive decimal integer) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"request_id"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Must be Ethereum chain 1"
},
"request_id": {
"type": "string",
"description": "Finalized, unclaimed unstETH NFT request ID owned by sender (positive decimal integer)"
}
}
}Prepare one or more bounded stETH withdrawal requests with an exact queue approval and cleanup. This irreversible asynchronous action mints unstETH NFTs, stops rewards while queued, and can settle below 1:1 after extraordinary losses; wallet simulation and clear user review are required.
| Argument | Type | Description |
|---|---|---|
| owner | string | Recipient/owner of the unstETH request NFTs; defaults to sender (address) |
| sender* | string | address |
| amounts* | array | One to 64 stETH request amounts, each from 100 wei through 1000 stETH |
| chain_id* | integer | string | Must be Ethereum chain 1 |
{
"type": "object",
"required": [
"chain_id",
"sender",
"amounts"
],
"properties": {
"owner": {
"type": "string",
"description": "Recipient/owner of the unstETH request NFTs; defaults to sender (address)"
},
"sender": {
"type": "string",
"description": "address"
},
"amounts": {
"type": "array",
"items": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"minItems": 1,
"description": "One to 64 stETH request amounts, each from 100 wei through 1000 stETH"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Must be Ethereum chain 1"
}
}
}Prepare an exact stETH approval, wstETH wrap call, and allowance cleanup in one atomic wallet plan.
| Argument | Type | Description |
|---|---|---|
| amount* | string | Exact stETH amount to wrap in base units (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | Must be Ethereum chain 1 |
{
"type": "object",
"required": [
"chain_id",
"sender",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Exact stETH amount to wrap in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Must be Ethereum chain 1"
}
}
}Prepare a v3 position mint or add_liquidity, initializing a new pool at initial_tick when requested, with every approval, refund and cleanup step. Ekubo ticks use base 1.000001, so tick = ln(price in base units) x 10^6 and a Uniswap-style 1.0001 calculation is 100x too small. The token ratio follows the range and current price: do every swap first, re-read the tick with the pool's current_state_query, then mint once. If the wallet lacks one side, execute that swap separately and size the deposit from the measured balance after its receipt, never a quoted output. See ekubo://docs/lp-position-workflow.
| Argument | Type | Description |
|---|---|---|
| mode | string | |
| sender* | string | address |
| pool_id | string | Omit when pool_key is supplied (decimal or 0x-hex integer) |
| chain_id* | integer | string | EVM chain ID |
| pool_key | object | Required for an uninitialized pool. PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config |
| token_id | string | add_liquidity only (decimal or 0x-hex integer) |
| tick_lower* |
Prepare collection of all accrued fees from an owned standard position or rewards from an owned Ve33 position, keeping its liquidity and NFT. Run its current_state_query first: require every inner call to succeed and the decoded owner to equal expected_owner, and pass the decoded fees or rewards to the wallet with the plan.
| Argument | Type | Description |
|---|---|---|
| sender* | string | Position owner (address) |
| chain_id* | integer | string | EVM chain ID |
| token_id* | string | Position NFT ID (decimal or 0x-hex integer) |
| recipient | string | Defaults to sender (address) |
| positions_address* | string | Positions or Ve33Positions manager (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"positions_address",
"token_id"
],
"properties": {
"sender": {
"type": "string",
"description": "Position owner (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"token_id": {
"type": "string",
"description": "Position NFT ID (decimal or 0x-hex integer)"
},
"recipient": {
"type": "string",
"description": "Defaults to sender (address)"
},
"positions_address": {
"type": "string",
"description": "Positions or Ve33Positions manager (address)"
}
}
}Prepare the exact safeTransferFrom transaction for an owned LP position and include pending ownership validation. The position, liquidity, and unclaimed earnings move together.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| token_id* | string | decimal or 0x-hex integer |
| recipient* | string | address |
| positions_address* | string | address |
{
"type": "object",
"required": [
"chain_id",
"sender",
"positions_address",
"token_id",
"recipient"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"token_id": {
"type": "string",
"description": "decimal or 0x-hex integer"
},
"recipient": {
"type": "string",
"description": "address"
},
"positions_address": {
"type": "string",
"description": "address"
}
}
}Prepare partial or full withdrawals from one or more owned positions in one plan, collecting fees or Ve33 rewards and keeping the NFTs. Read each position's current_state_query first and request no more liquidity than it decodes; require every inner call to succeed and owner to equal expected_owner. Hand the wallet every principal and earnings estimate and recipient.
| Argument | Type | Description |
|---|---|---|
| sender* | string | Owner of every position (address) |
| chain_id* | integer | string | EVM chain ID |
| withdrawals* | array | One entry per position |
{
"type": "object",
"required": [
"chain_id",
"sender",
"withdrawals"
],
"properties": {
"sender": {
"type": "string",
"description": "Owner of every position (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"withdrawals": {
"type": "array",
"items": {
"type": "object",
"required": [
"positions_address",
"token_id",
"liquidity"
],
"properties": {
"token_id": {
"type": "string",
"description": "Position NFT ID (decimal or 0x-hex integer)"
},
"liquidity": {
"type": "string",
"description": "uint128 liquidity, at most the decoded current-state value (positive decimal integer)"
},
"recipient": {
"type": "string",
"description": "Defaults to sender (address)"
},
"positions_address": {
"type": "string",
"description": "Positions or Ve33Positions manager (address)"
}
}
},
"minItems": 1,
"description": "One entry per position"
}
},
"additionalProperties": false
}Compute the exact Q32 boost rates and prepare all token approvals, native value, and boost calldata used by the interface.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| amount0* | string | Total token0 base units over the boost (decimal integer) |
| amount1* | string | Total token1 base units over the boost (decimal integer) |
| chain_id* | integer | string | EVM chain ID |
| end_time* | string | Unix seconds, after start_time (decimal integer) |
| pool_key* | object | PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config |
| start_time* | string | Unix seconds (decimal integer) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"pool_key",
"start_time",
"end_time",
"amount0",
"amount1"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"amount0": {
"type": "string",
"description": "Total token0 base units over the boost (decimal integer)"
},
"amount1": {
"type": "string",
"description": "Total token1 base units over the boost (decimal integer)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"end_time": {
"type": "string",
"description": "Unix seconds, after start_time (decimal integer)"
},
"pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config"
},
"start_time": {
"type": "string",
"description": "Unix seconds (decimal integer)"
}
}
}Prepare one Distributor claim for every Merkl reward token the sender holds on a chain, from amounts and proofs fetched from https://api.merkl.xyz/v4/users/{address}/rewards/summary. The proofs are folded into their Merkle root here, and the read bundle checks it against the root the chain enforces, so Merkl's API need not be trusted. Distinct from prepare_rewards_claim, which claims Ekubo's own incentive drops.
| Argument | Type | Description |
|---|---|---|
| sender* | string | Claiming wallet; the leaf's user address |
| rewards* | array | One entry per reward token on this chain, all in one claim |
| chain_id* | integer | string | From the Merkl rewards summary |
{
"type": "object",
"required": [
"chain_id",
"sender",
"rewards"
],
"properties": {
"sender": {
"type": "string",
"description": "Claiming wallet; the leaf's user address"
},
"rewards": {
"type": "array",
"items": {
"type": "object",
"required": [
"token",
"amount",
"proofs"
],
"properties": {
"token": {
"type": "string",
"description": "Reward token address exactly as Merkl returned it"
},
"amount": {
"type": "string",
"description": "Merkl's cumulative amount, unchanged; not the claimable delta (positive decimal integer)"
},
"proofs": {
"type": "array",
"items": {
"type": "string",
"description": "bytes32 hex"
},
"description": "Merkl's proofs, in order, unchanged"
}
}
},
"minItems": 1,
"description": "One entry per reward token on this chain, all in one claim"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "From the Merkl rewards summary"
}
}
}Prepare an exact-approval Morpho Vault V2 deposit through the official SDK's VaultBundlesV1 route. The caller supplies a fresh RAY-scaled max share price, which is enforced onchain against ERC-4626 share-price inflation; shares are minted to the sender and the server performs no data fetch.
| Argument | Type | Description |
|---|---|---|
| vault* | string | Exact Morpho Vault V2 address returned by get_morpho_vaults |
| amount* | string | Positive underlying-asset amount in base units (positive decimal integer) |
| sender* | string | Wallet that will execute the Morpho action (address) |
| chain_id* | integer | string | Chain returned by get_morpho_vaults |
| deadline | string | Unix timestamp after which VaultBundlesV1 rejects the deposit; defaults to two hours after preparation. One already past makes the plan a guaranteed revert. (positive decimal integer) |
| recipient | string | Vault-share recipient; must equal sender if supplied, because VaultBundlesV1 mints shares only to the transaction sender (address) |
| max_share_price_ray |
Prepare a direct Morpho Vault V2 redemption for an exact share amount. Prefer redeem for full exits so the user's complete fresh share balance can be bound without asset/share rounding dust.
| Argument | Type | Description |
|---|---|---|
| owner | string | Vault-share owner; defaults to sender (address) |
| vault* | string | Exact Morpho Vault V2 address returned by get_morpho_vaults |
| sender* | string | Wallet that will execute the Morpho action (address) |
| shares* | string | Exact vault-share amount to redeem in base units (positive decimal integer) |
| chain_id* | integer | string | Chain returned by get_morpho_vaults |
| recipient | string | Underlying-asset recipient; defaults to sender (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"vault",
"shares"
],
"properties": {
"owner": {
"type": "string",
"description": "Vault-share owner; defaults to sender (address)"
},
"vault": {
"type": "string",
"description": "Exact Morpho Vault V2 address returned by get_morpho_vaults"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Morpho action (address)"
},
"shares": {
"type": "string",
"description": "Exact vault-share amount to redeem in base units (positive decimal integer)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain returned by get_morpho_vaults"
},
"recipient": {
"type": "string",
"description": "Underlying-asset recipient; defaults to sender (address)"
}
}
}Prepare a direct Morpho Vault V2 withdrawal for an exact underlying-asset amount from a fixed vault. Current shares, liquidity, permissions, and vault state are established by direct agent discovery and exact wallet simulation.
| Argument | Type | Description |
|---|---|---|
| owner | string | Vault-share owner; defaults to sender (address) |
| vault* | string | Exact Morpho Vault V2 address returned by get_morpho_vaults |
| amount* | string | Exact underlying-asset amount to withdraw in base units (positive decimal integer) |
| sender* | string | Wallet that will execute the Morpho action (address) |
| chain_id* | integer | string | Chain returned by get_morpho_vaults |
| recipient | string | Underlying-asset recipient; defaults to sender (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"vault",
"amount"
],
"properties": {
"owner": {
"type": "string",
"description": "Vault-share owner; defaults to sender (address)"
},
"vault": {
"type": "string",
"description": "Exact Morpho Vault V2 address returned by get_morpho_vaults"
},
"amount": {
"type": "string",
"description": "Exact underlying-asset amount to withdraw in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Morpho action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain returned by get_morpho_vaults"
},
"recipient": {
"type": "string",
"description": "Underlying-asset recipient; defaults to sender (address)"
}
}
}Prepare the interface's permissionless Oracle expandCapacity call for one ERC-20 token.
| Argument | Type | Description |
|---|---|---|
| token* | string | Token; zero address = native |
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| min_capacity* | integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"token",
"min_capacity"
],
"properties": {
"token": {
"type": "string",
"description": "Token; zero address = native"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"min_capacity": {
"type": "integer",
"minimum": 0
}
}
}Prepare one permissionless maybeInitializePool transaction for a v3 PoolKey and initial tick; prepare_lp_position_deposit with pool_initialized=false does the same atomically with the mint.
| Argument | Type | Description |
|---|---|---|
| sender* | string | Submitting wallet (address) |
| chain_id* | integer | string | EVM chain ID |
| pool_key* | object | Pool to initialize. PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config |
| core_address* | string | v3 Core address |
| initial_tick* | integer | The first initialization permanently sets the price |
{
"type": "object",
"required": [
"chain_id",
"sender",
"core_address",
"pool_key",
"initial_tick"
],
"properties": {
"sender": {
"type": "string",
"description": "Submitting wallet (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"pool_key": {
"type": "object",
"description": "Pool to initialize. PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config"
},
"core_address": {
"type": "string",
"description": "v3 Core address"
},
"initial_tick": {
"type": "integer",
"description": "The first initialization permanently sets the price"
}
}
}Prepare the exact selected ended-order collections, protocol-fee withdrawals, and token rolls in interface order within one atomic batch of decodable steps.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| roll_tokens* | array | |
| protocol_fee_pairs* | array | |
| ended_order_collects* | array |
{
"type": "object",
"required": [
"chain_id",
"sender",
"ended_order_collects",
"protocol_fee_pairs",
"roll_tokens"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"roll_tokens": {
"type": "array",
"items": {
"type": "string",
"description": "address"
}
},
"protocol_fee_pairs": {
"type": "array",
"items": {
"type": "object",
"required": [
"token0",
"token1"
],
"properties": {
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
}
}
}
},
"ended_order_collects": {
"type": "array",
"items": {
"type": "object",
"required": [
"sell_token",
"fee",
"end_time"
],
"properties": {
"fee": {
"type": "string",
"description": "decimal integer"
},
"end_time": {
"type": "string",
"description": "decimal integer"
},
"sell_token": {
"type": "string",
"description": "address"
}
}
}
}
}
}Prepare one Incentives claim or the interface's allow-failure Multicall3 aggregate for multiple claims.
| Argument | Type | Description |
|---|---|---|
| claims* | array | |
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
{
"type": "object",
"required": [
"chain_id",
"sender",
"claims"
],
"properties": {
"claims": {
"type": "array",
"items": {
"type": "object",
"required": [
"drop_address",
"key",
"claim",
"proof"
],
"properties": {
"key": {
"type": "object",
"required": [
"owner",
"token",
"root"
],
"properties": {
"root": {
"type": "string",
"description": "bytes32 hex"
},
"owner": {
"type": "string",
"description": "address"
},
"token": {
"type": "string",
"description": "address"
}
}
},
"claim": {
"type": "object",
"required": [
"index",
"account",
"amount"
],
"properties": {
"index": {
"type": "string",
"description": "decimal integer"
},
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"account": {
"type": "string",
"description": "address"
}
}
},
"proof": {
"type": "array",
"items": {
"type": "string",
"description": "bytes32 hex"
}
},
"drop_address": {
"type": "string",
"description": "address"
}
}
},
"minItems": 1
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
}
}
}Prepare an exact USDS approval, ERC-4626 sUSDS deposit, and allowance cleanup as one atomic wallet plan. The direct vault interface has no minimum-shares or deadline field, so a fresh preview and exact wallet simulation are mandatory.
| Argument | Type | Description |
|---|---|---|
| amount* | string | Exact USDS deposit amount in base units (positive decimal integer) |
| sender* | string | Wallet that will execute the Sky savings action (address) |
| chain_id* | integer | string | Must be Ethereum chain 1 |
| receiver | string | sUSDS recipient; defaults to sender (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Exact USDS deposit amount in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Sky savings action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Must be Ethereum chain 1"
},
"receiver": {
"type": "string",
"description": "sUSDS recipient; defaults to sender (address)"
}
}
}Prepare a direct sUSDS ERC-4626 redemption for an exact share amount. Use a fresh wallet/RPC balance and preview, then require exact wallet simulation before authorization.
| Argument | Type | Description |
|---|---|---|
| owner | string | sUSDS owner; defaults to sender (address) |
| sender* | string | Wallet that will execute the Sky savings action (address) |
| shares* | string | Exact sUSDS share amount to redeem in base units (positive decimal integer) |
| chain_id* | integer | string | Must be Ethereum chain 1 |
| receiver | string | USDS recipient; defaults to sender (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"shares"
],
"properties": {
"owner": {
"type": "string",
"description": "sUSDS owner; defaults to sender (address)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Sky savings action (address)"
},
"shares": {
"type": "string",
"description": "Exact sUSDS share amount to redeem in base units (positive decimal integer)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Must be Ethereum chain 1"
},
"receiver": {
"type": "string",
"description": "USDS recipient; defaults to sender (address)"
}
}
}Prepare a direct sUSDS ERC-4626 withdrawal for an exact USDS amount. The server does not query current exchange rate, capacity, balance, allowance, or preview state.
| Argument | Type | Description |
|---|---|---|
| owner | string | sUSDS owner; defaults to sender (address) |
| amount* | string | Exact USDS amount to withdraw in base units (positive decimal integer) |
| sender* | string | Wallet that will execute the Sky savings action (address) |
| chain_id* | integer | string | Must be Ethereum chain 1 |
| receiver | string | USDS recipient; defaults to sender (address) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"amount"
],
"properties": {
"owner": {
"type": "string",
"description": "sUSDS owner; defaults to sender (address)"
},
"amount": {
"type": "string",
"description": "Exact USDS amount to withdraw in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Sky savings action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Must be Ethereum chain 1"
},
"receiver": {
"type": "string",
"description": "USDS recipient; defaults to sender (address)"
}
}
}Prepare one atomic-capable plan of 1 to 4,096 ordered native, ERC-20, ERC-721 and ERC-1155 transfers on one EVM chain, mixed freely. Returns a compact summary and the execution_plan_reference.
| Argument | Type | Description |
|---|---|---|
| sender* | string | Nonzero owner of every asset (address) |
| chain_id* | integer | string | EVM chain ID |
| transfers* | array | One to 4096 ordered, optionally mixed native, ERC-20, ERC-721, or ERC-1155 transfers |
{
"type": "object",
"required": [
"chain_id",
"sender",
"transfers"
],
"properties": {
"sender": {
"type": "string",
"description": "Nonzero owner of every asset (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"transfers": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"kind",
"recipient",
"amount"
],
"properties": {
"kind": {
"type": "string",
"const": "native"
},
"amount": {
"type": "string",
"description": "Wei (positive decimal integer)"
},
"recipient": {
"type": "string",
"description": "Nonzero recipient address"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"token",
"recipient",
"amount"
],
"properties": {
"kind": {
"type": "string",
"const": "erc20"
},
"token": {
"type": "string",
"description": "Nonzero token contract address"
},
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"recipient": {
"type": "string",
"description": "Nonzero recipient address"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"token",
"recipient",
"token_id"
],
"properties": {
"data": {
"type": "string",
"description": "Receiver callback data for the four-argument safeTransferFrom; not with safe=false (hex bytes)"
},
"kind": {
"type": "string",
"const": "erc721"
},
"safe": {
"type": "boolean",
"description": "safeTransferFrom by default; false uses transferFrom"
},
"token": {
"type": "string",
"description": "Nonzero token contract address"
},
"token_id": {
"type": "string",
"description": "Token ID; zero is valid (decimal integer)"
},
"recipient": {
"type": "string",
"description": "Nonzero recipient address"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"token",
"recipient",
"token_id",
"amount"
],
"properties": {
"data": {
"type": "string",
"description": "Receiver callback data; defaults to empty (0x) (hex bytes)"
},
"kind": {
"type": "string",
"const": "erc1155"
},
"safe": {
"type": "boolean",
"const": true,
"description": "ERC-1155 has no unsafe transfer"
},
"token": {
"type": "string",
"description": "Nonzero token contract address"
},
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"token_id": {
"type": "string",
"description": "Token ID; zero is valid (decimal integer)"
},
"recipient": {
"type": "string",
"description": "Nonzero recipient address"
}
},
"additionalProperties": false
}
]
},
"minItems": 1,
"description": "One to 4096 ordered, optionally mixed native, ERC-20, ERC-721, or ERC-1155 transfers"
}
},
"additionalProperties": false
}Prepare one or more TWAMM order splits with approvals and native value as one atomic batch. details.token_id is the order's id before anything is sent: keep it, because prepare_twamm_order_collection and prepare_twamm_order_stop are keyed by it and orders are not enumerable by owner. Start and end times must be multiples of 256 seconds near the present, widening in powers of 16 further out.
| Argument | Type | Description |
|---|---|---|
| salt | string | Fixes the order's token id; omit to derive it from the request. Supply one only when identical orders need distinct ids (bytes32 hex) |
| orders* | array | |
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| buy_token* | string | Token; zero address = native |
| sell_token* | string | Token; zero address = native |
| deadline_seconds | integer | |
| pending_timestamp |
Prepare collection of every selected order key through the exact current or legacy Orders manager, as one atomic batch of decodable steps, with pending owner validation.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| token_id* | string | decimal or 0x-hex integer |
| order_keys* | array | |
| orders_address* | string | address |
{
"type": "object",
"required": [
"chain_id",
"sender",
"orders_address",
"token_id",
"order_keys"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"token_id": {
"type": "string",
"description": "decimal or 0x-hex integer"
},
"order_keys": {
"type": "array",
"items": {
"type": "object",
"description": "PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config"
},
"minItems": 1
},
"orders_address": {
"type": "string",
"description": "address"
}
}
}Prepare the interface's complete stop flow: collect every selected order and decrease every still-active sale rate in one atomic batch of decodable steps.
| Argument | Type | Description |
|---|---|---|
| orders* | array | |
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| token_id* | string | decimal or 0x-hex integer |
| orders_address* | string | address |
| pending_timestamp* | string | decimal integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"orders_address",
"token_id",
"pending_timestamp",
"orders"
],
"properties": {
"orders": {
"type": "array",
"items": {
"type": "object",
"required": [
"order_key",
"end_time",
"sale_rate"
],
"properties": {
"end_time": {
"type": "string",
"description": "decimal integer"
},
"order_key": {
"type": "object",
"description": "PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config"
},
"sale_rate": {
"type": "string",
"description": "decimal integer"
}
}
},
"minItems": 1
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"token_id": {
"type": "string",
"description": "decimal or 0x-hex integer"
},
"orders_address": {
"type": "string",
"description": "address"
},
"pending_timestamp": {
"type": "string",
"description": "decimal integer"
}
}
}Prepare the permissionless lockAndExecuteVirtualOrders maintenance call for a current or legacy TWAMM pool.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| pool_key* | object | PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config |
{
"type": "object",
"required": [
"chain_id",
"sender",
"pool_key"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config"
}
}
}Return exact wallet read bundles for pool state, reserves, positions and ownership. V3 supports bounded owner-index enumeration. V4 requires known token IDs. Verify returned tokens, fee, factory/pool key, tick spacing and owner before preparing liquidity operations.
| Argument | Type | Description |
|---|---|---|
| fee | integer | |
| hooks | string | address |
| owner | string | address |
| token0* | string | address |
| token1* | string | address |
| version* | string | |
| chain_id* | string | |
| token_ids | array | |
| pool_address | string | address |
| tick_spacing |
Add liquidity or create a V2 pair with exact token approvals and cleanup. Amounts are raw units; sorted token0/token1 and explicit minimum outputs are required. use_native pays ETH for the wrapped-native side. Execute atomically through the wallet.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| token0* | string | address |
| token1* | string | address |
| amount0* | string | decimal integer |
| amount1* | string | decimal integer |
| chain_id* | string | |
| deadline* | string | decimal integer |
| use_native | boolean | |
| amount0_min* |
Burn an exact LP amount through the canonical V2 router; realize accrued fees with principal. Raw minima protect withdrawal proceeds. LP token address is derived from the factory. Optional native unwrapping. V2 has no separate fee claim. Requires atomic LP approval and cleanup.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| token0* | string | address |
| token1* | string | address |
| chain_id* | string | |
| deadline* | string | decimal integer |
| liquidity* | string | decimal integer |
| amount0_min* | string | decimal integer |
| amount1_min* | string | decimal integer |
Mint a ranged NFT or increase token_id with raw desired amounts and minima. First verify factory fee tick spacing and position tokens/range. Optional initialize_sqrt_price_x96 creates the pool; use_native pays ETH and refunds excess. Exact approvals and cleanup require an atomic wallet.
| Argument | Type | Description |
|---|---|---|
| fee* | integer | |
| sender* | string | address |
| token0* | string | address |
| token1* | string | address |
| amount0* | string | decimal integer |
| amount1* | string | decimal integer |
| chain_id* | string | |
| deadline* | string | decimal integer |
| token_id |
Collect all owed fees without removing liquidity, optionally unwrapping WETH. Verify NFT ownership and currencies first. V3 collect has no onchain deadline; regenerate and simulate before execution.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| token0* | string | address |
| token1* | string | address |
| chain_id* | string | |
| deadline* | string | decimal integer |
| token_id* | string | decimal integer |
| unwrap_native | boolean |
{
"type": "object",
"required": [
"chain_id",
"sender",
"deadline",
"token0",
"token1",
"token_id"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"deadline": {
"type": "string",
"description": "decimal integer"
},
"token_id": {
"type": "string",
"description": "decimal integer"
},
"unwrap_native": {
"type": "boolean",
"default": false
}
}
}Decrease exact uint128 liquidity, collect principal and all accrued fees, and optionally burn a fully emptied NFT. Raw minima protect withdrawal proceeds. Optional unwrap_native requires verified position currencies.
| Argument | Type | Description |
|---|---|---|
| burn | boolean | |
| sender* | string | address |
| token0* | string | address |
| token1* | string | address |
| chain_id* | string | |
| deadline* | string | decimal integer |
| token_id* | string | decimal integer |
| liquidity* | string | decimal integer |
| amount0_min* | string |
Mint or increase an exact liquidity amount using raw uint128 token maxima. Zero token0 means native ETH. Uses exact ERC20 and Permit2 approvals with cleanup, settles both signs of accrued-fee deltas on increase, and refunds native surplus. Verify NFT pool key/range and hook behavior; hook_data is forwarded unchanged. Optional pool initialization.
| Argument | Type | Description |
|---|---|---|
| fee* | integer | |
| hooks | string | address |
| sender* | string | address |
| token0* | string | address |
| token1* | string | address |
| pool_id* | string | bytes32 hex |
| chain_id* | string | |
| deadline* | string | decimal integer |
Poke a V4 position with zero liquidity decrease then take both currencies to the sender. Principal remains invested. Verify ownership, pool key and hook behavior first.
| Argument | Type | Description |
|---|---|---|
| fee* | integer | |
| hooks | string | address |
| sender* | string | address |
| token0* | string | address |
| token1* | string | address |
| pool_id* | string | bytes32 hex |
| chain_id* | string | |
| deadline* | string | decimal integer |
| token_id* | string | decimal integer |
Remove liquidity and take principal plus fees to the sender. Optional burn:true requires liquidity:0 and withdraws the entire NFT with minima applied to the full position. Requires exact pool currencies and hook data; uint128 minima bound principal outputs.
| Argument | Type | Description |
|---|---|---|
| fee* | integer | |
| burn | boolean | |
| hooks | string | address |
| sender* | string | address |
| token0* | string | address |
| token1* | string | address |
| pool_id* | string | bytes32 hex |
| chain_id* | string | |
| deadline* | string | decimal integer |
Discover every active vote on VeTokens owned by the sender and generate one atomic batch of decodable VeToken steps claiming all indexed pool fees, with ownerOf and voteState validation calldata. Fees only: votes, stake amounts, lock ends, and NFT ownership are all unchanged.
| Argument | Type | Description |
|---|---|---|
| sender* | string | Owner whose indexed VeTokens and active votes should be discovered (address) |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| recipient | string | Fee recipient; defaults to sender for claimPoolFeesToSelf (address) |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender"
],
"properties": {
"sender": {
"type": "string",
"description": "Owner whose indexed VeTokens and active votes should be discovered (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"recipient": {
"type": "string",
"description": "Fee recipient; defaults to sender for claimPoolFeesToSelf (address)"
}
}
}Generate one call, or an atomic batch of decodable VeToken steps, claiming voter fees from one or more ve-tokens. Fees only: votes, stake amounts, lock ends, and NFT ownership are all unchanged, so this is always safe to run before any other ve(3,3) action.
| Argument | Type | Description |
|---|---|---|
| claims* | array | |
| sender* | string | address |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| recipient | string | address |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"claims"
],
"properties": {
"claims": {
"type": "array",
"items": {
"type": "object",
"required": [
"ve_id",
"pool_key"
],
"properties": {
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
}
}
},
"minItems": 1
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"recipient": {
"type": "string",
"description": "address"
}
}
}Remove the active vote from one or more ve-tokens, claiming each stake's current pool fees immediately before its clearVote in one atomic batch. Use this instead of raw clearVote calldata: Ve33 discards pending voter fees when a stake's weight goes to zero, and a current_pool_key that is not the stake's active pool reverts the whole batch. Stake amount, lock end and NFT ownership are untouched; the stake stops directing emissions and earning that pool's voter fees. Prefer prepare_ve33_reallocation when votes move to other pools. See ekubo://docs/ve33-workflow.
| Argument | Type | Description |
|---|---|---|
| votes* | array | |
| sender* | string | address |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| recipient | string | Fee recipient; defaults to sender for claimPoolFeesToSelf (address) |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"votes"
],
"properties": {
"votes": {
"type": "array",
"items": {
"type": "object",
"required": [
"ve_id",
"current_pool_key"
],
"properties": {
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"current_pool_key": {
"type": "object",
"description": "The pool this stake currently votes for. Required: its fees are claimed immediately before the clear, and a key that is not the stake's active pool reverts the whole batch before anything is cleared. PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
}
}
},
"minItems": 1
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"recipient": {
"type": "string",
"description": "Fee recipient; defaults to sender for claimPoolFeesToSelf (address)"
}
}
}Prepare a direct extension for an unvoted VeToken or an atomic claim-and-extend call when current_pool_key identifies an active vote, so pending voter fees are preserved. Extending moves the stake to a later end time and clears its vote — that is why the claim is compounded into the same call. A stake's end time only ever moves later, here and everywhere else in Ve33. No NFT is burned and no stake leaves the wallet; re-vote afterwards with prepare_ve33_vote. max_duration=true must be the user's explicit choice.
| Argument | Type | Description |
|---|---|---|
| ve_id* | string | decimal integer |
| sender* | string | address |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| max_duration | boolean | |
| current_pool_key | object | Active pool key when voted; the MCP claims fees atomically before extension. Omit only for an unvoted VeToken. PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote |
Prepare the exact approval/native value and increaseStakeAmount call while preserving the existing vote and fee accounting. Non-destructive: the vote is resized rather than cleared, no fees are discarded, and no NFT is burned. The added stake takes the NFT's existing lock end, so it cannot be withdrawn before that time.
| Argument | Type | Description |
|---|---|---|
| ve_id* | string | decimal integer |
| amount* | string | Base units (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| stake_token* | string | address |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"stake_token",
"ve_id",
"amount"
],
"properties": {
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"stake_token": {
"type": "string",
"description": "address"
}
}
}Prepare fee-safe merging of one or more source NFTs into a destination, including required claims and the selected resulting vote in one atomic batch of decodable steps. Destructive to the sources: each source's stake moves to the destination, its vote is cleared, and the source NFT is burned, so its fees are claimed first and its ID is reported in the plan. The destination keeps its own lock end, which is why no source may end later than it.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| sources* | array | |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| resulting_vote | object | null | |
| destination_ve_id* | string | decimal integer |
| destination_pool_key | object | PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote |
Compile a reviewed current allocation into at most 25 target pool-weight shares as one atomic batch of decodable VeToken steps. The default path only claims, splits, and votes: nothing is burned, no lock is extended, and nothing is withdrawn. The optional compact_max_lock strategy fee-safely consolidates active NFTs, extends the survivor to four years, then creates exactly one voting NFT per target; it burns every merged source NFT and lengthens the lock, and explicitly discloses both. Show the get_ve33_allocations result first and pass its exact state_id; hand the wallet the survivor, every burned source, the extension, and the decoded calls. See ekubo://docs/ve33-workflow.
| Argument | Type | Description |
|---|---|---|
| sender* | string | VeToken owner that will execute the atomic batch (address) |
| targets* | array | At most 25 targets. compact_max_lock creates one final voting VeToken per target; preserve_existing_locks may require multiple NFTs per target to keep expiry-cohort decay proportional. |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| strategy | string | Defaults to preserve_existing_locks. compact_max_lock explicitly claims fees, consolidates active stake into one surviving NFT, extends it to four years, then creates exactly one voting NFT per target; redundant source NFT IDs are burned. |
| ve_token |
Build the safe phased workflow for 'reinvest my fees': automatically claim all active voter fees, prepare one exact-input swap per claimed non-stake token, then increase one VeToken or every existing active allocation without changing ownership or replacing votes. phase=swap returns jurisdiction metadata inline on the result and on every child swap; it is not permission to trade. For a nonempty restricted_jurisdictions list, follow its execution_notice before requesting any signature. Phases run in order after each confirms: claim (omit claims to discover every active allocation; keep the pre-claim balance snapshots), swap with only the exact claimed deltas, never a pre-existing balance, then stake_all with the refreshed state_id and the measured STONX output.
| Argument | Type | Description |
|---|---|---|
| phase* | string | |
| ve_id | string | decimal integer |
| amount | string | Stake token base units (decimal integer) |
| claims | array | |
| sender* | string | address |
| source | string | |
| chain_id* | integer | string |
Split a source ve-token with an explicit salt and return the deterministic child token ID; the source vote is preserved with reduced weight and the child starts unvoted with the same lock end. Non-destructive: no stake leaves the wallet, no NFT is burned, no vote is cleared, and no fees are discarded.
| Argument | Type | Description |
|---|---|---|
| salt* | string | bytes32 hex |
| ve_id* | string | decimal integer |
| amount* | string | Base units (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"ve_id",
"amount",
"salt"
],
"properties": {
"salt": {
"type": "string",
"description": "bytes32 hex"
},
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
}
}
}Create a new VeToken stake with an exact stake-token approval. Max duration is the safe default for new stakes; an explicit shorter duration is optional and no existing NFT, vote, fee balance, or ownership is changed.
| Argument | Type | Description |
|---|---|---|
| salt* | string | User-selected salt for a deterministic, replay-detectable VeToken ID (bytes32 hex) |
| amount* | string | Base units (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| stake_token* | string | address |
| max_duration | boolean | Defaults to true when duration_seconds is omitted; set false only with an explicit duration_seconds |
| duration_seconds | integer |
Compile one actively voted ve-token into multiple allocations. Unconditionally claims its current pool first, then splits and changes votes in one atomic batch of decodable VeToken steps. Nothing is burned, withdrawn, or transferred: the source keeps a stake and every additional allocation is a newly minted NFT with the same lock end. Prefer the portfolio reallocation workflow for complete state validation.
| Argument | Type | Description |
|---|---|---|
| sender* | string | address |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| salt_nonce* | string | User-selected nonce used to derive deterministic, replay-detectable split salts (bytes32 hex) |
| allocations* | array | |
| current_vote* | object | Required active indexed vote; its pool is claimed unconditionally before any split, clear, or replacement vote |
| source_ve_id* |
Prepare fee-safe withdrawal of an expired ve-token stake, claiming the active pool first when voted and returning pending owner/stake validation. Ends the position: the stake leaves Ve33 and returns to the owner and the vote is cleared. Only an expired stake can be withdrawn — Ve33 reverts with StakeNotExpired at any earlier time, and there is no early exit or penalty path.
| Argument | Type | Description |
|---|---|---|
| ve_id* | string | decimal integer |
| sender* | string | address |
| chain_id* | integer | string | With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| current_pool_key | object | PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"ve_id"
],
"properties": {
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"current_pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
}
}
}Prepare a direct wrapped-native deposit or withdrawal on a chain with a verified wrapped native token. The response names the wrapped token, which is not WETH everywhere (BNB Chain wraps BNB, Polygon POL, Monad MON).
| Argument | Type | Description |
|---|---|---|
| amount* | string | Base units (positive decimal integer) |
| sender* | string | address |
| chain_id* | integer | string | EVM chain ID |
| direction* | string |
{
"type": "object",
"required": [
"chain_id",
"sender",
"direction",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"direction": {
"enum": [
"wrap",
"unwrap"
],
"type": "string"
}
}
}Calculate V3/V4 range liquidity, rounded mint/burn amounts and explicit token bounds from a current sqrt-price snapshot and raw token budgets, or an exact liquidity amount. Fees are excluded. Obtain current state using prepare_uniswap_reads.
| Argument | Type | Description |
|---|---|---|
| amount0* | string | decimal integer |
| amount1* | string | decimal integer |
| liquidity | string | decimal integer |
| tick_lower* | integer | |
| tick_upper* | integer | |
| slippage_bps | integer | |
| tick_spacing* | integer | |
| sqrt_price_x96* | string | decimal integer |
We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 4, 2026.
Takes a password, API key or token as an argument, so the secret passes through the model's context and chat logs.
Fix: Read credentials from the server's own configuration (environment, OAuth) instead of a tool argument.
| Transaction sender; pass with exactly one of slippage_bps or max_output_loss for plans (address) |
| chain_id* | integer | string | EVM chain ID |
| token_in* | string | Raw EVM address or CAIP-10 eip155:<chain_id>:<address>; all-zeroes denotes the native token |
| recipient | string | Defaults to sender (address) |
| token_out* | string | Raw EVM address or CAIP-10 eip155:<chain_id>:<address>; all-zeroes denotes the native token |
| quote_type* | string |
| slippage_bps | integer | Whole-bps calldata bound: 0.1% = 10. With sender supply this OR max_output_loss. Honor user preference; size near gas value / notional * 10,000. For positive sub-bps budgets use max_output_loss, not 0 or 1 bps. No generic 50 bps default. After slippage failure re-quote, never widen or retry reverted bytes. |
| max_output_loss | string | Exact-input loss budget from quoted output, output-token base units as a decimal integer string; requires sender, omit slippage_bps. Ekubo: exact subtraction. 0x: two quotes, floor budget to whole ppm, verify final minBuyAmount; positive budgets below 1 ppm fail, never become zero. Others unsupported. Convert gas value to output base units rounding down; never widen to 1 bps. |
| include_raw_quotes | boolean | Echo raw provider responses; only to diagnose a provider |
| destination_chain_id | integer | string | Destination chain; defaults to chain_id for a same-chain swap |
| swap_deadline_minutes | integer | Ekubo router route deadline; default 30 |
{
"type": "object",
"required": [
"chain_id",
"token_in",
"token_out",
"quote_type",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Transaction sender; pass with exactly one of slippage_bps or max_output_loss for plans (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"token_in": {
"type": "string",
"pattern": "^(?:0x[0-9a-fA-F]{1,40}|eip155:[0-9]+:0x[0-9a-fA-F]{1,40})$",
"description": "Raw EVM address or CAIP-10 eip155:<chain_id>:<address>; all-zeroes denotes the native token"
},
"recipient": {
"type": "string",
"description": "Defaults to sender (address)"
},
"token_out": {
"type": "string",
"pattern": "^(?:0x[0-9a-fA-F]{1,40}|eip155:[0-9]+:0x[0-9a-fA-F]{1,40})$",
"description": "Raw EVM address or CAIP-10 eip155:<chain_id>:<address>; all-zeroes denotes the native token"
},
"quote_type": {
"enum": [
"exact_input",
"exact_output"
],
"type": "string"
},
"slippage_bps": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Whole-bps calldata bound: 0.1% = 10. With sender supply this OR max_output_loss. Honor user preference; size near gas value / notional * 10,000. For positive sub-bps budgets use max_output_loss, not 0 or 1 bps. No generic 50 bps default. After slippage failure re-quote, never widen or retry reverted bytes."
},
"max_output_loss": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$",
"description": "Exact-input loss budget from quoted output, output-token base units as a decimal integer string; requires sender, omit slippage_bps. Ekubo: exact subtraction. 0x: two quotes, floor budget to whole ppm, verify final minBuyAmount; positive budgets below 1 ppm fail, never become zero. Others unsupported. Convert gas value to output base units rounding down; never widen to 1 bps."
},
"include_raw_quotes": {
"type": "boolean",
"description": "Echo raw provider responses; only to diagnose a provider"
},
"destination_chain_id": {
"type": [
"integer",
"string"
],
"description": "Destination chain; defaults to chain_id for a same-chain swap"
},
"swap_deadline_minutes": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Ekubo router route deadline; default 30"
}
}
}| string |
| Slippage bound: minimum token_a base units consumed (positive decimal integer) |
| amount_b_min* | string | Minimum token_b base units consumed (positive decimal integer) |
| amount_a_desired* | string | Maximum token_a base units (positive decimal integer) |
| amount_b_desired* | string | Maximum token_b base units (positive decimal integer) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"token_a",
"token_b",
"stable",
"amount_a_desired",
"amount_b_desired",
"amount_a_min",
"amount_b_min",
"deadline"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"stable": {
"type": "boolean",
"description": "Stable (true) or volatile pool; with the pair it identifies the pool"
},
"token_a": {
"type": "string",
"description": "address"
},
"token_b": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
},
"deadline": {
"type": "string",
"description": "Near-term unix timestamp; a past one makes the plan revert (positive decimal integer)"
},
"recipient": {
"type": "string",
"description": "Defaults to sender (address)"
},
"amount_a_min": {
"type": "string",
"description": "Slippage bound: minimum token_a base units consumed (positive decimal integer)"
},
"amount_b_min": {
"type": "string",
"description": "Minimum token_b base units consumed (positive decimal integer)"
},
"amount_a_desired": {
"type": "string",
"description": "Maximum token_a base units (positive decimal integer)"
},
"amount_b_desired": {
"type": "string",
"description": "Maximum token_b base units (positive decimal integer)"
}
}
}| liquidity* | string | Exact LP token amount to burn in base units (positive decimal integer) |
| recipient | string | Defaults to sender (address) |
| amount_a_min* | string | Minimum token_a base units to receive (positive decimal integer) |
| amount_b_min* | string | Minimum token_b base units to receive (positive decimal integer) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"token_a",
"token_b",
"stable",
"liquidity",
"amount_a_min",
"amount_b_min",
"deadline"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"stable": {
"type": "boolean",
"description": "Stable (true) or volatile pool"
},
"token_a": {
"type": "string",
"description": "address"
},
"token_b": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
},
"deadline": {
"type": "string",
"description": "Near-term unix timestamp; a past one makes the plan revert (positive decimal integer)"
},
"lp_token": {
"type": "string",
"description": "Pool address from this tool's first-phase read; omit to get that read, supply it for the full plan"
},
"liquidity": {
"type": "string",
"description": "Exact LP token amount to burn in base units (positive decimal integer)"
},
"recipient": {
"type": "string",
"description": "Defaults to sender (address)"
},
"amount_a_min": {
"type": "string",
"description": "Minimum token_a base units to receive (positive decimal integer)"
},
"amount_b_min": {
"type": "string",
"description": "Minimum token_b base units to receive (positive decimal integer)"
}
}
}{
"type": "object",
"required": [
"chain_id",
"sender",
"action"
],
"properties": {
"action": {
"enum": [
"create",
"increase_amount",
"extend",
"lock_permanent",
"unlock_permanent",
"withdraw"
],
"type": "string",
"description": "Which veAERO lock action to build"
},
"amount": {
"type": "string",
"description": "AERO amount in base units; required for create and increase_amount (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Base (8453) only"
},
"venft_id": {
"type": "string",
"description": "veNFT token id; required for every action but create (positive decimal integer)"
},
"lock_duration": {
"type": "string",
"description": "Lock length in seconds measured from now, required for create and extend. The escrow floors it to a week boundary and caps it at four years. (positive decimal integer)"
}
}
}| integer |
| min_boost_duration* | integer |
| graduation_pool_fee_q64* | string | decimal integer |
| graduation_pool_tick_spacing* | integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"sell_token",
"buy_token",
"sell_amount",
"creator_fee_q32",
"min_boost_duration",
"graduation_pool_fee_q64",
"graduation_pool_tick_spacing",
"start_time",
"auction_duration",
"salt"
],
"properties": {
"salt": {
"type": "string",
"description": "bytes32 hex"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"buy_token": {
"type": "string",
"description": "Token; zero address = native"
},
"sell_token": {
"type": "string",
"description": "Token; zero address = native"
},
"start_time": {
"type": "string",
"description": "decimal integer"
},
"sell_amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"creator_fee_q32": {
"type": "string",
"description": "decimal integer"
},
"auction_duration": {
"type": "integer",
"minimum": 0
},
"min_boost_duration": {
"type": "integer",
"minimum": 0
},
"graduation_pool_fee_q64": {
"type": "string",
"description": "decimal integer"
},
"graduation_pool_tick_spacing": {
"type": "integer",
"minimum": 0
}
}
}| pending_current_sqrt_ratio |
| string |
| decimal integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"core_address",
"pool_id",
"base_token",
"target_price"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"pool_id": {
"type": "string",
"description": "decimal or 0x-hex integer"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"base_token": {
"type": "string",
"description": "Token; zero address = native"
},
"core_address": {
"type": "string",
"description": "address"
},
"quote_result": {
"type": "object",
"required": [
"specified_token",
"calculated_token",
"specified_amount",
"calculated_amount"
],
"properties": {
"block_hash": {
"type": "string",
"description": "bytes32 hex"
},
"block_number": {
"type": "string",
"description": "decimal or 0x-hex integer"
},
"specified_token": {
"type": "string",
"description": "Token; zero address = native"
},
"calculated_token": {
"type": "string",
"description": "Token; zero address = native"
},
"specified_amount": {
"type": "string",
"description": "signed decimal integer"
},
"calculated_amount": {
"type": "string",
"description": "signed decimal integer"
}
}
},
"target_price": {
"type": "string",
"pattern": "^(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?|\\.[0-9]+)$"
},
"swap_deadline_minutes": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Ekubo router route deadline; default 30"
},
"pending_current_sqrt_ratio": {
"type": "string",
"description": "decimal integer"
}
}
}| integer |
| tick_upper* | integer |
| max_amount0* | string | Max token0 base units; 0 for single-sided (decimal integer) |
| max_amount1* | string | Max token1 base units; 0 for single-sided (decimal integer) |
| core_address* | string | v3 Core address |
| initial_tick | integer | Uninitialized pool only: initializes at this tick |
| slippage_bps* | integer | User-selected liquidity slippage |
| pool_initialized | boolean | false only for a new pool to initialize here |
{
"type": "object",
"required": [
"chain_id",
"sender",
"core_address",
"tick_lower",
"tick_upper",
"max_amount0",
"max_amount1",
"slippage_bps"
],
"properties": {
"mode": {
"enum": [
"mint_new",
"add_liquidity"
],
"type": "string",
"default": "mint_new"
},
"sender": {
"type": "string",
"description": "address"
},
"pool_id": {
"type": "string",
"description": "Omit when pool_key is supplied (decimal or 0x-hex integer)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"pool_key": {
"type": "object",
"description": "Required for an uninitialized pool. PoolKey {token0, token1, config}: token addresses (zero = native), bytes32 config"
},
"token_id": {
"type": "string",
"description": "add_liquidity only (decimal or 0x-hex integer)"
},
"tick_lower": {
"type": "integer"
},
"tick_upper": {
"type": "integer"
},
"max_amount0": {
"type": "string",
"description": "Max token0 base units; 0 for single-sided (decimal integer)"
},
"max_amount1": {
"type": "string",
"description": "Max token1 base units; 0 for single-sided (decimal integer)"
},
"core_address": {
"type": "string",
"description": "v3 Core address"
},
"initial_tick": {
"type": "integer",
"description": "Uninitialized pool only: initializes at this tick"
},
"slippage_bps": {
"type": "integer",
"maximum": 5000,
"minimum": 1,
"description": "User-selected liquidity slippage"
},
"pool_initialized": {
"type": "boolean",
"description": "false only for a new pool to initialize here"
}
}
}| string |
| Maximum acceptable vault share price in RAY (1e27), derived by the agent from fresh Morpho/onchain vault state plus the user's slippage tolerance (positive decimal integer) |
{
"type": "object",
"required": [
"chain_id",
"sender",
"vault",
"amount",
"max_share_price_ray"
],
"properties": {
"vault": {
"type": "string",
"description": "Exact Morpho Vault V2 address returned by get_morpho_vaults"
},
"amount": {
"type": "string",
"description": "Positive underlying-asset amount in base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "Wallet that will execute the Morpho action (address)"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "Chain returned by get_morpho_vaults"
},
"deadline": {
"type": "string",
"description": "Unix timestamp after which VaultBundlesV1 rejects the deposit; defaults to two hours after preparation. One already past makes the plan a guaranteed revert. (positive decimal integer)"
},
"recipient": {
"type": "string",
"description": "Vault-share recipient; must equal sender if supplied, because VaultBundlesV1 mints shares only to the transaction sender (address)"
},
"max_share_price_ray": {
"type": "string",
"description": "Maximum acceptable vault share price in RAY (1e27), derived by the agent from fresh Morpho/onchain vault state plus the user's slippage tolerance (positive decimal integer)"
}
}
}| string |
| decimal integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"sell_token",
"buy_token",
"orders",
"pending_timestamp"
],
"properties": {
"salt": {
"type": "string",
"description": "Fixes the order's token id; omit to derive it from the request. Supply one only when identical orders need distinct ids (bytes32 hex)"
},
"orders": {
"type": "array",
"items": {
"type": "object",
"required": [
"fee",
"start_time",
"end_time",
"amount"
],
"properties": {
"fee": {
"type": "string",
"description": "decimal integer"
},
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"end_time": {
"type": "string",
"description": "decimal integer"
},
"start_time": {
"type": "string",
"description": "decimal integer"
}
}
},
"minItems": 1
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "EVM chain ID"
},
"buy_token": {
"type": "string",
"description": "Token; zero address = native"
},
"sell_token": {
"type": "string",
"description": "Token; zero address = native"
},
"deadline_seconds": {
"type": "integer",
"default": 120,
"maximum": 3600,
"minimum": 0
},
"pending_timestamp": {
"type": "string",
"description": "decimal integer"
}
}
}| integer |
| owner_indices | array |
{
"type": "object",
"required": [
"chain_id",
"version",
"token0",
"token1"
],
"properties": {
"fee": {
"type": "integer",
"default": 3000,
"minimum": 0
},
"hooks": {
"type": "string",
"description": "address"
},
"owner": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"version": {
"enum": [
"v2",
"v3",
"v4"
],
"type": "string"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"token_ids": {
"type": "array",
"items": {
"type": "string",
"description": "decimal integer"
},
"default": []
},
"pool_address": {
"type": "string",
"description": "address"
},
"tick_spacing": {
"type": "integer",
"default": 60,
"maximum": 32767,
"minimum": 1
},
"owner_indices": {
"type": "array",
"items": {
"type": "string",
"description": "decimal integer"
},
"default": []
}
}
}| string |
| decimal integer |
| amount1_min* | string | decimal integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"deadline",
"token0",
"token1",
"amount0",
"amount1",
"amount0_min",
"amount1_min"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"amount0": {
"type": "string",
"description": "decimal integer"
},
"amount1": {
"type": "string",
"description": "decimal integer"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"deadline": {
"type": "string",
"description": "decimal integer"
},
"use_native": {
"type": "boolean",
"default": false
},
"amount0_min": {
"type": "string",
"description": "decimal integer"
},
"amount1_min": {
"type": "string",
"description": "decimal integer"
}
}
}| unwrap_native |
| boolean |
{
"type": "object",
"required": [
"chain_id",
"sender",
"deadline",
"token0",
"token1",
"liquidity",
"amount0_min",
"amount1_min"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"deadline": {
"type": "string",
"description": "decimal integer"
},
"liquidity": {
"type": "string",
"description": "decimal integer"
},
"amount0_min": {
"type": "string",
"description": "decimal integer"
},
"amount1_min": {
"type": "string",
"description": "decimal integer"
},
"unwrap_native": {
"type": "boolean",
"default": false
}
}
}| string |
| decimal integer |
| tick_lower* | integer |
| tick_upper* | integer |
| use_native | boolean |
| amount0_min* | string | decimal integer |
| amount1_min* | string | decimal integer |
| tick_spacing* | integer |
| initialize_sqrt_price_x96 | string | decimal integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"deadline",
"token0",
"token1",
"amount0",
"amount1",
"amount0_min",
"amount1_min",
"tick_lower",
"tick_upper",
"tick_spacing",
"fee"
],
"properties": {
"fee": {
"type": "integer",
"minimum": 1
},
"sender": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"amount0": {
"type": "string",
"description": "decimal integer"
},
"amount1": {
"type": "string",
"description": "decimal integer"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"deadline": {
"type": "string",
"description": "decimal integer"
},
"token_id": {
"type": "string",
"description": "decimal integer"
},
"tick_lower": {
"type": "integer"
},
"tick_upper": {
"type": "integer"
},
"use_native": {
"type": "boolean",
"default": false
},
"amount0_min": {
"type": "string",
"description": "decimal integer"
},
"amount1_min": {
"type": "string",
"description": "decimal integer"
},
"tick_spacing": {
"type": "integer",
"maximum": 32767,
"minimum": 1
},
"initialize_sqrt_price_x96": {
"type": "string",
"description": "decimal integer"
}
}
}| decimal integer |
| amount1_min* | string | decimal integer |
| unwrap_native | boolean |
{
"type": "object",
"required": [
"chain_id",
"sender",
"deadline",
"token0",
"token1",
"token_id",
"liquidity",
"amount0_min",
"amount1_min"
],
"properties": {
"burn": {
"type": "boolean",
"default": false
},
"sender": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"deadline": {
"type": "string",
"description": "decimal integer"
},
"token_id": {
"type": "string",
"description": "decimal integer"
},
"liquidity": {
"type": "string",
"description": "decimal integer"
},
"amount0_min": {
"type": "string",
"description": "decimal integer"
},
"amount1_min": {
"type": "string",
"description": "decimal integer"
},
"unwrap_native": {
"type": "boolean",
"default": false
}
}
}| token_id |
| string |
| decimal integer |
| hook_data | string | hex bytes |
| liquidity* | string | decimal integer |
| tick_lower* | integer |
| tick_upper* | integer |
| amount0_max* | string | decimal integer |
| amount1_max* | string | decimal integer |
| tick_spacing* | integer |
| initialize_sqrt_price_x96 | string | decimal integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"deadline",
"pool_id",
"token0",
"token1",
"fee",
"tick_spacing",
"tick_lower",
"tick_upper",
"liquidity",
"amount0_max",
"amount1_max"
],
"properties": {
"fee": {
"type": "integer",
"minimum": 0
},
"hooks": {
"type": "string",
"description": "address"
},
"sender": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"pool_id": {
"type": "string",
"description": "bytes32 hex"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"deadline": {
"type": "string",
"description": "decimal integer"
},
"token_id": {
"type": "string",
"description": "decimal integer"
},
"hook_data": {
"type": "string",
"default": "0x",
"description": "hex bytes"
},
"liquidity": {
"type": "string",
"description": "decimal integer"
},
"tick_lower": {
"type": "integer"
},
"tick_upper": {
"type": "integer"
},
"amount0_max": {
"type": "string",
"description": "decimal integer"
},
"amount1_max": {
"type": "string",
"description": "decimal integer"
},
"tick_spacing": {
"type": "integer",
"maximum": 32767,
"minimum": 1
},
"initialize_sqrt_price_x96": {
"type": "string",
"description": "decimal integer"
}
}
}| hook_data | string | hex bytes |
| tick_spacing* | integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"deadline",
"pool_id",
"token0",
"token1",
"fee",
"tick_spacing",
"token_id"
],
"properties": {
"fee": {
"type": "integer",
"minimum": 0
},
"hooks": {
"type": "string",
"description": "address"
},
"sender": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"pool_id": {
"type": "string",
"description": "bytes32 hex"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"deadline": {
"type": "string",
"description": "decimal integer"
},
"token_id": {
"type": "string",
"description": "decimal integer"
},
"hook_data": {
"type": "string",
"default": "0x",
"description": "hex bytes"
},
"tick_spacing": {
"type": "integer",
"maximum": 32767,
"minimum": 1
}
}
}| token_id* | string | decimal integer |
| hook_data | string | hex bytes |
| liquidity* | string | decimal integer |
| amount0_min* | string | decimal integer |
| amount1_min* | string | decimal integer |
| tick_spacing* | integer |
{
"type": "object",
"required": [
"chain_id",
"sender",
"deadline",
"pool_id",
"token0",
"token1",
"fee",
"tick_spacing",
"token_id",
"liquidity",
"amount0_min",
"amount1_min"
],
"properties": {
"fee": {
"type": "integer",
"minimum": 0
},
"burn": {
"type": "boolean",
"default": false
},
"hooks": {
"type": "string",
"description": "address"
},
"sender": {
"type": "string",
"description": "address"
},
"token0": {
"type": "string",
"description": "address"
},
"token1": {
"type": "string",
"description": "address"
},
"pool_id": {
"type": "string",
"description": "bytes32 hex"
},
"chain_id": {
"enum": [
"1",
"10",
"130",
"4663",
"8453",
"42161"
],
"type": "string"
},
"deadline": {
"type": "string",
"description": "decimal integer"
},
"token_id": {
"type": "string",
"description": "decimal integer"
},
"hook_data": {
"type": "string",
"default": "0x",
"description": "hex bytes"
},
"liquidity": {
"type": "string",
"description": "decimal integer"
},
"amount0_min": {
"type": "string",
"description": "decimal integer"
},
"amount1_min": {
"type": "string",
"description": "decimal integer"
},
"tick_spacing": {
"type": "integer",
"maximum": 32767,
"minimum": 1
}
}
}| duration_seconds |
| integer |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"ve_id"
],
"properties": {
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"max_duration": {
"type": "boolean",
"default": false
},
"current_pool_key": {
"type": "object",
"description": "Active pool key when voted; the MCP claims fees atomically before extension. Omit only for an unvoted VeToken. PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
},
"duration_seconds": {
"type": "integer",
"minimum": 1
}
}
}{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"destination_ve_id",
"sources"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"ve_id"
],
"properties": {
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"current_pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
}
}
},
"minItems": 1
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"resulting_vote": {
"type": [
"object",
"null"
],
"required": [
"pool_key",
"swap_fee"
],
"properties": {
"pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
},
"swap_fee": {
"type": "string",
"description": "decimal integer"
}
}
},
"destination_ve_id": {
"type": "string",
"description": "decimal integer"
},
"destination_pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
}
}
}| string |
| address |
| salt_nonce* | string | User-selected nonce for deterministic child VeToken IDs created by required splits (bytes32 hex) |
| current_state_id* | string | Exact state_id returned by get_ve33_allocations; preparation fails if indexed state changed (bytes32 hex) |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"current_state_id",
"targets",
"salt_nonce"
],
"properties": {
"sender": {
"type": "string",
"description": "VeToken owner that will execute the atomic batch (address)"
},
"targets": {
"type": "array",
"items": {
"type": "object",
"required": [
"pool_key_id",
"swap_fee",
"weight_bps"
],
"properties": {
"swap_fee": {
"type": "string",
"description": "Selected uint64 swap fee vote (decimal integer)"
},
"weight_bps": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Target share of allocated voting power in basis points"
},
"pool_key_id": {
"type": "string",
"description": "Canonical Ekubo Ve33 pool key ID; the server resolves and verifies the full pool key (decimal integer)"
}
}
},
"minItems": 1,
"description": "At most 25 targets. compact_max_lock creates one final voting VeToken per target; preserve_existing_locks may require multiple NFTs per target to keep expiry-cohort decay proportional."
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"strategy": {
"enum": [
"preserve_existing_locks",
"compact_max_lock"
],
"type": "string",
"description": "Defaults to preserve_existing_locks. compact_max_lock explicitly claims fees, consolidates active stake into one surviving NFT, extends it to four years, then creates exactly one voting NFT per target; redundant source NFT IDs are burned."
},
"ve_token": {
"type": "string",
"description": "address"
},
"salt_nonce": {
"type": "string",
"description": "User-selected nonce for deterministic child VeToken IDs created by required splits (bytes32 hex)"
},
"current_state_id": {
"type": "string",
"description": "Exact state_id returned by get_ve33_allocations; preparation fails if indexed state changed (bytes32 hex)"
}
}
}| With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain |
| ve_token* | string | address |
| stake_token | string | address |
| fee_balances | array |
| slippage_bps | integer |
| current_state_id | string | bytes32 hex |
| swap_deadline_minutes | integer | Ekubo router route deadline; default 30 |
{
"type": "object",
"required": [
"phase",
"chain_id",
"ve_token",
"sender"
],
"properties": {
"phase": {
"enum": [
"claim",
"swap",
"stake",
"stake_all"
],
"type": "string"
},
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"amount": {
"type": "string",
"description": "Stake token base units (decimal integer)"
},
"claims": {
"type": "array",
"items": {
"type": "object",
"required": [
"ve_id",
"pool_key"
],
"properties": {
"ve_id": {
"type": "string",
"description": "decimal integer"
},
"pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
}
}
},
"minItems": 1
},
"sender": {
"type": "string",
"description": "address"
},
"source": {
"enum": [
"ekubo",
"0x",
"across",
"layerzero",
"lifi"
],
"type": "string"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"stake_token": {
"type": "string",
"description": "address"
},
"fee_balances": {
"type": "array",
"items": {
"type": "object",
"required": [
"token",
"amount"
],
"properties": {
"token": {
"type": "string",
"description": "address"
},
"amount": {
"type": "string",
"description": "Base units (decimal integer)"
}
}
},
"minItems": 1
},
"slippage_bps": {
"type": "integer",
"default": 50,
"maximum": 10000,
"minimum": 0
},
"current_state_id": {
"type": "string",
"description": "bytes32 hex"
},
"swap_deadline_minutes": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Ekubo router route deadline; default 30"
}
}
}{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"stake_token",
"amount",
"salt"
],
"properties": {
"salt": {
"type": "string",
"description": "User-selected salt for a deterministic, replay-detectable VeToken ID (bytes32 hex)"
},
"amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"stake_token": {
"type": "string",
"description": "address"
},
"max_duration": {
"type": "boolean",
"description": "Defaults to true when duration_seconds is omitted; set false only with an explicit duration_seconds"
},
"duration_seconds": {
"type": "integer",
"minimum": 1
}
}
}| string |
| decimal integer |
| source_amount* | string | Base units (positive decimal integer) |
| unallocated_permille* | integer |
{
"type": "object",
"required": [
"chain_id",
"ve_token",
"sender",
"source_ve_id",
"source_amount",
"current_vote",
"allocations",
"unallocated_permille",
"salt_nonce"
],
"properties": {
"sender": {
"type": "string",
"description": "address"
},
"chain_id": {
"type": [
"integer",
"string"
],
"description": "With ve_token, from get_ve33_allocations (STONX: 4663), not the wallet's chain"
},
"ve_token": {
"type": "string",
"description": "address"
},
"salt_nonce": {
"type": "string",
"description": "User-selected nonce used to derive deterministic, replay-detectable split salts (bytes32 hex)"
},
"allocations": {
"type": "array",
"items": {
"type": "object",
"required": [
"pool_key_id",
"pool_key",
"swap_fee",
"permille"
],
"properties": {
"permille": {
"type": "integer",
"maximum": 1000,
"minimum": 1
},
"pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
},
"swap_fee": {
"type": "string",
"description": "decimal integer"
},
"pool_key_id": {
"type": "string",
"minLength": 1
}
}
},
"minItems": 1
},
"current_vote": {
"type": "object",
"required": [
"pool_key_id",
"pool_key"
],
"properties": {
"pool_key": {
"type": "object",
"description": "PoolKey {token0, token1, config} or {token0, token1, fee, tick_spacing, extension, stableswap_params?}, as read from the pool or vote"
},
"swap_fee": {
"type": "string",
"description": "decimal integer"
},
"pool_key_id": {
"type": "string",
"minLength": 1
}
},
"description": "Required active indexed vote; its pool is claimed unconditionally before any split, clear, or replacement vote"
},
"source_ve_id": {
"type": "string",
"description": "decimal integer"
},
"source_amount": {
"type": "string",
"description": "Base units (positive decimal integer)"
},
"unallocated_permille": {
"type": "integer",
"maximum": 1000,
"minimum": 0
}
}
}{
"type": "object",
"required": [
"tick_lower",
"tick_upper",
"tick_spacing",
"sqrt_price_x96",
"amount0",
"amount1"
],
"properties": {
"amount0": {
"type": "string",
"description": "decimal integer"
},
"amount1": {
"type": "string",
"description": "decimal integer"
},
"liquidity": {
"type": "string",
"description": "decimal integer"
},
"tick_lower": {
"type": "integer"
},
"tick_upper": {
"type": "integer"
},
"slippage_bps": {
"type": "integer",
"default": 50,
"maximum": 1000,
"minimum": 0
},
"tick_spacing": {
"type": "integer",
"maximum": 32767,
"minimum": 1
},
"sqrt_price_x96": {
"type": "string",
"description": "decimal integer"
}
}
}