@orderly.network/ui-transfer 2.9.1 → 2.10.0-alpha.0

package/dist/index.d.ts

@@ -1,132 +1,44 @@
 import * as react from 'react';
 import react__default, { FC, ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ConnectedChain, Chain, SubAccount } from '@orderly.network/hooks';
 import * as _orderly_network_types from '@orderly.network/types';
-import { API, NetworkId, AssetHistoryStatusEnum } from '@orderly.network/types';
+import { NetworkId, API, AssetHistoryStatusEnum } from '@orderly.network/types';
+import { ConnectedChain, Chain, SubAccount } from '@orderly.network/hooks';
 import { InputFormatter, InputProps } from '@orderly.network/ui';
 
-type DST = {
-    symbol: string;
-    address?: string;
-    decimals?: number;
-    chainId?: number;
-    network?: string;
-};
-declare enum DepositAction {
-    Deposit = 0,
-    Approve = 1,
-    ApproveAndDeposit = 2
-}
-declare enum WithdrawTo {
-    /** withdraw to web3 wallet */
-    Wallet = "wallet",
-    /** withdraw to other account id */
-    Account = "accountId"
-}
-type InputStatus = "error" | "warning" | "success" | "default";
-
-type Options$2 = {
-    isNativeToken: boolean;
-    allowance: string;
-    quantity: string;
-    maxQuantity: string;
-};
-declare function useActionType(options: Options$2): DepositAction.Deposit | DepositAction.ApproveAndDeposit;
-
-type CurrentChain = Pick<ConnectedChain, "namespace"> & {
-    id: number;
-    info?: Chain;
-};
-declare function useChainSelect(): {
-    chains: API.NetworkInfos[];
-    currentChain: CurrentChain | null;
-    settingChain: boolean;
-    onChainChange: (chain: API.NetworkInfos) => Promise<void>;
-};
-
-type Options$1 = {
-    quantity: string;
-    allowance?: string;
-    approve: (quantity?: string) => Promise<any>;
-    deposit: () => Promise<any>;
-    onSuccess?: () => void;
-    onError?: (err: unknown, knownErrorMessage?: string) => void;
-    customDeposit?: () => Promise<any>;
-    enableCustomDeposit?: boolean;
-};
-declare function useDepositAction(options: Options$1): {
-    submitting: boolean;
-    onApprove: () => Promise<void>;
-    onDeposit: () => Promise<void>;
-    onApproveAndDeposit: () => Promise<void>;
-};
-
-type Options = {
-    quantity: string;
-    maxQuantity: string | number;
-};
-declare function useInputStatus(options: Options): {
-    inputStatus: InputStatus;
-    hintMessage: string;
-};
-
 type DepositFormScriptReturn = ReturnType<typeof useDepositFormScript>;
 type DepositFormScriptOptions = {
     close?: () => void;
 };
 declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
-    sourceToken: API.TokenInfo | undefined;
-    targetToken: API.TokenInfo | undefined;
-    sourceTokens: {
-        balance: number;
-        isNativeToken: boolean;
-        address?: string;
-        base_weight: number;
-        decimals?: number;
-        token_decimal?: number;
-        discount_factor?: number | null;
-        display_name?: string;
-        haircut: number;
-        is_collateral: boolean;
-        symbol?: string;
-        user_max_qty: number;
-        precision?: number;
-        minimum_withdraw_amount: number;
-        swap_enable?: boolean;
-    }[];
-    targetTokens: API.TokenInfo[];
-    onSourceTokenChange: (token: API.TokenInfo) => void;
-    onTargetTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
-    amount: number;
+    sourceToken: _orderly_network_types.API.TokenInfo | undefined;
+    targetToken: _orderly_network_types.API.TokenInfo | undefined;
+    sourceTokens: _orderly_network_types.API.TokenInfo[];
+    targetTokens: _orderly_network_types.API.TokenInfo[];
+    onSourceTokenChange: react.Dispatch<react.SetStateAction<_orderly_network_types.API.TokenInfo | undefined>>;
+    onTargetTokenChange: react.Dispatch<react.SetStateAction<_orderly_network_types.API.TokenInfo | undefined>>;
     nativeSymbol: string | undefined;
     isNativeToken: boolean;
     quantity: string;
     collateralContributionQuantity: number;
     maxQuantity: string;
     maxDepositAmount: string;
-    indexPrice: number;
     onQuantityChange: react.Dispatch<react.SetStateAction<string>>;
     hintMessage: string;
-    inputStatus: "default" | "error" | "warning" | "success";
-    chains: API.NetworkInfos[];
+    inputStatus: InputStatus;
+    targetInputStatus: InputStatus;
+    targetHintMessage: string;
+    chains: _orderly_network_types.API.NetworkInfos[];
     currentChain: CurrentChain | null;
     settingChain: boolean;
-    onChainChange: (chain: API.NetworkInfos) => Promise<void>;
+    onChainChange: (chain: _orderly_network_types.API.NetworkInfos) => Promise<void>;
     actionType: DepositAction;
     onDeposit: () => Promise<void>;
     onApprove: () => Promise<void>;
     onApproveAndDeposit: () => Promise<void>;
-    fetchBalance: (address: string, decimals?: number, token?: string) => Promise<string>;
-    dst: {
-        symbol: string;
-        address: string | undefined;
-        decimals: number | undefined;
-        chainId: number;
-        network: string;
-    };
     wrongNetwork: boolean;
     balanceRevalidating: boolean;
+    batchBalancesRevalidating: boolean;
     loading: boolean;
     disabled: boolean;
     networkId: NetworkId;
@@ -144,43 +56,19 @@ declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     isConvertThresholdLoading: boolean;
     slippage: any;
     onSlippageChange: (value: number) => void;
-    minimumReceived: string | number;
-    usdcToken: API.TokenInfo | undefined;
+    slippageValidate: (value: number) => string;
+    swapMinReceived: string | undefined;
+    usdcToken: _orderly_network_types.API.TokenInfo | undefined;
     needSwap: boolean;
-    needCrossSwap: boolean;
-    swapPrice: number;
-    markPrice: number;
-    swapFee: {
-        nativeSymbol: string | undefined;
-        feeAmount: string;
-        feeQtys: {
-            value: string | number;
-            dp: number;
-            symbol?: string;
-        }[];
-        feeDetails: {
-            value: string | number;
-            title: string;
-            description: string;
-            dp: number;
-            symbol: string | undefined;
-        }[];
-    };
-    warningMessage: string | react_jsx_runtime.JSX.Element;
-    targetQuantity: string;
+    swapPrice: number | undefined;
+    swapPriceInUSD: string | number | undefined;
+    warningMessage: string | react_jsx_runtime.JSX.Element | undefined;
+    targetQuantity: string | undefined;
     targetQuantityLoading: boolean;
-    tokenBalances: Record<string, string>;
     isLoggedIn: boolean;
-};
-type UseDepositFeeReturn = ReturnType<typeof useDepositFee>;
-declare function useDepositFee(options: {
-    nativeSymbol?: string;
-    depositFee?: bigint;
-}): {
-    dstGasFee: string;
-    feeQty: string;
-    feeAmount: string;
-    dp: number;
+    showSourceDepositCap: boolean;
+    showTargetDepositCap: boolean;
+    quantityNotional: number;
 };
 
 declare const DepositForm: FC<DepositFormScriptReturn>;
@@ -188,6 +76,23 @@ declare const DepositForm: FC<DepositFormScriptReturn>;
 type DepositFormWidgetProps = DepositFormScriptOptions;
 declare const DepositFormWidget: FC<DepositFormWidgetProps>;
 
+declare enum DepositAction {
+    Deposit = 0,
+    Approve = 1,
+    ApproveAndDeposit = 2
+}
+declare enum WithdrawTo {
+    /** withdraw to web3 wallet */
+    Wallet = "wallet",
+    /** withdraw to other account id */
+    Account = "accountId"
+}
+type InputStatus = "error" | "warning" | "success" | "default";
+type CurrentChain = Pick<ConnectedChain, "namespace"> & {
+    id: number;
+    info?: Chain;
+};
+
 type AccountInfo = {
     accountId: string;
     address: string;
@@ -306,71 +211,6 @@ type DepositAndWithdrawProps = {
 };
 declare const DepositAndWithdraw: FC<DepositAndWithdrawProps>;
 
-type UseSwapDepositFormScriptReturn = ReturnType<typeof useSwapDepositFormScript>;
-type UseSwapDepositFormScriptOptions = {
-    onClose?: () => void;
-};
-declare const useSwapDepositFormScript: (options: UseSwapDepositFormScriptOptions) => {
-    token: API.TokenInfo | undefined;
-    tokens: API.TokenInfo[];
-    onTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
-    amount: number;
-    quantity: string;
-    maxQuantity: string;
-    swapQuantity: string;
-    onQuantityChange: react.Dispatch<react.SetStateAction<string>>;
-    hintMessage: string;
-    inputStatus: InputStatus;
-    chains: API.NetworkInfos[];
-    currentChain: CurrentChain | null;
-    settingChain: boolean;
-    onChainChange: (chain: API.NetworkInfos) => Promise<void>;
-    actionType: DepositAction;
-    onDeposit: () => Promise<void>;
-    onApprove: () => Promise<void>;
-    fetchBalance: (address: string, decimals?: number, token?: string) => Promise<string>;
-    dst: {
-        symbol: string;
-        address: string | undefined;
-        decimals: number | undefined;
-        chainId: number;
-        network: string;
-    };
-    wrongNetwork: boolean;
-    balanceRevalidating: boolean;
-    loading: boolean;
-    disabled: boolean;
-    networkId: NetworkId;
-    slippage: any;
-    onSlippageChange: (value: number) => void;
-    needSwap: boolean;
-    needCrossSwap: boolean;
-    swapPrice: number;
-    swapRevalidating: boolean;
-    warningMessage: string;
-    fee: {
-        nativeSymbol: string | undefined;
-        feeAmount: string;
-        feeQtys: {
-            value: string | number;
-            dp: number;
-            symbol?: string;
-        }[];
-        feeDetails: {
-            value: string | number;
-            title: string;
-            description: string;
-            dp: number;
-            symbol: string | undefined;
-        }[];
-    };
-};
-
-declare const SwapDepositForm: FC<UseSwapDepositFormScriptReturn>;
-
-type SwapDepositFormWidgetProps = UseSwapDepositFormScriptOptions;
-declare const SwapDepositFormWidget: FC<SwapDepositFormWidgetProps>;
-
 type TransferFormScriptReturn = ReturnType<typeof useTransferFormScript>;
 type TransferFormScriptOptions = {
     /** target sub account id */
@@ -479,11 +319,36 @@ declare const ConvertFormUI: react__default.FC<ConvertFormProps>;
 
 declare const ConvertFormWidget: react__default.FC<ConvertFormScriptOptions>;
 
-declare const getTokenByTokenList: (tokens?: API.TokenInfo[]) => API.TokenInfo;
+declare function sortTokensWithUSDCFirst(tokens?: API.TokenInfo[]): API.TokenInfo[];
+/** Prefer USDC, then USDC.e, then USDbC, then first token. Single pass, no extra object allocation. */
+declare const getUSDCToken: (tokens?: API.TokenInfo[]) => API.TokenInfo | undefined;
 declare const feeDecimalsOffset: (origin?: number) => number;
 declare function checkIsAccountId(accountId: string): boolean;
 declare function getTransferErrorMessage(errorCode: number): string;
-declare function getDepositKnownErrorMessage(message: string): string | undefined;
+declare const DEPOSIT_ERROR_CODE_MAP: {
+    AccessControlBadConfirmation: string;
+    AccessControlUnauthorizedAccount: string;
+    AccountIdInvalid: string;
+    AddressZero: string;
+    BalanceNotEnough: string;
+    BrokerNotAllowed: string;
+    CeffuAddressMismatch: string;
+    DepositExceedLimit: string;
+    EnumerableSetError: string;
+    InvalidSwapSignature: string;
+    InvalidTokenAddress: string;
+    NativeTokenDepositAmountMismatch: string;
+    NotRebalanceEnableToken: string;
+    NotZeroCodeLength: string;
+    OnlyCrossChainManagerCanCall: string;
+    ReentrancyGuardReentrantCall: string;
+    SwapAlreadySubmitted: string;
+    TokenNotAllowed: string;
+    ZeroCodeLength: string;
+    ZeroDeposit: string;
+    ZeroDepositFee: string;
+};
+declare function getDepositKnownErrorMessage(message: string): string;
 
 type ChainSelectProps = {
     chains: API.NetworkInfos[];
@@ -504,25 +369,26 @@ type QuantityInputProps = {
     hintSuffix?: ReactNode;
     onValueChange?: (value: string) => void;
     onTokenChange?: (token: any) => void;
-    fetchBalance?: (token: string, decimals: number) => Promise<any>;
     loading?: boolean;
     testId?: string;
     formatters?: InputFormatter[];
     vaultBalanceList?: API.VaultBalance[];
     displayType?: "balance" | "vaultBalance";
-    tokenBalances?: Record<string, string>;
     tokenValueFormatter?: (value: string) => ReactNode;
     tokenShowCaret?: boolean;
+    balancesRevalidating?: boolean;
+    showBalance?: boolean;
 } & Omit<InputProps, "onClear" | "suffix" | "onValueChange">;
 declare const QuantityInput: FC<QuantityInputProps>;
 
 type AvailableQuantityProps = {
     token?: Partial<API.TokenInfo>;
-    amount?: number | string;
-    maxQuantity?: number | string;
+    quantity?: string | number;
+    maxQuantity?: string | number;
     onClick?: () => void;
     loading?: boolean;
     tooltipContent?: React.ReactNode;
+    notional?: number;
 };
 declare const AvailableQuantity: FC<AvailableQuantityProps>;
 
@@ -541,6 +407,7 @@ interface SwapCoinProps {
     targetSymbol?: string;
     indexPrice: number | string;
     precision?: number;
+    suffix?: ReactNode;
 }
 declare const SwapCoin: FC<SwapCoinProps>;
 
@@ -556,6 +423,18 @@ type ActionButtonProps = {
 };
 declare const ActionButton: react__default.FC<ActionButtonProps>;
 
+type UseDepositFeeReturn = ReturnType<typeof useDepositFee>;
+declare function useDepositFee(options: {
+    nativeSymbol?: string;
+    depositFee?: bigint;
+    getIndexPrice: (token: string) => number;
+}): {
+    dstGasFee: string;
+    feeQty: string;
+    feeAmount: string;
+    dp: number;
+};
+
 type FeeProps = Partial<UseDepositFeeReturn> & {
     nativeSymbol?: string;
 };
@@ -633,4 +512,4 @@ declare const DepositStatus: react__default.FC<DepositStatusProps>;
 type DepositStatusWidgetProps = Pick<DepositStatusProps, "className" | "onClick">;
 declare const DepositStatusWidget: react__default.FC<DepositStatusWidgetProps>;
 
-export { ActionButton, AvailableQuantity, BrokerWallet, ChainSelect, type ConvertFormProps, ConvertFormUI, ConvertFormWidget, type CurrentChain, type DST, DepositAction, DepositAndWithdraw, type DepositAndWithdrawProps, DepositAndWithdrawWithDialogId, DepositAndWithdrawWithSheetId, DepositForm, type DepositFormScriptOptions, DepositFormWidget, type DepositFormWidgetProps, DepositStatus, DepositStatusWidget, ExchangeDivider, Fee, type InputStatus, QuantityInput, SwapCoin, SwapDepositForm, SwapDepositFormWidget, TransferDialogId, TransferForm, TransferFormWidget, type TransferFormWidgetProps, TransferSheetId, TransferWidget, Web3Wallet, WithdrawForm, type WithdrawFormScriptOptions, WithdrawFormWidget, type WithdrawFormWidgetProps, WithdrawTo, YIELD_BEARING_ASSETS, type YieldBearingAsset, YieldBearingReminder, checkIsAccountId, feeDecimalsOffset, getDepositKnownErrorMessage, getTokenByTokenList, getTransferErrorMessage, getYieldBearingAsset, isYieldBearingAsset, useActionType, useChainSelect, useConvertFormScript as useConvertForm, useDepositAction, useDepositFormScript, useDepositStatusScript, useInputStatus, useSwapDepositFormScript, useTransferFormScript, useWithdrawFormScript };
+export { ActionButton, AvailableQuantity, BrokerWallet, ChainSelect, type ConvertFormProps, ConvertFormUI, ConvertFormWidget, type CurrentChain, DEPOSIT_ERROR_CODE_MAP, DepositAction, DepositAndWithdraw, type DepositAndWithdrawProps, DepositAndWithdrawWithDialogId, DepositAndWithdrawWithSheetId, DepositForm, type DepositFormScriptOptions, DepositFormWidget, type DepositFormWidgetProps, DepositStatus, DepositStatusWidget, ExchangeDivider, Fee, type InputStatus, QuantityInput, SwapCoin, TransferDialogId, TransferForm, TransferFormWidget, type TransferFormWidgetProps, TransferSheetId, TransferWidget, Web3Wallet, WithdrawForm, type WithdrawFormScriptOptions, WithdrawFormWidget, type WithdrawFormWidgetProps, WithdrawTo, YIELD_BEARING_ASSETS, type YieldBearingAsset, YieldBearingReminder, checkIsAccountId, feeDecimalsOffset, getDepositKnownErrorMessage, getTransferErrorMessage, getUSDCToken, getYieldBearingAsset, isYieldBearingAsset, sortTokensWithUSDCFirst, useConvertFormScript as useConvertForm, useDepositFormScript, useDepositStatusScript, useTransferFormScript, useWithdrawFormScript };