マーケットプレイスデータフック

主要なマーケットプレイスデータを取得するためのGETフックのコレクションです。UIでマーケットプレイス情報を取得・管理するのに便利です。

​

useMarketplaceConfig

useMarketplaceConfigフックは、Builderからコレクション、SNSリンク、タイトル、その他の設定など、マーケットプレイスの構成情報を取得します。

import { useMarketplaceConfig } from "@0xsequence/marketplace-sdk/react";

## Into your React component:

const data = useMarketplaceConfig();

useMarketplaceConfig

* return properties

表示 子属性

publisherId · string

マーケットプレイス発行者の一意の識別子。

title · string

マーケットプレイスのタイトル。

shortDescription · string

マーケットプレイスの簡単な説明。

socials · MarketplaceSocials

マーケットプレイスに関連するSNSリンク。

faviconUrl · string

マーケットプレイスのファビコンのURL。

landingBannerUrl · string

ランディングページ用マーケットプレイスバナーのURL

collections · MarketplaceCollection[]

マーケットプレイスのコレクション配列。

walletOptions · MarketplaceWalletOptions

ウォレット連携のための設定オプション。

landingPageLayout · string

マーケットプレイスのランディングページ用レイアウト設定。

logoUrl · string

マーケットプレイスのロゴURL。

bannerUrl · string

マーケットプレイスのバナーURL。

fontUrl · string | undefined

マーケットプレイスで使用されるカスタムフォントのURL。

ogImage · string | undefined

ogImageのURL

cssString · string

マーケットプレイス用のカスタムCSSスタイル。

manifestUrl · string

マーケットプレイスのマニフェストファイルのURL。

​

useListCollectibles

useListCollectiblesフックは、マーケットプレイスのコレクション内の現在の出品やオファーを取得します。出品やオファーを効率的に管理・取得するのに役立ちます。

import { OrderSide } from '@0xsequence/marketplace-sdk';
import { useListCollectibles } from '@0xsequence/marketplace-sdk/react';

## Into your React component:

const {
  data: collectibles,
  isLoading: collectiblesLoading,
  fetchNextPage: fetchNextCollectibles,
} = useListCollectibles({
  chainId,
  collectionAddress,
  filter: {
    // # Optional filters
    includeEmpty,
    searchText,
    properties,
  },
  side: OrderSide.listing,
});

const collectiblesFlat =
  collectibles?.pages.flatMap((p) => p.collectibles) ?? [];

return (
  <div>
    {collectiblesFlat?.map((collectible) => (
      // Your Collectibles component
    ))}
  </div>
);

useListCollectibles

* params

表示 子属性

interface UseListCollectiblesArgs {
  chainId: string;
  side: OrderSide;
  collectionAddress: `0x${string}`;
  page?: {
    page: number;
    pageSize: number;
    sort?: {
      order: SortOrder$1;
      column: string;
    }[];
    more?: boolean;
  };
  filter?: {
    includeEmpty: boolean;
    searchText?: string;
    properties?: {
      type: PropertyType;
      name: string;
      values?: any[];
      max?: number;
      min?: number;
    }[];
    marketplaces?: MarketplaceKind[];
    inAccounts?: string[];
    notInAccounts?: string[];
    ordersCreatedBy?: string[];
    ordersNotCreatedBy?: string[];
  };
  query?: {
    enabled?: boolean;
  };
}

* return properties

表示 子属性

data · ListCollectiblesReturn

ページごとに分割されたコレクティブル注文データを含みます。

data.pages · CollectibleOrder[]

ページごとに返されるコレクティブル注文のリスト。

isLoading · boolean

データが現在読み込み中かどうかを示します。

fetchNextPage · (options?: FetchNextPageOptions) => Promise<UseInfiniteQueryResult>

この関数で次の「ページ」の結果を取得できます。

​

useListCollectiblesPaginated

useListCollectiblesPaginatedフックは、マーケットプレイスから現在の出品やオファーを効率的に取得・管理します。コレクション内でページ分割されたNFTを表示するのに最適です。

import { OrderSide } from '@0xsequence/marketplace-sdk';
import { useListCollectiblesPaginated } from '@0xsequence/marketplace-sdk/react';

const chainId = 137;
const searchText = "";
const enabled = true;
const includeEmpty = true;
const properties = [];
const pageSize = 30;
const currentPage = 1;
const collectionAddress = "0x0e5566a108e617baedbebb44e3fcc7bf03e3a839";

## Into your React component:

const {
    data: collectiblesResponse,
    isLoading: collectiblesLoading,
} = useListCollectiblesPaginated({
  chainId: String(chainId),
  collectionAddress,
  side: OrderSide.listing,
  filter: {
    // # Optional filters
    includeEmpty,
    searchText,
    properties,
  },
  page: {
    page: currentPage,
    pageSize,
  },
  query: {
    page: currentPage,
    pageSize,
    enabled,
  },
});

const collectiblesList = collectiblesResponse?.collectibles ?? [];

return (
  <div>
    {collectiblesList?.map((collectible) => (
      // Your Collectibles component
    ))}
  </div>
);

useListCollectiblesPaginated details

* params

表示 子属性

interface UseListCollectiblesPaginatedArgs {
  chainId: string;
  side: OrderSide;
  collectionAddress: `0x${string}`;
  page?: {
    page: number;
    pageSize: number;
    sort?: {
      order: SortOrder$1;
      column: string;
    }[];
    more?: boolean;
  };
  filter?: {
    includeEmpty: boolean;
    searchText?: string;
    properties?: {
      type: PropertyType;
      name: string;
      values?: any[];
      max?: number;
      min?: number;
    }[];
    marketplaces?: MarketplaceKind[];
    inAccounts?: string[];
    notInAccounts?: string[];
    ordersCreatedBy?: string[];
    ordersNotCreatedBy?: string[];
  };
  query: {
    page: number;
    pageSize: number;
    enabled?: boolean;
  };
}

* return properties

表示 子属性

data · ListCollectiblesReturn

コレクティブル注文データを含みます。

data.collectibles · CollectibleOrder[]

コレクティブル注文のリスト。

isLoading · boolean

データが現在読み込み中かどうかを示します。

​

useCountOfCollectables

useCountOfCollectablesフックは、コレクション内のNFT数を返します。

import { OrderSide } from '@0xsequence/marketplace-sdk';
import { useCountOfCollectables } from '@0xsequence/marketplace-sdk/react';

const countOfCollectables = useCountOfCollectables({
  chainId,
  collectionAddress,
  side: OrderSide.listing,
  filter: {
    searchText: text,
    includeEmpty,
    properties,
  },
});

useCountOfCollectables details

* params

表示 子属性

interface UseCountOfCollectables {
  chainId: ChainId;
  collectionAddress: CollectionAddress;
  query?: { enabled?: boolean };
  filter?: {
    includeEmpty: boolean;
    searchText?: string;
    properties?: {
      name: string;
      type: PropertyType;
      min?: number;
      max?: number;
      values?: any[];
    }[];
    marketplaces?: MarketplaceKind[];
    inAccounts?: string[];
    notInAccounts?: string[];
    ordersCreatedBy?: string[];
    ordersNotCreatedBy?: string[];
  };
  side?: OrderSide;
}

* return properties

表示 子属性

data · number

数値のレスポンスデータ。

isLoading · boolean

データが現在読み込み中かどうかを示します。