@bananapus/nana-sdk-core 1.0.0 → 1.1.1

package/dist/cjs/v6/tokens.d.ts

@@ -0,0 +1,194 @@
+import { Address, Hex, PublicClient } from "viem";
+import { jbControllerAbi } from "../generated/juicebox.js";
+import { JBChainId } from "../types.js";
+/**
+ * A prepared `deployERC20For` transaction request.
+ */
+export interface V6DeployErc20TxRequest {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof jbControllerAbi;
+    functionName: "deployERC20For";
+    args: readonly [bigint, string, string, Hex];
+}
+/**
+ * Build a `JBController.deployERC20For(projectId, name, symbol, salt)` transaction
+ * request, deploying a claimable ERC-20 for a project's tokens.
+ *
+ * Requires the project owner or the DEPLOY_ERC20 permission.
+ *
+ * @param args.chainId The chain to deploy on.
+ * @param args.projectId The project's id.
+ * @param args.name The ERC-20's name.
+ * @param args.symbol The ERC-20's symbol.
+ * @param args.salt A CREATE2 salt. Use the same non-zero salt (from the same deployer)
+ * across chains for a same-address omnichain ERC-20. Defaults to zero (non-deterministic
+ * address).
+ * @returns The transaction request.
+ */
+export declare function buildDeployErc20Tx({ chainId, projectId, name, symbol, salt, }: {
+    chainId: JBChainId;
+    projectId: bigint;
+    name: string;
+    symbol: string;
+    salt?: Hex;
+}): V6DeployErc20TxRequest;
+/**
+ * A prepared `claimTokensFor` transaction request.
+ */
+export interface V6ClaimTokensTxRequest {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof jbControllerAbi;
+    functionName: "claimTokensFor";
+    args: readonly [Address, bigint, bigint, Address];
+}
+/**
+ * Build a `JBController.claimTokensFor(holder, projectId, tokenCount, beneficiary)`
+ * transaction request, claiming a holder's internal token credits as ERC-20 tokens.
+ *
+ * The project must have an ERC-20 deployed (see {@link buildDeployErc20Tx}). Claiming
+ * for another holder requires the CLAIM_TOKENS permission.
+ *
+ * @param args.chainId The chain to claim on.
+ * @param args.holder The address whose credits are being claimed.
+ * @param args.projectId The project's id.
+ * @param args.tokenCount The number of credits to claim, as a fixed point number with
+ * 18 decimals.
+ * @param args.beneficiary The address that receives the ERC-20 tokens.
+ * @returns The transaction request.
+ */
+export declare function buildClaimTokensTx({ chainId, holder, projectId, tokenCount, beneficiary, }: {
+    chainId: JBChainId;
+    holder: Address;
+    projectId: bigint;
+    tokenCount: bigint;
+    beneficiary: Address;
+}): V6ClaimTokensTxRequest;
+/**
+ * A prepared `transferCreditsFrom` transaction request.
+ */
+export interface V6TransferCreditsTxRequest {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof jbControllerAbi;
+    functionName: "transferCreditsFrom";
+    args: readonly [Address, bigint, Address, bigint];
+}
+/**
+ * Build a `JBController.transferCreditsFrom(holder, projectId, recipient,
+ * creditCount)` transaction request, transferring internal token credits (unclaimed
+ * tokens) to another address.
+ *
+ * Transferring another holder's credits requires the TRANSFER_CREDITS permission.
+ *
+ * @param args.chainId The chain to transfer on.
+ * @param args.holder The address whose credits are being transferred.
+ * @param args.projectId The project's id.
+ * @param args.recipient The address that receives the credits.
+ * @param args.creditCount The number of credits to transfer, as a fixed point number
+ * with 18 decimals.
+ * @returns The transaction request.
+ */
+export declare function buildTransferCreditsTx({ chainId, holder, projectId, recipient, creditCount, }: {
+    chainId: JBChainId;
+    holder: Address;
+    projectId: bigint;
+    recipient: Address;
+    creditCount: bigint;
+}): V6TransferCreditsTxRequest;
+/**
+ * A prepared `mintTokensOf` transaction request.
+ */
+export interface V6MintTokensTxRequest {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof jbControllerAbi;
+    functionName: "mintTokensOf";
+    args: readonly [bigint, bigint, Address, string, boolean];
+}
+/**
+ * Build a `JBController.mintTokensOf(projectId, tokenCount, beneficiary, memo,
+ * useReservedPercent)` transaction request, minting new project tokens.
+ *
+ * Only works when the project's ruleset allows owner minting; requires the project
+ * owner or the MINT_TOKENS permission.
+ *
+ * @param args.chainId The chain to mint on.
+ * @param args.projectId The project's id.
+ * @param args.tokenCount The number of tokens to mint, as a fixed point number with 18
+ * decimals.
+ * @param args.beneficiary The address that receives the minted tokens.
+ * @param args.memo A memo included in the MintTokens event. Defaults to "".
+ * @param args.useReservedPercent Whether the ruleset's reserved percent should be
+ * withheld from the mint for the project's reserved splits. Defaults to true.
+ * @returns The transaction request.
+ */
+export declare function buildMintTokensTx({ chainId, projectId, tokenCount, beneficiary, memo, useReservedPercent, }: {
+    chainId: JBChainId;
+    projectId: bigint;
+    tokenCount: bigint;
+    beneficiary: Address;
+    memo?: string;
+    useReservedPercent?: boolean;
+}): V6MintTokensTxRequest;
+/**
+ * A prepared `burnTokensOf` transaction request.
+ */
+export interface V6BurnTokensTxRequest {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof jbControllerAbi;
+    functionName: "burnTokensOf";
+    args: readonly [Address, bigint, bigint, string];
+}
+/**
+ * Build a `JBController.burnTokensOf(holder, projectId, tokenCount, memo)` transaction
+ * request, burning a holder's project tokens.
+ *
+ * Burning another holder's tokens requires the BURN_TOKENS permission.
+ *
+ * @param args.chainId The chain to burn on.
+ * @param args.holder The address whose tokens are being burned.
+ * @param args.projectId The project's id.
+ * @param args.tokenCount The number of tokens to burn, as a fixed point number with 18
+ * decimals.
+ * @param args.memo A memo included in the BurnTokens event. Defaults to "".
+ * @returns The transaction request.
+ */
+export declare function buildBurnTokensTx({ chainId, holder, projectId, tokenCount, memo, }: {
+    chainId: JBChainId;
+    holder: Address;
+    projectId: bigint;
+    tokenCount: bigint;
+    memo?: string;
+}): V6BurnTokensTxRequest;
+/**
+ * Read a project's ERC-20 token address via `JBTokens.tokenOf(projectId)`.
+ *
+ * @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 token address, or null when the project has no ERC-20 deployed (token
+ * balances are held as internal credits).
+ */
+export declare function getTokenAddress(client: PublicClient, { chainId, projectId, }: {
+    chainId: JBChainId;
+    projectId: bigint;
+}): Promise<Address | null>;
+/**
+ * Read a holder's internal token credit balance (unclaimed tokens) via
+ * `JBTokens.creditBalanceOf(holder, projectId)`.
+ *
+ * @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.
+ * @param args.holder The holder to read the credit balance of.
+ * @returns The holder's credit balance, as a fixed point number with 18 decimals.
+ */
+export declare function getCreditBalance(client: PublicClient, { chainId, projectId, holder, }: {
+    chainId: JBChainId;
+    projectId: bigint;
+    holder: Address;
+}): Promise<bigint>;
+//# sourceMappingURL=tokens.d.ts.map

package/dist/cjs/v6/tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../../src/v6/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAyB,MAAM,MAAM,CAAC;AACzE,OAAO,EAAE,eAAe,EAAe,MAAM,0BAA0B,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,eAAe,CAAC;IAC5B,YAAY,EAAE,gBAAgB,CAAC;IAC/B,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,SAAS,EACT,IAAI,EACJ,MAAM,EACN,IAAe,GAChB,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,GAAG,sBAAsB,CAQzB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,eAAe,CAAC;IAC5B,YAAY,EAAE,gBAAgB,CAAC;IAC/B,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;CACnD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,MAAM,EACN,SAAS,EACT,UAAU,EACV,WAAW,GACZ,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;CACtB,GAAG,sBAAsB,CAQzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,eAAe,CAAC;IAC5B,YAAY,EAAE,qBAAqB,CAAC;IACpC,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;CACnD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,OAAO,EACP,MAAM,EACN,SAAS,EACT,SAAS,EACT,WAAW,GACZ,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,GAAG,0BAA0B,CAQ7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,eAAe,CAAC;IAC5B,YAAY,EAAE,cAAc,CAAC;IAC7B,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,OAAO,EACP,SAAS,EACT,UAAU,EACV,WAAW,EACX,IAAS,EACT,kBAAyB,GAC1B,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,GAAG,qBAAqB,CAQxB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,eAAe,CAAC;IAC5B,YAAY,EAAE,cAAc,CAAC;IAC7B,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CAClD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,OAAO,EACP,MAAM,EACN,SAAS,EACT,UAAU,EACV,IAAS,GACV,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GAAG,qBAAqB,CAQxB;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,YAAY,EACpB,EACE,OAAO,EACP,SAAS,GACV,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB,GACA,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CASzB;AAED;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,YAAY,EACpB,EACE,OAAO,EACP,SAAS,EACT,MAAM,GACP,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;CACjB,GACA,OAAO,CAAC,MAAM,CAAC,CAOjB"}

package/dist/cjs/v6/tokens.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDeployErc20Tx = buildDeployErc20Tx;
+exports.buildClaimTokensTx = buildClaimTokensTx;
+exports.buildTransferCreditsTx = buildTransferCreditsTx;
+exports.buildMintTokensTx = buildMintTokensTx;
+exports.buildBurnTokensTx = buildBurnTokensTx;
+exports.getTokenAddress = getTokenAddress;
+exports.getCreditBalance = getCreditBalance;
+const viem_1 = require("viem");
+const juicebox_js_1 = require("../generated/juicebox.js");
+const types_js_1 = require("./types.js");
+/**
+ * Build a `JBController.deployERC20For(projectId, name, symbol, salt)` transaction
+ * request, deploying a claimable ERC-20 for a project's tokens.
+ *
+ * Requires the project owner or the DEPLOY_ERC20 permission.
+ *
+ * @param args.chainId The chain to deploy on.
+ * @param args.projectId The project's id.
+ * @param args.name The ERC-20's name.
+ * @param args.symbol The ERC-20's symbol.
+ * @param args.salt A CREATE2 salt. Use the same non-zero salt (from the same deployer)
+ * across chains for a same-address omnichain ERC-20. Defaults to zero (non-deterministic
+ * address).
+ * @returns The transaction request.
+ */
+function buildDeployErc20Tx({ chainId, projectId, name, symbol, salt = viem_1.zeroHash, }) {
+    return {
+        chainId,
+        address: (0, types_js_1.v6Address)("JBController", chainId),
+        abi: juicebox_js_1.jbControllerAbi,
+        functionName: "deployERC20For",
+        args: [projectId, name, symbol, salt],
+    };
+}
+/**
+ * Build a `JBController.claimTokensFor(holder, projectId, tokenCount, beneficiary)`
+ * transaction request, claiming a holder's internal token credits as ERC-20 tokens.
+ *
+ * The project must have an ERC-20 deployed (see {@link buildDeployErc20Tx}). Claiming
+ * for another holder requires the CLAIM_TOKENS permission.
+ *
+ * @param args.chainId The chain to claim on.
+ * @param args.holder The address whose credits are being claimed.
+ * @param args.projectId The project's id.
+ * @param args.tokenCount The number of credits to claim, as a fixed point number with
+ * 18 decimals.
+ * @param args.beneficiary The address that receives the ERC-20 tokens.
+ * @returns The transaction request.
+ */
+function buildClaimTokensTx({ chainId, holder, projectId, tokenCount, beneficiary, }) {
+    return {
+        chainId,
+        address: (0, types_js_1.v6Address)("JBController", chainId),
+        abi: juicebox_js_1.jbControllerAbi,
+        functionName: "claimTokensFor",
+        args: [holder, projectId, tokenCount, beneficiary],
+    };
+}
+/**
+ * Build a `JBController.transferCreditsFrom(holder, projectId, recipient,
+ * creditCount)` transaction request, transferring internal token credits (unclaimed
+ * tokens) to another address.
+ *
+ * Transferring another holder's credits requires the TRANSFER_CREDITS permission.
+ *
+ * @param args.chainId The chain to transfer on.
+ * @param args.holder The address whose credits are being transferred.
+ * @param args.projectId The project's id.
+ * @param args.recipient The address that receives the credits.
+ * @param args.creditCount The number of credits to transfer, as a fixed point number
+ * with 18 decimals.
+ * @returns The transaction request.
+ */
+function buildTransferCreditsTx({ chainId, holder, projectId, recipient, creditCount, }) {
+    return {
+        chainId,
+        address: (0, types_js_1.v6Address)("JBController", chainId),
+        abi: juicebox_js_1.jbControllerAbi,
+        functionName: "transferCreditsFrom",
+        args: [holder, projectId, recipient, creditCount],
+    };
+}
+/**
+ * Build a `JBController.mintTokensOf(projectId, tokenCount, beneficiary, memo,
+ * useReservedPercent)` transaction request, minting new project tokens.
+ *
+ * Only works when the project's ruleset allows owner minting; requires the project
+ * owner or the MINT_TOKENS permission.
+ *
+ * @param args.chainId The chain to mint on.
+ * @param args.projectId The project's id.
+ * @param args.tokenCount The number of tokens to mint, as a fixed point number with 18
+ * decimals.
+ * @param args.beneficiary The address that receives the minted tokens.
+ * @param args.memo A memo included in the MintTokens event. Defaults to "".
+ * @param args.useReservedPercent Whether the ruleset's reserved percent should be
+ * withheld from the mint for the project's reserved splits. Defaults to true.
+ * @returns The transaction request.
+ */
+function buildMintTokensTx({ chainId, projectId, tokenCount, beneficiary, memo = "", useReservedPercent = true, }) {
+    return {
+        chainId,
+        address: (0, types_js_1.v6Address)("JBController", chainId),
+        abi: juicebox_js_1.jbControllerAbi,
+        functionName: "mintTokensOf",
+        args: [projectId, tokenCount, beneficiary, memo, useReservedPercent],
+    };
+}
+/**
+ * Build a `JBController.burnTokensOf(holder, projectId, tokenCount, memo)` transaction
+ * request, burning a holder's project tokens.
+ *
+ * Burning another holder's tokens requires the BURN_TOKENS permission.
+ *
+ * @param args.chainId The chain to burn on.
+ * @param args.holder The address whose tokens are being burned.
+ * @param args.projectId The project's id.
+ * @param args.tokenCount The number of tokens to burn, as a fixed point number with 18
+ * decimals.
+ * @param args.memo A memo included in the BurnTokens event. Defaults to "".
+ * @returns The transaction request.
+ */
+function buildBurnTokensTx({ chainId, holder, projectId, tokenCount, memo = "", }) {
+    return {
+        chainId,
+        address: (0, types_js_1.v6Address)("JBController", chainId),
+        abi: juicebox_js_1.jbControllerAbi,
+        functionName: "burnTokensOf",
+        args: [holder, projectId, tokenCount, memo],
+    };
+}
+/**
+ * Read a project's ERC-20 token address via `JBTokens.tokenOf(projectId)`.
+ *
+ * @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 token address, or null when the project has no ERC-20 deployed (token
+ * balances are held as internal credits).
+ */
+async function getTokenAddress(client, { chainId, projectId, }) {
+    const token = await client.readContract({
+        address: (0, types_js_1.v6Address)("JBTokens", chainId),
+        abi: juicebox_js_1.jbTokensAbi,
+        functionName: "tokenOf",
+        args: [projectId],
+    });
+    return token === viem_1.zeroAddress ? null : token;
+}
+/**
+ * Read a holder's internal token credit balance (unclaimed tokens) via
+ * `JBTokens.creditBalanceOf(holder, projectId)`.
+ *
+ * @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.
+ * @param args.holder The holder to read the credit balance of.
+ * @returns The holder's credit balance, as a fixed point number with 18 decimals.
+ */
+async function getCreditBalance(client, { chainId, projectId, holder, }) {
+    return client.readContract({
+        address: (0, types_js_1.v6Address)("JBTokens", chainId),
+        abi: juicebox_js_1.jbTokensAbi,
+        functionName: "creditBalanceOf",
+        args: [holder, projectId],
+    });
+}
+//# sourceMappingURL=tokens.js.map

package/dist/cjs/v6/tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../../src/v6/tokens.ts"],"names":[],"mappings":";;AA+BA,gDAoBC;AA4BD,gDAoBC;AA4BD,wDAoBC;AA8BD,8CAsBC;AA2BD,8CAoBC;AAWD,0CAkBC;AAYD,4CAkBC;AAjTD,+BAAyE;AACzE,0DAAwE;AAExE,yCAAuC;AAavC;;;;;;;;;;;;;;GAcG;AACH,SAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,SAAS,EACT,IAAI,EACJ,MAAM,EACN,IAAI,GAAG,eAAQ,GAOhB;IACC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC;QAC3C,GAAG,EAAE,6BAAe;QACpB,YAAY,EAAE,gBAAgB;QAC9B,IAAI,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC;KACtC,CAAC;AACJ,CAAC;AAaD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,MAAM,EACN,SAAS,EACT,UAAU,EACV,WAAW,GAOZ;IACC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC;QAC3C,GAAG,EAAE,6BAAe;QACpB,YAAY,EAAE,gBAAgB;QAC9B,IAAI,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC;KACnD,CAAC;AACJ,CAAC;AAaD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,sBAAsB,CAAC,EACrC,OAAO,EACP,MAAM,EACN,SAAS,EACT,SAAS,EACT,WAAW,GAOZ;IACC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC;QAC3C,GAAG,EAAE,6BAAe;QACpB,YAAY,EAAE,qBAAqB;QACnC,IAAI,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC;KAClD,CAAC;AACJ,CAAC;AAaD;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,iBAAiB,CAAC,EAChC,OAAO,EACP,SAAS,EACT,UAAU,EACV,WAAW,EACX,IAAI,GAAG,EAAE,EACT,kBAAkB,GAAG,IAAI,GAQ1B;IACC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC;QAC3C,GAAG,EAAE,6BAAe;QACpB,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,kBAAkB,CAAC;KACrE,CAAC;AACJ,CAAC;AAaD;;;;;;;;;;;;;GAaG;AACH,SAAgB,iBAAiB,CAAC,EAChC,OAAO,EACP,MAAM,EACN,SAAS,EACT,UAAU,EACV,IAAI,GAAG,EAAE,GAOV;IACC,OAAO;QACL,OAAO;QACP,OAAO,EAAE,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC;QAC3C,GAAG,EAAE,6BAAe;QACpB,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC;KAC5C,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,eAAe,CACnC,MAAoB,EACpB,EACE,OAAO,EACP,SAAS,GAIV;IAED,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;QACtC,OAAO,EAAE,IAAA,oBAAS,EAAC,UAAU,EAAE,OAAO,CAAC;QACvC,GAAG,EAAE,yBAAW;QAChB,YAAY,EAAE,SAAS;QACvB,IAAI,EAAE,CAAC,SAAS,CAAC;KAClB,CAAC,CAAC;IAEH,OAAO,KAAK,KAAK,kBAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AAC9C,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,gBAAgB,CACpC,MAAoB,EACpB,EACE,OAAO,EACP,SAAS,EACT,MAAM,GAKP;IAED,OAAO,MAAM,CAAC,YAAY,CAAC;QACzB,OAAO,EAAE,IAAA,oBAAS,EAAC,UAAU,EAAE,OAAO,CAAC;QACvC,GAAG,EAAE,yBAAW;QAChB,YAAY,EAAE,iBAAiB;QAC/B,IAAI,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;KAC1B,CAAC,CAAC;AACL,CAAC"}

package/dist/cjs/v6/tokens.test.d.ts

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

package/dist/cjs/v6/tokens.test.d.ts.map

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

package/dist/cjs/v6/tokens.test.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const viem_1 = require("viem");
+const vitest_1 = require("vitest");
+const constants_js_1 = require("../constants.js");
+const juicebox_js_1 = require("../generated/juicebox.js");
+const tokens_js_1 = require("./tokens.js");
+const types_js_1 = require("./types.js");
+const chainId = 11155111;
+const projectId = 3n;
+const holder = "0x1111111111111111111111111111111111111111";
+const beneficiary = "0x2222222222222222222222222222222222222222";
+(0, vitest_1.describe)("tokens", () => {
+    (0, vitest_1.test)("buildDeployErc20Tx encodes deployERC20For", () => {
+        const tx = (0, tokens_js_1.buildDeployErc20Tx)({
+            chainId,
+            projectId,
+            name: "Token",
+            symbol: "TKN",
+        });
+        (0, vitest_1.expect)(tx.address).toEqual((0, types_js_1.v6Address)("JBController", chainId));
+        (0, vitest_1.expect)(tx.functionName).toEqual("deployERC20For");
+        (0, vitest_1.expect)(tx.args).toEqual([projectId, "Token", "TKN", viem_1.zeroHash]);
+        (0, vitest_1.expect)(() => (0, viem_1.encodeFunctionData)(tx)).not.toThrow();
+    });
+    (0, vitest_1.test)("buildDeployErc20Tx passes a custom salt through", () => {
+        const salt = `0x${"11".repeat(32)}`;
+        const tx = (0, tokens_js_1.buildDeployErc20Tx)({
+            chainId,
+            projectId,
+            name: "Token",
+            symbol: "TKN",
+            salt,
+        });
+        (0, vitest_1.expect)(tx.args[3]).toEqual(salt);
+    });
+    (0, vitest_1.test)("buildClaimTokensTx encodes claimTokensFor", () => {
+        const tx = (0, tokens_js_1.buildClaimTokensTx)({
+            chainId,
+            holder,
+            projectId,
+            tokenCount: constants_js_1.ONE_ETHER,
+            beneficiary,
+        });
+        (0, vitest_1.expect)(tx.address).toEqual((0, types_js_1.v6Address)("JBController", chainId));
+        (0, vitest_1.expect)(tx.functionName).toEqual("claimTokensFor");
+        (0, vitest_1.expect)(tx.args).toEqual([holder, projectId, constants_js_1.ONE_ETHER, beneficiary]);
+        (0, vitest_1.expect)(() => (0, viem_1.encodeFunctionData)(tx)).not.toThrow();
+    });
+    (0, vitest_1.test)("buildTransferCreditsTx encodes transferCreditsFrom", () => {
+        const tx = (0, tokens_js_1.buildTransferCreditsTx)({
+            chainId,
+            holder,
+            projectId,
+            recipient: beneficiary,
+            creditCount: constants_js_1.ONE_ETHER,
+        });
+        (0, vitest_1.expect)(tx.address).toEqual((0, types_js_1.v6Address)("JBController", chainId));
+        (0, vitest_1.expect)(tx.functionName).toEqual("transferCreditsFrom");
+        (0, vitest_1.expect)(tx.args).toEqual([holder, projectId, beneficiary, constants_js_1.ONE_ETHER]);
+        (0, vitest_1.expect)(() => (0, viem_1.encodeFunctionData)(tx)).not.toThrow();
+    });
+    (0, vitest_1.test)("buildMintTokensTx encodes mintTokensOf with defaults", () => {
+        const tx = (0, tokens_js_1.buildMintTokensTx)({
+            chainId,
+            projectId,
+            tokenCount: constants_js_1.ONE_ETHER,
+            beneficiary,
+        });
+        (0, vitest_1.expect)(tx.address).toEqual((0, types_js_1.v6Address)("JBController", chainId));
+        (0, vitest_1.expect)(tx.functionName).toEqual("mintTokensOf");
+        (0, vitest_1.expect)(tx.args).toEqual([projectId, constants_js_1.ONE_ETHER, beneficiary, "", true]);
+        (0, vitest_1.expect)(() => (0, viem_1.encodeFunctionData)(tx)).not.toThrow();
+    });
+    (0, vitest_1.test)("buildMintTokensTx can skip the reserved percent", () => {
+        const tx = (0, tokens_js_1.buildMintTokensTx)({
+            chainId,
+            projectId,
+            tokenCount: constants_js_1.ONE_ETHER,
+            beneficiary,
+            memo: "gm",
+            useReservedPercent: false,
+        });
+        (0, vitest_1.expect)(tx.args).toEqual([projectId, constants_js_1.ONE_ETHER, beneficiary, "gm", false]);
+    });
+    (0, vitest_1.test)("buildBurnTokensTx encodes burnTokensOf", () => {
+        const tx = (0, tokens_js_1.buildBurnTokensTx)({
+            chainId,
+            holder,
+            projectId,
+            tokenCount: constants_js_1.ONE_ETHER,
+        });
+        (0, vitest_1.expect)(tx.address).toEqual((0, types_js_1.v6Address)("JBController", chainId));
+        (0, vitest_1.expect)(tx.functionName).toEqual("burnTokensOf");
+        (0, vitest_1.expect)(tx.args).toEqual([holder, projectId, constants_js_1.ONE_ETHER, ""]);
+        (0, vitest_1.expect)(() => (0, viem_1.encodeFunctionData)(tx)).not.toThrow();
+    });
+    (0, vitest_1.test)("getTokenAddress returns null when no ERC-20 is deployed", async () => {
+        const calls = [];
+        const client = {
+            async readContract(params) {
+                calls.push(params);
+                return viem_1.zeroAddress;
+            },
+        };
+        const token = await (0, tokens_js_1.getTokenAddress)(client, { chainId, projectId });
+        (0, vitest_1.expect)(token).toBeNull();
+        (0, vitest_1.expect)(calls[0].address).toEqual((0, types_js_1.v6Address)("JBTokens", chainId));
+        (0, vitest_1.expect)(calls[0].abi).toBe(juicebox_js_1.jbTokensAbi);
+        (0, vitest_1.expect)(calls[0].functionName).toEqual("tokenOf");
+        (0, vitest_1.expect)(calls[0].args).toEqual([projectId]);
+    });
+    (0, vitest_1.test)("getTokenAddress returns the deployed ERC-20", async () => {
+        const erc20 = "0x3333333333333333333333333333333333333333";
+        const client = {
+            async readContract() {
+                return erc20;
+            },
+        };
+        (0, vitest_1.expect)(await (0, tokens_js_1.getTokenAddress)(client, { chainId, projectId })).toEqual(erc20);
+    });
+    (0, vitest_1.test)("getCreditBalance reads creditBalanceOf(holder, projectId)", async () => {
+        const calls = [];
+        const client = {
+            async readContract(params) {
+                calls.push(params);
+                return 42n;
+            },
+        };
+        const balance = await (0, tokens_js_1.getCreditBalance)(client, {
+            chainId,
+            projectId,
+            holder,
+        });
+        (0, vitest_1.expect)(balance).toEqual(42n);
+        (0, vitest_1.expect)(calls[0].address).toEqual((0, types_js_1.v6Address)("JBTokens", chainId));
+        (0, vitest_1.expect)(calls[0].functionName).toEqual("creditBalanceOf");
+        (0, vitest_1.expect)(calls[0].args).toEqual([holder, projectId]);
+    });
+});
+//# sourceMappingURL=tokens.test.js.map

package/dist/cjs/v6/tokens.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.test.js","sourceRoot":"","sources":["../../../src/v6/tokens.test.ts"],"names":[],"mappings":";;AAAA,+BAA+E;AAC/E,mCAAgD;AAChD,kDAA4C;AAC5C,0DAAuD;AACvD,2CAQqB;AACrB,yCAAuC;AAEvC,MAAM,OAAO,GAAG,QAAQ,CAAC;AACzB,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,MAAM,MAAM,GAAG,4CAAqD,CAAC;AACrE,MAAM,WAAW,GAAG,4CAAqD,CAAC;AAE1E,IAAA,iBAAQ,EAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,IAAA,aAAI,EAAC,2CAA2C,EAAE,GAAG,EAAE;QACrD,MAAM,EAAE,GAAG,IAAA,8BAAkB,EAAC;YAC5B,OAAO;YACP,SAAS;YACT,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/D,IAAA,eAAM,EAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAClD,IAAA,eAAM,EAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,eAAQ,CAAC,CAAC,CAAC;QAC/D,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAA,yBAAkB,EAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,iDAAiD,EAAE,GAAG,EAAE;QAC3D,MAAM,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAW,CAAC;QAC7C,MAAM,EAAE,GAAG,IAAA,8BAAkB,EAAC;YAC5B,OAAO;YACP,SAAS;YACT,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,IAAI;SACL,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,2CAA2C,EAAE,GAAG,EAAE;QACrD,MAAM,EAAE,GAAG,IAAA,8BAAkB,EAAC;YAC5B,OAAO;YACP,MAAM;YACN,SAAS;YACT,UAAU,EAAE,wBAAS;YACrB,WAAW;SACZ,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/D,IAAA,eAAM,EAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAClD,IAAA,eAAM,EAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,wBAAS,EAAE,WAAW,CAAC,CAAC,CAAC;QACrE,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAA,yBAAkB,EAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,oDAAoD,EAAE,GAAG,EAAE;QAC9D,MAAM,EAAE,GAAG,IAAA,kCAAsB,EAAC;YAChC,OAAO;YACP,MAAM;YACN,SAAS;YACT,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,wBAAS;SACvB,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/D,IAAA,eAAM,EAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACvD,IAAA,eAAM,EAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,wBAAS,CAAC,CAAC,CAAC;QACrE,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAA,yBAAkB,EAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,sDAAsD,EAAE,GAAG,EAAE;QAChE,MAAM,EAAE,GAAG,IAAA,6BAAiB,EAAC;YAC3B,OAAO;YACP,SAAS;YACT,UAAU,EAAE,wBAAS;YACrB,WAAW;SACZ,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/D,IAAA,eAAM,EAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAChD,IAAA,eAAM,EAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,wBAAS,EAAE,WAAW,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;QACvE,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAA,yBAAkB,EAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,iDAAiD,EAAE,GAAG,EAAE;QAC3D,MAAM,EAAE,GAAG,IAAA,6BAAiB,EAAC;YAC3B,OAAO;YACP,SAAS;YACT,UAAU,EAAE,wBAAS;YACrB,WAAW;YACX,IAAI,EAAE,IAAI;YACV,kBAAkB,EAAE,KAAK;SAC1B,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,wBAAS,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,wCAAwC,EAAE,GAAG,EAAE;QAClD,MAAM,EAAE,GAAG,IAAA,6BAAiB,EAAC;YAC3B,OAAO;YACP,MAAM;YACN,SAAS;YACT,UAAU,EAAE,wBAAS;SACtB,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAA,oBAAS,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/D,IAAA,eAAM,EAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAChD,IAAA,eAAM,EAAC,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,wBAAS,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5D,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAA,yBAAkB,EAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACzE,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,kBAAW,CAAC;YACrB,CAAC;SACyB,CAAC;QAE7B,MAAM,KAAK,GAAG,MAAM,IAAA,2BAAe,EAAC,MAAM,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QAEpE,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;QACzB,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAA,oBAAS,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QACjE,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,yBAAW,CAAC,CAAC;QACvC,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,KAAK,GAAG,4CAA4C,CAAC;QAC3D,MAAM,MAAM,GAAG;YACb,KAAK,CAAC,YAAY;gBAChB,OAAO,KAAK,CAAC;YACf,CAAC;SACyB,CAAC;QAE7B,IAAA,eAAM,EAAC,MAAM,IAAA,2BAAe,EAAC,MAAM,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,OAAO,CACnE,KAAK,CACN,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QAC3E,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,GAAG,CAAC;YACb,CAAC;SACyB,CAAC;QAE7B,MAAM,OAAO,GAAG,MAAM,IAAA,4BAAgB,EAAC,MAAM,EAAE;YAC7C,OAAO;YACP,SAAS;YACT,MAAM;SACP,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAA,oBAAS,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QACjE,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACzD,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/v6/types.d.ts

@@ -0,0 +1,12 @@
+import { Address } from "viem";
+import { jbContractAddress } from "../generated/juicebox.js";
+import { JBChainId } from "../types.js";
+/**
+ * The contracts deployed for Juicebox v6.
+ */
+export type V6Contract = keyof (typeof jbContractAddress)["6"];
+/**
+ * The address of a v6 contract on a chain.
+ */
+export declare function v6Address(contract: V6Contract, chainId: JBChainId): Address;
+//# sourceMappingURL=types.d.ts.map

package/dist/cjs/v6/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/v6/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC;AAE/D;;GAEG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,GAAG,OAAO,CAQ3E"}

package/dist/cjs/v6/types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v6Address = v6Address;
+const juicebox_js_1 = require("../generated/juicebox.js");
+/**
+ * The address of a v6 contract on a chain.
+ */
+function v6Address(contract, chainId) {
+    const address = juicebox_js_1.jbContractAddress["6"][contract][String(chainId)];
+    if (!address) {
+        throw new Error(`No v6 ${String(contract)} deployment on chain ${chainId}`);
+    }
+    return address;
+}
+//# sourceMappingURL=types.js.map

package/dist/cjs/v6/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/v6/types.ts"],"names":[],"mappings":";;AAYA,8BAQC;AAnBD,0DAA6D;AAQ7D;;GAEG;AACH,SAAgB,SAAS,CAAC,QAAoB,EAAE,OAAkB;IAChE,MAAM,OAAO,GAAI,+BAAiB,CAAC,GAAG,CAAC,CAAC,QAAQ,CAA6B,CAC3E,MAAM,CAAC,OAAO,CAAC,CAChB,CAAC;IACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,SAAS,MAAM,CAAC,QAAQ,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

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

@@ -0,0 +1,88 @@
+import { Address, Hex, PublicClient } from "viem";
+import { jbMultiTerminalAbi } from "../generated/juicebox.js";
+import { JBChainId } from "../types.js";
+/**
+ * A prepared `cashOutTokensOf` transaction request, accepted as-is by viem's
+ * `walletClient.writeContract` and wagmi's `writeContract`.
+ */
+export interface V6CashOutTxRequest {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof jbMultiTerminalAbi;
+    functionName: "cashOutTokensOf";
+    args: readonly [Address, bigint, bigint, Address, bigint, Address, Hex];
+}
+/**
+ * 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 declare function buildCashOutTx({ chainId, terminal, holder, projectId, cashOutCount, tokenToReclaim, minTokensReclaimed, beneficiary, metadata, }: {
+    chainId: JBChainId;
+    terminal: Address;
+    holder: Address;
+    projectId: bigint;
+    cashOutCount: bigint;
+    tokenToReclaim: Address;
+    minTokensReclaimed?: bigint;
+    beneficiary: Address;
+    metadata?: Hex;
+}): V6CashOutTxRequest;
+/**
+ * A cash out quote.
+ */
+export interface CashOutQuote {
+    /**
+     * The reclaimable surplus for the cash out count, before the protocol fee.
+     */
+    reclaimAmount: bigint;
+    /**
+     * The reclaim amount net of the 2.5% protocol cash out fee.
+     *
+     * The fee only applies when the ruleset's cash out tax rate is non-zero — for
+     * zero-tax rulesets the full {@link CashOutQuote.reclaimAmount} is paid out.
+     */
+    reclaimAmountAfterFee: bigint;
+}
+/**
+ * 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.
+ *
+ * NOTE: the defaults quote in NATIVE terms (decimals 18, token-keyed native
+ * currency). For a project whose accounting token is not the native token
+ * (e.g. USDC), pass that token's `decimals` and `tokenCurrencyId(token)` to
+ * quote in its own terms and avoid a price-feed conversion.
+ */
+export declare function getCashOutQuote(client: PublicClient, { chainId, projectId, cashOutCount, decimals, currency, }: {
+    chainId: JBChainId;
+    projectId: bigint;
+    cashOutCount: bigint;
+    decimals?: bigint;
+    currency?: bigint;
+}): Promise<CashOutQuote>;
+//# sourceMappingURL=cashOut.d.ts.map