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

package/dist/contracts/tokens/leRAAC/getAllowance.js

@@ -1,11 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAllowance = void 0;
-const ethers_1 = require("ethers");
 const _helpers_1 = require("./_helpers");
+const amount_1 = require("../../../utils/amount");
+/**
+ * Gets the leRAAC allowance `owner` granted to `spender`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param owner - The token owner.
+ * @param spender - The approved spender.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The allowance in leRAAC base units, with the `leraac` asset decimals from the chain config.
+ */
 const getAllowance = async (chainId, owner, spender, provider) => {
     const contract = await (0, _helpers_1.getLeRAACContract)(chainId, provider);
     const allowance = await contract.allowance(owner, spender);
-    return ethers_1.ethers.formatEther(allowance);
+    return (0, amount_1.toTokenAmount)(chainId, "leraac", allowance);
 };
 exports.getAllowance = getAllowance;

package/dist/contracts/tokens/leRAAC/getBalance.js

@@ -1,11 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBalance = void 0;
-const ethers_1 = require("ethers");
 const _helpers_1 = require("./_helpers");
+const amount_1 = require("../../../utils/amount");
+/**
+ * Gets the leRAAC balance of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The balance in leRAAC base units, with the `leraac` asset decimals from the chain config.
+ */
 const getBalance = async (chainId, address, provider) => {
     const contract = await (0, _helpers_1.getLeRAACContract)(chainId, provider);
     const balance = await contract.balanceOf(address);
-    return ethers_1.ethers.formatEther(balance);
+    return (0, amount_1.toTokenAmount)(chainId, "leraac", balance);
 };
 exports.getBalance = getBalance;

package/dist/contracts/tokens/leRAAC/getMinterInfo.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMinterInfo = void 0;
 const _helpers_1 = require("./_helpers");
+const amount_1 = require("../../../utils/amount");
+/**
+ * Gets a minter's role status, mint ceiling and minted amount on leRAAC.
+ *
+ * @param chainId - The chain/network to use.
+ * @param minter - The minter address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The minter info; `ceiling` and `minted` use the `leraac` asset decimals from the chain config.
+ */
 const getMinterInfo = async (chainId, minter, provider) => {
     const contract = await (0, _helpers_1.getLeRAACContract)(chainId, provider);
     const [info, isMinter] = await Promise.all([
@@ -10,6 +19,6 @@ const getMinterInfo = async (chainId, minter, provider) => {
     ]);
     const ceiling = info.ceiling ?? info[0];
     const minted = info.minted ?? info[1];
-    return { isMinter, ceiling, minted };
+    return { isMinter, ceiling: (0, amount_1.toTokenAmount)(chainId, "leraac", ceiling), minted: (0, amount_1.toTokenAmount)(chainId, "leraac", minted) };
 };
 exports.getMinterInfo = getMinterInfo;

package/dist/contracts/tokens/leRAAC/getTotalSupply.js

@@ -1,11 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTotalSupply = void 0;
-const ethers_1 = require("ethers");
 const _helpers_1 = require("./_helpers");
+const amount_1 = require("../../../utils/amount");
+/**
+ * Gets the leRAAC total supply.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The total supply in leRAAC base units, with the `leraac` asset decimals from the chain config.
+ */
 const getTotalSupply = async (chainId, provider) => {
     const contract = await (0, _helpers_1.getLeRAACContract)(chainId, provider);
     const supply = await contract.totalSupply();
-    return ethers_1.ethers.formatEther(supply);
+    return (0, amount_1.toTokenAmount)(chainId, "leraac", supply);
 };
 exports.getTotalSupply = getTotalSupply;

package/dist/contracts/tokens/leRAAC/transfer.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transfer = void 0;
 const _helpers_1 = require("./_helpers");
+/**
+ * Transfers the caller's leRAAC to `to`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param to - The recipient.
+ * @param amount - The amount in leRAAC base units (18 decimals).
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The transfer transaction, after it is mined.
+ */
 const transfer = async (chainId, to, amount, signer) => {
     if (!signer)
         throw new Error("Signer is required");

package/dist/contracts/tokens/leRAAC/transferFrom.js

@@ -2,6 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transferFrom = void 0;
 const _helpers_1 = require("./_helpers");
+/**
+ * Transfers leRAAC from `from` to `to` using the caller's allowance.
+ *
+ * @param chainId - The chain/network to use.
+ * @param from - The token owner.
+ * @param to - The recipient.
+ * @param amount - The amount in leRAAC base units (18 decimals).
+ * @param signer - An ethers.js Signer instance (must be connected to wallet).
+ * @returns The transfer transaction, after it is mined.
+ */
 const transferFrom = async (chainId, from, to, amount, signer) => {
     if (!signer)
         throw new Error("Signer is required");

package/dist/contracts/tokens/pmUSD/getBalance.js

@@ -5,15 +5,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBalance = void 0;
 const ethers_1 = require("ethers");
-const chains_1 = require("../../../configs/chains");
+const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const amount_1 = require("../../../utils/amount");
 const BALANCE_OF_ABI = "function balanceOf(address account) view returns (uint256)";
-const getBalance = async (chainId, address) => {
-    const rpc = chains_1.configs[chainId].rpcs[0];
-    const provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+/**
+ * Gets the pmUSD balance of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The balance in pmUSD base units, with the `pmusd` asset decimals from the chain config.
+ */
+const getBalance = async (chainId, address, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
     const contractAddress = (0, getContractAddress_1.default)(chainId, "pmusd");
     const contract = new ethers_1.ethers.Contract(contractAddress, [BALANCE_OF_ABI], provider);
     const balance = await contract.balanceOf(address);
-    return ethers_1.ethers.formatEther(balance);
+    return (0, amount_1.toTokenAmount)(chainId, "pmusd", balance);
 };
 exports.getBalance = getBalance;

package/dist/contracts/tokens/pmUSD/getTotalSupply.js

@@ -7,18 +7,23 @@ exports.getTotalSupply = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const amount_1 = require("../../../utils/amount");
 const TOTAL_SUPPLY_ABI = "function totalSupply() view returns (uint256)";
 /**
+ * Gets the pmUSD total supply.
  *
- * @param {number} chainId
- * @returns {Promise<string>}
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The total supply in pmUSD base units, with the `pmusd` asset decimals from the chain config.
  */
-const getTotalSupply = async (chainId) => {
-    const rpc = chains_1.default[chainId].rpcs[0];
-    const provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+const getTotalSupply = async (chainId, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
     const contractAddress = (0, getContractAddress_1.default)(chainId, "pmusd");
     const contract = new ethers_1.ethers.Contract(contractAddress, [TOTAL_SUPPLY_ABI], provider);
     const totalSupply = await contract.totalSupply();
-    return ethers_1.ethers.formatEther(totalSupply);
+    return (0, amount_1.toTokenAmount)(chainId, "pmusd", totalSupply);
 };
 exports.getTotalSupply = getTotalSupply;

package/dist/contracts/tokens/rcrvUSD/getBalance.js

@@ -5,15 +5,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBalance = void 0;
 const ethers_1 = require("ethers");
-const chains_1 = require("../../../configs/chains");
+const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const amount_1 = require("../../../utils/amount");
 const BALANCE_OF_ABI = "function balanceOf(address account) view returns (uint256)";
-const getBalance = async (chainId, address) => {
-    const rpc = chains_1.configs[chainId].rpcs[0];
-    const provider = new ethers_1.ethers.JsonRpcProvider(rpc);
-    const contractAddress = (0, getContractAddress_1.default)(chainId, "rcrvusd");
+/**
+ * Gets the rcrvUSD balance of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The balance in rcrvUSD base units, with the `rtoken` asset decimals from the chain config.
+ */
+const getBalance = async (chainId, address, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const contractAddress = (0, getContractAddress_1.default)(chainId, "rtoken");
     const contract = new ethers_1.ethers.Contract(contractAddress, [BALANCE_OF_ABI], provider);
     const balance = await contract.balanceOf(address);
-    return ethers_1.ethers.formatEther(balance);
+    return (0, amount_1.toTokenAmount)(chainId, "rtoken", balance);
 };
 exports.getBalance = getBalance;

package/dist/contracts/tokens/rcrvUSD/getTotalSupply.js

@@ -7,17 +7,23 @@ exports.getTotalSupply = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const amount_1 = require("../../../utils/amount");
 const TOTAL_SUPPLY_ABI = "function totalSupply() view returns (uint256)";
 /**
- * @param {number} chainId
- * @returns {Promise<string>}
+ * Gets the rcrvUSD total supply.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The total supply in rcrvUSD base units, with the `rtoken` asset decimals from the chain config.
  */
-const getTotalSupply = async (chainId) => {
-    const rpc = chains_1.default[chainId].rpcs[0];
-    const provider = new ethers_1.ethers.JsonRpcProvider(rpc);
-    const contractAddress = (0, getContractAddress_1.default)(chainId, "rcrvusd");
+const getTotalSupply = async (chainId, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const contractAddress = (0, getContractAddress_1.default)(chainId, "rtoken");
     const contract = new ethers_1.ethers.Contract(contractAddress, [TOTAL_SUPPLY_ABI], provider);
     const totalSupply = await contract.totalSupply();
-    return ethers_1.ethers.formatEther(totalSupply);
+    return (0, amount_1.toTokenAmount)(chainId, "rtoken", totalSupply);
 };
 exports.getTotalSupply = getTotalSupply;

package/dist/contracts/tokens/veRAAC/_helpers.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureRAACAllowance = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const getContractAddress_1 = require("../../getContractAddress");
+const ERC20_ALLOWANCE_ABI = [
+    "function allowance(address owner, address spender) view returns (uint256)",
+    "function approve(address spender, uint256 amount) returns (bool)",
+];
+/**
+ * Approves `spender` for exactly `amount` RAAC when the signer's current allowance is below it.
+ *
+ * The allowance is read through the signer's provider, or the chain's configured RPC when the
+ * signer has none (some wrapped signers, e.g. thirdweb, do not expose one).
+ *
+ * @param chainId - The chain/network to use.
+ * @param spender - The contract that will pull the RAAC.
+ * @param amount - The required allowance, in RAAC base units.
+ * @param signer - The RAAC owner.
+ * @param label - Prefix for the log lines.
+ */
+const ensureRAACAllowance = async (chainId, spender, amount, signer, label) => {
+    const owner = await signer.getAddress();
+    const raacAddress = (0, getContractAddress_1.getContractAddress)(chainId, "raactoken");
+    const provider = signer.provider ?? new ethers_1.ethers.JsonRpcProvider(chains_1.default[chainId].rpcs[0]);
+    const allowance = await new ethers_1.ethers.Contract(raacAddress, ERC20_ALLOWANCE_ABI, provider).allowance(owner, spender);
+    if (allowance >= amount)
+        return;
+    console.log(`[${label}] Approving RAAC for veRAAC contract...`);
+    const tx = await new ethers_1.ethers.Contract(raacAddress, ERC20_ALLOWANCE_ABI, signer).approve(spender, amount);
+    await tx.wait();
+    console.log(`[${label}] Approval successful`);
+};
+exports.ensureRAACAllowance = ensureRAACAllowance;

package/dist/contracts/tokens/veRAAC/distributeRewards.js

@@ -10,7 +10,7 @@ const artifacts_1 = require("../../../utils/artifacts");
  *
  * @param chainId - The chain/network to use.
  * @param rewardTokenAddress - The token being distributed as reward.
- * @param amount - The amount of reward tokens to distribute.
+ * @param amount - The amount to distribute, in base units of the reward token (its own decimals).
  * @param epochs - Number of epochs over which to distribute the rewards.
  * @param signer - An ethers.js Signer instance (must be connected to wallet).
  * @returns Transaction receipt after the rewards are distributed.

package/dist/contracts/tokens/veRAAC/getBalance.js

@@ -8,6 +8,15 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
+/**
+ * Gets the current (decayed) veRAAC voting power of an account.
+ *
+ * @param chainId - The chain/network to use.
+ * @param address - The account to query.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The voting power in veRAAC base units, with the `veraac` asset decimals from the chain config.
+ */
 const getBalance = async (chainId, address, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
@@ -17,6 +26,6 @@ const getBalance = async (chainId, address, provider) => {
     const abi = (0, artifacts_1.getABI)("veraac");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const balance = await contract.balanceOf(address);
-    return ethers_1.ethers.formatEther(balance);
+    return (0, amount_1.toTokenAmount)(chainId, "veraac", balance);
 };
 exports.getBalance = getBalance;

package/dist/contracts/tokens/veRAAC/getBalanceAt.js

@@ -8,6 +8,7 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * Gets the historical voting power of an account at a specific block.
  *
@@ -15,7 +16,7 @@ const artifacts_1 = require("../../../utils/artifacts");
  * @param address - The address to check the balance for.
  * @param blockNumber - The block number to check the balance at.
  * @param provider - Optional ethers.js Provider instance.
- * @returns The voting power at the specified block formatted in ether units.
+ * @returns The voting power at the specified block in veRAAC base units, with the `veraac` asset decimals from the chain config.
  */
 const getBalanceAt = async (chainId, address, blockNumber, provider) => {
     if (!provider) {
@@ -26,6 +27,6 @@ const getBalanceAt = async (chainId, address, blockNumber, provider) => {
     const abi = (0, artifacts_1.getABI)("veraac");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const balance = await contract.balanceOfAt(address, blockNumber);
-    return ethers_1.ethers.formatEther(balance);
+    return (0, amount_1.toTokenAmount)(chainId, "veraac", balance);
 };
 exports.getBalanceAt = getBalanceAt;

package/dist/contracts/tokens/veRAAC/getBalanceAtTime.js

@@ -8,6 +8,7 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * Gets the voting power of an account at a specific timestamp.
  *
@@ -15,7 +16,7 @@ const artifacts_1 = require("../../../utils/artifacts");
  * @param address - The address to check the balance for.
  * @param timestamp - The timestamp to check the balance at (in seconds).
  * @param provider - Optional ethers.js Provider instance.
- * @returns The voting power at the specified timestamp formatted in ether units.
+ * @returns The voting power at the specified timestamp in veRAAC base units, with the `veraac` asset decimals from the chain config.
  */
 const getBalanceAtTime = async (chainId, address, timestamp, provider) => {
     if (!provider) {
@@ -26,6 +27,6 @@ const getBalanceAtTime = async (chainId, address, timestamp, provider) => {
     const abi = (0, artifacts_1.getABI)("veraac");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const balance = await contract.balanceOfAtTime(address, timestamp);
-    return ethers_1.ethers.formatEther(balance);
+    return (0, amount_1.toTokenAmount)(chainId, "veraac", balance);
 };
 exports.getBalanceAtTime = getBalanceAtTime;

package/dist/contracts/tokens/veRAAC/getCheckpoint.js

@@ -8,6 +8,7 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * Gets the user's voting power checkpoints (block-based).
  * Used for governance proposal snapshots.
@@ -15,7 +16,7 @@ const artifacts_1 = require("../../../utils/artifacts");
  * @param chainId - The chain/network to use.
  * @param address - The address to query.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Array of checkpoints with block number and voting power value.
+ * @returns Array of checkpoints with block number and voting power value; `value` uses the `veraac` asset decimals from the chain config.
  */
 const getCheckpoint = async (chainId, address, provider) => {
     if (!provider) {
@@ -28,7 +29,7 @@ const getCheckpoint = async (chainId, address, provider) => {
     const checkpoints = await contract.getCheckpoint(address);
     return checkpoints.map((c) => ({
         fromBlock: Number(c.fromBlock),
-        value: ethers_1.ethers.formatEther(c.value),
+        value: (0, amount_1.toTokenAmount)(chainId, "veraac", c.value),
     }));
 };
 exports.getCheckpoint = getCheckpoint;

package/dist/contracts/tokens/veRAAC/getClaimable.js

@@ -8,6 +8,7 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * Returns the claimable rewards for a specific user and reward token.
  *
@@ -16,7 +17,7 @@ const artifacts_1 = require("../../../utils/artifacts");
  * @param rewardTokenAddress - The address of the reward token.
  * @param maxDistributions - Maximum number of distributions to process.
  * @param provider - Optional ethers.js Provider instance.
- * @returns The claimable rewards formatted in ether units.
+ * @returns The claimable rewards in base units of the reward token, with decimals and symbol from the token registry (18 decimals and no symbol if the token is not listed).
  */
 const getClaimable = async (chainId, userAddress, rewardTokenAddress, maxDistributions, provider) => {
     if (!provider) {
@@ -27,6 +28,6 @@ const getClaimable = async (chainId, userAddress, rewardTokenAddress, maxDistrib
     const abi = (0, artifacts_1.getABI)("veraac");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const claimable = await contract.claimable(userAddress, rewardTokenAddress, maxDistributions);
-    return ethers_1.ethers.formatEther(claimable);
+    return (0, amount_1.toTokenAmount)(chainId, rewardTokenAddress, claimable);
 };
 exports.getClaimable = getClaimable;

package/dist/contracts/tokens/veRAAC/getClaimed.js

@@ -8,6 +8,7 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * Returns the claimed rewards for a specific user and reward token.
  *
@@ -15,7 +16,7 @@ const artifacts_1 = require("../../../utils/artifacts");
  * @param userAddress - The address of the user.
  * @param rewardTokenAddress - The address of the reward token.
  * @param provider - Optional ethers.js Provider instance.
- * @returns The claimed rewards formatted in ether units.
+ * @returns The claimed rewards in base units of the reward token, with decimals and symbol from the token registry (18 decimals and no symbol if the token is not listed).
  */
 const getClaimed = async (chainId, userAddress, rewardTokenAddress, provider) => {
     if (!provider) {
@@ -26,6 +27,6 @@ const getClaimed = async (chainId, userAddress, rewardTokenAddress, provider) =>
     const abi = (0, artifacts_1.getABI)("veraac");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const claimed = await contract.claimed(userAddress, rewardTokenAddress);
-    return ethers_1.ethers.formatEther(claimed);
+    return (0, amount_1.toTokenAmount)(chainId, rewardTokenAddress, claimed);
 };
 exports.getClaimed = getClaimed;

package/dist/contracts/tokens/veRAAC/getEarned.js

@@ -8,6 +8,7 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * Returns the earned rewards (total of claimed + claimable) for a user.
  *
@@ -16,7 +17,7 @@ const artifacts_1 = require("../../../utils/artifacts");
  * @param rewardTokenAddress - The address of the reward token.
  * @param maxDistributions - Maximum number of distributions to process.
  * @param provider - Optional ethers.js Provider instance.
- * @returns The total earned rewards formatted in ether units.
+ * @returns The total earned rewards in base units of the reward token, with decimals and symbol from the token registry (18 decimals and no symbol if the token is not listed).
  */
 const getEarned = async (chainId, userAddress, rewardTokenAddress, maxDistributions, provider) => {
     if (!provider) {
@@ -27,6 +28,6 @@ const getEarned = async (chainId, userAddress, rewardTokenAddress, maxDistributi
     const abi = (0, artifacts_1.getABI)("veraac");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const earned = await contract.earned(userAddress, rewardTokenAddress, maxDistributions);
-    return ethers_1.ethers.formatEther(earned);
+    return (0, amount_1.toTokenAmount)(chainId, rewardTokenAddress, earned);
 };
 exports.getEarned = getEarned;

package/dist/contracts/tokens/veRAAC/getGlobalLockInfo.js

@@ -8,12 +8,13 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * Gets the global lock info from the veRAAC contract.
  *
  * @param chainId - The chain/network to use.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Global lock info including totalLocked, maxLockEpochs, and epochDuration.
+ * @returns Global lock info including totalLocked (RAAC, `raactoken` asset decimals from the chain config), maxLockEpochs, and epochDuration (seconds).
  */
 const getGlobalLockInfo = async (chainId, provider) => {
     if (!provider) {
@@ -25,7 +26,7 @@ const getGlobalLockInfo = async (chainId, provider) => {
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const [totalLocked, maxLockEpochs, epochDuration] = await contract.getGlobalLockInfo();
     return {
-        totalLocked: ethers_1.ethers.formatEther(totalLocked),
+        totalLocked: (0, amount_1.toTokenAmount)(chainId, "raactoken", totalLocked),
         maxLockEpochs: Number(maxLockEpochs),
         epochDuration: Number(epochDuration),
     };

package/dist/contracts/tokens/veRAAC/getLockedBalance.js

@@ -8,13 +8,14 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * Gets the locked balance of an account in the veRAAC contract.
  *
  * @param chainId - The chain/network to use.
  * @param address - The address to check the locked balance for.
  * @param provider - Optional ethers.js Provider instance.
- * @returns The locked balance of the account formatted in ether units.
+ * @returns The RAAC locked by the account, in RAAC base units, with the `raactoken` asset decimals from the chain config.
  */
 const getLockedBalance = async (chainId, address, provider) => {
     if (!provider) {
@@ -25,6 +26,6 @@ const getLockedBalance = async (chainId, address, provider) => {
     const abi = (0, artifacts_1.getABI)("veraac");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
     const lockedBalance = await contract.lockedBalanceOf(address);
-    return ethers_1.ethers.formatEther(lockedBalance);
+    return (0, amount_1.toTokenAmount)(chainId, "raactoken", lockedBalance);
 };
 exports.getLockedBalance = getLockedBalance;

package/dist/contracts/tokens/veRAAC/getLocks.js

@@ -8,12 +8,13 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
 /**
  * @notice Gets the locks for an account
  * @param chainId - The chain/network to use.
  * @param address - The address to check locks for.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Array of active locks with amount and unlock time.
+ * @returns Array of active locks with amount (RAAC, `raactoken` asset decimals from the chain config) and unlock time.
  */
 const getLocks = async (chainId, address, provider) => {
     if (!provider) {
@@ -23,16 +24,13 @@ const getLocks = async (chainId, address, provider) => {
     const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "veraac");
     const abi = (0, artifacts_1.getABI)("veraac");
     const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
-    // The contract returns an array of { amount: bigint, unlockTime: bigint }
     const locks = await contract.getLocks(address);
     if (!locks || !Array.isArray(locks)) {
         return [];
     }
-    return locks
-        // .filter(({ amount }) => amount > 0n) // May be ? Or via filter ? 
-        .map(({ amount, unlockTime }) => ({
-        amount: ethers_1.ethers.formatEther(amount),
-        unlockTime: Number(unlockTime)
+    return locks.map(({ amount, unlockTime }) => ({
+        amount: (0, amount_1.toTokenAmount)(chainId, "raactoken", amount),
+        unlockTime: Number(unlockTime),
     }));
 };
 exports.getLocks = getLocks;

package/dist/contracts/tokens/veRAAC/getMinLockAmount.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMinLockAmount = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const getContractAddress_1 = require("../../getContractAddress");
+const artifacts_1 = require("../../../utils/artifacts");
+const amount_1 = require("../../../utils/amount");
+/**
+ * Gets the smallest RAAC lock veRAAC will accept.
+ *
+ * Consumers that schedule unlocks need this: the liquid locker refuses to leave a remainder
+ * below this threshold in a bucket, taking the whole bucket instead, so an unlock request can
+ * be rounded up by as much as this amount.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The minimum lock amount in RAAC base units, with the `raactoken` asset decimals from the chain config.
+ */
+const getMinLockAmount = async (chainId, 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, "veraac");
+    const abi = (0, artifacts_1.getABI)("veraac");
+    // Not cast to VeRAACToken: the checked-in typechain declaration predates
+    // getMinLockAmount, though the ABI this resolves carries it.
+    const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
+    const minLockAmount = await contract.getMinLockAmount();
+    return (0, amount_1.toTokenAmount)(chainId, "raactoken", minLockAmount);
+};
+exports.getMinLockAmount = getMinLockAmount;