Raw schema
{
"type": "object",
"properties": {
"token": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$",
"description": "The token's address."
},
"quote": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "What the token trades against: ETH, USDG, or the quote token's address."
},
"payIn": {
"type": "string",
"enum": [
"ETH",
"USDG"
],
"description": "What the wallet pays with."
},
"amount": {
"type": "string",
"pattern": "^\\d*\\.?\\d+$",
"description": "How much is paid, as a decimal string (for example \"0.05\")."
},
"owner": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$",
"description": "The wallet that signs, sends, and owns the ladder."
},
"pool": {
"description": "A v4 pool id from ladder_pools to build in, on the hook or not; the quote is then that pool's. Left out: the token's pool against the quote, opened if none.",
"type": "string"
},
"feePct": {
"description": "The swap fee for a pool that has to be opened: 0.1, 0.5, or 1 to 5 (percent). Ignored when the pair already has a pool on the hook.",
"type": "number",
"minimum": 0.1,
"maximum": 10
},
"hook": {
"description": "Which hook the pool goes on and with what, when it has to be opened. Left out: the plain ranges pool at feePct; the answer then lists the presets under options. A full-range pool, a launch fee or the volatility fee are opened by the hook's own call in a transaction before the build (plan_build returns both, in order).",
"type": "object",
"properties": {
"kind": {
"description": "ranges: LoomOpenHookV2, any band, the fee in the asset paid in (default). full: LoomFullHook, one full-range position only, every fee in the quote (ETH or USDG), and a swap that closes a gap of 3%+ to the token's Uniswap v3 market pays for the gap instead.",
"type": "string",
"enum": [
"ranges",
"full"
]
},
"preset": {
"description": "A named set: steady (1%, plain), volatile (3%, volatility fee on), launch (5%, opens at 50% and falls to 5% over an hour, volatility fee on), full (full range, 1% in the quote, opens at 10% for ten minutes). A field given beside it wins.",
"type": "string",
"enum": [
"steady",
"volatile",
"launch",
"full"
]
},
"launchFeePct": {
"description": "The fee the pool opens at, percent, above the swap fee and at most 50; it falls in a straight line to the swap fee over launchMinutes. Needs launchMinutes.",
"type": "number",
"minimum": 0,
"maximum": 50
},
"launchMinutes": {
"description": "How long the launch fee takes to fall to the swap fee: 1 to 1440 minutes.",
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"volatility": {
"description": "ranges only: a fee that rises for a while after the price moves (a move under 3% adds nothing; the add fades within minutes).",
"type": "boolean"
},
"blocks": {
"description": "ranges only: the creator's blocks, each enforced by the hook in every swap and fixed at opening. A trader always pays the pool's fee and no more: the royalty and the burn come out of it.",
"type": "object",
"properties": {
"antiSnipeMaxQuote": {
"description": "Anti-snipe: the most a single buy may spend of the quote (ETH or USDG, in whole units) during the first antiSnipeMinutes.",
"type": "number",
"exclusiveMinimum": 0
},
"antiSnipeMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"royaltyPct": {
"description": "Royalty: this percent of the base fee goes to the pool's creator in the quote, every swap. At most 30.",
"type": "number",
"exclusiveMinimum": 0,
"maximum": 30
},
"burnPct": {
"description": "Auto burn: this percent of the base fee is burned in the token on every sell. At most 20.",
"type": "number",
"exclusiveMinimum": 0,
"maximum": 20
},
"managedFee": {
"description": "Managed fee: the creator may later move the base fee between these tiers (same spacing as the fee: 1 to 5 together), an hour apart, with the hook's setFee.",
"type": "object",
"properties": {
"floorPct": {
"type": "number"
},
"ceilPct": {
"type": "number"
}
},
"required": [
"floorPct",
"ceilPct"
]
},
"offHoursFeePct": {
"description": "Market hours: outside NYSE hours (weekdays 13:30 to 20:00 UTC) the base fee is this tier instead.",
"type": "number"
}
}
}
}
},
"lowPct": {
"description": "The band's bottom, percent from the price (negative). Needed unless fullRange.",
"type": "number",
"minimum": -98,
"maximum": 400
},
"highPct": {
"description": "The band's top, percent from the price. Needed unless fullRange.",
"type": "number",
"minimum": -97,
"maximum": 500
},
"rungs": {
"description": "How many rungs across the band, 1 to 40; default 20.",
"type": "integer",
"minimum": 1,
"maximum": 40
},
"shape": {
"description": "Where the band puts the most: spot, curve, bidask, hybrid, or custom with weights. Default bidask.",
"type": "string",
"enum": [
"spot",
"curve",
"bidask",
"hybrid",
"custom"
]
},
"weights": {
"description": "shape custom only: a relative height per rung, low price to high, any scale; stretched over the rungs built.",
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "number",
"minimum": 0,
"maximum": 1000000
}
},
"fullRange": {
"description": "One position across every price instead of a band; lowPct and highPct are ignored.",
"type": "boolean"
},
"slippagePct": {
"description": "Room for the price to move, in percent. Left out: 1.5% on a calm token, more on one that has been moving, at most 10%.",
"type": "number",
"minimum": 0.5,
"maximum": 50
},
"referrer": {
"description": "The wallet that referred the owner: paid 0.1% of what goes in, out of the opening fee.",
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$"
},
"copyOf": {
"description": "The id of a ladder on the current contract this one copies: its owner is paid 0.1% while it stays open in the same pair.",
"type": "string",
"pattern": "^\\d+$"
}
},
"required": [
"token",
"quote",
"payIn",
"amount",
"owner"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}