@bananapus/nana-sdk-core 1.0.0 → 1.1.0

package/dist/esm/v6/suckers.js

@@ -0,0 +1,156 @@
+import { getAddress, pad, sliceHex, zeroHash, } from "viem";
+import { jbSuckerRegistryAbi } from "../generated/juicebox.js";
+import { v6Address } from "./types.js";
+/**
+ * Minimal v6 JBSucker ABI. v6 identifies remote beneficiaries as bytes32 (for cross-VM
+ * compatibility) and adds an opaque `metadata` attribution payload to prepared leaves.
+ */
+export const jbSuckerV6Abi = [
+    {
+        type: "function",
+        name: "prepare",
+        inputs: [
+            { name: "projectTokenCount", type: "uint256", internalType: "uint256" },
+            { name: "beneficiary", type: "bytes32", internalType: "bytes32" },
+            { name: "minTokensReclaimed", type: "uint256", internalType: "uint256" },
+            { name: "token", type: "address", internalType: "address" },
+            { name: "metadata", type: "bytes32", internalType: "bytes32" },
+        ],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+    {
+        type: "function",
+        name: "toRemote",
+        inputs: [{ name: "token", type: "address", internalType: "address" }],
+        outputs: [],
+        stateMutability: "payable",
+    },
+    {
+        type: "function",
+        name: "claim",
+        inputs: [
+            {
+                name: "claimData",
+                type: "tuple",
+                internalType: "struct JBClaim",
+                components: [
+                    { name: "token", type: "address", internalType: "address" },
+                    {
+                        name: "leaf",
+                        type: "tuple",
+                        internalType: "struct JBLeaf",
+                        components: [
+                            { name: "index", type: "uint256", internalType: "uint256" },
+                            { name: "beneficiary", type: "bytes32", internalType: "bytes32" },
+                            { name: "projectTokenCount", type: "uint256", internalType: "uint256" },
+                            { name: "terminalTokenAmount", type: "uint256", internalType: "uint256" },
+                            { name: "metadata", type: "bytes32", internalType: "bytes32" },
+                        ],
+                    },
+                    { name: "proof", type: "bytes32[32]", internalType: "bytes32[32]" },
+                ],
+            },
+        ],
+        outputs: [],
+        stateMutability: "nonpayable",
+    },
+];
+/**
+ * Builds a `prepare` transaction on a v6 sucker, locking project tokens into an outbox
+ * leaf destined for the remote chain.
+ *
+ * The beneficiary is an EVM address; it's left-padded to bytes32 internally (v6 suckers
+ * identify beneficiaries as bytes32 for cross-VM compatibility).
+ *
+ * @param args.chainId The chain the sucker lives on.
+ * @param args.sucker The sucker's address.
+ * @param args.projectTokenCount The number of project tokens to bridge, as a fixed point
+ * number with 18 decimals.
+ * @param args.beneficiary The address that will claim the bridged tokens on the remote chain.
+ * @param args.minTokensReclaimed The minimum number of terminal tokens to reclaim when the
+ * project tokens are cashed out. Defaults to 0.
+ * @param args.token The local terminal token being bridged alongside the project tokens.
+ * @param args.metadata Opaque bytes32 attribution payload hashed into the leaf. Defaults to
+ * zero.
+ */
+export function buildBridgePrepareTx({ chainId, sucker, projectTokenCount, beneficiary, minTokensReclaimed = 0n, token, metadata = zeroHash, }) {
+    return {
+        chainId,
+        address: sucker,
+        abi: jbSuckerV6Abi,
+        functionName: "prepare",
+        args: [
+            projectTokenCount,
+            // Lowercase so the bytes32 is deterministic regardless of input checksum casing.
+            pad(beneficiary.toLowerCase(), { size: 32 }),
+            minTokensReclaimed,
+            token,
+            metadata,
+        ],
+    };
+}
+/**
+ * Builds a `claim` transaction on a v6 sucker, redeeming an inbox leaf that was bridged
+ * from the remote chain.
+ *
+ * @param args.chainId The chain the sucker lives on.
+ * @param args.sucker The sucker's address.
+ * @param args.claim The claim: terminal token, leaf (with bytes32 beneficiary), and a
+ * 32-entry bytes32 inclusion proof.
+ */
+export function buildBridgeClaimTx({ chainId, sucker, claim, }) {
+    return {
+        chainId,
+        address: sucker,
+        abi: jbSuckerV6Abi,
+        functionName: "claim",
+        args: [claim],
+    };
+}
+/**
+ * Builds a `toRemote` transaction on a v6 sucker, sending the outbox tree for a token to
+ * the remote chain.
+ *
+ * Payable: bridging over CCIP requires a fee to be sent along as `value`. Native-bridge
+ * suckers (OP/Base/Arbitrum) take no fee.
+ *
+ * @param args.chainId The chain the sucker lives on.
+ * @param args.sucker The sucker's address.
+ * @param args.token The local terminal token whose outbox tree should be bridged.
+ * @param args.value The bridge fee to send along. Defaults to 0.
+ */
+export function buildToRemoteTx({ chainId, sucker, token, value = 0n, }) {
+    return {
+        chainId,
+        address: sucker,
+        abi: jbSuckerV6Abi,
+        functionName: "toRemote",
+        args: [token],
+        value,
+    };
+}
+/**
+ * Reads a project's v6 sucker pairs from the JBSuckerRegistry on the given chain.
+ *
+ * The v6 registry stores remote suckers as bytes32 (for cross-VM compatibility); for EVM
+ * peers the address is in the low 20 bytes, which this unpacks to a checksummed address.
+ *
+ * @param client A viem PublicClient connected to `chainId`.
+ * @param args.chainId The chain to read the registry on.
+ * @param args.projectId The project to look up pairs for.
+ */
+export async function getV6SuckerPairs(client, { chainId, projectId }) {
+    const pairs = await client.readContract({
+        address: v6Address("JBSuckerRegistry", chainId),
+        abi: jbSuckerRegistryAbi,
+        functionName: "suckerPairsOf",
+        args: [projectId],
+    });
+    return pairs.map((pair) => ({
+        local: pair.local,
+        remote: getAddress(sliceHex(pair.remote, 12)),
+        remoteChainId: pair.remoteChainId,
+    }));
+}
+//# sourceMappingURL=suckers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"suckers.js","sourceRoot":"","sources":["../../../src/v6/suckers.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,UAAU,EACV,GAAG,EACH,QAAQ,EACR,QAAQ,GACT,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,SAAS;QACf,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;YACvE,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;YACjE,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;YACxE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;YAC3D,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;SAC/D;QACD,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,YAAY;KAC9B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC;QACrE,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,SAAS;KAC3B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,OAAO;QACb,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,OAAO;gBACb,YAAY,EAAE,gBAAgB;gBAC9B,UAAU,EAAE;oBACV,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;oBAC3D;wBACE,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,OAAO;wBACb,YAAY,EAAE,eAAe;wBAC7B,UAAU,EAAE;4BACV,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;4BAC3D,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;4BACjE,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;4BACvE,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;4BACzE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;yBAC/D;qBACF;oBACD,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE;iBACpE;aACF;SACF;QACD,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,YAAY;KAC9B;CACO,CAAC;AA8CX;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,oBAAoB,CAAC,EACnC,OAAO,EACP,MAAM,EACN,iBAAiB,EACjB,WAAW,EACX,kBAAkB,GAAG,EAAE,EACvB,KAAK,EACL,QAAQ,GAAG,QAAQ,GASpB;IAOC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,MAAM;QACf,GAAG,EAAE,aAAa;QAClB,YAAY,EAAE,SAAS;QACvB,IAAI,EAAE;YACJ,iBAAiB;YACjB,iFAAiF;YACjF,GAAG,CAAC,WAAW,CAAC,WAAW,EAAa,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YACvD,kBAAkB;YAClB,KAAK;YACL,QAAQ;SACT;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAC,EACjC,OAAO,EACP,MAAM,EACN,KAAK,GAKN;IAOC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,MAAM;QACf,GAAG,EAAE,aAAa;QAClB,YAAY,EAAE,OAAO;QACrB,IAAI,EAAE,CAAC,KAAK,CAAC;KACd,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,EAC9B,OAAO,EACP,MAAM,EACN,KAAK,EACL,KAAK,GAAG,EAAE,GAMX;IAQC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,MAAM;QACf,GAAG,EAAE,aAAa;QAClB,YAAY,EAAE,UAAU;QACxB,IAAI,EAAE,CAAC,KAAK,CAAC;QACb,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAoB,EACpB,EAAE,OAAO,EAAE,SAAS,EAA6C;IAEjE,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;QACtC,OAAO,EAAE,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC;QAC/C,GAAG,EAAE,mBAAmB;QACxB,YAAY,EAAE,eAAe;QAC7B,IAAI,EAAE,CAAC,SAAS,CAAC;KAClB,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;KAClC,CAAC,CAAC,CAAC;AACN,CAAC"}

package/dist/esm/v6/suckers.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=suckers.test.d.ts.map

package/dist/esm/v6/suckers.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suckers.test.d.ts","sourceRoot":"","sources":["../../../src/v6/suckers.test.ts"],"names":[],"mappings":""}

package/dist/esm/v6/suckers.test.js

@@ -0,0 +1,132 @@
+import { describe, expect, test, vi } from "vitest";
+import { decodeFunctionData, encodeFunctionData, pad, zeroHash, } from "viem";
+import { buildBridgeClaimTx, buildBridgePrepareTx, buildToRemoteTx, getV6SuckerPairs, jbSuckerV6Abi, } from "./suckers.js";
+import { v6Address } from "./types.js";
+const sucker = "0x00000000000000000000000000000000000000aa";
+const token = "0x000000000000000000000000000000000000000b";
+const beneficiary = "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266";
+const paddedBeneficiary = "0x000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266";
+describe("suckers", () => {
+    describe("buildBridgePrepareTx", () => {
+        test("left-pads the beneficiary address to bytes32 and encodes", () => {
+            const tx = buildBridgePrepareTx({
+                chainId: 11155111,
+                sucker,
+                projectTokenCount: 100n * 10n ** 18n,
+                beneficiary,
+                token,
+            });
+            expect(tx.address).toEqual(sucker);
+            expect(tx.functionName).toEqual("prepare");
+            expect(tx.args[1]).toEqual(paddedBeneficiary);
+            // minTokensReclaimed and metadata default to 0.
+            expect(tx.args[2]).toEqual(0n);
+            expect(tx.args[4]).toEqual(zeroHash);
+            const data = encodeFunctionData(tx);
+            const decoded = decodeFunctionData({ abi: jbSuckerV6Abi, data });
+            expect(decoded.functionName).toEqual("prepare");
+            expect(decoded.args).toEqual([
+                100n * 10n ** 18n,
+                paddedBeneficiary,
+                0n,
+                token,
+                zeroHash,
+            ]);
+        });
+        test("passes explicit minTokensReclaimed and metadata through", () => {
+            const metadata = pad("0x1234", { size: 32 });
+            const tx = buildBridgePrepareTx({
+                chainId: 1,
+                sucker,
+                projectTokenCount: 1n,
+                beneficiary,
+                minTokensReclaimed: 42n,
+                token,
+                metadata,
+            });
+            expect(tx.args[2]).toEqual(42n);
+            expect(tx.args[4]).toEqual(metadata);
+            expect(() => encodeFunctionData(tx)).not.toThrow();
+        });
+    });
+    describe("buildBridgeClaimTx", () => {
+        const claim = {
+            token,
+            leaf: {
+                index: 3n,
+                beneficiary: paddedBeneficiary,
+                projectTokenCount: 5n,
+                terminalTokenAmount: 7n,
+                metadata: zeroHash,
+            },
+            proof: Array.from({ length: 32 }, () => zeroHash),
+        };
+        test("encodes a full JBClaim", () => {
+            const tx = buildBridgeClaimTx({ chainId: 11155111, sucker, claim });
+            expect(tx.address).toEqual(sucker);
+            expect(tx.functionName).toEqual("claim");
+            const data = encodeFunctionData(tx);
+            const decoded = decodeFunctionData({ abi: jbSuckerV6Abi, data });
+            expect(decoded.functionName).toEqual("claim");
+            expect(decoded.args[0]).toEqual(claim);
+        });
+        test("rejects proofs that aren't exactly 32 entries", () => {
+            const tx = buildBridgeClaimTx({
+                chainId: 11155111,
+                sucker,
+                claim: {
+                    ...claim,
+                    proof: claim.proof.slice(0, 31),
+                },
+            });
+            expect(() => encodeFunctionData(tx)).toThrow();
+        });
+    });
+    describe("buildToRemoteTx", () => {
+        test("is payable with a default value of 0", () => {
+            const tx = buildToRemoteTx({ chainId: 11155111, sucker, token });
+            expect(tx.value).toEqual(0n);
+            expect(tx.functionName).toEqual("toRemote");
+            expect(() => encodeFunctionData(tx)).not.toThrow();
+        });
+        test("passes an explicit CCIP fee value through", () => {
+            const tx = buildToRemoteTx({
+                chainId: 11155111,
+                sucker,
+                token,
+                value: 123n,
+            });
+            expect(tx.value).toEqual(123n);
+            expect(tx.args).toEqual([token]);
+        });
+    });
+    describe("getV6SuckerPairs", () => {
+        test("reads the registry and unpacks bytes32 remotes to checksummed addresses", async () => {
+            const readContract = vi.fn().mockResolvedValue([
+                {
+                    local: sucker,
+                    remote: "0x000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266",
+                    remoteChainId: 10n,
+                },
+            ]);
+            const client = { readContract };
+            const pairs = await getV6SuckerPairs(client, {
+                chainId: 11155111,
+                projectId: 4n,
+            });
+            expect(readContract).toHaveBeenCalledWith(expect.objectContaining({
+                address: v6Address("JBSuckerRegistry", 11155111),
+                functionName: "suckerPairsOf",
+                args: [4n],
+            }));
+            expect(pairs).toEqual([
+                {
+                    local: sucker,
+                    remote: beneficiary, // checksummed low-20-bytes of the bytes32 remote
+                    remoteChainId: 10n,
+                },
+            ]);
+        });
+    });
+});
+//# sourceMappingURL=suckers.test.js.map

package/dist/esm/v6/suckers.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suckers.test.js","sourceRoot":"","sources":["../../../src/v6/suckers.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACpD,OAAO,EAEL,kBAAkB,EAClB,kBAAkB,EAClB,GAAG,EACH,QAAQ,GACT,MAAM,MAAM,CAAC;AACd,OAAO,EAEL,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,aAAa,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,MAAM,GAAG,4CAAqD,CAAC;AACrE,MAAM,KAAK,GAAG,4CAAqD,CAAC;AACpE,MAAM,WAAW,GAAG,4CAAqD,CAAC;AAC1E,MAAM,iBAAiB,GACrB,oEAA6E,CAAC;AAEhF,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;YACpE,MAAM,EAAE,GAAG,oBAAoB,CAAC;gBAC9B,OAAO,EAAE,QAAQ;gBACjB,MAAM;gBACN,iBAAiB,EAAE,IAAI,GAAG,GAAG,IAAI,GAAG;gBACpC,WAAW;gBACX,KAAK;aACN,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC3C,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;YAC9C,gDAAgD;YAChD,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC/B,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAErC,MAAM,IAAI,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACpC,MAAM,OAAO,GAAG,kBAAkB,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YACjE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC3B,IAAI,GAAG,GAAG,IAAI,GAAG;gBACjB,iBAAiB;gBACjB,EAAE;gBACF,KAAK;gBACL,QAAQ;aACT,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACnE,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;YAC7C,MAAM,EAAE,GAAG,oBAAoB,CAAC;gBAC9B,OAAO,EAAE,CAAC;gBACV,MAAM;gBACN,iBAAiB,EAAE,EAAE;gBACrB,WAAW;gBACX,kBAAkB,EAAE,GAAG;gBACvB,KAAK;gBACL,QAAQ;aACT,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACrC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,MAAM,KAAK,GAAY;YACrB,KAAK;YACL,IAAI,EAAE;gBACJ,KAAK,EAAE,EAAE;gBACT,WAAW,EAAE,iBAAiB;gBAC9B,iBAAiB,EAAE,EAAE;gBACrB,mBAAmB,EAAE,EAAE;gBACvB,QAAQ,EAAE,QAAQ;aACnB;YACD,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAgC;SACjF,CAAC;QAEF,IAAI,CAAC,wBAAwB,EAAE,GAAG,EAAE;YAClC,MAAM,EAAE,GAAG,kBAAkB,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAEpE,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEzC,MAAM,IAAI,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACpC,MAAM,OAAO,GAAG,kBAAkB,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YACjE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC9C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACzD,MAAM,EAAE,GAAG,kBAAkB,CAAC;gBAC5B,OAAO,EAAE,QAAQ;gBACjB,MAAM;gBACN,KAAK,EAAE;oBACL,GAAG,KAAK;oBACR,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAgC;iBAC/D;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAChD,MAAM,EAAE,GAAG,eAAe,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAEjE,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC7B,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACrD,MAAM,EAAE,GAAG,eAAe,CAAC;gBACzB,OAAO,EAAE,QAAQ;gBACjB,MAAM;gBACN,KAAK;gBACL,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,IAAI,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;YACzF,MAAM,YAAY,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;gBAC7C;oBACE,KAAK,EAAE,MAAM;oBACb,MAAM,EACJ,oEAAoE;oBACtE,aAAa,EAAE,GAAG;iBACnB;aACF,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,EAAE,YAAY,EAA6B,CAAC;YAE3D,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE;gBAC3C,OAAO,EAAE,QAAQ;gBACjB,SAAS,EAAE,EAAE;aACd,CAAC,CAAC;YAEH,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,CACvC,MAAM,CAAC,gBAAgB,CAAC;gBACtB,OAAO,EAAE,SAAS,CAAC,kBAAkB,EAAE,QAAQ,CAAC;gBAChD,YAAY,EAAE,eAAe;gBAC7B,IAAI,EAAE,CAAC,EAAE,CAAC;aACX,CAAC,CACH,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB;oBACE,KAAK,EAAE,MAAM;oBACb,MAAM,EAAE,WAAW,EAAE,iDAAiD;oBACtE,aAAa,EAAE,GAAG;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/esm/v6/terminals.d.ts

@@ -0,0 +1,67 @@
+import { Address, PublicClient } from "viem";
+import { JBChainId } from "../types.js";
+/**
+ * A payment terminal resolved for a `(projectId, token)` pair.
+ */
+export interface ResolvedPaymentTerminal {
+    /**
+     * The terminal address payments for the token should be sent to.
+     */
+    address: Address;
+    /**
+     * True when the project has no primary terminal for the token and the
+     * JBRouterTerminalRegistry (a universal terminal with the same `pay` signature) is
+     * used instead.
+     */
+    isRouter: boolean;
+}
+/**
+ * A v6 terminal accounting context.
+ */
+export interface JBAccountingContext {
+    /**
+     * The token the context applies to.
+     */
+    token: Address;
+    /**
+     * The token's number of decimals.
+     */
+    decimals: number;
+    /**
+     * The token's accounting-context currency: `uint32(uint160(token))`.
+     */
+    currency: number;
+}
+/**
+ * Resolve the terminal to pay a project's `token` payments to.
+ *
+ * Reads `JBDirectory.primaryTerminalOf(projectId, token)`. When the project has no
+ * primary terminal for the token (zero address), falls back to the
+ * JBRouterTerminalRegistry — a universal terminal that accepts any token and exposes
+ * the same `pay` signature.
+ *
+ * @param client A viem public client on the given chain.
+ * @param args.chainId The chain to resolve on.
+ * @param args.projectId The project's id.
+ * @param args.token The token being paid.
+ * @returns The terminal address and whether it's the router registry fallback.
+ */
+export declare function resolvePaymentTerminal(client: PublicClient, { chainId, projectId, token, }: {
+    chainId: JBChainId;
+    projectId: bigint;
+    token: Address;
+}): Promise<ResolvedPaymentTerminal>;
+/**
+ * Read the accounting contexts (accepted tokens with their decimals and currencies)
+ * registered for a project on the JBMultiTerminal.
+ *
+ * @param client A viem public client on the given chain.
+ * @param args.chainId The chain to read from.
+ * @param args.projectId The project's id.
+ * @returns The project's accounting contexts.
+ */
+export declare function getAccountingContexts(client: PublicClient, { chainId, projectId, }: {
+    chainId: JBChainId;
+    projectId: bigint;
+}): Promise<readonly JBAccountingContext[]>;
+//# sourceMappingURL=terminals.d.ts.map

package/dist/esm/v6/terminals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminals.d.ts","sourceRoot":"","sources":["../../../src/v6/terminals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,YAAY,EACpB,EACE,OAAO,EACP,SAAS,EACT,KAAK,GACN,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,uBAAuB,CAAC,CAgBlC;AAED;;;;;;;;GAQG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,YAAY,EACpB,EACE,OAAO,EACP,SAAS,GACV,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB,GACA,OAAO,CAAC,SAAS,mBAAmB,EAAE,CAAC,CAOzC"}

package/dist/esm/v6/terminals.js

@@ -0,0 +1,50 @@
+import { zeroAddress } from "viem";
+import { jbDirectoryAbi, jbMultiTerminalAbi } from "../generated/juicebox.js";
+import { v6Address } from "./types.js";
+/**
+ * Resolve the terminal to pay a project's `token` payments to.
+ *
+ * Reads `JBDirectory.primaryTerminalOf(projectId, token)`. When the project has no
+ * primary terminal for the token (zero address), falls back to the
+ * JBRouterTerminalRegistry — a universal terminal that accepts any token and exposes
+ * the same `pay` signature.
+ *
+ * @param client A viem public client on the given chain.
+ * @param args.chainId The chain to resolve on.
+ * @param args.projectId The project's id.
+ * @param args.token The token being paid.
+ * @returns The terminal address and whether it's the router registry fallback.
+ */
+export async function resolvePaymentTerminal(client, { chainId, projectId, token, }) {
+    const primaryTerminal = await client.readContract({
+        address: v6Address("JBDirectory", chainId),
+        abi: jbDirectoryAbi,
+        functionName: "primaryTerminalOf",
+        args: [projectId, token],
+    });
+    if (primaryTerminal === zeroAddress) {
+        return {
+            address: v6Address("JBRouterTerminalRegistry", chainId),
+            isRouter: true,
+        };
+    }
+    return { address: primaryTerminal, isRouter: false };
+}
+/**
+ * Read the accounting contexts (accepted tokens with their decimals and currencies)
+ * registered for a project on the JBMultiTerminal.
+ *
+ * @param client A viem public client on the given chain.
+ * @param args.chainId The chain to read from.
+ * @param args.projectId The project's id.
+ * @returns The project's accounting contexts.
+ */
+export async function getAccountingContexts(client, { chainId, projectId, }) {
+    return client.readContract({
+        address: v6Address("JBMultiTerminal", chainId),
+        abi: jbMultiTerminalAbi,
+        functionName: "accountingContextsOf",
+        args: [projectId],
+    });
+}
+//# sourceMappingURL=terminals.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"terminals.js","sourceRoot":"","sources":["../../../src/v6/terminals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,WAAW,EAAE,MAAM,MAAM,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAoCvC;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAoB,EACpB,EACE,OAAO,EACP,SAAS,EACT,KAAK,GAKN;IAED,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;QAChD,OAAO,EAAE,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC;QAC1C,GAAG,EAAE,cAAc;QACnB,YAAY,EAAE,mBAAmB;QACjC,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC;KACzB,CAAC,CAAC;IAEH,IAAI,eAAe,KAAK,WAAW,EAAE,CAAC;QACpC,OAAO;YACL,OAAO,EAAE,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC;YACvD,QAAQ,EAAE,IAAI;SACf,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AACvD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAAoB,EACpB,EACE,OAAO,EACP,SAAS,GAIV;IAED,OAAO,MAAM,CAAC,YAAY,CAAC;QACzB,OAAO,EAAE,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC;QAC9C,GAAG,EAAE,kBAAkB;QACvB,YAAY,EAAE,sBAAsB;QACpC,IAAI,EAAE,CAAC,SAAS,CAAC;KAClB,CAAC,CAAC;AACL,CAAC"}

package/dist/esm/v6/terminals.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=terminals.test.d.ts.map

package/dist/esm/v6/terminals.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminals.test.d.ts","sourceRoot":"","sources":["../../../src/v6/terminals.test.ts"],"names":[],"mappings":""}

package/dist/esm/v6/terminals.test.js

@@ -0,0 +1,57 @@
+import { zeroAddress } from "viem";
+import { describe, expect, test } from "vitest";
+import { NATIVE_TOKEN } from "../constants.js";
+import { jbDirectoryAbi, jbMultiTerminalAbi } from "../generated/juicebox.js";
+import { getAccountingContexts, resolvePaymentTerminal } from "./terminals.js";
+import { v6Address } from "./types.js";
+const chainId = 11155111;
+const projectId = 3n;
+function mockClient(result, calls = []) {
+    return {
+        async readContract(params) {
+            calls.push(params);
+            return result;
+        },
+    };
+}
+describe("terminals", () => {
+    test("resolvePaymentTerminal returns the primary terminal when set", async () => {
+        const terminal = "0x1111111111111111111111111111111111111111";
+        const calls = [];
+        const resolved = await resolvePaymentTerminal(mockClient(terminal, calls), {
+            chainId,
+            projectId,
+            token: NATIVE_TOKEN,
+        });
+        expect(resolved).toEqual({ address: terminal, isRouter: false });
+        expect(calls[0].address).toEqual(v6Address("JBDirectory", chainId));
+        expect(calls[0].abi).toBe(jbDirectoryAbi);
+        expect(calls[0].functionName).toEqual("primaryTerminalOf");
+        expect(calls[0].args).toEqual([projectId, NATIVE_TOKEN]);
+    });
+    test("resolvePaymentTerminal falls back to the router registry", async () => {
+        const resolved = await resolvePaymentTerminal(mockClient(zeroAddress), {
+            chainId,
+            projectId,
+            token: NATIVE_TOKEN,
+        });
+        expect(resolved).toEqual({
+            address: v6Address("JBRouterTerminalRegistry", chainId),
+            isRouter: true,
+        });
+    });
+    test("getAccountingContexts reads the multi terminal", async () => {
+        const contexts = [{ token: NATIVE_TOKEN, decimals: 18, currency: 61166 }];
+        const calls = [];
+        const result = await getAccountingContexts(mockClient(contexts, calls), {
+            chainId,
+            projectId,
+        });
+        expect(result).toEqual(contexts);
+        expect(calls[0].address).toEqual(v6Address("JBMultiTerminal", chainId));
+        expect(calls[0].abi).toBe(jbMultiTerminalAbi);
+        expect(calls[0].functionName).toEqual("accountingContextsOf");
+        expect(calls[0].args).toEqual([projectId]);
+    });
+});
+//# sourceMappingURL=terminals.test.js.map

package/dist/esm/v6/terminals.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminals.test.js","sourceRoot":"","sources":["../../../src/v6/terminals.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,WAAW,EAAE,MAAM,MAAM,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,OAAO,GAAG,QAAQ,CAAC;AACzB,MAAM,SAAS,GAAG,EAAE,CAAC;AAErB,SAAS,UAAU,CAAC,MAAe,EAAE,QAAmB,EAAE;IACxD,OAAO;QACL,KAAK,CAAC,YAAY,CAAC,MAAe;YAChC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnB,OAAO,MAAM,CAAC;QAChB,CAAC;KACyB,CAAC;AAC/B,CAAC;AAED,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,IAAI,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,QAAQ,GAAG,4CAA4C,CAAC;QAC9D,MAAM,KAAK,GAAU,EAAE,CAAC;QAExB,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE;YACzE,OAAO;YACP,SAAS;YACT,KAAK,EAAE,YAAY;SACpB,CAAC,CAAC;QAEH,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACjE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;YACrE,OAAO;YACP,SAAS;YACT,KAAK,EAAE,YAAY;SACpB,CAAC,CAAC;QAEH,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;YACvB,OAAO,EAAE,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC;YACvD,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,QAAQ,GAAG,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1E,MAAM,KAAK,GAAU,EAAE,CAAC;QAExB,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE;YACtE,OAAO;YACP,SAAS;SACV,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,CAAC;QACxE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC9D,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}