@dodoex/widgets 3.2.2 → 3.2.4-beta.1

package/dist/types/hooks/Submission/spec.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Let's pretend that typescript has ADT
+ */
+import { BigNumber } from 'bignumber.js';
+import { BigNumber as EthersBigNumber } from '@ethersproject/bignumber';
+/**
+ * All supported opcodes, as tagged union discriminants
+ */
+export declare enum OpCode {
+    Approval = "APPROVAL",
+    TX = "TX",
+    TypedSign = "TypedSign"
+}
+export declare enum SwapType {
+    Normal = "Normal",
+    Privacy = "Privacy",
+    LimitOrder = "LimitOrder",
+    RFQ = "RFQ"
+}
+export type TokenData = {
+    address: string;
+};
+export type ApprovalStep = {
+    opcode: OpCode.Approval;
+    /**
+     * The address of the token
+     */
+    token: TokenData;
+    /**
+     * The approved contract address
+     */
+    contract: string;
+    /**
+     * The amount to set the allowance to, in Wei, in base-10. If omitted, a (very) big constants is used
+     * TODO(meow): bigint shows a 87% support rate. Can we use it here?
+     */
+    amt?: BigNumber;
+};
+export type TXStep = {
+    opcode: OpCode.TX;
+    value: number | string;
+    to: string;
+    data: string;
+    swapType?: SwapType;
+    gasLimit?: EthersBigNumber;
+    gasPrice?: number;
+    ddlSecRel?: number;
+};
+export type TypedSignStep = {
+    opcode: OpCode.TypedSign;
+    swapType?: SwapType;
+    signer?: string;
+    typedData: Record<string, unknown>;
+};
+export type Step = ApprovalStep | TXStep | TypedSignStep;
+export type Steps = Step[];

package/dist/types/hooks/Submission/types.d.ts

@@ -0,0 +1,95 @@
+import { Step as StepSpec } from './spec';
+import { ExecutionProps } from './useExecution';
+export declare enum State {
+    Running = 0,
+    Success = 1,
+    Failed = 2,
+    Warning = 3
+}
+export declare enum MetadataFlag {
+    swap = "swap",
+    crossChain = "crossChain",
+    addLiquidity = "addLiquidity",
+    removeLiquidity = "removeLiquidity",
+    createDPPPool = "createDPPPool",
+    createDSPPool = "createDSPPool",
+    createGSPPool = "createGSPPool",
+    createDVMPool = "createDVMPool",
+    createAMMV2Position = "createAMMV2Position",
+    addLiquidityAMMV2Position = "addLiquidityAMMV2Position",
+    removeLiqidityAMMV2Position = "removeLiqidityAMMV2Position",
+    createAMMV3Pool = "createAMMV3Pool",
+    addAMMV3Pool = "addAMMV3Pool",
+    removeAMMV3Pool = "removeAMMV3Pool",
+    claimAMMV3Pool = "claimAMMV3Pool",
+    stakeMining = "stakeMining",
+    unstakeMining = "unstakeMining",
+    claimMining = "claimMining",
+    submissionCreateMetaKey = "submissionCreateMetaKey",
+    approve = "approve",
+    reset = "reset"
+}
+export type Metadata = Record<string, any>;
+export type Request = {
+    brief: string;
+    spec: StepSpec;
+    subtitle?: string | React.ReactNode | null;
+    metadata?: Metadata;
+    tx: string;
+    nonce?: number;
+    doneTime?: number;
+};
+export type TextUpdater = (request: Request) => null | {
+    brief: string;
+    subtitle?: string;
+    metadata?: Metadata;
+};
+export type Requests = Map<string, [Request, State]>;
+export declare enum ExecutionResult {
+    Canceled = "canceled",
+    Failed = "failed",
+    Success = "success",
+    Submitted = "submitted"
+}
+type SubmitState = 'loading' | 'submitted';
+export interface Showing {
+    brief: string;
+    subtitle?: string | React.ReactNode;
+    spec: StepSpec;
+    submitState?: SubmitState;
+}
+export type ExecutionCtx = {
+    /**
+     * Execute an on-chain operation
+     * @param breif: TX title. e.g.: "Swap"
+     * @param spec: TX specification.
+     * @param subtitle: Additional hint text. e.g.: "10 USDT to 10 USDC"
+     * @param early: When given, the returned promise resolves when user confirmed in their wallet.
+     * @param mixpanelProps: mixpanel properties
+     * @param submittedConfirmBack: submittedConfirmBack
+     * @param successBack: successBack
+     * @param metadata: metadata
+     */
+    execute: (brief: string, spec: StepSpec, params?: {
+        subtitle?: string | React.ReactNode | null;
+        early?: boolean;
+        submittedBack?: () => void;
+        mixpanelProps?: Record<string, any>;
+        submittedConfirmBack?: () => void;
+        successBack?: (tx: string, callback?: ExecutionProps['onTxSuccess']) => void;
+        metadata?: Metadata;
+    }) => Promise<ExecutionResult>;
+    /**
+     * order
+     */
+    requests?: Requests;
+    updateText: (upd: TextUpdater) => void;
+    setShowing?: React.Dispatch<React.SetStateAction<Showing | null>>;
+    waitingSubmit: boolean;
+    errorMessage: string | null;
+};
+export declare enum WatchResult {
+    Failed = 0,
+    Success = 1
+}
+export {};

package/dist/types/hooks/Submission/useBalanceUpdateLoading.d.ts

@@ -0,0 +1,16 @@
+import BigNumber from 'bignumber.js';
+export type BalanceData = {
+    [address: string]: string;
+};
+/**
+ * Record the loading status of the balance waiting to be updated after the chain is successfully uploaded
+ * Insert token data into logBalance in metadata when uploading, within 5 minutes after successful uploading. If the newly passed in balance is consistent with the previously recorded balance, loading will be returned
+ * After the balance is updated, or after 5 minutes, loading will return false. And delete the recorded metadata information to avoid calculating this data next time
+ * The 5-minute time limit is to avoid operations on other terminals or other tabs, which will cause the balance comparison to be invalid and keep loading.
+ */
+export declare const useBalanceUpdateLoading: () => {
+    balanceData: BalanceData;
+    balanceDataDone: BalanceData;
+    isTokenLoading: (address: string, balance: BigNumber | number | string) => boolean;
+    isTokenLoadingDone: (address: string, balance: BigNumber | number | string) => boolean;
+};

package/dist/types/hooks/Submission/useExecution.d.ts

@@ -0,0 +1,27 @@
+import { State, Request, Showing, ExecutionCtx } from './types';
+export interface ExecutionProps {
+    onTxFail?: (error: Error, data: any) => void;
+    onTxSubmit?: (tx: string, data: any) => void;
+    onTxSuccess?: (tx: string, data: any) => void;
+    onTxReverted?: (tx: string, data: any) => void;
+    showSubmitLoadingDialog?: boolean;
+    executionStatus?: {
+        showing?: Showing | null;
+        showingDone?: boolean;
+        transactionTx?: string;
+        errorMessage?: string;
+        setErrorMessage?: (msg?: string | null) => void;
+        closeShowing?: () => void;
+    };
+}
+export default function useExecution({ onTxFail, onTxSubmit, onTxSuccess, onTxReverted, }?: ExecutionProps): {
+    showing: Showing | null;
+    showingDone: boolean;
+    transactionTx: string;
+    errorMessage: string | null;
+    setErrorMessage: import("react").Dispatch<import("react").SetStateAction<string | null>>;
+    closeShowing: () => void;
+    setShowing: import("react").Dispatch<import("react").SetStateAction<Showing | null>>;
+    ctxVal: ExecutionCtx;
+    requests: Map<string, [Request, State]>;
+};

package/dist/types/hooks/Submission/useInflights.d.ts

@@ -0,0 +1,5 @@
+import { Request } from './types';
+export default function useInflights(): {
+    runningRequests: Request[];
+    isInflight: boolean;
+};

package/dist/types/hooks/Submission/useSubmissionStatusColor.d.ts

@@ -0,0 +1,18 @@
+export declare enum StateText {
+    Running = "pending",
+    Success = "success",
+    Failed = "failed",
+    /** Accelerated or canceled tx warning handling */
+    Warning = "reset"
+}
+export declare function useSubmissionStatusColor({ status, stateTextMap, }: {
+    status: string | number;
+    stateTextMap?: {
+        [key: string | number]: StateText;
+    };
+}): {
+    state: StateText;
+    statusText: string;
+    statusColor: string;
+    statusAlphaColor: number | undefined;
+};

package/dist/types/hooks/Swap/index.d.ts

@@ -0,0 +1,4 @@
+export * from './useMarginAmount';
+export * from './useFetchFiatPrice';
+export * from './useFetchRoutePrice';
+export { default as useExecuteSwap } from './useExecuteSwap';

package/dist/types/hooks/Swap/useCustomSlippage.d.ts

@@ -0,0 +1,10 @@
+import { TokenInfo } from '../Token';
+import { CustomSwapPairSlippage } from './useSwapSettingStore';
+export declare function useCustomSlippage({ fromToken, toToken, }: {
+    fromToken?: TokenInfo | null;
+    toToken?: TokenInfo | null;
+}): {
+    customSlippageNum: number;
+    customSlippage: string | undefined;
+    handleSlippageChange: (newItem: Pick<CustomSwapPairSlippage, "slippage" | "recommend" | "disabled" | "deleted">) => void;
+};

package/dist/types/hooks/Swap/useExecuteSwap.d.ts

@@ -0,0 +1,13 @@
+import { BigNumber as EthersBigNumber } from '@ethersproject/bignumber';
+import React from 'react';
+export default function useExecuteSwap(): ({ to, data, useSource, duration, ddl, gasLimit, subtitle, value, mixpanelProps, }: {
+    value: string;
+    to: string;
+    data: string;
+    useSource?: string;
+    duration?: number;
+    ddl: number;
+    gasLimit?: EthersBigNumber;
+    subtitle: React.ReactNode;
+    mixpanelProps?: Record<string, any>;
+}) => void;

package/dist/types/hooks/Swap/useFetchFiatPrice.d.ts

@@ -0,0 +1,13 @@
+import { TokenInfo } from '../Token';
+export interface FetchFiatPriceProps {
+    fromToken: TokenInfo | null;
+    toToken: TokenInfo | null;
+}
+export declare function useFetchFiatPrice({ fromToken, toToken }: FetchFiatPriceProps): {
+    loading: boolean;
+    isLoading: boolean;
+    refetch: () => void;
+    error: Error | null;
+    toFiatPrice: string;
+    fromFiatPrice: string;
+};

package/dist/types/hooks/Swap/useFetchFiatPrice.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/hooks/Swap/useFetchRoutePrice.d.ts

@@ -0,0 +1,40 @@
+import React from 'react';
+import { TokenInfo } from '../Token';
+export declare enum RoutePriceStatus {
+    Initial = "Initial",
+    Loading = "Loading",
+    Failed = "Failed",
+    Success = "Success"
+}
+export interface FetchRoutePrice {
+    fromToken: TokenInfo | null;
+    toToken: TokenInfo | null;
+    marginAmount?: string;
+    fromAmount: string;
+    toAmount: string;
+    estimateGas?: boolean;
+    isReverseRouting?: boolean;
+    slippage?: number;
+    slippageLoading?: boolean;
+}
+interface IRouteResponse {
+    resAmount: number;
+    priceImpact: number;
+    baseFeeAmount: number;
+    additionalFeeAmount: number;
+    resPricePerToToken: number;
+    resPricePerFromToken: number;
+    to: string;
+    data: string;
+    value: string;
+    useSource: string;
+    duration: number;
+}
+export declare function useFetchRoutePrice({ toToken, fromToken, fromAmount, toAmount, marginAmount, estimateGas, isReverseRouting, slippage, slippageLoading, }: FetchRoutePrice): {
+    status: RoutePriceStatus;
+    rawBrief: IRouteResponse | null;
+    refetch: () => Promise<void>;
+    executeSwap: (subtitle: React.ReactNode) => void;
+    reset: () => void;
+};
+export {};

package/dist/types/hooks/Swap/useFetchRoutePrice.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/hooks/Swap/useForecastSlippageList.d.ts

@@ -0,0 +1,172 @@
+import { TokenInfo } from '../Token';
+export interface ForecastSlippageListItem {
+    forecastSlippage?: number;
+    forecastValue?: number;
+    confidenceRatio?: number;
+    confidenceIntervalUpper?: number;
+    confidenceIntervalLower?: number;
+}
+export declare function useForecastSlippageList({ fromToken, toToken, }: {
+    fromToken: TokenInfo | undefined | null;
+    toToken: TokenInfo | undefined | null;
+}): {
+    data: import("@dodoex/api/dist/types/gql/graphql").FetchErc20ForecastSlippageQuery;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("@dodoex/api/dist/types/gql/graphql").FetchErc20ForecastSlippageQuery, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    slippageData: {
+        recommendSlippage?: undefined;
+        slippageList?: undefined;
+    } | {
+        recommendSlippage: ForecastSlippageListItem | undefined;
+        slippageList: ForecastSlippageListItem[];
+    };
+} | {
+    data: import("@dodoex/api/dist/types/gql/graphql").FetchErc20ForecastSlippageQuery;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("@dodoex/api/dist/types/gql/graphql").FetchErc20ForecastSlippageQuery, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    slippageData: {
+        recommendSlippage?: undefined;
+        slippageList?: undefined;
+    } | {
+        recommendSlippage: ForecastSlippageListItem | undefined;
+        slippageList: ForecastSlippageListItem[];
+    };
+} | {
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("@dodoex/api/dist/types/gql/graphql").FetchErc20ForecastSlippageQuery, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    slippageData: {
+        recommendSlippage?: undefined;
+        slippageList?: undefined;
+    } | {
+        recommendSlippage: ForecastSlippageListItem | undefined;
+        slippageList: ForecastSlippageListItem[];
+    };
+} | {
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("@dodoex/api/dist/types/gql/graphql").FetchErc20ForecastSlippageQuery, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    slippageData: {
+        recommendSlippage?: undefined;
+        slippageList?: undefined;
+    } | {
+        recommendSlippage: ForecastSlippageListItem | undefined;
+        slippageList: ForecastSlippageListItem[];
+    };
+} | {
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<import("@dodoex/api/dist/types/gql/graphql").FetchErc20ForecastSlippageQuery, Error>>;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
+    slippageData: {
+        recommendSlippage?: undefined;
+        slippageList?: undefined;
+    } | {
+        recommendSlippage: ForecastSlippageListItem | undefined;
+        slippageList: ForecastSlippageListItem[];
+    };
+};

package/dist/types/hooks/Swap/useInitDefaultToken.d.ts

@@ -0,0 +1,10 @@
+import { TokenInfo } from '../Token';
+export declare function useInitDefaultToken({ fromToken, toToken, setFromToken, setToToken, updateFromAmt, updateToAmt, setIsReverseRouting, }: {
+    fromToken: TokenInfo | null;
+    toToken: TokenInfo | null;
+    setFromToken: (value: React.SetStateAction<TokenInfo | null>) => void;
+    setToToken: (value: React.SetStateAction<TokenInfo | null>) => void;
+    updateFromAmt: (v: string | number) => void;
+    updateToAmt: (v: string | number) => void;
+    setIsReverseRouting: React.Dispatch<React.SetStateAction<boolean>>;
+}): void;

package/dist/types/hooks/Swap/useMarginAmount.d.ts

@@ -0,0 +1,8 @@
+import { TokenInfo } from '../Token';
+export interface MarginAmountProps {
+    token: TokenInfo | null;
+    fiatPrice: string;
+}
+export declare function useMarginAmount({ token, fiatPrice }: MarginAmountProps): {
+    marginAmount: string;
+};

package/dist/types/hooks/Swap/useMarginAmount.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/hooks/Swap/usePriceTimer.d.ts

@@ -0,0 +1,5 @@
+export interface PriceTimerProps {
+    refetch: () => void;
+    interval?: number;
+}
+export declare function usePriceTimer({ refetch, interval }: PriceTimerProps): void;

package/dist/types/hooks/Swap/useSlippageLimit.d.ts

@@ -0,0 +1,2 @@
+export declare const getMaxSlippageWarning: (chainId: number | undefined) => 5 | 32;
+export declare const useSlippageLimit: (slippageSwap: number | undefined, chainId: number | undefined) => boolean;

package/dist/types/hooks/Swap/useSwapSettingStore.d.ts

@@ -0,0 +1,37 @@
+export interface CustomSwapPairSlippage {
+    account: string;
+    from: string;
+    to: string;
+    /** Should be consistent with fromToken */
+    chainId: number;
+    disabled?: boolean;
+    /** Whether it has been deleted: not necessarily deleted */
+    deleted?: boolean;
+    slippage: string;
+    fromSymbol: string;
+    fromLogo: string | null;
+    toSymbol: string;
+    toLogo: string | null;
+    recommend: string;
+}
+interface SwapSettingState {
+    slippageAdvanced: boolean;
+    customSwapPairSlippages: Array<CustomSwapPairSlippage>;
+    notRemindAgainSlippageHigher: boolean;
+    notRemindAgainSlippageLower: boolean;
+    ddl: string;
+    expertMode: boolean;
+    disableIndirectRouting: boolean;
+}
+export declare const useSwapSettingStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<SwapSettingState>, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<SwapSettingState, SwapSettingState>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: SwapSettingState) => void) => () => void;
+        onFinishHydration: (fn: (state: SwapSettingState) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<SwapSettingState, SwapSettingState>>;
+    };
+}>;
+export {};