bsv-wallet 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1c9a3b59c2d83b14456fcdc7e4eb9f26ad8a5cd4094bc1dd192b26e69903d2b
-  data.tar.gz: 3fa4584de7d5f3ce782468aa9243ffc80ddc7106b1da6ed11b7d0a97250c2a29
+  metadata.gz: aeb3dc8d2b6c485d81d28e540b432688b65b370be001f545d7fbe0e2adbff34d
+  data.tar.gz: 9f9ce64fe90d7d386c1823c4e698ee268e913870a8192135794d8d6f0ddd7643
 SHA512:
-  metadata.gz: 500bec40cbe5fbf13f325e975522ec467a87d8ddef268a88cc6f4f35f429d75d27b1fd7adbd0f085668d21c79ddef1a19270b5502296e4dcc35fa74031f27b0f
-  data.tar.gz: b0dd2838de3f000c5dadd73cb9ce3b6e5575e7c224a4397dbdb0ce2cfd73afdd2cb0366e6805faa035a3375560d3fe2b5ede49a82ae77e494957eb9549cd7727
+  metadata.gz: 8c49d1e84cc279ce6ec065bcf914d83d16590ded06601459979d0e2cd8084b95d678121fa8c4c36f27c68243ee2337b88857f77d1e09a79f3153e5800a76d54d
+  data.tar.gz: 83c9ae27c5ca5b09731d81e9aedbc3c981310675f6d2052a229c2da8215b7e13e95e5a8f72c39418ec20f42e4a95478459394f051c3ab32b99578066ccf0504e

data/lib/bsv/wallet_interface/file_store.rb

@@ -72,8 +72,26 @@ module BSV
         result
       end
 
+      def store_proof(txid, bump_hex)
+        super
+        save_proofs
+      end
+
+      def store_transaction(txid, tx_hex)
+        super
+        save_transactions
+      end
+
       private
 
+      def proofs_path
+        File.join(@dir, 'proofs.json')
+      end
+
+      def transactions_path
+        File.join(@dir, 'transactions.json')
+      end
+
       def check_permissions
         dir_mode = File.stat(@dir).mode & 0o777
         if dir_mode != 0o700
@@ -81,7 +99,7 @@ module BSV
                        'Other users may be able to access wallet data.')
         end
 
-        [actions_path, outputs_path, certificates_path].each do |path|
+        [actions_path, outputs_path, certificates_path, proofs_path, transactions_path].each do |path|
           next unless File.exist?(path)
 
           file_mode = File.stat(path).mode & 0o777
@@ -108,6 +126,8 @@ module BSV
         @actions = load_file(actions_path)
         @outputs = load_file(outputs_path)
         @certificates = load_file(certificates_path)
+        @proofs = load_proofs_file
+        @transactions = load_transactions_file
       end
 
       def load_file(path)
@@ -134,6 +154,38 @@ module BSV
         write_file(certificates_path, @certificates)
       end
 
+      def save_proofs
+        json = JSON.pretty_generate(@proofs)
+        tmp = "#{proofs_path}.tmp"
+        File.open(tmp, File::WRONLY | File::CREAT | File::TRUNC, 0o600) { |f| f.write(json) }
+        File.rename(tmp, proofs_path)
+      end
+
+      def load_proofs_file
+        return {} unless File.exist?(proofs_path)
+
+        data = JSON.parse(File.read(proofs_path))
+        data.is_a?(Hash) ? data : {}
+      rescue JSON::ParserError
+        {}
+      end
+
+      def save_transactions
+        json = JSON.pretty_generate(@transactions)
+        tmp = "#{transactions_path}.tmp"
+        File.open(tmp, File::WRONLY | File::CREAT | File::TRUNC, 0o600) { |f| f.write(json) }
+        File.rename(tmp, transactions_path)
+      end
+
+      def load_transactions_file
+        return {} unless File.exist?(transactions_path)
+
+        data = JSON.parse(File.read(transactions_path))
+        data.is_a?(Hash) ? data : {}
+      rescue JSON::ParserError
+        {}
+      end
+
       def write_file(path, data)
         json = JSON.pretty_generate(stringify_keys_deep(data))
         tmp = "#{path}.tmp"

data/lib/bsv/wallet_interface/local_proof_store.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module BSV
+  module Wallet
+    # Default proof store — persists serialised merkle proofs via a
+    # {StorageAdapter}. Requires no external services.
+    #
+    # @example Using the default local proof store
+    #   store   = BSV::Wallet::MemoryStore.new
+    #   proofs  = BSV::Wallet::LocalProofStore.new(store)
+    #   proofs.store_proof(txid_hex, merkle_path)
+    #   proof   = proofs.resolve_proof(txid_hex)
+    class LocalProofStore
+      include ProofStore
+
+      # @param storage [StorageAdapter] the underlying persistence adapter
+      def initialize(storage)
+        @storage = storage
+      end
+
+      # Serialise and store a merkle proof.
+      #
+      # @param txid [String] hex transaction ID
+      # @param merkle_path [BSV::Transaction::MerklePath] the proof to store
+      # @return [void]
+      def store_proof(txid, merkle_path)
+        @storage.store_proof(txid, merkle_path.to_hex)
+      end
+
+      # Resolve and deserialise a merkle proof.
+      #
+      # @param txid [String] hex transaction ID
+      # @return [BSV::Transaction::MerklePath, nil] the proof, or nil if unknown
+      def resolve_proof(txid)
+        bump_hex = @storage.find_proof(txid)
+        return unless bump_hex
+
+        BSV::Transaction::MerklePath.from_hex(bump_hex)
+      end
+    end
+  end
+end

data/lib/bsv/wallet_interface/memory_store.rb

@@ -13,6 +13,8 @@ module BSV
         @actions = []
         @outputs = []
         @certificates = []
+        @proofs = {}
+        @transactions = {}
       end
 
       def store_action(action_data)
@@ -62,6 +64,22 @@ module BSV
         filter_certificates(query).length
       end
 
+      def store_proof(txid, bump_hex)
+        @proofs[txid] = bump_hex
+      end
+
+      def find_proof(txid)
+        @proofs[txid]
+      end
+
+      def store_transaction(txid, tx_hex)
+        @transactions[txid] = tx_hex
+      end
+
+      def find_transaction(txid)
+        @transactions[txid]
+      end
+
       def delete_certificate(type:, serial_number:, certifier:)
         idx = @certificates.index do |c|
           c[:type] == type && c[:serial_number] == serial_number && c[:certifier] == certifier

data/lib/bsv/wallet_interface/proof_store.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module BSV
+  module Wallet
+    # Duck-typed interface for merkle proof persistence.
+    #
+    # Include this module in proof store implementations and override all
+    # methods. The default implementations raise NotImplementedError.
+    #
+    # Two implementations ship with the SDK:
+    # - {LocalProofStore} — persists proofs via a {StorageAdapter} (default)
+    # - Future: ChaintracksProofStore — resolves proofs from an external service
+    module ProofStore
+      # Store a merkle proof for a transaction.
+      #
+      # @param _txid [String] hex transaction ID
+      # @param _merkle_path [BSV::Transaction::MerklePath] the proof to store
+      # @return [void]
+      def store_proof(_txid, _merkle_path)
+        raise NotImplementedError, "#{self.class}#store_proof not implemented"
+      end
+
+      # Resolve a merkle proof for a transaction.
+      #
+      # @param _txid [String] hex transaction ID
+      # @return [BSV::Transaction::MerklePath, nil] the proof, or nil if unknown
+      def resolve_proof(_txid)
+        raise NotImplementedError, "#{self.class}#resolve_proof not implemented"
+      end
+    end
+  end
+end

data/lib/bsv/wallet_interface/storage_adapter.rb

@@ -50,6 +50,22 @@ module BSV
       def count_certificates(_query)
         raise NotImplementedError, "#{self.class}#count_certificates not implemented"
       end
+
+      def store_proof(_txid, _bump_hex)
+        raise NotImplementedError, "#{self.class}#store_proof not implemented"
+      end
+
+      def find_proof(_txid)
+        raise NotImplementedError, "#{self.class}#find_proof not implemented"
+      end
+
+      def store_transaction(_txid, _tx_hex)
+        raise NotImplementedError, "#{self.class}#store_transaction not implemented"
+      end
+
+      def find_transaction(_txid)
+        raise NotImplementedError, "#{self.class}#find_transaction not implemented"
+      end
     end
   end
 end

data/lib/bsv/wallet_interface/version.rb

@@ -2,6 +2,6 @@
 
 module BSV
   module WalletInterface
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/lib/bsv/wallet_interface/wallet_client.rb

@@ -35,17 +35,22 @@ module BSV
       # @return [String] the network ('mainnet' or 'testnet')
       attr_reader :network
 
+      # @return [ProofStore] the merkle proof persistence store
+      attr_reader :proof_store
+
       # @param key [BSV::Primitives::PrivateKey, String, KeyDeriver] signing key
       # @param storage [StorageAdapter] persistence adapter (default: FileStore).
       #   Use +storage: MemoryStore.new+ for tests.
       # @param network [String] 'mainnet' (default) or 'testnet'
       # @param chain_provider [ChainProvider] blockchain data provider (default: NullChainProvider)
+      # @param proof_store [ProofStore, nil] merkle proof store (default: LocalProofStore backed by storage)
       # @param http_client [#request, nil] injectable HTTP client for certificate issuance
-      def initialize(key, storage: FileStore.new, network: 'mainnet', chain_provider: NullChainProvider.new, http_client: nil)
+      def initialize(key, storage: FileStore.new, network: 'mainnet', chain_provider: NullChainProvider.new, proof_store: nil, http_client: nil)
         super(key)
         @storage = storage
         @network = network
         @chain_provider = chain_provider
+        @proof_store = proof_store || LocalProofStore.new(storage)
         @http_client = http_client
         @pending = {}
       end
@@ -177,6 +182,7 @@ module BSV
         beef = BSV::Transaction::Beef.from_binary(beef_binary)
         tx = extract_subject_transaction(beef)
 
+        store_proofs_from_beef(beef)
         process_internalize_outputs(tx, args[:outputs])
         store_action(tx, args, status: 'completed')
         { accepted: true }
@@ -523,7 +529,32 @@ module BSV
 
         return unless stored[:source_tx_hex]
 
-        input.source_transaction = BSV::Transaction::Transaction.from_hex(stored[:source_tx_hex])
+        source_tx = BSV::Transaction::Transaction.from_hex(stored[:source_tx_hex])
+        txid_hex = outpoint.split('.').first
+        proof = @proof_store.resolve_proof(txid_hex)
+        source_tx.merkle_path = proof if proof
+
+        # Recursively wire ancestors of the source tx so to_beef can build a
+        # complete, valid BEEF with the full proof chain.
+        wire_source_tx_ancestors(source_tx) unless source_tx.merkle_path
+
+        input.source_transaction = source_tx
+      end
+
+      def wire_source_tx_ancestors(tx)
+        tx.inputs.each do |inp|
+          next if inp.source_transaction
+
+          ancestor_txid_hex = inp.prev_tx_id.reverse.unpack1('H*')
+          tx_hex = @storage.find_transaction(ancestor_txid_hex)
+          next unless tx_hex
+
+          ancestor_tx = BSV::Transaction::Transaction.from_hex(tx_hex)
+          proof = @proof_store.resolve_proof(ancestor_txid_hex)
+          ancestor_tx.merkle_path = proof if proof
+          wire_source_tx_ancestors(ancestor_tx) unless ancestor_tx.merkle_path
+          inp.source_transaction = ancestor_tx
+        end
       end
 
       def build_outputs(tx, outputs)
@@ -651,6 +682,16 @@ module BSV
 
       # --- Internalize helpers ---
 
+      def store_proofs_from_beef(beef)
+        beef.transactions.each do |beef_tx|
+          next unless beef_tx.transaction&.merkle_path
+
+          txid_hex = beef_tx.transaction.txid_hex
+          @proof_store.store_proof(txid_hex, beef_tx.transaction.merkle_path)
+          @storage.store_transaction(txid_hex, beef_tx.transaction.to_hex)
+        end
+      end
+
       def extract_subject_transaction(beef)
         return find_by_subject_txid(beef) if beef.subject_txid
 

data/lib/bsv/wallet_interface.rb

@@ -14,6 +14,8 @@ module BSV
     autoload :StorageAdapter,    'bsv/wallet_interface/storage_adapter'
     autoload :MemoryStore,       'bsv/wallet_interface/memory_store'
     autoload :FileStore,         'bsv/wallet_interface/file_store'
+    autoload :ProofStore,        'bsv/wallet_interface/proof_store'
+    autoload :LocalProofStore,   'bsv/wallet_interface/local_proof_store'
     autoload :ChainProvider,     'bsv/wallet_interface/chain_provider'
     autoload :NullChainProvider, 'bsv/wallet_interface/null_chain_provider'
     autoload :WalletClient,      'bsv/wallet_interface/wallet_client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bsv-wallet
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Simon Bettison
@@ -55,8 +55,10 @@ files:
 - lib/bsv/wallet_interface/file_store.rb
 - lib/bsv/wallet_interface/interface.rb
 - lib/bsv/wallet_interface/key_deriver.rb
+- lib/bsv/wallet_interface/local_proof_store.rb
 - lib/bsv/wallet_interface/memory_store.rb
 - lib/bsv/wallet_interface/null_chain_provider.rb
+- lib/bsv/wallet_interface/proof_store.rb
 - lib/bsv/wallet_interface/proto_wallet.rb
 - lib/bsv/wallet_interface/storage_adapter.rb
 - lib/bsv/wallet_interface/validators.rb