@manifoldxyz/dropkit 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,207 @@
+import { Address, Abi, Hex } from 'viem';
+export { Address, Hex } from 'viem';
+import { ReactNode } from 'react';
+
+declare const UNSUPPORTED_REASONS: readonly ["UNKNOWN_EXTENSION", "AMBIGUOUS_EXTENSION", "CLAIM_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"];
+/** 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;
+    constructor(reason: ReasonCode, message: string, opts?: {
+        field?: string;
+        cause?: unknown;
+    });
+}
+declare function isMintError(e: unknown): e is MintError;
+
+/**
+ * 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 MintConfig = ManifoldClaimConfig | ContractConfig;
+/** 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. */
+    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';
+};
+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[];
+};
+/** 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;
+};
+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;
+    };
+};
+
+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;
+
+/** Options for useMint and the props MintButton forwards to it (spec #package-api). */
+type UseMintOptions = {
+    config: MintConfig;
+    /** chainId -> JSON-RPC URL (agent's domain-restricted key). */
+    rpcUrls?: RpcUrls;
+    /** Defaults to the connected wallet. */
+    recipient?: Address;
+    /** Controlled when onQuantityChange is also supplied. */
+    quantity?: number;
+    onQuantityChange?: (quantity: number) => void;
+    connect?: {
+        walletConnectProjectId?: string;
+    };
+    onEvent?: (event: MintEvent) => void;
+};
+/** Spec #data-models table 2. */
+type MintState = {
+    state: MintStateName;
+    reason: ReasonCode | null;
+    message: string | null;
+    drop: DropInfo | null;
+    wallet: WalletInfo | null;
+    quantity: number;
+    setQuantity: (quantity: number) => void;
+    maxQuantity: number | null;
+    total: {
+        native: Money;
+        erc20: Money | null;
+    } | null;
+    mint: () => void;
+    result: MintResult | null;
+    refresh: () => Promise<void>;
+    canAct: boolean;
+};
+declare function useMint(options: UseMintOptions): MintState;
+
+type MintButtonProps = UseMintOptions & {
+    className?: string;
+    /** Per-state text override, e.g. { live: 'Collect', 'sold-out': 'Gone' }. */
+    labels?: Partial<Record<MintStateName, string>>;
+    /** A function child replaces the default markup entirely; m.mint still drives the flow. */
+    children?: ReactNode | ((m: MintState) => ReactNode);
+};
+declare function MintButton(props: MintButtonProps): ReactNode;
+
+declare const VERSION = "0.1.0";
+
+export { type ArgTemplate, type Attempt, CLICKABLE_STATES, type ContractConfig, type DropInfo, type Erc20Ref, type ErrorReason, type FieldSource, type IneligibleReason, MAX_QUANTITY, MINT_STATES, type ManifoldClaimConfig, MintButton, type MintButtonProps, type MintConfig, MintError, type MintEvent, type MintEventType, type MintResult, type MintState, type MintStateName, type MintedToken, type Money, REASON_CODES, type ReasonCode, type RpcUrls, type UnsupportedReason, type UseMintOptions, VERSION, type WalletInfo, isMintError, useMint };

package/dist/index.d.ts

@@ -0,0 +1,207 @@
+import { Address, Abi, Hex } from 'viem';
+export { Address, Hex } from 'viem';
+import { ReactNode } from 'react';
+
+declare const UNSUPPORTED_REASONS: readonly ["UNKNOWN_EXTENSION", "AMBIGUOUS_EXTENSION", "CLAIM_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"];
+/** 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;
+    constructor(reason: ReasonCode, message: string, opts?: {
+        field?: string;
+        cause?: unknown;
+    });
+}
+declare function isMintError(e: unknown): e is MintError;
+
+/**
+ * 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 MintConfig = ManifoldClaimConfig | ContractConfig;
+/** 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. */
+    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';
+};
+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[];
+};
+/** 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;
+};
+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;
+    };
+};
+
+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;
+
+/** Options for useMint and the props MintButton forwards to it (spec #package-api). */
+type UseMintOptions = {
+    config: MintConfig;
+    /** chainId -> JSON-RPC URL (agent's domain-restricted key). */
+    rpcUrls?: RpcUrls;
+    /** Defaults to the connected wallet. */
+    recipient?: Address;
+    /** Controlled when onQuantityChange is also supplied. */
+    quantity?: number;
+    onQuantityChange?: (quantity: number) => void;
+    connect?: {
+        walletConnectProjectId?: string;
+    };
+    onEvent?: (event: MintEvent) => void;
+};
+/** Spec #data-models table 2. */
+type MintState = {
+    state: MintStateName;
+    reason: ReasonCode | null;
+    message: string | null;
+    drop: DropInfo | null;
+    wallet: WalletInfo | null;
+    quantity: number;
+    setQuantity: (quantity: number) => void;
+    maxQuantity: number | null;
+    total: {
+        native: Money;
+        erc20: Money | null;
+    } | null;
+    mint: () => void;
+    result: MintResult | null;
+    refresh: () => Promise<void>;
+    canAct: boolean;
+};
+declare function useMint(options: UseMintOptions): MintState;
+
+type MintButtonProps = UseMintOptions & {
+    className?: string;
+    /** Per-state text override, e.g. { live: 'Collect', 'sold-out': 'Gone' }. */
+    labels?: Partial<Record<MintStateName, string>>;
+    /** A function child replaces the default markup entirely; m.mint still drives the flow. */
+    children?: ReactNode | ((m: MintState) => ReactNode);
+};
+declare function MintButton(props: MintButtonProps): ReactNode;
+
+declare const VERSION = "0.1.0";
+
+export { type ArgTemplate, type Attempt, CLICKABLE_STATES, type ContractConfig, type DropInfo, type Erc20Ref, type ErrorReason, type FieldSource, type IneligibleReason, MAX_QUANTITY, MINT_STATES, type ManifoldClaimConfig, MintButton, type MintButtonProps, type MintConfig, MintError, type MintEvent, type MintEventType, type MintResult, type MintState, type MintStateName, type MintedToken, type Money, REASON_CODES, type ReasonCode, type RpcUrls, type UnsupportedReason, type UseMintOptions, VERSION, type WalletInfo, isMintError, useMint };