SweepModal offers a simple way to make bulk purchases within a collection.

Prerequisites ⚙️

Install and configure ReservoirKit.

SweepModal Setup

ReservoirKit provides a simple to configure modal for facilitating sweeping tokens in your react app. Below is an example of a simple SweepModal setup.

import { SweepModal } from '@reservoir0x/reservoir-kit-ui'

<SweepModal
	trigger={
    <button>
    	Sweep
    </button>
  }
	onConnectWallet={onConnectWallet}
  contract={contract}
  onSweepComplete={(data) => {
    console.log('Sweep Complete', data)
  }}
  onSweepError={(error, data) => {
    console.log('Sweep Error', error, data)
  }}
  onClose={() => {
    console.log('SweepModal Closed')
  }}
/>

Let's dive into the parameters:

Conditional Rendering

ReservoirKit's SweepModal doesn't take care of conditionally showing the button/modal, we leave that logic up to the developer. The user also needs to have a connected wallet. You can check this by looking for a signer from the useWalletClient wagmi hook.

Custom SweepModal

The SweepModal also comes with a custom renderer which can be used to just get the data layer that the SweepModal uses internally to handle the underlying business logic. With the renderer you can rebuild the UI completely to your liking. Below is an example of how it works in practice.

import { SweepModal, SweepStep } from '@reservoir0x/reservoir-kit-ui'

<SweepModal.Custom
  open={open}
  collectionId={collectionId}>
  {({
     collection,
     token,
     loading,
     isFetchingPath,
     address,
     selectedTokens,
     setSelectedTokens,
     itemAmount,
     setItemAmount,
     maxItemAmount,
     setMaxItemAmount,
     paymentCurrency,
     setPaymentCurrency,
     chainCurrency,
     paymentTokens,
     totalIncludingFees,
     averageUnitPrice,
     feeOnTop,
     feeUsd,
     usdPrice,
     disableJumperLink,
     usdPriceRaw,
     isConnected,
     currentChain,
     orders,
     balance,
     hasEnoughCurrency,
     addFundsLink,
     blockExplorerBaseUrl,
     transactionError,
     stepData,
     setStepData,
     sweepStep,
     setSweepStep,
     sweepTokens,
  }) => {
    { Your Custom React Elements }
  })}
</SweepModal.Custom>

The custom SweepModal takes a few parameters like before with one additional one being the open parameter. This is because there is no trigger, you have control over what sort of modal you want this to eventually live in and how to trigger that modal. You'll have the ability to add a custom button with a custom handler, etc. The custom SweepModal then passes some key data into the children which we parse above and use in our custom UI. It's also important to note the SweepStep here which is used to manage the internal state of the SweepModal's logic. You can decide to use all or some of the data passed into your custom implementation.

👍

Nice job!

Now that we've added a sweep modal to your dApp, let's customize the theme to match your brand.