Data types

Field names below are the exact wire names. Numeric scales are not encoded in the names: see Events for the scale of every field.

`HubAssetKey`

HubAssetKey {
  hub_id: u32,
  asset: Address,
}

The market coordinate used by controller flows, pool storage, keeper config, views, events, and strategy inputs. The same token under two hubs is two independent markets.

Account model

There is no single Account struct on the wire. Account state is split across three controller records plus the position-NFT contract:

Record	Holds
`AccountMeta(account_id)`	`{ spoke_id: u32, mode: PositionMode }`
`SupplyPositions(account_id)`	`Map<HubAssetKey, AccountPositionRaw>`
`BorrowPositions(account_id)`	`Map<HubAssetKey, DebtPositionRaw>`
`Delegates(account_id)`	`DelegateGrant { granted_by: Address, delegates: Vec<Address> }`

Ownership is not stored on the controller. The account_id is the position NFT’s token_id; the controller calls owner_of(account_id) on every authority check. Transferring the token transfers the whole position. AccountAttributes is the view projection of AccountMeta: { spoke_id: u32, mode: PositionMode }. Accounts bind to a spoke id >= 1, and the binding never changes.

`PositionMode`

#[repr(u32)], so it is a plain u32 on the wire.

Variant	Value	Meaning
`Normal`	0	Standard supply and borrow.
`Multiply`	1	Leveraged collateral/debt loop.
`Long`	2	Directional long strategy.
`Short`	3	Directional short strategy.

Fixed at account creation and enforced on every later multiply or flash_position call against that account (#25 AccountModeMismatch).

`AccountPositionRaw`

Field	Scale	Meaning
`scaled_amount`	RAY	Supply shares.
`liquidation_threshold`	bps	Threshold stamped onto the position.
`liquidation_bonus`	bps	Bonus stamped onto the position.
`loan_to_value`	bps	LTV stamped onto the position.
`liquidation_fees`	bps	Protocol liquidation fee stamped onto the position.

`DebtPositionRaw`

Field	Scale	Meaning
`scaled_amount`	RAY	Debt shares.

`SpokeConfig`

Field	Scale	Meaning
`is_deprecated`	—	True when the spoke accepts no new positions.
`liquidation_target_hf_wad`	WAD	The health factor a liquidation aims to restore the account to.
`hf_for_max_bonus_wad`	WAD	The health factor at or below which the bonus is maximal.
`liquidation_bonus_factor_bps`	bps	Scaling factor applied to the bonus curve increment.

`SpokeAssetConfig`

Field	Scale	Meaning
`is_collateralizable`	—	Whether supply counts as collateral in this spoke.
`is_borrowable`	—	Whether accounts can borrow it.
`paused`	—	Blocks every user verb on the asset, entry and exit alike.
`frozen`	—	Blocks entry only; exit remains open.
`no_seize`	—	Blocks only the liquidation seizure leg.
`loan_to_value`	bps	Borrowing power per unit of collateral.
`liquidation_threshold`	bps	Health-factor collateral weight.
`liquidation_bonus`	bps	Base liquidator discount.
`liquidation_fees`	bps	Protocol’s share of the bonus.
`supply_cap`	raw asset units	Spoke supply cap. Zero means no new exposure.
`borrow_cap`	raw asset units	Spoke borrow cap. Zero means no new exposure.

The three halt flags are independent. Seizure is deliberately not gated by paused, because seizure is pro-rata across an account’s whole collateral set — pausing one collateral would otherwise halt liquidation of every account holding it. SpokeAssetArgs is the write-side input shape. It uses different field names for the same values: can_collateral, can_borrow, ltv, threshold, bonus, plus hub_id, asset, spoke_id, the three flags, liquidation_fees, supply_cap, and borrow_cap.

`SpokeUsageRaw`

Field	Scale
`supplied_scaled_ray`	RAY
`borrowed_scaled_ray`	RAY

`MarketParamsRaw`

Lives in pool Params(HubAssetKey) storage. Rate and utilization fields are RAY-scaled. There are no _ray / _bps suffixes on the wire, and no supply/borrow cap fields — caps are per-spoke, not per-market.

Field	Scale	Meaning
`max_borrow_rate`	RAY	Borrow rate at maximum utilization; the top of the curve. Capped at `2 * RAY` (200% APR).
`base_borrow_rate`	RAY	Borrow rate at zero utilization.
`slope1`	RAY	Rate contribution reached at the mid utilization breakpoint.
`slope2`	RAY	Rate contribution reached at the optimal breakpoint.
`slope3`	RAY	Rate contribution reached at 100% utilization.
`mid_utilization`	RAY	First utilization breakpoint.
`optimal_utilization`	RAY	Second utilization breakpoint.
`max_utilization`	RAY	Utilization ceiling enforced after borrows and withdrawals.
`reserve_factor`	bps	Share of borrow interest booked as protocol revenue.
`is_flashloanable`	—	Whether flash loans are enabled for this market.
`flashloan_fee`	bps	Flash-loan fee. Capped at `MAX_FLASHLOAN_FEE_BPS = 500`.
`asset_id`	—	The market’s underlying token contract.
`asset_decimals`	—	Token decimals, 3..=18. Use this to interpret every raw-asset-unit amount for this market.

InterestRateModel is the same set minus asset_id and asset_decimals; it is what upgrade_liquidity_pool_params takes.

Liquidation types

`SeizeMode`

enum SeizeMode {
  Transfer,      // pool pays underlying, withholding the protocol fee
  Credit(u64),   // seized supply shares move to a controller account
}

Credit(0) creates the receiving account for you. It is owned by the liquidator and bound to the liquidated account’s spoke. A non-zero id must already satisfy all five of these:

it exists;
it is not the liquidated account itself (#133);
the liquidator owns it, or is a delegate on it;
it sits in the liquidated account’s spoke;
it is in PositionMode::Normal.

`LiquidationEstimate`

Field	Meaning
`seized_collaterals`	`Vec<PaymentTuple>` — gross of `protocol_fees`.
`protocol_fees`	`Vec<PaymentTuple>` — the protocol’s cut, taken from the bonus.
`refunds`	`Vec<PaymentTuple>` — budget trimmed before transfer. No refund transfer occurs; the liquidator simply keeps it.
`max_payment_wad`	WAD — the maximum USD-equivalent debt repayable.
`bonus_rate_bps`	bps — the applied bonus rate.

Units follow the mode: asset units for Transfer, RAY-scaled supply shares for Credit. PaymentTuple is { asset: Address, amount: i128 }.

`MarketIndexView`

Returned by get_market_indexes_detailed.

Field	Scale	Meaning
`asset`	—	Token contract.
`supply_index` / `borrow_index`	RAY	Current indexes.
`price_wad`	WAD	Resolved blended price.
`primary_price_wad` / `anchor_price_wad`	WAD	Individual legs.
`price_timestamp`	s	Timestamp of the older leg.
`stale` / `deviation` / `valid`	—	Failure flags.
`error_code`	—	`Option<u32>`: the `OracleError` discriminant that made the price unusable, if any. Not yet released — see below.

error_code is not in a released build yet. It exists only on an unmerged branch. A contract deployed from main today returns MarketIndexView and PriceStatus without this field, so a decoder that expects it will fail.Until it lands, treat a price as unusable whenever valid is false.Do not try to infer why from stale or deviation. A resolution error zeroes both, so false there does not mean those checks passed.

Once it ships, error_code becomes the only field that tells you why a price failed, for exactly that reason.

Oracle types

Oracle configuration is stored on the price aggregator, keyed by PriceKey:

enum PriceKey {
  Token(Address),   // a token contract
  Ref(Symbol),      // a synthetic reference used as an intermediate quote
}

`AssetOracle`

Field	Scale	Meaning
`asset_decimals`	—	The decimal scale of the price this oracle returns.
`max_price_stale_seconds`	s	Maximum age a blended price may have.
`sources`	—	`Vec<PriceSource>`, one or two entries.
`tolerance`	—	`OracleTolerance { upper_ratio_bps, lower_ratio_bps }`, the agreement band between two sources.
`independence`	—	`IndependencePolicy`: `RequireDisjoint` or `AllowShared(Vec<Address>)`.
`min_sanity_price_wad`	WAD	Lower bound a resolved price must fall within.
`max_sanity_price_wad`	WAD	Upper bound.

`PriceSource`

enum PriceSource {
  Feed(FeedSource),
  Scaled(ScaledSource),
  AquariusLp(AquariusLpSource),
  AquariusStableLp(AquariusLpSource),
}

FeedSource { provider: ProviderRef, decimals: u32, max_stale_seconds: u64 }, where ProviderRef is Reflector(ReflectorFeedRef), RedStone(MultiFeedRef), or Xoxno(MultiFeedRef). Reflector references carry an OracleReadMode of Spot or Twap(records); RedStone and Xoxno references carry a FeedNature of Market or Fundamental. See Oracles for how these compose.

Start here

Concepts

Integration guides

Reference

Operations

`HubAssetKey`

Account model

`PositionMode`

`AccountPositionRaw`

`DebtPositionRaw`

`SpokeConfig`

`SpokeAssetConfig`

`SpokeUsageRaw`

`MarketParamsRaw`

Liquidation types

`SeizeMode`

`LiquidationEstimate`

`MarketIndexView`

Oracle types

`AssetOracle`

`PriceSource`

​HubAssetKey

​Account model

​PositionMode

​AccountPositionRaw

​DebtPositionRaw

​SpokeConfig

​SpokeAssetConfig

​SpokeUsageRaw

​MarketParamsRaw

​Liquidation types

​SeizeMode

​LiquidationEstimate

​MarketIndexView

​Oracle types

​AssetOracle

​PriceSource

`HubAssetKey`

Account model

`PositionMode`

`AccountPositionRaw`

`DebtPositionRaw`

`SpokeConfig`

`SpokeAssetConfig`

`SpokeUsageRaw`

`MarketParamsRaw`

Liquidation types

`SeizeMode`

`LiquidationEstimate`

`MarketIndexView`

Oracle types

`AssetOracle`

`PriceSource`