You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
3
3
# Swap SDK
4
4
5
-
The missing peer-to-peer swap library for Ethereum and EVMcompatible chains, powered by the [0x protocol](https://0x.org), written in TypeScript for web3 developers. Trade tokens (ERC20s), NFTs, and other collectibles (ERC721 and ERC1155) with just a few lines of code. Seriously, easily trade anything on Ethereum with this library.
5
+
The missing peer-to-peer swap library for Ethereum and EVM-compatible chains, powered by the [0x protocol](https://0x.org), written in TypeScript for web3 developers. Trade tokens (ERC20s), NFTs, and other collectibles (ERC721 and ERC1155) with just a few lines of code. Seriously, easily trade anything on Ethereum with this library.
6
6
7
7
**🎉 Update 1/31/22: Swap SDK now supports 0x v4, check out the [docs](https://docs.swapsdk.xyz/0x-v4). 🎉**
8
8
9
9
## Overview
10
10
11
-
tl;dr: NFT Swap SDK is the easiest, most-powerful swap library available on the EVM. Supports Ethereum and EVM-compatible chains (Polygon, Avalanche, BSC, etc..). Works in both browser and node.js. Written in TypeScript, built using the 0x protocol. With this library, you can build support for NFT marketplaces, over-the-counter (OTC) exchange, and/or peer-to-peer exchange.
11
+
tl;dr: NFT Swap SDK is the easiest, most-powerful swap library available on the EVM. Supports Ethereum and EVM-compatible chains (Polygon, Avalanche, BSC, etc.). Works in both browser and Node.js. Written in TypeScript, built using the 0x protocol. With this library, you can build support for NFT marketplaces, over-the-counter (OTC) exchanges, and/or peer-to-peer exchanges.
12
12
13
13
The NFT Swap SDK developed by [Trader.xyz](https://trader.xyz) offers swap support for ERC20s, ERC721s, and ERC1155s. Exchange NFTs for NFTs, NFTs for ERC20 tokens, or bundles of NFTs and tokens. This library provides the ultimate swap flexibility combined with a simple API surface area so you can be productive immediately and focus on building your web3 app.
14
14
@@ -41,7 +41,7 @@ import { NftSwap } from '@traderxyz/nft-swap-sdk';
Now you're setup and ready to use the SDK in your program. Check out the examples for how to swap with the library.
44
+
Now you're set up and ready to use the SDK in your program. Check out the examples below to learn how to swap with the library.
45
45
46
46
## Examples
47
47
@@ -153,7 +153,7 @@ More concrete example: We can swap `[2 CryptoPunks and 1,000 DAI] for [420 WETH
153
153
This is just one example. In reality, you can swap as many things as you'd like, any way you'd like. The underlying 0x protocol is extremely flexible, and the NFT swap library abstracts all the complexity away so you don't have to worry about protocol nuances.
154
154
155
155
```tsx
156
-
//Setup the sample data for the swap...
156
+
//Set up the sample data for the swap...
157
157
const CHAIN_ID =1; // Mainnet
158
158
159
159
const CRYPTOPUNK_420 = {
@@ -248,7 +248,7 @@ const App = () => {
248
248
249
249
## FAQ
250
250
251
-
- Which ERCs does this library support
251
+
- Which ERCs does this library support?
252
252
253
253
- ERC20, ERC721, and ERC1155
254
254
@@ -261,7 +261,7 @@ const App = () => {
261
261
- Binance Smart Chain (56)
262
262
- Avalanche (43114)
263
263
264
-
- What protocol does this library?
264
+
- What protocol does this library use?
265
265
266
266
- trader.xyz and trader.xyz libraries are powered by 0x v3 Protocol. This protocol is mature and lindy, and has been extremely well-audited.
267
267
- Check out the 0x v3 spec [here](https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md)
@@ -290,13 +290,13 @@ For general documentation, check out https://docs.swapsdk.xyz
290
290
291
291
## Roadmap
292
292
293
-
We're currently working on the following features for the next iteration of this library
293
+
We're currently working on the following features for the next iteration of this library:
294
294
295
295
- ✅ LIVE -- Persistent data store of orders (off-the-shelf storage in trader.xyz's public order storage server). Think of it as a public good
296
296
- ✅ LIVE -- Property-based orders
297
297
- ✅ LIVE -- Order validation
298
298
- ✅ LIVE -- Live order status
299
-
- Order event streaming via websockets
299
+
- Order event streaming via WebSockets
300
300
301
301
If you have feature requests, reach out in our [Discord](https://discord.gg/GCf5rSX6).
0 commit comments