-
Notifications
You must be signed in to change notification settings - Fork 181
/
README.md
185 lines (140 loc) · 5.86 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<p align="center">
<img src="./img/banner.png" />
</p>
[![Version][version-badge]][version-link]
[![npm][npm-badge]][npm-link]
[![Test CI][ci-badge]][ci-link]
[![Code Coverage][coverage-badge]][coverage-link]
[![License][license-badge]][license-link]
[![Docs][docs-badge]][docs-link]
[![Discussions][discussions-badge]][discussions-link]
# Seaport.js
[Seaport][seaport-link] 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](#synopsis)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Use Cases](#use-cases)
- [Contributing](#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][seaport-link] docs to get a better understanding of how the Seaport marketplace works.
## Installation
We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versions. Execute `nvm use`, if you have `nvm` installed.
Then, in your project, run:
```console
npm install --save @opensea/seaport-js
```
## Getting Started
Instantiate your instance of seaport using your ethers provider:
### Examples
#### Through a browser provider (i.e. Metamask)
```js
import { Seaport } from "@opensea/seaport-js";
import { ethers } from "ethers";
const provider = new ethers.BrowserProvider(window.ethereum);
const seaport = new Seaport(provider);
```
#### Through a RPC Provider (i.e. Alchemy)
```js
import { Seaport } from "@opensea/seaport-js";
import { ethers } from "ethers";
const provider = new ethers.JsonRpcProvider(
"https://<network>.alchemyapi.io/v2/YOUR-API-KEY",
);
const seaport = new Seaport(provider);
```
#### With custom signer
```js
import { Seaport } from "@opensea/seaport-js";
import { ethers } from "ethers";
// Provider must be provided to the signer when supplying a custom signer
const provider = new ethers.JsonRpcProvider(
"https://<network>.alchemyapi.io/v2/YOUR-API-KEY",
);
const signer = new ethers.Wallet("YOUR_PK", provider);
const 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
```js
const offerer = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266";
const fulfiller = "0x70997970c51812dc3a010c7d01b50e0d17dc79c8";
const { executeAllActions } = await seaport.createOrder(
{
offer: [
{
itemType: ItemType.ERC721,
token: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
identifier: "1",
},
],
consideration: [
{
amount: ethers.parseEther("10").toString(),
recipient: offerer,
},
],
},
offerer,
);
const order = await executeAllActions();
const { executeAllActions: executeAllFulfillActions } =
await seaport.fulfillOrder({
order,
accountAddress: fulfiller,
});
const transaction = executeAllFulfillActions();
```
#### Making an offer for an ERC-721 for 10 WETH and fulfilling it
```js
const offerer = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266";
const fulfiller = "0x70997970c51812dc3a010c7d01b50e0d17dc79c8";
const { executeAllActions } = await seaport.createOrder(
{
offer: [
{
amount: parseEther("10").toString(),
// WETH
token: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
},
],
consideration: [
{
itemType: ItemType.ERC721,
token: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
identifier: "1",
recipient: offerer,
},
],
},
offerer,
);
const order = await executeAllActions();
const { executeAllActions: executeAllFulfillActions } =
await seaport.fulfillOrder({
order,
accountAddress: fulfiller,
});
const transaction = executeAllFulfillActions();
```
## Contributing
See [the contributing guide](./.github/CONTRIBUTING.md) for detailed instructions on how to get started with this project.
## License
[MIT](LICENSE) Copyright 2022 Ozone Networks, Inc.
[seaport-link]: https://github.com/ProjectOpenSea/seaport
[version-badge]: https://img.shields.io/github/package-json/v/ProjectOpenSea/seaport-js
[version-link]: https://github.com/ProjectOpenSea/seaport-js/releases
[npm-badge]: https://img.shields.io/npm/v/@opensea/seaport-js?color=red
[npm-link]: https://www.npmjs.com/package/@opensea/seaport-js
[ci-badge]: https://github.com/ProjectOpenSea/seaport-js/actions/workflows/main.yaml/badge.svg
[ci-link]: https://github.com/ProjectOpenSea/seaport-js/actions/workflows/main.yaml
[coverage-badge]: https://codecov.io/gh/ProjectOpenSea/seaport-js/branch/main/graph/badge.svg
[coverage-link]: https://codecov.io/gh/ProjectOpenSea/seaport-js
[license-badge]: https://img.shields.io/github/license/ProjectOpenSea/seaport-js
[license-link]: https://github.com/ProjectOpenSea/seaport-js/blob/main/LICENSE
[docs-badge]: https://img.shields.io/badge/Seaport.js-documentation-informational
[docs-link]: https://github.com/ProjectOpenSea/seaport-js/blob/main/README.md#getting-started
[discussions-badge]: https://img.shields.io/badge/Seaport.js-discussions-blueviolet
[discussions-link]: https://github.com/ProjectOpenSea/seaport-js/discussions