Update README (#175)

* Update README * Remove unused pnpm lock * Update hardhat to remove github action compile error * Fix node version to prevent hardhat error during github actions * Fix coverage tests
0xsequence · Jul 3, 2023 · 3b0ea33 · 3b0ea33
1 parent 4683828
commit 3b0ea33
Show file tree

Hide file tree

Showing 6 changed files with 222 additions and 12,053 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 18
+          node-version: 18.15
       - uses: actions/cache@master
         id: yarn-cache
         with:
@@ -30,7 +30,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 18
+          node-version: 18.15
       - uses: actions/cache@master
         id: yarn-cache
         with:
@@ -49,7 +49,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 18
+          node-version: 18.15
       - uses: actions/cache@master
         id: yarn-cache
         with:
@@ -67,7 +67,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 18
+          node-version: 18.15
       - uses: actions/cache@master
         id: yarn-cache
         with:
@@ -85,7 +85,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 18
+          node-version: 18.15
       - uses: actions/cache@master
         id: yarn-cache
         with:
@@ -104,7 +104,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 18
+          node-version: 18.15
       - uses: actions/cache@master
         id: yarn-cache
         with:

diff --git a/README.md b/README.md
@@ -1,77 +1,55 @@
-Sequence Smart Wallet Contracts
-===============================
+# Sequence Smart Wallet Contracts
 
 Ethereum contracts for the Sequence Smart Wallet at [https://sequence.app](https://sequence.app).
 
-For more information see, [https://sequence.build](https://sequence.build)
-
+For more information, visit [https://sequence.build](https://sequence.build)
 
 ## Usage
 
 Please visit [https://sequence.app](https://sequence.app) to access the Sequence Wallet via your Web Browser, or
 download "Sequence Wallet" from the respective Apple/Google stores.
 
-You may also access, interface or develop your own Sequence Wallet via [sequence.js](https://github.com/0xsequence/sequence.js). The
+You may also access, interface, or develop your own Sequence Wallet via [sequence.js](https://github.com/0xsequence/sequence.js). The
 sequence.js library offers a full open source library to interact, create, deploy and manage a Sequence Smart Wallet Account,
-as defined by the contracts in this respository. Also see [go-sequence](https://github.com/0xsequence/go-sequence) for an implementation
+as defined by the contracts in this repository. Also see [go-sequence](https://github.com/0xsequence/go-sequence) for an implementation
 in Go.
 
-
 ## Connecting your Dapp with Sequence Wallet
 
 If you wish to use Sequence Wallet in your Dapp, simply use [sequence.js](https://github.com/0xsequence/sequence.js). Sequence.js
 is an Ethereum client library built on [ethers.js](https://github.com/ethers-io/ethers.js), that provides an additional
 Sequence Smart Wallet Signer.
 
-1. Install Sequence.js, an Ethereum client library built on ethers.js -- `yarn add 0xsequence` or `npm install 0xsequence`
-
-2. Setup an Ethereum web3-compatible provider from your dapp to the Sequence Wallet
-
-```typescript
-import { sequence } from '0xsequence'
-
-const wallet = new sequence.Wallet('mainnet')
-await wallet.login()
+Please refer to the [sequence.js](https://github.com/0xsequence/sequence.js) repository for usage instructions.
 
-const provider = wallet.getProvider()
-// .. connect provider to your dapp
-```
+# Developing a Custom Wallet UI for Sequence (Advanced!)
 
-# Developing a custom Wallet UI for Sequence (advanced!)
+If you wish to use the Sequence Wallet Contracts `@0xsequence/wallet-contracts` directly:
 
-If you wish to the Sequence Wallet Contracts `@0xsequence/wallet-contracts` directly:
+1. Install the contracts: `yarn add @0xsequence/wallet-contracts` or `npm install @0xsequence/wallet-contracts`
+2. Install the Sequence Wallet libraries: `yarn add @0xsequence/wallet` or `npm install @0xsequence/wallet`. You can view the source,
+   of the [wallet libraries](https://github.com/0xsequence/sequence.js/tree/master/packages/wallet), and review the
+   [Sequence tests](https://github.com/0xsequence/sequence.js/tree/master/packages/0xsequence) for sample usage.
 
-1. Install the contracts -- `yarn add @0xsequence/wallet-contracts` or `npm install @0xsequence/wallet-contracts`
-2. Install the Sequence Wallet libraries -- `yarn add @0xsequence/wallet` or `npm install @0xsequence/wallet`. To view the source,
-   of the wallet libraries, [see here](https://github.com/0xsequence/sequence.js/tree/master/packages/wallet), and review the test
-   for sample usage, as well as the tests [here]((https://github.com/0xsequence/sequence.js/tree/master/packages/0xsequence)).
-
-NOTE: this integration is only needed if you want low-level access to the Sequence Wallet contracts, such as if you'd building
+**NOTE:** this integration is only needed if you want low-level access to the Sequence Wallet contracts, such as if you'd building
 your own custom wallet, or perhaps a CLI tool for managing your wallet.
 
-
 ## Security Review
 
-`@0xsequence/wallet-contracts` has been audited by two independant parties
-
-* [Consensys Diligence](https://github.com/0xsequence/wallet-contracts/blob/master/audits/Consensys_Diligence.md) - May 2020
-* [Quantstamp - initial audit](https://github.com/0xsequence/wallet-contracts/raw/master/audits/Quantstamp_Arcadeum_Report_Final.pdf) - July 2020
-* [Quantstamp - audit of new capability, nested Sequence signers](https://github.com/0xsequence/wallet-contracts/raw/master/audits/sequence_quantstamp_audit_feb_2021.pdf) - Feb 2021
-
+`@0xsequence/wallet-contracts` has been audited by independent parties.
 
-## Dev env & release
+### V2 Audits
 
-This repository is configured as a yarn workspace, and has multiple pacakge.json files. Specifically,
-we have the root ./package.json for the development environment, contract compilation and testing. Contract
-source code and distribution files are packaged in "src/package.json".
+- [Consensys Diligence](https://github.com/0xsequence/wallet-contracts/blob/master/audits/v2/consensys-horizon-sequence-wallet-audit-2023-02.pdf) - February 2023
+- [Zellic](https://github.com/0xsequence/wallet-contracts/raw/master/audits/Quantstamp_Arcadeum_Report_Final.pdf) - March 2023
 
-To release a new version, make sure to bump the version, tag it, and run `yarn release`. The `release` command
-will publish the `@0xsequence/wallet-contracts` package in the "src/" folder, separate from the root package. The advantage
-here is that application developers who consume `@0xsequence/wallet-contracts` aren't required to install any of the devDependencies
-in their toolchains as our build and contract packages are separated.
+### V1 Audits
 
+- [Consensys Diligence](https://github.com/0xsequence/wallet-contracts/blob/master/audits/v1/Consensys_Diligence.md) - May 2020
+- [Quantstamp - initial audit](https://github.com/0xsequence/wallet-contracts/raw/master/audits/v1/Quantstamp_Arcadeum_Report_Final.pdf) - July 2020
+- [Quantstamp - audit of new capability, nested Sequence signers](https://github.com/0xsequence/wallet-contracts/raw/master/audits/v1/sequence_quantstamp_audit_feb_2021.pdf) - February 2021
 
-## LICENSE
+## License
 
 Copyright (c) 2017-present [Horizon Blockchain Games Inc](https://horizon.io).
 

diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -46,9 +46,6 @@ const config: HardhatUserConfig = {
     avalanche: networkConfig('avalanche'),
     avalancheFuji: networkConfig('avalanche-fuji'),
     ganache: ganacheNetwork,
-    coverage: {
-      url: 'http://localhost:8555'
-    },
     hardhat: {
       blockGasLimit: 60000000
     }

diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
     "clean": "rimraf artifacts && rimraf cache",
     "test": "hardhat test",
     "benchmark": "BENCHMARK=true yarn test",
-    "coverage": "COVERAGE=true NET_ID=1 hardhat coverage --network coverage",
+    "coverage": "COVERAGE=true NET_ID=1 hardhat coverage",
     "deploy": "hardhat run utils/deploy-contracts.ts --network",
     "verify": "hardhat verify --network",
     "release": "yarn publish src",
@@ -58,14 +58,14 @@
     "ethereum-waffle": "^3.4.4",
     "ethers": "^5.7.2",
     "ganache-cli": "6.12.2",
-    "hardhat": "^2.12.6",
+    "hardhat": "^2.16.1",
     "hardhat-gas-reporter": "1.0.4",
     "husky": "^4.2.3",
     "ora": "^5.4.1",
     "rimraf": "^3.0.2",
     "scrypt": "github:barrysteyn/node-scrypt#fb60a8d3c158fe115a624b5ffa7480f3a24b03fb",
     "solhint": "^3.4.1",
-    "solidity-coverage": "0.8.2",
+    "solidity-coverage": "0.8.3",
     "ts-node": "^10.9.1",
     "typechain": "^8.1.0",
     "typescript": "^4.7.4",