Litecoin and Bitcoin Cash support #19

pragmaxim · 2025-11-18T08:59:55Z

Adding support for LTC and BCH

Note that current BCH version fails on processing blocks since MWEB activation which would require patching the litcoin crate. It fails right at the start because chain indexer processes the tip block header.

Copilot

Pull Request Overview

This PR adds support for Litecoin (LTC) and Bitcoin Cash (BCH) blockchain indexing to the codebase. Both implementations closely mirror the existing Bitcoin chain implementation structure. Note that the PR description indicates the BCH version fails on processing blocks since MWEB activation, which requires patching the litcoin crate.

Key Changes

Complete Litecoin chain implementation with REST API client, block processing, address codec support (Base58Check and Bech32), and configuration
Complete Bitcoin Cash chain implementation with HTTP/RPC client, block processing, legacy address support, and configuration
CI integration for testing and benchmarking both new chains

Reviewed Changes

Copilot reviewed 28 out of 32 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
chains/ltc/src/rest_client.rs	REST client for fetching blocks from Litecoin node
chains/ltc/src/model_v1.rs	Data model definitions for LTC blockchain entities
chains/ltc/src/main.rs	Entry point for LTC chain indexer
chains/ltc/src/lib.rs	Library setup with error types and config
chains/ltc/src/hook.rs	Transaction input processing hooks
chains/ltc/src/codec.rs	Address encoding/decoding for Litecoin addresses
chains/ltc/src/block_provider.rs	Block processing and parsing logic
chains/ltc/config/*.toml	Configuration files for LTC node and indexer
chains/ltc/Cargo.toml	Dependencies for Litecoin implementation
chains/ltc/benches/ltc_benchmark.rs	Performance benchmarks
chains/ltc/README.md	Setup and usage documentation
chains/bch/src/http_client.rs	HTTP/RPC client for fetching blocks from BCH node
chains/bch/src/model_v1.rs	Data model definitions for BCH blockchain entities
chains/bch/src/main.rs	Entry point for BCH chain indexer
chains/bch/src/lib.rs	Library setup with error types and config
chains/bch/src/hook.rs	Transaction input processing hooks
chains/bch/src/codec.rs	Address encoding/decoding for BCH legacy addresses
chains/bch/src/block_provider.rs	Block processing and parsing logic
chains/bch/config/*.toml	Configuration files for BCH node and indexer
chains/bch/Cargo.toml	Dependencies for Bitcoin Cash implementation
chains/bch/benches/bch_benchmark.rs	Performance benchmarks
chains/bch/README.md	Setup and usage documentation
Cargo.toml	Added ltc and bch to workspace members
.github/workflows/redbit.yml	Added CI test and bench jobs for both chains

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-18T09:04:42Z

chains/ltc/config/settings.toml

+name = "ltc"
+db_path = "/opt/.chain"
+enable = true
+node_sync_interval_s = 1          # 0 means only chatching up but no periodic sync


Typo: "chatching" should be "catching"

Suggested change

node_sync_interval_s = 1 # 0 means only chatching up but no periodic sync

node_sync_interval_s = 1 # 0 means only catching up but no periodic sync

Copilot · 2025-11-18T09:04:42Z

chains/bch/config/settings.toml

+name = "bch"
+db_path = "/opt/.chain"
+enable = true
+node_sync_interval_s = 1          # 0 means only chatching up but no periodic sync


Typo: "chatching" should be "catching"

Suggested change

node_sync_interval_s = 1 # 0 means only chatching up but no periodic sync

node_sync_interval_s = 1 # 0 means only catching up but no periodic sync

Copilot · 2025-11-18T09:04:43Z

chains/bch/config/settings.toml

+fork_detection_heights = 100      # max 255, how many blocks from tip to check for forks
+db_cache_size_gb = "mild"         # off / tiny / low / mild / high / ultra
+min_entity_batch_size = 1_000_000 # Sum of : inputs + outputs
+max_entity_buffer_kb_size = 8192  # total size of fetched blocks in MB to buffer


Inconsistent units in comment: The comment states "total size of fetched blocks in MB to buffer" but the field name is max_entity_buffer_kb_size (KB). Either the comment should say "KB" or the field should be renamed to use MB units.

Suggested change

max_entity_buffer_kb_size = 8192 # total size of fetched blocks in MB to buffer

max_entity_buffer_kb_size = 8192 # total size of fetched blocks in KB to buffer

Copilot · 2025-11-18T09:04:43Z

chains/ltc/src/hook.rs

+            let id = TransactionPointer::from_parent(*id_pointer, *id_index as u16);
+            let utxo_pointer = match tx_pointer_buf_opt {
+                Some(tx_pointer_buf) => TransactionPointer::from_parent(tx_pointer_buf.as_value(), input_ref.index),
+                // coinbase marker, actually u32::MAX, but we store btc input index as u16 as it never exceeds that in by size limits


Comment contains "btc" instead of "ltc": The comment says "we store btc input index as u16" but this is the Litecoin implementation. Update to "litecoin" or "ltc" for consistency.

Suggested change

// coinbase marker, actually u32::MAX, but we store btc input index as u16 as it never exceeds that in by size limits

// coinbase marker, actually u32::MAX, but we store ltc input index as u16 as it never exceeds that by size limits

Copilot · 2025-11-18T09:04:43Z

chains/ltc/src/codec.rs

+
+pub const TAG_SEGWIT: u8 = 0xB0;
+pub const TAG_OP_RETURN: u8 = 0xF0;


Magic numbers should be documented: The constants TAG_SEGWIT (0xB0), TAG_OP_RETURN (0xF0), and TAG_NON_ADDR (0xFF) are defined but would benefit from inline documentation explaining their purpose and why these specific values were chosen.

Suggested change

pub const TAG_SEGWIT: u8 = 0xB0;

pub const TAG_OP_RETURN: u8 = 0xF0;

/// Tag for SegWit (Bech32) addresses. 0xB0 is chosen to distinguish SegWit payloads from legacy types.

pub const TAG_SEGWIT: u8 = 0xB0;

/// Tag for OP_RETURN outputs. 0xF0 is used to mark data-carrying outputs (not spendable addresses).

pub const TAG_OP_RETURN: u8 = 0xF0;

/// Tag for non-address payloads. 0xFF is reserved to indicate an invalid or non-address type.

Copilot · 2025-11-18T09:04:45Z

chains/bch/README.md

+export BITCOINCASH__rpc_user = "foo"
+export BITCOINCASH__rpc_password = "bar"


Invalid environment variable syntax: Remove spaces around the = sign. The correct syntax should be export BITCOINCASH__rpc_user="foo" (no spaces).

Suggested change

export BITCOINCASH__rpc_user = "foo"

export BITCOINCASH__rpc_password = "bar"

export BITCOINCASH__rpc_user="foo"

export BITCOINCASH__rpc_password="bar"

Copilot · 2025-11-18T09:04:45Z

chains/ltc/config/settings.toml

+fork_detection_heights = 100      # max 255, how many blocks from tip to check for forks
+db_cache_size_gb = "mild"         # off / tiny / low / mild / high / ultra
+min_entity_batch_size = 1_000_000 # Sum of : inputs + outputs
+max_entity_buffer_kb_size = 8192  # total size of fetched blocks in MB to buffer


Inconsistent units in comment: The comment states "total size of fetched blocks in MB to buffer" but the field name is max_entity_buffer_kb_size (KB). Either the comment should say "KB" or the field should be renamed to use MB units.

Suggested change

max_entity_buffer_kb_size = 8192 # total size of fetched blocks in MB to buffer

max_entity_buffer_kb_size = 8192 # total size of fetched blocks in KB to buffer

Copilot · 2025-11-18T09:04:45Z

chains/ltc/src/codec.rs

+    let ver = src[1];
+    let prog = &src[2..];
+    if prog.len() != 20 && prog.len() != 32 {
+        return Err(serde::ser::Error::custom("invalid segwit program length"));


Error message could be more helpful: "invalid segwit program length" doesn't specify what valid lengths are. Consider: "invalid segwit program length (expected 20 or 32 bytes)".

Suggested change

return Err(serde::ser::Error::custom("invalid segwit program length"));

return Err(serde::ser::Error::custom("invalid segwit program length (expected 20 or 32 bytes)"));

Copilot · 2025-11-18T09:04:46Z

chains/ltc/src/codec.rs

+                .map_err(|e| serde::de::Error::custom(format!("Bech32 parse failed: {e}")))?;
+            let _ = hrp; // HRP not stored in index bytes
+            if prog.len() != 20 && prog.len() != 32 {
+                return Err(serde::de::Error::custom("invalid segwit program length"));


Error message could be more helpful: "invalid segwit program length" doesn't specify what valid lengths are. Consider: "invalid segwit program length (expected 20 or 32 bytes)".

Suggested change

return Err(serde::de::Error::custom("invalid segwit program length"));

return Err(serde::de::Error::custom("invalid segwit program length (expected 20 or 32 bytes)"));

Copilot · 2025-11-18T09:04:46Z

chains/bch/config/bch.toml

+rpc_user = "" # change this either in .env file or export is as env var
+rpc_password = ""


Security concern: The configuration file contains empty RPC credentials with an instruction to change them, but this could lead to accidental deployment with empty credentials. Consider either providing secure placeholder values or making these required fields that fail on startup if empty.

Suggested change

rpc_user = "" # change this either in .env file or export is as env var

rpc_password = ""

rpc_user = "CHANGEME_USER" # MUST change this in .env file or export as env var before deployment

rpc_password = "CHANGEME_PASSWORD" # MUST change this in .env file or export as env var before deployment

pragmaxim added 7 commits November 17, 2025 13:33

ltc spike

e6498c4

ltc benches

3e0592c

bch

c460afe

change http port for bch

8298277

bch settings

94c22f3

ltc and bch readme and fixes

d66e0ab

ltc fails on blocks since MWEB activation

71ce325

pragmaxim requested a review from Copilot November 18, 2025 09:00

Copilot started reviewing on behalf of pragmaxim November 18, 2025 09:00 View session

Copilot finished reviewing on behalf of pragmaxim November 18, 2025 09:03

Copilot AI reviewed Nov 18, 2025

View reviewed changes

addressing PR comments [skip ci]

1c57b80

pragmaxim merged commit 46cb380 into master Nov 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Litecoin and Bitcoin Cash support #19

Litecoin and Bitcoin Cash support #19

Uh oh!

pragmaxim commented Nov 18, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	node_sync_interval_s = 1 # 0 means only chatching up but no periodic sync
	node_sync_interval_s = 1 # 0 means only catching up but no periodic sync

	max_entity_buffer_kb_size = 8192 # total size of fetched blocks in MB to buffer
	max_entity_buffer_kb_size = 8192 # total size of fetched blocks in KB to buffer

	// coinbase marker, actually u32::MAX, but we store btc input index as u16 as it never exceeds that in by size limits
	// coinbase marker, actually u32::MAX, but we store ltc input index as u16 as it never exceeds that by size limits


		pub const TAG_SEGWIT: u8 = 0xB0;
		pub const TAG_OP_RETURN: u8 = 0xF0;

		export BITCOINCASH__rpc_user = "foo"
		export BITCOINCASH__rpc_password = "bar"

	return Err(serde::ser::Error::custom("invalid segwit program length"));
	return Err(serde::ser::Error::custom("invalid segwit program length (expected 20 or 32 bytes)"));

	return Err(serde::de::Error::custom("invalid segwit program length"));
	return Err(serde::de::Error::custom("invalid segwit program length (expected 20 or 32 bytes)"));

		rpc_user = "" # change this either in .env file or export is as env var
		rpc_password = "" No newline at end of file

Litecoin and Bitcoin Cash support #19

Litecoin and Bitcoin Cash support #19

Uh oh!

Conversation

pragmaxim commented Nov 18, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant