Marketplace Actions

The action hooks are essential for interacting with the Marketplace in your application. Useful for making listings, making offers, and performing buy and sell actions.

useCreateListingModal

The useCreateListingModal hook is used to list an item for sale on the Marketplace. It provides the necessary functionality to create and manage a new listing.

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

## Into your React component:

const { show: showListModal } = useCreateListingModal({ onError });

const onClickList = () => {
	showListModal({
		collectionAddress,
		chainId,
		collectibleId,
		orderbookKind,
	});
};

return <button onClick={onClickList}>List</button>

useCreateListingModal

* params

Show child attributes

interface useCreateListingModal {
	onSuccess?: ({ hash, orderId }: {
	hash?: Hash; 
		orderId?: string; 
	}) => void;
	onError?: (error: Error) => void;
}

* return properties

Show child attributes

show · (args: ShowCreateListingModalArgs) => void

interface ShowCreateListingModalArgs {
	collectionAddress: Hex;
	chainId: string;
	collectibleId: string;
	orderbookKind?: OrderbookKind;
	callbacks?: ModalCallbacks;
}

close · () => void

useBuyModal

The useBuyModal hook allows users to purchase an NFT that is listed for sale on the Marketplace. It handles the buying process and transaction execution.

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

## Into your React component:

const { show: showBuyModal } = useBuyModal({
	onSuccess(hash) {
		console.log("Buy transaction sent with hash: ", hash);
	},
	onError,
});

const onClickBuy = () => {
	showBuyModal({
		chainId,
		collectionAddress,
		tokenId,
		order,
	});
};

return <button onClick={onClickBuy}>Buy</button>

useBuyModal

* params

Show child attributes

interface useBuyModal {
	onSuccess?: ({ hash, orderId }: {
			hash?: Hash;
			orderId?: string;
	}) => void;
	onError?: (error: Error) => void;
}

* return properties

Show child attributes

show · (args: ShowBuyModalArgs) => void

interface ShowBuyModalArgs {
	chainId: string;
	collectionAddress: Hex;
	tokenId: string;
	order: Order;
}

close · () => void

useMakeOfferModal

The useMakeOfferModal hook enables users to place an offer on an NFT. It facilitates creating and submitting offers within the Marketplace.

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

## Into your React component:

const { show: showOfferModal } = useMakeOfferModal({
	onError,
});

const onClickOffer = () => {
	showOfferModal({
		collectionAddress,
		chainId,
		collectibleId,
		orderbookKind,
	});
};

return <button onClick={onClickOffer}>Make Offer</button>

useMakeOfferModal

* params

Show child attributes

interface useMakeOfferModal {
	onSuccess?: ({ hash, orderId }: {
			hash?: Hash;
			orderId?: string;
	}) => void;
	onError?: (error: Error) => void;
}

* return properties

Show child attributes

show · (args: ShowMakeOfferModalArgs) => void

interface ShowMakeOfferModalArgs {
	collectionAddress: Hex;
	chainId: string;
	collectibleId: string;
	orderbookKind?: OrderbookKind;
	callbacks?: ModalCallbacks;
}

close · () => void

useSellModal

The useSellModal hook is used to sell an NFT by accepting an existing offer. It provides the necessary functionality to complete the selling process.

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

## Into your React component:

const { show: showSellModal } = useSellModal({ onError });

const onAcceptOffer = () => {
	showSellModal({
		collectionAddress,
		chainId,
		tokenId,
		order,
	});
};

return <button onClick={onAcceptOffer}>Accept Offer</button>

useSellModal

* params

Show child attributes

interface useSellModal {
	onSuccess?: ({ hash, orderId }: {
		hash?: Hash;
		orderId?: string;
	}) => void;
	onError?: (error: Error) => void;
}

* return properties

Show child attributes

show · (args: ShowSellModalArgs) => void

interface ShowSellModalArgs {
	collectionAddress: Hex;
	chainId: string;
	tokenId: string;
	order: Order;
	callbacks?: ModalCallbacks;
}

close · () => void