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

package/dist/pools/stabilityPool/getWithdrawRequestInfo.js

@@ -1,21 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWithdrawRequestInfo = getWithdrawRequestInfo;
-const ethers_1 = require("ethers");
 const _helpers_1 = require("./_helpers");
+const _helpers_2 = require("../lendingPool/_helpers");
+const amount_1 = require("../../utils/amount");
+/**
+ * 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.
+ */
 async function getWithdrawRequestInfo(chainId, userAddress, provider) {
     try {
         const stabilityPoolContract = await (0, _helpers_1.getStabilityPoolContract)(chainId, provider);
-        const duration = await stabilityPoolContract.withdrawTimelockDuration();
-        const request = await stabilityPoolContract.withdrawTimelock(userAddress);
+        const [duration, request] = await Promise.all([
+            stabilityPoolContract.withdrawTimelockDuration(),
+            stabilityPoolContract.withdrawTimelock(userAddress),
+        ]);
         if (request[0] === 0n) {
             return null;
         }
         return {
-            amount: ethers_1.ethers.formatEther(request[0]),
-            indexAtRequest: Number(request[1]),
-            balanceAtRequest: ethers_1.ethers.formatEther(request[2]),
-            userIndexAtRequest: Number(request[3]),
+            amount: (0, _helpers_2.toReserveAmount)(chainId, request[0]),
+            indexAtRequest: (0, amount_1.toScaled)(request[1], amount_1.RAY_DECIMALS),
+            balanceAtRequest: (0, _helpers_2.toReserveAmount)(chainId, request[2]),
+            userIndexAtRequest: (0, amount_1.toScaled)(request[3], amount_1.RAY_DECIMALS),
             readyAt: Number(request[4]),
             expiresAt: Number(request[5]),
             duration: Number(duration)

package/dist/pools/stabilityPool/requestWithdraw.js

@@ -1,18 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.requestWithdraw = requestWithdraw;
-const ethers_1 = require("ethers");
 const _helpers_1 = require("./_helpers");
+/**
+ * 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.
+ */
 async function requestWithdraw(chainId, amount, signer) {
     if (!signer) {
         throw new Error("Wallet not connected");
     }
     try {
         const stabilityPoolContract = await (0, _helpers_1.getStabilityPoolContract)(chainId, signer);
-        const amountInWei = ethers_1.ethers.parseEther(amount);
-        const tx = await stabilityPoolContract.requestWithdraw(amountInWei);
+        const tx = await stabilityPoolContract.requestWithdraw(amount);
         const receipt = await tx.wait();
-        console.log(`Withdrawal request for ${amount} submitted successfully`);
+        console.log(`Withdrawal request for ${amount} base units submitted successfully`);
         console.log(`Transaction hash: ${receipt?.hash}`);
         return receipt;
     }

package/dist/pools/stabilityPool/withdrawFromStabilityPool.js

@@ -1,23 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const ethers_1 = require("ethers");
-const contracts_1 = require("../../utils/contracts");
-const artifacts_1 = require("../../utils/artifacts");
+const _helpers_1 = require("./_helpers");
+/**
+ * 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.
+ */
 async function withdrawFromStabilityPool(chainId, amount, signer) {
     if (!signer) {
         throw new Error("Wallet not connected");
     }
     try {
-        const stabilityPoolAddress = (0, contracts_1.getContractAddress)(chainId, "stabilitypool");
-        const abi = (0, artifacts_1.getABI)("stabilitypool");
-        const stabilityPoolContract = new ethers_1.ethers.Contract(stabilityPoolAddress, abi, signer);
-        const amountInWei = ethers_1.ethers.parseEther(amount);
-        const tx = await stabilityPoolContract.withdraw(amountInWei.toString(), {
+        const stabilityPoolContract = await (0, _helpers_1.getStabilityPoolContract)(chainId, signer);
+        const tx = await stabilityPoolContract.withdraw(amount, {
             nonce: await signer.getNonce(),
         });
         console.log(`Withdrawal transaction sent to Stability Pool:`, tx.hash);
         const receipt = await tx.wait();
-        console.log(`Withdrawn ${amount} from Stability Pool successfully:`, receipt?.hash);
+        console.log(`Withdrawn ${amount} base units from Stability Pool successfully:`, receipt?.hash);
         return receipt;
     }
     catch (error) {

package/dist/prices/getPrices.js

@@ -1,12 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPrices = void 0;
-// TODO: fetch prices from coingecko / chainlink or similar. 
+const amount_1 = require("../utils/amount");
+const ONE_USD = 10n ** BigInt(amount_1.WAD_DECIMALS);
+// TODO: fetch prices from coingecko / chainlink or similar.
+/**
+ * Returns the USD price of each token.
+ * @returns The prices, each a USD price per whole token scaled by 1e18.
+ */
 const getPrices = async () => {
     return {
-        pmUSD: 1,
-        crvUSD: 1,
-        raac: 1,
+        pmUSD: (0, amount_1.toScaled)(ONE_USD, amount_1.WAD_DECIMALS),
+        crvUSD: (0, amount_1.toScaled)(ONE_USD, amount_1.WAD_DECIMALS),
+        raac: (0, amount_1.toScaled)(ONE_USD, amount_1.WAD_DECIMALS),
     };
 };
 exports.getPrices = getPrices;

package/dist/scripts/index.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
+const amount_1 = require("../utils/amount");
 const chains_1 = __importDefault(require("../configs/chains"));
 //node --env-file=../.env -r ts-node/register ./test.ts
 const RPCLibrary_1 = __importDefault(require("../RPCLibrary"));
@@ -215,7 +216,7 @@ const execute = async () => {
     // console.log(await rwaVaultContract.supportedDepositableAdapters(erc20AdapterAddress));
     // console.log(await rwaVaultContract.depositableAdapters(1));
     // await rwaVaultContract.setIndexTokenMintingFee(0);
-    await rpc.wallet.assets.approveAsset(chainId, "crvusd", erc20AdapterAddress, "200", signer);
+    await rpc.wallet.assets.approveAsset(chainId, "crvusd", erc20AdapterAddress, (0, amount_1.parseAmount)("200", 18), signer);
     const data = new ethers_1.ethers.AbiCoder().encode(["uint256"], [ethers_1.ethers.parseEther("200")]);
     // await rpc.pools.rwaVault.depositToRWAVault(chainId, "crvusdadapter", data, signer.address, signer);
     console.log(await rwaVaultContract.pricePerShare());

package/dist/scripts/liquidation.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
+const amount_1 = require("../utils/amount");
 const chains_1 = __importDefault(require("../configs/chains"));
 //node --env-file=../.env -r ts-node/register ./test.ts
 const RPCLibrary_1 = __importDefault(require("../RPCLibrary"));
@@ -64,17 +65,17 @@ async function setupLiquidityPool() {
     // deposit 5 million in the RWA Vault
     console.log("Depositing 5 million in the RWA Vault");
     await rpc.wallet.assets.approveAsset(chainId, "crvusd", await rpc.pools.rwaVault.getAdapterAddress(chainId, "crvusdadapter")
-        .address, "100000000", signer);
+        .address, (0, amount_1.parseAmount)("100000000", 18), signer);
     const d1 = new ethers_1.ethers.AbiCoder().encode(["uint256"], [ethers_1.ethers.parseEther("100000000")]);
-    await rpc.pools.rwaVault.depositToRWAVault(chainId, "crvusdadapter", d1, signer.address, "0", signer);
+    await rpc.pools.rwaVault.depositToRWAVault(chainId, "crvusdadapter", d1, signer.address, 0n, signer);
     // deposit 5 million in the Mock Liquidity Pool
     console.log("Depositing 5 million in the Mock Liquidity Pool");
-    await rpc.wallet.assets.approveAsset(chainId, "crvusd", MockLiquidityPoolAddress, "100000000", signer);
-    const indextokenBalance = (await rpc.wallet.assets.getBalance(chainId, "rwaindextoken", signer.address, provider)).balance;
-    await rpc.wallet.assets.approveAsset(chainId, "rwaindextoken", MockLiquidityPoolAddress, indextokenBalance, signer);
+    await rpc.wallet.assets.approveAsset(chainId, "crvusd", MockLiquidityPoolAddress, (0, amount_1.parseAmount)("100000000", 18), signer);
+    const indextokenBalance = await rpc.wallet.assets.getBalance(chainId, "rwaindextoken", signer.address, provider);
+    await rpc.wallet.assets.approveAsset(chainId, "rwaindextoken", MockLiquidityPoolAddress, indextokenBalance.value, signer);
     await (await MockLiquidityPoolContract.add_liquidity([
         ethers_1.ethers.parseEther("100000000"),
-        ethers_1.ethers.parseEther(indextokenBalance.toString()),
+        indextokenBalance.value,
     ], 0, signer.address)).wait();
     return;
 }
@@ -93,10 +94,10 @@ async function setupLendingPool() {
     const StabilityPoolABI = (0, artifacts_1.getABI)("stabilitypool");
     const StabilityPoolContract = new ethers_1.ethers.Contract(StabilityPoolAddress, StabilityPoolABI, signer);
     await rpc.wallet.assets.mintAsset(chainId, "crvusd", 2000000n, signer.address, signer);
-    await rpc.wallet.assets.approveAsset(chainId, "crvusd", lendingPoolAddress, "2000000", signer);
-    await rpc.pools.lendingPool.depositToLendingPool(chainId, "2000000", signer);
-    await rpc.wallet.assets.approveAsset(chainId, "rtoken", StabilityPoolAddress, "2000000", signer);
-    await rpc.pools.stabilityPool.depositToStabilityPool(chainId, "2000000", signer);
+    await rpc.wallet.assets.approveAsset(chainId, "crvusd", lendingPoolAddress, (0, amount_1.parseAmount)("2000000", 18), signer);
+    await rpc.pools.lendingPool.depositToLendingPool(chainId, (0, amount_1.parseAmount)("2000000", 18), signer);
+    await rpc.wallet.assets.approveAsset(chainId, "rtoken", StabilityPoolAddress, (0, amount_1.parseAmount)("2000000", 18), signer);
+    await rpc.pools.stabilityPool.depositToStabilityPool(chainId, (0, amount_1.parseAmount)("2000000", 18), signer);
     console.log("Deposited to stability pool.");
 }
 async function initiateLiquidation(adapter, user, data) {

package/dist/types/RPCLibrary.d.ts

@@ -42,6 +42,9 @@ import getTokensByOwner from "./nfts/getTokensByOwner";
 import getOwnerOfNFT from "./nfts/getOwnerOfNFT";
 import getContractAddress from "./contracts/getContractAddress";
 import getContract from "./contracts/getContract";
+import { findContract } from "./contracts/findContract";
+import { decodeCall } from "./contracts/decodeCall";
+import { resolveName, resolveNames } from "./contracts/resolveName";
 import getLatestPrice from "./contracts/housePrices/getLatestPrice";
 import setOracle from "./contracts/housePrices/setOracle";
 import tick from "./minter/tick";
@@ -106,11 +109,12 @@ import { getWithdrawRequestInfo as getStabilityPoolWithdrawRequestInfo } from ".
 import { requestWithdraw as requestStabilityPoolWithdraw } from "./pools/stabilityPool/requestWithdraw";
 import { getABI } from "./utils/artifacts";
 import { decodeErrorName, getErrorInfo, attachDecodedError, decodeErrorMessage, attachDecodedErrorMessage } from "./utils/errorDecoder";
+import { toAmount, toScaled, parseAmount, toDecimalString, serializeAmount, deserializeAmount, getAssetDecimals, getTokenInfo, toTokenAmount } from "./utils/amount";
 import * as distributorMethods from "./contracts/governance/distributor";
 import * as gaugeMethods from "./contracts/governance/gauge";
 import * as controllerMethods from "./contracts/governance/gaugeController";
+import * as gaugeSystemMethods from "./contracts/governance/gaugeSystems";
 import { cancel as cancelProposals } from "./contracts/governance/proposals/cancel";
-import { getProposalData as getProposalDataProposals } from "./contracts/governance/proposals/getProposalData";
 import { getQuorumNumerator as getQuorumNumeratorProposals } from "./contracts/governance/proposals/getQuorumNumerator";
 import { getVotingPeriod as getVotingPeriodProposals } from "./contracts/governance/proposals/getVotingPeriod";
 import { castVote as castVoteProposals } from "./contracts/governance/proposals/castVote";
@@ -124,6 +128,15 @@ import { getProposal as getProposalProposals } from "./contracts/governance/prop
 import { getProposalCount as getProposalCountProposals } from "./contracts/governance/proposals/getProposalCount";
 import { getQuorum as getQuorumProposals } from "./contracts/governance/proposals/getQuorum";
 import { getVotingDelay as getVotingDelayProposals } from "./contracts/governance/proposals/getVotingDelay";
+import { getGovernances as getGovernancesProposals } from "./contracts/governance/proposals/getGovernances";
+import { hasVoted as hasVotedProposals } from "./contracts/governance/proposals/hasVoted";
+import { getVoteReceipt as getVoteReceiptProposals } from "./contracts/governance/proposals/getVoteReceipt";
+import { getProposalEta as getProposalEtaProposals } from "./contracts/governance/proposals/getProposalEta";
+import { getLabel as getLabelProposals } from "./contracts/governance/proposals/getLabel";
+import { getRoles as getRolesProposals } from "./contracts/governance/proposals/getRoles";
+import { hasRole as hasRoleProposals } from "./contracts/governance/proposals/hasRole";
+import { setParameter as setParameterProposals } from "./contracts/governance/proposals/setParameter";
+import { setTimelock as setTimelockProposals } from "./contracts/governance/proposals/setTimelock";
 import { getConstants as getConstantsTimelock } from "./contracts/governance/timelock/getConstants";
 import { getTimestamp as getTimestampTimelock } from "./contracts/governance/timelock/getTimestamp";
 import { getMinDelay as getMinDelayTimelock } from "./contracts/governance/timelock/getMinDelay";
@@ -131,6 +144,8 @@ import { hashOperationBatch as hashOperationBatchTimelock } from "./contracts/go
 import { isOperationDone as isOperationDoneTimelock } from "./contracts/governance/timelock/isOperationDone";
 import { isOperationReady as isOperationReadyTimelock } from "./contracts/governance/timelock/isOperationReady";
 import { isOperationPending as isOperationPendingTimelock } from "./contracts/governance/timelock/isOperationPending";
+import { getRoles as getRolesTimelock } from "./contracts/governance/timelock/getRoles";
+import { hasRole as hasRoleTimelock } from "./contracts/governance/timelock/hasRole";
 import { getBalance as getPMUSDBalance } from "./contracts/tokens/pmUSD/getBalance";
 import { getTotalSupply as getPMUSDTotalSupply } from "./contracts/tokens/pmUSD/getTotalSupply";
 import { getBalance as getCRVUSDBalance } from "./contracts/tokens/crvUSD/getBalance";
@@ -167,8 +182,8 @@ import { lockWithApproval as veRAACLockWithApproval } from "./contracts/tokens/v
 import { increaseWithApproval as veRAACIncreaseWithApproval } from "./contracts/tokens/veRAAC/increaseWithApproval";
 import { getRawBalanceOf as getVeRAACRawBalanceOf } from "./contracts/tokens/veRAAC/getRawBalanceOf";
 import { getRawTotalSupply as getVeRAACRawTotalSupply } from "./contracts/tokens/veRAAC/getRawTotalSupply";
-import { getEffectiveLockEnd as getVeRAACEffectiveLockEnd } from "./contracts/tokens/veRAAC/getEffectiveLockEnd";
 import { getMinLockEnd as getVeRAACMinLockEnd } from "./contracts/tokens/veRAAC/getMinLockEnd";
+import { getMinLockAmount as getVeRAACMinLockAmount } from "./contracts/tokens/veRAAC/getMinLockAmount";
 import { getMaxUnclaimedDistributions as getVeRAACMaxUnclaimedDistributions } from "./contracts/tokens/veRAAC/getMaxUnclaimedDistributions";
 import { getBalance as getRAACBalance } from "./contracts/tokens/RAAC/getBalance";
 import { getTotalSupply as getRAACTotalSupply } from "./contracts/tokens/RAAC/getTotalSupply";
@@ -189,6 +204,8 @@ import { getUserLocks as getUserLocksLiquidLocker } from "./contracts/lockers/li
 import { getGlobalInfo as getGlobalInfoLiquidLocker } from "./contracts/lockers/liquidLocker/getGlobalInfo";
 import { getConfig as getConfigLiquidLocker } from "./contracts/lockers/liquidLocker/getConfig";
 import { isKeeper as isKeeperLiquidLocker } from "./contracts/lockers/liquidLocker/isKeeper";
+import { previewWithdraw as previewWithdrawLiquidLocker } from "./contracts/lockers/liquidLocker/previewWithdraw";
+import { checkAccountHealth as checkAccountHealthLiquidLocker } from "./contracts/lockers/liquidLocker/checkAccountHealth";
 import { deposit as depositMaturityVault } from "./contracts/lockers/maturityVault/deposit";
 import { depositFor as depositForMaturityVault } from "./contracts/lockers/maturityVault/depositFor";
 import { withdraw as withdrawMaturityVault } from "./contracts/lockers/maturityVault/withdraw";
@@ -320,6 +337,10 @@ declare class RPCLibrary {
         };
         getContractAddress: typeof getContractAddress;
         getContract: typeof getContract;
+        findContract: typeof findContract;
+        decodeCall: typeof decodeCall;
+        resolveName: typeof resolveName;
+        resolveNames: typeof resolveNames;
         feeCollector: {
             claimRewardFromPool: typeof claimRewardFromPool;
         };
@@ -349,9 +370,9 @@ declare class RPCLibrary {
         distributor: typeof distributorMethods;
         gauge: typeof gaugeMethods;
         controller: typeof controllerMethods;
+        gaugeSystems: typeof gaugeSystemMethods;
         proposals: {
             cancel: typeof cancelProposals;
-            getProposalData: typeof getProposalDataProposals;
             getQuorumNumerator: typeof getQuorumNumeratorProposals;
             getVotingPeriod: typeof getVotingPeriodProposals;
             castVote: typeof castVoteProposals;
@@ -365,6 +386,15 @@ declare class RPCLibrary {
             getProposalCount: typeof getProposalCountProposals;
             getQuorum: typeof getQuorumProposals;
             getVotingDelay: typeof getVotingDelayProposals;
+            getGovernances: typeof getGovernancesProposals;
+            hasVoted: typeof hasVotedProposals;
+            getVoteReceipt: typeof getVoteReceiptProposals;
+            getProposalEta: typeof getProposalEtaProposals;
+            getLabel: typeof getLabelProposals;
+            getRoles: typeof getRolesProposals;
+            hasRole: typeof hasRoleProposals;
+            setParameter: typeof setParameterProposals;
+            setTimelock: typeof setTimelockProposals;
         };
         timelock: {
             getConstants: typeof getConstantsTimelock;
@@ -374,6 +404,8 @@ declare class RPCLibrary {
             isOperationDone: typeof isOperationDoneTimelock;
             isOperationReady: typeof isOperationReadyTimelock;
             isOperationPending: typeof isOperationPendingTimelock;
+            getRoles: typeof getRolesTimelock;
+            hasRole: typeof hasRoleTimelock;
         };
     };
     tokens: {
@@ -412,8 +444,8 @@ declare class RPCLibrary {
             increaseWithApproval: typeof veRAACIncreaseWithApproval;
             getRawBalanceOf: typeof getVeRAACRawBalanceOf;
             getRawTotalSupply: typeof getVeRAACRawTotalSupply;
-            getEffectiveLockEnd: typeof getVeRAACEffectiveLockEnd;
             getMinLockEnd: typeof getVeRAACMinLockEnd;
+            getMinLockAmount: typeof getVeRAACMinLockAmount;
             getMaxUnclaimedDistributions: typeof getVeRAACMaxUnclaimedDistributions;
         };
         crvUSD: {
@@ -461,6 +493,8 @@ declare class RPCLibrary {
             getGlobalInfo: typeof getGlobalInfoLiquidLocker;
             getConfig: typeof getConfigLiquidLocker;
             isKeeper: typeof isKeeperLiquidLocker;
+            previewWithdraw: typeof previewWithdrawLiquidLocker;
+            checkAccountHealth: typeof checkAccountHealthLiquidLocker;
         };
         maturityVault: {
             deposit: typeof depositMaturityVault;
@@ -609,6 +643,17 @@ declare class RPCLibrary {
         decodeErrorMessage: typeof decodeErrorMessage;
         attachDecodedErrorMessage: typeof attachDecodedErrorMessage;
     };
+    amounts: {
+        toAmount: typeof toAmount;
+        toScaled: typeof toScaled;
+        parseAmount: typeof parseAmount;
+        toDecimalString: typeof toDecimalString;
+        serializeAmount: typeof serializeAmount;
+        deserializeAmount: typeof deserializeAmount;
+        getAssetDecimals: typeof getAssetDecimals;
+        getTokenInfo: typeof getTokenInfo;
+        toTokenAmount: typeof toTokenAmount;
+    };
     constructor(privateKey?: string);
     getWallet(privateKey: string, provider: Provider): Promise<ethers.JsonRpcSigner | ethers.Wallet>;
     getProvider(chainId: ChainId, providerRpc?: string): Promise<ethers.JsonRpcProvider | ethers.BrowserProvider>;

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

@@ -0,0 +1,16 @@
+import { ChainId } from "../configs/chains";
+/** The zero address, used in the chain configs for an asset that is not deployed on that chain. */
+export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+/**
+ * Whether an asset has a deployed contract on a chain. Native ETH counts as deployed.
+ * @param chainId The chain id.
+ * @param assetId The asset key in the chain config, any casing.
+ * @returns `true` when the config holds a non-zero address for the asset.
+ */
+export declare function isAssetDeployed(chainId: ChainId, assetId: string): boolean;
+/**
+ * Throws a clear error when an asset is not deployed on a chain, so callers do not see a decode failure instead.
+ * @param chainId The chain id.
+ * @param assetId The asset key in the chain config.
+ */
+export declare function assertAssetDeployed(chainId: ChainId, assetId: string): void;

package/dist/types/assets/getAsset.d.ts

@@ -1,5 +1,16 @@
 import { ChainId } from "../configs/chains";
 import { AssetType } from "../utils/artifacts";
 import { Provider } from "ethers";
-declare function getAsset(chainId: ChainId, assetId: AssetType, provider: Provider): Promise<any>;
+import { TokenAmount } from "../utils/amount";
+/**
+ * Reads a configured asset's config entry together with its total supply.
+ * @param chainId The chain id.
+ * @param assetId The asset id in the chain config.
+ * @param provider The provider to read with.
+ * @returns The asset's config entry plus `supply`, the total supply as a `TokenAmount`. Native ETH has no `supply`.
+ * @throws If the asset is not configured or the supply read fails.
+ */
+declare function getAsset(chainId: ChainId, assetId: AssetType, provider: Provider): Promise<Record<string, any> & {
+    supply?: TokenAmount;
+}>;
 export default getAsset;

package/dist/types/assets/getAssets.d.ts

@@ -1,4 +1,13 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains";
-declare function getAssets(chainId: ChainId, provider: Provider): Promise<{}>;
+import { TokenAmount } from "../utils/amount";
+/**
+ * Reads every configured asset with its total supply.
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns A map of asset id to the asset's config entry plus `supply` as a `TokenAmount` (absent for native ETH). Assets the chain config does not have a deployment for are left out.
+ */
+declare function getAssets(chainId: ChainId, provider: Provider): Promise<Record<string, Record<string, any> & {
+    supply?: TokenAmount;
+}>>;
 export default getAssets;

package/dist/types/assets/getSupply.d.ts

@@ -1,5 +1,14 @@
 import { Provider } from "ethers";
 import { ChainId } from "../configs/chains";
 import { AssetType } from "../utils/artifacts";
-declare function getSupply(chainId: ChainId, assetId: AssetType, provider: Provider): Promise<string | 0>;
+import { TokenAmount } from "../utils/amount";
+/**
+ * Reads the total supply of a configured asset.
+ * @param chainId The chain id.
+ * @param assetId The asset key in the chain config.
+ * @param provider The provider to read with.
+ * @returns The total supply in base units, with the asset's decimals.
+ * @throws If the asset is native ETH (it has no on-chain total supply), is not deployed on the chain, or the read fails.
+ */
+declare function getSupply(chainId: ChainId, assetId: AssetType, provider: Provider): Promise<TokenAmount>;
 export default getSupply;

package/dist/types/configs/chains/index.d.ts

@@ -105,43 +105,29 @@ declare const chains: {
                 contract: string;
             };
         };
-        governance: {
-            gaugerewardsdistributor: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gaugecontroller: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            raacgauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            rwagauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            governance: {
-                id: string;
-                name: string;
-                contract: string;
+        gauges: {
+            raacgauges: {
+                id: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: {
+                    id: string;
+                    name: string;
+                    contract: string;
+                }[];
             };
-            timelockcontroller: {
+            rwagauges: {
                 id: string;
-                name: string;
-                contract: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: any[];
             };
         };
+        proposals: any[];
         pools: {
             stabilitypool: {
                 id: string;
@@ -150,6 +136,7 @@ declare const chains: {
             };
             lendingpool: {
                 id: string;
+                asset: string;
                 name: string;
                 contract: string;
             };
@@ -157,6 +144,7 @@ declare const chains: {
         nfts: {
             raacnft: {
                 id: string;
+                asset: string;
                 name: string;
                 contract: string;
             };
@@ -165,24 +153,28 @@ declare const chains: {
             eth: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
             pmusd: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
             xpm: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
             crvusd: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
@@ -201,12 +193,14 @@ declare const chains: {
             raactoken: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
             veraac: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
@@ -360,43 +354,29 @@ export declare const configs: {
                 contract: string;
             };
         };
-        governance: {
-            gaugerewardsdistributor: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gaugecontroller: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            raacgauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            rwagauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            governance: {
-                id: string;
-                name: string;
-                contract: string;
+        gauges: {
+            raacgauges: {
+                id: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: {
+                    id: string;
+                    name: string;
+                    contract: string;
+                }[];
             };
-            timelockcontroller: {
+            rwagauges: {
                 id: string;
-                name: string;
-                contract: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: any[];
             };
         };
+        proposals: any[];
         pools: {
             stabilitypool: {
                 id: string;
@@ -405,6 +385,7 @@ export declare const configs: {
             };
             lendingpool: {
                 id: string;
+                asset: string;
                 name: string;
                 contract: string;
             };
@@ -412,6 +393,7 @@ export declare const configs: {
         nfts: {
             raacnft: {
                 id: string;
+                asset: string;
                 name: string;
                 contract: string;
             };
@@ -420,24 +402,28 @@ export declare const configs: {
             eth: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
             pmusd: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
             xpm: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
             crvusd: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
@@ -456,12 +442,14 @@ export declare const configs: {
             raactoken: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };
             veraac: {
                 id: string;
                 name: string;
+                symbol: string;
                 decimals: number;
                 contract: string;
             };