feat: add coverate to readme, force rerun

thesandboxgame · Aug 25, 2023 · 345cd16 · 345cd16
1 parent d8a41ac
commit 345cd16
Show file tree

Hide file tree

Showing 4 changed files with 240 additions and 104 deletions.
diff --git a/README.md b/README.md
@@ -6,9 +6,14 @@
 ![Node Version](https://img.shields.io/badge/node-18.x-green)
 [![Discord](https://img.shields.io/discord/497312527093334036.svg?label=Discord&logo=discord)](<https://discord.gg/vAe4zvY>)
 
-[The Sandbox](https://sandbox.game) is a user-generated content (UGC) gaming platform, that will empower creators through digital ownership and monetization of 3D voxel creations made and shared by users around the world.
+[The Sandbox](https://sandbox.game) is a user-generated content (UGC) gaming platform, that will empower creators
+through digital ownership and monetization of 3D voxel creations made and shared by users around the world.
 
-This mono-repo contains The Sandbox smart contracts, underpinning The Sandbox metaverse. Our key token contracts were conceived inside the core package. You can find out more about some of our early blockchain features in [this article](https://medium.com/sandbox-game/blockchain-features-in-the-sandbox-7db91fcc615c). Since core was created, we have added new contracts and updates via new packages - see the below Architecture Overview for more information.
+This mono-repo contains The Sandbox smart contracts, underpinning The Sandbox metaverse. Our key token contracts were
+conceived inside the core package. You can find out more about some of our early blockchain features
+in [this article](https://medium.com/sandbox-game/blockchain-features-in-the-sandbox-7db91fcc615c). Since core was
+created, we have added new contracts and updates via new packages - see the below Architecture Overview for more
+information.
 
 ## Learn more
 
@@ -27,17 +32,20 @@ This mono-repo contains The Sandbox smart contracts, underpinning The Sandbox me
 This workspace uses [Nx: a smart, fast and extensible build system.](https://nx.dev)
 Run `nx graph` to see a diagram of the dependencies of the projects.
 
-To add a package simply add it inside the packages directory. Every package can implement the following targets that will be run by the root `package.json` scripts and on the CI:
+To add a package simply add it inside the packages directory. Every package can implement the following targets that
+will be run by the root `package.json` scripts and on the CI:
 
 - `test`: run unit tests inside your new package.
 - `coverage`: run coverage. Note: CI expects to have at least 80% coverage.
 - `lint`: lint your code.
 - `format`: format the code with prettier.
 
-See [`packages/example-hardhat`](./packages/example-hardhat) for an example template package for smart contract development with Hardhat.
+See [`packages/example-hardhat`](./packages/example-hardhat) for an example template package for smart contract
+development with Hardhat.
 
-Refer to each package's readme for more information about that package. Note that deployment for all new packages is carried out via `packages/deploy`.
-Each package should follow the [audit best practices](./audit-best-practices.md) where applicable.
+Refer to each package's readme for more information about that package. Note that deployment for all new packages is
+carried out via `packages/deploy`. Each package should follow the [audit best practices](./audit-best-practices.md)
+where applicable.
 
 ### Developer quickstart
 
@@ -48,15 +56,16 @@ yarn install
 ## Architecture Overview
 
 - 📦 This mono-repository contains a suite of smart contract packages.
-- ⚖️ The mono-repository is released under [MIT license](./LICENSE). Note, that the packages may contain their own licenses.
-
-| Package                                                                               | Version                                                                                                                                            | License                                                                                                  | Description                              |
-|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------------------|
-| [`@sandbox-smart-contracts/packages/core`](./packages/core)                           | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/core)](https://www.npmjs.com/package/@sandbox-smart-contracts/core)                  | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🗝️ Core smart contracts (pre 2023)        |
-| [`@sandbox-smart-contracts/packages/deploy`](./packages/deploy)                       | N/A                                                                                                                                                | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🚀 Deploy all packages (except core)      |
-| [`@sandbox-smart-contracts/packages/example-hardhat`](./packages/example-hardhat)     | N/A                                                                                                                                                | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 👷 Development template using Hardhat     |
-| [`@sandbox-smart-contracts/packages/giveaway`](./packages/giveaway)                   | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/giveaway)](https://www.npmjs.com/package/@sandbox-smart-contracts/giveaway)          | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🎁 Instant Giveaway smart contract claims |
-| [`@sandbox-smart-contracts/packages/dependency-metatx`](./packages/dependency-metatx) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/dependency-metatx)](https://www.npmjs.com/package/@sandbox-smart-contracts/giveaway) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🌐 Dependency: ERC2771 handler            |
+- ⚖️ The mono-repository is released under [MIT license](./LICENSE). Note, that the packages may contain their own
+  licenses.
+
+| Package                                                                               | Version                                                                                                                                            | License                                                                                                  | Coverage | Description                              |
+|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|----------|------------------------------------------|
+| [`@sandbox-smart-contracts/packages/core`](./packages/core)                           | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/core)](https://www.npmjs.com/package/@sandbox-smart-contracts/core)                  | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | ![N/A](https://raw.githubusercontent.com/thesandboxgame/sandbox-smart-contracts/gh-pages/core.svg) | 🗝️ Core smart contracts (pre 2023)        |
+| [`@sandbox-smart-contracts/packages/deploy`](./packages/deploy)                       | N/A                                                                                                                                                | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | N/A | 🚀 Deploy all packages (except core)      |
+| [`@sandbox-smart-contracts/packages/example-hardhat`](./packages/example-hardhat)     | N/A                                                                                                                                                | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | ![N/A](https://raw.githubusercontent.com/thesandboxgame/sandbox-smart-contracts/gh-pages/example-hardhat.svg) | 👷 Development template using Hardhat     |
+| [`@sandbox-smart-contracts/packages/giveaway`](./packages/giveaway)                   | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/giveaway)](https://www.npmjs.com/package/@sandbox-smart-contracts/giveaway)          | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | ![N/A](https://raw.githubusercontent.com/thesandboxgame/sandbox-smart-contracts/gh-pages/giveaway.svg) | 🎁 Instant Giveaway smart contract claims |
+| [`@sandbox-smart-contracts/packages/dependency-metatx`](./packages/dependency-metatx) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/dependency-metatx)](https://www.npmjs.com/package/@sandbox-smart-contracts/giveaway) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | ![N/A](https://raw.githubusercontent.com/thesandboxgame/sandbox-smart-contracts/gh-pages/dependency-metatx.svg) | 🌐 Dependency: ERC2771 handler            |
 
 ## Contributing
 

diff --git a/packages/dependency-metatx/package.json b/packages/dependency-metatx/package.json
@@ -7,6 +7,12 @@
   "files": [
     "contracts"
   ],
+  "keywords": [
+    "ethereum",
+    "polygon",
+    "smart-contracts",
+    "The Sandbox"
+  ],
   "scripts": {
     "lint": "eslint --max-warnings 0 \"**/*.{js,ts}\" && solhint --max-warnings 0 \"contracts/**/*.sol\"",
     "lint:fix": "eslint --fix \"**/*.{js,ts}\" && solhint --fix \"contracts/**/*.sol\"",

diff --git a/packages/giveaway/package.json b/packages/giveaway/package.json
@@ -7,6 +7,12 @@
     "files": [
         "contracts"
     ],
+    "keywords": [
+        "ethereum",
+        "polygon",
+        "smart-contracts",
+        "The Sandbox"
+    ],
     "scripts": {
         "lint": "eslint --max-warnings 0 \"**/*.{js,ts}\" && solhint --max-warnings 0 \"contracts/**/*.sol\"",
         "lint:fix": "eslint --fix \"**/*.{js,ts}\" && solhint --fix \"contracts/**/*.sol\"",