useBuyNow

Hook for buying a listing on a Marketplace smart contract.

If the listing is in a currency that is not native to the chain (e.g. not Ether on Ethereum), the hook will prompt the user to approve the marketplace contract to spend the currency on their behalf before performing the buy.

Marketplace V3

Note: This hook is only for Marketplace contracts.

import { useBuyNow } from "@thirdweb-dev/react";

const { mutateAsync, isLoading, error } = useBuyNow(contract);

Usage

Provide your marketplace contract as the argument.

import { useBuyNow, useContract, Web3Button } from "@thirdweb-dev/react";
import { ListingType } from "@thirdweb-dev/sdk";

// Your smart contract address
const contractAddress = "{{contract_address}}";

function App() {
  const { contract } = useContract(contractAddress, "marketplace");
  const { mutateAsync: buyNow, isLoading, error } = useBuyNow(contract);

  return (
    <Web3Button
      contractAddress={contractAddress}
      action={() =>
        buyNow({
          id: "{{listing_id}}", // ID of the listing to buy
          type: ListingType.Direct, // Direct (0) or Auction (1)
          buyAmount: "{{buy_amount}}", // Amount to buy
          buyForWallet: "{{wallet_address}}", // Wallet to buy for, defaults to current wallet
        })
      }
    >
      Buy Now
    </Web3Button>
  );
}

Configuration

id

id (required)

The ID of the listing you want to buy.

import { useBuyNow, useContract, Web3Button } from "@thirdweb-dev/react";
import { ListingType } from "@thirdweb-dev/sdk";

// Your smart contract address
const contractAddress = "{{contract_address}}";

function App() {
  const { contract } = useContract(contractAddress, "marketplace");
  const { mutateAsync: buyNow, isLoading, error } = useBuyNow(contract);

  return (
    <Web3Button
      contractAddress={contractAddress}
      action={() =>
        buyNow({
          id: "{{listing_id}}", // ID of the listing to buy
          type: ListingType.Direct, // Direct (0) or Auction (1)
          buyAmount: "{{buy_amount}}",
        })
      }
    >
      Buy Now
    </Web3Button>
  );
}

type

type (required)

The type of listing. Either ListingType.Direct (0) or ListingType.Auction (1).

import { useBuyNow, useContract, Web3Button } from "@thirdweb-dev/react";
import { ListingType } from "@thirdweb-dev/sdk";

// Your smart contract address
const contractAddress = "{{contract_address}}";

function App() {
  const { contract } = useContract(contractAddress, "marketplace");
  const { mutateAsync: buyNow, isLoading, error } = useBuyNow(contract);

  return (
    <Web3Button
      contractAddress={contractAddress}
      action={() =>
        buyNow({
          id: "{{listing_id}}",
          type: ListingType.Direct, // Direct (0) or Auction (1)
          buyAmount: "{{buy_amount}}",
        })
      }
    >
      Buy Now
    </Web3Button>
  );
}

buyAmount

buyAmount (required)

The amount of tokens you want to buy from the listing.

Applicable for ERC1155 listings only, should always be 1 for ERC721 listings.

import { useBuyNow, useContract, Web3Button } from "@thirdweb-dev/react";
import { ListingType } from "@thirdweb-dev/sdk";

// Your smart contract address
const contractAddress = "{{contract_address}}";

function App() {
  const { contract } = useContract(contractAddress, "marketplace");
  const { mutateAsync: buyNow, isLoading, error } = useBuyNow(contract);

  return (
    <Web3Button
      contractAddress={contractAddress}
      action={() =>
        buyNow({
          id: "{{listing_id}}",
          type: ListingType.Direct, // Direct (0) or Auction (1)
          buyAmount: "{{buy_amount}}", // Amount to buy
        })
      }
    >
      Buy Now
    </Web3Button>
  );
}

buyForWallet

buyForWallet (optional)

Optionally, specify a different wallet address to buy the listing for.

import { useBuyNow, useContract, Web3Button } from "@thirdweb-dev/react";
import { ListingType } from "@thirdweb-dev/sdk";

// Your smart contract address
const contractAddress = "{{contract_address}}";

function App() {
  const { contract } = useContract(contractAddress, "marketplace");
  const { mutateAsync: buyNow, isLoading, error } = useBuyNow(contract);

  return (
    <Web3Button
      contractAddress={contractAddress}
      action={() =>
        buyNow({
          id: "{{listing_id}}",
          type: ListingType.Direct, // Direct (0) or Auction (1)
          buyAmount: "{{buy_amount}}",
          buyForWallet: "{{some_other_wallet_address}}", // Wallet to buy for, defaults to current wallet
        })
      }
    >
      Buy Now
    </Web3Button>
  );
}