@raac/rpc 1.2.0-beta.9 → 2.0.0-beta.1

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;

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

@@ -1,11 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
+import { TokenAmount } from "../../utils/amount";
 /**
  * @description Get the sum of all the scaled debts of a user over all NFTs
- * @param chainId
- * @param address
- * @param provider
- * @returns The  debt of the user
+ * @param chainId The chain id.
+ * @param address The user.
+ * @param provider The provider to read with.
+ * @returns The user's total debt including accrued interest, in reserve asset (crvUSD) base units.
  */
-declare function getPositionsScaledDebt(chainId: ChainId, address: string, provider: Provider): Promise<bigint>;
+declare function getPositionsScaledDebt(chainId: ChainId, address: string, provider: Provider): Promise<TokenAmount>;
 export default getPositionsScaledDebt;

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

@@ -1,4 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getRawUserDepositsInLendingPool(chainId: ChainId, address: string, provider: Provider): Promise<bigint>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Reads the user's raw rToken balance in the lending pool, without accrued interest.
+ * @param chainId The chain id.
+ * @param address The user.
+ * @param provider The provider to read with.
+ * @returns The raw deposit in rToken (reserve asset, crvUSD) base units.
+ */
+declare function getRawUserDepositsInLendingPool(chainId: ChainId, address: string, provider: Provider): Promise<TokenAmount>;
 export default getRawUserDepositsInLendingPool;

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

@@ -1,11 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
+import { TokenAmount } from "../../utils/amount";
 /**
  * @description Sum of the prices of all the NFTS
- * @param chainId
- * @param address
- * @param provider
- * @returns The total value of the collateral
+ * @param chainId The chain id.
+ * @param address The user.
+ * @param provider The provider to read with.
+ * @returns The total collateral value in crvUSD base units. Asset adapters always price with 18 decimals.
  */
-declare function getUserCollateralValue(chainId: ChainId, address: string, provider: Provider): Promise<bigint>;
+declare function getUserCollateralValue(chainId: ChainId, address: string, provider: Provider): Promise<TokenAmount>;
 export default getUserCollateralValue;

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

@@ -1,4 +1,4 @@
-import { ethers, Signer } from "ethers";
+import { Signer } from "ethers";
 import { ChainId } from "../../configs/chains";
-declare function openVaultPosition(chainId: ChainId, signer: Signer): Promise<ethers.ContractTransactionReceipt>;
+declare function openVaultPosition(chainId: ChainId, signer: Signer): Promise<import("ethers").ContractTransactionReceipt>;
 export default openVaultPosition;

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

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

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

@@ -1,4 +1,12 @@
 import { ethers, Signer } from "ethers";
 import { ChainId } from "../../configs/chains";
-declare function withdrawFromLendingPool(chainId: ChainId, amount: string, signer: Signer): Promise<ethers.ContractTransactionReceipt>;
+/**
+ * Redeems rToken for the reserve asset.
+ * @param chainId The chain id.
+ * @param amount The amount to withdraw, in rToken (reserve asset, crvUSD) base units.
+ * @param signer The rToken holder.
+ * @returns The transaction receipt.
+ * @throws If the signer's rToken balance is below `amount`.
+ */
+declare function withdrawFromLendingPool(chainId: ChainId, amount: bigint, signer: Signer): Promise<ethers.ContractTransactionReceipt>;
 export default withdrawFromLendingPool;

package/dist/types/pools/liquidityPool/getLiquidityPoolInfo.d.ts

@@ -1,7 +1,32 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
+import { ScaledValue, TokenAmount } from "../../utils/amount";
+/** Per-market liquidity pool state. */
+export interface LiquidityPoolMarketInfo {
+    totalLiquidity: {
+        raac: TokenAmount;
+        paired: TokenAmount;
+    };
+    userLiquidity: {
+        raac: TokenAmount;
+        paired: TokenAmount;
+        lpAmount: TokenAmount;
+    };
+    /** Exchange rates, 1e18-scaled. */
+    exchangeRate: {
+        raacPerPaired: ScaledValue;
+        pairedPerRaac: ScaledValue;
+    };
+}
+/**
+ * Reads liquidity pool markets. The liquidity pool is disabled and this method is not wired into `RPCLibrary`.
+ * @param chainId The chain id.
+ * @param address The user, or an empty string to skip user reads.
+ * @param provider The provider to read with.
+ * @returns Market info keyed by paired token, and the TVL (18 decimals, fixed by the contract).
+ */
 declare function getLiquidityPoolInfo(chainId: ChainId, address: string, provider: Provider): Promise<{
-    markets: {};
-    tvl: string;
+    markets: Record<string, LiquidityPoolMarketInfo>;
+    tvl: TokenAmount;
 }>;
 export default getLiquidityPoolInfo;

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

@@ -2,9 +2,29 @@ import { BytesLike, ethers, Provider, Signer } from "ethers";
 import { ChainId } from "../../configs/chains";
 import { Adapter } from "../../configs/chains/chain";
 import { RWAVault } from "../../typechain-types";
+import { TokenAmount } from "../../utils/amount";
+/** Config asset id of the RWA vault's share token. */
+export declare const VAULT_SHARE_ASSET_ID = "rwaindextoken";
+/**
+ * Wraps an RWA vault share amount (the RWA index token).
+ * @param chainId The chain id.
+ * @param value The shares in base units.
+ * @returns The amount with the share token's registry decimals and symbol.
+ */
+export declare function toShareAmount(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 getRWAVaultAdapterByAddress(chainId: ChainId, address: string): Adapter;
 export declare function getRWAVaultContract(chainId: ChainId, provider_signer?: Provider | Signer): Promise<RWAVault>;

package/dist/types/pools/rwaVault/adapters/erc20/getERC20VaultAdapterAssetValue.d.ts

@@ -1,3 +1,11 @@
 import { Signer } from "ethers";
-declare function getERC20VaultAdapterAssetValue(adapterAddress: string, amount: bigint, signer: Signer): Promise<bigint>;
+import { TokenAmount } from "../../../../utils/amount";
+/**
+ * Values an amount of the adapter's ERC20 token.
+ * @param adapterAddress The ERC20 vault adapter address.
+ * @param amount The token amount, in the adapter token's base units.
+ * @param signer The signer to read with.
+ * @returns The value in crvUSD base units. The adapter always normalizes to 18 decimals.
+ */
+declare function getERC20VaultAdapterAssetValue(adapterAddress: string, amount: bigint, signer: Signer): Promise<TokenAmount>;
 export default getERC20VaultAdapterAssetValue;

package/dist/types/pools/rwaVault/adapters/erc20/getERC20VaultAdapterTotalValue.d.ts

@@ -1,3 +1,10 @@
 import { Signer } from "ethers";
-declare function getERC20VaultAdapterTotalValue(adapterAddress: string, signer: Signer): Promise<bigint>;
+import { TokenAmount } from "../../../../utils/amount";
+/**
+ * Reads the value of all tokens held by an ERC20 vault adapter.
+ * @param adapterAddress The ERC20 vault adapter address.
+ * @param signer The signer to read with.
+ * @returns The value in crvUSD base units. The adapter always normalizes to 18 decimals.
+ */
+declare function getERC20VaultAdapterTotalValue(adapterAddress: string, signer: Signer): Promise<TokenAmount>;
 export default getERC20VaultAdapterTotalValue;

package/dist/types/pools/rwaVault/adapters/erc721/getERC721VaultAdapterAssetValue.d.ts

@@ -1,3 +1,11 @@
 import { Signer } from "ethers";
-declare function getERC721VaultAdapterAssetValue(adapterAddress: string, tokenId: bigint, signer: Signer): Promise<bigint>;
+import { TokenAmount } from "../../../../utils/amount";
+/**
+ * Values an NFT held by an ERC721 vault adapter.
+ * @param adapterAddress The ERC721 vault adapter address.
+ * @param tokenId The NFT token id.
+ * @param signer The signer to read with.
+ * @returns The oracle value in crvUSD base units, 18 decimals.
+ */
+declare function getERC721VaultAdapterAssetValue(adapterAddress: string, tokenId: bigint, signer: Signer): Promise<TokenAmount>;
 export default getERC721VaultAdapterAssetValue;

package/dist/types/pools/rwaVault/adapters/erc721/getERC721VaultAdapterTotalValue.d.ts

@@ -1,3 +1,10 @@
 import { Signer } from "ethers";
-declare function getERC721VaultAdapterTotalValue(adapterAddress: string, signer: Signer): Promise<bigint>;
+import { TokenAmount } from "../../../../utils/amount";
+/**
+ * Reads the value of all NFTs held by an ERC721 vault adapter.
+ * @param adapterAddress The ERC721 vault adapter address.
+ * @param signer The signer to read with.
+ * @returns The summed oracle value in crvUSD base units, 18 decimals.
+ */
+declare function getERC721VaultAdapterTotalValue(adapterAddress: string, signer: Signer): Promise<TokenAmount>;
 export default getERC721VaultAdapterTotalValue;

package/dist/types/pools/rwaVault/depositToRWAVault.d.ts

@@ -1,5 +1,15 @@
-import { BytesLike, ethers, Signer } from "ethers";
+import { BytesLike, Signer } from "ethers";
 import { ChainId } from "../../configs/chains/index";
 import { RWAVaultAdapterId } from "./types";
-declare function depositToRWAVault(chainId: ChainId, adapter: RWAVaultAdapterId, data: BytesLike, receiver: string, minSharesOut: string, signer: Signer): Promise<ethers.ContractTransactionReceipt>;
+/**
+ * Deposits an asset into the RWA vault through an adapter and mints vault shares to `receiver`.
+ * @param chainId The chain id.
+ * @param adapter The RWA vault adapter id.
+ * @param data The adapter-encoded asset data.
+ * @param receiver The share recipient.
+ * @param minSharesOut The minimum shares to mint, in share token (RWA index token) base units.
+ * @param signer The depositor.
+ * @returns The transaction receipt.
+ */
+declare function depositToRWAVault(chainId: ChainId, adapter: RWAVaultAdapterId, data: BytesLike, receiver: string, minSharesOut: bigint, signer: Signer): Promise<import("ethers").ContractTransactionReceipt>;
 export default depositToRWAVault;

package/dist/types/pools/rwaVault/getRWAVaultInfo.d.ts

@@ -1,15 +1,27 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-interface RWAVaultInfo {
-    totalAssets: string;
-    pricePerShare: string;
+import { TokenAmount } from "../../utils/amount";
+/** RWA vault state. Values are in crvUSD base units with 18 decimals, as priced by the vault adapters. */
+export interface RWAVaultInfo {
+    /** Total value of all assets held by the vault. */
+    totalAssets: TokenAmount;
+    /** Value of 1e18 share base units (one whole share for an 18-decimal index token). */
+    pricePerShare: TokenAmount;
     vaultToken: string;
     stabilityPool: string;
     vrfConsumer: string;
-    indexTokenMintingFee: string;
+    /** Index token minting fee in basis points (10000 = 100%). */
+    indexTokenMintingFee: bigint;
     feeCollector: string;
+    /** Minimum delay between VRF requests, in seconds. */
     vrfRequestDelay: string;
     allowVRFRequest: boolean;
 }
+/**
+ * Reads the RWA vault's state.
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns The vault info; see `RWAVaultInfo` for units.
+ */
 declare function getRWAVaultInfo(chainId: ChainId, provider: Provider): Promise<RWAVaultInfo>;
 export default getRWAVaultInfo;

package/dist/types/pools/rwaVault/previewDeposit.d.ts

@@ -1,4 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function previewDeposit(chainId: ChainId, assetValue: string, provider: Provider): Promise<bigint>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Previews how many vault shares are minted for depositing `assetValue`.
+ * @param chainId The chain id.
+ * @param assetValue The asset value in vault value base units (crvUSD, 18 decimals, as returned by the vault adapters).
+ * @param provider The provider to read with.
+ * @returns The shares (rounded down), in share token (RWA index token) base units.
+ */
+declare function previewDeposit(chainId: ChainId, assetValue: bigint, provider: Provider): Promise<TokenAmount>;
 export default previewDeposit;

package/dist/types/pools/rwaVault/previewWithdraw.d.ts

@@ -1,4 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function previewWithdraw(chainId: ChainId, assetValue: string, provider: Provider): Promise<bigint>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Previews how many vault shares are burned to withdraw `assetValue`.
+ * @param chainId The chain id.
+ * @param assetValue The asset value in vault value base units (crvUSD, 18 decimals, as returned by the vault adapters).
+ * @param provider The provider to read with.
+ * @returns The shares (rounded up), in share token (RWA index token) base units.
+ */
+declare function previewWithdraw(chainId: ChainId, assetValue: bigint, provider: Provider): Promise<TokenAmount>;
 export default previewWithdraw;

package/dist/types/pools/rwaVault/redeemNFTFromRWAVault.d.ts

@@ -1,5 +1,14 @@
-import { ethers, Signer } from "ethers";
+import { Signer } from "ethers";
 import { ChainId } from "../../configs/chains/index";
 import { RWAVaultAdapterId } from "./types";
-declare function redeemNFTFromRWAVault(chainId: ChainId, adapter: RWAVaultAdapterId, tokenId: string, maxSharesBurn: string, signer: Signer): Promise<ethers.ContractTransactionReceipt>;
+/**
+ * Burns vault shares to redeem a specific NFT from the RWA vault.
+ * @param chainId The chain id.
+ * @param adapter The RWA vault adapter id holding the NFT.
+ * @param tokenId The NFT token id.
+ * @param maxSharesBurn The maximum shares to burn, in share token (RWA index token) base units.
+ * @param signer The redeemer.
+ * @returns The transaction receipt.
+ */
+declare function redeemNFTFromRWAVault(chainId: ChainId, adapter: RWAVaultAdapterId, tokenId: string, maxSharesBurn: bigint, signer: Signer): Promise<import("ethers").ContractTransactionReceipt>;
 export default redeemNFTFromRWAVault;

package/dist/types/pools/stabilityPool/depositToStabilityPool.d.ts

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

package/dist/types/pools/stabilityPool/getRawUserDepositsInStabilityPool.d.ts

@@ -1,4 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getRawUserDepositInStabilityPool(chainId: ChainId, address: string, provider: Provider): Promise<bigint>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Reads the user's raw stability pool deposit, without accrued interest.
+ * @param chainId The chain id.
+ * @param address The user.
+ * @param provider The provider to read with.
+ * @returns The deposit in deToken base units (reserve asset, crvUSD, decimals).
+ */
+declare function getRawUserDepositInStabilityPool(chainId: ChainId, address: string, provider: Provider): Promise<TokenAmount>;
 export default getRawUserDepositInStabilityPool;

package/dist/types/pools/stabilityPool/getStabilityPoolInfo.d.ts

@@ -1,7 +1,18 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getStabilityPoolInfo(chainId: ChainId, address: string, provider: Provider): Promise<{
-    totalDeposits: string;
-    userDeposit: string;
-}>;
+import { TokenAmount } from "../../utils/amount";
+/** Stability pool totals, in deToken base units (reserve asset, crvUSD, decimals). */
+export interface StabilityPoolInfo {
+    totalDeposits: TokenAmount;
+    /** The user's deposit. Zero when no user is given. */
+    userDeposit: TokenAmount;
+}
+/**
+ * Reads the stability pool's total deposits and, optionally, a user's deposit.
+ * @param chainId The chain id.
+ * @param address The user, or an empty string to skip the user read.
+ * @param provider The provider to read with.
+ * @returns The totals; see `StabilityPoolInfo`.
+ */
+declare function getStabilityPoolInfo(chainId: ChainId, address: string, provider: Provider): Promise<StabilityPoolInfo>;
 export default getStabilityPoolInfo;

package/dist/types/pools/stabilityPool/getStabilityPoolTotalDeposits.d.ts

@@ -1,4 +1,11 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getStabilityPoolTotalDeposits(chainId: ChainId, provider: Provider): Promise<bigint>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Reads the stability pool's total deposits (deToken total supply).
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns The total deposits in deToken base units (reserve asset, crvUSD, decimals).
+ */
+declare function getStabilityPoolTotalDeposits(chainId: ChainId, provider: Provider): Promise<TokenAmount>;
 export default getStabilityPoolTotalDeposits;

package/dist/types/pools/stabilityPool/getWithdrawRequestInfo.d.ts

@@ -1,13 +1,26 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains";
-interface WithdrawRequestInfo {
-    amount: string;
-    indexAtRequest: number;
-    balanceAtRequest: string;
-    userIndexAtRequest: number;
+import { ScaledValue, TokenAmount } from "../../utils/amount";
+/** A pending stability pool withdraw request. Amounts are in deToken base units (reserve asset, crvUSD, decimals). */
+export interface WithdrawRequestInfo {
+    amount: TokenAmount;
+    /** Lending pool liquidity index (ray, 27 decimals) at request time. */
+    indexAtRequest: ScaledValue;
+    balanceAtRequest: TokenAmount;
+    /** The user's deToken index (ray, 27 decimals) at request time. */
+    userIndexAtRequest: ScaledValue;
+    /** Unix timestamp in seconds. */
     readyAt: number;
+    /** Unix timestamp in seconds. */
     expiresAt: number;
+    /** Withdraw timelock duration in seconds. */
     duration: number;
 }
+/**
+ * Reads a user's pending stability pool withdraw request.
+ * @param chainId The chain id.
+ * @param userAddress The user.
+ * @param provider The provider to read with.
+ * @returns The request, or `null` when there is none.
+ */
 export declare function getWithdrawRequestInfo(chainId: ChainId, userAddress: string, provider: Provider): Promise<WithdrawRequestInfo | null>;
-export {};

package/dist/types/pools/stabilityPool/requestWithdraw.d.ts

@@ -1,4 +1,11 @@
-import { ethers, Signer } from "ethers";
+import { Signer } from "ethers";
 import { ChainId } from "../../configs/chains";
-declare function requestWithdraw(chainId: ChainId, amount: string, signer: Signer): Promise<ethers.ContractTransactionReceipt>;
+/**
+ * Queues a timelocked stability pool withdrawal.
+ * @param chainId The chain id.
+ * @param amount The deToken amount to withdraw later, in base units (reserve asset decimals). `0n` cancels a pending request.
+ * @param signer The depositor.
+ * @returns The transaction receipt.
+ */
+declare function requestWithdraw(chainId: ChainId, amount: bigint, signer: Signer): Promise<import("ethers").ContractTransactionReceipt>;
 export { requestWithdraw };

package/dist/types/pools/stabilityPool/withdrawFromStabilityPool.d.ts

@@ -1,4 +1,11 @@
-import { ethers, Signer } from "ethers";
+import { Signer } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function withdrawFromStabilityPool(chainId: ChainId, amount: string, signer: Signer): Promise<ethers.ContractTransactionReceipt>;
+/**
+ * Redeems deToken from the stability pool for rToken. When a withdraw timelock is active, `amount` must match the pending request.
+ * @param chainId The chain id.
+ * @param amount The deToken amount to redeem, in base units (reserve asset decimals). `ethers.MaxUint256` withdraws the full requested balance plus interest.
+ * @param signer The depositor.
+ * @returns The transaction receipt.
+ */
+declare function withdrawFromStabilityPool(chainId: ChainId, amount: bigint, signer: Signer): Promise<import("ethers").ContractTransactionReceipt>;
 export default withdrawFromStabilityPool;

package/dist/types/prices/getPrices.d.ts

@@ -1,5 +1,12 @@
-export declare const getPrices: () => Promise<{
-    pmUSD: number;
-    crvUSD: number;
-    raac: number;
-}>;
+import { ScaledValue } from "../utils/amount";
+/** Placeholder USD prices per whole token, each scaled by 1e18. */
+export interface Prices {
+    pmUSD: ScaledValue;
+    crvUSD: ScaledValue;
+    raac: ScaledValue;
+}
+/**
+ * Returns the USD price of each token.
+ * @returns The prices, each a USD price per whole token scaled by 1e18.
+ */
+export declare const getPrices: () => Promise<Prices>;