bsv-attest 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2f577e5fd3ffdca87cab33ea4c1e8d38d3eb8451fac97eb6894169ebe75c989
+  data.tar.gz: 3ed83b62b4e73c35e8c8169df260281a3f22b24f333982d33fda1793d42e5742
+SHA512:
+  metadata.gz: c994a19ba4b35abdbaca3b43c5b9a1f4125ebc54cb64b4c89922335c6fc70060e8b06e6e119d3e4bdd598d3d7b5cfc3a2cc2b6799cf37c316f96d3ad18e363d7
+  data.tar.gz: 64e1261fe2dd9ffd2eaf0a1ac4c659652f7b8dc920d3e8f546bc5029c4c852ecf00d91f9e769d9fecaa9baeec26dbf3dca1963c41f7ef1b5374b832db8f7f529

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog — bsv-attest
+
+All notable changes to the `bsv-attest` 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.2.0 — 2026-04-13
+
+### Breaking Changes
+- Removed `broadcaster` from `Attest::Configuration` — attestation now uses the wallet's broadcaster via `create_action`
+
+### Added
+- `BSV::Attest.publish` now uses `wallet.create_action` for transaction construction and broadcast (#414)
+- `BSV::Attest::BroadcastError` class for create_action failures (#413)
+
+### Changed
+- `Attest::Response` simplified to hash + txid only (#412)
+
+### Fixed
+- Pass args as positional Hash to `create_action` for Ruby 2.7 compatibility (#414)
+
+## 0.1.0
+
+Initial release of `bsv-attest`.

data/LICENSE

@@ -0,0 +1,86 @@
+Open BSV License Version 5 – granted by BSV Association, Grafenauweg 6, 6300
+Zug, Switzerland (CHE-427.008.338) ("Licensor"), to you as a user (henceforth
+"You", "User" or "Licensee").
+
+For the purposes of this license, the definitions below have the following
+meanings:
+
+"Bitcoin Protocol" means the protocol implementation, cryptographic rules,
+network protocols, and consensus mechanisms in the Bitcoin White Paper as
+described here https://protocol.bsvblockchain.org.
+
+"Bitcoin White Paper" means the paper entitled 'Bitcoin: A Peer-to-Peer
+Electronic Cash System' published by 'Satoshi Nakamoto' in October 2008.
+
+"BSV Blockchains" means:
+  (a) the Bitcoin blockchain containing block height #556767 with the hash
+      "000000000000000001d956714215d96ffc00e0afda4cd0a96c96f8d802b1662b" and
+      that contains the longest honest persistent chain of blocks which has been
+      produced in a manner which is consistent with the rules set forth in the
+      Network Access Rules; and
+  (b) the test blockchains that contain the longest honest persistent chains of
+      blocks which has been produced in a manner which is consistent with the
+      rules set forth in the Network Access Rules.
+
+"Network Access Rules" or "Rules" means the set of rules regulating the
+relationship between BSV Association and the nodes on BSV based on the Bitcoin
+Protocol rules and those set out in the Bitcoin White Paper, and available here
+https://bsvblockchain.org/network-access-rules.
+
+"Software" means the software the subject of this licence, including any/all
+intellectual property rights therein and associated documentation files.
+
+BSV Association grants permission, free of charge and on a non-exclusive and
+revocable basis, to any person obtaining a copy of the Software to deal in the
+Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to and conditioned upon the following conditions:
+
+1 - The text "© BSV Association," and this license shall be included in all
+copies or substantial portions of the Software.
+2 - The Software, and any software that is derived from the Software or parts
+thereof, must only be used on the BSV Blockchains.
+
+For the avoidance of doubt, this license is granted subject to and conditioned
+upon your compliance with these terms only. In the event of non-compliance, the
+license shall extinguish and you can be enjoined from violating BSV's
+intellectual property rights (incl. damages and similar related claims).
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES REGARDING ENTITLEMENT,
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS THEREOF BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+
+Version 0.1.1 of the Bitcoin SV software, and prior versions of software upon
+which it was based, were licensed under the MIT License, which is included below.
+
+The MIT License (MIT)
+
+Copyright (c) 2009-2010 Satoshi Nakamoto
+Copyright (c) 2009-2015 Bitcoin Developers
+Copyright (c) 2009-2017 The Bitcoin Core developers
+Copyright (c) 2017 The Bitcoin ABC developers
+Copyright (c) 2018 Bitcoin Association for BSV
+Copyright (c) 2023 BSV Association
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/bsv/attest/broadcast_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BSV
+  module Attest
+    class BroadcastError < StandardError; end
+  end
+end

data/lib/bsv/attest/configuration.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module BSV
+  module Attest
+    class Configuration
+      attr_accessor :wallet, :provider
+    end
+  end
+end

data/lib/bsv/attest/response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BSV
+  module Attest
+    class Response
+      attr_reader :hash, :txid
+
+      def initialize(hash:, txid:)
+        @hash = hash
+        @txid = txid
+      end
+
+      def hash_hex
+        @hash.unpack1('H*')
+      end
+    end
+  end
+end

data/lib/bsv/attest/verification_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BSV
+  module Attest
+    class VerificationError < StandardError; end
+  end
+end

data/lib/bsv/attest/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BSV
+  module Attest
+    VERSION = '0.2.0'
+  end
+end

data/lib/bsv/attest.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module BSV
+  module Attest
+    autoload :BroadcastError,    'bsv/attest/broadcast_error'
+    autoload :Configuration,     'bsv/attest/configuration'
+    autoload :Response,          'bsv/attest/response'
+    autoload :VerificationError, 'bsv/attest/verification_error'
+    autoload :VERSION,           'bsv/attest/version'
+
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+
+      def reset_configuration!
+        @configuration = Configuration.new
+      end
+
+      def hash(data)
+        BSV::Primitives::Digest.sha256(data)
+      end
+
+      def publish(data, wallet: nil, description: nil)
+        w = wallet || configuration.wallet
+        raise ArgumentError, 'wallet is required' unless w
+
+        digest = hash(data)
+        script = BSV::Script::Script.op_return(digest)
+
+        desc = description || 'Attest data hash to chain'
+
+        result = w.create_action(
+          {
+            description: desc,
+            outputs: [{
+              locking_script: script.to_hex,
+              satoshis: 0,
+              output_description: 'Attestation hash'
+            }],
+            options: { randomize_outputs: false }
+          }
+        )
+
+        raise BroadcastError, result[:broadcast_error] if result[:broadcast_error]
+
+        Response.new(hash: digest, txid: result[:txid])
+      end
+
+      def verify(data, txid, provider: nil)
+        p = provider || configuration.provider
+        raise ArgumentError, 'provider is required' unless p
+
+        digest = hash(data)
+
+        tx = p.fetch_transaction(txid)
+
+        tx.outputs.each do |output|
+          script = output.locking_script
+          next unless script.op_return?
+
+          # Use op_return_data which correctly re-parses the tail after F3.1's
+          # OP_RETURN termination fix (the raw tail is now in one chunk).
+          items = script.op_return_data
+          next if items.nil?
+
+          return true if items.include?(digest)
+        end
+
+        raise VerificationError, 'hash not found in transaction outputs'
+      end
+    end
+  end
+end

data/lib/bsv-attest.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bsv-sdk'
+require_relative 'bsv/attest'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: bsv-attest
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Simon Bettison
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bsv-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bsv-wallet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Hash data, publish hashes to the BSV blockchain via OP_RETURN, and verify
+  attestations on chain.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- lib/bsv-attest.rb
+- lib/bsv/attest.rb
+- lib/bsv/attest/broadcast_error.rb
+- lib/bsv/attest/configuration.rb
+- lib/bsv/attest/response.rb
+- lib/bsv/attest/verification_error.rb
+- lib/bsv/attest/version.rb
+homepage: https://github.com/sgbett/bsv-ruby-sdk
+licenses:
+- LicenseRef-OpenBSV
+metadata:
+  homepage_uri: https://github.com/sgbett/bsv-ruby-sdk
+  source_code_uri: https://github.com/sgbett/bsv-ruby-sdk
+  changelog_uri: https://github.com/sgbett/bsv-ruby-sdk/blob/master/gem/bsv-attest/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Data attestation for the BSV Blockchain
+test_files: []