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

package/dist/contracts/lockers/liquidLocker/harvest.js

@@ -5,6 +5,11 @@ const _helpers_1 = require("./_helpers");
 /**
  * Harvest veRAAC rewards, swap to RAAC via the configured Zap, and distribute.
  * Caller must hold HARVEST_ROLE; receives the harvest bounty at `recipient`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param recipient - Address that receives the harvest bounty.
+ * @param minimumOut - Minimum RAAC the swap must return, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const harvest = async (chainId, recipient, minimumOut, signer) => {
     if (!signer)

package/dist/contracts/lockers/liquidLocker/previewWithdraw.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.previewWithdraw = void 0;
+const amount_1 = require("../../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * Projects how the caller's matured reservations would split on withdrawUnlocked.
+ *
+ * A withdrawal never leaves the debt undercollateralised: whatever the position is short of
+ * the collateral the debt requires is relocked rather than paid out. Mirrors the same split
+ * withdrawUnlocked applies, so the preview cannot drift from the transaction.
+ *
+ * @param chainId - The chain/network to use.
+ * @param account - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The payout and relock split, in RAAC base units.
+ */
+const previewWithdraw = async (chainId, account, provider) => {
+    const contract = await (0, _helpers_1.getLiquidLockerContract)(chainId, provider);
+    const [payout, relock] = await contract.previewWithdraw(account);
+    return {
+        payout: (0, amount_1.toTokenAmount)(chainId, "raactoken", payout),
+        relock: (0, amount_1.toTokenAmount)(chainId, "raactoken", relock),
+    };
+};
+exports.previewWithdraw = previewWithdraw;

package/dist/contracts/lockers/liquidLocker/repay.js

@@ -4,7 +4,11 @@ exports.repay = void 0;
 const _helpers_1 = require("./_helpers");
 /**
  * Repay outstanding leRAAC debt. The fee portion is transferred to the treasury,
- * the net portion is burned via leRAAC.burnFrom — caller must approve the locker on the leRAAC token first.
+ * the net portion is burned via leRAAC.burnFrom - caller must approve the locker on the leRAAC token first.
+ *
+ * @param chainId - The chain/network to use.
+ * @param leRAACAmount - leRAAC to repay, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const repay = async (chainId, leRAACAmount, signer) => {
     if (!signer)

package/dist/contracts/lockers/liquidLocker/requestUnlock.js

@@ -3,14 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.requestUnlock = void 0;
 const _helpers_1 = require("./_helpers");
 /**
- * Reserve `numLocks` of the caller's pending future-locks for unlock at their existing maturity epoch(s).
- * Health is checked against (totalLocked - newUnlock) and current debt.
+ * Schedule `amount` of the caller's locked RAAC, in base units, for unlock.
+ *
+ * The locker reserves against the caller's future unlock buckets soonest-maturing first,
+ * partial-reserving the boundary bucket. When the remainder left in that bucket would fall
+ * below veRAAC's minimum lock, the whole bucket is taken instead — so the amount actually
+ * scheduled can exceed `amount` by up to that minimum. Scheduling less than `amount`
+ * (open capacity is short) reverts with InsufficientToUnlock.
+ *
+ * Health is checked against (totalLocked - alreadyReserved - amount) and current debt,
+ * reverting with InsufficientCollateral when the remaining collateral would not back the debt.
+ *
+ * @param chainId - The chain/network to use.
+ * @param amount - RAAC to schedule for unlock, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
-const requestUnlock = async (chainId, numLocks, signer) => {
+const requestUnlock = async (chainId, amount, signer) => {
     if (!signer)
         throw new Error("Signer is required");
     const contract = await (0, _helpers_1.getLiquidLockerContract)(chainId, signer);
-    const tx = await contract.requestUnlock(numLocks);
+    const tx = await contract.requestUnlock(amount);
     await tx.wait();
     return tx;
 };

package/dist/contracts/lockers/liquidLocker/voteGauge.js

@@ -4,7 +4,13 @@ exports.voteGauge = void 0;
 const _helpers_1 = require("./_helpers");
 /**
  * Vote on a gauge using the locker's veRAAC voting power. Treasury-only.
- * `weight` is in basis points (0–10000).
+ * `weight` is in basis points (0 to 10000, where 10000 is 100% of the locker's voting power).
+ *
+ * @param chainId - The chain/network to use.
+ * @param controller - Address of the GaugeController.
+ * @param gauge - Address of the gauge.
+ * @param weight - Vote weight in basis points.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const voteGauge = async (chainId, controller, gauge, weight, signer) => {
     if (!signer)

package/dist/contracts/lockers/maturityVault/deposit.js

@@ -5,6 +5,10 @@ const _helpers_1 = require("./_helpers");
 /**
  * Deposit leRAAC into the maturity vault for the caller.
  * Caller must have approved leRAAC to the vault first.
+ *
+ * @param chainId - The chain/network to use.
+ * @param amount - leRAAC to deposit, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const deposit = async (chainId, amount, signer) => {
     if (!signer)

package/dist/contracts/lockers/maturityVault/depositFor.js

@@ -4,6 +4,11 @@ exports.depositFor = void 0;
 const _helpers_1 = require("./_helpers");
 /**
  * Deposit leRAAC into the maturity vault crediting `account`. Caller pays.
+ *
+ * @param chainId - The chain/network to use.
+ * @param account - Address credited with the deposit.
+ * @param amount - leRAAC to deposit, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const depositFor = async (chainId, account, amount, signer) => {
     if (!signer)

package/dist/contracts/lockers/maturityVault/distribute.js

@@ -5,6 +5,11 @@ const _helpers_1 = require("./_helpers");
 /**
  * Distribute RAAC into the vault to pay down leRAAC debt. Whitelisted callers only.
  * `origin` is the address whose RAAC balance is consumed via transferFrom.
+ *
+ * @param chainId - The chain/network to use.
+ * @param origin - Address whose RAAC is pulled.
+ * @param amount - RAAC to distribute, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const distribute = async (chainId, origin, amount, signer) => {
     if (!signer)

package/dist/contracts/lockers/maturityVault/getConfig.js

@@ -1,7 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConfig = void 0;
+const amount_1 = require("../../../utils/amount");
 const _helpers_1 = require("./_helpers");
+/** Decimals of the vault's fee values: FEE_PRECISION is 1e9. */
+const FEE_DECIMALS = 9;
+/**
+ * Reads the vault's linked addresses and fee parameters.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The addresses and the fees as 9-decimal fixed-point values.
+ */
 const getConfig = async (chainId, provider) => {
     const contract = await (0, _helpers_1.getMaturityVaultContract)(chainId, provider);
     const [raac, leRAAC, platform, governor, owner, platformFeePercentage, harvestBountyPercentage] = await Promise.all([
@@ -19,8 +29,8 @@ const getConfig = async (chainId, provider) => {
         platform,
         governor,
         owner,
-        platformFeePercentage,
-        harvestBountyPercentage,
+        platformFeePercentage: (0, amount_1.toScaled)(platformFeePercentage, FEE_DECIMALS),
+        harvestBountyPercentage: (0, amount_1.toScaled)(harvestBountyPercentage, FEE_DECIMALS),
     };
 };
 exports.getConfig = getConfig;

package/dist/contracts/lockers/maturityVault/getGlobalInfo.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGlobalInfo = void 0;
-const ethers_1 = require("ethers");
+const amount_1 = require("../../../utils/amount");
 const _helpers_1 = require("./_helpers");
 /**
  * Snapshot of the maturity vault's global accounting and active reward schedule.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The vault totals and reward schedule; see `MaturityVaultGlobalInfo` for the unit of each field.
  */
 const getGlobalInfo = async (chainId, provider) => {
     const contract = await (0, _helpers_1.getMaturityVaultContract)(chainId, provider);
@@ -22,23 +26,17 @@ const getGlobalInfo = async (chainId, provider) => {
     const lastUpdate = rewardInfoTuple.lastUpdate ?? rewardInfoTuple[2];
     const finishAt = rewardInfoTuple.finishAt ?? rewardInfoTuple[3];
     return {
-        totalRAACInPool: ethers_1.ethers.formatEther(totalRAACInPool),
-        totalUnrealised: ethers_1.ethers.formatEther(totalUnrealised),
-        totalRealised: ethers_1.ethers.formatEther(totalRealised),
+        totalRAACInPool: (0, amount_1.toTokenAmount)(chainId, "raactoken", totalRAACInPool),
+        totalUnrealised: (0, amount_1.toTokenAmount)(chainId, "leraac", totalUnrealised),
+        totalRealised: (0, amount_1.toTokenAmount)(chainId, "raactoken", totalRealised),
         accUnrealisedFraction,
         distributeIndex,
         lastPaidOffDistributeIndex,
         rewardInfo: {
-            ratePerSecond: ethers_1.ethers.formatEther(ratePerSecond),
+            ratePerSecond: (0, amount_1.toTokenAmount)(chainId, "raactoken", ratePerSecond),
             periodLength: Number(periodLength),
             lastUpdate: Number(lastUpdate),
             finishAt: Number(finishAt),
-            raw: { ratePerSecond, periodLength, lastUpdate, finishAt },
-        },
-        raw: {
-            totalRAACInPool,
-            totalUnrealised,
-            totalRealised,
         },
     };
 };

package/dist/contracts/lockers/maturityVault/getUserInfo.js

@@ -1,18 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUserInfo = void 0;
-const ethers_1 = require("ethers");
+const amount_1 = require("../../../utils/amount");
 const _helpers_1 = require("./_helpers");
 /**
  * Returns the user's unrealised (still-earning leRAAC) and realised (claimable RAAC) totals.
+ *
+ * @param chainId - The chain/network to use.
+ * @param account - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The user's unrealised leRAAC and realised RAAC, in base units.
  */
 const getUserInfo = async (chainId, account, provider) => {
     const contract = await (0, _helpers_1.getMaturityVaultContract)(chainId, provider);
     const [unrealised, realised] = await contract.getUserInfo(account);
     return {
-        unrealised: ethers_1.ethers.formatEther(unrealised),
-        realised: ethers_1.ethers.formatEther(realised),
-        raw: { unrealised, realised },
+        unrealised: (0, amount_1.toTokenAmount)(chainId, "leraac", unrealised),
+        realised: (0, amount_1.toTokenAmount)(chainId, "raactoken", realised),
     };
 };
 exports.getUserInfo = getUserInfo;

package/dist/contracts/lockers/maturityVault/withdraw.js

@@ -4,6 +4,11 @@ exports.withdraw = void 0;
 const _helpers_1 = require("./_helpers");
 /**
  * Withdraw `amount` of unrealised leRAAC to `recipient`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param recipient - Address that receives the leRAAC.
+ * @param amount - leRAAC to withdraw, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const withdraw = async (chainId, recipient, amount, signer) => {
     if (!signer)

package/dist/contracts/pmBlender/_helpers.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPmBlenderContract = getPmBlenderContract;
+const ethers_1 = require("ethers");
+const contracts_1 = require("../../utils/contracts");
+const artifacts_1 = require("../../utils/artifacts");
+const index_1 = require("../../configs/chains/index");
+/**
+ * Builds the pmBlender (TokenBlender) contract for reads.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The contract and its address.
+ */
+function getPmBlenderContract(chainId, provider) {
+    const runner = provider ?? new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
+    const address = (0, contracts_1.getContractAddress)(chainId, "pmblender");
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("pmblender"), runner);
+    return { contract, address };
+}

package/dist/contracts/pmBlender/getReserveBalance.js

@@ -1,21 +1,22 @@
 "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 index_1 = require("../../configs/chains/index");
-async function getReserveBalance(chainId) {
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * Reads the pmBlender reserve: the sum of every supported token balance converted at its ratio.
+ * @param chainId The chain id.
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The reserve, denominated in the pmBlender token (registry decimals and symbol, else 18 decimals: TokenBlender is an 18-decimal ERC20).
+ */
+async function getReserveBalance(chainId, provider) {
     try {
-        const provider = new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
-        const pmBlenderAddress = (0, contracts_1.getContractAddress)(chainId, "pmblender");
-        const pmBlenderABI = (0, artifacts_1.getABI)("pmblender");
-        const pmBlenderContract = new ethers_1.ethers.Contract(pmBlenderAddress, pmBlenderABI, provider);
-        const balance = await pmBlenderContract.getReserveBalance();
-        return ethers_1.ethers.formatEther(balance);
+        const { contract, address } = (0, _helpers_1.getPmBlenderContract)(chainId, provider);
+        const balance = await contract.getReserveBalance();
+        return (0, amount_1.toTokenAmount)(chainId, address, balance);
     }
     catch (error) {
         console.error("Error getting pm blender reserve balance:", error);
-        return -1;
+        throw error;
     }
 }
 exports.default = getReserveBalance;

package/dist/contracts/pmBlender/previewDeposit.js

@@ -1,21 +1,24 @@
 "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 index_1 = require("../../configs/chains/index");
-async function previewDeposit(chainId, token, amount) {
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * Previews how many pmBlender tokens a deposit mints.
+ * @param chainId The chain id.
+ * @param token The supported token to deposit.
+ * @param amount The deposit in `token` base units (TokenBlender only supports 18-decimal tokens).
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The pmBlender tokens minted, in the pmBlender token (registry decimals and symbol, else 18 decimals: TokenBlender is an 18-decimal ERC20).
+ */
+async function previewDeposit(chainId, token, amount, provider) {
     try {
-        const provider = new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
-        const pmBlenderAddress = (0, contracts_1.getContractAddress)(chainId, "pmblender");
-        const pmBlenderABI = (0, artifacts_1.getABI)("pmblender");
-        const pmBlenderContract = new ethers_1.ethers.Contract(pmBlenderAddress, pmBlenderABI, provider);
-        const result = await pmBlenderContract.previewDeposit(token, ethers_1.ethers.parseEther(amount));
-        return ethers_1.ethers.parseEther(result);
+        const { contract, address } = (0, _helpers_1.getPmBlenderContract)(chainId, provider);
+        const result = await contract.previewDeposit(token, amount);
+        return (0, amount_1.toTokenAmount)(chainId, address, result);
     }
     catch (error) {
         console.error("Error getting pm blender preview deposit:", error);
-        return -1;
+        throw error;
     }
 }
 exports.default = previewDeposit;

package/dist/contracts/pmBlender/previewSwap.js

@@ -1,21 +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 index_1 = require("../../configs/chains/index");
-async function previewSwap(chainId, tokenIn, tokenOut, amountIn) {
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * Previews a swap between two supported tokens.
+ * @param chainId The chain id.
+ * @param tokenIn The supported token sent.
+ * @param tokenOut The supported token received.
+ * @param amountIn The amount sent in `tokenIn` base units (TokenBlender only supports 18-decimal tokens).
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The amount of `tokenOut` received, with its registry decimals and symbol (18 decimals if not in the registry, which TokenBlender enforces for supported tokens).
+ */
+async function previewSwap(chainId, tokenIn, tokenOut, amountIn, provider) {
     try {
-        const provider = new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
-        const pmBlenderAddress = (0, contracts_1.getContractAddress)(chainId, "pmblender");
-        const pmBlenderABI = (0, artifacts_1.getABI)("pmblender");
-        const pmBlenderContract = new ethers_1.ethers.Contract(pmBlenderAddress, pmBlenderABI, provider);
-        const result = await pmBlenderContract.previewSwap(tokenIn, tokenOut, ethers_1.ethers.parseEther(amountIn));
-        return ethers_1.ethers.formatEther(result);
+        const { contract } = (0, _helpers_1.getPmBlenderContract)(chainId, provider);
+        const result = await contract.previewSwap(tokenIn, tokenOut, amountIn);
+        return (0, amount_1.toTokenAmount)(chainId, tokenOut, result);
     }
     catch (error) {
         console.error("Error getting pm blender preview swap:", error);
-        return -1;
+        throw error;
     }
 }
 exports.default = previewSwap;

package/dist/contracts/pmBlender/previewWithdraw.js

@@ -1,21 +1,24 @@
 "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 index_1 = require("../../configs/chains/index");
-async function previewWithdraw(chainId, token, amountOut) {
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * Previews how many pmBlender tokens are burned to withdraw an exact amount of a supported token.
+ * @param chainId The chain id.
+ * @param token The supported token to withdraw.
+ * @param amountOut The amount to receive in `token` base units (TokenBlender only supports 18-decimal tokens).
+ * @param provider Optional provider; defaults to the chain's first configured RPC.
+ * @returns The pmBlender tokens burned, in the pmBlender token (registry decimals and symbol, else 18 decimals: TokenBlender is an 18-decimal ERC20).
+ */
+async function previewWithdraw(chainId, token, amountOut, provider) {
     try {
-        const provider = new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
-        const pmBlenderAddress = (0, contracts_1.getContractAddress)(chainId, "pmblender");
-        const pmBlenderABI = (0, artifacts_1.getABI)("pmblender");
-        const pmBlenderContract = new ethers_1.ethers.Contract(pmBlenderAddress, pmBlenderABI, provider);
-        const result = await pmBlenderContract.previewWithdraw(token, ethers_1.ethers.parseEther(amountOut));
-        return ethers_1.ethers.formatEther(result);
+        const { contract, address } = (0, _helpers_1.getPmBlenderContract)(chainId, provider);
+        const result = await contract.previewWithdraw(token, amountOut);
+        return (0, amount_1.toTokenAmount)(chainId, address, result);
     }
     catch (error) {
         console.error("Error getting pm blender preview withdraw:", error);
-        return -1;
+        throw error;
     }
 }
 exports.default = previewWithdraw;

package/dist/contracts/pmMarket/getMarketConfig.js

@@ -4,28 +4,30 @@ const ethers_1 = require("ethers");
 const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
 const index_1 = require("../../configs/chains/index");
-async function getMarketConfig(chainId) {
+const amount_1 = require("../../utils/amount");
+/**
+ * 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.
+ */
+async function getMarketConfig(chainId, provider) {
     try {
-        const provider = new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
+        const runner = provider ?? new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
         const pmMarketAddress = (0, contracts_1.getContractAddress)(chainId, "pmmarket");
         const pmMarketABI = (0, artifacts_1.getABI)("pmmarket");
-        const pmMarketContract = new ethers_1.ethers.Contract(pmMarketAddress, pmMarketABI, provider);
+        const pmMarketContract = new ethers_1.ethers.Contract(pmMarketAddress, pmMarketABI, runner);
         const marketConfig = await pmMarketContract.marketConfig();
         return {
-            stabilityRatio: ethers_1.ethers.formatEther(marketConfig[0]),
-            liquidationRatio: ethers_1.ethers.formatEther(marketConfig[1]),
-            selfLiquidationRatio: ethers_1.ethers.formatEther(marketConfig[2]),
-            recapRatio: ethers_1.ethers.formatEther(marketConfig[3]),
+            stabilityRatio: (0, amount_1.toScaled)(marketConfig[0], amount_1.WAD_DECIMALS),
+            liquidationRatio: (0, amount_1.toScaled)(marketConfig[1], amount_1.WAD_DECIMALS),
+            selfLiquidationRatio: (0, amount_1.toScaled)(marketConfig[2], amount_1.WAD_DECIMALS),
+            recapRatio: (0, amount_1.toScaled)(marketConfig[3], amount_1.WAD_DECIMALS),
         };
     }
     catch (error) {
         console.error("Error getting pm market config:", error);
-        return {
-            stabilityRatio: -1,
-            liquidationRatio: -1,
-            selfLiquidationRatio: -1,
-            recapRatio: -1,
-        };
+        throw error;
     }
 }
 exports.default = getMarketConfig;

package/dist/contracts/pmTreasury/_helpers.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_TOKEN_DECIMALS = void 0;
+exports.resolvePmTreasuryProvider = resolvePmTreasuryProvider;
+exports.getPmTreasuryContract = getPmTreasuryContract;
+exports.assertCollateralRatio = assertCollateralRatio;
+const ethers_1 = require("ethers");
+const contracts_1 = require("../../utils/contracts");
+const index_1 = require("../../configs/chains/index");
+const amount_1 = require("../../utils/amount");
+const pmTreasury_json_1 = __importDefault(require("../../artifacts/core/pmTreasury/pmTreasury.json"));
+/**
+ * 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.
+ */
+exports.BASE_TOKEN_DECIMALS = amount_1.WAD_DECIMALS;
+/**
+ * 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.
+ */
+function resolvePmTreasuryProvider(chainId, provider) {
+    return provider ?? new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
+}
+/**
+ * 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.
+ */
+function getPmTreasuryContract(chainId, provider) {
+    const address = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
+    return new ethers_1.ethers.Contract(address, pmTreasury_json_1.default.abi, provider);
+}
+/**
+ * Throws if a collateral ratio is not above 1.0, which the treasury would revert on anyway.
+ * @param newCollateralRatio The ratio, scaled by 1e18.
+ */
+function assertCollateralRatio(newCollateralRatio) {
+    if (typeof newCollateralRatio !== "bigint") {
+        throw new Error("newCollateralRatio must be a bigint scaled by 1e18");
+    }
+    if (newCollateralRatio <= 10n ** 18n) {
+        throw new Error("newCollateralRatio must be greater than 1e18 (1.0)");
+    }
+}

package/dist/contracts/pmTreasury/getCollateralRatio.js

@@ -1,26 +1,23 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const ethers_1 = require("ethers");
-const contracts_1 = require("../../utils/contracts");
-const index_1 = require("../../configs/chains/index");
-// import { PMTreasury } from "../../typechain-types";
-const pmTreasury_json_1 = __importDefault(require("../../artifacts/core/pmTreasury/pmTreasury.json"));
-async function getCollateralRatio(chainId) {
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * 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%).
+ */
+async function getCollateralRatio(chainId, provider) {
     try {
-        const provider = new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
-        const pmTreasuryAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
-        // const pmTreasuryABI = getABI("pmtreasury");
-        const pmTreasuryABI = pmTreasury_json_1.default.abi;
-        const pmTreasuryContract = new ethers_1.ethers.Contract(pmTreasuryAddress, pmTreasuryABI, provider);
+        const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
+        const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
         const collateralRatio = await pmTreasuryContract.collateralRatio();
-        return collateralRatio;
+        return (0, amount_1.toScaled)(collateralRatio, amount_1.WAD_DECIMALS);
     }
     catch (error) {
         console.error("Error getting collateral ratio:", error);
-        return -1;
+        throw error;
     }
 }
 exports.default = getCollateralRatio;

package/dist/contracts/pmTreasury/getCurrentNav.js

@@ -1,34 +1,27 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const ethers_1 = require("ethers");
-const contracts_1 = require("../../utils/contracts");
-const index_1 = require("../../configs/chains/index");
-// import { PMTreasury } from "../../typechain-types";
-const pmTreasury_json_1 = __importDefault(require("../../artifacts/core/pmTreasury/pmTreasury.json"));
-async function getCurrentNav(chainId) {
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * 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.
+ */
+async function getCurrentNav(chainId, provider) {
     try {
-        const provider = new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
-        const pmTreasuryAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
-        // const pmTreasuryABI = getABI("pmtreasury");
-        const pmTreasuryABI = pmTreasury_json_1.default.abi;
-        const pmTreasuryContract = new ethers_1.ethers.Contract(pmTreasuryAddress, pmTreasuryABI, provider);
+        const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
+        const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
         const currentNav = await pmTreasuryContract.getCurrentNav();
         return {
-            goldNav: ethers_1.ethers.formatEther(currentNav._baseNav),
-            goldUSDNav: ethers_1.ethers.formatEther(currentNav._fNav),
-            xGoldNav: ethers_1.ethers.formatEther(currentNav._xNav),
+            goldNav: (0, amount_1.toScaled)(currentNav._baseNav, amount_1.WAD_DECIMALS),
+            goldUSDNav: (0, amount_1.toScaled)(currentNav._fNav, amount_1.WAD_DECIMALS),
+            xGoldNav: (0, amount_1.toScaled)(currentNav._xNav, amount_1.WAD_DECIMALS),
         };
     }
     catch (error) {
         console.error("Error getting current nav:", error);
-        return {
-            goldNav: -1,
-            goldUSDNav: -1,
-            xGoldNav: -1,
-        };
+        throw error;
     }
 }
 exports.default = getCurrentNav;