Wallet CLI Implementation

README.md

@@ -102,6 +102,22 @@ Importing the snapshot only needs to happen during the first run. Following this
 ./target/release/forest
 ```
 
+### Interacting with Forest via CLI
+
+When the Forest daemon is started, an admin token will be displayed. You will need this for commands that require a higher level of authorization (like a password). Forest, as mentioned above, uses multiaddresses for networking. This is no different in the CLI. To set the host and the port to use, if not using the default port or using a remote host, set the `FULLNODE_API_INFO` environment variable. This is also where you can set a token for authentication.
+
+```
+FULLNODE_API_INFO="<token goes here>:/ip4/<host>/tcp/<port>/http
+```
+
+Note that if a token is not present in the FULLNODE_API_INFO env variable, the colon is removed.
+
+Forest developers will prepend this variable to cli commands over using `export` on Linux or its equivelant on Windows. This will look like the following:
+
+```
+FULLNODE_API_INFO="..." forest auth api-info -p admin
+```
+
 ### Documentation
 https://chainsafe.github.io/forest/
 

blockchain/chain/src/store/chain_store.rs

@@ -1020,13 +1020,7 @@ mod tests {
     use super::*;
     use address::Address;
     use async_std::sync::Arc;
-    use async_std::{
-        fs::{remove_file, File},
-        io::{BufReader, BufWriter},
-    };
     use cid::Code::{Blake2b256, Identity};
-    use state_tree::StateTree;
-    use types::StateTreeVersion;
 
     #[test]
     fn genesis_test() {

blockchain/chain_sync/src/chain_muxer.rs

@@ -837,23 +837,12 @@ where
 #[cfg(test)]
 mod tests {
     use std::convert::TryFrom;
-    use std::sync::Arc;
-    use std::time::Duration;
-
-    use async_std::channel::{bounded, Sender};
-    use async_std::task;
 
     use crate::validation::TipsetValidator;
-    use beacon::{BeaconPoint, MockBeacon};
-    use chain::ChainStore;
     use cid::Cid;
     use db::MemoryDB;
-    use fil_types::verifier::MockVerifier;
-    use forest_libp2p::NetworkEvent;
     use message::{SignedMessage, UnsignedMessage};
-    use message_pool::{test_provider::TestApi, MessagePool};
-    use state_manager::StateManager;
-    use test_utils::{construct_dummy_header, construct_messages};
+    use test_utils::construct_messages;
 
     #[test]
     fn compute_msg_meta_given_msgs_test() {

crypto/src/signature.rs

@@ -343,7 +343,7 @@ pub mod json {
             Secp256k1,
         }
 
-        #[derive(Serialize, Deserialize)]
+        #[derive(Debug, Serialize, Deserialize)]
         #[serde(transparent)]
         pub struct SignatureTypeJson(#[serde(with = "self")] pub SignatureType);
 

docs/CLI.md

@@ -0,0 +1,75 @@
+
+# CLI
+
+The forest CLI allows for operations to interact with a Filecoin node and the blockchain.
+
+
+## Environment Variables
+For nodes not running on a non-default port, or when interacting with a node remotely, you will need
+to provide the multiaddress information for the node. You will need to either set the environment variable
+`FULLNODE_API_INFO`, or prepend it to the command, like so:
+
+`FULLNODE_API_INFO="..." forest wallet new -s bls`
+
+On linux, you can set the environment variable with the following syntax
+
+`export FULLNOPDE_API_INFO="..."`
+
+Setting your API info this way will limit the value to your current session. Look online for ways to persist 
+this variable if desired.
+
+The syntax for the `FULLNODE_API_INFO` variable is as follows:
+
+`<admin_token>:/ip4/<ip of host>/tcp/<port>/http`
+
+This will use IPv4, tcp, and http when communicating with the RPC API. The admin token can be found when starting
+the forest daemon. This will be needed to create tokens with certain permissions such as read, write, sign, or admin.
+
+## Wallet
+
+All wallet commands require write permissions to interact with the keystore
+
+Balance
+Retrieve the fil balance of a given address
+Usage: `forest wallet balance <address>`
+
+Default
+Get the default, persisted address from the keystore
+Usage: `forest wallet default`
+
+Has
+Check if an address exists in the keystore
+shows true/false if exists or doesn't
+Usage: `forest wallet has <address>`
+
+List
+Display the keys in the keystore
+Usage: `forest wallet list`
+
+New
+Create a new wallet
+The signature type can either be secp256k1 or bls. Defaults to use bls
+Usage: `forest wallet new <bls/secp256k1>`
+
+Set-default
+Set an address to be the default address of the keystore
+Usage: `forest wallet set-default <address>`
+
+Import
+Import a private key to the keystore and create a new address.
+The default format for importing keys is hex encoded JSON. Use the `export`
+command to get formatted keys for importing.
+Usage: `forest wallet import <hex encoded json key>`
+
+Export
+Export a key by address. Use a wallet address to export a key. Returns a formatted key
+to be used to import on another node, or into a new keystore.
+Usage: `forest wallet export <address>`
+
+Sign
+Use an address to sign a vector of bytes
+Usage: `forest wallet sign -m <hex message> -a <address>`
+
+Verify
+Verify the message's integrity with an address and signature
+Usage: `forest wallet verify -m <hex message> -a <address> -s <signature>`

forest/Cargo.toml

@@ -6,6 +6,7 @@ edition = "2018"
 
 [dependencies]
 address = { package = "forest_address", version = "0.3" }
+base64 = "0.13"
 forest_libp2p = { path = "../node/forest_libp2p" }
 utils = { path = "../node/utils" }
 db = { package = "forest_db", version = "0.1" }
@@ -21,6 +22,7 @@ chain_sync = { path = "../blockchain/chain_sync" }
 state_manager = { path = "../blockchain/state_manager" }
 cid = { package = "forest_cid", version = "0.3", features = ["json"] }
 forest_car = { path = "../ipld/car" }
+forest_crypto = { version = "0.5.2", features = ["json"] }
 tokio = { version = "1.0", features = ["sync"] }
 num-bigint = { path = "../utils/bigint", package = "forest_bigint" }
 blocks = { package = "forest_blocks", path = "../blockchain/blocks" }
@@ -34,6 +36,7 @@ rpc_client = { package = "rpc-client", path = "../node/rpc-client" }
 rpc-api = { path = "../node/rpc-api", version = "0.1" }
 fil_types = "0.2"
 serde_json = "1.0"
+message = { package = "forest_message", version = "0.7", features = ["blst"] }
 message_pool = { package = "message_pool", path = "../blockchain/message_pool" }
 wallet = { package = "key_management", path = "../key_management" }
 uuid = { version = "0.8.2", features = ["v4"] }

forest/src/cli/mod.rs

@@ -6,12 +6,14 @@ mod chain_cmd;
 mod config;
 mod fetch_params_cmd;
 mod genesis_cmd;
+mod wallet_cmd;
 
 pub(super) use self::auth_cmd::AuthCommands;
 pub(super) use self::chain_cmd::ChainCommands;
 pub use self::config::Config;
 pub(super) use self::fetch_params_cmd::FetchCommands;
 pub(super) use self::genesis_cmd::GenesisCommands;
+pub(super) use self::wallet_cmd::WalletCommands;
 
 use jsonrpc_v2::Error as JsonRpcError;
 use serde::Serialize;
@@ -59,6 +61,8 @@ pub enum Subcommand {
 
     #[structopt(name = "genesis", about = "Work with blockchain genesis")]
     Genesis(GenesisCommands),
+    #[structopt(name = "wallet", about = "Manage wallet")]
+    Wallet(WalletCommands),
 }
 
 /// Daemon process command line options.
@@ -204,6 +208,11 @@ pub(super) fn handle_rpc_err(e: JsonRpcError) {
     }
 }
 
+pub(super) fn cli_error_and_die(msg: &str, code: i32) {
+    println!("Error: {}", msg);
+    std::process::exit(code);
+}
+
 /// Prints a plain HTTP JSON-RPC response result
 pub(super) fn print_rpc_res(res: Result<String, JsonRpcError>) {
     match res {