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

package/dist/contracts/curve/common/_helpers.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurvePools = exports.CURVE_POOL_READ_ABI = void 0;
+exports.resolveCurvePool = resolveCurvePool;
+exports.getCurvePoolContract = getCurvePoolContract;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+/**
+ * Reads every Curve pool flavour shares. Coin indexes differ (uint256 vs int128) only in swap and liquidity
+ * methods, which are not here.
+ */
+exports.CURVE_POOL_READ_ABI = [
+    "function coins(uint256) view returns (address)",
+    "function balances(uint256) view returns (uint256)",
+    "function totalSupply() view returns (uint256)",
+    "function balanceOf(address) view returns (uint256)",
+    "function get_virtual_price() view returns (uint256)",
+];
+const getCurvePools = (chainId) => chains_1.default[chainId]?.curve ?? {};
+exports.getCurvePools = getCurvePools;
+/** Resolves a Curve pool by its config key (any casing) or its address. */
+function resolveCurvePool(chainId, poolAddressOrId) {
+    const pools = (0, exports.getCurvePools)(chainId);
+    const needle = poolAddressOrId.toLowerCase();
+    const entry = pools[needle] ?? Object.values(pools).find((pool) => pool.contract.toLowerCase() === needle);
+    if (!entry)
+        throw new Error(`Curve pool "${poolAddressOrId}" not configured for chain ${chainId}`);
+    return entry;
+}
+function getCurvePoolContract(chainId, poolAddressOrId, provider) {
+    if (!provider) {
+        provider = new ethers_1.ethers.JsonRpcProvider(chains_1.default[chainId].rpcs[0]);
+    }
+    const entry = resolveCurvePool(chainId, poolAddressOrId);
+    return { entry, contract: new ethers_1.ethers.Contract(entry.contract, exports.CURVE_POOL_READ_ABI, provider), provider };
+}

package/dist/contracts/curve/common/getPools.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPool = exports.getPools = void 0;
+const amount_1 = require("../../../utils/amount");
+const contracts_1 = require("../../../utils/contracts");
+const _helpers_1 = require("./_helpers");
+const toPool = (chainId, entry) => ({
+    ...entry,
+    coins: entry.coins.map((asset) => {
+        const info = (0, amount_1.getTokenInfo)(chainId, asset);
+        return {
+            asset,
+            address: (0, contracts_1.getContractAddress)(chainId, asset),
+            symbol: info?.symbol ?? asset,
+            decimals: info?.decimals ?? 18,
+        };
+    }),
+});
+/**
+ * Lists the Curve pools in the chain config.
+ *
+ * @param chainId - The chain/network to use.
+ * @returns Every configured pool with its flavour and coins in pool index order; empty when the chain has none.
+ */
+const getPools = (chainId) => Object.values((0, _helpers_1.getCurvePools)(chainId)).map((entry) => toPool(chainId, entry));
+exports.getPools = getPools;
+/**
+ * Looks up one Curve pool in the chain config. Reads the config only; no RPC call is made.
+ *
+ * @param chainId - The chain/network to use.
+ * @param poolAddressOrId - The pool's config key or its address.
+ * @returns The pool with its flavour and coins in pool index order.
+ * @throws If the pool is not configured on the chain.
+ */
+const getPool = (chainId, poolAddressOrId) => toPool(chainId, (0, _helpers_1.resolveCurvePool)(chainId, poolAddressOrId));
+exports.getPool = getPool;

package/dist/contracts/curve/common/getVirtualPrice.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVirtualPrice = void 0;
+const amount_1 = require("../../../utils/amount");
+const rpcError_1 = require("../../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
+/**
+ * Reads a Curve pool's virtual price: the value of one whole LP token in units of the pool's underlying coins,
+ * which only grows with fees. For a stableswap pool of $1 coins it is the LP token's USD price.
+ *
+ * @param chainId - The chain/network to use.
+ * @param poolAddressOrId - The pool's key in the chain config's `curve` section, or its address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns `get_virtual_price()` as an 18-decimal amount, e.g. 1.0021 underlying per LP token.
+ */
+const getVirtualPrice = async (chainId, poolAddressOrId, provider) => {
+    const { entry, contract } = (0, _helpers_1.getCurvePoolContract)(chainId, poolAddressOrId, provider);
+    try {
+        const price = await contract.get_virtual_price();
+        return (0, amount_1.toAmount)(price, amount_1.WAD_DECIMALS);
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("curve.common.getVirtualPrice", error, { chainId, address: entry.contract });
+    }
+};
+exports.getVirtualPrice = getVirtualPrice;

package/dist/contracts/curve/common/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./getPools"), exports);
+__exportStar(require("./getVirtualPrice"), exports);

package/dist/contracts/findContract.js

@@ -7,10 +7,10 @@ exports.findContract = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../configs/chains"));
 const artifacts_1 = require("../utils/artifacts");
+const contracts_1 = require("../utils/contracts");
 /** Sections scanned in order; the first match wins. */
-const FLAT_SECTIONS = ["contracts", "governance", "pools", "lockers", "zap", "psm", "nfts", "assets"];
+const FLAT_SECTIONS = ["contracts", "governance", "pools", "lockers", "zap", "psm", "nfts", "assets", "curve"];
 const abiKey = (key) => (key in artifacts_1.ABIS ? key : null);
-const isDeployed = (address) => !!address && ethers_1.ethers.isAddress(address) && address !== ethers_1.ethers.ZeroAddress;
 /** Builds every configured contract on the chain with its name and ABI key. */
 function listContracts(chainId) {
     const config = chains_1.default[chainId];
@@ -19,7 +19,7 @@ function listContracts(chainId) {
     }
     const found = [];
     const push = (entry) => {
-        if (isDeployed(entry.address))
+        if ((0, contracts_1.isDeployed)(entry.address))
             found.push({ ...entry, address: ethers_1.ethers.getAddress(entry.address) });
     };
     // gauges: { <system>: { label, gaugeType, controller, distributor, gauges: [{ id, name, contract }] } }

package/dist/contracts/getContractAddress.js

@@ -31,6 +31,7 @@ const getContractAddress = (chainId, contractName) => {
         "lockers",
         "zap",
         "psm",
+        "curve",
     ];
     let address = null;
     for (const key of lookupKeys) {

package/dist/contracts/governance/gaugeSystems/_helpers.js

@@ -7,8 +7,8 @@ exports.resolveGauge = exports.lookupGauge = exports.listGauges = exports.resolv
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const _helpers_1 = require("../_helpers");
+const contracts_1 = require("../../../utils/contracts");
 exports.GAUGE_SYSTEM_IDS = ["raacgauges", "rwagauges"];
-const isDeployed = (address) => !!address && ethers_1.ethers.isAddress(address) && address !== ethers_1.ethers.ZeroAddress;
 /**
  * Reads the `gauges` section of a chain config.
  *
@@ -51,7 +51,7 @@ const resolveSystemContract = (chainId, ref, field, name) => {
         return (0, _helpers_1.requireAddress)(ref, name);
     }
     const system = (0, exports.requireGaugeSystem)(chainId, ref);
-    if (!isDeployed(system[field])) {
+    if (!(0, contracts_1.isDeployed)(system[field])) {
         throw new Error(`Gauge system "${system.id}" has no ${name} deployed on chainId: ${chainId}`);
     }
     return ethers_1.ethers.getAddress(system[field]);

package/dist/contracts/rentStreamer/_helpers.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRentStreamerContract = getRentStreamerContract;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../configs/chains"));
+const getContractAddress_1 = require("../getContractAddress");
+const artifacts_1 = require("../../utils/artifacts");
+async function getRentStreamerContract(chainId, runner) {
+    if (!runner) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        runner = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const address = (0, getContractAddress_1.getContractAddress)(chainId, "rentstreamer");
+    const abi = (0, artifacts_1.getABI)("rentstreamer");
+    return new ethers_1.ethers.Contract(address, abi, runner);
+}

package/dist/contracts/rentStreamer/getScheduled.js

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

@@ -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/pools/lendingPool/adapters/erc20/getERC20AdapterBalance.js

@@ -9,16 +9,16 @@ const rpcError_1 = require("../../../../utils/rpcError");
  * @param chainId The chain id, used to look up the adapter token's decimals in the token registry.
  * @param adapterAddress The ERC20 asset adapter address.
  * @param userAddress The user.
- * @param signer The signer to read with.
+ * @param runner The signer or provider to read with. A read-only provider is enough.
  * @returns The deposited balance in base units of the adapter's token, with its registry decimals and symbol (18 decimals if the token is not in the registry).
  */
-async function getERC20AdapterBalance(chainId, adapterAddress, userAddress, signer) {
-    if (!signer) {
+async function getERC20AdapterBalance(chainId, adapterAddress, userAddress, runner) {
+    if (!runner) {
         throw new Error("Wallet not connected");
     }
     try {
         const abi = (0, artifacts_1.getABI)("erc20assetadapter");
-        const adapterContract = new ethers_1.ethers.Contract(adapterAddress, abi, signer);
+        const adapterContract = new ethers_1.ethers.Contract(adapterAddress, abi, runner);
         const [balance, token] = await Promise.all([
             adapterContract.balanceOf(userAddress),
             adapterContract.token(),

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";
@@ -134,11 +139,13 @@ import { cancelExit as cancelExitPsm } from "./contracts/psm/cancelExit";
 import { redeem as redeemPsm } from "./contracts/psm/redeem";
 import { swap as swapPsm } from "./contracts/psm/swap";
 import { getABI } from "./utils/artifacts";
-import { toAmount, toScaled, parseAmount, toDecimalString, serializeAmount, deserializeAmount, getAssetDecimals, getTokenInfo, toTokenAmount } from "./utils/amount";
+import { toAmount, toScaled, parseAmount, toDecimalString, toNumber, serializeAmount, deserializeAmount, getAssetDecimals, getTokenInfo, toTokenAmount } from "./utils/amount";
 import * as distributorMethods from "./contracts/governance/distributor";
 import * as gaugeMethods from "./contracts/governance/gauge";
 import * as controllerMethods from "./contracts/governance/gaugeController";
 import * as gaugeSystemMethods from "./contracts/governance/gaugeSystems";
+import * as curveCommonMethods from "./contracts/curve/common";
+import * as userMethods from "./user";
 import { cancel as cancelProposals } from "./contracts/governance/proposals/cancel";
 import { getQuorumNumerator as getQuorumNumeratorProposals } from "./contracts/governance/proposals/getQuorumNumerator";
 import { getVotingPeriod as getVotingPeriodProposals } from "./contracts/governance/proposals/getVotingPeriod";
@@ -316,6 +323,10 @@ declare class RPCLibrary {
     address: JsonRpcSigner | string;
     chainId: ChainId | bigint | null;
     privateKey: any;
+    curve: {
+        common: typeof curveCommonMethods;
+    };
+    user: typeof userMethods;
     prices: {
         getPrices: typeof getPrices;
         getTokenPriceUSD: typeof getTokenPriceUSD;
@@ -393,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;
@@ -732,6 +750,7 @@ declare class RPCLibrary {
         toScaled: typeof toScaled;
         parseAmount: typeof parseAmount;
         toDecimalString: typeof toDecimalString;
+        toNumber: typeof toNumber;
         serializeAmount: typeof serializeAmount;
         deserializeAmount: typeof deserializeAmount;
         getAssetDecimals: typeof getAssetDecimals;

package/dist/types/contracts/curve/common/_helpers.d.ts

@@ -0,0 +1,16 @@
+import { ethers, Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { CurvePoolEntry, CurvePools } from "../../../configs/chains/chain";
+/**
+ * Reads every Curve pool flavour shares. Coin indexes differ (uint256 vs int128) only in swap and liquidity
+ * methods, which are not here.
+ */
+export declare const CURVE_POOL_READ_ABI: string[];
+export declare const getCurvePools: (chainId: ChainId) => CurvePools;
+/** Resolves a Curve pool by its config key (any casing) or its address. */
+export declare function resolveCurvePool(chainId: ChainId, poolAddressOrId: string): CurvePoolEntry;
+export declare function getCurvePoolContract(chainId: ChainId, poolAddressOrId: string, provider?: Provider): {
+    entry: CurvePoolEntry;
+    contract: ethers.Contract;
+    provider: ethers.Provider;
+};

package/dist/types/contracts/curve/common/getPools.d.ts

@@ -0,0 +1,30 @@
+import { ChainId } from "../../../configs/chains";
+import { CurvePoolEntry } from "../../../configs/chains/chain";
+export interface CurvePoolCoin {
+    /** Asset key in the chain config, e.g. "pmusd". */
+    asset: string;
+    address: string;
+    /** From the token registry; the asset key when the registry has no symbol. */
+    symbol: string;
+    decimals: number;
+}
+export interface CurvePool extends Omit<CurvePoolEntry, "coins"> {
+    /** In pool index order: coins[i] is coin i on chain. */
+    coins: CurvePoolCoin[];
+}
+/**
+ * Lists the Curve pools in the chain config.
+ *
+ * @param chainId - The chain/network to use.
+ * @returns Every configured pool with its flavour and coins in pool index order; empty when the chain has none.
+ */
+export declare const getPools: (chainId: ChainId) => CurvePool[];
+/**
+ * Looks up one Curve pool in the chain config. Reads the config only; no RPC call is made.
+ *
+ * @param chainId - The chain/network to use.
+ * @param poolAddressOrId - The pool's config key or its address.
+ * @returns The pool with its flavour and coins in pool index order.
+ * @throws If the pool is not configured on the chain.
+ */
+export declare const getPool: (chainId: ChainId, poolAddressOrId: string) => CurvePool;

package/dist/types/contracts/curve/common/getVirtualPrice.d.ts

@@ -0,0 +1,13 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { TokenAmount } from "../../../utils/amount";
+/**
+ * Reads a Curve pool's virtual price: the value of one whole LP token in units of the pool's underlying coins,
+ * which only grows with fees. For a stableswap pool of $1 coins it is the LP token's USD price.
+ *
+ * @param chainId - The chain/network to use.
+ * @param poolAddressOrId - The pool's key in the chain config's `curve` section, or its address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns `get_virtual_price()` as an 18-decimal amount, e.g. 1.0021 underlying per LP token.
+ */
+export declare const getVirtualPrice: (chainId: ChainId, poolAddressOrId: string, provider?: Provider) => Promise<TokenAmount>;

package/dist/types/contracts/curve/common/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./getPools";
+export * from "./getVirtualPrice";

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>;

package/dist/types/pools/lendingPool/adapters/erc20/getERC20AdapterBalance.d.ts

@@ -1,4 +1,4 @@
-import { Signer } from "ethers";
+import { Provider, Signer } from "ethers";
 import { ChainId } from "../../../../configs/chains";
 import { TokenAmount } from "../../../../utils/amount";
 /**
@@ -6,8 +6,8 @@ import { TokenAmount } from "../../../../utils/amount";
  * @param chainId The chain id, used to look up the adapter token's decimals in the token registry.
  * @param adapterAddress The ERC20 asset adapter address.
  * @param userAddress The user.
- * @param signer The signer to read with.
+ * @param runner The signer or provider to read with. A read-only provider is enough.
  * @returns The deposited balance in base units of the adapter's token, with its registry decimals and symbol (18 decimals if the token is not in the registry).
  */
-declare function getERC20AdapterBalance(chainId: ChainId, adapterAddress: string, userAddress: string, signer: Signer): Promise<TokenAmount>;
+declare function getERC20AdapterBalance(chainId: ChainId, adapterAddress: string, userAddress: string, runner: Signer | Provider): Promise<TokenAmount>;
 export default getERC20AdapterBalance;