add readme badges, codecov (#68)

Author: ryanio

.github/pull_request_template.md

@@ -0,0 +1,25 @@
+<!--
+Borrowed from foundry.
+
+Thank you for your Pull Request. Please provide a description above and review
+the requirements below.
+
+Bug fixes and new features should include tests.
+-->
+
+## Motivation
+
+<!--
+Explain the context and why you're making that change. What is the problem
+you're trying to solve? In some cases there is not a problem and this can be
+thought of as being the motivation for your change.
+
+If your PR solves a particular issue, tag that issue.
+-->
+
+## Solution
+
+<!--
+Summarize the solution and provide any necessary context needed to understand
+the code change.
+-->

.github/workflows/main.yaml

@@ -1,11 +1,11 @@
+name: CI
+
 on:
   push:
     branches:
       - main
   pull_request:
 
-name: main workflow
-
 env:
   GITHUB_TOKEN: ${{ secrets.GH_PAT_TOKEN }}
 
@@ -18,7 +18,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: "16.11.0"
+          node-version: 16.11.0
           cache: npm
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GH_PAT_TOKEN }}
@@ -40,7 +40,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: "16.11.0"
+          node-version: 16.11.0
           cache: npm
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GH_PAT_TOKEN }}
@@ -62,7 +62,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: "16.11.0"
+          node-version: 16.11.0
           cache: npm
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GH_PAT_TOKEN }}
@@ -73,10 +73,9 @@ jobs:
       - name: Build
         run: npm run build
 
-      - name: Run tests
+      - name: Run coverage
         run: npm run coverage
 
-      - name: Coveralls
-        uses: coverallsapp/github-action@master
+      - uses: codecov/codecov-action@v3
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          files: ./coverage/lcov.info

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Ozone Networks, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,8 +1,13 @@
-[![Coverage Status](https://coveralls.io/repos/github/ProjectOpenSea/seaport-js/badge.svg?branch=main)](https://coveralls.io/github/ProjectOpenSea/seaport-js?branch=main)
+[![Version][version-badge]][version-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](https://github.com/ProjectOpenSea/seaport) is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a JavaScript library intended to make interfacing with the contract reasonable and easy.
+[Seaport][seaport-link] is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a JavaScript library intended to make interfacing with the contract reasonable and easy.
 
 - [Synopsis](#synopsis)
 - [Installation](#installation)
@@ -12,23 +17,23 @@
 
 ## Synopsis
 
-This is a JavaScript 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](https://github.com/ProjectOpenSea/seaport) docs to get a better understanding of how the Seaport marketplace works.
+This is a JavaScript 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:
 
-```JavaScript
+```js
 import { Seaport } from "@opensea/seaport-js";
 
 const provider = ethers.getDefaultProvider();
@@ -46,7 +51,7 @@ Many of the main core flows return _use cases_. What this means is that if you w
 
 #### Listing an ERC-721 for 10 ETH and fulfilling it
 
-```
+```js
 const offerer = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266";
 const fulfiller = "0x70997970c51812dc3a010c7d01b50e0d17dc79c8";
 const { executeAllActions } = await seaport.createOrder({
@@ -55,61 +60,81 @@ const { executeAllActions } = await seaport.createOrder({
       itemType: ItemType.ERC721,
       token: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
       identifier: "1",
-    }
+    },
   ],
   consideration: [
     {
       amount: parseEther("10").toString(),
       recipient: offerer,
-    }
+    },
   ],
-  accountAddress: offerer
+  accountAddress: offerer,
 });
 
 const order = await executeAllActions();
 
-const { executeAllActions: executeAllFulfillActions } = await seaport.fulfillOrder({
-  order,
-  accountAddress: fulfiller,
-});
+const { executeAllActions: executeAllFulfillActions } =
+  await seaport.fulfillOrder({
+    order,
+    accountAddress: fulfiller,
+  });
 
-const transaction = executeAllFulfillActions()
+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"
+      token: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
     },
   ],
   consideration: [
     {
       itemType: ItemType.ERC721,
       token: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
       identifier: "1",
-      recipient: offerer
+      recipient: offerer,
     },
   ],
-  accountAddress: offerer
+  accountAddress: offerer,
 });
 
 const order = await executeAllActions();
 
-const { executeAllActions: executeAllFulfillActions } = await seaport.fulfillOrder({
-  order,
-  accountAddress: fulfiller.address,
-});
+const { executeAllActions: executeAllFulfillActions } =
+  await seaport.fulfillOrder({
+    order,
+    accountAddress: fulfiller.address,
+  });
 
-const transaction = executeAllFulfillActions()
+const transaction = executeAllFulfillActions();
 ```
 
 ## Contributing
 
 See [the contributing guide](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
+[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

codecov.yml

@@ -0,0 +1,11 @@
+coverage:
+  range: 95..100
+  round: down
+  precision: 2
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 0%
+        base: auto
+        if_ci_failed: error

package-lock.json

@@ -55,7 +55,6 @@
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "concurrently": "^7.1.0",
-    "coveralls": "^3.1.1",
     "dotenv": "^10.0.0",
     "eslint": "^8.17.0",
     "eslint-config-prettier": "^8.5.0",