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

package/dist/RPCLibrary.js

@@ -133,6 +133,17 @@ const getAuctions_1 = __importDefault(require("./contracts/zeno/getAuctions"));
 const createAuction_1 = __importDefault(require("./contracts/zeno/createAuction"));
 const createZeno_1 = __importDefault(require("./contracts/zeno/createZeno"));
 const getZenos_1 = __importDefault(require("./contracts/zeno/getZenos"));
+const getAuctionState_1 = __importDefault(require("./contracts/zeno/getAuctionState"));
+const getBondState_1 = __importDefault(require("./contracts/zeno/getBondState"));
+const getPrice_1 = __importDefault(require("./contracts/zeno/getPrice"));
+const buy_1 = __importDefault(require("./contracts/zeno/buy"));
+const redeem_1 = require("./contracts/zeno/redeem");
+const setAuction_1 = __importDefault(require("./contracts/zeno/setAuction"));
+const sweepSurplus_1 = __importDefault(require("./contracts/zeno/sweepSurplus"));
+const pause_2 = require("./contracts/zeno/pause");
+const grantRole_1 = require("./contracts/zeno/grantRole");
+const priceAt_1 = require("./contracts/zeno/priceAt");
+const quoteBuy_1 = require("./contracts/zeno/quoteBuy");
 const getBaseUri_1 = __importDefault(require("./nfts/getBaseUri"));
 const claimRewardFromPool_1 = __importDefault(require("./contracts/feeCollector/claimRewardFromPool"));
 const getRawUserDepositsInLendingPool_1 = __importDefault(require("./pools/lendingPool/getRawUserDepositsInLendingPool"));
@@ -179,7 +190,7 @@ const previewProportionalSplit_1 = require("./contracts/psm/previewProportionalS
 const deposit_1 = require("./contracts/psm/deposit");
 const requestExit_1 = require("./contracts/psm/requestExit");
 const cancelExit_1 = require("./contracts/psm/cancelExit");
-const redeem_1 = require("./contracts/psm/redeem");
+const redeem_2 = require("./contracts/psm/redeem");
 const swap_1 = require("./contracts/psm/swap");
 const artifacts_1 = require("./utils/artifacts");
 const rpcError_1 = require("./utils/rpcError");
@@ -193,6 +204,10 @@ const distributorMethods = __importStar(require("./contracts/governance/distribu
 const gaugeMethods = __importStar(require("./contracts/governance/gauge"));
 const controllerMethods = __importStar(require("./contracts/governance/gaugeController"));
 const gaugeSystemMethods = __importStar(require("./contracts/governance/gaugeSystems"));
+// ===== Curve =====
+const curveCommonMethods = __importStar(require("./contracts/curve/common"));
+// ===== User aggregates (dashboard) =====
+const userMethods = __importStar(require("./user"));
 // Proposals
 const cancel_1 = require("./contracts/governance/proposals/cancel");
 const getQuorumNumerator_1 = require("./contracts/governance/proposals/getQuorumNumerator");
@@ -328,10 +343,10 @@ const getConfig_3 = require("./contracts/lockers/botLocker/getConfig");
 const getUnlockWindow_1 = require("./contracts/lockers/botLocker/getUnlockWindow");
 const getRoles_3 = require("./contracts/lockers/botLocker/getRoles");
 const hasRole_3 = require("./contracts/lockers/botLocker/hasRole");
-const grantRole_1 = require("./contracts/lockers/botLocker/grantRole");
+const grantRole_2 = require("./contracts/lockers/botLocker/grantRole");
 const addRewardTokens_1 = require("./contracts/lockers/botLocker/addRewardTokens");
 const distributeRewardToken_1 = require("./contracts/lockers/botLocker/distributeRewardToken");
-const pause_2 = require("./contracts/lockers/botLocker/pause");
+const pause_3 = require("./contracts/lockers/botLocker/pause");
 const rescueTokens_1 = require("./contracts/lockers/botLocker/rescueTokens");
 // leRAAC token
 const getBalance_8 = require("./contracts/tokens/leRAAC/getBalance");
@@ -389,6 +404,10 @@ class RPCLibrary {
     chainId;
     privateKey;
     // prices
+    // Curve pools from the chain config's `curve` section
+    curve;
+    // Aggregate reads of one user's position and claimables, composed from the methods above
+    user;
     prices;
     // valid
     assets;
@@ -644,12 +663,12 @@ class RPCLibrary {
                 getUnlockWindow: getUnlockWindow_1.getUnlockWindow,
                 getRoles: getRoles_3.getRoles,
                 hasRole: hasRole_3.hasRole,
-                grantRole: grantRole_1.grantRole,
-                revokeRole: grantRole_1.revokeRole,
+                grantRole: grantRole_2.grantRole,
+                revokeRole: grantRole_2.revokeRole,
                 addRewardTokens: addRewardTokens_1.addRewardTokens,
                 distributeRewardToken: distributeRewardToken_1.distributeRewardToken,
-                pause: pause_2.pause,
-                unpause: pause_2.unpause,
+                pause: pause_3.pause,
+                unpause: pause_3.unpause,
                 rescueTokens: rescueTokens_1.rescueTokens,
             },
         };
@@ -732,7 +751,7 @@ class RPCLibrary {
             deposit: deposit_1.deposit,
             requestExit: requestExit_1.requestExit,
             cancelExit: cancelExit_1.cancelExit,
-            redeem: redeem_1.redeem,
+            redeem: redeem_2.redeem,
             swap: swap_1.swap,
         };
         this.pools = {
@@ -820,7 +839,25 @@ class RPCLibrary {
             getAuctions: getAuctions_1.default,
             createZeno: createZeno_1.default,
             getZenos: getZenos_1.default,
+            getAuctionState: getAuctionState_1.default,
+            getBondState: getBondState_1.default,
+            getPrice: getPrice_1.default,
+            buy: buy_1.default,
+            redeem: redeem_1.redeem,
+            redeemAll: redeem_1.redeemAll,
+            setAuction: setAuction_1.default,
+            sweepSurplus: sweepSurplus_1.default,
+            pause: pause_2.pause,
+            unpause: pause_2.unpause,
+            grantRole: grantRole_1.grantRole,
+            revokeRole: grantRole_1.revokeRole,
+            priceAt: priceAt_1.priceAt,
+            quoteBuy: quoteBuy_1.quoteBuy,
+        };
+        this.curve = {
+            common: curveCommonMethods,
         };
+        this.user = userMethods;
         this.prices = {
             getPrices: getPrices_1.getPrices,
             getTokenPriceUSD: tokenPricesUSD_1.getTokenPriceUSD,
@@ -834,6 +871,7 @@ class RPCLibrary {
             toScaled: amount_1.toScaled,
             parseAmount: amount_1.parseAmount,
             toDecimalString: amount_1.toDecimalString,
+            toNumber: amount_1.toNumber,
             serializeAmount: amount_1.serializeAmount,
             deserializeAmount: amount_1.deserializeAmount,
             getAssetDecimals: amount_1.getAssetDecimals,

package/dist/configs/chains/11155111.json

@@ -22,12 +22,12 @@
         "auctionfactory": {
             "id": "auctionfactory",
             "name": "Auction Factory",
-            "contract": "0xC644A84734A7329eE46d3B6704746179d272f990"
+            "contract": "0xeb4b30b853BCf687c91C3a20f3ad0816EEf002BD"
         },
         "zenofactory": {
             "id": "zenofactory",
             "name": "Zeno Factory",
-            "contract": "0xa9eE59A113bCB4B2CC10f802D1efF0Bae1Ab91D2"
+            "contract": "0x55F6F6801Bda0AD55753B4B89a525F1E36fC8333"
         },
         "raacminter": {
             "id": "raacminter",
@@ -179,6 +179,36 @@
             "contract": "0x7F7d0924C9082F4C3F0D5D97bF9a26C3D3DEf706"
         }
     },
+    "curve": {
+        "raac-pmusd": {
+            "id": "raac-pmusd",
+            "name": "RAAC / pmUSD",
+            "contract": "0xF65C691aE1782A9A504d6865F0dAeC88Ef46a592",
+            "flavour": "twocrypto",
+            "coins": ["pmusd", "raactoken"]
+        },
+        "ireet-pmusd": {
+            "id": "ireet-pmusd",
+            "name": "iREET / pmUSD",
+            "contract": "0x7F7d0924C9082F4C3F0D5D97bF9a26C3D3DEf706",
+            "flavour": "twocrypto",
+            "coins": ["pmusd", "rwaindextoken"]
+        },
+        "rpmusd-depmusd": {
+            "id": "rpmusd-depmusd",
+            "name": "RpmUSD / DEpmUSD",
+            "contract": "0x421E9431E751c8fC02E53F8e54a1772aE6021BeD",
+            "flavour": "stableswap",
+            "coins": ["rtoken", "detoken"]
+        },
+        "leraac-raac-pmusd": {
+            "id": "leraac-raac-pmusd",
+            "name": "leRAAC / RAAC / pmUSD",
+            "contract": "0x1D0805Bd3EF5338b66158770c28fD6f4Cd685F28",
+            "flavour": "tricrypto",
+            "coins": ["pmusd", "raactoken", "leraac"]
+        }
+    },
     "nfts": {
         "raacnft": {
             "id": "raacnft",

package/dist/configs/chains/8453.json

@@ -22,12 +22,12 @@
         "auctionfactory": {
             "id": "auctionfactory",
             "name": "Auction Factory",
-            "contract": "0xC644A84734A7329eE46d3B6704746179d272f990"
+            "contract": "0x98eDDadCfde04dC22a0e62119617e74a6Bc77313"
         },
         "zenofactory": {
             "id": "zenofactory",
             "name": "Zeno Factory",
-            "contract": "0xa9eE59A113bCB4B2CC10f802D1efF0Bae1Ab91D2"
+            "contract": "0x95bD8D42f30351685e96C62EDdc0d0613bf9a87A"
         },
         "raacminter": {
             "id": "raacminter",
@@ -299,6 +299,27 @@
             "symbol": "leRAAC",
             "decimals": 18,
             "contract": "0xa513E6E4b8f2a923D98304ec87F64353C4D5C853"
+        },
+        "zenocrvusd": {
+            "id": "zenocrvusd",
+            "name": "crvUSD (bond seed mock)",
+            "symbol": "crvUSD",
+            "decimals": 18,
+            "contract": "0x2B574555158337Cd46d47c2Ca57E4698A1f04e70"
+        },
+        "zenousdc": {
+            "id": "zenousdc",
+            "name": "USDC (bond seed mock)",
+            "symbol": "USDC",
+            "decimals": 6,
+            "contract": "0xcA8b49076D1A8039599e24979abf819af784c27a"
+        },
+        "zenousdt": {
+            "id": "zenousdt",
+            "name": "USDT (bond seed mock)",
+            "symbol": "USDT",
+            "decimals": 6,
+            "contract": "0xc039b3B46814D8388e5205D37Dd0D154D806F1f4"
         }
     },
     "lockers": {

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/zeno/_helpers.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERC20_ABI = void 0;
+exports.getZenoContract = getZenoContract;
+exports.getAuctionContract = getAuctionContract;
+exports.toZenoAmount = toZenoAmount;
+exports.addressOrNull = addressOrNull;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../configs/chains"));
+const artifacts_1 = require("../../utils/artifacts");
+const amount_1 = require("../../utils/amount");
+/** The one ERC20 call the zeno methods make: the underlying held by a ZENO. */
+exports.ERC20_ABI = ["function balanceOf(address) view returns (uint256)"];
+/** A ZENO bond. Bonds are created by the factory, so the address is passed in rather than read from the config. */
+function getZenoContract(chainId, zeno, runner) {
+    if (!runner) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        runner = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    return new ethers_1.ethers.Contract(zeno, (0, artifacts_1.getABI)("zeno"), runner);
+}
+/** A ZENO auction. Auctions are created by the factory, so the address is passed in rather than read from the config. */
+function getAuctionContract(chainId, auction, runner) {
+    if (!runner) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        runner = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    return new ethers_1.ethers.Contract(auction, (0, artifacts_1.getABI)("auction"), runner);
+}
+/**
+ * A ZENO amount. ZENO takes its decimals from its underlying, so they come from the underlying's registry entry; a
+ * ZENO address itself is never in the registry. Falls back to 18 decimals when the underlying is not listed.
+ */
+function toZenoAmount(chainId, underlying, value, symbol) {
+    return (0, amount_1.toAmount)(value, (0, amount_1.getTokenInfo)(chainId, underlying)?.decimals ?? amount_1.WAD_DECIMALS, symbol);
+}
+/** `ZENO.auction()` and other unset address fields read as the zero address; this maps that to null. */
+function addressOrNull(address) {
+    return address === ethers_1.ethers.ZeroAddress ? null : address;
+}

package/dist/contracts/zeno/buy.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rpcError_1 = require("../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
+/**
+ * Buys ZENO: spends exactly `paymentAmount` of the payment token, sent to the issuer, at the price of the block it is
+ * mined in. Needs a payment token allowance for the auction (`wallet.assets.approveAsset`). Reverts while paused,
+ * outside the auction window, when the ZENO out would exceed what is left, or when it is below `minZenoOut`.
+ * @param chainId The chain id.
+ * @param auction The auction address.
+ * @param paymentAmount Payment token to spend, in base units.
+ * @param minZenoOut The least ZENO to accept, in ZENO base units; `quoteBuy` sizes it.
+ * @param signer The buyer, who receives the ZENO.
+ * @returns The transaction receipt; its `ZENOPurchased` log carries the ZENO minted and the price paid.
+ */
+async function buy(chainId, auction, paymentAmount, minZenoOut, signer) {
+    if (!signer)
+        throw new Error("Signer is required");
+    try {
+        const tx = await (0, _helpers_1.getAuctionContract)(chainId, auction, signer).buy(paymentAmount, minZenoOut);
+        return await tx.wait();
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("zeno.buy", error, { chainId, address: auction });
+    }
+}
+exports.default = buy;

package/dist/contracts/zeno/getAuctionState.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const amount_1 = require("../../utils/amount");
+const rpcError_1 = require("../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
+/**
+ * Reads one auction's terms and live state.
+ * @param chainId The chain id.
+ * @param auction The auction address.
+ * @param provider The provider to read with. Defaults to the chain's first configured RPC.
+ * @returns The auction's state.
+ */
+async function getAuctionState(chainId, auction, provider) {
+    try {
+        const contract = (0, _helpers_1.getAuctionContract)(chainId, auction, provider);
+        const [details, paymentToken, paused, ended] = await Promise.all([
+            contract.getDetails(),
+            contract.token(),
+            contract.paused(),
+            contract.checkAuctionEnded(),
+        ]);
+        const underlying = await (0, _helpers_1.getZenoContract)(chainId, details.zenoAddress, contract.runner).underlyingAsset();
+        return {
+            auction: details.auctionAddress,
+            zeno: details.zenoAddress,
+            paymentToken,
+            issuer: details.issuer,
+            fundingMode: Number(details.fundingMode),
+            startTime: details.auctionStartTime,
+            endTime: details.auctionEndTime,
+            startingPrice: (0, amount_1.toTokenAmount)(chainId, paymentToken, details.startingPrice),
+            reservePrice: (0, amount_1.toTokenAmount)(chainId, paymentToken, details.reservePrice),
+            isFixedPrice: details.startingPrice === details.reservePrice,
+            price: (0, amount_1.toTokenAmount)(chainId, paymentToken, details.price),
+            totalAllocated: (0, _helpers_1.toZenoAmount)(chainId, underlying, details.totalZENOAllocated),
+            totalRemaining: (0, _helpers_1.toZenoAmount)(chainId, underlying, details.totalZENORemaining),
+            paused,
+            ended,
+        };
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("zeno.getAuctionState", error, { chainId, address: auction });
+    }
+}
+exports.default = getAuctionState;

package/dist/contracts/zeno/getAuctions.js

@@ -9,12 +9,14 @@ const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
 const amount_1 = require("../../utils/amount");
 const rpcError_1 = require("../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
 /**
  * Lists every auction created by the AuctionFactory.
  * @param chainId The chain id.
  * @param provider The provider to read with. Defaults to the chain's first configured RPC.
- * @returns One record per auction. Price amounts use the auction's payment token, ZENO amounts the ZENO
- * token; decimals and symbols come from the chain config registry and fall back to 18 when the token is not listed.
+ * @returns One record per auction. Price amounts use the auction's payment token, ZENO amounts the ZENO's underlying,
+ * whose decimals ZENO shares; decimals and symbols come from the chain config registry and fall back to 18 when the
+ * token is not listed.
  */
 async function getAuctions(chainId, provider) {
     if (!provider) {
@@ -30,6 +32,7 @@ async function getAuctions(chainId, provider) {
                 auctionContract.getDetails(),
                 auctionContract.token(),
             ]);
+            const underlying = await (0, _helpers_1.getZenoContract)(chainId, details.zenoAddress, provider).underlyingAsset();
             return {
                 auctionAddress: details.auctionAddress,
                 zenoAddress: details.zenoAddress,
@@ -40,8 +43,8 @@ async function getAuctions(chainId, provider) {
                 startingPrice: (0, amount_1.toTokenAmount)(chainId, tokenAddress, details.startingPrice),
                 reservePrice: (0, amount_1.toTokenAmount)(chainId, tokenAddress, details.reservePrice),
                 price: (0, amount_1.toTokenAmount)(chainId, tokenAddress, details.price),
-                totalZENOAllocated: (0, amount_1.toTokenAmount)(chainId, details.zenoAddress, details.totalZENOAllocated),
-                totalZENORemaining: (0, amount_1.toTokenAmount)(chainId, details.zenoAddress, details.totalZENORemaining),
+                totalZENOAllocated: (0, _helpers_1.toZenoAmount)(chainId, underlying, details.totalZENOAllocated),
+                totalZENORemaining: (0, _helpers_1.toZenoAmount)(chainId, underlying, details.totalZENORemaining),
                 fundingMode: Number(details.fundingMode),
             };
         }));

package/dist/contracts/zeno/getBondState.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ethers_1 = require("ethers");
+const amount_1 = require("../../utils/amount");
+const rpcError_1 = require("../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
+/**
+ * Reads a ZENO bond's live state: supply, collateral and whether it can be redeemed. Collateral is read here rather
+ * than indexed, because top-ups are plain transfers on the underlying that no ZENO event records.
+ * @param chainId The chain id.
+ * @param zeno The ZENO bond address.
+ * @param provider The provider to read with. Defaults to the chain's first configured RPC.
+ * @returns The bond's state.
+ */
+async function getBondState(chainId, zeno, provider) {
+    try {
+        const contract = (0, _helpers_1.getZenoContract)(chainId, zeno, provider);
+        const [details, underlying, auction, totalSupply, sweepableSurplus, isRedeemable] = await Promise.all([
+            contract.getDetails(),
+            contract.underlyingAsset(),
+            contract.auction(),
+            contract.totalSupply(),
+            contract.sweepableSurplus(),
+            contract.isRedeemable(),
+        ]);
+        const collateral = await new ethers_1.ethers.Contract(underlying, _helpers_1.ERC20_ABI, contract.runner).balanceOf(zeno);
+        return {
+            zeno: details.zenoAddress,
+            name: details.name,
+            symbol: details.symbol,
+            underlying,
+            auction: (0, _helpers_1.addressOrNull)(auction),
+            maturityDate: details.maturityDate,
+            isRedeemable,
+            totalMinted: (0, _helpers_1.toZenoAmount)(chainId, underlying, details.totalMinted, details.symbol),
+            totalSupply: (0, _helpers_1.toZenoAmount)(chainId, underlying, totalSupply, details.symbol),
+            totalRedeemed: (0, _helpers_1.toZenoAmount)(chainId, underlying, details.totalRedeemed, details.symbol),
+            collateral: (0, amount_1.toTokenAmount)(chainId, underlying, collateral),
+            sweepableSurplus: (0, amount_1.toTokenAmount)(chainId, underlying, sweepableSurplus),
+            isFunded: collateral >= totalSupply,
+        };
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("zeno.getBondState", error, { chainId, address: zeno });
+    }
+}
+exports.default = getBondState;

package/dist/contracts/zeno/getPrice.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const amount_1 = require("../../utils/amount");
+const rpcError_1 = require("../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
+/**
+ * Reads an auction's current price. Read it right before `buy` to size `minZenoOut`: a Dutch price falls every block.
+ * @param chainId The chain id.
+ * @param auction The auction address.
+ * @param provider The provider to read with. Defaults to the chain's first configured RPC.
+ * @returns The price in payment token base units per whole ZENO.
+ */
+async function getPrice(chainId, auction, provider) {
+    try {
+        const contract = (0, _helpers_1.getAuctionContract)(chainId, auction, provider);
+        const [price, paymentToken] = await Promise.all([contract.getPrice(), contract.token()]);
+        return (0, amount_1.toTokenAmount)(chainId, paymentToken, price);
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("zeno.getPrice", error, { chainId, address: auction });
+    }
+}
+exports.default = getPrice;