Skip to main content

Glossary

Quick reference for key terms used in the Boros API. For portfolio concepts (leverage, margin, PnL, liquidation), see the Boros User Glossary.


Core Concepts​

TermDescription
MarketA trading market uniquely identified by marketId, with one collateral token and specific parameters
AssetAny token in the system, identified by tokenId (e.g., USDT has 6 decimals, BTC has 8)
RootEVM address (0x-prefixed) serving as the primary trading identity
AccountSub-account under a root (IDs 0-255). Account 0 is default for trading; 255 is reserved for AMM
AgentWallet authorized to trade on your behalf but cannot withdraw funds
Market AccountUnique trading context: (root, subaccountId, tokenId, marketId). Use CROSS_MARKET_ID (16777215) for cross-margin, or specific marketId for isolated
DecimalsDeposits/withdrawals use native token decimals; trading/balances always use 18 decimals internally

Trading Concepts​

TermDescription
OrderBookPrimary liquidity source with Long/Short sides organized by price ticks. Learn more
OrderTrade instruction with orderId, tick (price level), side, size (18 decimals), and tif
TickInteger price level. Formula: rate = 1.00005^(tick Γ— tickStep) - 1. Use SDK helpers to convert
SlippageMax acceptable price impact as percentage (market orders only)
AMMAutomated market maker providing continuous liquidity

Enums​

Side​

ValueNameDescription
0LONGBetting on rate increase
1SHORTBetting on rate decrease

Time In Force (TIF)​

ValueNameDescription
0GOOD_TIL_CANCELLEDRemains active until filled or cancelled
1IMMEDIATE_OR_CANCELFill what's possible, cancel the rest
2FILL_OR_KILLMust fill completely immediately or cancel
3POST_ONLYOnly add liquidity, reject if would take
4POST_ONLY_SLIDEPost-only with price adjustment

SDK Helpers​

import { MarketAccLib, CROSS_MARKET_ID, estimateTickForRate, getRateAtTick } from "@pendle/sdk-boros";
import { FixedX18 } from "@pendle/boros-offchain-math";

// Pack market account
const marketAcc = MarketAccLib.pack(walletAddress, accountId, tokenId, CROSS_MARKET_ID);

// Convert between tick and rate
const tick = estimateTickForRate(FixedX18.fromNumber(0.05), tickStep, false);
const rate = getRateAtTick(tick, tickStep);

// Convert decimals
const size = FixedX18.fromNumber(100).value.toString();
const amount = FixedX18.fromBigIntString(balanceString).toNumber();

Additional Resources​