bsv-sdk 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bb4b97822f38d793a308e9beddc94bd90e64457bda8f1782875ddcd8a1ff1f3
-  data.tar.gz: 85009a67a04ee1264acd883224ea418ed46558629a18db3d1757486cc544852d
+  metadata.gz: 7e425cc46fca3c3db1d2dc79702491600ec302625132ba10c95ee8dee7242ed9
+  data.tar.gz: 1839e24be2d7ebea84478b54526f7793839681cd385fb9de962f118826220338
 SHA512:
-  metadata.gz: 85e2958f6bb6af774b2ca06e5187bbc1c756546e322430375108617b4675e6e5d5373aa8d93fd4504327d3c48e29507a2caea566d0b9af5e16c3fdd089bc2fbc
-  data.tar.gz: 56797e445e8996c2a41e85484e49f53b3568eaebeaf01de39a1e919c6949f40b172236ad5bd89fbc77eb9405a532653c9ab1972e696e699d6410e503318360d7
+  metadata.gz: 285dd4fc51b19fef84f31071cec373b43c70347de9cd5bf904c17fff65ff1c964b62d49969de79b98caa241198b6e689c7e50551a66aac2c1c593b1b9f491dc9
+  data.tar.gz: 3e5536f21302a75992e221967fa5de233cb4200a9efc34cd71b6d892f714955fd2dda73625a998a9943110274d63925e044690a99fe8870ef5a09323d6c1d901

data/CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to the `bsv-sdk` gem are documented here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 and this gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.18.1 — 2026-05-09
+
+### Added
+- ARC broadcast accepts hex and binary strings directly, in addition to transaction objects
+
+### Fixed
+- Hex string detection uses content inspection rather than string encoding
+- Stale "Phase B" text removed from Protocols namespace module doc
+
 ## 0.18.0 — 2026-05-09
 
 ### Breaking Changes

data/lib/bsv/network/protocols/arc.rb

@@ -68,7 +68,8 @@ module BSV
         # Broadcast escape hatch: EF format preference, custom headers, rejection
         # detection, and malformed 2xx detection.
         #
-        # @param tx [Transaction] the transaction to broadcast
+        # @param tx [#to_ef_hex, #to_hex, String] transaction object, hex string,
+        #   or binary string
         # @param wait_for [String, nil] ARC wait condition
         # @param skip_fee_validation [Boolean, nil]
         # @param skip_script_validation [Boolean, nil]
@@ -80,7 +81,7 @@ module BSV
         def call_broadcast(tx, wait_for: nil, skip_fee_validation: nil,
                            skip_script_validation: nil, skip_tx_validation: nil,
                            callback_url: nil, callback_token: nil, callback_batch: nil, **)
-          hex  = ef_hex_with_fallback(tx)
+          hex  = resolve_tx_hex(tx)
           body = JSON.generate(rawTx: hex)
 
           extra_headers = build_broadcast_headers(
@@ -99,7 +100,7 @@ module BSV
 
         # Broadcast-many escape hatch: batch broadcast with per-item rejection detection.
         #
-        # @param txs [Array<Transaction>]
+        # @param txs [Array<#to_ef_hex, #to_hex, String>]
         # @param wait_for [String, nil]
         # @param skip_fee_validation [Boolean, nil]
         # @param skip_script_validation [Boolean, nil]
@@ -113,7 +114,7 @@ module BSV
                                 callback_url: nil, callback_token: nil, callback_batch: nil, **)
           return Result::Success.new(data: []) if txs.empty?
 
-          body = JSON.generate(txs.map { |tx| { rawTx: ef_hex_with_fallback(tx) } })
+          body = JSON.generate(txs.map { |tx| { rawTx: resolve_tx_hex(tx) } })
 
           extra_headers = build_broadcast_headers(
             wait_for: wait_for,
@@ -136,10 +137,26 @@ module BSV
           request
         end
 
-        # Prefer Extended Format hex (BRC-30) so ARC can validate sighashes without
-        # fetching parent transactions. Falls back to plain raw-tx hex when any input
-        # lacks source_satoshis / source_locking_script.
-        def ef_hex_with_fallback(tx)
+        # Coerce a transaction input to hex for the ARC JSON body.
+        #
+        # Accepts (in order of preference):
+        # 1. Hex string — pass-through, zero conversion
+        # 2. Binary string — convert to hex
+        # 3. Transaction object — prefer EF hex (BRC-30), fall back to raw hex
+        #
+        # Detection uses content, not encoding: a string is hex if it has even
+        # length and contains only hex characters. This handles hex strings
+        # tagged as ASCII-8BIT (e.g. read from IO in binary mode).
+        #
+        # @param tx [String, #to_ef_hex, #to_hex] transaction in any supported form
+        # @return [String] hex-encoded transaction
+        def resolve_tx_hex(tx)
+          if tx.is_a?(String)
+            return tx if tx.match?(/\A[0-9a-fA-F]*\z/) && tx.length.even?
+
+            return tx.unpack1('H*')
+          end
+
           tx.to_ef_hex
         rescue ArgumentError => e
           BSV.logger&.debug { "[ARC] EF serialisation failed: #{e.message} — falling back to raw hex" }

data/lib/bsv/network/protocols.rb

@@ -3,9 +3,8 @@
 module BSV
   module Network
     # Protocols is a namespace module for concrete Protocol subclasses.
-    #
-    # Protocol implementations (e.g. ARC, WhatsOnChain adapters built on
-    # the Protocol base class) will be autoloaded here in Phase B.
+    # Each class maps a service's commands to HTTP endpoints: ARC, Chaintracks,
+    # JungleBus, Ordinals, TAALBinary, and WoCREST.
     module Protocols
       autoload :ARC,         'bsv/network/protocols/arc'
       autoload :Chaintracks, 'bsv/network/protocols/chaintracks'

data/lib/bsv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BSV
-  VERSION = '0.18.0'
+  VERSION = '0.18.1'
 end

data/lib/bsv/wallet/proto_wallet.rb

@@ -8,15 +8,51 @@ module BSV
   module Wallet
     # Minimal cryptographic wallet implementing the BRC-100 interface.
     #
-    # ProtoWallet provides signing, encryption, HMAC, and key derivation
-    # without transactions, storage, or blockchain interaction. It is the
-    # direct implementation of the BRC-100 crypto methods, not a delegating
-    # client. This makes it suitable for use in the SDK's Auth module without
-    # depending on the bsv-wallet gem.
+    # ProtoWallet is a direct, in-process implementation of the BRC-100 crypto
+    # operations. It requires no external gem, no storage, and no blockchain
+    # access — making it suitable for use inside the SDK itself (e.g. the Auth
+    # module) as well as lightweight applications that need cryptographic
+    # operations without full wallet infrastructure.
     #
-    # Includes +BSV::Wallet::Interface::BRC100+ — methods it supports are
-    # overridden; unsupported methods (transactions, blockchain, authentication)
-    # fall through to +NotImplementedError+.
+    # == Supported BRC-100 areas
+    #
+    # - *Public key management* — {#get_public_key}, {#reveal_counterparty_key_linkage},
+    #   {#reveal_specific_key_linkage}
+    # - *Cryptography* — {#encrypt}, {#decrypt}, {#create_hmac}, {#verify_hmac},
+    #   {#create_signature}, {#verify_signature}
+    # - *Certificates (read-only stub)* — {#list_certificates} returns an empty list;
+    #   {#prove_certificate} raises {UnsupportedActionError}
+    #
+    # == NOT supported
+    #
+    # The following BRC-100 areas are not implemented and will raise
+    # +NotImplementedError+:
+    #
+    # - Transactions (+create_action+, +sign_action+, +list_actions+, etc.)
+    # - Output management (+list_outputs+, +relinquish_output+, etc.)
+    # - Authentication (+authenticated?+, +wait_for_authentication+)
+    # - Blockchain / network data (+get_height+, +get_header_for_height+, etc.)
+    # - Certificate acquisition / discovery (+acquire_certificate+,
+    #   +discover_by_identity_key+, etc.)
+    #
+    # For full wallet functionality, use the +bsv-wallet+ gem. See
+    # +docs/sdk/wallet.md+ for usage guidance.
+    #
+    # == Construction
+    #
+    # Pass a {BSV::Primitives::PrivateKey} or the special string <tt>'anyone'</tt>.
+    # The <tt>'anyone'</tt> variant uses a well-known key (private key = 1) and is
+    # suitable for verifying or encrypting data that should be readable by
+    # any party — it must not be used where secrecy is required.
+    #
+    # @example Normal usage
+    #   wallet = BSV::Wallet::ProtoWallet.new(BSV::Primitives::PrivateKey.generate)
+    #   sig = wallet.create_signature(protocol_id: [1, 'my-app'], key_id: 'msg-1',
+    #                                 data: 'hello'.bytes)
+    #
+    # @example Anyone wallet
+    #   wallet = BSV::Wallet::ProtoWallet.new('anyone')
+    #   pub = wallet.get_public_key(identity_key: true)
     #
     class ProtoWallet
       include Interface::BRC100

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bsv-sdk
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Simon Bettison