Seaport.js

Seaport is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a TypeScript library intended to make interfacing with the contract reasonable and easy.

• Synopsis
• Installation
• Getting Started
  • Use Cases
• Contributing

Synopsis

This is a TypeScript library to help interface with Seaport. It includes various helper methods and constants that makes interfacing with Seaport easier. These include creating orders, fulfilling orders, doing the necessary balance and approval checks, and more. We recommend taking a look at the Seaport docs to get a better understanding of how the Seaport marketplace works.

Installation

We recommend using nvm to manage Node.js versions. Execute nvm use, if you have nvm installed.

Then, in your project, run:

1npm install --save @opensea/seaport-js

Getting Started

Instantiate your instance of seaport using your ethers provider:

Examples

Through a browser provider (i.e. Metamask)

1import { Seaport } from "@opensea/seaport-js";
2import { ethers } from "ethers";
3
4const provider = new ethers.BrowserProvider(window.ethereum);
5
6const seaport = new Seaport(provider);

Through a RPC Provider (i.e. Alchemy)

1import { Seaport } from "@opensea/seaport-js";
2import { ethers } from "ethers";
3
4const provider = new ethers.JsonRpcProvider(
5  "https://<network>.alchemyapi.io/v2/YOUR-API-KEY",
6);
7
8const seaport = new Seaport(provider);

With custom signer

1import { Seaport } from "@opensea/seaport-js";
2import { ethers } from "ethers";
3
4// Provider must be provided to the signer when supplying a custom signer
5const provider = new ethers.JsonRpcProvider(
6  "https://<network>.alchemyapi.io/v2/YOUR-API-KEY",
7);
8
9const signer = new ethers.Wallet("YOUR_PK", provider);
10
11const seaport = new Seaport(signer);

Look at the relevant definitions in seaport.ts in order to see the different functionality this library offers.

Use Cases

Many of the main core flows return use cases. What this means is that if you were to create an order (a la createOrder), the library helps perform the necessary balance and approval checks based on the offer of the order being created. If the offerer requires approvals on one asset contract, the actions field of the use case would contain an approval action that the user should execute first in order for the trade to succeed in the future.

Examples

Listing an ERC-721 for 10 ETH and fulfilling it

1const offerer = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266";
2const fulfiller = "0x70997970c51812dc3a010c7d01b50e0d17dc79c8";
3const { executeAllActions } = await seaport.createOrder(
4  {
5    offer: [
6      {
7        itemType: ItemType.ERC721,
8        token: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
9        identifier: "1",
10      },
11    ],
12    consideration: [
13      {
14        amount: ethers.parseEther("10").toString(),
15        recipient: offerer,
16      },
17    ],
18  },
19  offerer,
20);
21
22const order = await executeAllActions();
23
24const { executeAllActions: executeAllFulfillActions } =
25  await seaport.fulfillOrder({
26    order,
27    accountAddress: fulfiller,
28  });
29
30const transaction = executeAllFulfillActions();

Making an offer for an ERC-721 for 10 WETH and fulfilling it

1const offerer = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266";
2const fulfiller = "0x70997970c51812dc3a010c7d01b50e0d17dc79c8";
3const { executeAllActions } = await seaport.createOrder(
4  {
5    offer: [
6      {
7        amount: parseEther("10").toString(),
8        // WETH
9        token: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
10      },
11    ],
12    consideration: [
13      {
14        itemType: ItemType.ERC721,
15        token: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
16        identifier: "1",
17        recipient: offerer,
18      },
19    ],
20  },
21  offerer,
22);
23
24const order = await executeAllActions();
25
26const { executeAllActions: executeAllFulfillActions } =
27  await seaport.fulfillOrder({
28    order,
29    accountAddress: fulfiller,
30  });
31
32const transaction = executeAllFulfillActions();

Contributing

See the contributing guide for detailed instructions on how to get started with this project.

License

MIT Copyright 2022 Ozone Networks, Inc.