Documentation Index
Fetch the complete documentation index at: https://docs.kuru.io/llms.txt
Use this file to discover all available pages before exploring further.
State Variables
Public Variables
| Variable | Type | Description |
|---|
orderBookImplementation | address | Current OrderBook implementation address |
kuruAmmVaultImplementation | address | Current KuruAMMVault implementation address |
marginAccountAddress | address | MarginAccount contract address |
TRUSTED_FORWARDER | address | Address for meta-transaction forwarding |
Mappings
mapping(address => MarketParams) public verifiedMarket;
Core Functions
initialize
One-time initialization of the Router contract.
function initialize(
address _owner,
address _marginAccount,
address _orderbookImplementation,
address _kuruAmmVaultImplementation,
address _trustedForwarder
) public initializer
deployProxy
Deploys a new OrderBook market with an associated KuruAMMVault.
function deployProxy(
IOrderBook.OrderBookType _type,
address _baseAssetAddress,
address _quoteAssetAddress,
uint96 _sizePrecision,
uint32 _pricePrecision,
uint32 _tickSize,
uint96 _minSize,
uint96 _maxSize,
uint256 _takerFeeBps,
uint256 _makerFeeBps,
uint96 _kuruAmmSpread
) public returns (address proxy)
NO_NATIVE - Both base and quote are ERC20 tokensNATIVE_IN_BASE - Native token (Monad) as base assetNATIVE_IN_QUOTE - Native token (Monad) as quote asset
Deploys both OrderBook and KuruAMMVault using Create2 for deterministic addresses. Registers the market in verifiedMarket mapping. Returns the deployed OrderBook proxy address.
computeAddress
Computes the deterministic address for an OrderBook proxy.
function computeAddress(
address _baseAssetAddress,
address _quoteAssetAddress,
uint96 _sizePrecision,
uint32 _pricePrecision,
uint32 _tickSize,
uint96 _minSize,
uint96 _maxSize,
uint256 _takerFeeBps,
uint256 _makerFeeBps,
uint96 _kuruAmmSpread,
address oldImplementation,
bool old
) public view returns (address proxy)
computeVaultAddress
Computes the deterministic address for a KuruAMMVault.
function computeVaultAddress(
address _marketAddress,
address oldImplementation,
bool old
) public view returns (address)
anyToAnySwap
Enables multi-hop swaps across different markets.
function anyToAnySwap(
address[] calldata _marketAddresses,
bool[] calldata _isBuy,
bool[] calldata _nativeSend,
address _debitToken,
address _creditToken,
uint256 _amount,
uint256 _minAmountOut
) external payable returns (uint256 _amountOut)
verifiedMarket mapping and enforces slippage protection via _minAmountOut. Supports native token transfers when _nativeSend is true.
Example: Swap TOKEN_A → Native → TOKEN_B
const markets = [tokenAMarket, nativeMarket];
const isBuy = [false, false]; // Sell TOKEN_A, sell Native
const nativeSend = [false, true];
await router.anyToAnySwap(
markets, isBuy, nativeSend,
tokenA, tokenB, amount, minAmountOut,
{ value: nativeAmount }
);
Events
MarketRegistered
event MarketRegistered(
address baseAsset,
address quoteAsset,
address market,
address vaultAddress,
uint32 pricePrecision,
uint96 sizePrecision,
uint32 tickSize,
uint96 minSize,
uint96 maxSize,
uint256 takerFeeBps,
uint256 makerFeeBps,
uint96 kuruAmmSpread
);
deployProxy. Contains all market parameters and addresses for the OrderBook and KuruAMMVault.
OBImplementationUpdated
event OBImplementationUpdated(
address previousImplementation,
address newImplementation
);
VaultImplementationUpdated
event VaultImplementationUpdated(
address previousImplementation,
address newImplementation
);
KuruRouterSwap
event KuruRouterSwap(
address msgSender,
address debitToken,
address creditToken,
uint256 amountIn,
uint256 amountOut
);
anyToAnySwap. Tracks the swap input/output for the entire routing path.
