@0xsplits/splits-sdk-react/dist/hooks/data.d.ts

React wrapper for the 0xSplits SDK

import { Address } from 'viem';
import { FormattedContractEarnings, FormattedSplitEarnings, FormattedUserEarnings, FormattedUserEarningsByContract, LiquidSplit, Split, Swapper, VestingModule, WaterfallModule } from '@0xsplits/splits-sdk';
import { DataLoadStatus, RequestError, SplitProviderSearchCacheData } from '../types';
export declare const useSplitMetadataViaProvider: (chainId: number, splitAddress: string, options?: {
    cacheData?: {
        blockRange?: bigint;
        controller?: Address;
        blocks?: {
            createBlock?: bigint;
            updateBlock?: bigint;
            latestScannedBlock: bigint;
        };
    };
}) => {
    isLoading: boolean;
    data?: Split;
    status?: DataLoadStatus;
    error?: RequestError;
    currentBlockRange?: {
        from: bigint;
        to: bigint;
    };
    cacheData?: SplitProviderSearchCacheData;
};
export declare const useSplitMetadata: (chainId: number, splitAddress: string, options?: {
    requireDataClient?: boolean;
}) => {
    isLoading: boolean;
    data: Split | undefined;
    status?: DataLoadStatus;
    error?: RequestError;
};
export declare const useSplitEarnings: (chainId: number, splitAddress: string, options?: {
    includeActiveBalances?: boolean;
    erc20TokenList?: string[];
    requireDataClient?: boolean;
}) => {
    isLoading: boolean;
    data: FormattedSplitEarnings | undefined;
    refetch: () => void;
    status?: DataLoadStatus;
    error?: RequestError;
};
export declare const useContractEarnings: (chainId: number, contractAddress: string, options?: {
    includeActiveBalances?: boolean;
    erc20TokenList?: string[];
}) => {
    isLoading: boolean;
    data: FormattedContractEarnings | undefined;
    status?: DataLoadStatus;
    error?: RequestError;
};
export declare const useLiquidSplitMetadata: (chainId: number, liquidSplitAddress: string) => {
    isLoading: boolean;
    data: LiquidSplit | undefined;
    status?: DataLoadStatus;
    error?: RequestError;
};
export declare const useSwapperMetadata: (chainId: number, swapperAddress: string) => {
    isLoading: boolean;
    data: Swapper | undefined;
    status?: DataLoadStatus;
    error?: RequestError;
};
export declare const useUserEarnings: (chainId: number, userAddress: string) => {
    isLoading: boolean;
    data?: FormattedUserEarnings;
    status?: DataLoadStatus;
    error?: RequestError;
};
export declare const useUserEarningsByContract: (chainId: number, userAddress: string, options?: {
    contractAddresses?: string[];
}) => {
    isLoading: boolean;
    data?: FormattedUserEarningsByContract;
    status?: DataLoadStatus;
    error?: RequestError;
};
export declare const useVestingMetadata: (chainId: number, vestingModuleAddress: string) => {
    isLoading: boolean;
    data: VestingModule | undefined;
    status?: DataLoadStatus;
    error?: RequestError;
};
export declare const useWaterfallMetadata: (chainId: number, waterfallModuleAddress: string) => {
    isLoading: boolean;
    data: WaterfallModule | undefined;
    status?: DataLoadStatus;
    error?: RequestError;
};