@raac/rpc 2.0.0-beta.7 → 2.0.0-beta.8

package/dist/contracts/rentStreamer/getState.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getState = void 0;
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * Reads the RentStreamer's configuration and running totals.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The streamer state; see `RentStreamerState` for the unit of each field.
+ */
+const getState = async (chainId, provider) => {
+    const contract = await (0, _helpers_1.getRentStreamerContract)(chainId, provider);
+    const [token, distributor, numEpochs, minBountyFee, maxBountyFee, bountyDuration, killed, processed, released, lastEpochProcessed] = await Promise.all([
+        contract.TOKEN(),
+        contract.GAUGE_REWARD_DISTRIBUTOR(),
+        contract.numEpochs(),
+        contract.minBountyFee(),
+        contract.maxBountyFee(),
+        contract.bountyDuration(),
+        contract.killed(),
+        contract.processed(),
+        contract.released(),
+        contract.lastEpochProcessed(),
+    ]);
+    return {
+        token,
+        distributor,
+        numEpochs: Number(numEpochs),
+        minBountyFee: (0, amount_1.toScaled)(minBountyFee, amount_1.WAD_DECIMALS),
+        maxBountyFee: (0, amount_1.toScaled)(maxBountyFee, amount_1.WAD_DECIMALS),
+        bountyDuration: Number(bountyDuration),
+        killed,
+        processed: (0, amount_1.toTokenAmount)(chainId, token, processed),
+        released: (0, amount_1.toTokenAmount)(chainId, token, released),
+        lastEpochProcessed: Number(lastEpochProcessed),
+    };
+};
+exports.getState = getState;

package/dist/contracts/rentStreamer/previewRelease.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.previewRelease = void 0;
+const amount_1 = require("../../utils/amount");
+const _helpers_1 = require("./_helpers");
+/**
+ * Previews what a `release` would move right now. All zero when the current epoch was already released or the
+ * streamer is killed. The bounty grows with time since the epoch start, so the real release can differ.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The release preview, in the streamed token's base units.
+ */
+const previewRelease = async (chainId, provider) => {
+    const contract = await (0, _helpers_1.getRentStreamerContract)(chainId, provider);
+    const [token, [amountToRelease, amountToDistribute, bountyFee]] = await Promise.all([contract.TOKEN(), contract.previewRelease()]);
+    return {
+        amountToRelease: (0, amount_1.toTokenAmount)(chainId, token, amountToRelease),
+        amountToDistribute: (0, amount_1.toTokenAmount)(chainId, token, amountToDistribute),
+        bountyFee: (0, amount_1.toTokenAmount)(chainId, token, bountyFee),
+    };
+};
+exports.previewRelease = previewRelease;

package/dist/contracts/rentStreamer/release.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.release = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Releases the current epoch's buckets: pays the keeper bounty and deposits the rest into the RWA
+ * GaugeRewardsDistributor. Permissionless, once per epoch; reverts while the RWA gauge system has no active gauge.
+ *
+ * @param chainId - The chain/network to use.
+ * @param receiver - Address paid the bounty; the signer when omitted.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The transaction.
+ */
+const release = async (chainId, receiver, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getRentStreamerContract)(chainId, signer);
+    const tx = receiver ? await contract["release(address)"](receiver) : await contract["release()"]();
+    await tx.wait();
+    return tx;
+};
+exports.release = release;

package/dist/contracts/rentStreamer/sync.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sync = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Splits token sent to the streamer since the last sync over the next `numEpochs` weekly buckets. Permissionless;
+ * `release` also syncs first.
+ *
+ * @param chainId - The chain/network to use.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The transaction.
+ */
+const sync = async (chainId, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getRentStreamerContract)(chainId, signer);
+    const tx = await contract.sync();
+    await tx.wait();
+    return tx;
+};
+exports.sync = sync;

package/dist/types/RPCLibrary.d.ts

@@ -88,6 +88,11 @@ import { quoteBuy } from "./contracts/zeno/quoteBuy";
 import { ChainId } from "./configs/chains";
 import getBaseUri from "./nfts/getBaseUri";
 import claimRewardFromPool from "./contracts/feeCollector/claimRewardFromPool";
+import { getState as getStateRentStreamer } from "./contracts/rentStreamer/getState";
+import { previewRelease as previewReleaseRentStreamer } from "./contracts/rentStreamer/previewRelease";
+import { getScheduled as getScheduledRentStreamer } from "./contracts/rentStreamer/getScheduled";
+import { sync as syncRentStreamer } from "./contracts/rentStreamer/sync";
+import { release as releaseRentStreamer } from "./contracts/rentStreamer/release";
 import getRawUserDepositsInLendingPool from "./pools/lendingPool/getRawUserDepositsInLendingPool";
 import getRawUserDepositInStabilityPool from "./pools/stabilityPool/getRawUserDepositsInStabilityPool";
 import getEligibleUserDeposits from "./pools/lendingPool/getEligibleUserDeposits";
@@ -399,6 +404,13 @@ declare class RPCLibrary {
         feeCollector: {
             claimRewardFromPool: typeof claimRewardFromPool;
         };
+        rentStreamer: {
+            getState: typeof getStateRentStreamer;
+            previewRelease: typeof previewReleaseRentStreamer;
+            getScheduled: typeof getScheduledRentStreamer;
+            sync: typeof syncRentStreamer;
+            release: typeof releaseRentStreamer;
+        };
         getABI: typeof getABI;
         pmTreasury: {
             getCollateralRatio: typeof getCollateralRatio;

package/dist/types/contracts/rentStreamer/_helpers.d.ts

@@ -0,0 +1,4 @@
+import { Provider, Signer } from "ethers";
+import { ChainId } from "../../configs/chains";
+import { RentStreamer } from "../../typechain-types";
+export declare function getRentStreamerContract(chainId: ChainId, runner?: Provider | Signer): Promise<RentStreamer>;

package/dist/types/contracts/rentStreamer/getScheduled.d.ts

@@ -0,0 +1,12 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../configs/chains";
+import { TokenAmount } from "../../utils/amount";
+/**
+ * Reads the amount bucketed for one epoch. Released epochs read zero.
+ *
+ * @param chainId - The chain/network to use.
+ * @param epoch - Epoch start timestamp, a multiple of one week.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The scheduled amount in the streamed token's base units.
+ */
+export declare const getScheduled: (chainId: ChainId, epoch: bigint, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/rentStreamer/getState.d.ts

@@ -0,0 +1,33 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../configs/chains";
+import { ScaledValue, TokenAmount } from "../../utils/amount";
+export interface RentStreamerState {
+    /** Streamed token (USDC). */
+    token: string;
+    /** GaugeRewardsDistributor every release deposits into. */
+    distributor: string;
+    /** Number of weekly buckets each synced amount is split over. */
+    numEpochs: number;
+    /** Keeper bounty at the start of an epoch, 18-decimal fraction of the released amount (1.0 = 100%). */
+    minBountyFee: ScaledValue;
+    /** Keeper bounty once `bountyDuration` has passed, 18-decimal fraction of the released amount (1.0 = 100%). */
+    maxBountyFee: ScaledValue;
+    /** Seconds over which the bounty ramps from min to max after an epoch starts. */
+    bountyDuration: number;
+    /** Whether the streamer was permanently shut down. */
+    killed: boolean;
+    /** Token synced into buckets and not yet released. */
+    processed: TokenAmount;
+    /** Token released so far, bounties included. */
+    released: TokenAmount;
+    /** Start timestamp of the last released epoch. */
+    lastEpochProcessed: number;
+}
+/**
+ * Reads the RentStreamer's configuration and running totals.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The streamer state; see `RentStreamerState` for the unit of each field.
+ */
+export declare const getState: (chainId: ChainId, provider?: Provider) => Promise<RentStreamerState>;

package/dist/types/contracts/rentStreamer/previewRelease.d.ts

@@ -0,0 +1,20 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../configs/chains";
+import { TokenAmount } from "../../utils/amount";
+export interface RentStreamerReleasePreview {
+    /** Total the next release takes out of the buckets, bounty included. */
+    amountToRelease: TokenAmount;
+    /** Part deposited into the RWA GaugeRewardsDistributor. */
+    amountToDistribute: TokenAmount;
+    /** Part paid to the keeper that calls `release`. */
+    bountyFee: TokenAmount;
+}
+/**
+ * Previews what a `release` would move right now. All zero when the current epoch was already released or the
+ * streamer is killed. The bounty grows with time since the epoch start, so the real release can differ.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The release preview, in the streamed token's base units.
+ */
+export declare const previewRelease: (chainId: ChainId, provider?: Provider) => Promise<RentStreamerReleasePreview>;

package/dist/types/contracts/rentStreamer/release.d.ts

@@ -0,0 +1,12 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../configs/chains";
+/**
+ * Releases the current epoch's buckets: pays the keeper bounty and deposits the rest into the RWA
+ * GaugeRewardsDistributor. Permissionless, once per epoch; reverts while the RWA gauge system has no active gauge.
+ *
+ * @param chainId - The chain/network to use.
+ * @param receiver - Address paid the bounty; the signer when omitted.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The transaction.
+ */
+export declare const release: (chainId: ChainId, receiver: string | undefined, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;

package/dist/types/contracts/rentStreamer/sync.d.ts

@@ -0,0 +1,11 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../configs/chains";
+/**
+ * Splits token sent to the streamer since the last sync over the next `numEpochs` weekly buckets. Permissionless;
+ * `release` also syncs first.
+ *
+ * @param chainId - The chain/network to use.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The transaction.
+ */
+export declare const sync: (chainId: ChainId, signer: Signer) => Promise<import("ethers").ContractTransactionResponse>;