listToken

You can supply an object of parameters listed below:

Parameter	Description	Required	Example
listings	An array of objects representing listings, mapping directly to the `params` property from the execute list api.	`true`	`[{ token: "0:0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d", weiPrice: 10000000000000000, orderbook: "reservoir", orderKind: "seaport-v1.5", expirationTime: 1667403808616, options: { "seaport-v1.5":{ useOffChainCancellation: true }} }]`
wallet	A valid WalletClient from viem or a ReservoirWallet generated from an adapter. Learn more about adapters.	`true`	Refer to viem's documentation on Wallet Clients_
onProgress	Callback to update UI state as execution progresses. Can also be used to get the transaction hash for a given step item.	`true`	`(steps) => { console.log(steps) }`
precheck	A boolean indicating whether to just get back the steps/path and not to execute them. This is useful for checking if marketplace approval is required before iterating over the steps.	`false`	`false`
chainId	Override the current active chain	`false`	1

Example

import { getClient, Execute } from "@reservoir0x/reservoir-sdk";
import { createWalletClient, http } from 'viem'

...

address = "0x8ba1f109551bD432803012645Ac136ddd6000000"
wallet = createWalletClient({
  account: address,
  transport: http()
})

getClient()?.actions.listToken({
  listings: [{  
    token: "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d:0",  
    weiPrice: 10000000000000000,  
    orderbook: "reservoir",  
    orderKind: "seaport-v1.5",  
    expirationTime: 1667403808616,
    options: { "seaport-v1.5": { useOffChainCancellation: true }}
  }],
  wallet,
  onProgress: (steps: Execute['steps']) => {
    console.log(steps)
  }
})