@funkit/connect 3.2.0 → 3.3.0

package/dist/domains/checkoutFees.d.ts

@@ -0,0 +1,38 @@
+import { CheckoutQuoteResponse } from '@funkit/api-base';
+import type { Config } from 'wagmi';
+import { PaymentMethod, PaymentMethodInfo } from '../domains/paymentMethods';
+import { FunkitActiveCheckoutItem } from '../providers/FunkitCheckoutContext';
+interface BaseCheckoutFees {
+    paymentMethod: PaymentMethod;
+    marketMakerFeeUsd: number;
+    liquidityProviderFeePercentage: number;
+    totalFeesUsd: number;
+    totalFeesToken: number;
+}
+interface WalletCheckoutFees extends BaseCheckoutFees {
+    paymentMethod: PaymentMethod.ACCOUNT_BALANCE;
+    eoaWalletFeeToken: number;
+    eoaWalletFeeUsd: number;
+}
+interface CardCheckoutFees extends BaseCheckoutFees {
+    paymentMethod: PaymentMethod.CARD;
+    cardProcessingFeeUsd: number;
+    moonpayCostUsd: number;
+}
+interface BrokerageCheckoutFees extends BaseCheckoutFees {
+    paymentMethod: PaymentMethod.BROKERAGE;
+    exchangeFeeUsd: number;
+    meshCostUsd: number;
+}
+export type CheckoutFees = WalletCheckoutFees | CardCheckoutFees | BrokerageCheckoutFees;
+export declare const GAS_ESTIMATE_MULTIPLER = 1.2;
+interface EvaluateFeeBreakdownItem {
+    baseQuote: CheckoutQuoteResponse;
+    selectedSourceAssetInfo: FunkitActiveCheckoutItem['selectedSourceAssetInfo'];
+    newPaymentMethodInfo: PaymentMethodInfo;
+    wagmiConfig: Config;
+    apiKey: string;
+    isWeb3Login: boolean;
+}
+export declare function evaluateFeeBreakdown(evalItem: EvaluateFeeBreakdownItem): Promise<CheckoutFees>;
+export {};

package/dist/{consts/payment.d.ts → domains/paymentMethods.d.ts}

@@ -5,12 +5,11 @@ import { ReactNode } from 'react';
 export declare enum PaymentMethod {
     /** Moonpay - Credit / Debit Card **/
     CARD = "card",
-    /** Direct Transfer: used in polymarket **/
-    TRANSFER = "transfer",
     /** Account Balance **/
     ACCOUNT_BALANCE = "balance",
     /** Mesh - Exchange / Brokerage **/
-    BROKERAGE = "brokerage"
+    BROKERAGE = "brokerage",
+    TOKEN_TRANSFER = "token_transfer"
 }
 type PaymentMethodInfoMeta = LinkPayload & {
     checkoutMeshNetworkId?: string;
@@ -21,7 +20,7 @@ type PaymentMethodInfoMeta = LinkPayload & {
 export interface PaymentMethodInfo {
     paymentMethod: PaymentMethod;
     title: string;
-    titleIcon: ReactNode;
+    titleIcon: (size: number) => ReactNode;
     description: string;
     descriptionIcon?: ReactNode;
     meta: PaymentMethodInfoMeta;
@@ -35,11 +34,14 @@ export interface PaymentMethodBrokerageInfo extends PaymentMethodInfo {
 export interface PaymentMethodAccountInfo extends PaymentMethodInfo {
     paymentMethod: PaymentMethod.ACCOUNT_BALANCE;
 }
+export interface PaymentMethodTransferTokenInfo extends PaymentMethodInfo {
+    paymentMethod: PaymentMethod.TOKEN_TRANSFER;
+}
 /** Shouldn't be used generally. Will most likely be removed once checkoutItem usage is reduced */
 export declare const getPartialPaymentMethodInfo: <T extends PaymentMethodInfo>(paymentMethod: T["paymentMethod"]) => {
     paymentMethod: T["paymentMethod"];
     title: string;
-    titleIcon: null;
+    titleIcon: () => null;
     description: string;
     descriptionIcon: null;
     meta: {};

package/dist/hooks/useCheckoutStateBooleans.d.ts

@@ -1,9 +1,13 @@
 import { CheckoutState } from '@funkit/api-base';
-export declare function useCheckoutStateBooleans(checkoutState: CheckoutState): {
+export type CheckoutStatus = 'failed' | 'expired' | 'processing' | 'completed';
+type CheckoutStateBooleans = {
     isProcessing: boolean;
     isCompleted: boolean;
     isError: boolean;
     isExpired: boolean;
     isFailed: boolean;
     isTerminal: boolean;
+    status: CheckoutStatus;
 };
+export declare function useCheckoutStateBooleans(checkoutState: CheckoutState): CheckoutStateBooleans;
+export {};

package/dist/hooks/useCheckoutTransferDepositAddress.d.ts

@@ -0,0 +1,2 @@
+import { FunAddress } from '@funkit/api-base';
+export declare const useCheckoutTransferDepositAddress: (userId: string | undefined, recipientAddress: FunAddress) => `0x${string}` | undefined;

package/dist/hooks/useCheckoutType.d.ts

@@ -1,5 +1,5 @@
-import { FunkitActiveCheckoutItem, FunkitCheckoutActionParams, FunkitCheckoutConfig } from '../providers/FunkitCheckoutContext';
-export declare function evaluateCheckoutGenerateActionsParams(config: FunkitCheckoutConfig): FunkitCheckoutActionParams[];
+import { FunkitActiveCheckoutItem, FunkitCheckoutActionParams, FunkitCheckoutConfig, ServerCheckoutConfig } from '../providers/FunkitCheckoutContext';
+export declare function evaluateCheckoutGenerateActionsParams(config: FunkitCheckoutConfig | ServerCheckoutConfig): FunkitCheckoutActionParams[];
 export declare function isCheckoutCrFlow(checkoutItem: FunkitActiveCheckoutItem): boolean;
 export declare function isCheckoutDirectCrFlow(checkoutItem: FunkitActiveCheckoutItem): boolean;
-export declare function isCheckoutPostActionRequired(config: FunkitCheckoutConfig): boolean;
+export declare function isCheckoutPostActionRequired(config: FunkitCheckoutConfig | ServerCheckoutConfig): boolean;

package/dist/hooks/useMesh.d.ts

@@ -1,18 +1,18 @@
 import { LinkPayload } from '@meshconnect/web-link-sdk';
 import React, { ReactNode } from 'react';
 import { FunSelectOption } from '../components/FunSelect/FunSelect';
-import { PaymentMethodBrokerageInfo } from '../consts/payment';
+import { PaymentMethodBrokerageInfo } from '../domains/paymentMethods';
 import { MeshExchanges } from '../utils/mesh';
-export declare const getMeshExchangeIconMap: (size?: number) => Partial<Record<MeshExchanges, ReactNode>>;
+export declare const MESH_EXCHANGE_ICON_MAP: Partial<Record<MeshExchanges, (size: number) => ReactNode>>;
+export declare function getExchangeIcon(exchange: MeshExchanges, size: number): React.ReactNode;
 export declare const useSupportedExchanges: () => MeshExchanges[];
 export declare function getExchangeName(exchange: MeshExchanges): string;
+export declare const preparePaymentInfo: (meshMeta: LinkPayload, brokerage: MeshExchanges) => PaymentMethodBrokerageInfo;
 export declare const useMeshExchanges: ({ fullInfo, iconSize, }: {
     fullInfo?: boolean;
     iconSize?: number;
 }) => {
     options: FunSelectOption[];
-    preparePaymentInfo: (meshMeta: LinkPayload, brokerage: MeshExchanges) => PaymentMethodBrokerageInfo;
-    getIcon: (brokerage: MeshExchanges) => React.ReactNode;
 };
 /**
  * Fetches mesh-related network information across all chains, given an exchange