bsv-wallet 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b8425ff5a48801f390149006396bac80983a36231e101ff9e96255b4c702f68
-  data.tar.gz: 5df7b47ab142634281a76a68de73cd30562a31c4864cddb1ebf5cfe332e60ac0
+  metadata.gz: 640f3d2d34c8ef7a9acbaa3680904bae8507d091b251213fcb1fd7d3dd4e1796
+  data.tar.gz: f0fdf19e4128bace6be1dd7a09c0c9bf0c63a5a9bb4699e1c3736b8263d5ffc1
 SHA512:
-  metadata.gz: 7a8faf79916348e238b86b1006a78cf16ce4bcc0317170c7bd0ba80a2627615a129b6b2a694af884a2492379a29f354994581cd74e54adc62cd6138103906094
-  data.tar.gz: 9f3f53a96072ed5dd27d46265a54558b3bd8073811d7532458276d4d287f59c5b77714017d024f970b95686f7fca8c1f5fc0891ba32e493cb671287ac84ff74c
+  metadata.gz: e46a2a8781c325707ec1bfa6de79bb7f1c84ea8a5b904237ad1080d9cf2d22a3ac80d31111304bd9ed3138bd9418ba0efe2d77f0c0554476a011ef7308f68ccb
+  data.tar.gz: a238543de60ded0e911eb564c34fb47f4b5367c0570fd4d0fabefa02327caa2141ff9ba6d09308e6478692541446ae367934d095d321421c7ae13e02ac48fd39

data/lib/bsv/wallet_interface/file_store.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+require 'logger'
+
+module BSV
+  module Wallet
+    # JSON file-backed storage adapter.
+    #
+    # Persists actions, outputs, and certificates as JSON files in a
+    # configurable directory (default: +~/.bsv-wallet/+). Data survives
+    # process restarts.
+    #
+    # Inherits all filtering and pagination logic from {MemoryStore} and
+    # adds load-on-init / save-on-mutation.
+    #
+    # @example Default location
+    #   store = BSV::Wallet::FileStore.new
+    #   # Data written to ~/.bsv-wallet/
+    #
+    # @example Custom directory
+    #   store = BSV::Wallet::FileStore.new(dir: '/var/lib/my-app/wallet')
+    class FileStore < MemoryStore
+      DEFAULT_DIR = File.expand_path('~/.bsv-wallet')
+
+      # @param dir [String] directory for JSON files
+      #   (default: +~/.bsv-wallet/+ or +BSV_WALLET_DIR+ env var)
+      # @param dir [String] directory for JSON files
+      # @param logger [Logger, nil] logger for permission warnings (default: Logger to STDERR)
+      def initialize(dir: nil, logger: nil)
+        super()
+        @dir = dir || ENV.fetch('BSV_WALLET_DIR', DEFAULT_DIR)
+        @logger = logger || Logger.new($stderr, progname: 'bsv-wallet')
+        FileUtils.mkdir_p(@dir, mode: 0o700)
+        check_permissions
+        load_from_disk
+      end
+
+      # @return [String] the storage directory path
+      attr_reader :dir
+
+      # --- Mutations: delegate to super, then persist ---
+
+      def store_action(action_data)
+        result = super
+        save_actions
+        result
+      end
+
+      def store_output(output_data)
+        result = super
+        save_outputs
+        result
+      end
+
+      def delete_output(outpoint)
+        result = super
+        save_outputs if result
+        result
+      end
+
+      def store_certificate(cert_data)
+        result = super
+        save_certificates
+        result
+      end
+
+      def delete_certificate(type:, serial_number:, certifier:)
+        result = super
+        save_certificates if result
+        result
+      end
+
+      private
+
+      def check_permissions
+        dir_mode = File.stat(@dir).mode & 0o777
+        if dir_mode != 0o700
+          @logger.warn("Wallet directory #{@dir} has permissions #{format('%04o', dir_mode)} (expected 0700). " \
+                       'Other users may be able to access wallet data.')
+        end
+
+        [actions_path, outputs_path, certificates_path].each do |path|
+          next unless File.exist?(path)
+
+          file_mode = File.stat(path).mode & 0o777
+          next if file_mode == 0o600
+
+          @logger.warn("Wallet file #{path} has permissions #{format('%04o', file_mode)} (expected 0600). " \
+                       'Other users may be able to read wallet data.')
+        end
+      end
+
+      def actions_path
+        File.join(@dir, 'actions.json')
+      end
+
+      def outputs_path
+        File.join(@dir, 'outputs.json')
+      end
+
+      def certificates_path
+        File.join(@dir, 'certificates.json')
+      end
+
+      def load_from_disk
+        @actions = load_file(actions_path)
+        @outputs = load_file(outputs_path)
+        @certificates = load_file(certificates_path)
+      end
+
+      def load_file(path)
+        return [] unless File.exist?(path)
+
+        data = JSON.parse(File.read(path))
+        return [] unless data.is_a?(Array)
+
+        # Symbolise top-level keys for consistency with MemoryStore
+        data.map { |entry| symbolise_keys(entry) }
+      rescue JSON::ParserError
+        []
+      end
+
+      def save_actions
+        write_file(actions_path, @actions)
+      end
+
+      def save_outputs
+        write_file(outputs_path, @outputs)
+      end
+
+      def save_certificates
+        write_file(certificates_path, @certificates)
+      end
+
+      def write_file(path, data)
+        json = JSON.pretty_generate(stringify_keys_deep(data))
+        tmp = "#{path}.tmp"
+        File.open(tmp, File::WRONLY | File::CREAT | File::TRUNC, 0o600) { |f| f.write(json) }
+        File.rename(tmp, path)
+      end
+
+      def symbolise_keys(hash)
+        return hash unless hash.is_a?(Hash)
+
+        hash.each_with_object({}) do |(k, v), result|
+          result[k.to_sym] = case v
+                             when Hash then symbolise_keys(v)
+                             when Array then v.map { |e| e.is_a?(Hash) ? symbolise_keys(e) : e }
+                             else v
+                             end
+        end
+      end
+
+      def stringify_keys_deep(obj)
+        case obj
+        when Hash
+          obj.each_with_object({}) do |(k, v), result|
+            result[k.to_s] = stringify_keys_deep(v)
+          end
+        when Array
+          obj.map { |e| stringify_keys_deep(e) }
+        else
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/bsv/wallet_interface/memory_store.rb

@@ -91,6 +91,7 @@ module BSV
 
       def filter_outputs(query)
         results = @outputs
+        results = results.select { |o| o[:outpoint] == query[:outpoint] } if query[:outpoint]
         results = results.select { |o| o[:basket] == query[:basket] } if query[:basket]
         if query[:tags]
           mode = query[:tag_query_mode] || 'any'

data/lib/bsv/wallet_interface/proto_wallet.rb

@@ -45,7 +45,7 @@ module BSV
       # @option args [Boolean] :for_self derive from own identity
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] { public_key: String } hex-encoded compressed public key
-      def get_public_key(args, _originator: nil)
+      def get_public_key(args, originator: nil)
         if args[:identity_key]
           { public_key: @key_deriver.identity_key }
         else
@@ -69,7 +69,7 @@ module BSV
       # @option args [String] :counterparty public key hex, 'self', or 'anyone'
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] { ciphertext: Array<Integer> }
-      def encrypt(args, _originator: nil)
+      def encrypt(args, originator: nil)
         sym_key = derive_sym_key(args)
         ciphertext = sym_key.encrypt(bytes_to_string(args[:plaintext]))
         { ciphertext: string_to_bytes(ciphertext) }
@@ -84,7 +84,7 @@ module BSV
       # @option args [String] :counterparty public key hex, 'self', or 'anyone'
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] { plaintext: Array<Integer> }
-      def decrypt(args, _originator: nil)
+      def decrypt(args, originator: nil)
         sym_key = derive_sym_key(args)
         plaintext = sym_key.decrypt(bytes_to_string(args[:ciphertext]))
         { plaintext: string_to_bytes(plaintext) }
@@ -99,7 +99,7 @@ module BSV
       # @option args [String] :counterparty public key hex, 'self', or 'anyone'
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] { hmac: Array<Integer> }
-      def create_hmac(args, _originator: nil)
+      def create_hmac(args, originator: nil)
         sym_key = derive_sym_key(args)
         hmac = BSV::Primitives::Digest.hmac_sha256(sym_key.to_bytes, bytes_to_string(args[:data]))
         { hmac: string_to_bytes(hmac) }
@@ -116,7 +116,7 @@ module BSV
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] { valid: true }
       # @raise [InvalidHmacError] if the HMAC does not match
-      def verify_hmac(args, _originator: nil)
+      def verify_hmac(args, originator: nil)
         sym_key = derive_sym_key(args)
         expected = BSV::Primitives::Digest.hmac_sha256(sym_key.to_bytes, bytes_to_string(args[:data]))
         provided = bytes_to_string(args[:hmac])
@@ -140,7 +140,7 @@ module BSV
       # @option args [String] :counterparty public key hex, 'self', or 'anyone'
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] { signature: Array<Integer> } DER-encoded signature as byte array
-      def create_signature(args, _originator: nil)
+      def create_signature(args, originator: nil)
         counterparty = args[:counterparty] || 'self'
         priv_key = @key_deriver.derive_private_key(args[:protocol_id], args[:key_id], counterparty)
 
@@ -170,7 +170,7 @@ module BSV
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] { valid: true }
       # @raise [InvalidSignatureError] if the signature does not verify
-      def verify_signature(args, _originator: nil)
+      def verify_signature(args, originator: nil)
         counterparty = args[:counterparty] || 'self'
         for_self = args[:for_self] || false
 
@@ -208,7 +208,7 @@ module BSV
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] with :prover, :verifier, :counterparty, :revelation_time,
       #   :encrypted_linkage, :encrypted_linkage_proof
-      def reveal_counterparty_key_linkage(args, _originator: nil)
+      def reveal_counterparty_key_linkage(args, originator: nil)
         counterparty = args[:counterparty]
         verifier = args[:verifier]
 
@@ -270,7 +270,7 @@ module BSV
       # @param originator [String, nil] FQDN of the originating application
       # @return [Hash] with :prover, :verifier, :counterparty, :protocol_id, :key_id,
       #   :encrypted_linkage, :encrypted_linkage_proof, :proof_type
-      def reveal_specific_key_linkage(args, _originator: nil)
+      def reveal_specific_key_linkage(args, originator: nil)
         counterparty = args[:counterparty]
         verifier = args[:verifier]
         protocol_id = args[:protocol_id]

data/lib/bsv/wallet_interface/version.rb

@@ -2,6 +2,6 @@
 
 module BSV
   module WalletInterface
-    VERSION = '0.1.2'
+    VERSION = '0.2.1'
   end
 end

data/lib/bsv/wallet_interface/wallet_client.rb

@@ -36,11 +36,12 @@ module BSV
       attr_reader :network
 
       # @param key [BSV::Primitives::PrivateKey, String, KeyDeriver] signing key
-      # @param storage [StorageAdapter] persistence adapter (default: MemoryStore)
+      # @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 http_client [#request, nil] injectable HTTP client for certificate issuance
-      def initialize(key, storage: MemoryStore.new, network: 'mainnet', chain_provider: NullChainProvider.new, http_client: nil)
+      def initialize(key, storage: FileStore.new, network: 'mainnet', chain_provider: NullChainProvider.new, http_client: nil)
         super(key)
         @storage = storage
         @network = network
@@ -482,8 +483,17 @@ module BSV
           )
 
           wire_source(input, txid_hex, output_index, beef) if beef
-
-          input.unlocking_script = BSV::Script::Script.from_hex(spec[:unlocking_script]) if spec[:unlocking_script]
+          wire_source_from_storage(input, spec[:outpoint]) if input.source_satoshis.nil? || input.source_locking_script.nil?
+
+          case spec[:unlocking_script]
+          when BSV::Transaction::UnlockingScriptTemplate
+            input.unlocking_script_template = spec[:unlocking_script]
+          when String
+            input.unlocking_script = BSV::Script::Script.from_hex(spec[:unlocking_script])
+          when nil then nil
+          else
+            raise InvalidParameterError.new('unlocking_script', 'a hex String or UnlockingScriptTemplate')
+          end
 
           tx.add_input(input)
         end
@@ -503,6 +513,15 @@ module BSV
         input.source_locking_script = source_tx.outputs[output_index].locking_script
       end
 
+      def wire_source_from_storage(input, outpoint)
+        results = @storage.find_outputs({ outpoint: outpoint, limit: 1 })
+        stored = results.first
+        return unless stored
+
+        input.source_satoshis = stored[:satoshis]
+        input.source_locking_script = BSV::Script::Script.from_hex(stored[:locking_script])
+      end
+
       def build_outputs(tx, outputs)
         outputs.each do |spec|
           output = BSV::Transaction::TransactionOutput.new(
@@ -539,6 +558,7 @@ module BSV
       end
 
       def finalize_action(tx, args)
+        tx.sign_all if tx.inputs.any?(&:unlocking_script_template)
         txid = tx.txid_hex
         status = args.dig(:options, :no_send) ? 'nosend' : 'completed'
 

data/lib/bsv/wallet_interface.rb

@@ -13,6 +13,7 @@ module BSV
     autoload :Validators,       'bsv/wallet_interface/validators'
     autoload :StorageAdapter,    'bsv/wallet_interface/storage_adapter'
     autoload :MemoryStore,       'bsv/wallet_interface/memory_store'
+    autoload :FileStore,         'bsv/wallet_interface/file_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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bsv-wallet
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Simon Bettison
 bindir: bin
 cert_chain: []
-date: 2026-03-30 00:00:00.000000000 Z
+date: 2026-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 description: Implements the BRC-100 standard wallet-to-application interface for the
   BSV Blockchain.
 executables: []
@@ -52,6 +52,7 @@ files:
 - lib/bsv/wallet_interface/errors/invalid_signature_error.rb
 - lib/bsv/wallet_interface/errors/unsupported_action_error.rb
 - lib/bsv/wallet_interface/errors/wallet_error.rb
+- lib/bsv/wallet_interface/file_store.rb
 - lib/bsv/wallet_interface/interface.rb
 - lib/bsv/wallet_interface/key_deriver.rb
 - lib/bsv/wallet_interface/memory_store.rb