@raac/rpc 2.0.0-beta.15 → 2.0.0-beta.16

package/dist/RPCLibrary.js

@@ -158,6 +158,7 @@ const getRawUserDepositsInStabilityPool_1 = __importDefault(require("./pools/sta
 const getEligibleUserDeposits_1 = __importDefault(require("./pools/lendingPool/getEligibleUserDeposits"));
 const getMintPrice_1 = __importDefault(require("./nfts/getMintPrice"));
 const getMintFeePercentage_1 = __importDefault(require("./nfts/getMintFeePercentage"));
+const getPriceStaleness_1 = __importStar(require("./nfts/getPriceStaleness"));
 const getAllTokens_1 = __importDefault(require("./nfts/getAllTokens"));
 const totalNFTSupply_1 = __importDefault(require("./nfts/totalNFTSupply"));
 const getTokenURI_1 = __importDefault(require("./nfts/getTokenURI"));
@@ -497,6 +498,8 @@ class RPCLibrary {
             totalSupply: totalNFTSupply_1.default,
             getMintPrice: getMintPrice_1.default,
             getMintFeePercentage: getMintFeePercentage_1.default,
+            getPriceStalenessThreshold: getPriceStaleness_1.default,
+            isHousePriceStale: getPriceStaleness_1.isHousePriceStale,
             getAllTokens: getAllTokens_1.default,
             getTokenURI: getTokenURI_1.default,
             getTotalPropertiesCount: getTotalPropertiesCount_1.default,

package/dist/nfts/getPriceStaleness.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHousePriceStale = isHousePriceStale;
+const ethers_1 = require("ethers");
+const contracts_1 = require("../utils/contracts");
+const artifacts_1 = require("../utils/artifacts");
+const rpcError_1 = require("../utils/rpcError");
+// RAACNFT storage: token at slot 13, TRADE_FEE_PERCENTAGE at 17, PRICE_STALENESS_THRESHOLD at 18, feeCollector at 19.
+const TOKEN_SLOT = 13;
+const TRADE_FEE_SLOT = 17;
+const THRESHOLD_SLOT = 18;
+const FEE_COLLECTOR_SLOT = 19;
+/**
+ * Reads RAACNFT's `PRICE_STALENESS_THRESHOLD`, the maximum age of a house price that `mint` accepts. The variable has
+ * no getter, so it is read from storage slot 18, trusted only when the neighbouring slots match `token()`,
+ * `TRADE_FEE_PERCENTAGE()` and `feeCollector()` (the layout is as expected).
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns The threshold in seconds (0 turns the check off), or null when the storage layout could not be confirmed.
+ */
+async function getPriceStalenessThreshold(chainId, provider) {
+    const at = (0, contracts_1.getContractAddress)(chainId, "raacnft");
+    try {
+        const nft = new ethers_1.ethers.Contract(at, (0, artifacts_1.getABI)("raacnft"), provider);
+        const [token, tradeFee, feeCollector, ...slots] = await Promise.all([
+            nft.token(),
+            nft.TRADE_FEE_PERCENTAGE(),
+            nft.feeCollector(),
+            ...[TOKEN_SLOT, TRADE_FEE_SLOT, FEE_COLLECTOR_SLOT, THRESHOLD_SLOT].map((slot) => provider.getStorage(at, slot)),
+        ]);
+        const [tokenSlot, tradeFeeSlot, feeCollectorSlot, threshold] = slots.map((v) => BigInt(v));
+        const layoutOk = tokenSlot === BigInt(token) && tradeFeeSlot === tradeFee && feeCollectorSlot === BigInt(feeCollector);
+        return layoutOk ? Number(threshold) : null;
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("nfts.getPriceStalenessThreshold", error, { chainId, address: at });
+    }
+}
+/**
+ * Whether RAACNFT's `mint` would reject a house price as stale (`StalePriceData`), as `_validatePriceFreshness` decides:
+ * a price never set, or older than the threshold when the threshold is not 0. Only minting checks this; the lending
+ * pool's NFT adapter values collateral at the price whatever its age.
+ * @param priceTimestamp Unix seconds of the house price update; 0 when never priced.
+ * @param threshold `getPriceStalenessThreshold` in seconds.
+ * @param now Unix seconds to judge at, normally the latest block's timestamp.
+ * @returns True when a mint of this token would revert with `StalePriceData`.
+ */
+function isHousePriceStale(priceTimestamp, threshold, now) {
+    return priceTimestamp === 0 || (threshold > 0 && now > priceTimestamp + threshold);
+}
+exports.default = getPriceStalenessThreshold;

package/dist/types/RPCLibrary.d.ts

@@ -100,6 +100,7 @@ import getRawUserDepositInStabilityPool from "./pools/stabilityPool/getRawUserDe
 import getEligibleUserDeposits from "./pools/lendingPool/getEligibleUserDeposits";
 import getMintPrice from "./nfts/getMintPrice";
 import getMintFeePercentage from "./nfts/getMintFeePercentage";
+import getPriceStalenessThreshold, { isHousePriceStale } from "./nfts/getPriceStaleness";
 import getAllTokens from "./nfts/getAllTokens";
 import totalNFTSupply from "./nfts/totalNFTSupply";
 import getTokenURI from "./nfts/getTokenURI";
@@ -379,6 +380,8 @@ declare class RPCLibrary {
         totalSupply: typeof totalNFTSupply;
         getMintPrice: typeof getMintPrice;
         getMintFeePercentage: typeof getMintFeePercentage;
+        getPriceStalenessThreshold: typeof getPriceStalenessThreshold;
+        isHousePriceStale: typeof isHousePriceStale;
         getAllTokens: typeof getAllTokens;
         getTokenURI: typeof getTokenURI;
         getTotalPropertiesCount: typeof getTotalPropertiesCount;

package/dist/types/nfts/getPriceStaleness.d.ts

@@ -0,0 +1,22 @@
+import { Provider } from "ethers";
+import { ChainId } from "../configs/chains/index";
+/**
+ * Reads RAACNFT's `PRICE_STALENESS_THRESHOLD`, the maximum age of a house price that `mint` accepts. The variable has
+ * no getter, so it is read from storage slot 18, trusted only when the neighbouring slots match `token()`,
+ * `TRADE_FEE_PERCENTAGE()` and `feeCollector()` (the layout is as expected).
+ * @param chainId The chain id.
+ * @param provider The provider to read with.
+ * @returns The threshold in seconds (0 turns the check off), or null when the storage layout could not be confirmed.
+ */
+declare function getPriceStalenessThreshold(chainId: ChainId, provider: Provider): Promise<number | null>;
+/**
+ * Whether RAACNFT's `mint` would reject a house price as stale (`StalePriceData`), as `_validatePriceFreshness` decides:
+ * a price never set, or older than the threshold when the threshold is not 0. Only minting checks this; the lending
+ * pool's NFT adapter values collateral at the price whatever its age.
+ * @param priceTimestamp Unix seconds of the house price update; 0 when never priced.
+ * @param threshold `getPriceStalenessThreshold` in seconds.
+ * @param now Unix seconds to judge at, normally the latest block's timestamp.
+ * @returns True when a mint of this token would revert with `StalePriceData`.
+ */
+export declare function isHousePriceStale(priceTimestamp: number, threshold: number, now: number): boolean;
+export default getPriceStalenessThreshold;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@raac/rpc",
-	"version": "2.0.0-beta.15",
+	"version": "2.0.0-beta.16",
 	"description": "RPC Library for RAAC",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",