cardano-bech32 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61879ba04ac1f386b78a11a2627b3517b503153030fa714066e46d63ffaf1ca6
-  data.tar.gz: 5fdac5c7012890bb2eec29d1ed10162806c13657e7db539b05f38583312eb8da
+  metadata.gz: 3cc7e539a8a0e31cc6e25a42a84ba58419f9ce689be6be07f6e92cc8d6f4a04c
+  data.tar.gz: 04a8ff0509d920547f2e9f181e7659c3743fee575bf7f11ea61c35f9c0111fb2
 SHA512:
-  metadata.gz: eaba40171f236c8887414261a9063c9139c016331a1ed37984684c145655dd701c43a0963eb99888f83c2b6a27bf2c1d7a845c88e78582ff2f45b38910b6b8fd
-  data.tar.gz: b9f1737243afdfb79c5d19748c7cbbbabcab019ae29262569dc01c79ec21c4e4f3bcddfb1500dac5b6a3d0ef25bce23796ee88a20e1b33b494bd3dfffe69620a
+  metadata.gz: 90641e5ad5e7a0bfcd19e061fa8a02ed8442a9f25a7e023cc43ce447e7536270ae06029fdaef142ab92fe55be914d731d21ee7476236f359de1ebed5cfdd88eb
+  data.tar.gz: 29b7495b3e916622a6d3792fc412f2bc8471879c1d8a4f4ec9ba3e135c66ff0e814366fceefabe7472a2a9e6f0c1ac4b4870921f3952b1318f0516891892d28c

data/CODE_OF_CONDUCT.md

@@ -1,6 +1,6 @@
 # Code of Conduct
 
-"cardano_bech32" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+"cardano-bech32" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
 
 * Participants will be tolerant of opposing views.
 * Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.

data/README.md

@@ -1,4 +1,4 @@
-# CardanoBech32
+# cardano-bech32
 
 A small, focused Ruby library for encoding and decoding Cardano Bech32 identifiers.
 This gem deliberately avoids higher-level ledger concerns and focuses solely on correct, specification-compliant Bech32 handling.
@@ -43,18 +43,18 @@ tx_id (32 bytes) || index (1 byte)
 #### Encoding
 
 ```ruby
-require "cardano_bech32"
+require "cardano/bech32"
 
 txref = "b2a591ac219ce6dcca5847e0248015209c7cb0436aa6bd6863d0c1f152a60bc5#0"
 
-CardanoBech32::GovAction.encode(txref)
+Cardano::Bech32::GovAction.encode(txref)
 # => "gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn"
 ```
 
 #### Decoding
 
 ```ruby
-CardanoBech32::GovAction.decode(
+Cardano::Bech32::GovAction.decode(
   "gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn"
 )
 # => {
@@ -71,7 +71,7 @@ Validation checks:
 * Correct payload length (33 bytes)
 
 ```ruby
-CardanoBech32::GovAction.valid?("gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn")
+Cardano::Bech32::GovAction.valid?("gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn")
 # => true
 ```
 
@@ -86,8 +86,8 @@ explicit, typed errors:
 ```ruby
 # Example
 begin
-  CardanoBech32::GovAction.encode("invalid")
-rescue CardanoBech32::GovAction::Error => e
+  Cardano::Bech32::GovAction.encode("invalid")
+rescue Cardano::Bech32::GovAction::Error => e
   puts e.message
 end
 
@@ -109,4 +109,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the CardanoBech32 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cardano_bech32/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Cardano::Bech32 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cardano_bech32/blob/main/CODE_OF_CONDUCT.md).

data/lib/cardano/bech32/gov_action.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "bech32"
+
+module Cardano
+  module Bech32
+    # Bech32 encoding for governance action references.
+    # A governance action reference is of the form "txid#index"
+    # where txid is a 32-byte hex string and index is a 0..255 integer
+    # The Bech32 encoding has HRP "gov_action" and a payload of 33 bytes:
+    # - 32 bytes: txid (binary)
+    # - 1 byte: index (binary)
+    #
+    module GovAction
+      HRP = "gov_action"
+      TX_ID_BYTES = 32
+      INDEX_BYTES = 1
+      TOTAL_BYTES = TX_ID_BYTES + INDEX_BYTES
+
+      class Error < StandardError; end
+      class InvalidFormat < Error; end
+      class InvalidPayload < Error; end
+
+      def self.encode(tx_ref)
+        txid_hex, index_str = tx_ref.split("#", 2)
+        raise InvalidFormat, "expected txid#index" unless txid_hex && index_str
+
+        txid_bytes = hex_to_bytes(txid_hex)
+        index = Integer(index_str)
+
+        raise InvalidPayload, "txid must be 32 bytes" unless txid_bytes.bytesize == TX_ID_BYTES
+        raise InvalidPayload, "index must be 0..255" unless index.between?(0, 255)
+
+        payload = txid_bytes + [index].pack("C")
+
+        # Convert to 5-bit array
+        # args: data (array of integers), from_bits, to_bits, pad (boolean)
+        data_5bit = ::Bech32.convert_bits(payload.bytes, 8, 5, true)
+        ::Bech32.encode(HRP, data_5bit, ::Bech32::Encoding::BECH32)
+      end
+
+      def self.decode(bech32)
+        hrp, data = ::Bech32.decode(bech32)
+        raise InvalidFormat, "invalid HRP" unless hrp == HRP
+
+        # Convert to 5-bit array
+        # args: data (array of integers), from_bits, to_bits, pad (boolean)
+        bytes = ::Bech32.convert_bits(data, 5, 8, false)
+        raise InvalidPayload, "invalid payload length" unless bytes.length == TOTAL_BYTES
+
+        {
+          tx_id: bytes_to_hex(bytes[0, TX_ID_BYTES]),
+          index: bytes.last
+        }
+      rescue ArgumentError
+        raise InvalidFormat, "invalid bech32 encoding"
+      end
+
+      def self.valid?(bech32)
+        decode(bech32)
+        true
+      rescue Error
+        false
+      end
+
+      def self.hex_to_bytes(hex)
+        raise InvalidFormat, "invalid hex" unless hex.match?(/\A[0-9a-fA-F]{64}\z/)
+
+        [hex].pack("H*")
+      end
+
+      def self.bytes_to_hex(bytes)
+        bytes.pack("C*").unpack1("H*")
+      end
+    end
+  end
+end

data/lib/cardano/bech32/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cardano
+  module Bech32
+    VERSION = "0.3.0"
+  end
+end

data/lib/cardano/bech32.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "bech32/version"
+require_relative "bech32/gov_action"
+
+module Cardano
+  module Bech32
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/sig/cardano/bech32.rbs

@@ -0,0 +1,6 @@
+module Cardano
+  module Bech32
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cardano-bech32
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robin Böning
@@ -52,10 +52,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/cardano_bech32.rb
-- lib/cardano_bech32/gov_action.rb
-- lib/cardano_bech32/version.rb
-- sig/cardano_bech32.rbs
+- lib/cardano/bech32.rb
+- lib/cardano/bech32/gov_action.rb
+- lib/cardano/bech32/version.rb
+- sig/cardano/bech32.rbs
 homepage: https://github.com/lacepool/cardano-bech32
 licenses:
 - MIT

data/lib/cardano_bech32/gov_action.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require "bech32"
-
-module CardanoBech32
-  # Bech32 encoding for governance action references.
-  # A governance action reference is of the form "txid#index"
-  # where txid is a 32-byte hex string and index is a 0..255 integer
-  # The Bech32 encoding has HRP "gov_action" and a payload of 33 bytes:
-  # - 32 bytes: txid (binary)
-  # - 1 byte: index (binary)
-  #
-  module GovAction
-    HRP = "gov_action"
-    TX_ID_BYTES = 32
-    INDEX_BYTES = 1
-    TOTAL_BYTES = TX_ID_BYTES + INDEX_BYTES
-
-    class Error < StandardError; end
-    class InvalidFormat < Error; end
-    class InvalidPayload < Error; end
-
-    def self.encode(tx_ref)
-      txid_hex, index_str = tx_ref.split("#", 2)
-      raise InvalidFormat, "expected txid#index" unless txid_hex && index_str
-
-      txid_bytes = hex_to_bytes(txid_hex)
-      index = Integer(index_str)
-
-      raise InvalidPayload, "txid must be 32 bytes" unless txid_bytes.bytesize == TX_ID_BYTES
-      raise InvalidPayload, "index must be 0..255" unless index.between?(0, 255)
-
-      payload = txid_bytes + [index].pack("C")
-
-      # Convert to 5-bit array
-      # args: data (array of integers), from_bits, to_bits, pad (boolean)
-      data_5bit = Bech32.convert_bits(payload.bytes, 8, 5, true)
-      Bech32.encode(HRP, data_5bit, Bech32::Encoding::BECH32)
-    end
-
-    def self.decode(bech32)
-      hrp, data = Bech32.decode(bech32)
-      raise InvalidFormat, "invalid HRP" unless hrp == HRP
-
-      # Convert to 5-bit array
-      # args: data (array of integers), from_bits, to_bits, pad (boolean)
-      bytes = Bech32.convert_bits(data, 5, 8, false)
-      raise InvalidPayload, "invalid payload length" unless bytes.length == TOTAL_BYTES
-
-      {
-        tx_id: bytes_to_hex(bytes[0, TX_ID_BYTES]),
-        index: bytes.last
-      }
-    rescue ArgumentError
-      raise InvalidFormat, "invalid bech32 encoding"
-    end
-
-    def self.valid?(bech32)
-      decode(bech32)
-      true
-    rescue Error
-      false
-    end
-
-    def self.hex_to_bytes(hex)
-      raise InvalidFormat, "invalid hex" unless hex.match?(/\A[0-9a-fA-F]{64}\z/)
-
-      [hex].pack("H*")
-    end
-
-    def self.bytes_to_hex(bytes)
-      bytes.pack("C*").unpack1("H*")
-    end
-  end
-end

data/lib/cardano_bech32/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module CardanoBech32
-  VERSION = "0.1.0"
-end

data/lib/cardano_bech32.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "cardano_bech32/version"
-require_relative "cardano_bech32/gov_action"
-
-module CardanoBech32
-  class Error < StandardError; end
-  # Your code goes here...
-end

data/sig/cardano_bech32.rbs

@@ -1,4 +0,0 @@
-module CardanoBech32
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end