StaticdefaultReturn the configuration for the orderbook module.
The configuration for the orderbook module.
Get a listing by ID
The listingId to find.
The returned listing result.
Get a collection bid by ID
The collectionBidId to find.
The returned collection bid result.
Get a trade by ID
The tradeId to find.
The returned trade result.
List listings. This method is used to get a list of listings filtered by conditions specified in the params object.
Filtering, ordering and page parameters.
The paged listings.
List bids. This method is used to get a list of bids filtered by conditions specified in the params object.
Filtering, ordering and page parameters.
The paged bids.
List collection bids. This method is used to get a list of collection bids filtered by conditions specified in the params object.
Filtering, ordering and page parameters.
The paged collection bids.
List trades. This method is used to get a list of trades filtered by conditions specified in the params object
Filtering, ordering and page parameters.
The paged trades.
Get required transactions and messages for signing to facilitate creating bulk listings.
Once the transactions are submitted and the message signed, call the
PrepareBulkListingsResponse.completeListings method provided in the return
type with the signature. This method supports up to 20 listing creations
at a time. It can also be used for individual listings to simplify integration code paths.
Bulk listings created using an EOA (Metamask) will require a single listing confirmation signature. Bulk listings creating using a smart contract wallet will require multiple listing confirmation signatures (as many as the number of orders).
Details about the listings to be created.
PrepareBulkListingsResponse includes
any unsigned approval transactions, the typed bulk order message for signing and
the PrepareBulkListingsResponse.completeListings method that can be called with
the signature(s) to create the listings.
Get required transactions and messages for signing prior to creating a listing
through the createListing method
Details about the listing to be created.
PrepareListingResponse includes
the unsigned approval transaction, the typed order message for signing and
the order components that can be submitted to createListing with a signature.
Create a listing
create a listing with the given params.
The result of the listing created in the Immutable services.
Get required transactions and messages for signing prior to creating a bid
through the createBid method
Details about the bid to be created.
PrepareBidResponse includes
the unsigned approval transaction, the typed order message for signing and
the order components that can be submitted to createBid with a signature.
Create a bid
create a bid with the given params.
The result of the bid created in the Immutable services.
Get required transactions and messages for signing prior to creating a collection bid
through the createCollectionBid method
Details about the collection bid to be created.
PrepareCollectionBidResponse includes
the unsigned approval transaction, the typed order message for signing and
the order components that can be submitted to createCollectionBid with a signature.
Create a collection bid
create a collection bid with the given params.
The result of the collection bid created in the Immutable services.
Get unsigned transactions that can be submitted to fulfil an open order. If the approval transaction exists it must be signed and submitted to the chain before the fulfilment transaction can be submitted or it will be reverted.
The orderId to fulfil.
The address of the account fulfilling the order.
Taker ecosystem fees to be paid.
OptionalamountToFill: stringAmount of the order to fill, defaults to sell item amount. Only applies to ERC1155 orders
OptionaltokenId: stringApproval and fulfilment transactions.
Get unsigned transactions that can be submitted to fulfil multiple open orders. If approval transactions exist, they must be signed and submitted to the chain before the fulfilment transaction can be submitted or it will be reverted.
The details of the orders to fulfil, amounts to fill and taker ecosystem fees to be paid.
The address of the account fulfilling the order.
Approval and fulfilment transactions.
Cancelling orders is a gasless alternative to on-chain cancellation exposed with
cancelOrdersOnChain. For the orderbook to authenticate the cancellation,
the creator of the orders must sign an EIP712 message containing the orderIds.
The orderIds to attempt to cancel.
The signable action to cancel the orders.
Cancelling orders is a gasless alternative to on-chain cancellation exposed with
cancelOrdersOnChain. Orders cancelled this way cannot be fulfilled and
will be removed from the orderbook. If there is pending fulfillment data outstanding
for the order, its cancellation will be pending until the fulfillment window has passed.
prepareOrderCancellations can be used to get the signable action that is signed
to get the signature required for this call.
The orderIds to attempt to cancel.
The address of the account cancelling the orders.
The signature obtained by signing the
message obtained from prepareOrderCancellations.
The result of the off-chain cancellation request
Get an unsigned order cancellation transaction. Orders can only be cancelled by the account that created them. All of the orders must be from the same seaport contract. If trying to cancel orders from multiple seaport contracts, group the orderIds by seaport contract and call this method for each group.
The orderIds to cancel.
The address of the account cancelling the order.
The unsigned cancel order action
zkEVM orderbook SDK
Param: config
Configuration for Immutable services.