configuration options, including chain
Optional logger: ((arg) => void)optional function for logging debug strings. defaults to no logging
-Readonly apiAPI instance
-Readonly chainThe configured chain
-Logger function to use when debugging
-Provider to use for transactions.
-Seaport v1.5 client
+Readonly apiAPI instance
+Readonly chainThe configured chain
+Logger function to use when debugging
+Provider to use for transactions.
+Seaport v1.5 client
Instead of signing an off-chain order, this methods allows you to approve an order with on on-chain transaction.
Order to approve
Optional domain: stringAn optional domain to be hashed and included at the end of fulfillment calldata. This can be used for on-chain order attribution to assist with analytics.
Transaction hash of the approval transaction
Error if the accountAddress is not available through wallet or provider.
Error if the order's protocol address is not supported by OpenSea. See isValidProtocol.
-Cancel an order on-chain, preventing it from ever being fulfilled.
The account address that will be cancelling the order.
Optional domain?: stringAn optional domain to be hashed and included at the end of fulfillment calldata. This can be used for on-chain order attribution to assist with analytics.
The order to cancel
Error if the accountAddress is not available through wallet or provider.
Error if the order's protocol address is not supported by OpenSea. See isValidProtocol.
-Create and submit a collection offer.
+Create and submit a collection offer.
Address of the wallet making the offer.
Value of the offer in units, not base units e.g. not wei, of the payment token (or WETH if no payment token address specified).
Identifier for the collection.
@@ -58,7 +58,7 @@Error if the order's protocol address is not supported by
The number of assets to bid for (if fungible or semi-fungible).
Optional salt?: BigNumberishArbitrary salt. If not passed in, a random salt will be generated with the first four bytes being the domain hash or empty.
The CollectionOffer that was created.
-Create and submit a listing for an asset.
+Create and submit a listing for an asset.
Address of the wallet making the listing
The asset to trade. tokenAddress and tokenId must be defined.
Optional buyerOptional address that's allowed to purchase this item. If specified, no other address will be able to take the order, unless its value is the null address.
@@ -76,7 +76,7 @@Error if the order's protocol address is not supported by
Error if the accountAddress is not available through wallet or provider.
Error if the startAmount is not greater than 0.
Error if paymentTokenAddress is not WETH on anything other than Ethereum mainnet.
-Create and submit an offer on an asset.
+Create and submit an offer on an asset.
Address of the wallet making the offer.
The asset to trade. tokenAddress and tokenId must be defined.
Optional domain?: stringAn optional domain to be hashed and included in the first four bytes of the random salt.
@@ -90,7 +90,7 @@Error if paymentTokenAddress is not WETH on anything other tha
Error if the accountAddress is not available through wallet or provider.
Error if the startAmount is not greater than 0.
Error if paymentTokenAddress is not WETH on anything other than Ethereum mainnet.
-Fulfill an order for an asset. The order can be either a listing or an offer.
Address of the wallet taking the offer.
Optional domain?: stringAn optional domain to be hashed and included at the end of fulfillment calldata. This can be used for on-chain order attribution to assist with analytics.
The order to fulfill, a.k.a. "take"
@@ -100,12 +100,12 @@Error if paymentTokenAddress is not WETH on anything other tha
Error if the accountAddress is not available through wallet or provider.
Error if the order's protocol address is not supported by OpenSea. See isValidProtocol.
Error if attempting to fulfill the order with a recipient address which does not match a private listing.
-Get an account's balance of any Asset. This asset can be an ERC20, ERC1155, or ERC721.
Account address to check
The Asset to check balance for. tokenStandard must be set.
The balance of the asset for the account.
Error if the token standard does not support balanceOf.
-Returns whether an order is fulfillable. An order may not be fulfillable if a target item's transfer function is locked for some reason, e.g. an item is being rented within a game or trading has been locked for an item type.
@@ -113,24 +113,24 @@Error if attempting to fulfill the order with a recipient addr
Order to check
True if the order is fulfillable, else False.
Error if the order's protocol address is not supported by OpenSea. See isValidProtocol.
-Remove all event listeners. This should be called when you're unmounting a component that listens to events to make UI updates.
Optional event: EventTypeOptional EventType to remove listeners for
-Transfer an asset. This asset can be an ERC20, ERC1155, or ERC721.
+Transfer an asset. This asset can be an ERC20, ERC1155, or ERC721.
Optional amount?: BigNumberishAmount of asset to transfer. Not used for ERC721.
The Asset to transfer. tokenStandard must be set.
The address to transfer from
Optional overrides?: OverridesTransaction overrides, ignored if not set.
The address to transfer to
-Unwrap WETH into ETH.
Emits the UnwrapWeth event when the transaction is prompted.
Address of the user's wallet containing the WETH
How much WETH to unwrap
-Wrap ETH into WETH. W-ETH is needed for making offers.
Address of the user's wallet containing the ether
Amount of ether to wrap
-Generated using TypeDoc
Generated using TypeDoc
The OpenSea SDK main class.
-