add CLI support: clippy and fmt + rename commands

.cargo/config.toml

@@ -1,5 +1,8 @@
 [alias]
-bitcoin-indexer-install = "install --path components/cli --locked --force"
+bitcoin-indexer-install = "install --path components/ordhook-cli --locked --force"
+bitcoin-indexer-fmt = "fmt -- --config group_imports=StdExternalCrate,imports_granularity=Crate"
+bitcoin-indexer-clippy = "clippy --tests --all-features --all-targets -- -A clippy::too_many_arguments -A clippy::needless_return -A clippy::type_complexity -A clippy::ptr_arg"
+bitcoin-indexer-clippy-cli = "clippy --tests --all-features --all-targets --message-format=short -- -A clippy::too_many_arguments -A clippy::needless_return -A clippy::type_complexity -A clippy::ptr_arg -D warnings"
 
 [env]
 RUST_TEST_THREADS = "1"

.github/workflows/ci.yaml

@@ -119,6 +119,102 @@ jobs:
         run: npm run testenv:stop
         if: always()
 
+  rustfmt:
+    name: rust-fmt
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        suite:
+          - cli
+          - chainhook-sdk
+          - chainhook-postgres
+          - ordhook-core
+          - runes
+    defaults:
+      run:
+        working-directory: ./components/${{ matrix.suite }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Rustfmt Job Summary
+        run: |
+          # Run cargo and store the original output
+          CARGO_STATUS=0
+          CARGO_OUTPUT=$(cargo fmt --all --manifest-path=Cargo.toml -- --config group_imports=StdExternalCrate,imports_granularity=Crate --color=always --check 2>/dev/null) || CARGO_STATUS=$?
+
+          if [ ${CARGO_STATUS} -eq 0 ]; then
+              cat <<MARKDOWN_INTRO >> $GITHUB_STEP_SUMMARY
+          # Rustfmt Results
+
+          The code is formatted perfectly!
+          MARKDOWN_INTRO
+          else
+              cat <<MARKDOWN_INTRO >> $GITHUB_STEP_SUMMARY
+          # Rustfmt Results
+
+          \`cargo fmt\` reported formatting errors in the following locations.
+          You can fix them by executing the following command and committing the changes.
+          \`\`\`bash
+          cargo bitcoin-indexer-fmt
+          \`\`\`
+          MARKDOWN_INTRO
+
+              echo "${CARGO_OUTPUT}" |
+                  # Strip color codes
+                  sed 's/\x1B\[[0-9;]*[A-Za-z]\x0f\?//g' |
+                  # Strip (some) cursor movements
+                  sed 's/\x1B.[A-G]//g' |
+                  tr "\n" "\r" |
+                  # Wrap each location into a HTML details
+                  sed -E 's#Diff in ([^\r]*?)( at line |:)([[:digit:]]+):\r((:?[ +-][^\r]*\r)+)#<details>\n<summary>\1:\3</summary>\n\n```diff\n\4```\n\n</details>\n\n#g' |
+                  tr "\r" "\n" >> $GITHUB_STEP_SUMMARY
+          fi
+
+          # Print the original cargo message
+          echo "${CARGO_OUTPUT}"
+          # Exit with the same status as cargo
+          exit "${CARGO_STATUS}"
+
+  clippy:
+    name: rust-clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Run clippy
+        id: clippy
+        run: |
+          # Disable immediate exit on error
+          set +e
+
+          # Run clippy and capture output
+          cargo bitcoin-indexer-clippy-cli 2>&1 | tee /tmp/clippy_output.log
+          CLIPPY_EXIT_CODE=${PIPESTATUS[0]}
+
+          # Print output if clippy failed
+          if [ $CLIPPY_EXIT_CODE -ne 0 ]; then
+            echo "## ❌ Clippy Check Failed
+
+          To see and fix these issues, run:
+          \`\`\`bash
+          cargo bitcoin-indexer-clippy
+          \`\`\`
+
+          ### Clippy Errors
+          \`\`\`
+          $(cat /tmp/clippy_output.log | grep -E '(error\:)|(warning\:)')
+          \`\`\`" >> $GITHUB_STEP_SUMMARY
+          fi
+
+          # Enable immediate exit on error again
+          set -e
+          exit $CLIPPY_EXIT_CODE
+
   test:
     strategy:
       fail-fast: false
@@ -158,6 +254,10 @@ jobs:
       - name: Install Rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
 
+      - name: Run doc tests
+        run: |
+          cargo test --doc
+
       - name: Run tests
         run: |
           cargo install --force cargo-tarpaulin
@@ -178,7 +278,7 @@ jobs:
 
   semantic-release:
     runs-on: ubuntu-latest
-    needs: [api-lint, api-test, test]
+    needs: [api-lint, api-test, test, rustfmt, clippy]
     outputs:
       new_release_version: ${{ steps.semantic.outputs.new_release_version }}
       new_release_published: ${{ steps.semantic.outputs.new_release_published }}

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "editor.defaultFormatter": "rust-lang.rust-analyzer",
+    "editor.formatOnSave": true,
+    "editor.formatOnSaveMode": "file",
+    "rust-analyzer.rustfmt.extraArgs": [
+        "--config",
+        "group_imports=StdExternalCrate,imports_granularity=Crate"
+    ]
+}

README.md

@@ -2,15 +2,18 @@
       / --- /      Index Bitcoin meta-protocols like Ordinals, BRC-20, and Runes.
      /     /
 
-* [Features](#features)
-* [Quick Start](#quick-start)
-    * [Installing](#installing)
-    * [Running the Indexer](#running-the-indexer)
-* [Configuration](#configuration)
-* [System Requirements](#system-requirements)
-    * [Postgres](#postgres)
-* [Contribute](#contribute)
-* [Community](#community)
+- [Features](#features)
+- [Quick Start](#quick-start)
+  - [Installing](#installing)
+  - [Running the Indexer](#running-the-indexer)
+  - [Running an API](#running-an-api)
+- [Configuration](#configuration)
+- [System Requirements](#system-requirements)
+  - [Postgres](#postgres)
+- [Contribute](#contribute)
+  - [Code of Conduct](#code-of-conduct)
+  - [Contributing Guide](#contributing-guide)
+- [Community](#community)
 
 ***
 

components/chainhook-postgres/src/lib.rs

@@ -37,9 +37,9 @@
     if let Some(size) = config.pool_max_size {
         pool_builder = pool_builder.max_size(size);
     }
-    Ok(pool_builder
+    pool_builder
         .build()
-        .map_err(|e| format!("unable to build pg connection pool: {e}"))?)
+        .map_err(|e| format!("unable to build pg connection pool: {e}"))
 }
 
 /// Returns a new pg connection client taken from a pool.

components/chainhook-postgres/src/types/mod.rs

@@ -1,9 +1,9 @@
 mod pg_bigint_u32;
-mod pg_numeric_u64;
 mod pg_numeric_u128;
+mod pg_numeric_u64;
 mod pg_smallint_u8;
 
 pub use pg_bigint_u32::PgBigIntU32;
-pub use pg_numeric_u64::PgNumericU64;
 pub use pg_numeric_u128::PgNumericU128;
+pub use pg_numeric_u64::PgNumericU64;
 pub use pg_smallint_u8::PgSmallIntU8;

components/chainhook-postgres/src/types/pg_bigint_u32.rs

@@ -57,9 +57,8 @@ impl Ord for PgBigIntU32 {
 mod test {
     use test_case::test_case;
 
-    use crate::pg_test_client;
-
     use super::PgBigIntU32;
+    use crate::pg_test_client;
 
     #[test_case(4294967295; "u32 max")]
     #[test_case(0; "zero")]

components/chainhook-postgres/src/types/pg_numeric_u128.rs

@@ -11,7 +11,7 @@ use tokio_postgres::types::{to_sql_checked, FromSql, IsNull, ToSql, Type};
 
 /// Transforms a u128 value into postgres' `numeric` wire format.
 pub fn u128_into_pg_numeric_bytes(number: u128, out: &mut BytesMut) {
-    let mut num = number.clone();
+    let mut num = number;
     let mut digits = vec![];
     while !num.is_zero() {
         let remainder = (num % 10000).to_i16().unwrap();
@@ -136,9 +136,8 @@ impl Ord for PgNumericU128 {
 mod test {
     use test_case::test_case;
 
-    use crate::pg_test_client;
-
     use super::PgNumericU128;
+    use crate::pg_test_client;
 
     #[test_case(340282366920938463463374607431768211455; "u128 max")]
     #[test_case(80000000000000000; "with trailing zeros")]

components/chainhook-postgres/src/types/pg_numeric_u64.rs

@@ -53,9 +53,8 @@ impl Ord for PgNumericU64 {
 mod test {
     use test_case::test_case;
 
-    use crate::pg_test_client;
-
     use super::PgNumericU64;
+    use crate::pg_test_client;
 
     #[test_case(18446744073709551615; "u64 max")]
     #[test_case(800000000000; "with trailing zeros")]

components/chainhook-postgres/src/types/pg_smallint_u8.rs

@@ -39,9 +39,8 @@ impl<'a> FromSql<'a> for PgSmallIntU8 {
 mod test {
     use test_case::test_case;
 
-    use crate::pg_test_client;
-
     use super::PgSmallIntU8;
+    use crate::pg_test_client;
 
     #[test_case(255; "u8 max")]
     #[test_case(0; "zero")]

components/chainhook-postgres/src/utils.rs

@@ -4,7 +4,7 @@ pub fn multi_row_query_param_str(rows: usize, columns: usize) -> String {
     let mut arg_num = 1;
     let mut arg_str = String::new();
     for _ in 0..rows {
-        arg_str.push_str("(");
+        arg_str.push('(');
         for i in 0..columns {
             arg_str.push_str(format!("${},", arg_num + i).as_str());
         }

components/chainhook-sdk/src/indexer/bitcoin/mod.rs

@@ -1,22 +1,22 @@
 use std::time::Duration;
 
-use crate::try_debug;
-use crate::utils::Context;
-use bitcoincore_rpc::bitcoin::hashes::Hash;
-use bitcoincore_rpc::bitcoin::{self, Amount, BlockHash};
-use bitcoincore_rpc::jsonrpc::error::RpcError;
+use bitcoincore_rpc::{
+    bitcoin::{self, hashes::Hash, Amount, BlockHash},
+    jsonrpc::error::RpcError,
+};
 use bitcoincore_rpc_json::GetRawTransactionResultVoutScriptPubKey;
-use chainhook_types::bitcoin::{OutPoint, TxIn, TxOut};
 use chainhook_types::{
-    BitcoinBlockData, BitcoinBlockMetadata, BitcoinNetwork, 
-    BitcoinTransactionData,BitcoinTransactionMetadata, BlockHeader, BlockIdentifier, 
-    TransactionIdentifier,
+    bitcoin::{OutPoint, TxIn, TxOut},
+    BitcoinBlockData, BitcoinBlockMetadata, BitcoinNetwork, BitcoinTransactionData,
+    BitcoinTransactionMetadata, BlockHeader, BlockIdentifier, TransactionIdentifier,
 };
 use config::BitcoindConfig;
 use hiro_system_kit::slog;
 use reqwest::Client as HttpClient;
 use serde::Deserialize;
 
+use crate::{try_debug, utils::Context};
+
 #[derive(Clone, PartialEq, Debug, Deserialize, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct BitcoinBlockFullBreakdown {
@@ -213,7 +213,10 @@
     });
     let block_hash = http_client
         .post(&bitcoin_config.rpc_url)
-        .basic_auth(&bitcoin_config.rpc_username, Some(&bitcoin_config.rpc_password))
+        .basic_auth(
+            &bitcoin_config.rpc_username,
+            Some(&bitcoin_config.rpc_password),
+        )
         .header("Content-Type", "application/json")
         .header("Host", &bitcoin_config.rpc_url[7..])
         .json(&body)
@@ -283,7 +286,10 @@
     });
     let res = http_client
         .post(&bitcoin_config.rpc_url)
-        .basic_auth(&bitcoin_config.rpc_username, Some(&bitcoin_config.rpc_password))
+        .basic_auth(
+            &bitcoin_config.rpc_username,
+            Some(&bitcoin_config.rpc_password),
+        )
         .header("Content-Type", "application/json")
         .header("Host", &bitcoin_config.rpc_url[7..])
         .json(&body)
@@ -344,7 +350,12 @@
     let mut transactions = vec![];
     let block_height = block.height as u64;
 
-    try_debug!(ctx, "Standardizing Bitcoin block #{} {}", block.height, block.hash);
+    try_debug!(
+        ctx,
+        "Standardizing Bitcoin block #{} {}",
+        block.height,
+        block.hash
+    );
 
     for (tx_index, mut tx) in block.tx.into_iter().enumerate() {
         let txid = tx.txid.to_string();

components/chainhook-sdk/src/indexer/fork_scratch_pad.rs

@@ -1,14 +1,16 @@
-use crate::{
-    indexer::{ChainSegment, ChainSegmentIncompatibility},
-    try_error, try_info, try_warn,
-    utils::Context,
-};
+use std::collections::{BTreeMap, BTreeSet, HashSet};
+
 use chainhook_types::{
     BlockHeader, BlockIdentifier, BlockchainEvent, BlockchainUpdatedWithHeaders,
     BlockchainUpdatedWithReorg,
 };
 use hiro_system_kit::slog;
-use std::collections::{BTreeMap, BTreeSet, HashSet};
+
+use crate::{
+    indexer::{ChainSegment, ChainSegmentIncompatibility},
+    try_error, try_info, try_warn,
+    utils::Context,
+};
 
 pub struct ForkScratchPad {
     canonical_fork_id: usize,

components/chainhook-sdk/src/indexer/mod.rs

@@ -1,15 +1,14 @@
 pub mod bitcoin;
 pub mod fork_scratch_pad;
 
-use crate::utils::{AbstractBlock, Context};
+use std::collections::VecDeque;
 
 use chainhook_types::{BlockHeader, BlockIdentifier, BlockchainEvent};
 use config::BitcoindConfig;
 use hiro_system_kit::slog;
 
-use std::collections::VecDeque;
-
 use self::fork_scratch_pad::ForkScratchPad;
+use crate::utils::{AbstractBlock, Context};
 
 #[derive(Deserialize, Debug, Clone, Default)]
 pub struct AssetClassCache {

components/chainhook-sdk/src/indexer/tests/helpers/bitcoin_shapes.rs

@@ -1,10 +1,9 @@
-use crate::utils::Context;
-
-use super::super::BlockchainEventExpectation;
-use super::bitcoin_blocks;
 use chainhook_types::{BitcoinBlockData, BlockchainEvent};
 use hiro_system_kit::slog;
 
+use super::{super::BlockchainEventExpectation, bitcoin_blocks};
+use crate::utils::Context;
+
 pub fn expect_no_chain_update() -> BlockchainEventExpectation {
     Box::new(move |chain_event_to_check: Option<BlockchainEvent>| {
         assert!(

components/chainhook-sdk/src/indexer/tests/helpers/transactions.rs

@@ -1,7 +1,8 @@
 use base58::FromBase58;
-use bitcoincore_rpc::bitcoin::blockdata::opcodes;
-use bitcoincore_rpc::bitcoin::blockdata::script::Builder as BitcoinScriptBuilder;
-use chainhook_types::{bitcoin::TxOut, BitcoinTransactionData, BitcoinTransactionMetadata, TransactionIdentifier};
+use bitcoincore_rpc::bitcoin::blockdata::{opcodes, script::Builder as BitcoinScriptBuilder};
+use chainhook_types::{
+    bitcoin::TxOut, BitcoinTransactionData, BitcoinTransactionMetadata, TransactionIdentifier,
+};
 
 pub fn generate_test_tx_bitcoin_p2pkh_transfer(
     txid: u64,