@orderly.network/ui-transfer 2.8.1-alpha.0 → 2.8.2-alpha.0

package/dist/index.d.mts

@@ -77,11 +77,28 @@ type DepositFormScriptOptions = {
 declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     sourceToken: API.TokenInfo | undefined;
     targetToken: API.TokenInfo | undefined;
-    sourceTokens: API.TokenInfo[];
+    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: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
+    onSourceTokenChange: (token: API.TokenInfo) => void;
     onTargetTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
     amount: number;
+    nativeSymbol: string | undefined;
     isNativeToken: boolean;
     quantity: string;
     collateralContributionQuantity: number;
@@ -98,7 +115,7 @@ declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     onDeposit: () => Promise<void>;
     onApprove: () => Promise<void>;
     onApproveAndDeposit: () => Promise<void>;
-    fetchBalance: (address: string, decimals?: number) => Promise<string>;
+    fetchBalance: (address: string, decimals?: number, token?: string) => Promise<string>;
     dst: {
         symbol: string;
         address: string | undefined;
@@ -112,7 +129,6 @@ declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     disabled: boolean;
     networkId: NetworkId;
     fee: {
-        nativeSymbol: string | undefined;
         dstGasFee: string;
         feeQty: string;
         feeAmount: string;
@@ -151,13 +167,13 @@ declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     warningMessage: string;
     targetQuantity: string;
     targetQuantityLoading: boolean;
+    tokenBalances: Record<string, string>;
 };
 type UseDepositFeeReturn = ReturnType<typeof useDepositFee>;
 declare function useDepositFee(options: {
-    nativeToken?: API.TokenInfo;
+    nativeSymbol?: string;
     depositFee?: bigint;
 }): {
-    nativeSymbol: string | undefined;
     dstGasFee: string;
     feeQty: string;
     feeAmount: string;
@@ -190,7 +206,7 @@ declare const useWithdrawFormScript: (options: WithdrawFormScriptOptions) => {
     quantity: string;
     onQuantityChange: (qty: string) => void;
     sourceToken: API.TokenInfo | undefined;
-    onSourceTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
+    onSourceTokenChange: (token: API.TokenInfo) => void;
     sourceTokens: API.TokenInfo[];
     inputStatus: InputStatus;
     hintMessage: string | undefined;
@@ -257,7 +273,7 @@ declare const useSwapDepositFormScript: (options: UseSwapDepositFormScriptOption
     actionType: DepositAction;
     onDeposit: () => Promise<void>;
     onApprove: () => Promise<void>;
-    fetchBalance: (address: string, decimals?: number) => Promise<string>;
+    fetchBalance: (address: string, decimals?: number, token?: string) => Promise<string>;
     dst: {
         symbol: string;
         address: string | undefined;
@@ -437,6 +453,7 @@ type QuantityInputProps = {
     formatters?: InputFormatter[];
     vaultBalanceList?: API.VaultBalance[];
     displayType?: "balance" | "vaultBalance";
+    tokenBalances?: Record<string, string>;
 } & Omit<InputProps, "onClear" | "suffix" | "onValueChange">;
 declare const QuantityInput: FC<QuantityInputProps>;
 
@@ -479,7 +496,60 @@ type ActionButtonProps = {
 };
 declare const ActionButton: react__default.FC<ActionButtonProps>;
 
-declare const Fee: FC<Partial<UseDepositFeeReturn>>;
+type FeeProps = Partial<UseDepositFeeReturn> & {
+    nativeSymbol?: string;
+};
+declare const Fee: FC<FeeProps>;
+
+interface YieldBearingReminderProps {
+    /** Token symbol to check and display APY for */
+    symbol?: string;
+    /** Additional CSS class name */
+    className?: string;
+}
+/**
+ * YieldBearingReminder Component
+ * Router component that renders the appropriate reminder based on token type
+ * - YUSD: Dark blue theme with white text and coin icons
+ * - deUSD: Light pink/purple theme with dark text and deUSD logo icons
+ */
+declare const YieldBearingReminder: FC<YieldBearingReminderProps>;
+
+/**
+ * Yield-bearing collateral assets configuration
+ * These assets earn APY rewards while being used as collateral for trading
+ */
+interface YieldBearingAsset {
+    /** Asset symbol (e.g., "YUSD", "deUSD") */
+    symbol: string;
+    /** Asset display name */
+    displayName: string;
+    /** API endpoint to fetch APY data */
+    apyApiUrl: string;
+    /** Path to extract APY value from API response (e.g., "data.efficient_apr") */
+    apyPath: string;
+    /** External link to the asset issuer's website */
+    externalUrl: string;
+}
+/**
+ * Configuration for all supported yield-bearing assets
+ * Chain support is determined by the backend API (/v1/public/token)
+ * via the chain_details array for each token
+ */
+declare const YIELD_BEARING_ASSETS: YieldBearingAsset[];
+/**
+ * Check if a token is a yield-bearing asset
+ * Note: This only checks if the token symbol is configured as yield-bearing.
+ * Chain availability is determined by the backend API's chain_details.
+ *
+ * @param symbol - Token symbol to check
+ * @returns true if the token is configured as yield-bearing
+ */
+declare function isYieldBearingAsset(symbol?: string): boolean;
+/**
+ * Get yield-bearing asset configuration by symbol
+ */
+declare function getYieldBearingAsset(symbol?: string): YieldBearingAsset | undefined;
 
 type DepositStatusScriptReturn = ReturnType<typeof useDepositStatusScript>;
 declare function useDepositStatusScript(): {
@@ -503,4 +573,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, checkIsAccountId, feeDecimalsOffset, getDepositKnownErrorMessage, getTokenByTokenList, getTransferErrorMessage, useActionType, useChainSelect, useConvertFormScript as useConvertForm, useDepositAction, useDepositFormScript, useDepositStatusScript, useInputStatus, useSwapDepositFormScript, useTransferFormScript, useWithdrawFormScript };
+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 };

package/dist/index.d.ts

@@ -77,11 +77,28 @@ type DepositFormScriptOptions = {
 declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     sourceToken: API.TokenInfo | undefined;
     targetToken: API.TokenInfo | undefined;
-    sourceTokens: API.TokenInfo[];
+    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: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
+    onSourceTokenChange: (token: API.TokenInfo) => void;
     onTargetTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
     amount: number;
+    nativeSymbol: string | undefined;
     isNativeToken: boolean;
     quantity: string;
     collateralContributionQuantity: number;
@@ -98,7 +115,7 @@ declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     onDeposit: () => Promise<void>;
     onApprove: () => Promise<void>;
     onApproveAndDeposit: () => Promise<void>;
-    fetchBalance: (address: string, decimals?: number) => Promise<string>;
+    fetchBalance: (address: string, decimals?: number, token?: string) => Promise<string>;
     dst: {
         symbol: string;
         address: string | undefined;
@@ -112,7 +129,6 @@ declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     disabled: boolean;
     networkId: NetworkId;
     fee: {
-        nativeSymbol: string | undefined;
         dstGasFee: string;
         feeQty: string;
         feeAmount: string;
@@ -151,13 +167,13 @@ declare const useDepositFormScript: (options: DepositFormScriptOptions) => {
     warningMessage: string;
     targetQuantity: string;
     targetQuantityLoading: boolean;
+    tokenBalances: Record<string, string>;
 };
 type UseDepositFeeReturn = ReturnType<typeof useDepositFee>;
 declare function useDepositFee(options: {
-    nativeToken?: API.TokenInfo;
+    nativeSymbol?: string;
     depositFee?: bigint;
 }): {
-    nativeSymbol: string | undefined;
     dstGasFee: string;
     feeQty: string;
     feeAmount: string;
@@ -190,7 +206,7 @@ declare const useWithdrawFormScript: (options: WithdrawFormScriptOptions) => {
     quantity: string;
     onQuantityChange: (qty: string) => void;
     sourceToken: API.TokenInfo | undefined;
-    onSourceTokenChange: react.Dispatch<react.SetStateAction<API.TokenInfo | undefined>>;
+    onSourceTokenChange: (token: API.TokenInfo) => void;
     sourceTokens: API.TokenInfo[];
     inputStatus: InputStatus;
     hintMessage: string | undefined;
@@ -257,7 +273,7 @@ declare const useSwapDepositFormScript: (options: UseSwapDepositFormScriptOption
     actionType: DepositAction;
     onDeposit: () => Promise<void>;
     onApprove: () => Promise<void>;
-    fetchBalance: (address: string, decimals?: number) => Promise<string>;
+    fetchBalance: (address: string, decimals?: number, token?: string) => Promise<string>;
     dst: {
         symbol: string;
         address: string | undefined;
@@ -437,6 +453,7 @@ type QuantityInputProps = {
     formatters?: InputFormatter[];
     vaultBalanceList?: API.VaultBalance[];
     displayType?: "balance" | "vaultBalance";
+    tokenBalances?: Record<string, string>;
 } & Omit<InputProps, "onClear" | "suffix" | "onValueChange">;
 declare const QuantityInput: FC<QuantityInputProps>;
 
@@ -479,7 +496,60 @@ type ActionButtonProps = {
 };
 declare const ActionButton: react__default.FC<ActionButtonProps>;
 
-declare const Fee: FC<Partial<UseDepositFeeReturn>>;
+type FeeProps = Partial<UseDepositFeeReturn> & {
+    nativeSymbol?: string;
+};
+declare const Fee: FC<FeeProps>;
+
+interface YieldBearingReminderProps {
+    /** Token symbol to check and display APY for */
+    symbol?: string;
+    /** Additional CSS class name */
+    className?: string;
+}
+/**
+ * YieldBearingReminder Component
+ * Router component that renders the appropriate reminder based on token type
+ * - YUSD: Dark blue theme with white text and coin icons
+ * - deUSD: Light pink/purple theme with dark text and deUSD logo icons
+ */
+declare const YieldBearingReminder: FC<YieldBearingReminderProps>;
+
+/**
+ * Yield-bearing collateral assets configuration
+ * These assets earn APY rewards while being used as collateral for trading
+ */
+interface YieldBearingAsset {
+    /** Asset symbol (e.g., "YUSD", "deUSD") */
+    symbol: string;
+    /** Asset display name */
+    displayName: string;
+    /** API endpoint to fetch APY data */
+    apyApiUrl: string;
+    /** Path to extract APY value from API response (e.g., "data.efficient_apr") */
+    apyPath: string;
+    /** External link to the asset issuer's website */
+    externalUrl: string;
+}
+/**
+ * Configuration for all supported yield-bearing assets
+ * Chain support is determined by the backend API (/v1/public/token)
+ * via the chain_details array for each token
+ */
+declare const YIELD_BEARING_ASSETS: YieldBearingAsset[];
+/**
+ * Check if a token is a yield-bearing asset
+ * Note: This only checks if the token symbol is configured as yield-bearing.
+ * Chain availability is determined by the backend API's chain_details.
+ *
+ * @param symbol - Token symbol to check
+ * @returns true if the token is configured as yield-bearing
+ */
+declare function isYieldBearingAsset(symbol?: string): boolean;
+/**
+ * Get yield-bearing asset configuration by symbol
+ */
+declare function getYieldBearingAsset(symbol?: string): YieldBearingAsset | undefined;
 
 type DepositStatusScriptReturn = ReturnType<typeof useDepositStatusScript>;
 declare function useDepositStatusScript(): {
@@ -503,4 +573,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, checkIsAccountId, feeDecimalsOffset, getDepositKnownErrorMessage, getTokenByTokenList, getTransferErrorMessage, useActionType, useChainSelect, useConvertFormScript as useConvertForm, useDepositAction, useDepositFormScript, useDepositStatusScript, useInputStatus, useSwapDepositFormScript, useTransferFormScript, useWithdrawFormScript };
+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 };