@raac/rpc 2.0.0-beta.2 → 2.0.0-beta.21

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.castVote = void 0;
 const ethers_1 = require("ethers");
 const _helpers_1 = require("../_helpers");
+const rpcError_1 = require("../../../utils/rpcError");
 const artifacts_1 = require("../../../utils/artifacts");
 const amount_1 = require("../../../utils/amount");
 /**
@@ -23,8 +24,9 @@ const castVote = async (chainId, governance, proposalId, support, signer) => {
     if (!signer) {
         throw new Error("Signer is required");
     }
+    let contractAddress = governance;
     try {
-        const contractAddress = (0, _helpers_1.requireAddress)(governance, "Governance");
+        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.castVote(proposalId, support);
@@ -32,15 +34,13 @@ const castVote = async (chainId, governance, proposalId, support, signer) => {
         // Extract vote weight from events
         const event = receipt.logs.find((log) => log.fragment?.name === "VoteCast");
         const weight = event?.args?.[3];
-        console.log(`Vote cast on proposal ${proposalId}: ${support ? "FOR" : "AGAINST"} with weight ${weight ? ethers_1.ethers.formatEther(weight) : "unknown"}`);
         return {
             tx,
             weight: weight === undefined ? undefined : (0, amount_1.toTokenAmount)(chainId, "veraac", weight),
         };
     }
     catch (error) {
-        console.error("Error casting vote:", error);
-        throw (0, _helpers_1.toGovernanceTxError)("Failed to cast vote", error);
+        throw (0, rpcError_1.toRpcError)("governance.castVote", error, { chainId, address: contractAddress });
     }
 };
 exports.castVote = castVote;

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.execute = void 0;
 const ethers_1 = require("ethers");
 const _helpers_1 = require("../_helpers");
+const rpcError_1 = require("../../../utils/rpcError");
 const artifacts_1 = require("../../../utils/artifacts");
 /**
  * Executes a successful proposal through the timelock.
@@ -21,18 +22,16 @@ const execute = async (chainId, governance, proposalId, value = 0n, signer) => {
     if (!signer) {
         throw new Error("Signer is required");
     }
+    const contractAddress = (0, _helpers_1.requireAddress)(governance, "Governance");
     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.execute(proposalId, { value });
         await tx.wait();
-        console.log(`Proposal ${proposalId} executed/queued at ${contractAddress}`);
         return tx;
     }
     catch (error) {
-        console.error("Error executing proposal:", error);
-        throw (0, _helpers_1.toGovernanceTxError)("Failed to execute proposal", error);
+        throw (0, rpcError_1.toRpcError)("governance.execute", error, { chainId, address: contractAddress });
     }
 };
 exports.execute = execute;

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

@@ -47,7 +47,6 @@ const getVoteReceipt = async (chainId, governance, proposalId, account, fromBloc
         };
     }
     catch (error) {
-        console.error("Error reading VoteCast event:", error);
         return empty;
     }
 };

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

@@ -4,6 +4,7 @@ exports.propose = void 0;
 const ethers_1 = require("ethers");
 const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
+const rpcError_1 = require("../../../utils/rpcError");
 /**
  * Creates a new governance proposal.
  * Requires the caller to have at least proposalThreshold veRAAC voting power at the previous block, which becomes the proposal's snapshot block.
@@ -21,8 +22,8 @@ const propose = async (chainId, governance, targets, values, calldatas, descript
     if (!signer) {
         throw new Error("Signer is required");
     }
+    const contractAddress = (0, _helpers_1.requireAddress)(governance, "Governance");
     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.propose(targets, values, calldatas, description);
@@ -30,12 +31,10 @@ const propose = async (chainId, governance, targets, values, calldatas, descript
         // Extract proposal ID from events
         const event = receipt.logs.find((log) => log.fragment?.name === "ProposalCreated");
         const proposalId = event?.args?.[0];
-        console.log(`Proposal created with ID: ${proposalId} at ${contractAddress}`);
         return { tx, proposalId: proposalId !== undefined ? Number(proposalId) : undefined };
     }
     catch (error) {
-        console.error("Error creating proposal:", error);
-        throw new Error(`Failed to create proposal: ${error.message}`);
+        throw (0, rpcError_1.toRpcError)("governance.propose", error, { chainId, address: contractAddress });
     }
 };
 exports.propose = propose;

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

@@ -4,6 +4,7 @@ exports.setParameter = exports.GovernanceParameter = void 0;
 const ethers_1 = require("ethers");
 const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
+const rpcError_1 = require("../../../utils/rpcError");
 /**
  * Governance parameters enum matching the contract
  */
@@ -29,18 +30,16 @@ const setParameter = async (chainId, governance, param, newValue, signer) => {
     if (!signer) {
         throw new Error("Signer is required");
     }
+    const contractAddress = (0, _helpers_1.requireAddress)(governance, "Governance");
     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}`);
+        throw (0, rpcError_1.toRpcError)("governance.setParameter", error, { chainId, address: contractAddress });
     }
 };
 exports.setParameter = setParameter;

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

@@ -4,6 +4,7 @@ exports.setTimelock = void 0;
 const ethers_1 = require("ethers");
 const _helpers_1 = require("../_helpers");
 const artifacts_1 = require("../../../utils/artifacts");
+const rpcError_1 = require("../../../utils/rpcError");
 /**
  * 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.
@@ -19,18 +20,16 @@ const setTimelock = async (chainId, governance, newTimelock, signer) => {
     if (!signer) {
         throw new Error("Signer is required");
     }
+    const contractAddress = (0, _helpers_1.requireAddress)(governance, "Governance");
     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}`);
+        throw (0, rpcError_1.toRpcError)("governance.setTimelock", error, { chainId, address: contractAddress });
     }
 };
 exports.setTimelock = setTimelock;

package/dist/contracts/housePrices/getLatestPrice.js

@@ -5,6 +5,7 @@ const _helpers_1 = require("../../nfts/_helpers");
 const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
 const amount_1 = require("../../utils/amount");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * 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.
@@ -14,16 +15,15 @@ const amount_1 = require("../../utils/amount");
  * @returns The crvUSD price and the timestamp of its last update.
  */
 async function getLatestPrice(chainId, tokenId, provider) {
+    const raacHousePricesAddress = (0, contracts_1.getContractAddress)(chainId, "raachouseprices");
     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: (0, amount_1.toTokenAmount)(chainId, (0, _helpers_1.getNftAssetId)(chainId), price), timestamp };
     }
     catch (error) {
-        console.error("Error getting latest price:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("housePrices.getLatestPrice", error, { chainId, address: raacHousePricesAddress });
     }
 }
 exports.default = getLatestPrice;

package/dist/contracts/housePrices/getState.js

@@ -0,0 +1,41 @@
+"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 rpcError_1 = require("../../utils/rpcError");
+/**
+ * Reads who administers RAACHousePrices, who may set prices, and its syncers.
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ */
+async function getState(chainId, provider) {
+    const address = (0, contracts_1.getContractAddress)(chainId, "raachouseprices");
+    try {
+        const hp = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("raachouseprices"), provider);
+        const [owner, oracle, crvUSDToUSDOracle, count, lastUpdateTimestamp, maxSyncers] = await Promise.all([
+            hp.owner(),
+            hp.oracle(),
+            hp.crvUSDToUSDOracle(),
+            hp.count(),
+            hp.lastUpdateTimestamp(),
+            hp.MAX_SYNCERS(),
+        ]);
+        const syncers = [];
+        for (let i = 0; i < Number(maxSyncers); i++) {
+            try {
+                syncers.push(ethers_1.ethers.getAddress(await hp.syncers(i)));
+            }
+            catch (error) {
+                if (ethers_1.ethers.isError(error, "CALL_EXCEPTION"))
+                    break;
+                throw error;
+            }
+        }
+        return { owner, oracle, crvUSDToUSDOracle, count: Number(count), lastUpdateTimestamp: Number(lastUpdateTimestamp), syncers, maxSyncers: Number(maxSyncers) };
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("housePrices.getState", error, { chainId, address });
+    }
+}
+exports.default = getState;

package/dist/contracts/housePrices/setOracle.js

@@ -3,22 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
+const rpcError_1 = require("../../utils/rpcError");
 async function setOracle(chainId, newOracleAddress, signer) {
     if (!signer) {
         throw new Error("Wallet not connected");
     }
+    const raacHousePricesAddress = (0, contracts_1.getContractAddress)(chainId, "raachouseprices");
     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, signer);
         const tx = await raacHousePricesContract.setOracle(newOracleAddress);
         await tx.wait();
-        console.log(`Oracle address updated to: ${newOracleAddress}`);
         return tx;
     }
     catch (error) {
-        console.error("Error setting oracle:", error);
-        throw new Error(`Failed to set oracle: ${error.message}`);
+        throw (0, rpcError_1.toRpcError)("housePrices.setOracle", error, { chainId, address: raacHousePricesAddress });
     }
 }
 exports.default = setOracle;

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addRewardTokens = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Register reward tokens that can be distributed to lockers. MANAGER_ROLE only.
+ * Reverts if any token is the zero address or already registered.
+ *
+ * @param chainId - The chain/network to use.
+ * @param tokens - ERC20 addresses to register.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const addRewardTokens = async (chainId, tokens, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.addRewardTokens(tokens);
+    await tx.wait();
+    return tx;
+};
+exports.addRewardTokens = addRewardTokens;

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.distributeRewardToken = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Distribute `amount` of a registered reward token across all currently locked NFTs. DISTRIBUTOR_ROLE only.
+ * The signer's tokens are pulled via transferFrom, so approve the locker for `amount` first.
+ * Reverts when nothing is locked.
+ *
+ * @param chainId - The chain/network to use.
+ * @param token - Address of a registered reward token.
+ * @param amount - Amount to distribute, in `token` base units.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const distributeRewardToken = async (chainId, token, amount, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.distributeRewardToken(token, amount);
+    await tx.wait();
+    return tx;
+};
+exports.distributeRewardToken = distributeRewardToken;

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Read the locker's configuration in a single call batch.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The NFT collection, lock timing constants, reward tokens and pause state.
+ */
+const getConfig = async (chainId, provider) => {
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
+    const [nft, epochDuration, lockDurationEpochs, rewardTokens, paused] = await Promise.all([
+        contract.nft(),
+        contract.EPOCH_DURATION(),
+        contract.LOCK_DURATION_IN_EPOCH(),
+        contract.getRewardTokens(),
+        contract.paused(),
+    ]);
+    return {
+        nft,
+        epochDuration: Number(epochDuration),
+        lockDurationEpochs: Number(lockDurationEpochs),
+        rewardTokens: Array.from(rewardTokens),
+        paused,
+    };
+};
+exports.getConfig = getConfig;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLocksByOwner = exports.getLocks = void 0;
+exports.getLocksByOwner = exports.getLock = exports.getLocks = void 0;
+const ethers_1 = require("ethers");
 const _helpers_1 = require("./_helpers");
 const normalize = (l) => ({
     owner: l.owner ?? l[0],
@@ -16,6 +17,15 @@ const getLocks = async (chainId, provider) => {
     return results.map(normalize);
 };
 exports.getLocks = getLocks;
+/**
+ * Returns the lock of a single NFT, or null when it is not locked.
+ */
+const getLock = async (chainId, tokenId, provider) => {
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
+    const lock = normalize(await contract.locks(tokenId));
+    return lock.owner === ethers_1.ZeroAddress ? null : lock;
+};
+exports.getLock = getLock;
 /**
  * Returns every active NFT lock owned by `owner`.
  */

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRoles = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Gets the access-control role identifiers used by the bot locker.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The bytes32 role identifiers.
+ */
+const getRoles = async (chainId, provider) => {
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
+    const [defaultAdminRole, pauserRole, managerRole, distributorRole] = await Promise.all([
+        contract.DEFAULT_ADMIN_ROLE(),
+        contract.PAUSER_ROLE(),
+        contract.MANAGER_ROLE(),
+        contract.DISTRIBUTOR_ROLE(),
+    ]);
+    return { defaultAdminRole, pauserRole, managerRole, distributorRole };
+};
+exports.getRoles = getRoles;

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUnlockWindow = exports.BOT_LOCKER_LOCK_DURATION_EPOCHS = exports.BOT_LOCKER_EPOCH_DURATION = void 0;
+/** EPOCH_DURATION on RAACBotLocker, seconds. */
+exports.BOT_LOCKER_EPOCH_DURATION = 7 * 24 * 60 * 60;
+/** LOCK_DURATION_IN_EPOCH on RAACBotLocker. */
+exports.BOT_LOCKER_LOCK_DURATION_EPOCHS = 4;
+/**
+ * Unlock window of a locked NFT, computed locally without an RPC call.
+ *
+ * The contract allows `unlockAndClaim` when `floor((now - lockedAt) / epochDuration)` is a non-zero multiple of `lockDurationEpochs`, so windows are `[lockedAt + k * cycle, lockedAt + k * cycle + epochDuration)` for `k >= 1`, where `cycle = lockDurationEpochs * epochDuration`. They are relative to each NFT's own `lockedAt`, not to a global epoch, and a missed window reopens one cycle later.
+ *
+ * @param lockedAt - Lock timestamp of the NFT, unix seconds (`locks(tokenId).lockedAt`, or `lockedAt` from the subgraph).
+ * @param now - Current time, unix seconds. Use the latest block timestamp to match the contract exactly.
+ * @param epochDuration - Epoch length, seconds. Defaults to the contract constant.
+ * @param lockDurationEpochs - Epochs per lock cycle. Defaults to the contract constant.
+ * @returns Whether the NFT can unlock now and the bounds of the current or next window.
+ */
+const getUnlockWindow = (lockedAt, now, epochDuration = exports.BOT_LOCKER_EPOCH_DURATION, lockDurationEpochs = exports.BOT_LOCKER_LOCK_DURATION_EPOCHS) => {
+    const epochs = Math.floor((now - lockedAt) / epochDuration);
+    if (epochs > 0 && epochs % lockDurationEpochs === 0) {
+        const opensAt = lockedAt + epochs * epochDuration;
+        return { unlockable: true, opensAt, closesAt: opensAt + epochDuration };
+    }
+    const cycle = Math.floor(Math.max(epochs, 0) / lockDurationEpochs) + 1;
+    const opensAt = lockedAt + cycle * lockDurationEpochs * epochDuration;
+    return { unlockable: false, opensAt, closesAt: opensAt + epochDuration };
+};
+exports.getUnlockWindow = getUnlockWindow;

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revokeRole = exports.grantRole = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Grant a bot locker role. DEFAULT_ADMIN_ROLE only.
+ *
+ * @param chainId - The chain/network to use.
+ * @param role - The bytes32 role identifier (see `getRoles`).
+ * @param account - The address to grant the role to.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const grantRole = async (chainId, role, account, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.grantRole(role, account);
+    await tx.wait();
+    return tx;
+};
+exports.grantRole = grantRole;
+/**
+ * Revoke a bot locker role. DEFAULT_ADMIN_ROLE only.
+ *
+ * @param chainId - The chain/network to use.
+ * @param role - The bytes32 role identifier (see `getRoles`).
+ * @param account - The address to revoke the role from.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const revokeRole = async (chainId, role, account, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.revokeRole(role, account);
+    await tx.wait();
+    return tx;
+};
+exports.revokeRole = revokeRole;

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasRole = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Checks whether an account holds a bot locker role.
+ *
+ * @param chainId - The chain/network to use.
+ * @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, role, account, provider) => {
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
+    return contract.hasRole(role, account);
+};
+exports.hasRole = hasRole;

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unpause = exports.pause = void 0;
+const _helpers_1 = require("./_helpers");
+/** Pause lock, unlockAndClaim and claim. PAUSER_ROLE only. */
+const pause = async (chainId, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.pause();
+    await tx.wait();
+    return tx;
+};
+exports.pause = pause;
+/** PAUSER_ROLE only. */
+const unpause = async (chainId, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.unpause();
+    await tx.wait();
+    return tx;
+};
+exports.unpause = unpause;

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rescueTokens = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Send the locker's entire balance of `token` to `recipient`. DEFAULT_ADMIN_ROLE only.
+ * This includes rewards lockers have not claimed yet, so later claims of that token revert until it is refilled.
+ *
+ * @param chainId - The chain/network to use.
+ * @param token - ERC20 address to rescue.
+ * @param recipient - Address receiving the balance.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const rescueTokens = async (chainId, token, recipient, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.rescueTokens(token, recipient);
+    await tx.wait();
+    return tx;
+};
+exports.rescueTokens = rescueTokens;

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

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deposit = void 0;
 const _helpers_1 = require("./_helpers");
+const getContractAddress_1 = require("../../getContractAddress");
+const rpcError_1 = require("../../../utils/rpcError");
 /**
  * Deposit RAAC into the liquid locker; locks underlying RAAC into veRAAC for the locker.
  * Caller must have approved the locker to spend RAAC beforehand.
@@ -13,9 +15,15 @@ const _helpers_1 = require("./_helpers");
 const deposit = 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.deposit(amount);
-    await tx.wait();
-    return tx;
+    const contractAddress = (0, getContractAddress_1.getContractAddress)(chainId, "raacliquidlocker");
+    try {
+        const contract = await (0, _helpers_1.getLiquidLockerContract)(chainId, signer);
+        const tx = await contract.deposit(amount);
+        await tx.wait();
+        return tx;
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("liquidLocker.deposit", error, { chainId, address: contractAddress });
+    }
 };
 exports.deposit = deposit;

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUnlockSchedule = void 0;
+const ethers_1 = require("ethers");
+const amount_1 = require("../../../utils/amount");
+const rpcError_1 = require("../../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
+/** The locker's epochs are veRAAC's: 7 days, numbered from the UNIX epoch. */
+const EPOCH_SECONDS = 7 * 86_400;
+/** At most one entry per epoch a lock can end in; a list longer than this is read no further. */
+const MAX_ENTRIES = 104;
+const BATCH = 16;
+/**
+ * The RAAC scheduled to unlock from the liquid locker, by epoch: every entry of `epochEnds` from `processedEpochIndexes`
+ * on, with its `epochEndToLockAmount`. Processed epochs are left out (their RAAC is already withdrawable); an entry
+ * whose end has passed but is not processed yet is marked `due`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns Pending epochs in the order the locker schedules them, soonest first.
+ */
+const getUnlockSchedule = async (chainId, provider) => {
+    const contract = await (0, _helpers_1.getLiquidLockerContract)(chainId, provider);
+    try {
+        const runner = contract.runner?.provider ?? provider;
+        const [start, block] = await Promise.all([contract.processedEpochIndexes(), runner?.getBlock("latest")]);
+        const now = block ? Number(block.timestamp) : Math.floor(Date.now() / 1000);
+        const out = [];
+        // The array has no length getter: read it in parallel batches until an index past its end reverts.
+        const endAt = async (i) => {
+            try {
+                return await contract.epochEnds(i);
+            }
+            catch (error) {
+                // Reading past the end of the array reverts; anything else is a real failure.
+                if (ethers_1.ethers.isError(error, "CALL_EXCEPTION"))
+                    return null;
+                throw error;
+            }
+        };
+        for (let i = Number(start); i < Number(start) + MAX_ENTRIES; i += BATCH) {
+            const ends = await Promise.all(Array.from({ length: BATCH }, (_, k) => endAt(i + k)));
+            const found = ends.slice(0, ends.indexOf(null) < 0 ? BATCH : ends.indexOf(null));
+            const amounts = await Promise.all(found.map((end) => contract.epochEndToLockAmount(end)));
+            found.forEach((end, k) => {
+                if (amounts[k] === BigInt(0))
+                    return;
+                const epochEnd = Number(end);
+                out.push({ epochEnd, epoch: Math.floor(epochEnd / EPOCH_SECONDS), amount: (0, amount_1.toTokenAmount)(chainId, "raactoken", amounts[k]), due: epochEnd <= now });
+            });
+            if (found.length < BATCH)
+                break;
+        }
+        return out.sort((a, b) => a.epochEnd - b.epochEnd);
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("lockers.liquidLocker.getUnlockSchedule", error, { chainId, address: await contract.getAddress() });
+    }
+};
+exports.getUnlockSchedule = getUnlockSchedule;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasHarvestRole = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Checks whether `account` holds `HARVEST_ROLE` on the liquid locker - distinct
+ * from `isKeeper`, since `harvest()` is gated by `onlyRole(HARVEST_ROLE)`, not
+ * `onlyKeeper`.
+ */
+const hasHarvestRole = async (chainId, account, provider) => {
+    const contract = await (0, _helpers_1.getLiquidLockerContract)(chainId, provider);
+    const role = await contract.HARVEST_ROLE();
+    return contract.hasRole(role, account);
+};
+exports.hasHarvestRole = hasHarvestRole;