Skip to content

lending

Lending markets: supply, withdraw, borrow and repay (with max sugar for dust-exact debt repayment) with automatic approvals, plus health-factor, APY, max-borrow and debt helpers. Protocol selection via --using (Aave v3, Spark, Compound v3).

load lending
CommandDescription
lending:borrowBorrow a token from a lending market against the connected account's collateral (variable rate). The borrowed tokens go to the connected account.
lending:repayRepay borrowed tokens, approving the pool automatically when needed. Pass max as the amount to clear the debt dust-exact: the approval covers the current debt plus a 0.1% interest buffer, and the pool pulls only what is owed.
lending:set-collateralEnable or disable a supplied token as collateral for the connected account's borrows.
lending:set-emodeSet the connected account's efficiency-mode category, unlocking higher LTV between correlated assets (e.g. stablecoins). Category 0 disables e-mode.
lending:supplySupply a token to a lending market, approving the pool automatically when needed. Supplied tokens earn interest and can back borrows as collateral.
lending:withdrawWithdraw a supplied token from a lending market. Pass max as the amount to withdraw the full balance, accrued interest included.
HelperReturnsDescription
@lending:apynumberCurrent APY of a lending-market reserve as a decimal fraction (2.04% -> 0.0204). Pass supply for the deposit rate or borrow for the variable borrow rate.
@lending:debtnumberCurrent variable-rate debt of an account in a token, in base units (grows every block as interest accrues).
@lending:healthFactornumberHealth factor of an account's lending position, 1e18-scaled (below 1e18 the position is liquidatable; uint256.max when the account has no debt). Composes with assertions: assert @lending:healthFactor(@me) >= 1.5e18.
@lending:maxBorrownumberHow much of a token an account can still borrow against its current collateral, in base units of the token.