@raac/rpc 2.0.0-beta.12 → 2.0.0-beta.13

package/dist/contracts/rentStreamer/getEpochProjection.js

@@ -1,91 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEpochProjection = void 0;
-const ethers_1 = require("ethers");
-const chains_1 = __importDefault(require("../../configs/chains"));
-const artifacts_1 = require("../../utils/artifacts");
-const amount_1 = require("../../utils/amount");
-const _helpers_1 = require("./_helpers");
-/** FeeStreamer.WEEK: buckets and the gauge controller's epochs both start on this grid. */
-const WEEK = 7n * 24n * 3600n;
-const BOUNTY_PRECISION = 10n ** BigInt(amount_1.WAD_DECIMALS);
-/** Bucket `index` of `amount` split from a start epoch, as FeeStreamer._append does: equal splits, the remainder in the last. */
-const bucketShare = (amount, numEpochs, index) => {
-    if (index >= numEpochs)
-        return 0n;
-    const split = amount / numEpochs;
-    return index < numEpochs - 1n ? split : amount - split * (numEpochs - 1n);
-};
-/**
- * Projects what the RWA gauge system receives from the RentStreamer in the current and the next epoch, counting
- * token sent to the streamer but not yet synced as it will be split: from the current epoch when the current epoch
- * is not released yet, otherwise from the next one. Reads every value at one block.
- *
- * Assumes the current epoch is released before it ends; an unreleased bucket rolls into the next release. Rent sent
- * after this read adds to later buckets, so the next epoch's figure can still grow.
- *
- * @param chainId - The chain/network to use.
- * @param provider - Optional ethers.js Provider instance.
- * @returns Both epochs' deposited, pending and projected amounts in the streamed token's base units.
- */
-const getEpochProjection = async (chainId, provider) => {
-    if (!provider) {
-        const rpc = chains_1.default[chainId].rpcs[0];
-        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
-    }
-    const block = await provider.getBlock("latest");
-    if (!block)
-        throw new Error("Could not read the latest block");
-    const overrides = { blockTag: block.number };
-    const currentEpoch = (BigInt(block.timestamp) / WEEK) * WEEK;
-    const nextEpoch = currentEpoch + WEEK;
-    const streamer = await (0, _helpers_1.getRentStreamerContract)(chainId, provider);
-    const [token, distributorAddress, numEpochs, maxBountyFee, killed, processed, lastEpochProcessed, preview, scheduledNext] = await Promise.all([
-        streamer.TOKEN(overrides),
-        streamer.GAUGE_REWARD_DISTRIBUTOR(overrides),
-        streamer.numEpochs(overrides),
-        streamer.maxBountyFee(overrides),
-        streamer.killed(overrides),
-        streamer.processed(overrides),
-        streamer.lastEpochProcessed(overrides),
-        streamer.previewRelease(overrides),
-        streamer.scheduled(nextEpoch, overrides),
-    ]);
-    const erc20 = new ethers_1.ethers.Contract(token, ["function balanceOf(address) view returns (uint256)"], provider);
-    const distributor = new ethers_1.ethers.Contract(distributorAddress, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
-    const [balance, depositedCurrent] = await Promise.all([
-        erc20.balanceOf(await streamer.getAddress(), overrides),
-        distributor.depositedAtEpoch(token, currentEpoch, overrides),
-    ]);
-    const epochs = BigInt(numEpochs);
-    const unsynced = balance - processed;
-    const currentReleased = lastEpochProcessed >= currentEpoch;
-    // previewRelease already counts every unreleased bucket up to now plus the first split of the unsynced amount.
-    const pendingCurrent = killed ? 0n : preview[0];
-    // Unsynced token is split from the current epoch at its release, or from the next epoch once the current one is released.
-    const pendingNext = killed ? 0n : scheduledNext + bucketShare(unsynced, epochs, currentReleased ? 0n : 1n);
-    const amount = (value) => (0, amount_1.toTokenAmount)(chainId, token, value);
-    const project = (epoch, deposited, pending) => {
-        const maxBounty = (pending * maxBountyFee) / BOUNTY_PRECISION;
-        return {
-            epoch: Number(epoch),
-            deposited: amount(deposited),
-            pending: amount(pending),
-            maxBounty: amount(maxBounty),
-            projected: amount(deposited + pending - maxBounty),
-        };
-    };
-    return {
-        token,
-        numEpochs: Number(numEpochs),
-        killed,
-        currentReleased,
-        unsynced: amount(unsynced),
-        current: project(currentEpoch, depositedCurrent, pendingCurrent),
-        next: project(nextEpoch, 0n, pendingNext),
-    };
-};
-exports.getEpochProjection = getEpochProjection;

package/dist/contracts/rentStreamer/getScheduled.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getScheduled = void 0;
-const amount_1 = require("../../utils/amount");
-const _helpers_1 = require("./_helpers");
-/**
- * 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.
- */
-const getScheduled = async (chainId, epoch, provider) => {
-    const contract = await (0, _helpers_1.getRentStreamerContract)(chainId, provider);
-    const [token, amount] = await Promise.all([contract.TOKEN(), contract.scheduled(epoch)]);
-    return (0, amount_1.toTokenAmount)(chainId, token, amount);
-};
-exports.getScheduled = getScheduled;

package/dist/contracts/rentStreamer/getState.js

@@ -1,40 +0,0 @@
-"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

@@ -1,23 +0,0 @@
-"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

@@ -1,22 +0,0 @@
-"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

@@ -1,21 +0,0 @@
-"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/contracts/rentStreamer/_helpers.d.ts

@@ -1,4 +0,0 @@
-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/getEpochProjection.d.ts

@@ -1,40 +0,0 @@
-import { Provider } from "ethers";
-import { ChainId } from "../../configs/chains";
-import { TokenAmount } from "../../utils/amount";
-export interface RentStreamerEpochAmount {
-    /** Epoch start timestamp. */
-    epoch: number;
-    /** Already deposited into the RWA GaugeRewardsDistributor for this epoch, by any depositor. Always zero for the next epoch. */
-    deposited: TokenAmount;
-    /** What the streamer will release into this epoch from what it holds now, before the keeper bounty. */
-    pending: TokenAmount;
-    /** Keeper bounty on `pending` at the maximum fee. */
-    maxBounty: TokenAmount;
-    /** `deposited + pending - maxBounty`: the least this epoch receives from what is deposited or held now. */
-    projected: TokenAmount;
-}
-export interface RentStreamerEpochProjection {
-    /** Streamed token (USDC). */
-    token: string;
-    numEpochs: number;
-    killed: boolean;
-    /** Whether the current epoch's release already happened. */
-    currentReleased: boolean;
-    /** Token sent to the streamer and not yet split into buckets: balance - processed. */
-    unsynced: TokenAmount;
-    current: RentStreamerEpochAmount;
-    next: RentStreamerEpochAmount;
-}
-/**
- * Projects what the RWA gauge system receives from the RentStreamer in the current and the next epoch, counting
- * token sent to the streamer but not yet synced as it will be split: from the current epoch when the current epoch
- * is not released yet, otherwise from the next one. Reads every value at one block.
- *
- * Assumes the current epoch is released before it ends; an unreleased bucket rolls into the next release. Rent sent
- * after this read adds to later buckets, so the next epoch's figure can still grow.
- *
- * @param chainId - The chain/network to use.
- * @param provider - Optional ethers.js Provider instance.
- * @returns Both epochs' deposited, pending and projected amounts in the streamed token's base units.
- */
-export declare const getEpochProjection: (chainId: ChainId, provider?: Provider) => Promise<RentStreamerEpochProjection>;

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

@@ -1,12 +0,0 @@
-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

@@ -1,33 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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>;