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

package/dist/types/contracts/pmMarket/getMarketConfig.d.ts

@@ -1,13 +1,22 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getMarketConfig(chainId: ChainId): Promise<{
-    stabilityRatio: string;
-    liquidationRatio: string;
-    selfLiquidationRatio: string;
-    recapRatio: string;
-} | {
-    stabilityRatio: number;
-    liquidationRatio: number;
-    selfLiquidationRatio: number;
-    recapRatio: number;
-}>;
+import { ScaledValue } from "../../utils/amount";
+/** The pmMarket collateral ratio thresholds, each scaled by 1e18 (`decimals: 18`, 1.3e18 = 130%). */
+export interface PmMarketConfig {
+    /** Collateral ratio below which the system enters stability mode. */
+    stabilityRatio: ScaledValue;
+    /** Collateral ratio below which incentivized user liquidation starts. */
+    liquidationRatio: ScaledValue;
+    /** Collateral ratio below which self liquidation starts. */
+    selfLiquidationRatio: ScaledValue;
+    /** Collateral ratio below which recap mode starts. */
+    recapRatio: ScaledValue;
+}
+/**
+ * Reads the pmMarket (f(x) v1 Market) `marketConfig`.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The ratio thresholds, each scaled by 1e18.
+ */
+declare function getMarketConfig(chainId: ChainId, provider?: Provider): Promise<PmMarketConfig>;
 export default getMarketConfig;

package/dist/types/contracts/pmTreasury/_helpers.d.ts

@@ -0,0 +1,27 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../configs/chains/index";
+/**
+ * Decimals of the treasury's base token amounts. The f(x) v1 Treasury compares
+ * `baseSupply * baseNav * 1e18 / (fSupply * fNav)` against 1e18, which only holds for an 18-decimal base token,
+ * so the contract fixes base token amounts at 18 decimals.
+ */
+export declare const BASE_TOKEN_DECIMALS = 18;
+/**
+ * Resolves the provider to read with, falling back to the chain's first configured RPC.
+ * @param chainId The chain id.
+ * @param provider An optional provider.
+ * @returns The provider.
+ */
+export declare function resolvePmTreasuryProvider(chainId: ChainId, provider?: Provider): Provider;
+/**
+ * Builds the pmTreasury contract (an f(x) v1 Treasury) for reads.
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns The contract.
+ */
+export declare function getPmTreasuryContract(chainId: ChainId, provider: Provider): any;
+/**
+ * Throws if a collateral ratio is not above 1.0, which the treasury would revert on anyway.
+ * @param newCollateralRatio The ratio, scaled by 1e18.
+ */
+export declare function assertCollateralRatio(newCollateralRatio: bigint): void;

package/dist/types/contracts/pmTreasury/getCollateralRatio.d.ts

@@ -1,3 +1,11 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getCollateralRatio(chainId: ChainId): Promise<any>;
+import { ScaledValue } from "../../utils/amount";
+/**
+ * Reads the pmTreasury collateral ratio.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The collateral ratio scaled by 1e18 (`decimals: 18`, 1.5e18 = 150%).
+ */
+declare function getCollateralRatio(chainId: ChainId, provider?: Provider): Promise<ScaledValue>;
 export default getCollateralRatio;

package/dist/types/contracts/pmTreasury/getCurrentNav.d.ts

@@ -1,11 +1,20 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getCurrentNav(chainId: ChainId): Promise<{
-    goldNav: string;
-    goldUSDNav: string;
-    xGoldNav: string;
-} | {
-    goldNav: number;
-    goldUSDNav: number;
-    xGoldNav: number;
-}>;
+import { ScaledValue } from "../../utils/amount";
+/** Net asset values from the pmTreasury, each a USD price per whole token scaled by 1e18. */
+export interface PmTreasuryNav {
+    /** NAV of the base token (`_baseNav`), `decimals: 18`. */
+    goldNav: ScaledValue;
+    /** NAV of pmUSD (`_fNav`), `decimals: 18`. */
+    goldUSDNav: ScaledValue;
+    /** NAV of xPM (`_xNav`), `decimals: 18`. */
+    xGoldNav: ScaledValue;
+}
+/**
+ * Reads the current NAVs of the base token, pmUSD and xPM.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The NAVs, each scaled by 1e18.
+ */
+declare function getCurrentNav(chainId: ChainId, provider?: Provider): Promise<PmTreasuryNav>;
 export default getCurrentNav;

package/dist/types/contracts/pmTreasury/getLeverageRatio.d.ts

@@ -1,3 +1,11 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getLeverageRatio(chainId: ChainId): Promise<any>;
+import { ScaledValue } from "../../utils/amount";
+/**
+ * Reads the pmTreasury EMA leverage ratio of xPM.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The leverage ratio scaled by 1e18 (`decimals: 18`, 2e18 = 2x).
+ */
+declare function getLeverageRatio(chainId: ChainId, provider?: Provider): Promise<ScaledValue>;
 export default getLeverageRatio;

package/dist/types/contracts/pmTreasury/getMaxMintablePMUSD.d.ts

@@ -1,11 +1,19 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getMaxMintablePMUSD(chainId: ChainId, newCollateralRatio: number): Promise<{
-    maxPMIn: string;
-    maxPMUSDMintable: string;
-    maxPMUSDUSDMintable?: undefined;
-} | {
-    maxPMIn: number;
-    maxPMUSDUSDMintable: number;
-    maxPMUSDMintable?: undefined;
-}>;
+import { TokenAmount } from "../../utils/amount";
+/** Result of `getMaxMintablePMUSD`. */
+export interface MaxMintablePMUSD {
+    /** Base token to deposit, with 18 decimals (fixed by the treasury math). */
+    maxPMIn: TokenAmount;
+    /** pmUSD mintable, in pmUSD decimals. */
+    maxPMUSDMintable: TokenAmount;
+}
+/**
+ * Reads the most pmUSD mintable, and the base token needed, before the collateral ratio falls to `newCollateralRatio`.
+ * @param chainId The chain id.
+ * @param newCollateralRatio The target collateral ratio scaled by 1e18 (e.g. `1_300_000_000_000_000_000n` for 130%). Must be greater than 1e18.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The base token amount (18 decimals) and the pmUSD amount (registry `pmusd` decimals and symbol).
+ */
+declare function getMaxMintablePMUSD(chainId: ChainId, newCollateralRatio: bigint, provider?: Provider): Promise<MaxMintablePMUSD>;
 export default getMaxMintablePMUSD;

package/dist/types/contracts/pmTreasury/getMaxMintablePMUSDWithoutBaseToken.d.ts

@@ -1,7 +1,17 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getMaxMintablePMUSDWithoutBaseToken(chainId: ChainId, newCollateralRatio: number): Promise<{
-    maxPMUSDMintable: string;
-} | {
-    maxPMUSDMintable: number;
-}>;
+import { TokenAmount } from "../../utils/amount";
+/** Result of `getMaxMintablePMUSDWithoutBaseToken`. */
+export interface MaxMintablePMUSDWithoutBaseToken {
+    /** pmUSD mintable without depositing base token, in pmUSD decimals. */
+    maxPMUSDMintable: TokenAmount;
+}
+/**
+ * Reads the most pmUSD mintable without depositing base token before the collateral ratio falls to `newCollateralRatio`.
+ * @param chainId The chain id.
+ * @param newCollateralRatio The target collateral ratio scaled by 1e18 (e.g. `1_300_000_000_000_000_000n` for 130%). Must be greater than 1e18.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The pmUSD amount (registry `pmusd` decimals and symbol).
+ */
+declare function getMaxMintablePMUSDWithoutBaseToken(chainId: ChainId, newCollateralRatio: bigint, provider?: Provider): Promise<MaxMintablePMUSDWithoutBaseToken>;
 export default getMaxMintablePMUSDWithoutBaseToken;

package/dist/types/contracts/pmTreasury/getMaxMintableXPM.d.ts

@@ -1,9 +1,19 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getMaxMintablePMUSD(chainId: ChainId, newCollateralRatio: number): Promise<{
-    maxPMIn: string;
-    maxXPMMintable: string;
-} | {
-    maxPMIn: number;
-    maxXPMMintable: number;
-}>;
-export default getMaxMintablePMUSD;
+import { TokenAmount } from "../../utils/amount";
+/** Result of `getMaxMintableXPM`. */
+export interface MaxMintableXPM {
+    /** Base token to deposit, with 18 decimals (fixed by the treasury math). */
+    maxPMIn: TokenAmount;
+    /** xPM mintable, in xPM decimals. */
+    maxXPMMintable: TokenAmount;
+}
+/**
+ * Reads the most xPM mintable, and the base token needed, before the collateral ratio rises to `newCollateralRatio`.
+ * @param chainId The chain id.
+ * @param newCollateralRatio The target collateral ratio scaled by 1e18 (e.g. `1_300_000_000_000_000_000n` for 130%). Must be greater than 1e18.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The base token amount (18 decimals) and the xPM amount (registry `xpm` decimals and symbol).
+ */
+declare function getMaxMintableXPM(chainId: ChainId, newCollateralRatio: bigint, provider?: Provider): Promise<MaxMintableXPM>;
+export default getMaxMintableXPM;

package/dist/types/contracts/pmTreasury/getMaxRedeemablePMUSD.d.ts

@@ -1,9 +1,19 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getMaxRedeemablePMUSD(chainId: ChainId, newCollateralRatio: number): Promise<{
-    maxPMOut: string;
-    maxPMUSDRedeemable: string;
-} | {
-    maxPMOut: number;
-    maxPMUSDRedeemable: number;
-}>;
+import { TokenAmount } from "../../utils/amount";
+/** Result of `getMaxRedeemablePMUSD`. */
+export interface MaxRedeemablePMUSD {
+    /** Base token received, with 18 decimals (fixed by the treasury math). */
+    maxPMOut: TokenAmount;
+    /** pmUSD redeemable, in pmUSD decimals. */
+    maxPMUSDRedeemable: TokenAmount;
+}
+/**
+ * Reads the most pmUSD redeemable, and the base token received, before the collateral ratio rises to `newCollateralRatio`.
+ * @param chainId The chain id.
+ * @param newCollateralRatio The target collateral ratio scaled by 1e18 (e.g. `1_300_000_000_000_000_000n` for 130%). Must be greater than 1e18.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The base token amount (18 decimals) and the pmUSD amount (registry `pmusd` decimals and symbol).
+ */
+declare function getMaxRedeemablePMUSD(chainId: ChainId, newCollateralRatio: bigint, provider?: Provider): Promise<MaxRedeemablePMUSD>;
 export default getMaxRedeemablePMUSD;

package/dist/types/contracts/pmTreasury/getMaxRedeemableXPM.d.ts

@@ -1,9 +1,19 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getMaxRedeemableXPM(chainId: ChainId, newCollateralRatio: number): Promise<{
-    maxPMOut: string;
-    maxXPMRedeemable: string;
-} | {
-    maxPMOut: number;
-    maxXPMRedeemable: number;
-}>;
+import { TokenAmount } from "../../utils/amount";
+/** Result of `getMaxRedeemableXPM`. */
+export interface MaxRedeemableXPM {
+    /** Base token received, with 18 decimals (fixed by the treasury math). */
+    maxPMOut: TokenAmount;
+    /** xPM redeemable, in xPM decimals. */
+    maxXPMRedeemable: TokenAmount;
+}
+/**
+ * Reads the most xPM redeemable, and the base token received, before the collateral ratio falls to `newCollateralRatio`.
+ * @param chainId The chain id.
+ * @param newCollateralRatio The target collateral ratio scaled by 1e18 (e.g. `1_300_000_000_000_000_000n` for 130%). Must be greater than 1e18.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The base token amount (18 decimals) and the xPM amount (registry `xpm` decimals and symbol).
+ */
+declare function getMaxRedeemableXPM(chainId: ChainId, newCollateralRatio: bigint, provider?: Provider): Promise<MaxRedeemableXPM>;
 export default getMaxRedeemableXPM;

package/dist/types/contracts/pmTreasury/getTotalBaseToken.d.ts

@@ -1,3 +1,11 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains/index";
-declare function getTotalBaseToken(chainId: ChainId): Promise<string | -1>;
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Reads the amount of base token held by the pmTreasury.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The base token amount, with 18 decimals (fixed by the treasury math).
+ */
+declare function getTotalBaseToken(chainId: ChainId, provider?: Provider): Promise<TokenAmount>;
 export default getTotalBaseToken;

package/dist/types/contracts/tokens/RAAC/getBalance.d.ts

@@ -1,2 +1,12 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const getBalance: (chainId: ChainId, address: string) => Promise<string>;
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Gets the RAAC balance of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The balance in RAAC base units, with the `raactoken` asset decimals from the chain config.
+ */
+export declare const getBalance: (chainId: ChainId, address: string, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/RAAC/getTotalSupply.d.ts

@@ -1,7 +1,11 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
 /**
+ * Gets the RAAC total supply.
  *
- * @param {number} chainId
- * @returns {Promise<string>}
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The total supply in RAAC base units, with the `raactoken` asset decimals from the chain config.
  */
-export declare const getTotalSupply: (chainId: ChainId) => Promise<string>;
+export declare const getTotalSupply: (chainId: ChainId, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/crvUSD/getBalance.d.ts

@@ -1,2 +1,12 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const getBalance: (chainId: ChainId, address: string) => Promise<string>;
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Gets the crvUSD balance of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The balance in crvUSD base units, with the `crvusd` asset decimals from the chain config.
+ */
+export declare const getBalance: (chainId: ChainId, address: string, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/crvUSD/getTotalSupply.d.ts

@@ -1,7 +1,11 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
 /**
+ * Gets the crvUSD total supply.
  *
- * @param {number} chainId
- * @returns {Promise<string>}
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The total supply in crvUSD base units, with the `crvusd` asset decimals from the chain config.
  */
-export declare const getTotalSupply: (chainId: ChainId) => Promise<string>;
+export declare const getTotalSupply: (chainId: ChainId, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/leRAAC/approve.d.ts

@@ -1,3 +1,12 @@
 import { Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const approve: (chainId: ChainId, spender: string, amount: string | number | bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;
+/**
+ * Approves `spender` to transfer the caller's leRAAC.
+ *
+ * @param chainId - The chain/network to use.
+ * @param spender - The spender to approve.
+ * @param amount - The allowance in leRAAC base units (18 decimals).
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The approval transaction, after it is mined.
+ */
+export declare const approve: (chainId: ChainId, spender: string, amount: bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;

package/dist/types/contracts/tokens/leRAAC/burn.d.ts

@@ -2,5 +2,10 @@ import { Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
 /**
  * Burn `amount` of the caller's leRAAC.
+ *
+ * @param chainId - The chain/network to use.
+ * @param amount - The amount in leRAAC base units (18 decimals).
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The burn transaction, after it is mined.
  */
-export declare const burn: (chainId: ChainId, amount: string | number | bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;
+export declare const burn: (chainId: ChainId, amount: bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;

package/dist/types/contracts/tokens/leRAAC/burnFrom.d.ts

@@ -2,5 +2,11 @@ import { Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
 /**
  * Burn `amount` of `account`'s leRAAC. Caller must have ERC20 allowance from `account`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param account - The account to burn from.
+ * @param amount - The amount in leRAAC base units (18 decimals).
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The burn transaction, after it is mined.
  */
-export declare const burnFrom: (chainId: ChainId, account: string, amount: string | number | bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;
+export declare const burnFrom: (chainId: ChainId, account: string, amount: bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;

package/dist/types/contracts/tokens/leRAAC/getAllowance.d.ts

@@ -1,3 +1,13 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const getAllowance: (chainId: ChainId, owner: string, spender: string, provider?: Provider) => Promise<string>;
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Gets the leRAAC allowance `owner` granted to `spender`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param owner - The token owner.
+ * @param spender - The approved spender.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The allowance in leRAAC base units, with the `leraac` asset decimals from the chain config.
+ */
+export declare const getAllowance: (chainId: ChainId, owner: string, spender: string, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/leRAAC/getBalance.d.ts

@@ -1,3 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const getBalance: (chainId: ChainId, address: string, provider?: Provider) => Promise<string>;
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Gets the leRAAC balance of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The balance in leRAAC base units, with the `leraac` asset decimals from the chain config.
+ */
+export declare const getBalance: (chainId: ChainId, address: string, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/leRAAC/getMinterInfo.d.ts

@@ -1,8 +1,20 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
 export interface LeRAACMinterInfo {
+    /** Whether the account currently holds the minter role. */
     isMinter: boolean;
-    ceiling: bigint;
-    minted: bigint;
+    /** The most leRAAC the minter may mint, in leRAAC base units. */
+    ceiling: TokenAmount;
+    /** The leRAAC the minter has minted so far, in leRAAC base units. */
+    minted: TokenAmount;
 }
+/**
+ * Gets a minter's role status, mint ceiling and minted amount on leRAAC.
+ *
+ * @param chainId - The chain/network to use.
+ * @param minter - The minter address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The minter info; `ceiling` and `minted` use the `leraac` asset decimals from the chain config.
+ */
 export declare const getMinterInfo: (chainId: ChainId, minter: string, provider?: Provider) => Promise<LeRAACMinterInfo>;

package/dist/types/contracts/tokens/leRAAC/getTotalSupply.d.ts

@@ -1,3 +1,11 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const getTotalSupply: (chainId: ChainId, provider?: Provider) => Promise<string>;
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Gets the leRAAC total supply.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The total supply in leRAAC base units, with the `leraac` asset decimals from the chain config.
+ */
+export declare const getTotalSupply: (chainId: ChainId, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/leRAAC/transfer.d.ts

@@ -1,3 +1,12 @@
 import { Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const transfer: (chainId: ChainId, to: string, amount: string | number | bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;
+/**
+ * Transfers the caller's leRAAC to `to`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param to - The recipient.
+ * @param amount - The amount in leRAAC base units (18 decimals).
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The transfer transaction, after it is mined.
+ */
+export declare const transfer: (chainId: ChainId, to: string, amount: bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;

package/dist/types/contracts/tokens/leRAAC/transferFrom.d.ts

@@ -1,3 +1,13 @@
 import { Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const transferFrom: (chainId: ChainId, from: string, to: string, amount: string | number | bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;
+/**
+ * Transfers leRAAC from `from` to `to` using the caller's allowance.
+ *
+ * @param chainId - The chain/network to use.
+ * @param from - The token owner.
+ * @param to - The recipient.
+ * @param amount - The amount in leRAAC base units (18 decimals).
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The transfer transaction, after it is mined.
+ */
+export declare const transferFrom: (chainId: ChainId, from: string, to: string, amount: bigint, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;

package/dist/types/contracts/tokens/pmUSD/getBalance.d.ts

@@ -1,2 +1,12 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const getBalance: (chainId: ChainId, address: string) => Promise<string>;
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Gets the pmUSD balance of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The balance in pmUSD base units, with the `pmusd` asset decimals from the chain config.
+ */
+export declare const getBalance: (chainId: ChainId, address: string, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/pmUSD/getTotalSupply.d.ts

@@ -1,7 +1,11 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
 /**
+ * Gets the pmUSD total supply.
  *
- * @param {number} chainId
- * @returns {Promise<string>}
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The total supply in pmUSD base units, with the `pmusd` asset decimals from the chain config.
  */
-export declare const getTotalSupply: (chainId: ChainId) => Promise<string>;
+export declare const getTotalSupply: (chainId: ChainId, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/rcrvUSD/getBalance.d.ts

@@ -1,2 +1,12 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const getBalance: (chainId: ChainId, address: string) => Promise<string>;
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Gets the rcrvUSD balance of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The balance in rcrvUSD base units, with the `rtoken` asset decimals from the chain config.
+ */
+export declare const getBalance: (chainId: ChainId, address: string, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/rcrvUSD/getTotalSupply.d.ts

@@ -1,6 +1,11 @@
+import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
 /**
- * @param {number} chainId
- * @returns {Promise<string>}
+ * Gets the rcrvUSD total supply.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The total supply in rcrvUSD base units, with the `rtoken` asset decimals from the chain config.
  */
-export declare const getTotalSupply: (chainId: ChainId) => Promise<string>;
+export declare const getTotalSupply: (chainId: ChainId, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/veRAAC/_helpers.d.ts

@@ -0,0 +1,15 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Approves `spender` for exactly `amount` RAAC when the signer's current allowance is below it.
+ *
+ * The allowance is read through the signer's provider, or the chain's configured RPC when the
+ * signer has none (some wrapped signers, e.g. thirdweb, do not expose one).
+ *
+ * @param chainId - The chain/network to use.
+ * @param spender - The contract that will pull the RAAC.
+ * @param amount - The required allowance, in RAAC base units.
+ * @param signer - The RAAC owner.
+ * @param label - Prefix for the log lines.
+ */
+export declare const ensureRAACAllowance: (chainId: ChainId, spender: string, amount: bigint, signer: Signer, label: string) => Promise<void>;

package/dist/types/contracts/tokens/veRAAC/distributeRewards.d.ts

@@ -6,9 +6,9 @@ import { ChainId } from "../../../configs/chains";
  *
  * @param chainId - The chain/network to use.
  * @param rewardTokenAddress - The token being distributed as reward.
- * @param amount - The amount of reward tokens to distribute.
+ * @param amount - The amount to distribute, in base units of the reward token (its own decimals).
  * @param epochs - Number of epochs over which to distribute the rewards.
  * @param signer - An ethers.js Signer instance (must be connected to wallet).
  * @returns Transaction receipt after the rewards are distributed.
  */
-export declare const distributeRewards: (chainId: ChainId, rewardTokenAddress: string, amount: string | number | bigint, epochs: number, signer: Signer) => Promise<ethers.ContractTransactionResponse>;
+export declare const distributeRewards: (chainId: ChainId, rewardTokenAddress: string, amount: bigint, epochs: number, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/tokens/veRAAC/getBalance.d.ts

@@ -1,3 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
-export declare const getBalance: (chainId: ChainId, address: string, provider?: Provider) => Promise<string>;
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Gets the current (decayed) veRAAC voting power of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The voting power in veRAAC base units, with the `veraac` asset decimals from the chain config.
+ */
+export declare const getBalance: (chainId: ChainId, address: string, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/veRAAC/getBalanceAt.d.ts

@@ -1,5 +1,6 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
 /**
  * Gets the historical voting power of an account at a specific block.
  *
@@ -7,6 +8,6 @@ import { ChainId } from "../../../configs/chains";
  * @param address - The address to check the balance for.
  * @param blockNumber - The block number to check the balance at.
  * @param provider - Optional ethers.js Provider instance.
- * @returns The voting power at the specified block formatted in ether units.
+ * @returns The voting power at the specified block in veRAAC base units, with the `veraac` asset decimals from the chain config.
  */
-export declare const getBalanceAt: (chainId: ChainId, address: string, blockNumber: number | bigint, provider?: Provider) => Promise<string>;
+export declare const getBalanceAt: (chainId: ChainId, address: string, blockNumber: number | bigint, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/tokens/veRAAC/getBalanceAtTime.d.ts

@@ -1,5 +1,6 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
 /**
  * Gets the voting power of an account at a specific timestamp.
  *
@@ -7,6 +8,6 @@ import { ChainId } from "../../../configs/chains";
  * @param address - The address to check the balance for.
  * @param timestamp - The timestamp to check the balance at (in seconds).
  * @param provider - Optional ethers.js Provider instance.
- * @returns The voting power at the specified timestamp formatted in ether units.
+ * @returns The voting power at the specified timestamp in veRAAC base units, with the `veraac` asset decimals from the chain config.
  */
-export declare const getBalanceAtTime: (chainId: ChainId, address: string, timestamp: number | bigint, provider?: Provider) => Promise<string>;
+export declare const getBalanceAtTime: (chainId: ChainId, address: string, timestamp: number | bigint, provider?: Provider) => Promise<TokenAmount>;