chore: enhance comments (#1325)

I found some wrong information when i read the codes. Use this commit to
update them.

## Description

Closes: #?

## Changes

## Testing Information

## Checklist:

- [ ] I have performed a self-review of my code
- [ ] My changes generate no new warnings
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream
modules

Makefile

@@ -248,7 +248,7 @@ $(BLOCKLIST_OPENAPI_SPEC_PATH): $(BLOCKLIST_OPENAPI_SOURCE_FILES)
 	@echo "Generating Blocklist OpenAPI spec"
 	cargo $(CARGO_FLAGS) build --package $(BLOCKLIST_OPENAPI_SPEC_PROJECT_NAME) --target-dir ./target/blocklist-spec-gen ${CARGO_BUILD_ARGS}
 
-# Geneate Rust client code for the Blocklist API if any of the generated source
+# Generate Rust client code for the Blocklist API if any of the generated source
 # files are older than the OpenAPI spec file.
 $(BLOCKLIST_CLIENT_SOURCE_FILES): $(BLOCKLIST_OPENAPI_SPEC_PATH)
 	@echo "Generating blocklist client from openapi spec"

docker/mainnet/sbtc-signer/signer-config.toml.in

@@ -99,7 +99,7 @@ db_endpoint = "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@$POSTGRES_HOST:$PO
 private_key = "0000000000000000000000000000000000000000000000000000000000000001"
 
 # Specifies which network to use when constructing and sending transactions
-# on stacks and bitcoin. This cooresponds to the `chain` flag in the
+# on stacks and bitcoin. This corresponds to the `chain` flag in the
 # bitcoin.conf file of the connected bitcoin-core node, and the
 # `burnchain.mode` flag int he config.toml of the connected stacks-core
 # node.

docker/mainnet/vector/vector.yaml

@@ -11,7 +11,7 @@ sources:
 
 transforms:
   # This is required because Cloudwatch is picky about empty tags ("dimensions")
-  # And our `build` metric has an emtpy revision.
+  # And our `build` metric has an empty revision.
   sbtc_prometheus_metrics_strip_empty_tags:
     type: remap
     inputs:

docker/sbtc/README.md

@@ -1,6 +1,6 @@
 # /docker/sbtc/emily
 
-This folder contains three different docker definitons.
+This folder contains three different docker definitions.
 1. aws-setup - sets up the AWS resources necessary for the Emily API to function
 2. handler-lambda - Runs the Emily handler as a serverless lambda
 3. handler-server - Runs the Emily handler as a server, better for local testing and can compile for ARM 64 systems unlike the `handler-lambda`

docker/sbtc/emily-aws-setup/initialize.py

@@ -112,7 +112,7 @@ def replace_local_lambda_path(template, local_lambda_path):
     """
 
     # Ensure we don't modify the original template so this function doesn't
-    # have unintented side effects.
+    # have unintended side effects.
     modified_template = copy.deepcopy(template)
     lambda_template_resource_ids = get_template_resource_ids_for_resources_type(
         modified_template, "AWS::Lambda::Function")

docker/sbtc/signer/signer-config.toml

@@ -100,7 +100,7 @@ endpoints = ["http://stacks-node:20443"]
 private_key = ""
 
 # Specifies which network to use when constructing and sending transactions
-# on stacks and bitcoin. This cooresponds to the `chain` flag in the
+# on stacks and bitcoin. This corresponds to the `chain` flag in the
 # bitcoin.conf file of the connected bitcoin-core node, and the
 # `burnchain.mode` flag int he config.toml of the connected stacks-core
 # node.

docker/testnet/README.md

@@ -66,7 +66,7 @@ work for the folks running the signer. If your signer is saying that it
 cannot find the signer database either:
 
 1. The database is not in the location `.postgres/data`
-2. It has incompatable permissions with the docker container runner.
+2. It has incompatible permissions with the docker container runner.
 
 ### Add an event-listener to your Stacks node
 

docker/testnet/vector/vector.yaml

@@ -11,7 +11,7 @@ sources:
 
 transforms:
   # This is required because Cloudwatch is picky about empty tags ("dimensions")
-  # And our `build` metric has an emtpy revision.
+  # And our `build` metric has an empty revision.
   sbtc_prometheus_metrics_strip_empty_tags:
     type: remap
     inputs:

emily/handler/src/database/entries/deposit.rs

@@ -286,7 +286,7 @@ pub struct DepositEvent {
     pub status: StatusEntry,
     /// Status message.
     pub message: String,
-    /// Stacks block heigh at the time of this update.
+    /// Stacks block height at the time of this update.
     pub stacks_block_height: u64,
     /// Stacks block hash associated with the height of this update.
     pub stacks_block_hash: String,

emily/handler/src/database/entries/withdrawal.rs

@@ -225,7 +225,7 @@ pub struct WithdrawalEvent {
     pub status: StatusEntry,
     /// Status message.
     pub message: String,
-    /// Stacks block heigh at the time of this update.
+    /// Stacks block height at the time of this update.
     pub stacks_block_height: u64,
     /// Stacks block hash associated with the height of this update.
     pub stacks_block_hash: String,

sbtc/src/testing/deposits.rs

@@ -17,7 +17,7 @@ use crate::deposits;
 use crate::deposits::DepositScriptInputs;
 use crate::deposits::ReclaimScriptInputs;
 
-/// A properly formated transaction and the corresponding deposit and
+/// A properly formatted transaction and the corresponding deposit and
 /// reclaim inputs.
 pub struct TxSetup {
     /// The transaction

signer/src/config/default.toml

@@ -104,7 +104,7 @@ endpoints = ["http://localhost:20443"]
 private_key = "41634762d89dfa09133a4a8e9c1378d0161d29cd0a9433b51f1e3d32947a73dc"
 
 # Specifies which network to use when constructing and sending transactions
-# on stacks and bitcoin. This cooresponds to the `chain` flag in the
+# on stacks and bitcoin. This corresponds to the `chain` flag in the
 # bitcoin.conf file of the connected bitcoin-core node, and the
 # `burnchain.mode` flag int he config.toml of the connected stacks-core
 # node.