Merge pull request #837 from airswap/develop

Publish README updates to NPM
airswap · Mar 30, 2022 · 7257559 · 7257559
2 parents 6f0c027 + d868e5f
commit 7257559
Show file tree

Hide file tree

Showing 12 changed files with 86 additions and 135 deletions.
diff --git a/source/converter/README.md b/source/converter/README.md
@@ -15,31 +15,22 @@
 
 ## Usage
 
-:warning: This package is under active development and contains unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
-
-## Env Vars
-
-Hardhat expects the following environment variables to be set. They may be set in a `.env` file.
-
-| Variable            | Description                                    |
-| :------------------ | :--------------------------------------------- |
-| `MNEMONIC`          | 12-world account mnemonic used for testing     |
-| `INFURA_API_KEY`    | Infura API key to use for deployments          |
-| `ETHERSCAN_API_KEY` | Etherscan API key to use for verification      |
-| `ALCHEMY_API_KEY`   | Alchemy API key for testing with mainnet forks |
+:warning: This package may contain unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
 
 ## Commands
 
-| Command               | Description                             |
-| :-------------------- | :-------------------------------------- |
-| `yarn`                | Install dependencies                    |
-| `yarn clean`          | Delete the contract `build` folder      |
-| `yarn compile`        | Compile all contracts to `build` folder |
-| `yarn test`           | Run all tests in `test` folder          |
-| `yarn test:unit`      | Run unit tests in `test` folder         |
-| `yarn coverage`       | Report test coverage                    |
-| `yarn deploy:rinkeby` | Deploy contracts to Rinkeby             |
-| `yarn deploy:mainnet` | Deploy contracts to Mainnet             |
+Environment variables are set in an `.env` file in the repository root.
+
+| Command          | Description                              |
+| :--------------- | :--------------------------------------- |
+| `yarn`           | Install dependencies                     |
+| `yarn clean`     | Delete the contract `build` folder       |
+| `yarn compile`   | Compile all contracts to `build` folder  |
+| `yarn coverage`  | Report test coverage                     |
+| `yarn test`      | Run all tests in `test` folder           |
+| `yarn test:unit` | Run unit tests in `test` folder          |
+| `yarn deploy`    | Deploy on a network using --network flag |
+| `yarn verify`    | Verify on a network using --network flag |
 
 ## Running Tests
 

diff --git a/source/converter/package.json b/source/converter/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@airswap/converter",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "AirSwap: Protocol Fee Converter",
   "contributors": [
     "Martin Sterlicchi",

diff --git a/source/pool/README.md b/source/pool/README.md
@@ -15,30 +15,22 @@
 
 ## Usage
 
-:warning: This package is under active development and contains unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
-
-## Env Vars
-
-Hardhat expects the following environment variables to be set. They may be set in a `.env` file.
-
-| Variable            | Description                                |
-| :------------------ | :----------------------------------------- |
-| `MNEMONIC`          | 12-world account mnemonic used for testing |
-| `INFURA_API_KEY`    | Infura API key to use for deployments      |
-| `ETHERSCAN_API_KEY` | Etherscan API key to use for verification  |
+:warning: This package may contain unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
 
 ## Commands
 
-| Command               | Description                             |
-| :-------------------- | :-------------------------------------- |
-| `yarn`                | Install dependencies                    |
-| `yarn clean`          | Delete the contract `build` folder      |
-| `yarn compile`        | Compile all contracts to `build` folder |
-| `yarn test`           | Run all tests in `test` folder          |
-| `yarn test:unit`      | Run unit tests in `test` folder         |
-| `yarn coverage`       | Report test coverage                    |
-| `yarn deploy:rinkeby` | Deploy contracts to Rinkeby             |
-| `yarn deploy:mainnet` | Deploy contracts to Mainnet             |
+Environment variables are set in an `.env` file in the repository root.
+
+| Command          | Description                              |
+| :--------------- | :--------------------------------------- |
+| `yarn`           | Install dependencies                     |
+| `yarn clean`     | Delete the contract `build` folder       |
+| `yarn compile`   | Compile all contracts to `build` folder  |
+| `yarn coverage`  | Report test coverage                     |
+| `yarn test`      | Run all tests in `test` folder           |
+| `yarn test:unit` | Run unit tests in `test` folder          |
+| `yarn deploy`    | Deploy on a network using --network flag |
+| `yarn verify`    | Verify on a network using --network flag |
 
 ## Running Tests
 

diff --git a/source/pool/package.json b/source/pool/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@airswap/pool",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "AirSwap: Rewards Pool",
   "contributors": [
     "Don Mosites",
@@ -26,7 +26,7 @@
   },
   "devDependencies": {
     "@airswap/constants": "3.0.0",
-    "@airswap/staking": "3.0.0",
+    "@airswap/staking": "3.0.1",
     "@airswap/utils": "3.0.0",
     "@nomiclabs/hardhat-ethers": "^2.0.5",
     "@nomiclabs/hardhat-etherscan": "^3.0.3",

diff --git a/source/registry/README.md b/source/registry/README.md
@@ -15,30 +15,22 @@
 
 ## Usage
 
-:warning: This package is under active development and contains unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
-
-## Env Vars
-
-Hardhat expects the following environment variables to be set. They may be set in a `.env` file.
-
-| Variable            | Description                                |
-| :------------------ | :----------------------------------------- |
-| `MNEMONIC`          | 12-world account mnemonic used for testing |
-| `INFURA_API_KEY`    | Infura API key to use for deployments      |
-| `ETHERSCAN_API_KEY` | Etherscan API key to use for verification  |
+:warning: This package may contain unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
 
 ## Commands
 
-| Command               | Description                             |
-| :-------------------- | :-------------------------------------- |
-| `yarn`                | Install dependencies                    |
-| `yarn clean`          | Delete the contract `build` folder      |
-| `yarn compile`        | Compile all contracts to `build` folder |
-| `yarn test`           | Run all tests in `test` folder          |
-| `yarn test:unit`      | Run unit tests in `test` folder         |
-| `yarn coverage`       | Report test coverage                    |
-| `yarn deploy:rinkeby` | Deploy contracts to Rinkeby             |
-| `yarn deploy:mainnet` | Deploy contracts to Mainnet             |
+Environment variables are set in an `.env` file in the repository root.
+
+| Command          | Description                              |
+| :--------------- | :--------------------------------------- |
+| `yarn`           | Install dependencies                     |
+| `yarn clean`     | Delete the contract `build` folder       |
+| `yarn compile`   | Compile all contracts to `build` folder  |
+| `yarn coverage`  | Report test coverage                     |
+| `yarn test`      | Run all tests in `test` folder           |
+| `yarn test:unit` | Run unit tests in `test` folder          |
+| `yarn deploy`    | Deploy on a network using --network flag |
+| `yarn verify`    | Verify on a network using --network flag |
 
 ## Running Tests
 

diff --git a/source/registry/package.json b/source/registry/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@airswap/registry",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "AirSwap: Server URL Registry",
   "contributors": [
     "Ethan Wessel",

diff --git a/source/staking/README.md b/source/staking/README.md
@@ -15,30 +15,22 @@
 
 ## Usage
 
-:warning: This package is under active development and contains unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
-
-## Env Vars
-
-Hardhat expects the following environment variables to be set. They may be set in a `.env` file.
-
-| Variable            | Description                                |
-| :------------------ | :----------------------------------------- |
-| `MNEMONIC`          | 12-world account mnemonic used for testing |
-| `INFURA_API_KEY`    | Infura API key to use for deployments      |
-| `ETHERSCAN_API_KEY` | Etherscan API key to use for verification  |
+:warning: This package may contain unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
 
 ## Commands
 
-| Command               | Description                             |
-| :-------------------- | :-------------------------------------- |
-| `yarn`                | Install dependencies                    |
-| `yarn clean`          | Delete the contract `build` folder      |
-| `yarn compile`        | Compile all contracts to `build` folder |
-| `yarn test`           | Run all tests in `test` folder          |
-| `yarn test:unit`      | Run unit tests in `test` folder         |
-| `yarn coverage`       | Report test coverage                    |
-| `yarn deploy:rinkeby` | Deploy contracts to Rinkeby             |
-| `yarn deploy:mainnet` | Deploy contracts to Mainnet             |
+Environment variables are set in an `.env` file in the repository root.
+
+| Command          | Description                              |
+| :--------------- | :--------------------------------------- |
+| `yarn`           | Install dependencies                     |
+| `yarn clean`     | Delete the contract `build` folder       |
+| `yarn compile`   | Compile all contracts to `build` folder  |
+| `yarn coverage`  | Report test coverage                     |
+| `yarn test`      | Run all tests in `test` folder           |
+| `yarn test:unit` | Run unit tests in `test` folder          |
+| `yarn deploy`    | Deploy on a network using --network flag |
+| `yarn verify`    | Verify on a network using --network flag |
 
 ## Running Tests
 

diff --git a/source/staking/package.json b/source/staking/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@airswap/staking",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "AirSwap: Stake Tokens",
   "contributors": [
     "Ethan Wessel",

diff --git a/source/swap/README.md b/source/swap/README.md
@@ -15,30 +15,22 @@
 
 ## Usage
 
-:warning: This package is under active development and contains unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
-
-## Env Vars
-
-Hardhat expects the following environment variables to be set. They may be set in a `.env` file.
-
-| Variable            | Description                                |
-| :------------------ | :----------------------------------------- |
-| `MNEMONIC`          | 12-world account mnemonic used for testing |
-| `INFURA_API_KEY`    | Infura API key to use for deployments      |
-| `ETHERSCAN_API_KEY` | Etherscan API key to use for verification  |
+:warning: This package may contain unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
 
 ## Commands
 
-| Command               | Description                             |
-| :-------------------- | :-------------------------------------- |
-| `yarn`                | Install dependencies                    |
-| `yarn clean`          | Delete the contract `build` folder      |
-| `yarn compile`        | Compile all contracts to `build` folder |
-| `yarn test`           | Run all tests in `test` folder          |
-| `yarn test:unit`      | Run unit tests in `test` folder         |
-| `yarn coverage`       | Report test coverage                    |
-| `yarn deploy:rinkeby` | Deploy contracts to Rinkeby             |
-| `yarn deploy:mainnet` | Deploy contracts to Mainnet             |
+Environment variables are set in an `.env` file in the repository root.
+
+| Command          | Description                              |
+| :--------------- | :--------------------------------------- |
+| `yarn`           | Install dependencies                     |
+| `yarn clean`     | Delete the contract `build` folder       |
+| `yarn compile`   | Compile all contracts to `build` folder  |
+| `yarn coverage`  | Report test coverage                     |
+| `yarn test`      | Run all tests in `test` folder           |
+| `yarn test:unit` | Run unit tests in `test` folder          |
+| `yarn deploy`    | Deploy on a network using --network flag |
+| `yarn verify`    | Verify on a network using --network flag |
 
 ## Running Tests
 

diff --git a/source/swap/package.json b/source/swap/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@airswap/swap",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "AirSwap: Atomic Token Swap",
   "contributors": [
     "Vicente Dragicevic",

diff --git a/source/wrapper/README.md b/source/wrapper/README.md
@@ -15,30 +15,22 @@
 
 ## Usage
 
-:warning: This package is under active development and contains unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
-
-## Env Vars
-
-Hardhat expects the following environment variables to be set. They may be set in a `.env` file.
-
-| Variable            | Description                                |
-| :------------------ | :----------------------------------------- |
-| `MNEMONIC`          | 12-world account mnemonic used for testing |
-| `INFURA_API_KEY`    | Infura API key to use for deployments      |
-| `ETHERSCAN_API_KEY` | Etherscan API key to use for verification  |
+:warning: This package may contain unaudited code. For all AirSwap contract deployments see [Deployed Contracts](https://about.airswap.io/technology/deployments).
 
 ## Commands
 
-| Command               | Description                             |
-| :-------------------- | :-------------------------------------- |
-| `yarn`                | Install dependencies                    |
-| `yarn clean`          | Delete the contract `build` folder      |
-| `yarn compile`        | Compile all contracts to `build` folder |
-| `yarn test`           | Run all tests in `test` folder          |
-| `yarn test:unit`      | Run unit tests in `test` folder         |
-| `yarn coverage`       | Report test coverage                    |
-| `yarn deploy:rinkeby` | Deploy contracts to Rinkeby             |
-| `yarn deploy:mainnet` | Deploy contracts to Mainnet             |
+Environment variables are set in an `.env` file in the repository root.
+
+| Command          | Description                              |
+| :--------------- | :--------------------------------------- |
+| `yarn`           | Install dependencies                     |
+| `yarn clean`     | Delete the contract `build` folder       |
+| `yarn compile`   | Compile all contracts to `build` folder  |
+| `yarn coverage`  | Report test coverage                     |
+| `yarn test`      | Run all tests in `test` folder           |
+| `yarn test:unit` | Run unit tests in `test` folder          |
+| `yarn deploy`    | Deploy on a network using --network flag |
+| `yarn verify`    | Verify on a network using --network flag |
 
 ## Running Tests
 

diff --git a/source/wrapper/package.json b/source/wrapper/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@airswap/wrapper",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "AirSwap: Automatic Wrap and Unwrap",
   "contributors": [
     "Don Mosites",
@@ -26,7 +26,7 @@
   },
   "devDependencies": {
     "@airswap/constants": "3.0.0",
-    "@airswap/swap": "3.0.0",
+    "@airswap/swap": "3.0.1",
     "@airswap/utils": "3.0.0",
     "@nomiclabs/hardhat-ethers": "^2.0.5",
     "@nomiclabs/hardhat-etherscan": "^3.0.3",