# Aave Book ## The Aave Book - [Introduction](https://calnix.gitbook.io/aave-book/introduction.md) - [TradFi vs DeFi: Lending](https://calnix.gitbook.io/aave-book/tradfi-vs-defi-lending.md) - [Market forces x Interest Rate Models](https://calnix.gitbook.io/aave-book/market-forces-x-interest-rate-models.md): Borrow Demand -> Utilization -> Borrow rate -> Supply rate - [On Indexes](https://calnix.gitbook.io/aave-book/on-indexes.md) - [Why use indexes?](https://calnix.gitbook.io/aave-book/on-indexes/why-use-indexes.md) - [Scaling and ATokens](https://calnix.gitbook.io/aave-book/scaling-and-atokens.md) - [Deposit & Borrow Interest](https://calnix.gitbook.io/aave-book/deposit-and-borrow-interest.md) - [Stable borrowing](https://calnix.gitbook.io/aave-book/stable-borrowing.md) - [Under construction](https://calnix.gitbook.io/aave-book/stable-borrowing/under-construction.md) - [Liquidation](https://calnix.gitbook.io/aave-book/liquidation.md): https://docs.aave.com/risk/asset-risk/risk-parameters#liquidation-threshold - [TODO: Full example](https://calnix.gitbook.io/aave-book/liquidation/todo-full-example.md) - [Under construction: oracles](https://calnix.gitbook.io/aave-book/liquidation/under-construction-oracles.md) - [Bitmap & Masks](https://calnix.gitbook.io/aave-book/primer/bitmap-and-masks.md) - [padding and bytes](https://calnix.gitbook.io/aave-book/primer/bitmap-and-masks/padding-and-bytes.md) - [WadRayLibrary](https://calnix.gitbook.io/aave-book/primer/wadraylibrary.md) - [Math Operations](https://calnix.gitbook.io/aave-book/primer/wadraylibrary/math-operations.md) - [WIP: Scaling different decimal representations](https://calnix.gitbook.io/aave-book/primer/wadraylibrary/wip-scaling-different-decimal-representations.md) - [WIP: 2's complement](https://calnix.gitbook.io/aave-book/primer/wadraylibrary/wip-2s-complement.md) - [casting: to uint128](https://calnix.gitbook.io/aave-book/primer/wadraylibrary/casting-to-uint128.md) - [PercentageMath](https://calnix.gitbook.io/aave-book/primer/percentagemath.md) - [Embedded vs Linked Libraries](https://calnix.gitbook.io/aave-book/primer/embedded-vs-linked-libraries.md) - [General Execution flow](https://calnix.gitbook.io/aave-book/functions/general-execution-flow.md) - [Architecture & Design choices](https://calnix.gitbook.io/aave-book/functions/architecture-and-design-choices.md) - [Upgradability and Proxies](https://calnix.gitbook.io/aave-book/functions/architecture-and-design-choices/upgradability-and-proxies.md) - [Common Functions](https://calnix.gitbook.io/aave-book/functions/common-functions.md) - [getReserveFactor, getDecimals](https://calnix.gitbook.io/aave-book/functions/common-functions/getreservefactor-getdecimals.md) - [.cache](https://calnix.gitbook.io/aave-book/functions/common-functions/.cache.md) - [.updateState](https://calnix.gitbook.io/aave-book/functions/common-functions/.updatestate.md) - [.updateInterestRates](https://calnix.gitbook.io/aave-book/functions/common-functions/.updateinterestrates.md) - [SupplyCap, BorrowCap](https://calnix.gitbook.io/aave-book/functions/common-functions/supplycap-borrowcap.md) - [getFlags](https://calnix.gitbook.io/aave-book/functions/common-functions/getflags.md) - [more on flags](https://calnix.gitbook.io/aave-book/functions/common-functions/getflags/more-on-flags.md) - [calculateUserAccountData](https://calnix.gitbook.io/aave-book/functions/common-functions/calculateuseraccountdata.md) - [supply](https://calnix.gitbook.io/aave-book/functions/supply.md) - [validateSupply](https://calnix.gitbook.io/aave-book/functions/supply/validatesupply.md) - [transfer & mint](https://calnix.gitbook.io/aave-book/functions/supply/transfer-and-mint.md) - [isFirstSupply](https://calnix.gitbook.io/aave-book/functions/supply/isfirstsupply.md) - [isUsingAsCollateralOne, isUsingAsCollateralAny](https://calnix.gitbook.io/aave-book/functions/supply/isfirstsupply/isusingascollateralone-isusingascollateralany.md) - [On check-effects-interactions pattern](https://calnix.gitbook.io/aave-book/functions/supply/on-check-effects-interactions-pattern.md) - [withdraw](https://calnix.gitbook.io/aave-book/functions/withdraw.md) - [get user balance & withdraw amount](https://calnix.gitbook.io/aave-book/functions/withdraw/get-user-balance-and-withdraw-amount.md) - [validateWithdraw](https://calnix.gitbook.io/aave-book/functions/withdraw/validatewithdraw.md) - [collateral check](https://calnix.gitbook.io/aave-book/functions/withdraw/collateral-check.md) - [burn ATokens](https://calnix.gitbook.io/aave-book/functions/withdraw/burn-atokens.md) - [Ensure existing loans are collateralized](https://calnix.gitbook.io/aave-book/functions/withdraw/ensure-existing-loans-are-collateralized.md) - [borrow](https://calnix.gitbook.io/aave-book/functions/borrow.md) - [getIsolationModeState](https://calnix.gitbook.io/aave-book/functions/borrow/getisolationmodestate.md) - [.validateBorrow](https://calnix.gitbook.io/aave-book/functions/borrow/.validateborrow.md) - [Mint debt token](https://calnix.gitbook.io/aave-book/functions/borrow/mint-debt-token.md) - [setBorrowing](https://calnix.gitbook.io/aave-book/functions/borrow/setborrowing.md) - [update IsolationMode debt](https://calnix.gitbook.io/aave-book/functions/borrow/update-isolationmode-debt.md) - [transfer underlying to user](https://calnix.gitbook.io/aave-book/functions/borrow/transfer-underlying-to-user.md) - [repay](https://calnix.gitbook.io/aave-book/functions/repay.md) - [get current debt](https://calnix.gitbook.io/aave-book/functions/repay/get-current-debt.md) - [validateRepay, paybackAmount](https://calnix.gitbook.io/aave-book/functions/repay/validaterepay-paybackamount.md) - [burn debt tokens](https://calnix.gitbook.io/aave-book/functions/repay/burn-debt-tokens.md) - [Cleanup + Collect repay](https://calnix.gitbook.io/aave-book/functions/repay/cleanup-+-collect-repay.md) - [liquidate](https://calnix.gitbook.io/aave-book/functions/liquidate.md): liquidationCall() - [\_calculateDebt](https://calnix.gitbook.io/aave-book/functions/liquidate/_calculatedebt.md) - [validateLiquidationCall](https://calnix.gitbook.io/aave-book/functions/liquidate/validateliquidationcall.md) - [getConfigurationData](https://calnix.gitbook.io/aave-book/functions/liquidate/getconfigurationdata.md) - [calculateAvailableCollateralToLiquidate](https://calnix.gitbook.io/aave-book/functions/liquidate/calculateavailablecollateraltoliquidate.md) - [\_burnDebtTokens](https://calnix.gitbook.io/aave-book/functions/liquidate/_burndebttokens.md) - [liquidate/burn collateral](https://calnix.gitbook.io/aave-book/functions/liquidate/liquidate-burn-collateral.md) - [liquidation Fee](https://calnix.gitbook.io/aave-book/functions/liquidate/liquidation-fee.md) - [Wrap-up](https://calnix.gitbook.io/aave-book/functions/liquidate/wrap-up.md) - [swapBorrowRateMode](https://calnix.gitbook.io/aave-book/functions/swapborrowratemode.md) - [setUserUseReserveAsCollateral](https://calnix.gitbook.io/aave-book/functions/setuserusereserveascollateral.md) - [AToken](https://calnix.gitbook.io/aave-book/contracts/atoken.md) - [Simple example: mint & balanceOf](https://calnix.gitbook.io/aave-book/contracts/atoken/simple-example-mint-and-balanceof.md) - [StableDebtToken](https://calnix.gitbook.io/aave-book/contracts/stabledebttoken.md): https://docs.aave.com/developers/v/2.0/the-core-protocol/debt-tokens - [Implementation explained](https://calnix.gitbook.io/aave-book/contracts/stabledebttoken/implementation-explained.md) - [VariableDebtToken](https://calnix.gitbook.io/aave-book/contracts/variabledebttoken.md) - [DefaultReserveInterestRateStrategy](https://calnix.gitbook.io/aave-book/contracts/defaultreserveinterestratestrategy.md): https://docs.aave.com/developers/deployed-contracts/v3-mainnet/ethereum-mainnet - [L2](https://calnix.gitbook.io/aave-book/contracts/l2.md) - [PriceOracleSentinel](https://calnix.gitbook.io/aave-book/contracts/l2/priceoraclesentinel.md) - [Under construction](https://calnix.gitbook.io/aave-book/audit-findings/under-construction.md) - [Simple, Compound, APR, APY](https://calnix.gitbook.io/aave-book/appendix/simple-compound-apr-apy.md) - [Risk Management](https://calnix.gitbook.io/aave-book/aave-features/risk-management.md) - [Supply & Borrow Caps](https://calnix.gitbook.io/aave-book/aave-features/risk-management/supply-and-borrow-caps.md) - [Isolation Mode](https://calnix.gitbook.io/aave-book/aave-features/risk-management/isolation-mode.md) - [Siloed Borrowing](https://calnix.gitbook.io/aave-book/aave-features/risk-management/siloed-borrowing.md): https://docs.aave.com/developers/whats-new/siloed-borrowing - [Other features](https://calnix.gitbook.io/aave-book/aave-features/other-features.md) - [Repay with ATokens](https://calnix.gitbook.io/aave-book/aave-features/other-features/repay-with-atokens.md) - [eMode: High efficiency Mode](https://calnix.gitbook.io/aave-book/aave-features/other-features/emode-high-efficiency-mode.md): https://docs.aave.com/developers/whats-new/efficiency-mode-emode - [Aave Vault](https://calnix.gitbook.io/aave-book/aave-features/other-features/aave-vault.md) - [Portal](https://calnix.gitbook.io/aave-book/aave-features/other-features/portal.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://calnix.gitbook.io/aave-book/introduction.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.