@kodiak-finance/orderly-ui-transfer 2.7.4

package/dist/index.d.ts

@@ -0,0 +1,478 @@
+import * as react from 'react';
+import react__default, { FC, ReactNode } from 'react';
+import { ConnectedChain, Chain, SubAccount } from '@kodiak-finance/orderly-hooks';
+import { API, NetworkId, AssetHistoryStatusEnum } from '@kodiak-finance/orderly-types';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { InputFormatter, InputProps } from '@kodiak-finance/orderly-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;
+    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 | undefined;
+};
+
+type DepositFormScriptReturn = ReturnType<typeof useDepositFormScript>;
+type DepositFormScriptOptions = {
+    close?: () => void;
+};
+declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
+    sourceToken: API.TokenInfo | undefined;
+    targetToken: API.TokenInfo | undefined;
+    sourceTokens: API.TokenInfo[];
+    targetTokens: API.TokenInfo[];
+    onSourceTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
+    onTargetTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
+    amount: number;
+    isNativeToken: boolean;
+    quantity: string;
+    collateralContributionQuantity: number;
+    maxQuantity: string;
+    indexPrice: number;
+    onQuantityChange: react.Dispatch<react.SetStateAction<string>>;
+    hintMessage: string | undefined;
+    inputStatus: InputStatus;
+    chains: API.NetworkInfos[];
+    currentChain: CurrentChain | null;
+    settingChain: boolean;
+    onChainChange: (chain: API.NetworkInfos) => Promise<void>;
+    actionType: DepositAction;
+    onDeposit: () => Promise<void>;
+    onApprove: () => Promise<void>;
+    onApproveAndDeposit: () => Promise<void>;
+    fetchBalance: (address: string, decimals?: number) => 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;
+    fee: {
+        nativeSymbol: string | undefined;
+        dstGasFee: string;
+        feeQty: string;
+        feeAmount: string;
+        dp: number;
+    };
+    collateralRatio: number;
+    currentLTV: number;
+    nextLTV: number;
+    ltv_threshold: number | undefined;
+    negative_usdc_threshold: number | undefined;
+    isConvertThresholdLoading: boolean;
+    slippage: any;
+    onSlippageChange: (value: number) => void;
+    minimumReceived: string | number;
+    usdcToken: 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 | undefined;
+    targetQuantity: string;
+    targetQuantityLoading: boolean;
+};
+type UseDepositFeeReturn = ReturnType<typeof useDepositFee>;
+declare function useDepositFee(options: {
+    nativeToken?: API.TokenInfo;
+    depositFee?: bigint;
+}): {
+    nativeSymbol: string | undefined;
+    dstGasFee: string;
+    feeQty: string;
+    feeAmount: string;
+    dp: number;
+};
+
+declare const DepositForm: FC<DepositFormScriptReturn>;
+
+type DepositFormWidgetProps = DepositFormScriptOptions;
+declare const DepositFormWidget: FC<DepositFormWidgetProps>;
+
+type WithdrawFormScriptReturn = ReturnType<typeof useWithdrawFormScript>;
+type WithdrawFormScriptOptions = {
+    close?: () => void;
+};
+declare const useWithdrawFormScript: (options: WithdrawFormScriptOptions) => {
+    currentLTV: number;
+    nextLTV: number;
+    ltvWarningMessage: string;
+    withdrawTo: WithdrawTo;
+    setWithdrawTo: react.Dispatch<react.SetStateAction<WithdrawTo>>;
+    toAccountId: string;
+    setToAccountId: react.Dispatch<react.SetStateAction<string>>;
+    onTransfer: () => void;
+    internalWithdrawSubmitting: boolean;
+    toAccountIdInputStatus: InputStatus;
+    toAccountIdHintMessage: string | undefined;
+    walletName: string | undefined;
+    address: string | undefined;
+    quantity: string;
+    onQuantityChange: (qty: string) => void;
+    sourceToken: API.TokenInfo | undefined;
+    onSourceTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
+    sourceTokens: API.TokenInfo[];
+    inputStatus: InputStatus;
+    hintMessage: string | undefined;
+    amount: number;
+    balanceRevalidating: boolean;
+    maxQuantity: number;
+    disabled: boolean;
+    loading: boolean;
+    unsettledPnL: number;
+    wrongNetwork: boolean;
+    settingChain: boolean;
+    tokenChains: API.NetworkInfos[];
+    currentChain: CurrentChain | null;
+    onChainChange: (chain: API.NetworkInfos) => Promise<void>;
+    onWithdraw: () => Promise<void>;
+    chainVaultBalance: number | null;
+    fee: number;
+    crossChainWithdraw: boolean;
+    crossChainTrans: boolean;
+    showQty: string | number;
+    networkId: NetworkId;
+    checkIsBridgeless: boolean;
+    hasPositions: boolean;
+    onSettlePnl: () => Promise<any>;
+    brokerName: string;
+    qtyGreaterThanMaxAmount: boolean;
+    qtyGreaterThanVault: boolean;
+    vaultBalanceList: API.VaultBalance[] | undefined;
+};
+
+type WithdrawFormProps = WithdrawFormScriptReturn;
+declare const WithdrawForm: react__default.FC<WithdrawFormProps>;
+
+type WithdrawFormWidgetProps = WithdrawFormScriptOptions;
+declare const WithdrawFormWidget: FC<WithdrawFormWidgetProps>;
+
+declare const DepositAndWithdrawWithDialogId = "DepositAndWithdrawWithDialogId";
+declare const DepositAndWithdrawWithSheetId = "DepositAndWithdrawWithSheetId";
+type DepositAndWithdrawProps = {
+    activeTab?: "deposit" | "withdraw";
+    close?: () => void;
+};
+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 | undefined;
+    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) => 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 */
+    toAccountId?: string;
+    token?: string;
+    close?: () => void;
+};
+declare const useTransferFormScript: (options: TransferFormScriptOptions) => {
+    networkId: NetworkId;
+    onTransfer: () => void;
+    quantity: string;
+    amount: number;
+    onQuantityChange: react.Dispatch<react.SetStateAction<string>>;
+    maxQuantity: number;
+    tokens: API.TokenInfo[];
+    token: API.TokenInfo;
+    onTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo>>;
+    disabled: boolean;
+    submitting: boolean;
+    hintMessage: string | undefined;
+    inputStatus: InputStatus;
+    hasPositions: boolean;
+    onSettlePnl: () => Promise<any>;
+    unsettledPnL: number | undefined;
+    toAccountAsset: number;
+    fromAccount: SubAccount | undefined;
+    toAccount: SubAccount | undefined;
+    fromAccounts: SubAccount[];
+    onFromAccountChange: (account: SubAccount) => void;
+    toAccounts: SubAccount[] | undefined;
+    onToAccountChange: (account: SubAccount) => void;
+    onExchange: () => void;
+    isMainAccount: boolean;
+};
+
+type TransferFormProps = TransferFormScriptReturn;
+declare const TransferForm: FC<TransferFormProps>;
+
+declare const TransferDialogId = "TransferDialogId";
+declare const TransferSheetId = "TransferSheetId";
+type TransferFormWidgetProps = TransferFormScriptOptions;
+declare const TransferFormWidget: (props: TransferFormWidgetProps) => react_jsx_runtime.JSX.Element;
+declare const TransferWidget: FC<TransferFormWidgetProps>;
+
+type ConvertFormScriptReturn = ReturnType<typeof useConvertFormScript>;
+interface ConvertFormScriptOptions {
+    token?: string;
+    close?: () => void;
+}
+declare const useConvertFormScript: (options: ConvertFormScriptOptions) => {
+    walletName: string | undefined;
+    address: string | undefined;
+    quantity: string;
+    onQuantityChange: (qty: string) => void;
+    token: API.Chain;
+    sourceTokens: API.Chain[];
+    onSourceTokenChange: react.Dispatch<react.SetStateAction<API.Chain | undefined>>;
+    targetToken: API.Chain | undefined;
+    balanceRevalidating: boolean;
+    maxQuantity: number;
+    disabled: boolean;
+    loading: boolean;
+    wrongNetwork: boolean;
+    onConvert: () => Promise<void>;
+    hasPositions: boolean;
+    onSettlePnl: () => Promise<any>;
+    networkId: NetworkId;
+    slippage: any;
+    onSlippageChange: (value: number) => void;
+    convertRate: string;
+    minimumReceived: number;
+    outAmounts: string;
+    isQuoteLoading: boolean;
+    currentLTV: number;
+    nextLTV: number;
+};
+
+type ConvertFormProps = ConvertFormScriptReturn;
+declare const ConvertFormUI: react__default.FC<ConvertFormProps>;
+
+declare const ConvertFormWidget: react__default.FC<ConvertFormScriptOptions>;
+
+declare const getTokenByTokenList: (tokens?: API.TokenInfo[]) => API.TokenInfo;
+declare const feeDecimalsOffset: (origin?: number) => number;
+declare function checkIsAccountId(accountId: string): boolean;
+declare function getTransferErrorMessage(errorCode: number): string;
+
+type ChainSelectProps = {
+    chains: API.NetworkInfos[];
+    value: CurrentChain;
+    onValueChange: (chain: API.NetworkInfos) => Promise<void>;
+    wrongNetwork: boolean;
+    loading?: boolean;
+};
+declare const ChainSelect: React.FC<ChainSelectProps>;
+
+type QuantityInputProps = {
+    token?: API.TokenInfo;
+    tokens?: API.TokenInfo[];
+    label?: string;
+    status?: InputStatus;
+    hintMessage?: string;
+    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";
+} & Omit<InputProps, "onClear" | "suffix" | "onValueChange">;
+declare const QuantityInput: FC<QuantityInputProps>;
+
+type AvailableQuantityProps = {
+    token?: Partial<API.TokenInfo>;
+    amount?: number | string;
+    maxQuantity?: number | string;
+    onClick?: () => void;
+    loading?: boolean;
+};
+declare const AvailableQuantity: FC<AvailableQuantityProps>;
+
+declare const Web3Wallet: FC;
+
+declare const BrokerWallet: FC;
+
+type ExchangeDividerProps = {
+    icon?: ReactNode;
+};
+declare const ExchangeDivider: FC<ExchangeDividerProps>;
+
+interface SwapCoinProps {
+    className?: string;
+    sourceSymbol?: string;
+    targetSymbol?: string;
+    indexPrice: number | string;
+    precision?: number;
+}
+declare const SwapCoin: FC<SwapCoinProps>;
+
+type ActionButtonProps = {
+    disabled?: boolean;
+    loading?: boolean;
+    actionType: DepositAction;
+    symbol?: string;
+    onDeposit?: () => void;
+    onApprove?: () => void;
+    onApproveAndDeposit?: () => void;
+    networkId?: NetworkId;
+};
+declare const ActionButton: react__default.FC<ActionButtonProps>;
+
+declare const Fee: FC<Partial<UseDepositFeeReturn>>;
+
+type DepositStatusScriptReturn = ReturnType<typeof useDepositStatusScript>;
+declare function useDepositStatusScript(): {
+    pendingCount: number;
+    completedCount: number;
+    canTrade: boolean;
+    estimatedTime: string | number;
+    onClose: (status: AssetHistoryStatusEnum) => void;
+};
+
+type DepositStatusProps = {
+    className?: string;
+    classNames?: {
+        root?: string;
+        items?: string;
+    };
+    onClick?: () => void;
+} & DepositStatusScriptReturn;
+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, checkIsAccountId, feeDecimalsOffset, getTokenByTokenList, getTransferErrorMessage, useActionType, useChainSelect, useConvertFormScript as useConvertForm, useDepositAction, useDepositFormScript, useDepositStatusScript, useInputStatus, useSwapDepositFormScript, useTransferFormScript, useWithdrawFormScript };