Skip to content

Commit

Permalink
Remove outdated examples, fix some typos (ProjectOpenSea#848)
Browse files Browse the repository at this point in the history
* remove outdated examples, fix some typos

* remove examples toc link
  • Loading branch information
ryanio authored Mar 1, 2023
1 parent 88b0115 commit ac311ed
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module.exports = {
node: true,
},
root: true,
ignorePatterns: ["docs", "lib", "examples"],
ignorePatterns: ["docs", "lib"],
reportUnusedDisableDirectives: true,
parser: "@typescript-eslint/parser",
plugins: ["@typescript-eslint", "import", "jest", "prettier"],
Expand Down
6 changes: 0 additions & 6 deletions .gitmodules

This file was deleted.

1 change: 0 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
lib
docs
examples
.nyc_output
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
[![Coverage Status][coverage-badge]][coverage-link]
[![styled with prettier][prettier-badge]][prettier-link]

<!-- [![npm](https://img.shields.io/npm/v/wyvern-js.svg)](https://www.npmjs.com/package/wyvern-js) [![npm](https://img.shields.io/npm/dt/wyvern-js.svg)](https://www.npmjs.com/package/wyvern-js) -->

A JavaScript library for crypto-native ecommerce: buying, selling, and bidding on any cryptogood. With OpenSea.js, you can easily build your own native marketplace for your non-fungible tokens, or NFTs. These can be ERC-721 or ERC-1155 (semi-fungible) items. You don't have to deploy your own smart contracts or backend orderbooks.

Published on [GitHub](https://github.com/ProjectOpenSea/opensea-js) and [npm](https://www.npmjs.com/package/opensea-js)
Expand All @@ -37,7 +35,6 @@ Published on [GitHub](https://github.com/ProjectOpenSea/opensea-js) and [npm](ht
- [Private Auctions](#private-auctions)
- [Listening to Events](#listening-to-events)
- [Learning More](#learning-more)
- [Example Code](#example-code)
- [Migrating to version 1.0](#migrating-to-version-10)
- [Development Information](#development-information)
- [Diagnosing Common Issues](#diagnosing-common-issues)
Expand Down Expand Up @@ -67,15 +64,6 @@ npm install --save opensea-js
> Due to the use of git-url dependencies, versions of `npm` below 8.5.2 are incompatible with this package due to broken integrity checksum validation.
> Above version 8.5.2, `npm` will no longer validate integrity checksums for git-url dependencies.
> **Warning**
> To use `yarn` the following resolution is required to be added to your package.json:
>
> ```
> "resolutions": {
> "@0x/utils": "https://github.com/ProjectOpensea/0x-tools/raw/provider-patch/utils/0x-utils-6.5.0.tgz",
> }
> ```
Install [web3](https://github.com/ethereum/web3.js) too if you haven't already.

If you run into an error while building the dependencies and you're on a Mac, run this:
Expand Down Expand Up @@ -315,7 +303,7 @@ Note that the listing price of an asset is equal to the `currentPrice` of the **

To learn more about signatures, makers, takers, listingTime vs createdTime and other kinds of order terminology, please read the [**Terminology Section**](https://docs.opensea.io/reference#terminology) of the API Docs.

The available API filters for the orders endpoint is documented in the `OrdersQueryOptions` interface below, but see the main [API Docs](https://docs.opensea.io/reference#reference-getting-started) for a playground, along with more up-to-date and detailed explanantions.
The available API filters for the orders endpoint is documented in the `OrdersQueryOptions` interface below, but see the main [API Docs](https://docs.opensea.io/reference#reference-getting-started) for a playground, along with more up-to-date and detailed explanations.

```TypeScript
/**
Expand Down Expand Up @@ -402,7 +390,7 @@ const transactionHash = await openseaSDK.transfer({

To transfer fungible assets without token IDs, like ERC20 tokens, you can pass in an `OpenSeaFungibleToken` as the `asset`, set `schemaName` to "ERC20", and include `quantity` in base units (e.g. wei) to indicate how many.

Example for transfering 2 DAI ($2) to another address:
Example for transferring 2 DAI ($2) to another address:

```JavaScript
const paymentToken = (await openseaSDK.api.getPaymentTokens({ symbol: 'DAI'})).tokens[0]
Expand Down Expand Up @@ -609,12 +597,6 @@ To remove all listeners and start over, just call `openseaSDK.removeAllListeners

Auto-generated documentation for each export is available [here](https://projectopensea.github.io/opensea-js/).

### Example Code

Check out the [Ship's Log](https://github.com/ProjectOpenSea/ships-log), built with the SDK, which shows the recent orders in the OpenSea orderbook.

Also check out the [Mythereum marketplace](https://mythereum.io/marketplace), which is entirely powered by OpenSea.js.

## Migrating to version 1.0

See the [Changelog](CHANGELOG.md).
Expand Down
1 change: 0 additions & 1 deletion examples/opensea-creatures
Submodule opensea-creatures deleted from 3acbd7
1 change: 0 additions & 1 deletion examples/ships-log
Submodule ships-log deleted from 832fca

0 comments on commit ac311ed

Please sign in to comment.