@funkit/connect 5.5.13 → 5.5.15

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @funkit/connect
 
+## 5.5.15
+
+### Patch Changes
+
+- 9f6d124: fix react bug
+- 890ef8f: add up all gas
+- 4c208d4: feat(connect): swap meld deposit address from user to QR code address
+- Updated dependencies [4c208d4]
+  - @funkit/api-base@1.9.7
+  - @funkit/core@2.3.29
+  - @funkit/wagmi-tools@3.0.51
+
+## 5.5.14
+
+### Patch Changes
+
+- 0f27d4f: fix(connect): select chain dropdown width and position
+- 7232b85: chore(connect): deprecate vertex related code
+- 3ecab67: fix fee display
+- e4b274b: add icons to withdrawal
+- a650b5d: feat: add hyperevm chain
+- 3c3ea82: support exact input for withdrawal
+- 072a1c6: fix: fix fallback values for checkout time estimates
+- 08b7da3: chore: deprecate zoraTestnet
+- c3ea232: feat(connect): update Deposit with cash disclaimer
+- Updated dependencies [7232b85]
+- Updated dependencies [a650b5d]
+- Updated dependencies [afb6a57]
+- Updated dependencies [48d11b9]
+- Updated dependencies [08b7da3]
+  - @funkit/api-base@1.9.6
+  - @funkit/chains@0.3.3
+  - @funkit/core@2.3.28
+  - @funkit/utils@1.1.5
+  - @funkit/wagmi-tools@3.0.50
+
 ## 5.5.13
 
 ### Patch Changes

package/dist/components/CopyAddress/CopyInputDisplayedAddress.css.d.ts

@@ -1,2 +1,13 @@
 export declare const copyButtonWrapper: string;
 export declare const copyButton: string;
+export declare const copyButtonIcon: string;
+export declare const copyButtonIconBase: string;
+export declare const copyButtonIconActive: string;
+export declare const copyInputTextBox: string;
+export declare const copyInputTextBoxActive: string;
+export declare const copyInputText: string;
+export declare const copyInputTextWrapper: string;
+export declare const copyInputTextDefault: string;
+export declare const copyInputTextActive: string;
+export declare const textOut: string;
+export declare const textIn: string;

package/dist/components/CopyAddress/CopyInputDisplayedAddress.d.ts

@@ -3,6 +3,5 @@ interface CopyInputDisplayedAddressProps {
     address: string;
     truncateAddress?: boolean;
 }
-/** Element displaying the provided address along with a copy button below */
 export declare function CopyInputDisplayedAddress({ address, truncateAddress, }: CopyInputDisplayedAddressProps): React.JSX.Element;
 export {};

package/dist/components/FunCheckoutHistory/FunCheckoutHistoryContent.d.ts

@@ -5,7 +5,9 @@ interface FunCheckoutHistoryContentProps {
     currentPage: HistoryContentPages;
     onHelp: () => void;
     onBackFromHelpPage: () => void;
-    onClose: () => void;
+    onClose: (opt?: {
+        isNewDeposit?: boolean;
+    }) => void;
     onAnimationComplete?: (callback: () => void) => void;
     /** Element ID to be used to mount the CTA action bar */
     bottomBarId: string;

package/dist/components/FunPayments/FunPaymentMethods.d.ts

@@ -5,22 +5,22 @@ export declare function PaymentMethodIcon({ paymentIcon, keyIconSize, }: {
     paymentIcon: ReactNode;
     keyIconSize: number;
 }): React.JSX.Element;
-interface ConnectedMeshPaymentMethodItemProps {
+interface ConnectedMeshPaymentMethodItemProps extends ConnectedPaymentMethodItemProps {
     paymentMethodInfo: PaymentMethodBrokerageInfo;
-    isActive: boolean;
-    onSelect: () => void;
     onBrokerageError?: () => void;
-    targetChainId: string;
-    customValueIcon?: ReactNode;
 }
 /** it is different from BrokeragePaymentMethodItem
  * this component is for connected mesh brokerage like robinhood
  * the other one is for connecting new brokerage button
  * */
-export declare const ConnectedMeshPaymentMethodItem: ({ paymentMethodInfo, isActive, onSelect, onBrokerageError, targetChainId, customValueIcon, }: ConnectedMeshPaymentMethodItemProps) => React.JSX.Element;
-export declare const AccountBalancePaymentMethodItem: ({ isActive, customValueIcon, onClick, targetChainId, }: BasePaymentMethodItemProps & {
+export declare const ConnectedMeshPaymentMethodItem: ({ paymentMethodInfo, isSelected, onSelect, onBrokerageError, targetChainId, showSelectedCheckmark, }: ConnectedMeshPaymentMethodItemProps) => React.JSX.Element;
+interface ConnectedPaymentMethodItemProps {
+    isSelected: boolean;
+    showSelectedCheckmark?: boolean;
+    onSelect: () => void;
     targetChainId: string;
-}) => React.JSX.Element;
+}
+export declare const AccountBalancePaymentMethodItem: ({ isSelected, showSelectedCheckmark, onSelect, targetChainId, }: ConnectedPaymentMethodItemProps) => React.JSX.Element;
 export declare const ActiveFiatAccountPaymentMethodItem: ({ isActive, onClick, paymentMethodInfo, customValueIcon, }: BasePaymentMethodItemProps & {
     paymentMethodInfo: PaymentMethodVirtualBankInfo;
 }) => React.JSX.Element;

package/dist/components/Icons/CheckIcon.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
-export declare const CheckIcon: ({ size }: {
+export declare const CheckIcon: ({ size, className, }: {
     size?: number;
+    className?: string;
 }) => React.JSX.Element;

package/dist/components/Icons/EtherFiIcon.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export declare const EtherFiIcon: ({ size }: {
+    size?: number;
+}) => React.JSX.Element;

package/dist/components/ReceiveAmount/ReceiveAmount.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { ServerCheckoutConfig } from '~/domains/clientMetadata';
+import type { FunkitCheckoutConfig } from '~/providers/FunkitCheckoutContext';
+interface ReceiveAmountProps {
+    config: ServerCheckoutConfig | FunkitCheckoutConfig;
+    /** To override the default icon if custom one is needed */
+    icon?: React.ReactNode;
+}
+export declare const ReceiveAmount: ({ config, icon }: ReceiveAmountProps) => React.JSX.Element;
+export {};

package/dist/consts/customers.d.ts

@@ -1,8 +1,8 @@
 export declare function isDydxCustomer(apiKey: string): apiKey is "NJq0CGrsE19xBbP1vHyBOp8xJvzYo9kayJHqDFP5";
 export declare function isPolymarketCustomer(apiKey: string): apiKey is "Y53dikxXdT4E3afI1l8BMBSWgyhKvf65k6Dut1k6";
-export declare function isVertexCustomer(apiKey: string): apiKey is "OQXhzzkLHE2vHAK8nZBS76el5utuw3527RmnYn26";
 export declare function isOstiumCustomer(apiKey: string): apiKey is "SMbBD7DS9b3EPcyBVg4a8az1rRWR9xB068chHoUN";
 export declare function isBankrCustomer(apiKey: string): apiKey is "vWe20Dfyui2ouvfOhtSTY3Czeo8lFdbo5xXQBALZ";
 export declare function isBsxCustomer(apiKey: string): apiKey is "zN1zrkmLQn4oZtLUW9Qt02uuBI3Jvrgj8Ni40Gf1";
 export declare function isEtherealCustomer(apiKey: string): apiKey is "M3uox3cw0u8YCPV9cIREA6AugUMvPFTk6qOpm4um";
 export declare function isKatanaCustomer(apiKey: string): apiKey is "OXLUmejkh9PlNDS4gSvi9gcEWacOpTz2KUVepVf4";
+export declare function isEtherFiCustomer(apiKey: string): apiKey is "GyJMyQ3juDarKooebGRu16Ncogwhm59h2DIjCu1p";

package/dist/domains/asset.d.ts

@@ -8,7 +8,6 @@ export declare function isNativeTokenAddress(address: Address): boolean;
 export declare function isDefaultToken(asset: AssetHoldingsItem, checkoutConfig: FunkitCheckoutConfig): boolean;
 export declare const isPolygonEcosystemToken: (chainId: string, tokenAddress: string) => boolean;
 interface AssetUsableToPayParms {
-    apiKey: string;
     config: FunkitCheckoutConfig;
     payerAddress: string;
     paymentMethod: PaymentMethod;
@@ -19,10 +18,11 @@ interface AssetUsableToPayParms {
     assetUsdAmount: number | null;
     loginType: LoginType;
     isAllowedForCheckout: boolean;
+    minValueThreshold?: number;
 }
-export declare const isAssetUsableToPayForCheckout: ({ apiKey, config, payerAddress, paymentMethod, targetChainId, targetTokenAddress, assetChainId, assetTokenAddress, assetUsdAmount, loginType, isAllowedForCheckout, }: AssetUsableToPayParms) => {
+export declare const isAssetUsableToPayForCheckout: ({ config, payerAddress, paymentMethod, targetChainId, targetTokenAddress, assetChainId, assetTokenAddress, assetUsdAmount, loginType, isAllowedForCheckout, minValueThreshold, }: AssetUsableToPayParms) => {
     isUsable: boolean;
     reason: string;
 };
-export declare function getUsdAvailableAmount(targetChainId: string, assetChainId: string | undefined, assetUsdAmount: number | null | undefined, paymentMethod: PaymentMethod | undefined, isDirectExecution: boolean): number | null;
+export declare function getUsdAvailableAmount(targetChainId: string, assetChainId: string | undefined, assetUsdAmount: number | null | undefined, paymentMethod: PaymentMethod | undefined): number | null;
 export {};

package/dist/domains/clientMetadata.d.ts

@@ -31,11 +31,17 @@ export interface HistoricalCheckoutItem {
     };
     selectedSourceAssetInfo: FunkitActiveCheckoutItem['selectedSourceAssetInfo'];
     selectedPaymentMethodInfo: FunkitActiveCheckoutItem['selectedPaymentMethodInfo'];
+    isWithdrawal?: boolean;
 }
 /**
  * Sanitizes checkoutItem to generate a clientMetadata object to be saved in backend.
  * Ensures that no react components get sent to backend and the object isn't too big as well.
  */
-export declare function generateClientMetadataForBackend(checkoutItem: FunkitActiveCheckoutItem, quote: FunkitCheckoutQuoteResult, actionsParams?: FunkitCheckoutActionParams[]): ApiCheckoutClientMetadata;
+export declare function generateClientMetadataForBackend({ checkoutItem, latestQuote, actionsParams, isWithdrawal, }: {
+    checkoutItem: FunkitActiveCheckoutItem;
+    latestQuote: FunkitCheckoutQuoteResult;
+    actionsParams?: FunkitCheckoutActionParams[];
+    isWithdrawal?: boolean;
+}): ApiCheckoutClientMetadata;
 export declare function generateClientMetadataForTokenTransfer(): HistoricalCheckoutItem;
 export declare function toApiSelectedPaymentMethodInfo(paymentMethodInfo: PaymentMethodInfo): ApiSelectedPaymentMethodInfo;

package/dist/domains/paymentMethods.d.ts

@@ -45,6 +45,7 @@ export interface PaymentMethodVirtualBankInfo extends PaymentMethodVirtualBankIn
     matchingFiatAccount: BridgeVirtualBankAccount;
 }
 export type ConnectablePaymentMethodInfo = PaymentMethodAccountInfo | PaymentMethodBrokerageInfo | PaymentMethodVirtualBankInfo;
+export declare function isConnectablePaymentMethodInfo(value: unknown): value is ConnectablePaymentMethodInfo;
 export type PaymentMethodInfo = PaymentMethodCardInfo | PaymentMethodBrokerageInfo | PaymentMethodAccountInfo | PaymentMethodTokenTransferInfo | PaymentMethodVirtualBankIncompleteInfo;
 interface CardPaymentMethodParams {
     paymentMethod: PaymentMethod.CARD;

package/dist/domains/quote.d.ts

@@ -10,7 +10,7 @@ export interface FunkitCheckoutQuoteResult extends Omit<ApiFunkitCheckoutQuoteRe
     finalSpreadUsd: string;
     finalFeesBreakdown: CheckoutFees;
 }
-export declare function getCheckoutBaseQuote(checkoutItem: FunkitActiveCheckoutItem, userId: string, walletAddress: Address, apiKey: string, sponsorInitialTransferGasLimit: number, wagmiConfig: Config, directExecutionInfo: FunkitDirectExecutionInfo, senderAddress?: Address): Promise<CheckoutQuoteResponse>;
+export declare function getCheckoutBaseQuote(checkoutItem: FunkitActiveCheckoutItem, userId: string, walletAddress: Address, apiKey: string, sponsorInitialTransferGasLimit: number, wagmiConfig: Config, directExecutionInfo: FunkitDirectExecutionInfo, senderAddress?: Address, isWithdrawal?: boolean): Promise<CheckoutQuoteResponse>;
 export declare function getQuoteFinalEstimation(baseQuote: CheckoutQuoteResponse, checkoutItem: FunkitActiveCheckoutItem, newPaymentMethodInfo: PaymentMethodInfo, wagmiConfig: Config, apiKey: string, loginType: LoginType, enableFrogProxyServer?: boolean): Promise<{
     finalEstimation: FunkitCheckoutQuoteResult;
     brokerage?: BrokerageDetails;
@@ -37,8 +37,9 @@ export interface CheckoutQuoteParams {
      *  this happens when withdrawing from a different wallet
      **/
     senderAddress?: Address;
+    isWithdrawal?: boolean;
 }
-export declare function getQuoteAndEstimation({ checkoutItem, userId, walletAddress, apiKey, sponsorInitialTransferGasLimit, newPaymentMethodInfo, wagmiConfig, loginType, enableFrogProxyServer, directExecutionInfo, senderAddress, }: CheckoutQuoteParams): Promise<{
+export declare function getQuoteAndEstimation({ checkoutItem, userId, walletAddress, apiKey, sponsorInitialTransferGasLimit, newPaymentMethodInfo, wagmiConfig, loginType, enableFrogProxyServer, directExecutionInfo, senderAddress, isWithdrawal, }: CheckoutQuoteParams): Promise<{
     baseQuote: CheckoutQuoteResponse;
     checkedAssetAmount: CheckedAssetAmount;
     finalEstimation: FunkitCheckoutQuoteResult;

package/dist/domains/relay.d.ts

@@ -2,10 +2,15 @@ import type { RelayQuote } from '@funkit/fun-relay';
 export declare const KATANA_BRIDGE_ALERT_THRESHOLD_PERCENT = 0.5;
 export declare function extractRelayFeeInfo(relayQuote: RelayQuote['metadata']['relayQuote']): {
     gasUsd: number;
+    fillCostUsd: number;
+    fillCostPercent: number;
     chainName: string | undefined;
+    totalImpactUsd: number;
     totalImpact: number;
     swapImpact: number;
+    swapImpactUsd: number;
     appFeePercent: number;
+    appFeeUsd: number;
     maxSlippage: number;
     minReceived: number;
 };

package/dist/domains/wallet.d.ts

@@ -25,5 +25,5 @@ type RecommendedAsset = {
     chainSymbolKey: string;
     label: string | null;
 };
-export declare const getRecommendedAsset: (apiKey: string, checkoutItem: FunkitActiveCheckoutItem, accountHoldings: KnownAssetHoldingsItem[]) => RecommendedAsset | null;
+export declare const getRecommendedAsset: (checkoutItem: FunkitActiveCheckoutItem, accountHoldings: KnownAssetHoldingsItem[]) => RecommendedAsset | null;
 export {};

package/dist/hooks/queries/useWithdrawalQuote.d.ts

@@ -1,18 +1,17 @@
 import { type Address } from 'viem';
 import type { WithdrawalClient } from '~/wallets/Wallet';
 interface CheckoutQuoteParams {
-    recipientAddress: Address;
+    recipientAddress: string;
     sourceAmount: number;
     chainId: string;
     symbol: string;
     targetAsset: Address | undefined;
-    targetAssetAmount: number | undefined;
     withdrawalClient: WithdrawalClient;
 }
 /**
  * Simplified quoting logic used for withdrawal UI only.
  */
-export declare function useWithdrawalQuote({ recipientAddress, sourceAmount, chainId, symbol, targetAsset, targetAssetAmount, withdrawalClient, }: CheckoutQuoteParams): {
+export declare function useWithdrawalQuote({ recipientAddress, sourceAmount, chainId, symbol, targetAsset, withdrawalClient, }: CheckoutQuoteParams): {
     quoteEnabled: boolean;
     data: {
         baseQuote: import("@funkit/utils").CheckoutQuoteResponse;

package/dist/{modals/CheckoutModal/InputAmount → hooks}/useAssetPrice.d.ts

@@ -1,15 +1,19 @@
 import { type Erc20AssetInfo } from '@funkit/api-base';
 import type { Address } from 'viem';
+interface UseAssetAddressPriceParams {
+    chainId: string | undefined;
+    assetTokenAddress: Address | undefined;
+    refetchInterval?: number;
+    /** defaults to 1 hence price returned is unit price */
+    amount?: number;
+}
 type AssetPriceResult = {
     error: Error | null;
     isLoading: boolean;
-    unitPrice: number | undefined;
+    /** unit price if custom amount is not provided */
+    price: number | undefined;
 };
-export declare function useAssetAddressPrice({ chainId, assetTokenAddress, refetchInterval, }: {
-    chainId: string | undefined;
-    assetTokenAddress: Address | undefined;
-    refetchInterval?: number;
-}): AssetPriceResult;
+export declare function useAssetAddressPrice({ chainId, assetTokenAddress, amount, refetchInterval, }: UseAssetAddressPriceParams): AssetPriceResult;
 type AssetSymbolPriceParams = {
     chainId: string | undefined;
     symbol: string | undefined;

package/dist/hooks/useCheckoutDirectExecution.d.ts

@@ -1,25 +1,36 @@
 import { DirectExecutionType } from '@funkit/api-base';
-import { type CheckoutQuoteResponse } from '@funkit/utils';
+import type { CheckoutQuoteResponse } from '@funkit/utils';
 import type { Address, Hex } from 'viem';
-import { PaymentMethod } from '~/domains/paymentMethods';
 import type { FunkitCheckoutQuoteResult } from '~/domains/quote';
-import type { FunkitActiveCheckoutItem, FunkitCheckoutActionParams, FunkitCheckoutConfig } from '~/providers/FunkitCheckoutContext';
-interface DirectExecutionQuoteRequestParams {
+import type { FunkitActiveCheckoutItem, FunkitCheckoutActionParams } from '~/providers/FunkitCheckoutContext';
+import type { WithdrawalClient } from '~/wallets/Wallet';
+interface DirectExecutionQuoteRequestParamsBase {
     actionParams: FunkitCheckoutActionParams[];
     toChainId: string;
     toTokenAddress: Address;
-    toTokenAmount: number;
-    toTokenDecimals: number;
     fromChainId: string;
     fromTokenAddress: Address;
     recipientAddress: Address;
     senderAddress?: Address;
+    isExactIn?: boolean;
+}
+interface RegularDEQuoteRequest extends DirectExecutionQuoteRequestParamsBase {
+    toTokenAmount: number;
+    toTokenDecimals: number;
+    isExactIn?: false;
+}
+interface WithdrawalDEQuoteRequest extends DirectExecutionQuoteRequestParamsBase {
+    fromTokenAmount: number;
+    isExactIn: true;
+    fromTokenDecimals: number;
 }
+type DirectExecutionQuoteRequestParams = RegularDEQuoteRequest | WithdrawalDEQuoteRequest;
 interface DirectExecutionStartParams {
     checkoutItem: FunkitActiveCheckoutItem;
     stepMessageSetter: (m: string) => void;
     actionsParams: FunkitCheckoutActionParams[];
     latestQuote: FunkitCheckoutQuoteResult;
+    withdrawalClient?: WithdrawalClient;
 }
 export interface FunkitDirectExecutionInfo {
     isDirectExecution: boolean;
@@ -31,14 +42,5 @@ interface UseCheckoutDirectExecutionReturn {
     getDirectExecutionInfo: (checkoutItem: FunkitActiveCheckoutItem | null) => FunkitDirectExecutionInfo;
     getWithdrawalDirectExecution: () => FunkitDirectExecutionInfo;
 }
-export declare function isVertexDirectExecution({ apiKey, config, paymentMethod, sourceAsset, sourceChain, targetAsset, targetChain, }: {
-    apiKey: string;
-    config: FunkitCheckoutConfig;
-    paymentMethod: PaymentMethod | undefined;
-    sourceAsset: string;
-    sourceChain: string;
-    targetAsset?: string;
-    targetChain?: string;
-}): boolean;
 export declare function useCheckoutDirectExecution(): UseCheckoutDirectExecutionReturn;
 export {};

package/dist/hooks/useCheckoutTimeEstimate.d.ts

@@ -2,6 +2,9 @@ import { PaymentMethod } from '~/domains/paymentMethods';
 /**
  * https://linear.app/funxyz/issue/ENG-1154/update-dydx-and-polymarkets-time-estimate
  * https://linear.app/funxyz/issue/PE-775/sdkconnectwith-next-pm-requests
+ * @param originalTimeEstimationMs time estimation in milliseconds
+ * @param paymentMethod payment method
+ * @param bypassFlag whether to ignore flag value and return the original time estimation fallback even if flag is defined
  * @returns time estimation in seconds
  */
 export declare function useCheckoutTimeEstimate(originalTimeEstimationMs: number | undefined, paymentMethod?: PaymentMethod, //TODO: questionable

package/dist/hooks/usePaymentMethodIcon.d.ts

@@ -1,11 +1,6 @@
 import React, { type ReactNode } from 'react';
 import { PaymentMethod, type PaymentMethodInfo } from '../domains/paymentMethods';
-export declare const PAYMENT_METHOD_ICONS: {
-    brokerage: (size: number) => React.JSX.Element;
-    card: (size: number) => React.JSX.Element;
-    token_transfer: (size: number) => React.JSX.Element;
-    virtual_bank: (size: number) => React.JSX.Element;
-};
+export declare const PAYMENT_METHOD_ICONS: Record<Exclude<PaymentMethod, PaymentMethod.ACCOUNT_BALANCE>, (size: number) => ReactNode>;
 /**
   Reference ENG-716
   * web2 users -> social icon