doc: update

REI-Network · Jun 21, 2023 · a98ee01 · a98ee01
1 parent 3ef462d
commit a98ee01
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -28,7 +28,6 @@ Nodejs implementation of REI-Network protocols
 - node >= `14.16.1`
 - npm >= `7.0.0`
 - supported system:
-  - Windows 10+
   - MacOS 12+
   - Any Linux with glibc >= `2.28` and glibcxx >= `3.4.25`
 
@@ -78,12 +77,16 @@ Options:
   --verbosity <verbosity>                    logging verbosity: silent, error, warn, info, debug, detail (default: "info")
   --receipts-cache-size <receiptsCacheSize>  receipts cache size
   --evm <evm>                                evm implementation type, "js" or "binding"
+  --bls <bls>                                the datadir for bls (default: "bls")
+  --bls-password <blsPassword>               bls password file to use for non-interactive password input
+  --bls-file <blsFile>                       bls file name
   -h, --help                                 display help for command
 
 Commands:
   account                                    Manage accounts
   attach [ipcpath]                           Start an interactive JavaScript environment (connect to node)
   console                                    Start an interactive JavaScript environment
+  bls                                        Manage bls signature key
 ```
 
 ### Example

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -49,12 +49,16 @@ Options:
   --verbosity <verbosity>                    logging verbosity: silent, error, warn, info, debug, detail (default: "info")
   --receipts-cache-size <receiptsCacheSize>  receipts cache size
   --evm <evm>                                evm implementation type, "js" or "binding"
+  --bls <bls>                                the datadir for bls (default: "bls")
+  --bls-password <blsPassword>               bls password file to use for non-interactive password input
+  --bls-file <blsFile>                       bls file name
   -h, --help                                 display help for command
 
 Commands:
   account                                    Manage accounts
   attach [ipcpath]                           Start an interactive JavaScript environment (connect to node)
   console                                    Start an interactive JavaScript environment
+  bls                                        Manage bls signature key
 ```
 
 ## Example

diff --git a/packages/contracts/README.md b/packages/contracts/README.md
@@ -14,6 +14,7 @@ REI-Network genesis contracts
 - `FeePool` A smart contract for distributing miner fee rewards, deployed at `0x0000000000000000000000000000000000001006`
 - `FeeToken` A smart contract for querying the user's remaining Crude quantity, deployed at `0x0000000000000000000000000000000000001007`
 - `Prison` A smart contract for jailing validator which not mint blocks on time, deployed at `0x0000000000000000000000000000000000001008`
+- `ValidatorBLS` A smart contract that manages the validator's BLS public key, deployed at `0x0000000000000000000000000000000000001009`
 
 ## Install