btc-shared

BTC Shared Implementation Rules

Overview

Rules for modifying files in internal/infrastructure/api/btc/btc/ directory. This directory contains the shared BTC implementation used by both BTC and BCH.

Critical Rule

🚨 DO NOT Modify for BCH-Specific Issues

Files in this directory (internal/infrastructure/api/btc/btc/) are shared code that must remain pure BTC implementation.

If BCH behavior is incorrect, you MUST fix it by overriding the method in internal/infrastructure/api/btc/bch/ directory.

❌ FORBIDDEN: Modifying btc/btc/ for BCH issues
✅ REQUIRED:  Override in btc/bch/ directory

Architecture

internal/infrastructure/api/btc/
├── btc/                      # ← THIS DIRECTORY (Shared BTC implementation)
│   ├── bitcoin.go            # Bitcoin struct - DO NOT add BCH conditionals
│   ├── account.go
│   ├── address.go
│   └── ...
├── bch/                      # BCH overrides (ADD BCH-specific code here)
│   ├── bitcoin_cash.go       # BitcoinCash embeds Bitcoin
│   ├── account.go            # Override: GetAccount
│   ├── address.go            # Override: GetAddressInfo
│   └── ...
└── connection.go             # Shared connection logic

Why This Pattern?

Reason	Explanation
Separation of Concerns	BTC code remains pure and focused
Maintainability	BCH changes don't affect BTC behavior
Clarity	BCH differences are explicit in BCH directory
Safety	Prevents accidental BCH breakage when modifying BTC

How BCH Override Works

BCH uses Go's struct embedding pattern:

// internal/infrastructure/api/btc/bch/bitcoin_cash.go
type BitcoinCash struct {
    apibtcimpl.Bitcoin  // Embeds BTC implementation
}

When BitcoinCash defines a method with the same signature as Bitcoin, it overrides the embedded method.

Prohibited Patterns

❌ NEVER: Add BCH Conditionals

// internal/infrastructure/api/btc/btc/account.go
func (b *Bitcoin) GetAccount(addr string) (string, error) {
    if b.coinTypeCode == domainCoin.BCH {  // ❌ NEVER DO THIS
        // BCH-specific logic
    }
    // BTC logic
}