bech32 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 368eb6deb6248ddb8f5cbcba18ec90a3ed11b84f60a3de80bb59301eb5c7f1a2
-  data.tar.gz: a0d8654790ab71f8460eecdbf17248e8acd3748bf2011b94afe32dd079b2248b
+  metadata.gz: 22cba51d19b0989743f7f679f187311e735ce018dec53880ddfefebee89f688f
+  data.tar.gz: 1cd7be33ab83fd724054202a812f818ed02adb5eb7545baa27e27f6b3358da2e
 SHA512:
-  metadata.gz: f3aad0caf6fce5ce425bd0c4e59e934ecfe96bc6fec30cd5c5c7a6ee73f266824c7f90193f4e008ea24f8a65239d13c3763d35c8211d5fa2485cb8317e56d527
-  data.tar.gz: 4891f6c6f80b6b11cd136637c9fd204070a2fab2b170919b34c976219d9885eb8ed43ba688b2002fcc1db4df4b2755d1b169744cfaea578e64336afa327b4b65
+  metadata.gz: dc71997f097a817224b687dc53baf048ba2954cd030f7db50523d7e45121632b7f2edf758ed78298102214c3e3407cf7c7da6b3469a3cde089ade10e8346088d
+  data.tar.gz: 6c246c4107a40193d317738bfa4637ccf6452efb48f1d36532570cec1e09681cc17fd374f47361467017e6546f36c4513f2585ed2d4b767939dcef05047ede46

data/.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4']
+        ruby-version: ['3.2', '3.3', '3.4', '4.0']
 
     steps:
       - uses: actions/checkout@v4
@@ -32,3 +32,16 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run tests
         run: bundle exec rake
+
+  typecheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - name: Run type check
+        run: bundle exec steep check

data/.ruby-version

@@ -1 +1 @@
-ruby-3.4.1
+ruby-4.0.0

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bech32.gemspec
 gemspec
+
+group :development do
+  gem 'steep'
+  gem 'rbs'
+end

data/Steepfile

@@ -0,0 +1,19 @@
+# Steepfile
+target :lib do
+  signature "sig"
+
+  check "lib"
+
+  library "stringio"
+
+  # Configure diagnostic severity
+  # These errors are from Ruby code patterns that are runtime-safe but hard to express in RBS
+  configure_code_diagnostics do |hash|
+    # Suppress errors for method calls on potentially nil values
+    # The actual code handles nil cases properly at runtime
+    hash[Steep::Diagnostic::Ruby::NoMethod] = :hint
+    hash[Steep::Diagnostic::Ruby::ArgumentTypeMismatch] = :hint
+    hash[Steep::Diagnostic::Ruby::MethodBodyTypeMismatch] = :hint
+    hash[Steep::Diagnostic::Ruby::UnannotatedEmptyCollection] = :hint
+  end
+end

data/bech32.gemspec

@@ -13,8 +13,10 @@ Gem::Specification.new do |spec|
   spec.description   = %q(The implementation of Bech32 encoder and decoder.)
   spec.homepage      = 'https://github.com/azuchi/bech32rb'
   spec.license       = 'MIT'
+  spec.metadata      = { 'rubygems_mfa_required' => 'true' }
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         += Dir['sig/**/*.rbs']
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']

data/lib/bech32/nostr/entity.rb

@@ -110,37 +110,42 @@ module Bech32
         buf = ::StringIO.new(data)
         entries = []
         until buf.eof?
-          type, len = buf.read(2).unpack('CC')
+          header = buf.read(2)
+          raise ArgumentError, "Invalid TLV: truncated header." if header.nil? || header.bytesize < 2
+          type, len = header.unpack('CC')
+          value = buf.read(len)
+          raise ArgumentError, "Invalid TLV: truncated value." if value.nil? ? len > 0 : value.bytesize < len
+          value ||= ''
           case type
           when TYPE_SPECIAL # special
             case hrp
             when NIP19::HRP_PROFILE
-              entries << TLVEntry.new(type, buf.read(len).unpack1('H*'), 'pubkey')
+              entries << TLVEntry.new(type, value.unpack1('H*'), 'pubkey')
             when NIP19::HRP_RELAY
-              entries << TLVEntry.new(type, buf.read(len), 'relay')
+              entries << TLVEntry.new(type, value, 'relay')
             when NIP19::HRP_EVENT
-              entries << TLVEntry.new(type, buf.read(len).unpack1('H*'), 'id')
+              entries << TLVEntry.new(type, value.unpack1('H*'), 'id')
             when NIP19::HRP_EVENT_COORDINATE
-              entries << TLVEntry.new(type, buf.read(len), 'identifier')
+              entries << TLVEntry.new(type, value, 'identifier')
             end
           when TYPE_RELAY # relay
             case hrp
             when NIP19::HRP_PROFILE, NIP19::HRP_EVENT, NIP19::HRP_EVENT_COORDINATE
-              entries << TLVEntry.new(type, buf.read(len), 'relay')
+              entries << TLVEntry.new(type, value, 'relay')
             else
               raise ArgumentError, "Type: #{type} does not supported for HRP: #{hrp}"
             end
           when TYPE_AUTHOR # author
             case hrp
             when NIP19::HRP_EVENT, NIP19::HRP_EVENT_COORDINATE
-              entries << TLVEntry.new(type, buf.read(len).unpack1('H*'), 'author')
+              entries << TLVEntry.new(type, value.unpack1('H*'), 'author')
             else
               raise ArgumentError, "Type: #{type} does not supported for HRP: #{hrp}"
             end
           when TYPE_KIND # kind
             case hrp
             when NIP19::HRP_EVENT, NIP19::HRP_EVENT_COORDINATE
-              entries << TLVEntry.new(type, buf.read(len).unpack1('H*').to_i(16), 'kind')
+              entries << TLVEntry.new(type, value.unpack1('H*').to_s.to_i(16), 'kind')
             else
               raise ArgumentError, "Type: #{type} does not supported for HRP: #{hrp}"
             end

data/lib/bech32/nostr/nip19.rb

@@ -28,7 +28,9 @@ module Bech32
         raise ArgumentError, 'Invalid nip19 string.' if hrp.nil?
         raise ArgumentError, 'Invalid bech32 spec.' unless spec == Bech32::Encoding::BECH32
 
-        entity = Bech32.convert_bits(data, 5, 8, false).pack('C*')
+        converted = Bech32.convert_bits(data, 5, 8, false)
+        raise ArgumentError, 'Invalid data.' if converted.nil?
+        entity = converted.pack('C*')
         raise ArgumentError, "Data whose HRP is #{hrp} must be 32 bytes." if BARE_PREFIXES.include?(hrp) && entity.bytesize != 32
         if BARE_PREFIXES.include?(hrp)
           BareEntity.new(hrp, entity.unpack1('H*'))

data/lib/bech32/silent_payment_addr.rb

@@ -38,7 +38,9 @@ module Bech32
       raise ArgumentError, "addr must be encoded with bech32m." unless spec == Bech32::Encoding::BECH32M
       raise ArgumentError, 'Invalid hrp.' if hrp.nil? || data[0].nil? || ![HRP_MAINNET, HRP_TESTNET].include?(hrp)
       version = data[0]
-      keys = Bech32.convert_bits(data[1..-1], 5, 8, false).pack('C*').unpack1('H*')
+      converted = Bech32.convert_bits(data[1..-1], 5, 8, false)
+      raise ArgumentError, "Invalid data." if converted.nil?
+      keys = converted.pack('C*').unpack1('H*')
       raise ArgumentError, "Invalid key size." unless keys.length == 132
       scan = keys[0...66]
       spend = keys[66..-1]

data/lib/bech32/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bech32
-  VERSION = '1.5.0'
+  VERSION = '1.5.1'
 end

data/lib/bech32.rb

@@ -50,7 +50,7 @@ module Bech32
     bech = bech.downcase
     # check data length
     pos = bech.rindex(SEPARATOR)
-    return nil if pos.nil? || pos + 7 > bech.length || bech.length > max_length
+    return nil if pos.nil? || pos < 1 || pos + 7 > bech.length || bech.length > max_length
     # check valid charset
     bech[pos+1..-1].each_char{|c|return nil unless CHARSET.include?(c)}
     # split hrp and data

data/sig/bech32/bech32.rbs

@@ -0,0 +1,45 @@
+module Bech32
+  VERSION: String
+
+  module Encoding
+    BECH32: Integer
+    BECH32M: Integer
+  end
+
+  SEPARATOR: String
+  CHARSET: Array[String]
+  BECH32M_CONST: Integer
+
+  # Encode hrp and data to bech32/bech32m string.
+  def self.encode: (String hrp, Array[Integer] data, Integer spec) -> String
+
+  # Decode bech32/bech32m string. Returns nil if invalid.
+  def self.decode: (String bech, ?Integer max_length) -> [String, Array[Integer], Integer]?
+
+  # Convert bits from one base to another.
+  def self.convert_bits: (Array[Integer] data, Integer from, Integer to, ?bool padding) -> Array[Integer]?
+
+  # Create checksum for hrp and data.
+  def self.create_checksum: (String hrp, Array[Integer] data, Integer spec) -> Array[Integer]
+
+  # Verify checksum. Returns encoding spec if valid, nil otherwise.
+  def self.verify_checksum: (String hrp, Array[Integer] data) -> Integer?
+
+  # module_function methods are also available as instance methods
+  def encode: (String hrp, Array[Integer] data, Integer spec) -> String
+  def decode: (String bech, ?Integer max_length) -> [String, Array[Integer], Integer]?
+  def convert_bits: (Array[Integer] data, Integer from, Integer to, ?bool padding) -> Array[Integer]?
+  def create_checksum: (String hrp, Array[Integer] data, Integer spec) -> Array[Integer]
+  def verify_checksum: (String hrp, Array[Integer] data) -> Integer?
+
+  private
+
+  # Expand HRP for checksum computation.
+  def self.expand_hrp: (String hrp) -> Array[Integer]
+
+  # Compute polymod checksum.
+  def self.polymod: (Array[Integer] values) -> Integer
+
+  def expand_hrp: (String hrp) -> Array[Integer]
+  def polymod: (Array[Integer] values) -> Integer
+end

data/sig/bech32/nostr/entity.rbs

@@ -0,0 +1,54 @@
+module Bech32
+  module Nostr
+    class BareEntity
+      attr_reader hrp: String
+      attr_reader data: String
+
+      # Initialize bare entity.
+      def initialize: (String hrp, String data) -> void
+
+      # Encode to bech32 string.
+      def encode: () -> String
+    end
+
+    class TLVEntry
+      attr_reader type: Integer
+      attr_reader label: String?
+      attr_reader value: String | Integer
+
+      # Initialize TLV entry.
+      def initialize: (Integer type, String | Integer value, ?String? label) -> void
+
+      # Convert to binary payload.
+      def to_payload: () -> String
+
+      # String representation.
+      def to_s: () -> String
+
+      private
+
+      # Check if string is hex encoded.
+      def hex_string?: (String str) -> bool
+    end
+
+    class TLVEntity
+      TYPE_SPECIAL: Integer
+      TYPE_RELAY: Integer
+      TYPE_AUTHOR: Integer
+      TYPE_KIND: Integer
+      TYPES: Array[Integer]
+
+      attr_reader hrp: String
+      attr_reader entries: Array[TLVEntry]
+
+      # Initialize TLV entity.
+      def initialize: (String hrp, Array[TLVEntry] entries) -> void
+
+      # Parse TLV entity from binary data.
+      def self.parse: (String hrp, String data) -> TLVEntity
+
+      # Encode to bech32 string.
+      def encode: () -> String
+    end
+  end
+end

data/sig/bech32/nostr/nip19.rbs

@@ -0,0 +1,23 @@
+module Bech32
+  module Nostr
+    module NIP19
+      HRP_PUBKEY: String
+      HRP_PRIVATE_KEY: String
+      HRP_NOTE_ID: String
+      HRP_PROFILE: String
+      HRP_EVENT: String
+      HRP_RELAY: String
+      HRP_EVENT_COORDINATE: String
+
+      BARE_PREFIXES: Array[String]
+      TLV_PREFIXES: Array[String]
+      ALL_PREFIXES: Array[String]
+
+      # Decode NIP-19 bech32 string.
+      def self.decode: (String string) -> (BareEntity | TLVEntity)
+
+      # module_function methods are also available as instance methods
+      def decode: (String string) -> (BareEntity | TLVEntity)
+    end
+  end
+end

data/sig/bech32/segwit_addr.rbs

@@ -0,0 +1,28 @@
+module Bech32
+  class SegwitAddr
+    HRP_MAINNET: String
+    HRP_TESTNET: String
+    HRP_REGTEST: String
+
+    attr_accessor hrp: String
+    attr_accessor ver: Integer?
+    attr_accessor prog: Array[Integer]?
+
+    # Initialize SegwitAddr. Optionally parse from address string.
+    def initialize: (?String? addr) -> void
+
+    # Generate script pubkey from witness version and program.
+    def to_script_pubkey: () -> String
+
+    # Parse script pubkey into witness version and program.
+    def script_pubkey=: (String script_pubkey) -> void
+
+    # Generate bech32/bech32m address string.
+    def addr: () -> String
+
+    private
+
+    # Parse address string into hrp, version and program.
+    def parse_addr: (String addr) -> void
+  end
+end

data/sig/bech32/silent_payment_addr.rbs

@@ -0,0 +1,21 @@
+module Bech32
+  # BIP-352 silent payment address.
+  class SilentPaymentAddr
+    HRP_MAINNET: String
+    HRP_TESTNET: String
+
+    attr_reader hrp: String
+    attr_reader version: Integer
+    attr_reader scan_key: String
+    attr_reader spend_key: String
+
+    # Initialize SilentPaymentAddr.
+    def initialize: (String hrp, Integer version, String scan_key, String spend_key) -> void
+
+    # Parse silent payment address string.
+    def self.parse: (String addr) -> SilentPaymentAddr
+
+    # Generate silent payment address string.
+    def to_s: () -> String
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bech32
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Shigeyuki Azuchi
 bindir: exe
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -69,6 +69,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bech32.gemspec
 - bin/console
 - bin/setup
@@ -80,10 +81,16 @@ files:
 - lib/bech32/segwit_addr.rb
 - lib/bech32/silent_payment_addr.rb
 - lib/bech32/version.rb
+- sig/bech32/bech32.rbs
+- sig/bech32/nostr/entity.rbs
+- sig/bech32/nostr/nip19.rbs
+- sig/bech32/segwit_addr.rbs
+- sig/bech32/silent_payment_addr.rbs
 homepage: https://github.com/azuchi/bech32rb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -98,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 4.0.3
 specification_version: 4
 summary: The implementation of Bech32 encoder and decoder.
 test_files: []