@raac/rpc 1.2.0-beta.8 → 2.0.0-beta.0

package/dist/types/minter/get.d.ts

@@ -1,22 +1,25 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains";
+import { TokenAmount } from "../utils/amount";
 export interface MinterInfo {
+    /** The RAAC token address. */
     raacToken: string;
+    /** UNIX timestamp (seconds) the schedule was activated, 0 if not activated. */
     mintingStartAtTimestamp: number;
+    /** UNIX timestamp (seconds) of the last `tick()`. */
     lastUpdateBlockTimestamp: number;
-    excessTokens: string;
-    maxSupply: string;
+    /** RAAC minted but not yet distributed, with the registry `raactoken` decimals and symbol. */
+    excessTokens: TokenAmount;
+    /** RAAC `MAX_SUPPLY`, with the registry `raactoken` decimals and symbol. */
+    maxSupply: TokenAmount;
+    /** Sum of all distribution pool weights (unitless relative weights). */
     totalWeight: bigint;
+    /** Number of registered distribution pools. */
     distributionPoolCount: number;
+    /** Registered distribution pool addresses. */
     distributionPools: string[];
+    /** Whether the minter is paused. */
     paused: boolean;
-    raw: {
-        mintingStartAtTimestamp: bigint;
-        lastUpdateBlockTimestamp: bigint;
-        excessTokens: bigint;
-        maxSupply: bigint;
-        totalWeight: bigint;
-    };
 }
 /**
  * Read the RAAC minter's global state. Mirrors the new RAACMinter contract — the
@@ -24,6 +27,9 @@ export interface MinterInfo {
  * fields no longer exist; emissions are now driven by a time-based geometric
  * schedule (see `EmissionSchedule.sol`) and routed through weighted distribution
  * pools (see `getDistributionPools`).
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The minter state; RAAC amounts are `TokenAmount`s with the registry `raactoken` decimals and symbol.
  */
 declare function get(chainId: ChainId, provider?: Provider): Promise<MinterInfo>;
 export default get;

package/dist/types/minter/getApy.d.ts

@@ -1,10 +1,16 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains";
+import { TokenAmount } from "../utils/amount";
 export interface MinterApy {
-    emissionPerSecond: bigint;
-    yearlyEmission: bigint;
-    totalSupply: bigint;
+    /** RAAC emitted per second now, with the registry `raactoken` decimals and symbol. */
+    emissionPerSecond: TokenAmount;
+    /** RAAC scheduled over the next 365 days, with the registry `raactoken` decimals and symbol. */
+    yearlyEmission: TokenAmount;
+    /** Current RAAC total supply, with the registry `raactoken` decimals and symbol. */
+    totalSupply: TokenAmount;
+    /** `yearlyEmission / totalSupply` as a display percentage with 2 decimal places (12.34 = 12.34%). */
     apy: number;
+    /** `yearlyEmission / totalSupply` in basis points (10000 = 100%), rounded down. */
     apyBps: bigint;
 }
 /**
@@ -16,6 +22,9 @@ export interface MinterApy {
  * by current total RAAC supply.
  *
  * Returns zeros if minting hasn't been activated or supply is 0.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The emission figures and the APY.
  */
 declare function getApy(chainId: ChainId, provider?: Provider): Promise<MinterApy>;
 export default getApy;

package/dist/types/minter/getDistributionPools.d.ts

@@ -1,16 +1,24 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains";
+import { TokenAmount } from "../utils/amount";
 export interface DistributionPoolInfo {
+    /** The pool address. */
     pool: string;
+    /** The pool's weight (unitless, relative to `totalWeight`). */
     weight: bigint;
-    pendingRewards: string;
-    pendingRewardsRaw: bigint;
+    /** RAAC assigned to the pool but not yet sent, with the registry `raactoken` decimals and symbol. */
+    pendingRewards: TokenAmount;
+    /** Whether the pool is registered. */
     exists: boolean;
+    /** The pool's share of `totalWeight` as a display number from 0 to 1 (4 decimal places), 0 if `totalWeight` is 0. */
     weightShare: number;
 }
 /**
  * Returns full distribution-pool table along with each pool's share of
  * `totalWeight`. Iterates `distributionPools(i)` until it reverts (mirrors how
  * the contract stores the dynamic array) and reads `poolInfo(pool)` for each.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns One record per registered pool.
  */
 export declare const getDistributionPools: (chainId: ChainId, provider?: Provider) => Promise<DistributionPoolInfo[]>;

package/dist/types/minter/getEmissionPerSecond.d.ts

@@ -1,8 +1,10 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains";
+import { TokenAmount } from "../utils/amount";
 /**
  * Returns the current per-second RAAC emission. Derived by sampling
  * `calculateScheduledMintableAmount(now, now + 1)` at the latest block timestamp.
  * Returns 0 if minting hasn't been activated yet.
+ * @returns The RAAC emitted per second, with the registry `raactoken` decimals and symbol.
  */
-export declare const getEmissionPerSecond: (chainId: ChainId, provider?: Provider) => Promise<bigint>;
+export declare const getEmissionPerSecond: (chainId: ChainId, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/minter/getPoolInfo.d.ts

@@ -1,13 +1,21 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains";
+import { TokenAmount } from "../utils/amount";
 export interface MinterPoolInfo {
+    /** The pool address. */
     pool: string;
+    /** The pool's weight (unitless, relative to `totalWeight`). */
     weight: bigint;
-    pendingRewards: string;
-    pendingRewardsRaw: bigint;
+    /** RAAC assigned to the pool but not yet sent, with the registry `raactoken` decimals and symbol. */
+    pendingRewards: TokenAmount;
+    /** Whether the pool is registered. */
     exists: boolean;
 }
 /**
  * Read the per-pool record from the minter's `poolInfo` mapping.
+ * @param chainId The chain id.
+ * @param pool The pool address.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The pool record.
  */
 export declare const getPoolInfo: (chainId: ChainId, pool: string, provider?: Provider) => Promise<MinterPoolInfo>;

package/dist/types/nfts/_helpers.d.ts

@@ -0,0 +1,10 @@
+import { ChainId } from "../configs/chains";
+/** Config asset id used when a chain's `nfts.raacnft` entry does not name its payment token. */
+export declare const DEFAULT_NFT_ASSET_ID = "crvusd";
+/**
+ * The config asset id of the token RAACNFT is paid in, from `nfts.raacnft.asset`.
+ * House prices and mint prices are denominated in it.
+ * @param chainId The chain id.
+ * @returns The asset id.
+ */
+export declare function getNftAssetId(chainId: ChainId): string;

package/dist/types/nfts/getHousePrice.d.ts

@@ -1,4 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains/index";
-declare function getHousePrice(chainId: ChainId, tokenId: number, provider: Provider): Promise<string>;
+import { TokenAmount } from "../utils/amount";
+/**
+ * Reads the house price of a RAAC NFT, without the mint fee.
+ * @param chainId The chain id.
+ * @param tokenId The RAAC NFT token id.
+ * @param provider The provider to read with.
+ * @returns The price in the NFT's payment token, from the chain config (`nfts.raacnft.asset`).
+ */
+declare function getHousePrice(chainId: ChainId, tokenId: number, provider: Provider): Promise<TokenAmount>;
 export default getHousePrice;

package/dist/types/nfts/getMintFeePercentage.d.ts

@@ -1,4 +1,10 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains/index";
+/**
+ * Reads the RAAC NFT mint fee.
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns The mint fee in basis points (10000 = 100%), as `MINT_FEE_PERCENTAGE` stores it.
+ */
 declare function getMintFeePercentage(chainId: ChainId, provider: Provider): Promise<bigint>;
 export default getMintFeePercentage;

package/dist/types/nfts/getMintPrice.d.ts

@@ -1,7 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains/index";
-declare function getMintPrice(chainId: ChainId, tokenId: string | number, provider: Provider): Promise<{
-    price: bigint;
-    decimals: any;
-}>;
+import { TokenAmount } from "../utils/amount";
+/**
+ * Reads the total price to mint a RAAC NFT: the house price plus the mint fee.
+ * @param chainId The chain id.
+ * @param tokenId The RAAC NFT token id.
+ * @param provider The provider to read with.
+ * @returns The price in the NFT's payment token, from the chain config (`nfts.raacnft.asset`).
+ */
+declare function getMintPrice(chainId: ChainId, tokenId: string | number, provider: Provider): Promise<TokenAmount>;
 export default getMintPrice;

package/dist/types/nfts/mint.d.ts

@@ -1,4 +1,13 @@
 import { ethers, Signer } from "ethers";
 import { ChainId } from "../configs/chains/index";
-declare function mint(chainId: ChainId, tokenId: string, amount: string, signer: Signer): Promise<ethers.ContractTransactionResponse>;
+/**
+ * Mints a RAAC NFT, paying the mint price in the NFT's payment token (crvUSD). The signer must have approved the
+ * RAAC NFT contract for at least `amount`.
+ * @param chainId The chain id.
+ * @param tokenId The RAAC NFT token id.
+ * @param amount The maximum payment in payment token base units (see `getMintPrice`).
+ * @param signer The signer sending the transaction.
+ * @returns The transaction.
+ */
+declare function mint(chainId: ChainId, tokenId: string, amount: bigint, signer: Signer): Promise<ethers.ContractTransactionResponse>;
 export default mint;

package/dist/types/pools/lendingPool/_helpers.d.ts

@@ -2,9 +2,36 @@ import { BytesLike, ethers, Provider, Signer } from "ethers";
 import { ChainId } from "../../configs/chains";
 import { Adapter } from "../../configs/chains/chain";
 import { LendingPool } from "../../typechain-types";
+import { TokenAmount } from "../../utils/amount";
+/** Config asset id used when a chain's `pools.lendingpool` entry does not name its reserve asset. */
+export declare const DEFAULT_RESERVE_ASSET_ID = "crvusd";
+/**
+ * The config asset id of a chain's lending pool reserve asset, from `pools.lendingpool.asset`.
+ * rToken, deToken and debt amounts share the reserve asset's decimals.
+ * @param chainId The chain id.
+ * @returns The asset id.
+ */
+export declare function getReserveAssetId(chainId: ChainId): string;
+/**
+ * Wraps a reserve asset denominated value (reserve asset, rToken, deToken or debt amount; these tokens mirror the reserve asset's decimals).
+ * @param chainId The chain id.
+ * @param value The value in reserve asset base units.
+ * @returns The amount with the reserve asset's registry decimals and symbol.
+ */
+export declare function toReserveAmount(chainId: ChainId, value: bigint): TokenAmount;
 export declare function encodeERC721(tokenId: string): string;
 export declare function decodeERC721(data: BytesLike): ethers.Result;
-export declare function encodeERC20(amount: string): string;
+/**
+ * ABI-encodes an ERC20 adapter amount.
+ * @param amount The amount in the token's base units.
+ * @returns The encoded `uint256`.
+ */
+export declare function encodeERC20(amount: bigint): string;
+/**
+ * Decodes an ERC20 adapter amount.
+ * @param data The encoded `uint256`.
+ * @returns The amount in the token's base units.
+ */
 export declare function decodeERC20(data: BytesLike): bigint;
 export declare function getLendingPoolAdapterByAddress(chainId: ChainId, address: string): Adapter;
 export declare function getLendingPoolContract(chainId: ChainId, providerOrProvider?: Provider | Signer): Promise<LendingPool>;

package/dist/types/pools/lendingPool/adapters/erc20/getERC20AdapterBalance.d.ts

@@ -1,3 +1,13 @@
 import { Signer } from "ethers";
-declare function getERC20AdapterBalance(adapterAddress: string, userAddress: string, signer: Signer): Promise<string>;
+import { ChainId } from "../../../../configs/chains";
+import { TokenAmount } from "../../../../utils/amount";
+/**
+ * Reads how much of the adapter's ERC20 collateral a user has deposited.
+ * @param chainId The chain id, used to look up the adapter token's decimals in the token registry.
+ * @param adapterAddress The ERC20 asset adapter address.
+ * @param userAddress The user.
+ * @param signer The signer to read with.
+ * @returns The deposited balance in base units of the adapter's token, with its registry decimals and symbol (18 decimals if the token is not in the registry).
+ */
+declare function getERC20AdapterBalance(chainId: ChainId, adapterAddress: string, userAddress: string, signer: Signer): Promise<TokenAmount>;
 export default getERC20AdapterBalance;

package/dist/types/pools/lendingPool/borrowFromLendingPool.d.ts

@@ -1,5 +1,14 @@
 import { ChainId } from "../../configs/chains";
 import { LendingPoolAdapterId } from "./types";
 import { BytesLike, Signer } from "ethers";
-declare function borrowFromLendingPool(chainId: ChainId, adapterName: LendingPoolAdapterId, amount: string, data: BytesLike, signer: Signer): Promise<boolean>;
+/**
+ * Borrows the reserve asset against a collateral position.
+ * @param chainId The chain id.
+ * @param adapterName The lending pool adapter holding the collateral.
+ * @param amount The amount to borrow, in reserve asset (crvUSD) base units.
+ * @param data The adapter-encoded position data.
+ * @param signer The borrower.
+ * @returns Whether the transaction succeeded.
+ */
+declare function borrowFromLendingPool(chainId: ChainId, adapterName: LendingPoolAdapterId, amount: bigint, data: BytesLike, signer: Signer): Promise<boolean>;
 export default borrowFromLendingPool;

package/dist/types/pools/lendingPool/borrowFromLendingPoolWithInsurance.d.ts

@@ -1,5 +1,14 @@
 import { BytesLike, Signer } from "ethers";
 import { ChainId } from "../../configs/chains";
 import { LendingPoolAdapterId } from "./types";
-declare function borrowFromLendingPoolWithInsurance(chainId: ChainId, adapterName: LendingPoolAdapterId, amount: string, data: BytesLike, signer: Signer): Promise<boolean>;
+/**
+ * Borrows the reserve asset with insurance, approving the insurance fee in crvUSD first when needed.
+ * @param chainId The chain id.
+ * @param adapterName The lending pool adapter holding the collateral.
+ * @param amount The amount to borrow, in reserve asset (crvUSD) base units.
+ * @param data The adapter-encoded position data.
+ * @param signer The borrower.
+ * @returns Whether the transaction succeeded.
+ */
+declare function borrowFromLendingPoolWithInsurance(chainId: ChainId, adapterName: LendingPoolAdapterId, amount: bigint, data: BytesLike, signer: Signer): Promise<boolean>;
 export default borrowFromLendingPoolWithInsurance;

package/dist/types/pools/lendingPool/calculateInsuranceFee.d.ts

@@ -1,5 +1,16 @@
 import { BytesLike, Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
 import { LendingPoolAdapterId } from "./types";
-declare function calculateInsuranceFee(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, amount: string, provider: Provider): Promise<bigint>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Computes the insurance fee for borrowing `amount` with insurance, including any previously uninsured balance.
+ * @param chainId The chain id.
+ * @param adapterName The lending pool adapter holding the collateral.
+ * @param userAddress The borrower.
+ * @param data The adapter-encoded position data.
+ * @param amount The amount to borrow, in reserve asset (crvUSD) base units.
+ * @param provider The provider to read with.
+ * @returns The fee in reserve asset (crvUSD) base units.
+ */
+declare function calculateInsuranceFee(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, amount: bigint, provider: Provider): Promise<TokenAmount>;
 export default calculateInsuranceFee;

package/dist/types/pools/lendingPool/depositToLendingPool.d.ts

@@ -1,4 +1,11 @@
-import { ethers, Signer } from "ethers";
+import { Signer } from "ethers";
 import { ChainId } from "../../configs/chains";
-declare function depositToLendingPool(chainId: ChainId, amount: string, signer: Signer): Promise<ethers.ContractTransactionReceipt>;
+/**
+ * Deposits the reserve asset into the lending pool and receives rToken.
+ * @param chainId The chain id.
+ * @param amount The amount to deposit, in reserve asset (crvUSD) base units.
+ * @param signer The depositor.
+ * @returns The transaction receipt.
+ */
+declare function depositToLendingPool(chainId: ChainId, amount: bigint, signer: Signer): Promise<import("ethers").ContractTransactionReceipt>;
 export default depositToLendingPool;

package/dist/types/pools/lendingPool/getEligibleUserDeposits.d.ts

@@ -1,11 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
+import { TokenAmount } from "../../utils/amount";
 /**
  * @description Total amount of RToken + DEToken = total crvUSD they put in the system so far. How much they have contributed to the system.
- * @param chainId
- * @param address
- * @param provider
- * @returns
+ * @param chainId The chain id.
+ * @param address The user.
+ * @param provider The provider to read with.
+ * @returns The user's raw rToken deposits plus stability pool deposits, in reserve asset (crvUSD) base units.
  */
-declare function getEligibleUserDeposits(chainId: ChainId, address: string, provider: Provider): Promise<bigint>;
+declare function getEligibleUserDeposits(chainId: ChainId, address: string, provider: Provider): Promise<TokenAmount>;
 export default getEligibleUserDeposits;

package/dist/types/pools/lendingPool/getHealthFactor.d.ts

@@ -1,13 +1,14 @@
 import { BytesLike, Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
 import { LendingPoolAdapterId } from "./types";
+import { ScaledValue } from "../../utils/amount";
 /**
  * @description Get the health factor of a NFT position -> factor < 1 : undercollateralized.
- * @param chainId
- * @param adapterName
- * @param userAddress
- * @param data
- * @param provider
- * @returns The health factor of a position (0, inf)
+ * @param chainId The chain id.
+ * @param adapterName The lending pool adapter holding the collateral.
+ * @param userAddress The borrower.
+ * @param data The adapter-encoded position data.
+ * @param provider The provider to read with.
+ * @returns The health factor, 1e18-scaled (liquidatable below 1e18). A position with no debt returns 1e27 (`WadRayMath.RAY`), which reads as 1e9.
  */
-export default function getHealthFactor(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, provider: Provider): Promise<bigint>;
+export default function getHealthFactor(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, provider: Provider): Promise<ScaledValue>;

package/dist/types/pools/lendingPool/getHousePrice.d.ts

@@ -1,4 +1,12 @@
 import { Signer } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getHousePrice(chainId: ChainId, tokenId: number | string, signer: Signer): Promise<any>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Reads the latest crvUSD price of a RAAC NFT.
+ * @param chainId The chain id.
+ * @param tokenId The RAAC NFT token id.
+ * @param signer The signer to read with.
+ * @returns The house price in crvUSD base units. RAACHousePrices always returns it with 18 decimals.
+ */
+declare function getHousePrice(chainId: ChainId, tokenId: number | string, signer: Signer): Promise<TokenAmount>;
 export default getHousePrice;

package/dist/types/pools/lendingPool/getLendingPoolInfo.d.ts

@@ -1,24 +1,51 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains";
-declare function getLendingPoolInfo(chainId: ChainId, userAddress: string, provider: Provider): Promise<{
-    totalLiquidity: string;
-    totalBorrow: string;
-    utilization: string;
-    liquidityIndex: string;
-    usageIndex: string;
-    currentLiquidityRate: string;
-    currentUsageRate: string;
-    primeRate: string;
-    baseRate: string;
-    optimalRate: string;
-    maxRate: string;
-    optimalUtilizationRate: string;
-    protocolFeeRate: string;
-    normalizedIncome: string;
-    normalizedDebt: string;
-    apy: string;
-    userRedeemable: string;
-    apr: string;
-    pendingProtocolFeeAmount: string;
-}>;
+import { ScaledValue, TokenAmount } from "../../utils/amount";
+/**
+ * Lending pool state. Amounts are `TokenAmount`s in reserve asset (crvUSD) base units.
+ * Rates, indexes and utilization are ray (27-decimal) `ScaledValue`s: 1e27 is 1.0 (100% for rates and utilization).
+ */
+export interface LendingPoolInfo {
+    totalLiquidity: TokenAmount;
+    totalBorrow: TokenAmount;
+    utilization: ScaledValue;
+    liquidityIndex: ScaledValue;
+    usageIndex: ScaledValue;
+    /** Nominal annual supply rate. */
+    supplyRate: ScaledValue;
+    /** Nominal annual borrow rate. */
+    borrowRate: ScaledValue;
+    /** Supply APY. Equal to `supplyRate`, since the liquidity index accrues linearly. */
+    supplyApy: ScaledValue;
+    /** Borrow APY, `e^borrowRate - 1`, since the usage index compounds. */
+    borrowApy: ScaledValue;
+    primeRate: ScaledValue;
+    baseRate: ScaledValue;
+    optimalRate: ScaledValue;
+    maxRate: ScaledValue;
+    optimalUtilizationRate: ScaledValue;
+    protocolFeeRate: ScaledValue;
+    currentProtocolFeeRate: ScaledValue;
+    normalizedIncome: ScaledValue;
+    normalizedDebt: ScaledValue;
+    /** The user's rToken balance, i.e. the redeemable reserve asset amount. Zero when no user is given. */
+    userRedeemable: TokenAmount;
+    pendingProtocolFeeAmount: TokenAmount;
+    /** @deprecated use `supplyRate` */
+    currentLiquidityRate: ScaledValue;
+    /** @deprecated use `borrowRate` */
+    currentUsageRate: ScaledValue;
+    /** @deprecated use `borrowRate` */
+    apr: ScaledValue;
+    /** @deprecated use `supplyRate` */
+    apy: ScaledValue;
+}
+/**
+ * Reads the lending pool's reserve state, rates and, optionally, a user's redeemable balance.
+ * @param chainId The chain id.
+ * @param userAddress The user whose rToken balance to include in `userRedeemable`.
+ * @param provider The provider to read with. Defaults to the chain's first configured RPC.
+ * @returns The pool info; see `LendingPoolInfo` for units.
+ */
+declare function getLendingPoolInfo(chainId: ChainId, userAddress?: string, provider?: Provider): Promise<LendingPoolInfo>;
 export default getLendingPoolInfo;

package/dist/types/pools/lendingPool/getLendingPoolTotalLiquidity.d.ts

@@ -1,4 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains";
-declare function getLendingPoolTotalLiquidity(chainId: ChainId, provider: Provider): Promise<bigint>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Reads the lending pool's total liquidity.
+ * @deprecated Use `getLendingPoolInfo(...).totalLiquidity`.
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns The total liquidity in reserve asset (crvUSD) base units.
+ */
+declare function getLendingPoolTotalLiquidity(chainId: ChainId, provider: Provider): Promise<TokenAmount>;
 export default getLendingPoolTotalLiquidity;

package/dist/types/pools/lendingPool/getParameters.d.ts

@@ -1,16 +1,35 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getParameters(chainId: ChainId, provider: Provider): Promise<{
+import { TokenAmount } from "../../utils/amount";
+/** Lending pool protocol parameters. Amounts are in reserve asset (crvUSD) base units. */
+export interface LendingPoolParameters {
     canPaybackDebt: boolean;
     withdrawalsPaused: boolean;
+    /** Liquidation threshold in basis points (10000 = 100%). */
     liquidationThreshold: bigint;
+    /** Liquidation grace period in seconds. */
     liquidationGracePeriod: bigint;
+    /** Insurance fee in basis points (10000 = 100%). */
     insuranceFee: bigint;
+    /** Deposit fee in basis points (10000 = 100%). */
     depositFee: bigint;
+    /** Liquidity buffer ratio in basis points (10000 = 100%). */
     liquidityBufferRatio: bigint;
-    supplyCap: bigint;
-    borrowCap: bigint;
-    vaultOpeningFee: bigint;
+    supplyCap: TokenAmount;
+    borrowCap: TokenAmount;
+    vaultOpeningFee: TokenAmount;
+    /** Borrow threshold in basis points (10000 = 100%). */
     borrowThreshold: bigint;
-}>;
+    minDepositAmount: TokenAmount;
+    /** Maximum prime rate change per update in basis points (10000 = 100%). */
+    primeRateChangeBps: bigint;
+    minVaultRebalanceAmount: TokenAmount;
+}
+/**
+ * Reads the lending pool's protocol parameters.
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns The parameters: caps, fees and minimums as `TokenAmount`s in reserve asset base units, ratios as basis points.
+ */
+declare function getParameters(chainId: ChainId, provider: Provider): Promise<LendingPoolParameters>;
 export default getParameters;

package/dist/types/pools/lendingPool/getPositionDebt.d.ts

@@ -1,12 +1,15 @@
 import { ChainId } from "../../configs/chains";
 import { LendingPoolAdapterId } from "./types";
+import { TokenAmount } from "../../utils/amount";
 import { BytesLike, Provider } from "ethers";
 /**
  * @description Get the raw debt of the user on a NFT. Equivant to the original amount borrowed on NFT.
- * @param chainId
- * @param address
- * @param provider
- * @returns The raw debt of the user on a NFT
+ * @param chainId The chain id.
+ * @param adapterName The lending pool adapter holding the collateral.
+ * @param userAddress The borrower.
+ * @param data The adapter-encoded position data.
+ * @param provider The provider to read with.
+ * @returns The raw debt of the position (principal, without accrued interest), in reserve asset (crvUSD) base units.
  */
-declare function getPositionDebt(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, provider: Provider): Promise<bigint>;
+declare function getPositionDebt(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, provider: Provider): Promise<TokenAmount>;
 export default getPositionDebt;

package/dist/types/pools/lendingPool/getPositionScaledDebt.d.ts

@@ -1,14 +1,15 @@
 import { ChainId } from "../../configs/chains";
 import { LendingPoolAdapterId } from "./types";
+import { TokenAmount } from "../../utils/amount";
 import { BytesLike, Provider } from "ethers";
 /**
  * @description Get the scaled debt of the user on a NFT (contains the accured interest)
- * @param chainId
- * @param lendingPoolAddress
- * @param adapterName
- * @param userAddress
- * @param data
- * @returns The  debt of the user on a NFT with the accured interest
+ * @param chainId The chain id.
+ * @param adapterName The lending pool adapter holding the collateral.
+ * @param userAddress The borrower.
+ * @param data The adapter-encoded position data.
+ * @param provider The provider to read with.
+ * @returns The debt of the position including accrued interest, in reserve asset (crvUSD) base units.
  */
-declare function getPositionScaledDebt(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, provider: Provider): Promise<bigint>;
+declare function getPositionScaledDebt(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, provider: Provider): Promise<TokenAmount>;
 export default getPositionScaledDebt;

package/dist/types/pools/lendingPool/getPositionView.d.ts

@@ -1,25 +1,40 @@
 import { BytesLike, Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
 import { LendingPoolAdapterId } from "./types";
-export declare function transformPositionView(positionView: any): {
-    rawDebtBalance: string;
-    scaledDebtBalance: string;
-    healthFactor: any;
-    isUnderLiquidation: any;
-    liquidationStartTime: any;
-    positionIndex: any;
-    isInsured: any;
-    adapter: any;
-    asset: any;
-};
+import { ScaledValue, TokenAmount } from "../../utils/amount";
+import { ILendingPoolStorage } from "../../typechain-types/contracts/core/pools/LendingPool/LendingPool";
+/** A collateral position as returned by `LendingPool.getPositionView`. */
+export interface PositionView {
+    /** Principal debt without accrued interest, in reserve asset (crvUSD) base units. */
+    rawDebtBalance: TokenAmount;
+    /** Debt including accrued interest, in reserve asset (crvUSD) base units. */
+    scaledDebtBalance: TokenAmount;
+    /** Health factor, 1e18-scaled (liquidatable below 1e18). A position with no debt reports 1e27 (`WadRayMath.RAY`). */
+    healthFactor: ScaledValue;
+    isUnderLiquidation: boolean;
+    /** Liquidation start time as a unix timestamp string, `"0"` when not under liquidation. */
+    liquidationStartTime: string;
+    /** Usage index (ray, 27 decimals) at the position's last debt update. */
+    positionIndex: ScaledValue;
+    isInsured: boolean;
+    adapter: string;
+    asset: string;
+}
+/**
+ * Maps the on-chain `CollateralPositionView` struct to a `PositionView`.
+ * @param positionView The struct returned by `LendingPool.getPositionView`.
+ * @param chainId The chain id, used to resolve the reserve asset's decimals.
+ * @returns The position view.
+ */
+export declare function transformPositionView(positionView: ILendingPoolStorage.CollateralPositionViewStructOutput, chainId: ChainId): PositionView;
 /**
  * @description Return all the information about a NFT position
- * @param chainId
- * @param adapterName
- * @param userAddress
- * @param data
- * @param provider
- * @returns All information about a NFT position
+ * @param chainId The chain id.
+ * @param adapterName The lending pool adapter holding the collateral.
+ * @param userAddress The borrower.
+ * @param data The adapter-encoded position data.
+ * @param provider The provider to read with.
+ * @returns The position's debts, health factor, liquidation state, index, insurance flag, adapter and asset.
  */
-declare function getPositionView(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, provider: Provider): Promise<ReturnType<typeof transformPositionView>>;
+declare function getPositionView(chainId: ChainId, adapterName: LendingPoolAdapterId, userAddress: string, data: BytesLike, provider: Provider): Promise<PositionView>;
 export default getPositionView;