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

package/dist/contracts/governance/proposals/setParameter.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setParameter = exports.GovernanceParameter = void 0;
+const ethers_1 = require("ethers");
+const _helpers_1 = require("../_helpers");
+const artifacts_1 = require("../../../utils/artifacts");
+/**
+ * Governance parameters enum matching the contract
+ */
+var GovernanceParameter;
+(function (GovernanceParameter) {
+    GovernanceParameter[GovernanceParameter["VotingDelay"] = 0] = "VotingDelay";
+    GovernanceParameter[GovernanceParameter["VotingPeriod"] = 1] = "VotingPeriod";
+    GovernanceParameter[GovernanceParameter["ProposalThreshold"] = 2] = "ProposalThreshold";
+    GovernanceParameter[GovernanceParameter["QuorumNumerator"] = 3] = "QuorumNumerator";
+})(GovernanceParameter || (exports.GovernanceParameter = GovernanceParameter = {}));
+/**
+ * Updates a governance parameter. Requires `PARAMETER_UPDATE_ROLE`; takes effect immediately.
+ * Only affects proposals created afterwards, since quorum inputs are snapshotted at creation.
+ *
+ * @param chainId - The chain/network to use.
+ * @param governance - Address of the Governance contract.
+ * @param param - The parameter to update.
+ * @param newValue - The new raw value: seconds for the voting delay and period, veRAAC base units for the proposal threshold, percent (denominator 100) for the quorum numerator.
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The transaction response.
+ */
+const setParameter = async (chainId, governance, param, newValue, signer) => {
+    if (!signer) {
+        throw new Error("Signer is required");
+    }
+    try {
+        const contractAddress = (0, _helpers_1.requireAddress)(governance, "Governance");
+        const abi = (0, artifacts_1.getABI)("governance");
+        const contract = new ethers_1.ethers.Contract(contractAddress, abi, signer);
+        const tx = await contract.setParameter(param, newValue);
+        await tx.wait();
+        console.log(`Governance parameter ${GovernanceParameter[param]} set to ${newValue} at ${contractAddress}`);
+        return tx;
+    }
+    catch (error) {
+        console.error("Error setting governance parameter:", error);
+        throw new Error(`Failed to set governance parameter: ${error.message}`);
+    }
+};
+exports.setParameter = setParameter;

package/dist/contracts/governance/proposals/setTimelock.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setTimelock = void 0;
+const ethers_1 = require("ethers");
+const _helpers_1 = require("../_helpers");
+const artifacts_1 = require("../../../utils/artifacts");
+/**
+ * Updates the timelock controller used to queue new proposals. Requires `DEFAULT_ADMIN_ROLE`.
+ * Proposals already queued stay bound to the timelock they were queued in.
+ * Update the instance's `timelock` in the chain config afterwards so it stays in sync.
+ *
+ * @param chainId - The chain/network to use.
+ * @param governance - Address of the Governance contract.
+ * @param newTimelock - Address of the new timelock controller.
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The transaction response.
+ */
+const setTimelock = async (chainId, governance, newTimelock, signer) => {
+    if (!signer) {
+        throw new Error("Signer is required");
+    }
+    try {
+        const contractAddress = (0, _helpers_1.requireAddress)(governance, "Governance");
+        const abi = (0, artifacts_1.getABI)("governance");
+        const contract = new ethers_1.ethers.Contract(contractAddress, abi, signer);
+        const tx = await contract.setTimelock(newTimelock);
+        await tx.wait();
+        console.log(`Governance timelock set to ${newTimelock} at ${contractAddress}`);
+        return tx;
+    }
+    catch (error) {
+        console.error("Error setting governance timelock:", error);
+        throw new Error(`Failed to set governance timelock: ${error.message}`);
+    }
+};
+exports.setTimelock = setTimelock;

package/dist/contracts/governance/timelock/getConstants.js

@@ -6,21 +6,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConstants = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
+const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
 /**
  * Gets the timelock constants.
  *
  * @param chainId - The chain/network to use.
+ * @param timelock - Address of the TimelockController contract.
  * @param provider - Optional ethers.js Provider instance.
  * @returns Timelock constants including MIN_DELAY, MAX_DELAY, GRACE_PERIOD, EMERGENCY_DELAY.
  */
-const getConstants = async (chainId, provider) => {
+const getConstants = async (chainId, timelock, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "timelockcontroller");
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
     const abi = (0, artifacts_1.getABI)("timelockcontroller");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const [minDelay, maxDelay, gracePeriod, emergencyDelay] = await Promise.all([

package/dist/contracts/governance/timelock/getMinDelay.js

@@ -6,21 +6,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMinDelay = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
+const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
 /**
  * Returns the minimum delay for operations.
  *
  * @param chainId - The chain/network to use.
+ * @param timelock - Address of the TimelockController contract.
  * @param provider - Optional ethers.js Provider instance.
  * @returns Current minimum delay in seconds.
  */
-const getMinDelay = async (chainId, provider) => {
+const getMinDelay = async (chainId, timelock, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "timelockcontroller");
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
     const abi = (0, artifacts_1.getABI)("timelockcontroller");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const minDelay = await contract.getMinDelay();

package/dist/contracts/governance/timelock/getRoles.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRoles = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const _helpers_1 = require("../_helpers");
+const artifacts_1 = require("../../../utils/artifacts");
+/**
+ * Gets the access-control role identifiers used by the TimelockController.
+ * Governance must hold PROPOSER_ROLE, EXECUTOR_ROLE and CANCELLER_ROLE to queue, execute and cancel proposals.
+ *
+ * @param chainId - The chain/network to use.
+ * @param timelock - Address of the TimelockController contract.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The bytes32 role identifiers.
+ */
+const getRoles = async (chainId, timelock, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
+    const abi = (0, artifacts_1.getABI)("timelockcontroller");
+    const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
+    const [defaultAdminRole, proposerRole, executorRole, cancellerRole, emergencyRole] = await Promise.all([
+        contract.DEFAULT_ADMIN_ROLE(),
+        contract.PROPOSER_ROLE(),
+        contract.EXECUTOR_ROLE(),
+        contract.CANCELLER_ROLE(),
+        contract.EMERGENCY_ROLE(),
+    ]);
+    return { defaultAdminRole, proposerRole, executorRole, cancellerRole, emergencyRole };
+};
+exports.getRoles = getRoles;

package/dist/contracts/governance/timelock/getTimestamp.js

@@ -6,23 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTimestamp = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
+const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
 /**
  * Returns the timestamp for an operation.
  * This is when the operation will be ready for execution.
  *
  * @param chainId - The chain/network to use.
+ * @param timelock - Address of the TimelockController contract.
  * @param operationId - Operation ID to check (bytes32 hash).
  * @param provider - Optional ethers.js Provider instance.
  * @returns Timestamp when operation will be ready (0 if not scheduled).
  */
-const getTimestamp = async (chainId, operationId, provider) => {
+const getTimestamp = async (chainId, timelock, operationId, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "timelockcontroller");
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
     const abi = (0, artifacts_1.getABI)("timelockcontroller");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const timestamp = await contract.getTimestamp(operationId);

package/dist/contracts/governance/timelock/hasRole.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasRole = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const _helpers_1 = require("../_helpers");
+const artifacts_1 = require("../../../utils/artifacts");
+/**
+ * Checks whether an account holds a TimelockController role.
+ *
+ * @param chainId - The chain/network to use.
+ * @param timelock - Address of the TimelockController contract.
+ * @param role - The bytes32 role identifier (see `getRoles`).
+ * @param account - The address to check.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns True if the account holds the role.
+ */
+const hasRole = async (chainId, timelock, role, account, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
+    const abi = (0, artifacts_1.getABI)("timelockcontroller");
+    const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
+    return await contract.hasRole(role, account);
+};
+exports.hasRole = hasRole;

package/dist/contracts/governance/timelock/hashOperationBatch.js

@@ -6,30 +6,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.hashOperationBatch = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
+const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
 /**
  * Hashes an operation for unique identification.
  * Use this to compute the operation ID before scheduling or checking status.
  *
  * @param chainId - The chain/network to use.
- * @param proposalId - The ID of the proposal.
+ * @param timelock - Address of the TimelockController contract.
+ * @param nonce - Caller-supplied discriminator. Governance passes the proposal ID.
  * @param targets - Target addresses for calls.
- * @param values - ETH values for calls.
+ * @param values - ETH values for the calls, in wei.
  * @param calldatas - Calldata for calls.
  * @param predecessor - ID of operation that must be executed before (or zero bytes32).
  * @param salt - Random value for operation ID.
  * @param provider - Optional ethers.js Provider instance.
  * @returns Operation hash (bytes32).
  */
-const hashOperationBatch = async (chainId, proposalId, targets, values, calldatas, predecessor, salt, provider) => {
+const hashOperationBatch = async (chainId, timelock, nonce, targets, values, calldatas, predecessor, salt, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "timelockcontroller");
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
     const abi = (0, artifacts_1.getABI)("timelockcontroller");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
-    return await contract.hashOperationBatch(proposalId, targets, values, calldatas, predecessor, salt);
+    return await contract.hashOperationBatch(nonce, targets, values, calldatas, predecessor, salt);
 };
 exports.hashOperationBatch = hashOperationBatch;

package/dist/contracts/governance/timelock/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConstants = exports.hashOperationBatch = exports.getMinDelay = exports.getTimestamp = exports.isOperationDone = exports.isOperationReady = exports.isOperationPending = void 0;
+exports.hasRole = exports.getRoles = exports.getConstants = exports.hashOperationBatch = exports.getMinDelay = exports.getTimestamp = exports.isOperationDone = exports.isOperationReady = exports.isOperationPending = void 0;
 // Read functions
 var isOperationPending_1 = require("./isOperationPending");
 Object.defineProperty(exports, "isOperationPending", { enumerable: true, get: function () { return isOperationPending_1.isOperationPending; } });
@@ -16,3 +16,7 @@ var hashOperationBatch_1 = require("./hashOperationBatch");
 Object.defineProperty(exports, "hashOperationBatch", { enumerable: true, get: function () { return hashOperationBatch_1.hashOperationBatch; } });
 var getConstants_1 = require("./getConstants");
 Object.defineProperty(exports, "getConstants", { enumerable: true, get: function () { return getConstants_1.getConstants; } });
+var getRoles_1 = require("./getRoles");
+Object.defineProperty(exports, "getRoles", { enumerable: true, get: function () { return getRoles_1.getRoles; } });
+var hasRole_1 = require("./hasRole");
+Object.defineProperty(exports, "hasRole", { enumerable: true, get: function () { return hasRole_1.hasRole; } });

package/dist/contracts/governance/timelock/isOperationDone.js

@@ -6,22 +6,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isOperationDone = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
+const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
 /**
  * Returns whether an operation is done (executed).
  *
  * @param chainId - The chain/network to use.
+ * @param timelock - Address of the TimelockController contract.
  * @param operationId - Operation ID to check (bytes32 hash).
  * @param provider - Optional ethers.js Provider instance.
  * @returns True if operation is done.
  */
-const isOperationDone = async (chainId, operationId, provider) => {
+const isOperationDone = async (chainId, timelock, operationId, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "timelockcontroller");
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
     const abi = (0, artifacts_1.getABI)("timelockcontroller");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     return await contract.isOperationDone(operationId);

package/dist/contracts/governance/timelock/isOperationPending.js

@@ -6,22 +6,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isOperationPending = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
+const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
 /**
  * Returns whether an operation is pending (scheduled but not executed).
  *
  * @param chainId - The chain/network to use.
+ * @param timelock - Address of the TimelockController contract.
  * @param operationId - Operation ID to check (bytes32 hash).
  * @param provider - Optional ethers.js Provider instance.
  * @returns True if operation is pending.
  */
-const isOperationPending = async (chainId, operationId, provider) => {
+const isOperationPending = async (chainId, timelock, operationId, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "timelockcontroller");
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
     const abi = (0, artifacts_1.getABI)("timelockcontroller");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     return await contract.isOperationPending(operationId);

package/dist/contracts/governance/timelock/isOperationReady.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isOperationReady = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
+const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
 /**
  * Returns whether an operation is ready for execution.
@@ -14,16 +14,17 @@ const artifacts_1 = require("../../../utils/artifacts");
  * it's still within the grace period.
  *
  * @param chainId - The chain/network to use.
+ * @param timelock - Address of the TimelockController contract.
  * @param operationId - Operation ID to check (bytes32 hash).
  * @param provider - Optional ethers.js Provider instance.
  * @returns True if operation can be executed.
  */
-const isOperationReady = async (chainId, operationId, provider) => {
+const isOperationReady = async (chainId, timelock, operationId, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "timelockcontroller");
+    const contractAddress = (0, _helpers_1.requireAddress)(timelock, "TimelockController");
     const abi = (0, artifacts_1.getABI)("timelockcontroller");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     return await contract.isOperationReady(operationId);

package/dist/contracts/housePrices/getLatestPrice.js

@@ -1,21 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
+const _helpers_1 = require("../../nfts/_helpers");
 const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
+const amount_1 = require("../../utils/amount");
+/**
+ * Reads the latest house price of a RAAC NFT from RAACHousePrices. The contract stores the USD price with 18
+ * decimals and converts it to crvUSD through the crvUSD/USD oracle, returning 18 decimals.
+ * @param chainId The chain id.
+ * @param tokenId The RAAC NFT token id.
+ * @param provider The provider to read with.
+ * @returns The crvUSD price and the timestamp of its last update.
+ */
 async function getLatestPrice(chainId, tokenId, provider) {
     try {
         const raacHousePricesAddress = (0, contracts_1.getContractAddress)(chainId, "raachouseprices");
         const raacHousePricesABI = (0, artifacts_1.getABI)("raachouseprices");
         const raacHousePricesContract = new ethers_1.ethers.Contract(raacHousePricesAddress, raacHousePricesABI, provider);
         const [price, timestamp] = await raacHousePricesContract.getLatestPrice(tokenId);
-        return { price, timestamp };
+        return { price: (0, amount_1.toTokenAmount)(chainId, (0, _helpers_1.getNftAssetId)(chainId), price), timestamp };
     }
     catch (error) {
         console.error("Error getting latest price:", error);
-        return { price: -1n, timestamp: -1 };
-        // console.error('Error getting latest price:', error);
-        // throw new Error(`Failed to get latest price: ${error.message}`);
+        throw error;
     }
 }
 exports.default = getLatestPrice;

package/dist/contracts/lockers/botLocker/getClaimable.js

@@ -1,12 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getClaimable = void 0;
+const amount_1 = require("../../../utils/amount");
 const _helpers_1 = require("./_helpers");
 /**
  * Claimable amount of a single reward token for `account`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param account - Address of the user.
+ * @param token - Address of the reward token.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The claimable amount in `token` base units, with its registry decimals and symbol.
  */
 const getClaimable = async (chainId, account, token, provider) => {
     const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
-    return contract.claimable(account, token);
+    return (0, amount_1.toTokenAmount)(chainId, token, await contract.claimable(account, token));
 };
 exports.getClaimable = getClaimable;

package/dist/contracts/lockers/botLocker/getClaimables.js

@@ -1,16 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getClaimables = void 0;
+const amount_1 = require("../../../utils/amount");
 const _helpers_1 = require("./_helpers");
 /**
  * Claimable amounts across all registered reward tokens for `account`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param account - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns One entry per reward token, each amount in that token's base units.
  */
 const getClaimables = async (chainId, account, provider) => {
     const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
     const results = await contract.claimables(account);
-    return results.map((r) => ({
-        token: r.token ?? r[0],
-        amount: r.amount ?? r[1],
-    }));
+    return results.map((r) => {
+        const token = r.token ?? r[0];
+        return { token, amount: (0, amount_1.toTokenAmount)(chainId, token, r.amount ?? r[1]) };
+    });
 };
 exports.getClaimables = getClaimables;

package/dist/contracts/lockers/botLocker/getClaimedRewards.js

@@ -1,13 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getClaimedRewards = void 0;
+const amount_1 = require("../../../utils/amount");
 const _helpers_1 = require("./_helpers");
+/**
+ * Rewards `account` has already claimed, per reward token.
+ *
+ * @param chainId - The chain/network to use.
+ * @param account - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns One entry per reward token, each amount in that token's base units.
+ */
 const getClaimedRewards = async (chainId, account, provider) => {
     const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
     const results = await contract.getClaimedRewards(account);
-    return results.map((r) => ({
-        token: r.token ?? r[0],
-        amount: r.amount ?? r[1],
-    }));
+    return results.map((r) => {
+        const token = r.token ?? r[0];
+        return { token, amount: (0, amount_1.toTokenAmount)(chainId, token, r.amount ?? r[1]) };
+    });
 };
 exports.getClaimedRewards = getClaimedRewards;

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

@@ -5,6 +5,11 @@ const _helpers_1 = require("./_helpers");
 /**
  * Borrow leRAAC against the caller's locked RAAC collateral.
  * If `depositToMaturityVault` is true, borrowed leRAAC is forwarded to the maturity vault for the caller.
+ *
+ * @param chainId - The chain/network to use.
+ * @param amount - leRAAC to borrow, base units.
+ * @param depositToMaturityVault - True to forward the borrowed leRAAC to the maturity vault.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const borrow = async (chainId, amount, depositToMaturityVault, signer) => {
     if (!signer)

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkAccountHealth = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Whether a user's position is currently overcollateralised.
+ *
+ * Reserved collateral is scheduled to leave and so is netted out before the check, which is
+ * why a position can go unhealthy on requestUnlock alone, without any new borrowing.
+ */
+const checkAccountHealth = async (chainId, account, provider) => {
+    const contract = await (0, _helpers_1.getLiquidLockerContract)(chainId, provider);
+    return contract.checkAccountHealth(account);
+};
+exports.checkAccountHealth = checkAccountHealth;

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

@@ -5,6 +5,10 @@ const _helpers_1 = require("./_helpers");
 /**
  * Deposit RAAC into the liquid locker; locks underlying RAAC into veRAAC for the locker.
  * Caller must have approved the locker to spend RAAC beforehand.
+ *
+ * @param chainId - The chain/network to use.
+ * @param amount - RAAC to deposit, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const deposit = async (chainId, amount, signer) => {
     if (!signer)

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

@@ -4,6 +4,10 @@ exports.donate = void 0;
 const _helpers_1 = require("./_helpers");
 /**
  * Donate RAAC to be distributed pro-rata to all lockers.
+ *
+ * @param chainId - The chain/network to use.
+ * @param amount - RAAC to donate, base units.
+ * @param signer - An ethers.js Signer instance (required).
  */
 const donate = async (chainId, amount, signer) => {
     if (!signer)

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

@@ -1,10 +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 locker's fee and ratio values: FEE_PRECISION is 1e9. */
+const FEE_DECIMALS = 9;
 /**
  * Read the locker's configuration parameters in a single call batch.
  * Frontend setup screens / dashboards should call this to render fee % and linked addresses.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The linked addresses and the fee and ratio parameters as 9-decimal fixed-point values.
  */
 const getConfig = async (chainId, provider) => {
     const contract = await (0, _helpers_1.getLiquidLockerContract)(chainId, provider);
@@ -39,13 +46,13 @@ const getConfig = async (chainId, provider) => {
         cleverFeeRecipient,
         raacBotLocker,
         lockDurationEpochs: Number(lockDurationEpochs),
-        reserveRate,
-        repayFeePercentage,
-        harvestBountyPercentage,
-        treasuryFeePercentage,
-        feeSharesBots,
-        feeSharesClever,
-        feeSharesTreasury,
+        reserveRate: (0, amount_1.toScaled)(reserveRate, FEE_DECIMALS),
+        repayFeePercentage: (0, amount_1.toScaled)(repayFeePercentage, FEE_DECIMALS),
+        harvestBountyPercentage: (0, amount_1.toScaled)(harvestBountyPercentage, FEE_DECIMALS),
+        treasuryFeePercentage: (0, amount_1.toScaled)(treasuryFeePercentage, FEE_DECIMALS),
+        feeSharesBots: (0, amount_1.toScaled)(feeSharesBots, FEE_DECIMALS),
+        feeSharesClever: (0, amount_1.toScaled)(feeSharesClever, FEE_DECIMALS),
+        feeSharesTreasury: (0, amount_1.toScaled)(feeSharesTreasury, FEE_DECIMALS),
         paused,
     };
 };

package/dist/contracts/lockers/liquidLocker/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");
 /**
  * One-shot snapshot of locker global accounting.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The global totals; see `LiquidLockerGlobalInfo` for the unit of each field.
  */
 const getGlobalInfo = async (chainId, provider) => {
     const contract = await (0, _helpers_1.getLiquidLockerContract)(chainId, provider);
@@ -18,22 +22,13 @@ const getGlobalInfo = async (chainId, provider) => {
         contract.poolLockedUnderlying(),
     ]);
     return {
-        totalLockedGlobal: ethers_1.ethers.formatEther(totalLockedGlobal),
-        totalUnlockedGlobal: ethers_1.ethers.formatEther(totalUnlockedGlobal),
-        totalDebtGlobal: ethers_1.ethers.formatEther(totalDebtGlobal),
-        pendingCumulatedAmount: ethers_1.ethers.formatEther(pendingCumulatedAmount),
-        accRewardPerShare: accRewardPerShare.toString(),
-        totalRaacInPool: ethers_1.ethers.formatEther(totalRaacInPool),
-        poolLockedUnderlying: ethers_1.ethers.formatEther(poolLockedUnderlying),
-        raw: {
-            totalLockedGlobal,
-            totalUnlockedGlobal,
-            totalDebtGlobal,
-            pendingCumulatedAmount,
-            accRewardPerShare,
-            totalRaacInPool,
-            poolLockedUnderlying,
-        },
+        totalLockedGlobal: (0, amount_1.toTokenAmount)(chainId, "raactoken", totalLockedGlobal),
+        totalUnlockedGlobal: (0, amount_1.toTokenAmount)(chainId, "raactoken", totalUnlockedGlobal),
+        totalDebtGlobal: (0, amount_1.toTokenAmount)(chainId, "leraac", totalDebtGlobal),
+        pendingCumulatedAmount: (0, amount_1.toTokenAmount)(chainId, "raactoken", pendingCumulatedAmount),
+        accRewardPerShare: (0, amount_1.toScaled)(accRewardPerShare, amount_1.WAD_DECIMALS),
+        totalRaacInPool: (0, amount_1.toTokenAmount)(chainId, "raactoken", totalRaacInPool),
+        poolLockedUnderlying: (0, amount_1.toTokenAmount)(chainId, "raactoken", poolLockedUnderlying),
     };
 };
 exports.getGlobalInfo = getGlobalInfo;