Remove stale functions and config options left over from v1 signer and update the README file

Signed-off-by: Jacinta Ferrant <[email protected]>

Author: jferrant

stacks-signer/README.md

@@ -1,6 +1,6 @@
 # stacks-signer: Stacks Signer CLI
 
-stacks-signer is a command-line interface (CLI) for executing DKG (Distributed Key Generation) rounds, signing transactions and blocks, and more within the Stacks blockchain ecosystem. This tool provides various subcommands to interact with the StackerDB contract, perform cryptographic operations, and run a Stacks compliant signer.
+stacks-signer is a command-line interface (CLI) for operating a Stacks compliant signer. This tool provides various subcommands to interact with the StackerDB contract, generate SIP voting and stacking signatures, and monitoring the Signer network for expected behaviour.
 
 ## Installation
 
@@ -25,18 +25,92 @@ To use stacks-signer, you need to build and install the Rust program. You can do
    ./target/release/stacks-signer --help
    ```
 
+4. **Build with Prometheus Metrics Enabled**: You can optionally build and run the stacks-signer with monitoring metrics enabled.
+
+   ```bash
+   cd stacks-signer
+   cargo build --release --features "monitoring_prom"
+   cargo run --features "monitoring_prom" -p stacks-signer run --config <config_file>
+   ```
+
+You must specify the "metrics_endpoint" option in the config file to serve these metrics.
+See [metrics documentation](TODO) for a complete breakdown of the available metrics.
+
 ## Usage
 
 The stacks-signer CLI provides the following subcommands:
 
+### `run`
+
+Start the signer and handle requests to sign Stacks block proposals.
+
+```bash
+./stacks-signer run --config <config_file>
+
+```
+
+### `monitor-signers`
+
+Periodically query the current reward cycle's signers' StackerDB slots to verify their operation.
+
+```bash
+./stacks-signer monitor-signers --host <host> --interval <interval> --max-age <max_age>
+
+```
+- `--host`: The Stacks node to connect to.
+- `--interval`: The polling interval in seconds for querying stackerDB.
+- `--max-age`: The max age in seconds before a signer message is considered stale. 
+
+### `generate-stacking-signature`
+
+Generate a signature for stacking.
+
+```bash
+./stacks-signer generate-stacking-signature --config <config_file> --pox-address <address> --reward-cycle <cycle> --period <period> --max-amount <max_amount> --auth-id <auth_id>
+
+```
+- `--config`: The path to the signer configuration file.
+- `--pox-address`: The BTC address used to receive rewards
+- `--reward-cycle`: The reward cycle during which this signature is used
+- `--method`: Stacking metod that can be used
+- `--period`: Number of cycles used as a lock period. Use `1` for stack-aggregation-commit method
+- `--max-amount`: The max amount of uSTX that can be used in this unique transaction
+- `--auth-id`: A unique identifier to prevent re-using this authorization
+- `--json`: Output information in JSON format
+
+### `generate-vote`
+
+Generate a vote signature for a specific SIP
+
+```bash
+./stacks-signer generate-vote --config <config_file> --vote <yes|no> --sip <sip_number>
+
+```
+- `--config`: The path to the signer configuration file.
+- `--vote`: The vote (YES or NO)
+- `--sip`: the number of the SIP being voted on
+
+### `verify-vote`
+
+Verify the validity of a vote signature for a specific SIP.
+
+```bash
+./stacks-signer verify-vote --public-key <public_key> --signature <signature> --vote <yes|no> --sip <sip_number>
+
+```
+- `--public-key`: The stacks public key to verify against in hexadecimal format
+- `--signature`: The message signature in hexadecimal format
+- `--vote`: The vote (YES or NO)
+- `--sip`: the number of the SIP being voted on
+
 ### `get-chunk`
 
 Retrieve a chunk from the StackerDB instance.
 
 ```bash
 ./stacks-signer get-chunk --host <host> --contract <contract> --slot_id <slot_id> --slot_version <slot_version>
-```
 
+```
 - `--host`: The stacks node host to connect to.
 - `--contract`: The contract ID of the StackerDB instance.
 - `--slot-id`: The slot ID to get.
@@ -49,7 +123,6 @@ Retrieve the latest chunk from the StackerDB instance.
 ```bash
 ./stacks-signer get-latest-chunk --host <host> --contract <contract> --slot-id <slot_id>
 ```
-
 - `--host`: The stacks node host to connect to.
 - `--contract`: The contract ID of the StackerDB instance.
 - `--slot-id`: The slot ID to get.
@@ -71,72 +144,17 @@ Upload a chunk to the StackerDB instance.
 ```bash
 ./stacks-signer put-chunk --host <host> --contract <contract> --private_key <private_key> --slot-id <slot_id> --slot-version <slot_version> [--data <data>]
 ```
-
 - `--host`: The stacks node host to connect to.
 - `--contract`: The contract ID of the StackerDB instance.
 - `--private_key`: The Stacks private key to use in hexademical format.
 - `--slot-id`: The slot ID to get.
 - `--slot-version`: The slot version to get.
 - `--data`: The data to upload. If you wish to pipe data using STDIN, use with '-'.
 
-### `dkg`
-
-Run a distributed key generation round through stacker-db.
-
-```bash
-./stacks-signer dkg --config <config_file> 
-```
-
-- `--config`: The path to the signer configuration file.
-
-### `dkg-sign`
-
-Run a distributed key generation round and sign a given message through stacker-db.
-
-```bash
-./stacks-signer dkg-sign --config <config_file> [--data <data>]
-```
-- `--config`: The path to the signer configuration file.
-- `--data`: The data to sign. If you wish to pipe data using STDIN, use with '-'.
-
-
-### `dkg-sign`
-
-Sign a given message through stacker-db.
-
-```bash
-./stacks-signer sign --config <config_file> [--data <data>]
-```
-- `--config`: The path to the signer configuration file.
-- `--data`: The data to sign. If you wish to pipe data using STDIN, use with '-'.
-
-### `run`
-
-Start the signer and handle requests to sign messages and participate in DKG rounds via stacker-db.
-```bash
-./stacks-signer run --config <config_file>
-```
-- `--config`: The path to the signer configuration file.
-
-### `generate-files`
-
-Generate the necessary files to run a collection of signers to communicate via stacker-db.
-
-```bash
-./stacks-signer generate-files --host <host> --contract <contract>  --num-signers <num_signers> --num-keys <num_keys> --network <network> --dir <dir>
-```
-- `--host`: The stacks node host to connect to.
-- `--contract`: The contract ID of the StackerDB signer contract.
-- `--num-signers`: The number of signers to generate configuration files for.
-- `--num-keys`: The total number of key ids to distribute among the signers.
-- `--private-keys:` A path to a file containing a list of hexadecimal representations of Stacks private keys. Required if `--num-keys` is not set.
-- `--network`: The network to use. One of "mainnet" or "testnet".
-- `--dir`: The directory to write files to. Defaults to the current directory.
-- `--timeout`: Optional timeout in milliseconds to use when polling for updates in the StackerDB runloop.
-
 ## Contributing
 
 To contribute to the stacks-signer project, please read the [Contributing Guidelines](../CONTRIBUTING.md).
+
 ## License
 
 This program is open-source software released under the terms of the GNU General Public License (GPL). You should have received a copy of the GNU General Public License along with this program.

stacks-signer/src/client/mod.rs

@@ -129,15 +129,12 @@ pub(crate) mod tests {
 
     use blockstack_lib::chainstate::stacks::boot::POX_4_NAME;
     use blockstack_lib::chainstate::stacks::db::StacksBlockHeaderTypes;
-    use blockstack_lib::net::api::getaccount::AccountEntryResponse;
     use blockstack_lib::net::api::getinfo::RPCPeerInfoData;
     use blockstack_lib::net::api::getpoxinfo::{
         RPCPoxCurrentCycleInfo, RPCPoxEpoch, RPCPoxInfoData, RPCPoxNextCycleInfo,
     };
-    use blockstack_lib::net::api::postfeerate::{RPCFeeEstimate, RPCFeeEstimateResponse};
     use blockstack_lib::util_lib::boot::boot_code_id;
     use clarity::vm::costs::ExecutionCost;
-    use clarity::vm::types::TupleData;
     use clarity::vm::Value as ClarityValue;
     use libsigner::SignerEntries;
     use rand::distributions::Standard;
@@ -221,28 +218,6 @@ pub(crate) mod tests {
         ConsensusHash(hash)
     }
 
-    /// Build a response for the get_last_round request
-    pub fn build_get_last_round_response(round: u64) -> String {
-        let value = ClarityValue::some(ClarityValue::UInt(round as u128))
-            .expect("Failed to create response");
-        build_read_only_response(&value)
-    }
-
-    /// Build a response for the get_account_nonce request
-    pub fn build_account_nonce_response(nonce: u64) -> String {
-        let account_nonce_entry = AccountEntryResponse {
-            nonce,
-            balance: "0x00000000000000000000000000000000".to_string(),
-            locked: "0x00000000000000000000000000000000".to_string(),
-            unlock_height: thread_rng().next_u64(),
-            balance_proof: None,
-            nonce_proof: None,
-        };
-        let account_nonce_entry_json = serde_json::to_string(&account_nonce_entry)
-            .expect("Failed to serialize account nonce entry");
-        format!("HTTP/1.1 200 OK\n\n{account_nonce_entry_json}")
-    }
-
     /// Build a response to get_pox_data_with_retry where it returns a specific reward cycle id and block height
     pub fn build_get_pox_data_response(
         reward_cycle: Option<u64>,
@@ -377,44 +352,6 @@ pub(crate) mod tests {
         format!("HTTP/1.1 200 OK\n\n{{\"okay\":true,\"result\":\"{hex}\"}}")
     }
 
-    /// Build a response for the get_medium_estimated_fee_ustx_response request with a specific medium estimate
-    pub fn build_get_medium_estimated_fee_ustx_response(
-        medium_estimate: u64,
-    ) -> (String, RPCFeeEstimateResponse) {
-        // Generate some random info
-        let fee_response = RPCFeeEstimateResponse {
-            estimated_cost: ExecutionCost {
-                write_length: thread_rng().next_u64(),
-                write_count: thread_rng().next_u64(),
-                read_length: thread_rng().next_u64(),
-                read_count: thread_rng().next_u64(),
-                runtime: thread_rng().next_u64(),
-            },
-            estimated_cost_scalar: thread_rng().next_u64(),
-            cost_scalar_change_by_byte: thread_rng().next_u32() as f64,
-            estimations: vec![
-                RPCFeeEstimate {
-                    fee_rate: thread_rng().next_u32() as f64,
-                    fee: thread_rng().next_u64(),
-                },
-                RPCFeeEstimate {
-                    fee_rate: thread_rng().next_u32() as f64,
-                    fee: medium_estimate,
-                },
-                RPCFeeEstimate {
-                    fee_rate: thread_rng().next_u32() as f64,
-                    fee: thread_rng().next_u64(),
-                },
-            ],
-        };
-        let fee_response_json = serde_json::to_string(&fee_response)
-            .expect("Failed to serialize fee estimate response");
-        (
-            format!("HTTP/1.1 200 OK\n\n{fee_response_json}"),
-            fee_response,
-        )
-    }
-
     /// Generate a signer config with the given number of signers and keys where the first signer is
     /// obtained from the provided global config
     pub fn generate_signer_config(config: &GlobalConfig, num_signers: u32) -> SignerConfig {
@@ -473,43 +410,12 @@ pub(crate) mod tests {
             stacks_private_key: config.stacks_private_key,
             node_host: config.node_host.to_string(),
             mainnet: config.network.is_mainnet(),
-            dkg_end_timeout: config.dkg_end_timeout,
-            dkg_private_timeout: config.dkg_private_timeout,
-            dkg_public_timeout: config.dkg_public_timeout,
-            nonce_timeout: config.nonce_timeout,
-            sign_timeout: config.sign_timeout,
-            tx_fee_ustx: config.tx_fee_ustx,
-            max_tx_fee_ustx: config.max_tx_fee_ustx,
             db_path: config.db_path.clone(),
             first_proposal_burn_block_timing: config.first_proposal_burn_block_timing,
             block_proposal_timeout: config.block_proposal_timeout,
         }
     }
 
-    pub fn build_get_round_info_response(info: Option<(u64, u64)>) -> String {
-        let clarity_value = if let Some((vote_count, vote_weight)) = info {
-            ClarityValue::some(ClarityValue::Tuple(
-                TupleData::from_data(vec![
-                    ("votes-count".into(), ClarityValue::UInt(vote_count as u128)),
-                    (
-                        "votes-weight".into(),
-                        ClarityValue::UInt(vote_weight as u128),
-                    ),
-                ])
-                .expect("BUG: Failed to create clarity value from tuple data"),
-            ))
-            .expect("BUG: Failed to create clarity value from tuple data")
-        } else {
-            ClarityValue::none()
-        };
-        build_read_only_response(&clarity_value)
-    }
-
-    pub fn build_get_weight_threshold_response(threshold: u64) -> String {
-        let clarity_value = ClarityValue::UInt(threshold as u128);
-        build_read_only_response(&clarity_value)
-    }
-
     pub fn build_get_tenure_tip_response(header_types: &StacksBlockHeaderTypes) -> String {
         let response_json =
             serde_json::to_string(header_types).expect("Failed to serialize tenure tip info");