@bananapus/nana-sdk-core 1.0.0 → 1.1.0

package/dist/esm/v6/cashOut.js

@@ -0,0 +1,68 @@
+import { jbMultiTerminalAbi, jbTerminalStoreAbi, } from "../generated/juicebox.js";
+import { applyJbDaoCashOutFee } from "../utils/fee.js";
+import { NATIVE_TOKEN_CURRENCY_ID } from "./currency.js";
+import { v6Address } from "./types.js";
+/**
+ * Build a `cashOutTokensOf(holder, projectId, cashOutCount, tokenToReclaim,
+ * minTokensReclaimed, beneficiary, metadata)` transaction request for a v6 terminal.
+ *
+ * @param args.chainId The chain to cash out on.
+ * @param args.terminal The terminal holding the project's `tokenToReclaim` balance.
+ * @param args.holder The address whose project tokens are being cashed out.
+ * @param args.projectId The project's id.
+ * @param args.cashOutCount The number of project tokens to cash out, as a fixed point
+ * number with 18 decimals.
+ * @param args.tokenToReclaim The terminal token to reclaim from the project's surplus.
+ * @param args.minTokensReclaimed The minimum `tokenToReclaim` amount that must be
+ * reclaimed, else the transaction reverts. Defaults to 0.
+ * @param args.beneficiary The address that receives the reclaimed tokens.
+ * @param args.metadata Hook metadata. Defaults to "0x".
+ * @returns The transaction request.
+ */
+export function buildCashOutTx({ chainId, terminal, holder, projectId, cashOutCount, tokenToReclaim, minTokensReclaimed = 0n, beneficiary, metadata = "0x", }) {
+    return {
+        chainId,
+        address: terminal,
+        abi: jbMultiTerminalAbi,
+        functionName: "cashOutTokensOf",
+        args: [
+            holder,
+            projectId,
+            cashOutCount,
+            tokenToReclaim,
+            minTokensReclaimed,
+            beneficiary,
+            metadata,
+        ],
+    };
+}
+/**
+ * Quote the surplus reclaimed by cashing out `cashOutCount` project tokens, via
+ * `JBTerminalStore.currentReclaimableSurplusOf(projectId, cashOutCount, [], [],
+ * decimals, currency)`. Passing empty terminal/token arrays uses all of the project's
+ * terminals and tokens.
+ *
+ * @param client A viem public client on the given chain.
+ * @param args.chainId The chain to quote on.
+ * @param args.projectId The project's id.
+ * @param args.cashOutCount The number of project tokens to cash out, as a fixed point
+ * number with 18 decimals.
+ * @param args.decimals The decimals to quote the reclaim amount in. Defaults to 18.
+ * @param args.currency The currency to quote the reclaim amount in (an
+ * accounting-context currency, `uint32(uint160(token))`). Defaults to the native
+ * token's currency (61166).
+ * @returns The raw reclaim amount and the amount net of the 2.5% protocol fee.
+ */
+export async function getCashOutQuote(client, { chainId, projectId, cashOutCount, decimals = 18n, currency = BigInt(NATIVE_TOKEN_CURRENCY_ID), }) {
+    const reclaimAmount = await client.readContract({
+        address: v6Address("JBTerminalStore", chainId),
+        abi: jbTerminalStoreAbi,
+        functionName: "currentReclaimableSurplusOf",
+        args: [projectId, cashOutCount, [], [], decimals, currency],
+    });
+    return {
+        reclaimAmount,
+        reclaimAmountAfterFee: applyJbDaoCashOutFee(reclaimAmount),
+    };
+}
+//# sourceMappingURL=cashOut.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cashOut.js","sourceRoot":"","sources":["../../../src/v6/cashOut.ts"],"names":[],"mappings":"AACA,OAAO,EACL,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAcvC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAAC,EAC7B,OAAO,EACP,QAAQ,EACR,MAAM,EACN,SAAS,EACT,YAAY,EACZ,cAAc,EACd,kBAAkB,GAAG,EAAE,EACvB,WAAW,EACX,QAAQ,GAAG,IAAI,GAWhB;IACC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE,kBAAkB;QACvB,YAAY,EAAE,iBAAiB;QAC/B,IAAI,EAAE;YACJ,MAAM;YACN,SAAS;YACT,YAAY;YACZ,cAAc;YACd,kBAAkB;YAClB,WAAW;YACX,QAAQ;SACT;KACF,CAAC;AACJ,CAAC;AAmBD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAoB,EACpB,EACE,OAAO,EACP,SAAS,EACT,YAAY,EACZ,QAAQ,GAAG,GAAG,EACd,QAAQ,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAO5C;IAED,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;QAC9C,OAAO,EAAE,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC;QAC9C,GAAG,EAAE,kBAAkB;QACvB,YAAY,EAAE,6BAA6B;QAC3C,IAAI,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC;KAC5D,CAAC,CAAC;IAEH,OAAO;QACL,aAAa;QACb,qBAAqB,EAAE,oBAAoB,CAAC,aAAa,CAAC;KAC3D,CAAC;AACJ,CAAC"}

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

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

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

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

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

@@ -0,0 +1,100 @@
+import { encodeFunctionData } from "viem";
+import { describe, expect, test } from "vitest";
+import { NATIVE_TOKEN, ONE_ETHER } from "../constants.js";
+import { jbTerminalStoreAbi } from "../generated/juicebox.js";
+import { buildCashOutTx, getCashOutQuote } from "./cashOut.js";
+import { v6Address } from "./types.js";
+const chainId = 11155111;
+const terminal = "0x1111111111111111111111111111111111111111";
+const holder = "0x2222222222222222222222222222222222222222";
+const beneficiary = "0x3333333333333333333333333333333333333333";
+const projectId = 3n;
+describe("cashOut", () => {
+    test("buildCashOutTx encodes cashOutTokensOf", () => {
+        const tx = buildCashOutTx({
+            chainId,
+            terminal,
+            holder,
+            projectId,
+            cashOutCount: ONE_ETHER,
+            tokenToReclaim: NATIVE_TOKEN,
+            beneficiary,
+        });
+        expect(tx.chainId).toEqual(chainId);
+        expect(tx.address).toEqual(terminal);
+        expect(tx.functionName).toEqual("cashOutTokensOf");
+        expect(tx.args).toEqual([
+            holder,
+            projectId,
+            ONE_ETHER,
+            NATIVE_TOKEN,
+            0n,
+            beneficiary,
+            "0x",
+        ]);
+        expect(() => encodeFunctionData(tx)).not.toThrow();
+    });
+    test("buildCashOutTx passes minTokensReclaimed and metadata through", () => {
+        const tx = buildCashOutTx({
+            chainId,
+            terminal,
+            holder,
+            projectId,
+            cashOutCount: ONE_ETHER,
+            tokenToReclaim: NATIVE_TOKEN,
+            minTokensReclaimed: 999n,
+            beneficiary,
+            metadata: "0x1234",
+        });
+        expect(tx.args[4]).toEqual(999n);
+        expect(tx.args[6]).toEqual("0x1234");
+        expect(() => encodeFunctionData(tx)).not.toThrow();
+    });
+    test("getCashOutQuote reads the terminal store and applies the 2.5% fee", async () => {
+        const calls = [];
+        const client = {
+            async readContract(params) {
+                calls.push(params);
+                return ONE_ETHER;
+            },
+        };
+        const quote = await getCashOutQuote(client, {
+            chainId,
+            projectId,
+            cashOutCount: ONE_ETHER,
+        });
+        expect(quote.reclaimAmount).toEqual(ONE_ETHER);
+        expect(quote.reclaimAmountAfterFee).toEqual(975000000000000000n);
+        expect(calls[0].address).toEqual(v6Address("JBTerminalStore", chainId));
+        expect(calls[0].abi).toBe(jbTerminalStoreAbi);
+        expect(calls[0].functionName).toEqual("currentReclaimableSurplusOf");
+        // Empty terminal/token arrays use all of the project's terminals and tokens;
+        // defaults quote 18 decimals in the native token's currency.
+        expect(calls[0].args).toEqual([projectId, ONE_ETHER, [], [], 18n, 61166n]);
+    });
+    test("getCashOutQuote respects custom decimals and currency", async () => {
+        const calls = [];
+        const client = {
+            async readContract(params) {
+                calls.push(params);
+                return 0n;
+            },
+        };
+        await getCashOutQuote(client, {
+            chainId,
+            projectId,
+            cashOutCount: ONE_ETHER,
+            decimals: 6n,
+            currency: 0x3606eb48n,
+        });
+        expect(calls[0].args).toEqual([
+            projectId,
+            ONE_ETHER,
+            [],
+            [],
+            6n,
+            0x3606eb48n,
+        ]);
+    });
+});
+//# sourceMappingURL=cashOut.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cashOut.test.js","sourceRoot":"","sources":["../../../src/v6/cashOut.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,kBAAkB,EAAE,MAAM,MAAM,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,OAAO,GAAG,QAAQ,CAAC;AACzB,MAAM,QAAQ,GAAG,4CAAqD,CAAC;AACvE,MAAM,MAAM,GAAG,4CAAqD,CAAC;AACrE,MAAM,WAAW,GAAG,4CAAqD,CAAC;AAC1E,MAAM,SAAS,GAAG,EAAE,CAAC;AAErB,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAClD,MAAM,EAAE,GAAG,cAAc,CAAC;YACxB,OAAO;YACP,QAAQ;YACR,MAAM;YACN,SAAS;YACT,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,YAAY;YAC5B,WAAW;SACZ,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACnD,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACtB,MAAM;YACN,SAAS;YACT,SAAS;YACT,YAAY;YACZ,EAAE;YACF,WAAW;YACX,IAAI;SACL,CAAC,CAAC;QACH,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACzE,MAAM,EAAE,GAAG,cAAc,CAAC;YACxB,OAAO;YACP,QAAQ;YACR,MAAM;YACN,SAAS;YACT,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,YAAY;YAC5B,kBAAkB,EAAE,IAAI;YACxB,WAAW;YACX,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QACnF,MAAM,KAAK,GAAU,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG;YACb,KAAK,CAAC,YAAY,CAAC,MAAe;gBAChC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACnB,OAAO,SAAS,CAAC;YACnB,CAAC;SACyB,CAAC;QAE7B,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE;YAC1C,OAAO;YACP,SAAS;YACT,YAAY,EAAE,SAAS;SACxB,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEjE,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,6BAA6B,CAAC,CAAC;QACrE,6EAA6E;QAC7E,6DAA6D;QAC7D,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,KAAK,GAAU,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG;YACb,KAAK,CAAC,YAAY,CAAC,MAAe;gBAChC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACnB,OAAO,EAAE,CAAC;YACZ,CAAC;SACyB,CAAC;QAE7B,MAAM,eAAe,CAAC,MAAM,EAAE;YAC5B,OAAO;YACP,SAAS;YACT,YAAY,EAAE,SAAS;YACvB,QAAQ,EAAE,EAAE;YACZ,QAAQ,EAAE,WAAW;SACtB,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,SAAS;YACT,SAAS;YACT,EAAE;YACF,EAAE;YACF,EAAE;YACF,WAAW;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,43 @@
+import { Address } from "viem";
+/**
+ * The v6 base currency id for ETH (JBCurrencyIds.ETH).
+ *
+ * Base currencies are the small standard ids (ETH = 1, USD = 2) used to denominate a
+ * ruleset's `baseCurrency` and fund access limits. They are NOT the same as
+ * accounting-context currencies, which are derived from a token's address via
+ * {@link tokenCurrencyId}. Never use an accounting-context currency (e.g. 61166 for the
+ * native token) as a ruleset `baseCurrency` to "skip the price feed" — base currency
+ * must be 1 or 2.
+ *
+ * @link https://github.com/Bananapus/nana-core-v6/blob/main/src/libraries/JBCurrencyIds.sol
+ */
+export declare const BASE_CURRENCY_ETH = 1;
+/**
+ * The v6 base currency id for USD (JBCurrencyIds.USD).
+ *
+ * See {@link BASE_CURRENCY_ETH} for the distinction between base currencies and
+ * accounting-context currencies.
+ *
+ * @link https://github.com/Bananapus/nana-core-v6/blob/main/src/libraries/JBCurrencyIds.sol
+ */
+export declare const BASE_CURRENCY_USD = 2;
+/**
+ * The accounting-context currency id of the network's native token (e.g. ETH).
+ *
+ * Equal to `uint32(uint160(0x000000000000000000000000000000000000EEEe))` = 61166.
+ * This is what {@link tokenCurrencyId} returns for the native token address.
+ */
+export declare const NATIVE_TOKEN_CURRENCY_ID = 61166;
+/**
+ * The v6 accounting-context currency id for a token: `uint32(uint160(tokenAddress))`,
+ * i.e. the lowest 4 bytes of the token's address.
+ *
+ * Use this for terminal accounting contexts (`{ token, decimals, currency }`) — NOT for
+ * a ruleset's `baseCurrency`, which must be a base currency id
+ * ({@link BASE_CURRENCY_ETH} or {@link BASE_CURRENCY_USD}).
+ *
+ * @param token The token address to derive a currency id from.
+ * @returns The token's accounting-context currency id (fits in a uint32).
+ */
+export declare function tokenCurrencyId(token: Address): number;
+//# sourceMappingURL=currency.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../../src/v6/currency.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,QAAQ,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEtD"}

package/dist/esm/v6/currency.js

@@ -0,0 +1,44 @@
+/**
+ * The v6 base currency id for ETH (JBCurrencyIds.ETH).
+ *
+ * Base currencies are the small standard ids (ETH = 1, USD = 2) used to denominate a
+ * ruleset's `baseCurrency` and fund access limits. They are NOT the same as
+ * accounting-context currencies, which are derived from a token's address via
+ * {@link tokenCurrencyId}. Never use an accounting-context currency (e.g. 61166 for the
+ * native token) as a ruleset `baseCurrency` to "skip the price feed" — base currency
+ * must be 1 or 2.
+ *
+ * @link https://github.com/Bananapus/nana-core-v6/blob/main/src/libraries/JBCurrencyIds.sol
+ */
+export const BASE_CURRENCY_ETH = 1;
+/**
+ * The v6 base currency id for USD (JBCurrencyIds.USD).
+ *
+ * See {@link BASE_CURRENCY_ETH} for the distinction between base currencies and
+ * accounting-context currencies.
+ *
+ * @link https://github.com/Bananapus/nana-core-v6/blob/main/src/libraries/JBCurrencyIds.sol
+ */
+export const BASE_CURRENCY_USD = 2;
+/**
+ * The accounting-context currency id of the network's native token (e.g. ETH).
+ *
+ * Equal to `uint32(uint160(0x000000000000000000000000000000000000EEEe))` = 61166.
+ * This is what {@link tokenCurrencyId} returns for the native token address.
+ */
+export const NATIVE_TOKEN_CURRENCY_ID = 61166;
+/**
+ * The v6 accounting-context currency id for a token: `uint32(uint160(tokenAddress))`,
+ * i.e. the lowest 4 bytes of the token's address.
+ *
+ * Use this for terminal accounting contexts (`{ token, decimals, currency }`) — NOT for
+ * a ruleset's `baseCurrency`, which must be a base currency id
+ * ({@link BASE_CURRENCY_ETH} or {@link BASE_CURRENCY_USD}).
+ *
+ * @param token The token address to derive a currency id from.
+ * @returns The token's accounting-context currency id (fits in a uint32).
+ */
+export function tokenCurrencyId(token) {
+    return Number(BigInt(token) & 0xffffffffn);
+}
+//# sourceMappingURL=currency.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../src/v6/currency.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAEnC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,CAAC;AAC7C,CAAC"}

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

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

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

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

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

@@ -0,0 +1,24 @@
+import { describe, expect, test } from "vitest";
+import { NATIVE_TOKEN } from "../constants.js";
+import { BASE_CURRENCY_ETH, BASE_CURRENCY_USD, NATIVE_TOKEN_CURRENCY_ID, tokenCurrencyId, } from "./currency.js";
+describe("currency", () => {
+    test("base currency ids", () => {
+        expect(BASE_CURRENCY_ETH).toEqual(1);
+        expect(BASE_CURRENCY_USD).toEqual(2);
+    });
+    test("tokenCurrencyId of the native token is 61166", () => {
+        expect(tokenCurrencyId(NATIVE_TOKEN)).toEqual(61166);
+        expect(tokenCurrencyId(NATIVE_TOKEN)).toEqual(NATIVE_TOKEN_CURRENCY_ID);
+    });
+    test("tokenCurrencyId is the low 32 bits of the address", () => {
+        // Mainnet USDC; low 4 bytes are 0x3606eb48.
+        expect(tokenCurrencyId("0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48")).toEqual(0x3606eb48);
+    });
+    test("tokenCurrencyId of the zero address is 0", () => {
+        expect(tokenCurrencyId("0x0000000000000000000000000000000000000000")).toEqual(0);
+    });
+    test("tokenCurrencyId fits in a uint32 even for high addresses", () => {
+        expect(tokenCurrencyId("0xffffffffffffffffffffffffffffffffffffffff")).toEqual(0xffffffff);
+    });
+});
+//# sourceMappingURL=currency.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"currency.test.js","sourceRoot":"","sources":["../../../src/v6/currency.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,eAAe,GAChB,MAAM,eAAe,CAAC;AAEvB,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,IAAI,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC7B,MAAM,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC7D,4CAA4C;QAC5C,MAAM,CACJ,eAAe,CAAC,4CAA4C,CAAC,CAC9D,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACpD,MAAM,CACJ,eAAe,CAAC,4CAA4C,CAAC,CAC9D,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;QACpE,MAAM,CACJ,eAAe,CAAC,4CAA4C,CAAC,CAC9D,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,43 @@
+/**
+ * The Juicebox protocol fee, as a decimal fraction: 2.5%.
+ *
+ * Applies to payouts sent outside the protocol and to cash outs from rulesets with a
+ * non-zero cash out tax rate.
+ */
+export declare const PROTOCOL_FEE_PERCENT = 0.025;
+/**
+ * The standard protocol fee expressed out of {@link MAX_FEE}: 25 / 1000 = 2.5%.
+ *
+ * @link JBMultiTerminal.sol `FEE`
+ */
+export declare const STANDARD_FEE = 25n;
+/**
+ * The denominator for {@link STANDARD_FEE}-style fee percents.
+ */
+export declare const MAX_FEE = 1000n;
+/**
+ * The standard 2.5% protocol fee expressed per billion (out of 1e9), for legacy-style
+ * fixed-point math: 25_000_000 / 1_000_000_000 = 2.5%.
+ */
+export declare const TERMINAL_FEE_PER_BILLION = 25000000n;
+/**
+ * The fee taken from `amount`, rounded down.
+ *
+ * @param amount The gross amount the fee is taken from.
+ * @param feePerBillion The fee rate out of 1e9. Defaults to the standard 2.5% protocol
+ * fee ({@link TERMINAL_FEE_PER_BILLION}).
+ * @returns The fee, in the same fixed-point representation as `amount`.
+ */
+export declare function feeForAmount(amount: bigint, feePerBillion?: bigint): bigint;
+/**
+ * The amount left over once the fee has been taken from `amount`.
+ *
+ * Guaranteed to satisfy `amountAfterFee(x) + feeForAmount(x) === x`.
+ *
+ * @param amount The gross amount the fee is taken from.
+ * @param feePerBillion The fee rate out of 1e9. Defaults to the standard 2.5% protocol
+ * fee ({@link TERMINAL_FEE_PER_BILLION}).
+ * @returns The net amount after the fee.
+ */
+export declare function amountAfterFee(amount: bigint, feePerBillion?: bigint): bigint;
+//# sourceMappingURL=fees.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fees.d.ts","sourceRoot":"","sources":["../../../src/v6/fees.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,QAAQ,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,YAAY,MAAM,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,OAAO,QAAQ,CAAC;AAE7B;;;GAGG;AACH,eAAO,MAAM,wBAAwB,YAAc,CAAC;AAOpD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,aAAa,GAAE,MAAiC,GAC/C,MAAM,CAER;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,aAAa,GAAE,MAAiC,GAC/C,MAAM,CAER"}

package/dist/esm/v6/fees.js

@@ -0,0 +1,51 @@
+/**
+ * The Juicebox protocol fee, as a decimal fraction: 2.5%.
+ *
+ * Applies to payouts sent outside the protocol and to cash outs from rulesets with a
+ * non-zero cash out tax rate.
+ */
+export const PROTOCOL_FEE_PERCENT = 0.025;
+/**
+ * The standard protocol fee expressed out of {@link MAX_FEE}: 25 / 1000 = 2.5%.
+ *
+ * @link JBMultiTerminal.sol `FEE`
+ */
+export const STANDARD_FEE = 25n;
+/**
+ * The denominator for {@link STANDARD_FEE}-style fee percents.
+ */
+export const MAX_FEE = 1000n;
+/**
+ * The standard 2.5% protocol fee expressed per billion (out of 1e9), for legacy-style
+ * fixed-point math: 25_000_000 / 1_000_000_000 = 2.5%.
+ */
+export const TERMINAL_FEE_PER_BILLION = 25000000n;
+/**
+ * The per-billion fee denominator (1e9).
+ */
+const PER_BILLION = 1000000000n;
+/**
+ * The fee taken from `amount`, rounded down.
+ *
+ * @param amount The gross amount the fee is taken from.
+ * @param feePerBillion The fee rate out of 1e9. Defaults to the standard 2.5% protocol
+ * fee ({@link TERMINAL_FEE_PER_BILLION}).
+ * @returns The fee, in the same fixed-point representation as `amount`.
+ */
+export function feeForAmount(amount, feePerBillion = TERMINAL_FEE_PER_BILLION) {
+    return (amount * feePerBillion) / PER_BILLION;
+}
+/**
+ * The amount left over once the fee has been taken from `amount`.
+ *
+ * Guaranteed to satisfy `amountAfterFee(x) + feeForAmount(x) === x`.
+ *
+ * @param amount The gross amount the fee is taken from.
+ * @param feePerBillion The fee rate out of 1e9. Defaults to the standard 2.5% protocol
+ * fee ({@link TERMINAL_FEE_PER_BILLION}).
+ * @returns The net amount after the fee.
+ */
+export function amountAfterFee(amount, feePerBillion = TERMINAL_FEE_PER_BILLION) {
+    return amount - feeForAmount(amount, feePerBillion);
+}
+//# sourceMappingURL=fees.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fees.js","sourceRoot":"","sources":["../../../src/v6/fees.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAE1C;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC;AAEhC;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,CAAC;AAE7B;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,SAAW,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,GAAG,WAAc,CAAC;AAEnC;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAc,EACd,gBAAwB,wBAAwB;IAEhD,OAAO,CAAC,MAAM,GAAG,aAAa,CAAC,GAAG,WAAW,CAAC;AAChD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAc,EACd,gBAAwB,wBAAwB;IAEhD,OAAO,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AACtD,CAAC"}

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

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

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

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

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

@@ -0,0 +1,38 @@
+import { describe, expect, test } from "vitest";
+import { ONE_ETHER } from "../constants.js";
+import { applyJbDaoCashOutFee } from "../utils/fee.js";
+import { MAX_FEE, STANDARD_FEE, TERMINAL_FEE_PER_BILLION, amountAfterFee, feeForAmount, } from "./fees.js";
+describe("fees", () => {
+    test("constants agree on 2.5%", () => {
+        expect(STANDARD_FEE).toEqual(25n);
+        expect(MAX_FEE).toEqual(1000n);
+        expect((STANDARD_FEE * 1000000000n) / MAX_FEE).toEqual(TERMINAL_FEE_PER_BILLION);
+    });
+    test("feeForAmount takes 2.5% by default", () => {
+        expect(feeForAmount(ONE_ETHER)).toEqual(25000000000000000n);
+        expect(feeForAmount(1000000000n)).toEqual(25000000n);
+    });
+    test("amountAfterFee leaves 97.5% by default", () => {
+        expect(amountAfterFee(ONE_ETHER)).toEqual(975000000000000000n);
+        expect(amountAfterFee(ONE_ETHER)).toEqual(applyJbDaoCashOutFee(ONE_ETHER));
+    });
+    test("fee + net always equals the gross amount", () => {
+        for (const amount of [0n, 1n, 39n, 40n, 41n, ONE_ETHER, ONE_ETHER + 1n]) {
+            expect(feeForAmount(amount) + amountAfterFee(amount)).toEqual(amount);
+        }
+    });
+    test("fee rounds down; tiny amounts pay no fee", () => {
+        expect(feeForAmount(39n)).toEqual(0n);
+        expect(amountAfterFee(39n)).toEqual(39n);
+        expect(feeForAmount(40n)).toEqual(1n);
+    });
+    test("custom fee rates", () => {
+        // 10% per billion.
+        expect(feeForAmount(ONE_ETHER, 100000000n)).toEqual(100000000000000000n);
+        expect(amountAfterFee(ONE_ETHER, 100000000n)).toEqual(900000000000000000n);
+        // Zero fee.
+        expect(feeForAmount(ONE_ETHER, 0n)).toEqual(0n);
+        expect(amountAfterFee(ONE_ETHER, 0n)).toEqual(ONE_ETHER);
+    });
+});
+//# sourceMappingURL=fees.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fees.test.js","sourceRoot":"","sources":["../../../src/v6/fees.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EACL,OAAO,EACP,YAAY,EACZ,wBAAwB,EACxB,cAAc,EACd,YAAY,GACb,MAAM,WAAW,CAAC;AAEnB,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IACpB,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACnC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,CAAC,CAAC,YAAY,GAAG,WAAc,CAAC,GAAG,OAAO,CAAC,CAAC,OAAO,CACvD,wBAAwB,CACzB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC5D,MAAM,CAAC,YAAY,CAAC,WAAc,CAAC,CAAC,CAAC,OAAO,CAAC,SAAW,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC/D,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACpD,KAAK,MAAM,MAAM,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,GAAG,EAAE,CAAC,EAAE,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACxE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC5B,mBAAmB;QACnB,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,UAAY,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC3E,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,UAAY,CAAC,CAAC,CAAC,OAAO,CACrD,mBAAmB,CACpB,CAAC;QACF,YAAY;QACZ,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,16 @@
+export * from "./types.js";
+export * from "./currency.js";
+export * from "./fees.js";
+export * from "./launch.js";
+export * from "./omnichain.js";
+export * from "./rulesets.js";
+export * from "./splits.js";
+export * from "./revnets.js";
+export * from "./terminals.js";
+export * from "./pay.js";
+export * from "./cashOut.js";
+export * from "./tokens.js";
+export * from "./permissions.js";
+export * from "./suckers.js";
+export * from "./loans.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v6/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}

package/dist/esm/v6/index.js

@@ -0,0 +1,16 @@
+export * from "./types.js";
+export * from "./currency.js";
+export * from "./fees.js";
+export * from "./launch.js";
+export * from "./omnichain.js";
+export * from "./rulesets.js";
+export * from "./splits.js";
+export * from "./revnets.js";
+export * from "./terminals.js";
+export * from "./pay.js";
+export * from "./cashOut.js";
+export * from "./tokens.js";
+export * from "./permissions.js";
+export * from "./suckers.js";
+export * from "./loans.js";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v6/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}