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

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",
@@ -197,6 +197,11 @@
             "asset": "crvusd",
             "name": "RAAC NFT",
             "contract": "0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9"
+        },
+        "raacbotnft": {
+            "id": "raacbotnft",
+            "name": "RAAC Bot NFT (mock)",
+            "contract": "0x700b6A60ce7EaaEA56F065753d8dcB9653dbAD35"
         }
     },
     "assets": {
@@ -294,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": {
@@ -310,7 +336,7 @@
         "raacbotlocker": {
             "id": "raacbotlocker",
             "name": "RAAC Bot Locker",
-            "contract": "0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82"
+            "contract": "0x8ce361602B935680E8DeC218b820ff5056BeB7af"
         }
     },
     "zap": {

package/dist/contracts/lockers/botLocker/addRewardTokens.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addRewardTokens = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Register reward tokens that can be distributed to lockers. MANAGER_ROLE only.
+ * Reverts if any token is the zero address or already registered.
+ *
+ * @param chainId - The chain/network to use.
+ * @param tokens - ERC20 addresses to register.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const addRewardTokens = async (chainId, tokens, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.addRewardTokens(tokens);
+    await tx.wait();
+    return tx;
+};
+exports.addRewardTokens = addRewardTokens;

package/dist/contracts/lockers/botLocker/distributeRewardToken.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.distributeRewardToken = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Distribute `amount` of a registered reward token across all currently locked NFTs. DISTRIBUTOR_ROLE only.
+ * The signer's tokens are pulled via transferFrom, so approve the locker for `amount` first.
+ * Reverts when nothing is locked.
+ *
+ * @param chainId - The chain/network to use.
+ * @param token - Address of a registered reward token.
+ * @param amount - Amount to distribute, in `token` base units.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const distributeRewardToken = async (chainId, token, amount, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.distributeRewardToken(token, amount);
+    await tx.wait();
+    return tx;
+};
+exports.distributeRewardToken = distributeRewardToken;

package/dist/contracts/lockers/botLocker/getConfig.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Read the locker's configuration in a single call batch.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The NFT collection, lock timing constants, reward tokens and pause state.
+ */
+const getConfig = async (chainId, provider) => {
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
+    const [nft, epochDuration, lockDurationEpochs, rewardTokens, paused] = await Promise.all([
+        contract.nft(),
+        contract.EPOCH_DURATION(),
+        contract.LOCK_DURATION_IN_EPOCH(),
+        contract.getRewardTokens(),
+        contract.paused(),
+    ]);
+    return {
+        nft,
+        epochDuration: Number(epochDuration),
+        lockDurationEpochs: Number(lockDurationEpochs),
+        rewardTokens: Array.from(rewardTokens),
+        paused,
+    };
+};
+exports.getConfig = getConfig;

package/dist/contracts/lockers/botLocker/getLocks.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLocksByOwner = exports.getLocks = void 0;
+exports.getLocksByOwner = exports.getLock = exports.getLocks = void 0;
+const ethers_1 = require("ethers");
 const _helpers_1 = require("./_helpers");
 const normalize = (l) => ({
     owner: l.owner ?? l[0],
@@ -16,6 +17,15 @@ const getLocks = async (chainId, provider) => {
     return results.map(normalize);
 };
 exports.getLocks = getLocks;
+/**
+ * Returns the lock of a single NFT, or null when it is not locked.
+ */
+const getLock = async (chainId, tokenId, provider) => {
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
+    const lock = normalize(await contract.locks(tokenId));
+    return lock.owner === ethers_1.ZeroAddress ? null : lock;
+};
+exports.getLock = getLock;
 /**
  * Returns every active NFT lock owned by `owner`.
  */

package/dist/contracts/lockers/botLocker/getRoles.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRoles = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Gets the access-control role identifiers used by the bot locker.
+ *
+ * @param chainId - The chain/network to use.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The bytes32 role identifiers.
+ */
+const getRoles = async (chainId, provider) => {
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
+    const [defaultAdminRole, pauserRole, managerRole, distributorRole] = await Promise.all([
+        contract.DEFAULT_ADMIN_ROLE(),
+        contract.PAUSER_ROLE(),
+        contract.MANAGER_ROLE(),
+        contract.DISTRIBUTOR_ROLE(),
+    ]);
+    return { defaultAdminRole, pauserRole, managerRole, distributorRole };
+};
+exports.getRoles = getRoles;

package/dist/contracts/lockers/botLocker/getUnlockWindow.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUnlockWindow = exports.BOT_LOCKER_LOCK_DURATION_EPOCHS = exports.BOT_LOCKER_EPOCH_DURATION = void 0;
+/** EPOCH_DURATION on RAACBotLocker, seconds. */
+exports.BOT_LOCKER_EPOCH_DURATION = 7 * 24 * 60 * 60;
+/** LOCK_DURATION_IN_EPOCH on RAACBotLocker. */
+exports.BOT_LOCKER_LOCK_DURATION_EPOCHS = 4;
+/**
+ * Unlock window of a locked NFT, computed locally without an RPC call.
+ *
+ * The contract allows `unlockAndClaim` when `floor((now - lockedAt) / epochDuration)` is a non-zero multiple of `lockDurationEpochs`, so windows are `[lockedAt + k * cycle, lockedAt + k * cycle + epochDuration)` for `k >= 1`, where `cycle = lockDurationEpochs * epochDuration`. They are relative to each NFT's own `lockedAt`, not to a global epoch, and a missed window reopens one cycle later.
+ *
+ * @param lockedAt - Lock timestamp of the NFT, unix seconds (`locks(tokenId).lockedAt`, or `lockedAt` from the subgraph).
+ * @param now - Current time, unix seconds. Use the latest block timestamp to match the contract exactly.
+ * @param epochDuration - Epoch length, seconds. Defaults to the contract constant.
+ * @param lockDurationEpochs - Epochs per lock cycle. Defaults to the contract constant.
+ * @returns Whether the NFT can unlock now and the bounds of the current or next window.
+ */
+const getUnlockWindow = (lockedAt, now, epochDuration = exports.BOT_LOCKER_EPOCH_DURATION, lockDurationEpochs = exports.BOT_LOCKER_LOCK_DURATION_EPOCHS) => {
+    const epochs = Math.floor((now - lockedAt) / epochDuration);
+    if (epochs > 0 && epochs % lockDurationEpochs === 0) {
+        const opensAt = lockedAt + epochs * epochDuration;
+        return { unlockable: true, opensAt, closesAt: opensAt + epochDuration };
+    }
+    const cycle = Math.floor(Math.max(epochs, 0) / lockDurationEpochs) + 1;
+    const opensAt = lockedAt + cycle * lockDurationEpochs * epochDuration;
+    return { unlockable: false, opensAt, closesAt: opensAt + epochDuration };
+};
+exports.getUnlockWindow = getUnlockWindow;

package/dist/contracts/lockers/botLocker/grantRole.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revokeRole = exports.grantRole = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Grant a bot locker role. DEFAULT_ADMIN_ROLE only.
+ *
+ * @param chainId - The chain/network to use.
+ * @param role - The bytes32 role identifier (see `getRoles`).
+ * @param account - The address to grant the role to.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const grantRole = async (chainId, role, account, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.grantRole(role, account);
+    await tx.wait();
+    return tx;
+};
+exports.grantRole = grantRole;
+/**
+ * Revoke a bot locker role. DEFAULT_ADMIN_ROLE only.
+ *
+ * @param chainId - The chain/network to use.
+ * @param role - The bytes32 role identifier (see `getRoles`).
+ * @param account - The address to revoke the role from.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const revokeRole = async (chainId, role, account, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.revokeRole(role, account);
+    await tx.wait();
+    return tx;
+};
+exports.revokeRole = revokeRole;

package/dist/contracts/lockers/botLocker/hasRole.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasRole = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Checks whether an account holds a bot locker role.
+ *
+ * @param chainId - The chain/network to use.
+ * @param role - The bytes32 role identifier (see `getRoles`).
+ * @param account - The address to check.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns True if the account holds the role.
+ */
+const hasRole = async (chainId, role, account, provider) => {
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, provider);
+    return contract.hasRole(role, account);
+};
+exports.hasRole = hasRole;

package/dist/contracts/lockers/botLocker/pause.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unpause = exports.pause = void 0;
+const _helpers_1 = require("./_helpers");
+/** Pause lock, unlockAndClaim and claim. PAUSER_ROLE only. */
+const pause = async (chainId, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.pause();
+    await tx.wait();
+    return tx;
+};
+exports.pause = pause;
+/** PAUSER_ROLE only. */
+const unpause = async (chainId, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.unpause();
+    await tx.wait();
+    return tx;
+};
+exports.unpause = unpause;

package/dist/contracts/lockers/botLocker/rescueTokens.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rescueTokens = void 0;
+const _helpers_1 = require("./_helpers");
+/**
+ * Send the locker's entire balance of `token` to `recipient`. DEFAULT_ADMIN_ROLE only.
+ * This includes rewards lockers have not claimed yet, so later claims of that token revert until it is refilled.
+ *
+ * @param chainId - The chain/network to use.
+ * @param token - ERC20 address to rescue.
+ * @param recipient - Address receiving the balance.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+const rescueTokens = async (chainId, token, recipient, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const contract = await (0, _helpers_1.getBotLockerContract)(chainId, signer);
+    const tx = await contract.rescueTokens(token, recipient);
+    await tx.wait();
+    return tx;
+};
+exports.rescueTokens = rescueTokens;

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;

package/dist/contracts/zeno/getZenos.js

@@ -7,14 +7,14 @@ const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../configs/chains"));
 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 ZENO bond created by the ZENOFactory.
  * @param chainId The chain id.
  * @param provider The provider to read with. Defaults to the chain's first configured RPC.
- * @returns One record per bond. Amounts take decimals from the chain config registry and fall back to 18 when the
- * bond is not listed.
+ * @returns One record per bond. ZENO shares its underlying's decimals, so amounts take the underlying's from the chain
+ * config registry and fall back to 18 when it is not listed.
  */
 async function getZenos(chainId, provider) {
     if (!provider) {
@@ -26,14 +26,14 @@ async function getZenos(chainId, provider) {
         const zenoAddresses = await zenoFactoryContract.getZENOs();
         return await Promise.all(zenoAddresses.map(async (address) => {
             const zenoContract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("zeno"), provider);
-            const details = await zenoContract.getDetails();
+            const [details, underlying] = await Promise.all([zenoContract.getDetails(), zenoContract.underlyingAsset()]);
             return {
                 zenoAddress: details.zenoAddress,
                 maturityDate: details.maturityDate,
                 name: details.name,
                 symbol: details.symbol,
-                totalMinted: (0, amount_1.toTokenAmount)(chainId, details.zenoAddress, details.totalMinted),
-                totalRedeemed: (0, amount_1.toTokenAmount)(chainId, details.zenoAddress, details.totalRedeemed),
+                totalMinted: (0, _helpers_1.toZenoAmount)(chainId, underlying, details.totalMinted, details.symbol),
+                totalRedeemed: (0, _helpers_1.toZenoAmount)(chainId, underlying, details.totalRedeemed, details.symbol),
             };
         }));
     }

package/dist/contracts/zeno/grantRole.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.grantRole = grantRole;
+exports.revokeRole = revokeRole;
+const rpcError_1 = require("../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
+/**
+ * Grants an auction role, e.g. PAUSER_ROLE to a guardian bot. DEFAULT_ADMIN_ROLE only.
+ * @param chainId The chain id.
+ * @param auction The auction address.
+ * @param role The bytes32 role identifier: `keccak256("PAUSER_ROLE")`, or the zero hash for DEFAULT_ADMIN_ROLE.
+ * @param account The address to grant it to.
+ * @param signer A DEFAULT_ADMIN_ROLE holder.
+ * @returns The transaction receipt.
+ */
+async function grantRole(chainId, auction, role, account, signer) {
+    if (!signer)
+        throw new Error("Signer is required");
+    try {
+        const tx = await (0, _helpers_1.getAuctionContract)(chainId, auction, signer).grantRole(role, account);
+        return await tx.wait();
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("zeno.grantRole", error, { chainId, address: auction });
+    }
+}
+/**
+ * Revokes an auction role. DEFAULT_ADMIN_ROLE only.
+ * @param chainId The chain id.
+ * @param auction The auction address.
+ * @param role The bytes32 role identifier: `keccak256("PAUSER_ROLE")`, or the zero hash for DEFAULT_ADMIN_ROLE.
+ * @param account The address to revoke it from.
+ * @param signer A DEFAULT_ADMIN_ROLE holder.
+ * @returns The transaction receipt.
+ */
+async function revokeRole(chainId, auction, role, account, signer) {
+    if (!signer)
+        throw new Error("Signer is required");
+    try {
+        const tx = await (0, _helpers_1.getAuctionContract)(chainId, auction, signer).revokeRole(role, account);
+        return await tx.wait();
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("zeno.revokeRole", error, { chainId, address: auction });
+    }
+}