@manifoldxyz/dropkit 0.1.0 → 0.2.0

package/dist/index.d.cts

@@ -4,7 +4,7 @@ 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"];
+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];
@@ -21,9 +21,12 @@ 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': the message is Relay's decoded destination revert, shown as-is. */
+    readonly domain?: 'relay';
     constructor(reason: ReasonCode, message: string, opts?: {
         field?: string;
         cause?: unknown;
+        domain?: 'relay';
     });
 }
 declare function isMintError(e: unknown): e is MintError;
@@ -123,6 +126,33 @@ type MintResult = {
     txHash: Hex;
     explorerUrl: string | null;
     tokens: MintedToken[];
+    /** 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 = {
@@ -133,6 +163,8 @@ type Attempt = {
     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. */
@@ -148,6 +180,16 @@ type MintEvent = {
         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;
+};
+
+type TxRequest = {
+    to: Address;
+    data: Hex;
+    value: bigint;
 };
 
 declare const MINT_STATES: readonly ["loading", "unsupported", "upcoming", "ended", "sold-out", "disconnected", "connecting", "live", "ineligible", "insufficient-funds", "switching-chain", "approving", "minting", "confirming", "success", "error"];
@@ -171,6 +213,24 @@ type UseMintOptions = {
         walletConnectProjectId?: string;
     };
     onEvent?: (event: MintEvent) => void;
+    /**
+     * Relay cross-chain mint for Manifold claims. Default on: a wallet on another supported chain pays
+     * there and Relay mints on the drop chain. false turns it off; `chains` narrows the pay chains.
+     */
+    crossChain?: CrossChainOption;
+    /** Force the pay chain. The drop chain means a direct mint. Must be one of the pay chains. */
+    payChainId?: number;
+};
+/** What PayWithPicker needs to quote other chains (spec #public-api). */
+type CrossChainInfo = {
+    dropChainId: number;
+    /** Chains the collector may pay from, the drop chain included. */
+    payChains: number[];
+    /** The destination call (plan.mint for the current quantity and recipient). */
+    tx: TxRequest;
+    payer: Address;
+    recipient: Address;
+    testnet: boolean;
 };
 /** Spec #data-models table 2. */
 type MintState = {
@@ -190,9 +250,48 @@ type MintState = {
     result: MintResult | null;
     refresh: () => Promise<void>;
     canAct: boolean;
+    /** How this wallet pays: direct on the drop chain, or Relay from its current chain. null before a wallet read. */
+    route: Route | null;
+    /** Inputs for PayWithPicker; null when Relay cannot mint this drop for this wallet. */
+    crossChain: CrossChainInfo | null;
 };
 declare function useMint(options: UseMintOptions): MintState;
 
+type PayOption = {
+    chainId: number;
+    name: string;
+    /** The wallet's current chain. */
+    selected: boolean;
+    /** The drop's own chain: no bridge, no fee ("None"). */
+    isDropChain: boolean;
+    /** Relay's fee to pay from this chain; null on the drop chain or before the quote. */
+    relayFee: Money | null;
+    /** Total leaving the wallet on this chain; null on the drop chain or before the quote. */
+    amountIn: Money | null;
+    /** Balance through the wallet, for the selected chain only (spec D14). */
+    balance: Money | null;
+    loading: boolean;
+    /** Pick this chain: asks the wallet to switch to it. */
+    select: () => void;
+};
+type PayWithPickerProps = {
+    /** From useMint, or from MintButton's function child. */
+    mint: MintState;
+    className?: string;
+    /** Replaces the default row markup. */
+    renderRow?: (row: PayOption) => ReactNode;
+    /** Called after a pick, with the chain id, once the wallet switched (or failed to). */
+    onSelect?: (chainId: number, error: unknown) => void;
+};
+/** Rows for every pay chain; a chain whose quote failed is hidden, the drop chain never is. */
+declare function usePayOptions(mint: MintState, onSelect?: (chainId: number, error: unknown) => void): PayOption[];
+/**
+ * One button per pay chain, showing Relay's fee (the drop chain shows "None") and, for the wallet's
+ * current chain only, its balance. Picking a row switches the wallet; the button re-reads the route.
+ * Renders nothing when the drop cannot be minted cross-chain for this wallet.
+ */
+declare function PayWithPicker(props: PayWithPickerProps): ReactNode;
+
 type MintButtonProps = UseMintOptions & {
     className?: string;
     /** Per-state text override, e.g. { live: 'Collect', 'sold-out': 'Gone' }. */
@@ -202,6 +301,6 @@ type MintButtonProps = UseMintOptions & {
 };
 declare function MintButton(props: MintButtonProps): ReactNode;
 
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.2.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 };
+export { type ArgTemplate, type Attempt, CLICKABLE_STATES, type ContractConfig, type CrossChainInfo, type CrossChainOption, 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, type PayOption, PayWithPicker, type PayWithPickerProps, REASON_CODES, type ReasonCode, type Route, type RpcUrls, type UnsupportedReason, type UseMintOptions, VERSION, type WalletInfo, isMintError, useMint, usePayOptions };

package/dist/index.d.ts

@@ -4,7 +4,7 @@ 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"];
+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];
@@ -21,9 +21,12 @@ 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': the message is Relay's decoded destination revert, shown as-is. */
+    readonly domain?: 'relay';
     constructor(reason: ReasonCode, message: string, opts?: {
         field?: string;
         cause?: unknown;
+        domain?: 'relay';
     });
 }
 declare function isMintError(e: unknown): e is MintError;
@@ -123,6 +126,33 @@ type MintResult = {
     txHash: Hex;
     explorerUrl: string | null;
     tokens: MintedToken[];
+    /** 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 = {
@@ -133,6 +163,8 @@ type Attempt = {
     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. */
@@ -148,6 +180,16 @@ type MintEvent = {
         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;
+};
+
+type TxRequest = {
+    to: Address;
+    data: Hex;
+    value: bigint;
 };
 
 declare const MINT_STATES: readonly ["loading", "unsupported", "upcoming", "ended", "sold-out", "disconnected", "connecting", "live", "ineligible", "insufficient-funds", "switching-chain", "approving", "minting", "confirming", "success", "error"];
@@ -171,6 +213,24 @@ type UseMintOptions = {
         walletConnectProjectId?: string;
     };
     onEvent?: (event: MintEvent) => void;
+    /**
+     * Relay cross-chain mint for Manifold claims. Default on: a wallet on another supported chain pays
+     * there and Relay mints on the drop chain. false turns it off; `chains` narrows the pay chains.
+     */
+    crossChain?: CrossChainOption;
+    /** Force the pay chain. The drop chain means a direct mint. Must be one of the pay chains. */
+    payChainId?: number;
+};
+/** What PayWithPicker needs to quote other chains (spec #public-api). */
+type CrossChainInfo = {
+    dropChainId: number;
+    /** Chains the collector may pay from, the drop chain included. */
+    payChains: number[];
+    /** The destination call (plan.mint for the current quantity and recipient). */
+    tx: TxRequest;
+    payer: Address;
+    recipient: Address;
+    testnet: boolean;
 };
 /** Spec #data-models table 2. */
 type MintState = {
@@ -190,9 +250,48 @@ type MintState = {
     result: MintResult | null;
     refresh: () => Promise<void>;
     canAct: boolean;
+    /** How this wallet pays: direct on the drop chain, or Relay from its current chain. null before a wallet read. */
+    route: Route | null;
+    /** Inputs for PayWithPicker; null when Relay cannot mint this drop for this wallet. */
+    crossChain: CrossChainInfo | null;
 };
 declare function useMint(options: UseMintOptions): MintState;
 
+type PayOption = {
+    chainId: number;
+    name: string;
+    /** The wallet's current chain. */
+    selected: boolean;
+    /** The drop's own chain: no bridge, no fee ("None"). */
+    isDropChain: boolean;
+    /** Relay's fee to pay from this chain; null on the drop chain or before the quote. */
+    relayFee: Money | null;
+    /** Total leaving the wallet on this chain; null on the drop chain or before the quote. */
+    amountIn: Money | null;
+    /** Balance through the wallet, for the selected chain only (spec D14). */
+    balance: Money | null;
+    loading: boolean;
+    /** Pick this chain: asks the wallet to switch to it. */
+    select: () => void;
+};
+type PayWithPickerProps = {
+    /** From useMint, or from MintButton's function child. */
+    mint: MintState;
+    className?: string;
+    /** Replaces the default row markup. */
+    renderRow?: (row: PayOption) => ReactNode;
+    /** Called after a pick, with the chain id, once the wallet switched (or failed to). */
+    onSelect?: (chainId: number, error: unknown) => void;
+};
+/** Rows for every pay chain; a chain whose quote failed is hidden, the drop chain never is. */
+declare function usePayOptions(mint: MintState, onSelect?: (chainId: number, error: unknown) => void): PayOption[];
+/**
+ * One button per pay chain, showing Relay's fee (the drop chain shows "None") and, for the wallet's
+ * current chain only, its balance. Picking a row switches the wallet; the button re-reads the route.
+ * Renders nothing when the drop cannot be minted cross-chain for this wallet.
+ */
+declare function PayWithPicker(props: PayWithPickerProps): ReactNode;
+
 type MintButtonProps = UseMintOptions & {
     className?: string;
     /** Per-state text override, e.g. { live: 'Collect', 'sold-out': 'Gone' }. */
@@ -202,6 +301,6 @@ type MintButtonProps = UseMintOptions & {
 };
 declare function MintButton(props: MintButtonProps): ReactNode;
 
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.2.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 };
+export { type ArgTemplate, type Attempt, CLICKABLE_STATES, type ContractConfig, type CrossChainInfo, type CrossChainOption, 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, type PayOption, PayWithPicker, type PayWithPickerProps, REASON_CODES, type ReasonCode, type Route, type RpcUrls, type UnsupportedReason, type UseMintOptions, VERSION, type WalletInfo, isMintError, useMint, usePayOptions };