@raac/rpc 2.0.0-beta.19 → 2.0.0-beta.20

package/dist/RPCLibrary.js

@@ -330,6 +330,7 @@ const voteGovernance_1 = require("./contracts/lockers/liquidLocker/voteGovernanc
 const getUserInfo_1 = require("./contracts/lockers/liquidLocker/getUserInfo");
 const getUserLocks_1 = require("./contracts/lockers/liquidLocker/getUserLocks");
 const getGlobalInfo_1 = require("./contracts/lockers/liquidLocker/getGlobalInfo");
+const getUnlockSchedule_1 = require("./contracts/lockers/liquidLocker/getUnlockSchedule");
 const getConfig_1 = require("./contracts/lockers/liquidLocker/getConfig");
 const isKeeper_1 = require("./contracts/lockers/liquidLocker/isKeeper");
 const hasHarvestRole_1 = require("./contracts/lockers/liquidLocker/hasHarvestRole");
@@ -676,6 +677,7 @@ class RPCLibrary {
                 getUserInfo: getUserInfo_1.getUserInfo,
                 getUserLocks: getUserLocks_1.getUserLocks,
                 getGlobalInfo: getGlobalInfo_1.getGlobalInfo,
+                getUnlockSchedule: getUnlockSchedule_1.getUnlockSchedule,
                 getConfig: getConfig_1.getConfig,
                 isKeeper: isKeeper_1.isKeeper,
                 hasHarvestRole: hasHarvestRole_1.hasHarvestRole,

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/types/RPCLibrary.d.ts

@@ -252,6 +252,7 @@ import { voteGovernance as voteGovernanceLiquidLocker } from "./contracts/locker
 import { getUserInfo as getUserInfoLiquidLocker } from "./contracts/lockers/liquidLocker/getUserInfo";
 import { getUserLocks as getUserLocksLiquidLocker } from "./contracts/lockers/liquidLocker/getUserLocks";
 import { getGlobalInfo as getGlobalInfoLiquidLocker } from "./contracts/lockers/liquidLocker/getGlobalInfo";
+import { getUnlockSchedule as getUnlockScheduleLiquidLocker } from "./contracts/lockers/liquidLocker/getUnlockSchedule";
 import { getConfig as getConfigLiquidLocker } from "./contracts/lockers/liquidLocker/getConfig";
 import { isKeeper as isKeeperLiquidLocker } from "./contracts/lockers/liquidLocker/isKeeper";
 import { hasHarvestRole as hasHarvestRoleLiquidLocker } from "./contracts/lockers/liquidLocker/hasHarvestRole";
@@ -600,6 +601,7 @@ declare class RPCLibrary {
             getUserInfo: typeof getUserInfoLiquidLocker;
             getUserLocks: typeof getUserLocksLiquidLocker;
             getGlobalInfo: typeof getGlobalInfoLiquidLocker;
+            getUnlockSchedule: typeof getUnlockScheduleLiquidLocker;
             getConfig: typeof getConfigLiquidLocker;
             isKeeper: typeof isKeeperLiquidLocker;
             hasHarvestRole: typeof hasHarvestRoleLiquidLocker;

package/dist/types/contracts/lockers/liquidLocker/getUnlockSchedule.d.ts

@@ -0,0 +1,23 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
+export interface LockerUnlockEpoch {
+    /** UNIX seconds the epoch ends and its RAAC moves from locked to withdrawable. */
+    epochEnd: number;
+    /** `epochEnd / 7 days`, the epoch number the locker and veRAAC use. */
+    epoch: number;
+    /** RAAC that unlock requests scheduled for this epoch end. */
+    amount: TokenAmount;
+    /** The end has passed but the locker has not processed it yet; the next deposit, unlock or harvest does. */
+    due: boolean;
+}
+/**
+ * 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.
+ */
+export declare const getUnlockSchedule: (chainId: ChainId, provider?: Provider) => Promise<LockerUnlockEpoch[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@raac/rpc",
-	"version": "2.0.0-beta.19",
+	"version": "2.0.0-beta.20",
 	"description": "RPC Library for RAAC",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",