@bananapus/nana-sdk-core 2.27.0 → 2.29.0

package/dist/esm/v6/nftInventory.js

@@ -0,0 +1,208 @@
+import { parseAbi, zeroAddress } from "viem";
+import { jb721TiersHookStoreAbi, jbProjectsAbi, } from "../generated/juicebox.js";
+import { v6Address } from "./types.js";
+import { defifaDeployments, defifaStore } from "./defifaDeployments.js";
+import { getCurrentRuleset, getUpcomingRuleset, } from "./rulesets.js";
+import { getProject721Shop, } from "./nft.js";
+// Native read interface and deployment addresses: @ballkidz/defifa@1.0.2,
+// DefifaHook/DefifaDeployer; source revision d3c46dd4fe9a093cc46ed5eb2106395d2a19b860.
+// Defifa's pay metadata is (address,uint16[]), NOT JB721's (bool,uint16[]).
+const defifaReadAbi = parseAbi([
+    "function store() view returns (address)",
+    "function CODE_ORIGIN() view returns (address)",
+    "function projectId() view returns (uint256)",
+    "function gamePhaseReporter() view returns (address)",
+    "function gamePotReporter() view returns (address)",
+    "function pricingCurrency() view returns (uint256)",
+    "function contractURI() view returns (string)",
+    "function tierNameOf(uint256) view returns (string)",
+    "function currentSupplyOfTier(uint256) view returns (uint256)",
+    "function currentGamePotOf(uint256,bool) view returns (uint256,address,uint256)",
+    "function currentGamePhaseOf(uint256) view returns (uint8)",
+]);
+function sameAddress(left, right) {
+    return left.toLowerCase() === right.toLowerCase();
+}
+/**
+ * Discover displayable NFT tiers at one block, including Defifa games before
+ * entry starts and after payments stop. Unknown hooks return null; RPC failures
+ * throw. Defifa recognition requires the pinned deployer, exact clone runtime,
+ * project binding, native implementation/store and both game reporters.
+ *
+ * This is inventory discovery, not action authorization: JB721 capabilities
+ * identify compatible calldata, not account permissions or current pay status.
+ * Defifa entries, refunds and settlement require its native lifecycle adapter.
+ */
+export async function getProjectNftInventory(client, args) {
+    const { chainId, projectId, isRevnet = false, tierLimit = 100, startingId = 0n, categories = [], includeResolvedUri = false, } = args;
+    if (!Number.isInteger(tierLimit) || tierLimit < 1 || tierLimit > 128) {
+        throw new Error("NFT inventory tierLimit must be an integer between 1 and 128.");
+    }
+    if (startingId < 0n)
+        throw new Error("NFT inventory startingId cannot be negative.");
+    if (categories.some((category, index) => category < 0n ||
+        category > 0xffffffn ||
+        (index > 0 && category <= categories[index - 1]))) {
+        throw new Error("NFT inventory categories must be ascending, unique uint24 values for stable pagination.");
+    }
+    if ((await client.getChainId()) !== chainId)
+        throw new Error("NFT inventory client is connected to the wrong chain.");
+    if (args.blockNumber !== undefined && args.blockNumber < 0n) {
+        throw new Error("NFT inventory blockNumber cannot be negative.");
+    }
+    const blockNumber = args.blockNumber ?? (await client.getBlockNumber());
+    const snapshot = {
+        ...client,
+        readContract: (parameters) => client.readContract({ ...parameters, blockNumber }),
+    };
+    const ruleset = isRevnet
+        ? undefined
+        : await getCurrentRuleset(snapshot, args);
+    const hook = ruleset?.metadata.dataHook;
+    const deployment = defifaDeployments[chainId];
+    let owner;
+    // Only project ownership by the native deployer admits a Defifa candidate.
+    // This does not probe arbitrary custom hooks as if they were Defifa.
+    if (!isRevnet && deployment) {
+        owner = await snapshot.readContract({
+            address: v6Address("JBProjects", chainId),
+            abi: jbProjectsAbi,
+            functionName: "ownerOf",
+            args: [projectId],
+        });
+    }
+    if (!deployment || !owner || !sameAddress(owner, deployment.deployer)) {
+        const shop = await getProject721Shop(snapshot, {
+            ...args,
+            isRevnet,
+            ruleset,
+            includeInactiveHook: true,
+            tierLimit: tierLimit + 1,
+        });
+        if (!shop)
+            return null;
+        return {
+            ...shop,
+            protocol: "jb721",
+            blockNumber,
+            tiers: shop.tiers.slice(0, tierLimit),
+            nextStartingId: shop.tiers[tierLimit]
+                ? BigInt(shop.tiers[tierLimit].id)
+                : null,
+            capabilities: {
+                genericPay: true,
+                genericCashOut: true,
+                manageTiers: true,
+            },
+        };
+    }
+    // Countdown has no active ruleset yet; its first configured hook is queued.
+    const hookRuleset = !hook || hook === zeroAddress
+        ? await getUpcomingRuleset(snapshot, args)
+        : ruleset;
+    const defifaHook = hookRuleset.metadata.dataHook;
+    if (!defifaHook || defifaHook === zeroAddress)
+        return null;
+    const cloneCode = await client.getBytecode({
+        address: defifaHook,
+        blockNumber,
+    });
+    const expectedCode = `0x363d3d373d3d3d363d73${deployment.implementation.slice(2)}5af43d82803e903d91602b57fd5bf3`;
+    if (cloneCode?.toLowerCase() !== expectedCode)
+        throw new Error("Defifa hook clone does not match its pinned implementation.");
+    const read = (functionName) => snapshot.readContract({
+        address: defifaHook,
+        abi: defifaReadAbi,
+        functionName,
+    });
+    const [store, implementation, hookProjectId, phaseReporter, potReporter, currency, contractUri,] = await Promise.all([
+        read("store"),
+        read("CODE_ORIGIN"),
+        read("projectId"),
+        read("gamePhaseReporter"),
+        read("gamePotReporter"),
+        read("pricingCurrency"),
+        read("contractURI"),
+    ]);
+    if (!sameAddress(store, defifaStore) ||
+        !sameAddress(implementation, deployment.implementation) ||
+        hookProjectId !== projectId ||
+        !sameAddress(phaseReporter, deployment.deployer) ||
+        !sameAddress(potReporter, deployment.deployer)) {
+        throw new Error("Defifa hook provenance does not match the project deployment.");
+    }
+    const [pot, phase, raw] = await Promise.all([
+        snapshot.readContract({
+            address: deployment.deployer,
+            abi: defifaReadAbi,
+            functionName: "currentGamePotOf",
+            args: [projectId, false],
+        }),
+        snapshot.readContract({
+            address: deployment.deployer,
+            abi: defifaReadAbi,
+            functionName: "currentGamePhaseOf",
+            args: [projectId],
+        }),
+        snapshot.readContract({
+            address: store,
+            abi: jb721TiersHookStoreAbi,
+            functionName: "tiersOf",
+            args: [
+                defifaHook,
+                categories,
+                includeResolvedUri,
+                startingId,
+                BigInt(tierLimit + 1),
+            ],
+        }),
+    ]);
+    if (typeof currency !== "bigint" ||
+        currency > 0xffffffffn ||
+        pot[2] > 255n ||
+        pot[1] === zeroAddress ||
+        phase > 5) {
+        throw new Error("Defifa pricing or phase context is invalid.");
+    }
+    const visible = raw.filter((tier) => tier.initialSupply > 0);
+    const tiers = await Promise.all(visible.slice(0, tierLimit).map(async (tier) => {
+        const [name, currentSupply] = await Promise.all([
+            snapshot.readContract({
+                address: defifaHook,
+                abi: defifaReadAbi,
+                functionName: "tierNameOf",
+                args: [BigInt(tier.id)],
+            }),
+            snapshot.readContract({
+                address: defifaHook,
+                abi: defifaReadAbi,
+                functionName: "currentSupplyOfTier",
+                args: [BigInt(tier.id)],
+            }),
+        ]);
+        return { ...tier, name, currentSupply };
+    }));
+    return {
+        protocol: "defifa",
+        hook: defifaHook,
+        store: store,
+        implementation: implementation,
+        contractUri: contractUri,
+        pricing: {
+            currency: Number(currency),
+            decimals: Number(pot[2]),
+            token: pot[1],
+        },
+        phase,
+        tiers,
+        ruleset: hookRuleset,
+        blockNumber,
+        capabilities: {
+            genericPay: false,
+            genericCashOut: false,
+            manageTiers: false,
+        },
+        nextStartingId: visible[tierLimit] ? BigInt(visible[tierLimit].id) : null,
+    };
+}
+//# sourceMappingURL=nftInventory.js.map

package/dist/esm/v6/nftInventory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nftInventory.js","sourceRoot":"","sources":["../../../src/v6/nftInventory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,QAAQ,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAC9E,OAAO,EACL,sBAAsB,EACtB,aAAa,GACd,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,kBAAkB,GAEnB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,iBAAiB,GAGlB,MAAM,UAAU,CAAC;AAElB,0EAA0E;AAC1E,uFAAuF;AACvF,4EAA4E;AAC5E,MAAM,aAAa,GAAG,QAAQ,CAAC;IAC7B,yCAAyC;IACzC,+CAA+C;IAC/C,6CAA6C;IAC7C,qDAAqD;IACrD,mDAAmD;IACnD,mDAAmD;IACnD,8CAA8C;IAC9C,oDAAoD;IACpD,8DAA8D;IAC9D,gFAAgF;IAChF,2DAA2D;CAC5D,CAAC,CAAC;AA4DH,SAAS,WAAW,CAAC,IAAa,EAAE,KAAc;IAChD,OAAO,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;AACpD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAoB,EACpB,IAA6B;IAE7B,MAAM,EACJ,OAAO,EACP,SAAS,EACT,QAAQ,GAAG,KAAK,EAChB,SAAS,GAAG,GAAG,EACf,UAAU,GAAG,EAAE,EACf,UAAU,GAAG,EAAE,EACf,kBAAkB,GAAG,KAAK,GAC3B,GAAG,IAAI,CAAC;IACT,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,GAAG,GAAG,EAAE,CAAC;QACrE,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;IACJ,CAAC;IACD,IAAI,UAAU,GAAG,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,IACE,UAAU,CAAC,IAAI,CACb,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAClB,QAAQ,GAAG,EAAE;QACb,QAAQ,GAAG,SAAS;QACpB,CAAC,KAAK,GAAG,CAAC,IAAI,QAAQ,IAAI,UAAU,CAAC,KAAK,GAAG,CAAC,CAAE,CAAC,CACpD,EACD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,yFAAyF,CAC1F,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC,KAAK,OAAO;QACzC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,CAAC,MAAM,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAG;QACf,GAAG,MAAM;QACT,YAAY,EAAE,CAAC,UAAuD,EAAE,EAAE,CACxE,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,UAAU,EAAE,WAAW,EAAE,CAAC;KACtC,CAAC;IAClB,MAAM,OAAO,GAAG,QAAQ;QACtB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,MAAM,iBAAiB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,OAAO,EAAE,QAAQ,CAAC,QAA+B,CAAC;IAC/D,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC9C,IAAI,KAA0B,CAAC;IAC/B,2EAA2E;IAC3E,qEAAqE;IACrE,IAAI,CAAC,QAAQ,IAAI,UAAU,EAAE,CAAC;QAC5B,KAAK,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC;YAClC,OAAO,EAAE,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC;YACzC,GAAG,EAAE,aAAa;YAClB,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE,CAAC,SAAS,CAAC;SAClB,CAAC,CAAC;IACL,CAAC;IACD,IAAI,CAAC,UAAU,IAAI,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE;YAC7C,GAAG,IAAI;YACP,QAAQ;YACR,OAAO;YACP,mBAAmB,EAAE,IAAI;YACzB,SAAS,EAAE,SAAS,GAAG,CAAC;SACzB,CAAC,CAAC;QACH,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,OAAO;YACL,GAAG,IAAI;YACP,QAAQ,EAAE,OAAO;YACjB,WAAW;YACX,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC;YACrC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;gBACnC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAE,CAAC,EAAE,CAAC;gBACnC,CAAC,CAAC,IAAI;YACR,YAAY,EAAE;gBACZ,UAAU,EAAE,IAAI;gBAChB,cAAc,EAAE,IAAI;gBACpB,WAAW,EAAE,IAAI;aAClB;SACF,CAAC;IACJ,CAAC;IACD,4EAA4E;IAC5E,MAAM,WAAW,GACf,CAAC,IAAI,IAAI,IAAI,KAAK,WAAW;QAC3B,CAAC,CAAC,MAAM,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC;QAC1C,CAAC,CAAC,OAAQ,CAAC;IACf,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,QAAmB,CAAC;IAC5D,IAAI,CAAC,UAAU,IAAI,UAAU,KAAK,WAAW;QAAE,OAAO,IAAI,CAAC;IAC3D,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC;QACzC,OAAO,EAAE,UAAU;QACnB,WAAW;KACZ,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,yBAAyB,UAAU,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,gCAAgC,CAAC;IACjH,IAAI,SAAS,EAAE,WAAW,EAAE,KAAK,YAAY;QAC3C,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;IACJ,MAAM,IAAI,GAAG,CACX,YAOiB,EACjB,EAAE,CACF,QAAQ,CAAC,YAAY,CAAC;QACpB,OAAO,EAAE,UAAU;QACnB,GAAG,EAAE,aAAa;QAClB,YAAY;KACb,CAAC,CAAC;IACL,MAAM,CACJ,KAAK,EACL,cAAc,EACd,aAAa,EACb,aAAa,EACb,WAAW,EACX,QAAQ,EACR,WAAW,EACZ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,OAAO,CAAC;QACb,IAAI,CAAC,aAAa,CAAC;QACnB,IAAI,CAAC,WAAW,CAAC;QACjB,IAAI,CAAC,mBAAmB,CAAC;QACzB,IAAI,CAAC,iBAAiB,CAAC;QACvB,IAAI,CAAC,iBAAiB,CAAC;QACvB,IAAI,CAAC,aAAa,CAAC;KACpB,CAAC,CAAC;IACH,IACE,CAAC,WAAW,CAAC,KAAgB,EAAE,WAAW,CAAC;QAC3C,CAAC,WAAW,CAAC,cAAyB,EAAE,UAAU,CAAC,cAAc,CAAC;QAClE,aAAa,KAAK,SAAS;QAC3B,CAAC,WAAW,CAAC,aAAwB,EAAE,UAAU,CAAC,QAAQ,CAAC;QAC3D,CAAC,WAAW,CAAC,WAAsB,EAAE,UAAU,CAAC,QAAQ,CAAC,EACzD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC1C,QAAQ,CAAC,YAAY,CAAC;YACpB,OAAO,EAAE,UAAU,CAAC,QAAQ;YAC5B,GAAG,EAAE,aAAa;YAClB,YAAY,EAAE,kBAAkB;YAChC,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC;SACzB,CAAC;QACF,QAAQ,CAAC,YAAY,CAAC;YACpB,OAAO,EAAE,UAAU,CAAC,QAAQ;YAC5B,GAAG,EAAE,aAAa;YAClB,YAAY,EAAE,oBAAoB;YAClC,IAAI,EAAE,CAAC,SAAS,CAAC;SAClB,CAAC;QACF,QAAQ,CAAC,YAAY,CAAC;YACpB,OAAO,EAAE,KAAgB;YACzB,GAAG,EAAE,sBAAsB;YAC3B,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE;gBACJ,UAAU;gBACV,UAAU;gBACV,kBAAkB;gBAClB,UAAU;gBACV,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC;aACtB;SACF,CAAC;KACH,CAAC,CAAC;IACH,IACE,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,GAAG,WAAW;QACtB,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI;QACb,GAAG,CAAC,CAAC,CAAC,KAAK,WAAW;QACtB,KAAK,GAAG,CAAC,EACT,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;IAC7D,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC7C,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC9C,QAAQ,CAAC,YAAY,CAAC;gBACpB,OAAO,EAAE,UAAU;gBACnB,GAAG,EAAE,aAAa;gBAClB,YAAY,EAAE,YAAY;gBAC1B,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACxB,CAAC;YACF,QAAQ,CAAC,YAAY,CAAC;gBACpB,OAAO,EAAE,UAAU;gBACnB,GAAG,EAAE,aAAa;gBAClB,YAAY,EAAE,qBAAqB;gBACnC,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACxB,CAAC;SACH,CAAC,CAAC;QACH,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;IAC1C,CAAC,CAAC,CACH,CAAC;IACF,OAAO;QACL,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,KAAgB;QACvB,cAAc,EAAE,cAAyB;QACzC,WAAW,EAAE,WAAqB;QAClC,OAAO,EAAE;YACP,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;YAC1B,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACxB,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;SACd;QACD,KAAK;QACL,KAAK;QACL,OAAO,EAAE,WAAW;QACpB,WAAW;QACX,YAAY,EAAE;YACZ,UAAU,EAAE,KAAK;YACjB,cAAc,EAAE,KAAK;YACrB,WAAW,EAAE,KAAK;SACnB;QACD,cAAc,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;KAC3E,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/nana-sdk-core",
-  "version": "2.27.0",
+  "version": "2.29.0",
   "type": "module",
   "sideEffects": false,
   "repository": {