@manifoldxyz/dropkit 0.2.1 → 0.4.0

package/dist/types-BjKGb6c7.d.cts

@@ -0,0 +1,210 @@
+import { Address, Abi, Hex } from 'viem';
+
+declare const UNSUPPORTED_REASONS: readonly ["UNKNOWN_EXTENSION", "AMBIGUOUS_EXTENSION", "CLAIM_NOT_FOUND", "DROP_NOT_FOUND", "SIGNATURE_CLAIM", "INVALID_CONFIG", "CONNECT_WIDGET_TOO_OLD"];
+declare const INELIGIBLE_REASONS: readonly ["NOT_ON_ALLOWLIST", "ALLOWLIST_USED", "WALLET_LIMIT", "SIMULATION_REVERTED"];
+declare const ERROR_REASONS: readonly ["USER_REJECTED", "TX_REVERTED", "RATE_LIMITED", "RPC_ERROR", "CHAIN_SWITCH_FAILED", "ALLOWLIST_UNAVAILABLE", "BRIDGE_UNAVAILABLE", "BRIDGE_REFUNDED", "BRIDGE_FAILED", "BRIDGE_TIMEOUT"];
+/** insufficient-funds carries this reason so data-reason is never empty in that state. */
+declare const FUNDS_REASONS: readonly ["INSUFFICIENT_FUNDS"];
+type UnsupportedReason = (typeof UNSUPPORTED_REASONS)[number];
+type IneligibleReason = (typeof INELIGIBLE_REASONS)[number];
+type ErrorReason = (typeof ERROR_REASONS)[number];
+type ReasonCode = UnsupportedReason | IneligibleReason | ErrorReason | (typeof FUNDS_REASONS)[number];
+declare const REASON_CODES: readonly ReasonCode[];
+/**
+ * Thrown by adapters, rpc and wallet code; the hook maps it to the matching state.
+ * `message` is plain English and, for INVALID_CONFIG, names the exact bad field
+ * (e.g. `mint.args[1] "{qty}" is not a known placeholder`).
+ */
+declare class MintError extends Error {
+    readonly reason: ReasonCode;
+    /** INVALID_CONFIG only: dotted path of the bad field, e.g. "mint.args[1]" or "price". */
+    readonly field?: string;
+    /** 'relay' or 'tl-stacks': the message is a decoded destination revert, shown as-is. */
+    readonly domain?: 'relay' | 'tl-stacks';
+    constructor(reason: ReasonCode, message: string, opts?: {
+        field?: string;
+        cause?: unknown;
+        domain?: 'relay' | 'tl-stacks';
+    });
+}
+declare function isMintError(e: unknown): e is MintError;
+
+declare const MINT_STATES: readonly ["loading", "unsupported", "upcoming", "ended", "sold-out", "disconnected", "connecting", "live", "ineligible", "insufficient-funds", "switching-chain", "approving", "minting", "confirming", "success", "error"];
+type MintStateName = (typeof MINT_STATES)[number];
+/** States where mint() does something (spec: Clickable column). */
+declare const CLICKABLE_STATES: readonly MintStateName[];
+/** uint16 mintCount cap on Manifold extensions; also the global quantity cap. */
+declare const MAX_QUANTITY = 65535;
+
+/**
+ * Placeholders: {recipient} {payer} {quantity} {unitPrice} {totalPrice}. Integers beyond
+ * Number.MAX_SAFE_INTEGER must be bigint or a decimal string (an unsafe number is INVALID_CONFIG).
+ */
+type ArgTemplate = string | number | bigint | boolean | ArgTemplate[];
+type FieldSource = {
+    value: bigint;
+} | {
+    value: string;
+    unit: 'display';
+} | {
+    read: {
+        functionName: string;
+        args?: ArgTemplate[];
+        output?: number | string;
+    };
+};
+type Erc20Ref = {
+    address: Address;
+};
+type ManifoldClaimConfig = {
+    type: 'manifold-claim';
+    chainId: number;
+    creatorContract: Address;
+    /** Studio instance id == on-chain claim index (V6+ extensions). Decimal string. */
+    instanceId: string;
+    /** Optional; auto-discovered when omitted. */
+    extension?: Address;
+};
+type ContractConfig = {
+    type: 'contract';
+    chainId: number;
+    /** Mint call target. */
+    address: Address;
+    /** Where Transfer logs come from; defaults to address. */
+    tokenContract?: Address;
+    abi: Abi;
+    mint: {
+        functionName: string;
+        args: ArgTemplate[];
+    };
+    price: FieldSource & {
+        currency: 'native' | Erc20Ref;
+        per?: 'unit' | 'total';
+    };
+    totalMinted?: FieldSource;
+    /** 0 or absent = open edition. */
+    maxSupply?: FieldSource;
+    walletMinted?: FieldSource;
+    walletMax?: FieldSource;
+    startTime?: FieldSource;
+    endTime?: FieldSource;
+};
+type TlStacksConfig = {
+    type: 'tl-stacks';
+    chainId: number;
+    /** TL Stacks 721 v2.3.x. 0x384092784cfaa91efaa77870c04d958e20840242 on every supported chain. */
+    stacks: Address;
+    /** The TL creator contract the drop mints from. */
+    nftContract: Address;
+    /** The drop's allowlist file (TL's allowlistUrl or a copy in the same format). Required for a presale. */
+    allowlistUrl?: string;
+};
+type MintConfig = ManifoldClaimConfig | ContractConfig | TlStacksConfig;
+/** chainId -> JSON-RPC URL (agent's domain-restricted key). */
+type RpcUrls = Record<number, string>;
+type Money = {
+    value: bigint;
+    decimals: number;
+    symbol: string;
+    formatted: string;
+};
+type DropInfo = {
+    chainId: number;
+    unitPrice: Money;
+    /** Manifold MINT_FEE / MINT_FEE_MERKLE per unit (native). Zero Money for external contracts. For tl-stacks it is TL's protocol fee. */
+    unitFee: Money;
+    totalMinted: bigint;
+    /** null = open edition. */
+    maxSupply: bigint | null;
+    startTime: number | null;
+    endTime: number | null;
+    isAllowlist: boolean;
+    /** ERC20 the price is paid in; null = native. */
+    paymentToken: Address | null;
+    /** External price is per transaction ('total') rather than per unit. */
+    pricePer: 'unit' | 'total';
+    /** Unix seconds when the current sale phase ends and the price or eligibility can change. null = none before endTime. */
+    phaseEndsAt?: number | null;
+    /** When set and changed by a re-read, the button drops its wallet read and reads again before it is live. */
+    walletKey?: string;
+};
+type WalletInfo = {
+    address: Address;
+    chainId: number;
+    recipient: Address;
+    walletMinted: bigint | null;
+    walletMax: bigint | null;
+    allowlistRemaining: number | null;
+};
+type MintedToken = {
+    contract: Address;
+    tokenId: bigint;
+    amount: bigint;
+};
+type MintResult = {
+    txHash: Hex;
+    explorerUrl: string | null;
+    tokens: MintedToken[];
+    /** The quantity the collector asked for. tokens.length can be lower when the sale mints part of it. */
+    requested: number;
+    /** Set when the mint went through Relay: the deposit on the pay chain and Relay's request id. */
+    relay?: {
+        requestId: Hex;
+        originTxHash: Hex;
+        originChainId: number;
+    };
+};
+/** How the mint is paid (spec relay-cross-chain-mint #public-api). */
+type Route = {
+    kind: 'direct';
+    chainId: number;
+} | {
+    kind: 'relay';
+    /** The chain the collector pays on. */
+    originChainId: number;
+    /** What leaves the wallet on the origin chain: mint + Relay fee. */
+    amountIn: Money;
+    /** Relay's fee (fees.relayer). */
+    relayFee: Money;
+    /** Origin-chain gas Relay estimates for the deposit (fees.gas). */
+    originGas: Money;
+    /** Unix seconds. */
+    quotedAt: number;
+};
+/** Cross-chain options on useMint / MintButton. */
+type CrossChainOption = boolean | {
+    chains?: number[];
+};
+/** Immutable context frozen when mint is clicked (spec #state-management). */
+type Attempt = {
+    attemptId: number;
+    config: MintConfig;
+    payer: Address;
+    recipient: Address;
+    quantity: number;
+    chainId: number;
+    tokenContract: Address;
+    /** Chain the collector pays on; equals chainId for a direct mint. */
+    originChainId: number;
+};
+type MintEventType = 'state' | 'attempt' | 'approve-submitted' | 'tx-submitted' | 'success' | 'error';
+/** onEvent payload. No wallet address is included. */
+type MintEvent = {
+    type: MintEventType;
+    state: MintStateName;
+    reason: ReasonCode | null;
+    chainId: number;
+    txHash?: Hex;
+    quantity: number;
+    config: {
+        type: MintConfig['type'];
+        chainId: number;
+        address: Address;
+    };
+    /** 'relay' when the mint is (or would be) paid on another chain through Relay. */
+    route: 'direct' | 'relay';
+    /** Chain the collector pays on. chainId stays the drop chain. */
+    originChainId: number;
+};
+
+export { type ArgTemplate as A, type CrossChainOption as C, type DropInfo as D, type Erc20Ref as E, type FieldSource as F, type IneligibleReason as I, type ManifoldClaimConfig as M, type ReasonCode as R, type TlStacksConfig as T, type UnsupportedReason as U, type WalletInfo as W, type Money as a, type RpcUrls as b, type MintConfig as c, type MintEvent as d, type MintStateName as e, type MintResult as f, type Route as g, type Attempt as h, CLICKABLE_STATES as i, type ContractConfig as j, type ErrorReason as k, MAX_QUANTITY as l, MINT_STATES as m, MintError as n, type MintEventType as o, type MintedToken as p, REASON_CODES as q, isMintError as r };

package/dist/types-BjKGb6c7.d.ts

@@ -0,0 +1,210 @@
+import { Address, Abi, Hex } from 'viem';
+
+declare const UNSUPPORTED_REASONS: readonly ["UNKNOWN_EXTENSION", "AMBIGUOUS_EXTENSION", "CLAIM_NOT_FOUND", "DROP_NOT_FOUND", "SIGNATURE_CLAIM", "INVALID_CONFIG", "CONNECT_WIDGET_TOO_OLD"];
+declare const INELIGIBLE_REASONS: readonly ["NOT_ON_ALLOWLIST", "ALLOWLIST_USED", "WALLET_LIMIT", "SIMULATION_REVERTED"];
+declare const ERROR_REASONS: readonly ["USER_REJECTED", "TX_REVERTED", "RATE_LIMITED", "RPC_ERROR", "CHAIN_SWITCH_FAILED", "ALLOWLIST_UNAVAILABLE", "BRIDGE_UNAVAILABLE", "BRIDGE_REFUNDED", "BRIDGE_FAILED", "BRIDGE_TIMEOUT"];
+/** insufficient-funds carries this reason so data-reason is never empty in that state. */
+declare const FUNDS_REASONS: readonly ["INSUFFICIENT_FUNDS"];
+type UnsupportedReason = (typeof UNSUPPORTED_REASONS)[number];
+type IneligibleReason = (typeof INELIGIBLE_REASONS)[number];
+type ErrorReason = (typeof ERROR_REASONS)[number];
+type ReasonCode = UnsupportedReason | IneligibleReason | ErrorReason | (typeof FUNDS_REASONS)[number];
+declare const REASON_CODES: readonly ReasonCode[];
+/**
+ * Thrown by adapters, rpc and wallet code; the hook maps it to the matching state.
+ * `message` is plain English and, for INVALID_CONFIG, names the exact bad field
+ * (e.g. `mint.args[1] "{qty}" is not a known placeholder`).
+ */
+declare class MintError extends Error {
+    readonly reason: ReasonCode;
+    /** INVALID_CONFIG only: dotted path of the bad field, e.g. "mint.args[1]" or "price". */
+    readonly field?: string;
+    /** 'relay' or 'tl-stacks': the message is a decoded destination revert, shown as-is. */
+    readonly domain?: 'relay' | 'tl-stacks';
+    constructor(reason: ReasonCode, message: string, opts?: {
+        field?: string;
+        cause?: unknown;
+        domain?: 'relay' | 'tl-stacks';
+    });
+}
+declare function isMintError(e: unknown): e is MintError;
+
+declare const MINT_STATES: readonly ["loading", "unsupported", "upcoming", "ended", "sold-out", "disconnected", "connecting", "live", "ineligible", "insufficient-funds", "switching-chain", "approving", "minting", "confirming", "success", "error"];
+type MintStateName = (typeof MINT_STATES)[number];
+/** States where mint() does something (spec: Clickable column). */
+declare const CLICKABLE_STATES: readonly MintStateName[];
+/** uint16 mintCount cap on Manifold extensions; also the global quantity cap. */
+declare const MAX_QUANTITY = 65535;
+
+/**
+ * Placeholders: {recipient} {payer} {quantity} {unitPrice} {totalPrice}. Integers beyond
+ * Number.MAX_SAFE_INTEGER must be bigint or a decimal string (an unsafe number is INVALID_CONFIG).
+ */
+type ArgTemplate = string | number | bigint | boolean | ArgTemplate[];
+type FieldSource = {
+    value: bigint;
+} | {
+    value: string;
+    unit: 'display';
+} | {
+    read: {
+        functionName: string;
+        args?: ArgTemplate[];
+        output?: number | string;
+    };
+};
+type Erc20Ref = {
+    address: Address;
+};
+type ManifoldClaimConfig = {
+    type: 'manifold-claim';
+    chainId: number;
+    creatorContract: Address;
+    /** Studio instance id == on-chain claim index (V6+ extensions). Decimal string. */
+    instanceId: string;
+    /** Optional; auto-discovered when omitted. */
+    extension?: Address;
+};
+type ContractConfig = {
+    type: 'contract';
+    chainId: number;
+    /** Mint call target. */
+    address: Address;
+    /** Where Transfer logs come from; defaults to address. */
+    tokenContract?: Address;
+    abi: Abi;
+    mint: {
+        functionName: string;
+        args: ArgTemplate[];
+    };
+    price: FieldSource & {
+        currency: 'native' | Erc20Ref;
+        per?: 'unit' | 'total';
+    };
+    totalMinted?: FieldSource;
+    /** 0 or absent = open edition. */
+    maxSupply?: FieldSource;
+    walletMinted?: FieldSource;
+    walletMax?: FieldSource;
+    startTime?: FieldSource;
+    endTime?: FieldSource;
+};
+type TlStacksConfig = {
+    type: 'tl-stacks';
+    chainId: number;
+    /** TL Stacks 721 v2.3.x. 0x384092784cfaa91efaa77870c04d958e20840242 on every supported chain. */
+    stacks: Address;
+    /** The TL creator contract the drop mints from. */
+    nftContract: Address;
+    /** The drop's allowlist file (TL's allowlistUrl or a copy in the same format). Required for a presale. */
+    allowlistUrl?: string;
+};
+type MintConfig = ManifoldClaimConfig | ContractConfig | TlStacksConfig;
+/** chainId -> JSON-RPC URL (agent's domain-restricted key). */
+type RpcUrls = Record<number, string>;
+type Money = {
+    value: bigint;
+    decimals: number;
+    symbol: string;
+    formatted: string;
+};
+type DropInfo = {
+    chainId: number;
+    unitPrice: Money;
+    /** Manifold MINT_FEE / MINT_FEE_MERKLE per unit (native). Zero Money for external contracts. For tl-stacks it is TL's protocol fee. */
+    unitFee: Money;
+    totalMinted: bigint;
+    /** null = open edition. */
+    maxSupply: bigint | null;
+    startTime: number | null;
+    endTime: number | null;
+    isAllowlist: boolean;
+    /** ERC20 the price is paid in; null = native. */
+    paymentToken: Address | null;
+    /** External price is per transaction ('total') rather than per unit. */
+    pricePer: 'unit' | 'total';
+    /** Unix seconds when the current sale phase ends and the price or eligibility can change. null = none before endTime. */
+    phaseEndsAt?: number | null;
+    /** When set and changed by a re-read, the button drops its wallet read and reads again before it is live. */
+    walletKey?: string;
+};
+type WalletInfo = {
+    address: Address;
+    chainId: number;
+    recipient: Address;
+    walletMinted: bigint | null;
+    walletMax: bigint | null;
+    allowlistRemaining: number | null;
+};
+type MintedToken = {
+    contract: Address;
+    tokenId: bigint;
+    amount: bigint;
+};
+type MintResult = {
+    txHash: Hex;
+    explorerUrl: string | null;
+    tokens: MintedToken[];
+    /** The quantity the collector asked for. tokens.length can be lower when the sale mints part of it. */
+    requested: number;
+    /** Set when the mint went through Relay: the deposit on the pay chain and Relay's request id. */
+    relay?: {
+        requestId: Hex;
+        originTxHash: Hex;
+        originChainId: number;
+    };
+};
+/** How the mint is paid (spec relay-cross-chain-mint #public-api). */
+type Route = {
+    kind: 'direct';
+    chainId: number;
+} | {
+    kind: 'relay';
+    /** The chain the collector pays on. */
+    originChainId: number;
+    /** What leaves the wallet on the origin chain: mint + Relay fee. */
+    amountIn: Money;
+    /** Relay's fee (fees.relayer). */
+    relayFee: Money;
+    /** Origin-chain gas Relay estimates for the deposit (fees.gas). */
+    originGas: Money;
+    /** Unix seconds. */
+    quotedAt: number;
+};
+/** Cross-chain options on useMint / MintButton. */
+type CrossChainOption = boolean | {
+    chains?: number[];
+};
+/** Immutable context frozen when mint is clicked (spec #state-management). */
+type Attempt = {
+    attemptId: number;
+    config: MintConfig;
+    payer: Address;
+    recipient: Address;
+    quantity: number;
+    chainId: number;
+    tokenContract: Address;
+    /** Chain the collector pays on; equals chainId for a direct mint. */
+    originChainId: number;
+};
+type MintEventType = 'state' | 'attempt' | 'approve-submitted' | 'tx-submitted' | 'success' | 'error';
+/** onEvent payload. No wallet address is included. */
+type MintEvent = {
+    type: MintEventType;
+    state: MintStateName;
+    reason: ReasonCode | null;
+    chainId: number;
+    txHash?: Hex;
+    quantity: number;
+    config: {
+        type: MintConfig['type'];
+        chainId: number;
+        address: Address;
+    };
+    /** 'relay' when the mint is (or would be) paid on another chain through Relay. */
+    route: 'direct' | 'relay';
+    /** Chain the collector pays on. chainId stays the drop chain. */
+    originChainId: number;
+};
+
+export { type ArgTemplate as A, type CrossChainOption as C, type DropInfo as D, type Erc20Ref as E, type FieldSource as F, type IneligibleReason as I, type ManifoldClaimConfig as M, type ReasonCode as R, type TlStacksConfig as T, type UnsupportedReason as U, type WalletInfo as W, type Money as a, type RpcUrls as b, type MintConfig as c, type MintEvent as d, type MintStateName as e, type MintResult as f, type Route as g, type Attempt as h, CLICKABLE_STATES as i, type ContractConfig as j, type ErrorReason as k, MAX_QUANTITY as l, MINT_STATES as m, MintError as n, type MintEventType as o, type MintedToken as p, REASON_CODES as q, isMintError as r };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manifoldxyz/dropkit",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "React building blocks for Manifold creator drop sites.",
   "license": "MIT",
   "repository": {
@@ -24,6 +24,16 @@
         "default": "./dist/index.cjs"
       }
     },
+    "./cart": {
+      "import": {
+        "types": "./dist/cart.d.ts",
+        "default": "./dist/cart.js"
+      },
+      "require": {
+        "types": "./dist/cart.d.cts",
+        "default": "./dist/cart.cjs"
+      }
+    },
     "./package.json": "./package.json"
   },
   "files": [