@reservoir0x/reservoir-kit-ui
Version:
ReservoirKit is the official frontend kit to get you started building dApps with the ReservoirProtocol.
1,236 lines • 5.05 MB
TypeScript
import React, { FC, ReactNode, ComponentPropsWithoutRef, Dispatch, ReactElement, SetStateAction, CSSProperties, VideoHTMLAttributes, AudioHTMLAttributes, IframeHTMLAttributes, ComponentPropsWithRef } from "react";
import { ReservoirClientOptions, paths, Execute, ReservoirChain, ReservoirWallet, BuyTokenBodyParameters, ReservoirClientActions, SellPath } from "@reservoir0x/reservoir-sdk";
import { SWRInfiniteConfiguration } from "swr/infinite";
import { SWRConfiguration, SWRConfig } from "swr";
import { Address, WalletClient } from "viem";
import * as Popover from "@radix-ui/react-popover";
import * as DialogPrimitive from "@radix-ui/react-dialog";
import { CSS } from "@stitches/react";
export interface ReservoirKitTheme {
radii: {
borderRadius: string;
};
fonts: {
body: string;
button: string;
headline: string;
};
colors: ReservoirKitThemeColors;
assets: {
ethIcon: 'glyph' | 'gray' | 'purple';
chainIcon: 'dark' | 'light';
};
}
interface ReservoirKitThemeColors {
accentBase: string;
accentBgSubtle: string;
accentBg: string;
accentBgHover: string;
accentBgActive: string;
accentLine: string;
accentBorder: string;
accentBorderHover: string;
accentSolid: string;
accentSolidHover: string;
accentText: string;
accentTextContrast: string;
neutralBase: string;
neutralBgSubtle: string;
neutralBg: string;
neutralBgHover: string;
neutralBgActive: string;
neutralLine: string;
neutralBorder: string;
neutralBorderHover: string;
neutralSolid: string;
neutralSolidHover: string;
neutralText: string;
neutralTextContrast: string;
secondaryBase: string;
secondaryBgSubtle: string;
secondaryBg: string;
secondaryBgHover: string;
secondaryBgActive: string;
secondaryLine: string;
secondaryBorder: string;
secondaryBorderHover: string;
secondarySolid: string;
secondarySolidHover: string;
secondaryText: string;
secondaryTextContrast: string;
borderColor: string;
textColor: string;
focusColor: string;
errorText: string;
errorAccent: string;
successAccent: string;
reservoirLogoColor: string;
inputBackground: string;
buttonTextColor: string;
buttonTextHoverColor: string;
overlayBackground: string;
headerBackground: string;
footerBackground: string;
contentBackground: string;
wellBackground: string;
popoverBackground: string;
}
type ReservoirKitOverrides = {
borderRadius?: string;
font?: string;
buttonFont?: string;
buttonTextColor?: string;
buttonTextHoverColor?: string;
headlineFont?: string;
primaryColor?: string;
primaryHoverColor?: string;
wellBackground?: string;
textColor?: string;
headerBackground?: string;
contentBackground?: string;
footerBackground?: string;
overlayBackground?: string;
popoverBackground?: string;
borderColor?: string;
ethIcon?: ReservoirKitTheme['assets']['ethIcon'];
chainIcon?: ReservoirKitTheme['assets']['chainIcon'];
};
export function lightTheme(overrides?: ReservoirKitOverrides): ReservoirKitTheme;
export function darkTheme(overrides?: ReservoirKitOverrides): ReservoirKitTheme;
interface ReservoirClientProviderProps {
children: ReactNode;
options: ReservoirClientOptions;
}
export const ReservoirClientProvider: FC<ReservoirClientProviderProps>;
type CollectionsQuery = paths['/collections/v7']['get']['parameters']['query'];
export function useCollections(options?: CollectionsQuery | false, swrOptions?: SWRInfiniteConfiguration, chainId?: number): {
data: {
chainId: number;
id?: string | undefined;
slug?: string | undefined;
createdAt?: string | undefined;
updatedAt?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
contractDeployedAt?: string | undefined;
image?: string | undefined;
banner?: string | undefined;
discordUrl?: string | undefined;
externalUrl?: string | undefined;
twitterUsername?: string | undefined;
twitterUrl?: string | undefined;
openseaVerificationStatus?: string | undefined;
magicedenVerificationStatus?: string | undefined;
description?: string | undefined;
metadataDisabled?: boolean | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
isMinting?: boolean | undefined;
sampleImages?: string[] | undefined;
tokenCount?: string | undefined;
onSaleCount?: string | undefined;
primaryContract?: string | undefined;
tokenSetId?: string | undefined;
creator?: string | undefined;
isSharedContract?: boolean | undefined;
royalties?: {
recipient?: string | undefined;
breakdown?: {
recipient?: string | undefined;
bps?: number | undefined;
}[] | undefined;
bps?: number | undefined;
} | undefined;
allRoyalties?: {
[key: string]: unknown;
} | undefined;
floorAsk?: {
id?: string | undefined;
sourceDomain?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
maker?: string | undefined;
validFrom?: number | undefined;
validUntil?: number | undefined;
token?: {
contract?: string | undefined;
tokenId?: string | undefined;
name?: string | undefined;
image?: string | undefined;
} | undefined;
} | undefined;
topBid?: {
id?: string | undefined;
sourceDomain?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
maker?: string | undefined;
validFrom?: number | undefined;
validUntil?: number | undefined;
} | undefined;
rank?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
volume?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
volumeChange?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
floorSale?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
floorSaleChange?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
salesCount?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
collectionBidSupported?: boolean | undefined;
ownerCount?: number | undefined;
attributes?: {
key?: string | undefined;
kind?: string | undefined;
count?: number | undefined;
}[] | undefined;
contractKind?: string | undefined;
mintedTimestamp?: number | undefined;
lastMintTimestamp?: number | undefined;
mintStages?: {
stage: string;
tokenId?: string | undefined;
kind: string;
standard?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
pricePerQuantity?: {
price: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
};
quantity?: number | undefined;
}[] | undefined;
startTime?: number | undefined;
endTime?: number | undefined;
maxMints?: number | undefined;
maxMintsPerWallet?: number | undefined;
}[] | undefined;
securityConfig?: {
operatorWhitelist?: string[] | undefined;
operatorBlacklist?: string[] | undefined;
receiverAllowList?: string[] | undefined;
authorizers?: string[] | undefined;
transferSecurityLevel?: number | undefined;
transferValidator?: string | undefined;
} | undefined;
supply?: number | undefined;
remainingSupply?: number | undefined;
}[];
hasNextPage: boolean;
isFetchingInitialData: boolean;
isFetchingPage: any;
resetCache: () => Promise<void>;
fetchNextPage: () => void;
size: number;
setSize: (size: number | ((_size: number) => number)) => Promise<{
continuation?: string | undefined;
collections?: {
chainId: number;
id?: string | undefined;
slug?: string | undefined;
createdAt?: string | undefined;
updatedAt?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
contractDeployedAt?: string | undefined;
image?: string | undefined;
banner?: string | undefined;
discordUrl?: string | undefined;
externalUrl?: string | undefined;
twitterUsername?: string | undefined;
twitterUrl?: string | undefined;
openseaVerificationStatus?: string | undefined;
magicedenVerificationStatus?: string | undefined;
description?: string | undefined;
metadataDisabled?: boolean | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
isMinting?: boolean | undefined;
sampleImages?: string[] | undefined;
tokenCount?: string | undefined;
onSaleCount?: string | undefined;
primaryContract?: string | undefined;
tokenSetId?: string | undefined;
creator?: string | undefined;
isSharedContract?: boolean | undefined;
royalties?: {
recipient?: string | undefined;
breakdown?: {
recipient?: string | undefined;
bps?: number | undefined;
}[] | undefined;
bps?: number | undefined;
} | undefined;
allRoyalties?: {
[key: string]: unknown;
} | undefined;
floorAsk?: {
id?: string | undefined;
sourceDomain?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
maker?: string | undefined;
validFrom?: number | undefined;
validUntil?: number | undefined;
token?: {
contract?: string | undefined;
tokenId?: string | undefined;
name?: string | undefined;
image?: string | undefined;
} | undefined;
} | undefined;
topBid?: {
id?: string | undefined;
sourceDomain?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
maker?: string | undefined;
validFrom?: number | undefined;
validUntil?: number | undefined;
} | undefined;
rank?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
volume?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
volumeChange?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
floorSale?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
floorSaleChange?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
salesCount?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
collectionBidSupported?: boolean | undefined;
ownerCount?: number | undefined;
attributes?: {
key?: string | undefined;
kind?: string | undefined;
count?: number | undefined;
}[] | undefined;
contractKind?: string | undefined;
mintedTimestamp?: number | undefined;
lastMintTimestamp?: number | undefined;
mintStages?: {
stage: string;
tokenId?: string | undefined;
kind: string;
standard?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
pricePerQuantity?: {
price: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
};
quantity?: number | undefined;
}[] | undefined;
startTime?: number | undefined;
endTime?: number | undefined;
maxMints?: number | undefined;
maxMintsPerWallet?: number | undefined;
}[] | undefined;
securityConfig?: {
operatorWhitelist?: string[] | undefined;
operatorBlacklist?: string[] | undefined;
receiverAllowList?: string[] | undefined;
authorizers?: string[] | undefined;
transferSecurityLevel?: number | undefined;
transferValidator?: string | undefined;
} | undefined;
supply?: number | undefined;
remainingSupply?: number | undefined;
}[] | undefined;
}[] | undefined>;
error: any;
mutate: import("swr/_internal").KeyedMutator<{
continuation?: string | undefined;
collections?: {
chainId: number;
id?: string | undefined;
slug?: string | undefined;
createdAt?: string | undefined;
updatedAt?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
contractDeployedAt?: string | undefined;
image?: string | undefined;
banner?: string | undefined;
discordUrl?: string | undefined;
externalUrl?: string | undefined;
twitterUsername?: string | undefined;
twitterUrl?: string | undefined;
openseaVerificationStatus?: string | undefined;
magicedenVerificationStatus?: string | undefined;
description?: string | undefined;
metadataDisabled?: boolean | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
isMinting?: boolean | undefined;
sampleImages?: string[] | undefined;
tokenCount?: string | undefined;
onSaleCount?: string | undefined;
primaryContract?: string | undefined;
tokenSetId?: string | undefined;
creator?: string | undefined;
isSharedContract?: boolean | undefined;
royalties?: {
recipient?: string | undefined;
breakdown?: {
recipient?: string | undefined;
bps?: number | undefined;
}[] | undefined;
bps?: number | undefined;
} | undefined;
allRoyalties?: {
[key: string]: unknown;
} | undefined;
floorAsk?: {
id?: string | undefined;
sourceDomain?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
maker?: string | undefined;
validFrom?: number | undefined;
validUntil?: number | undefined;
token?: {
contract?: string | undefined;
tokenId?: string | undefined;
name?: string | undefined;
image?: string | undefined;
} | undefined;
} | undefined;
topBid?: {
id?: string | undefined;
sourceDomain?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
maker?: string | undefined;
validFrom?: number | undefined;
validUntil?: number | undefined;
} | undefined;
rank?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
volume?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
volumeChange?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
floorSale?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
floorSaleChange?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
} | undefined;
salesCount?: {
"1day"?: number | undefined;
"7day"?: number | undefined;
"30day"?: number | undefined;
allTime?: number | undefined;
} | undefined;
collectionBidSupported?: boolean | undefined;
ownerCount?: number | undefined;
attributes?: {
key?: string | undefined;
kind?: string | undefined;
count?: number | undefined;
}[] | undefined;
contractKind?: string | undefined;
mintedTimestamp?: number | undefined;
lastMintTimestamp?: number | undefined;
mintStages?: {
stage: string;
tokenId?: string | undefined;
kind: string;
standard?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
pricePerQuantity?: {
price: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
};
quantity?: number | undefined;
}[] | undefined;
startTime?: number | undefined;
endTime?: number | undefined;
maxMints?: number | undefined;
maxMintsPerWallet?: number | undefined;
}[] | undefined;
securityConfig?: {
operatorWhitelist?: string[] | undefined;
operatorBlacklist?: string[] | undefined;
receiverAllowList?: string[] | undefined;
authorizers?: string[] | undefined;
transferSecurityLevel?: number | undefined;
transferValidator?: string | undefined;
} | undefined;
supply?: number | undefined;
remainingSupply?: number | undefined;
}[] | undefined;
}[]>;
isValidating: boolean;
isLoading: boolean;
};
type CollectionActivityQuery = paths['/collections/activity/v6']['get']['parameters']['query'];
export function useCollectionActivity(options?: CollectionActivityQuery | false, swrOptions?: SWRInfiniteConfiguration, chainId?: number): {
data: {
type?: string | undefined;
fromAddress?: string | undefined;
toAddress?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
amount?: number | undefined;
timestamp?: number | undefined;
createdAt?: string | undefined;
contract?: string | undefined;
token?: {
tokenId?: string | undefined;
tokenName?: string | undefined;
tokenImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
rarityScore?: number | undefined;
rarityRank?: number | undefined;
} | undefined;
collection?: {
collectionId?: string | undefined;
collectionName?: string | undefined;
collectionImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
txHash?: string | undefined;
logIndex?: number | undefined;
batchIndex?: number | undefined;
fillSource?: {
id?: string | undefined;
domain?: string | undefined;
name?: string | undefined;
icon?: string | undefined;
url?: string | undefined;
} | undefined;
isAirdrop?: boolean | undefined;
comment?: string | undefined;
order?: {
id?: string | undefined;
side?: "ask" | "bid" | undefined;
source?: {
[key: string]: unknown;
} | undefined;
criteria?: {
kind?: "token" | undefined;
data?: {
token?: {
tokenId?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
collection?: {
id?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
} | undefined;
} | undefined;
} | undefined;
}[];
hasNextPage: boolean;
isFetchingInitialData: boolean;
isFetchingPage: any;
resetCache: () => Promise<void>;
fetchNextPage: () => void;
size: number;
setSize: (size: number | ((_size: number) => number)) => Promise<{
continuation?: string | undefined;
activities?: {
type?: string | undefined;
fromAddress?: string | undefined;
toAddress?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
amount?: number | undefined;
timestamp?: number | undefined;
createdAt?: string | undefined;
contract?: string | undefined;
token?: {
tokenId?: string | undefined;
tokenName?: string | undefined;
tokenImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
rarityScore?: number | undefined;
rarityRank?: number | undefined;
} | undefined;
collection?: {
collectionId?: string | undefined;
collectionName?: string | undefined;
collectionImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
txHash?: string | undefined;
logIndex?: number | undefined;
batchIndex?: number | undefined;
fillSource?: {
id?: string | undefined;
domain?: string | undefined;
name?: string | undefined;
icon?: string | undefined;
url?: string | undefined;
} | undefined;
isAirdrop?: boolean | undefined;
comment?: string | undefined;
order?: {
id?: string | undefined;
side?: "ask" | "bid" | undefined;
source?: {
[key: string]: unknown;
} | undefined;
criteria?: {
kind?: "token" | undefined;
data?: {
token?: {
tokenId?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
collection?: {
id?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
} | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}[] | undefined>;
error: any;
mutate: import("swr/_internal").KeyedMutator<{
continuation?: string | undefined;
activities?: {
type?: string | undefined;
fromAddress?: string | undefined;
toAddress?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
amount?: number | undefined;
timestamp?: number | undefined;
createdAt?: string | undefined;
contract?: string | undefined;
token?: {
tokenId?: string | undefined;
tokenName?: string | undefined;
tokenImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
rarityScore?: number | undefined;
rarityRank?: number | undefined;
} | undefined;
collection?: {
collectionId?: string | undefined;
collectionName?: string | undefined;
collectionImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
txHash?: string | undefined;
logIndex?: number | undefined;
batchIndex?: number | undefined;
fillSource?: {
id?: string | undefined;
domain?: string | undefined;
name?: string | undefined;
icon?: string | undefined;
url?: string | undefined;
} | undefined;
isAirdrop?: boolean | undefined;
comment?: string | undefined;
order?: {
id?: string | undefined;
side?: "ask" | "bid" | undefined;
source?: {
[key: string]: unknown;
} | undefined;
criteria?: {
kind?: "token" | undefined;
data?: {
token?: {
tokenId?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
collection?: {
id?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
} | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}[]>;
isValidating: boolean;
isLoading: boolean;
};
type UsersActivityBaseQuery = paths['/users/activity/v6']['get']['parameters']['query'];
type UsersQuery = UsersActivityBaseQuery['users'] | undefined;
type UsersActivityQuery = Omit<UsersActivityBaseQuery, 'users'>;
export function useUsersActivity(users?: UsersQuery, options?: UsersActivityQuery | false, swrOptions?: SWRInfiniteConfiguration, chainId?: number): {
data: {
type?: string | undefined;
fromAddress?: string | undefined;
toAddress?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
amount?: number | undefined;
timestamp?: number | undefined;
contract?: string | undefined;
token?: {
tokenId?: string | undefined;
tokenName?: string | undefined;
tokenImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
lastBuy?: {
value?: number | undefined;
timestamp?: number | undefined;
} | undefined;
lastSell?: {
value?: number | undefined;
timestamp?: number | undefined;
} | undefined;
tokenRarityScore?: number | undefined;
tokenRarityRank?: number | undefined;
tokenMedia?: string | undefined;
} | undefined;
collection?: {
collectionId?: string | undefined;
collectionName?: string | undefined;
collectionImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
txHash?: string | undefined;
logIndex?: number | undefined;
batchIndex?: number | undefined;
fillSource?: {
id?: string | undefined;
domain?: string | undefined;
name?: string | undefined;
icon?: string | undefined;
url?: string | undefined;
} | undefined;
isAirdrop?: boolean | undefined;
comment?: string | undefined;
order?: {
id?: string | undefined;
side?: "ask" | "bid" | undefined;
source?: {
[key: string]: unknown;
} | undefined;
criteria?: {
kind?: "token" | undefined;
data?: {
token?: {
tokenId?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
collection?: {
id?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
} | undefined;
} | undefined;
} | undefined;
createdAt?: string | undefined;
}[];
hasNextPage: boolean;
isFetchingInitialData: boolean;
isFetchingPage: any;
resetCache: () => Promise<void>;
fetchNextPage: () => void;
size: number;
setSize: (size: number | ((_size: number) => number)) => Promise<{
continuation?: string | undefined;
activities?: {
type?: string | undefined;
fromAddress?: string | undefined;
toAddress?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symbol?: string | undefined;
decimals?: number | undefined;
chainId?: number | undefined;
} | undefined;
amount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
netAmount?: {
raw?: string | undefined;
decimal?: number | undefined;
usd?: number | undefined;
native?: number | undefined;
} | undefined;
} | undefined;
amount?: number | undefined;
timestamp?: number | undefined;
contract?: string | undefined;
token?: {
tokenId?: string | undefined;
tokenName?: string | undefined;
tokenImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
lastBuy?: {
value?: number | undefined;
timestamp?: number | undefined;
} | undefined;
lastSell?: {
value?: number | undefined;
timestamp?: number | undefined;
} | undefined;
tokenRarityScore?: number | undefined;
tokenRarityRank?: number | undefined;
tokenMedia?: string | undefined;
} | undefined;
collection?: {
collectionId?: string | undefined;
collectionName?: string | undefined;
collectionImage?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
txHash?: string | undefined;
logIndex?: number | undefined;
batchIndex?: number | undefined;
fillSource?: {
id?: string | undefined;
domain?: string | undefined;
name?: string | undefined;
icon?: string | undefined;
url?: string | undefined;
} | undefined;
isAirdrop?: boolean | undefined;
comment?: string | undefined;
order?: {
id?: string | undefined;
side?: "ask" | "bid" | undefined;
source?: {
[key: string]: unknown;
} | undefined;
criteria?: {
kind?: "token" | undefined;
data?: {
token?: {
tokenId?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
collection?: {
id?: string | undefined;
name?: string | undefined;
image?: string | undefined;
isSpam?: boolean | undefined;
isNsfw?: boolean | undefined;
} | undefined;
} | undefined;
} | undefined;
} | undefined;
createdAt?: string | undefined;
}[] | undefined;
}[] | undefined>;
error: any;
mutate: import("swr/_internal").KeyedMutator<{
continuation?: string | undefined;
activities?: {
type?: string | undefined;
fromAddress?: string | undefined;
toAddress?: string | undefined;
price?: {
currency?: {
contract?: string | undefined;
name?: string | undefined;
symb