rbsecp256k1 6.0.1 → 6.0.2

data/ext/rbsecp256k1/secp256k1_recipe.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'mini_portile2'
+require 'zip'
+
+# Enable the recovery module by default
+WITH_RECOVERY = ENV.fetch('WITH_RECOVERY', '1') == '1'
+
+# Recipe for downloading and building libsecp256k1 as part of installation
+class Secp256k1Recipe < MiniPortile
+  # Hard-coded URL for libsecp256k1 zipfile (Official release v0.8.0)
+  LIBSECP256K1_ZIP_URL = 'https://github.com/bitcoin-core/secp256k1/archive/refs/tags/v0.8.0.zip'
+
+  # Expected SHA-256 of the zipfile above (computed using sha256sum)
+  LIBSECP256K1_SHA256 = 'ecece6a1cec8bdecdccbf22e1ee65455feae1a5312913bd62c45bbdc912b442c'
+
+  def initialize
+    super('libsecp256k1', '0.8.0')
+    @tarball = File.join(Dir.pwd, "/ports/archives/libsecp256k1.zip")
+    @files = ["file://#{@tarball}"]
+    self.configure_options += [
+      "--with-pic=yes"
+    ]
+
+    # MiniPortile builds a static library. Its benchmark consumers also need
+    # this definition on Windows to avoid references to DLL import symbols.
+    if RUBY_PLATFORM =~ /mingw|mswin/
+      configure_options << "CPPFLAGS=#{ENV.fetch('CPPFLAGS', '')} -DSECP256K1_STATIC"
+    end
+
+    # ECDH, extrakeys and schnorrsig are enabled by default in release v0.8.0,
+    # but recovery still needs to be enabled manually.
+    configure_options << "--enable-module-recovery" if WITH_RECOVERY
+  end
+
+  def configure
+    # Need to run autogen.sh before configure since it creates it
+    if RUBY_PLATFORM =~ /mingw|mswin/
+      # Windows doesn't recognize the shebang.
+      execute('autogen', %w[sh ./autogen.sh])
+    else
+      execute('chmod', %w[chmod +x ./autogen.sh])
+      execute('autogen', %w[./autogen.sh])
+    end
+
+    super
+  end
+
+  def download
+    download_file_http(LIBSECP256K1_ZIP_URL, @tarball)
+    verify_file(local_path: @tarball, sha256: LIBSECP256K1_SHA256)
+  end
+
+  def downloaded?
+    File.exist?(@tarball)
+  end
+
+  def extract_zip_file(file, destination)
+    FileUtils.mkdir_p(destination)
+
+    Zip::File.open(file) do |zip_file|
+      zip_file.each do |f|
+        fpath = File.join(destination, f.name)
+        zip_file.extract(f, fpath) unless File.exist?(fpath)
+      end
+    end
+  end
+
+  def extract
+    files_hashs.each do |file|
+      # Cached and interrupted downloads also reach extraction without download.
+      verify_file(local_path: file[:local_path], sha256: LIBSECP256K1_SHA256)
+      extract_zip_file(file[:local_path], tmp_path)
+    end
+  end
+end

data/lib/rbsecp256k1/context.rb

@@ -1,36 +1,40 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-
-module Secp256k1
-  # Wrapper around a secp256k1_context object.
-  class Context
-    # Create a new randomized context.
-    #
-    # @return [Secp256k1::Context] randomized context
-    def self.create
-      new(context_randomization_bytes: SecureRandom.random_bytes(32))
-    end
-
-    # Create a new non-randomized context.
-    #
-    # @return [Secp256k1::Context] non-randomized context
-    def self.create_unrandomized
-      new
-    end
-
-    # Generates a new random key pair.
-    #
-    # @return [Secp256k1::KeyPair] public-private key pair.
-    def generate_key_pair
-      key_pair_from_private_key(SecureRandom.random_bytes(32))
-    end
-
-    # Create Schnorr signature generating auxrand.
-    #
-    # @return [Secp256k1::SchnorrSignature] schnorr signature
-    def sign_schnorr(keypair, message)
-      sign_schnorr_custom(keypair, message, SecureRandom.random_bytes(32))
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Secp256k1
+  # Wrapper around a secp256k1_context object.
+  class Context
+    # Create a new randomized context.
+    #
+    # @return [Secp256k1::Context] randomized context
+    def self.create
+      new(context_randomization_bytes: SecureRandom.random_bytes(32))
+    end
+
+    # Create a new non-randomized context.
+    #
+    # @return [Secp256k1::Context] non-randomized context
+    def self.create_unrandomized
+      new
+    end
+
+    # Generates a new random key pair.
+    #
+    # @return [Secp256k1::KeyPair] public-private key pair.
+    def generate_key_pair
+      key_pair_from_private_key(SecureRandom.random_bytes(32))
+    end
+
+    # Sign message bytes directly with fresh 32-byte auxiliary randomness.
+    # No implicit hashing, padding, or truncation is performed.
+    #
+    # @param keypair [Secp256k1::KeyPair] key pair used for signing
+    # @param message [String] message of any byte length, including zero
+    #
+    # @return [Secp256k1::SchnorrSignature] schnorr signature
+    def sign_schnorr(keypair, message)
+      sign_schnorr_custom(keypair, message, SecureRandom.random_bytes(32))
+    end
+  end
+end

data/lib/rbsecp256k1/util.rb

@@ -1,28 +1,28 @@
-# frozen_string_literal: true
-
-module Secp256k1
-  # Contains utility methods that complement the functionality of the library.
-  module Util
-    # Regexp to validate a hexadecimal string
-    HEX_REGEXP = /^[A-Fa-f\d]+$/.freeze
-
-    # Converts a binary string to a hex string.
-    #
-    # @param binary_string [String] binary string to be converted.
-    # @return [String] hex string equivalent of the given binary string.
-    def self.bin_to_hex(binary_string)
-      binary_string.unpack('H*').first
-    end
-
-    # Converts a hex string to a binary string.
-    #
-    # @param hex_string [String] string with hexadeimcal value.
-    # @return [String] binary string equivalent of the given hex string.
-    # @raise [ArgumentError] if hex string is an invalid hexadecimal string.
-    def self.hex_to_bin(hex_string)
-      raise ArgumentError, "Invalid hexadecimal string" unless hex_string =~ HEX_REGEXP
-
-      [hex_string].pack('H*')
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Secp256k1
+  # Contains utility methods that complement the functionality of the library.
+  module Util
+    # Regexp to validate a hexadecimal string
+    HEX_REGEXP = /^[A-Fa-f\d]+$/.freeze
+
+    # Converts a binary string to a hex string.
+    #
+    # @param binary_string [String] binary string to be converted.
+    # @return [String] hex string equivalent of the given binary string.
+    def self.bin_to_hex(binary_string)
+      binary_string.unpack('H*').first
+    end
+
+    # Converts a hex string to a binary string.
+    #
+    # @param hex_string [String] string with hexadeimcal value.
+    # @return [String] binary string equivalent of the given hex string.
+    # @raise [ArgumentError] if hex string is an invalid hexadecimal string.
+    def self.hex_to_bin(hex_string)
+      raise ArgumentError, "Invalid hexadecimal string" unless hex_string =~ HEX_REGEXP
+
+      [hex_string].pack('H*')
+    end
+  end
+end

data/lib/rbsecp256k1/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module Secp256k1
-  VERSION = '6.0.1'
-end
+# frozen_string_literal: true
+
+module Secp256k1
+  VERSION = '6.0.2'
+end

data/lib/rbsecp256k1.rb

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-# Wraps libsecp256k1 in a ruby module and provides object interfaces.
-module Secp256k1
-end
-
-require 'rbsecp256k1/context'
-require 'rbsecp256k1/util'
-require 'rbsecp256k1/version'
-
-# The ext directory is where the compiled shared object files go for native
-# extension gems. Rubygems adds this to the LOAD_PATH so we should just need to
-# explicitly require the shared object
-require 'rbsecp256k1/rbsecp256k1'
+# frozen_string_literal: true
+
+# Wraps libsecp256k1 in a ruby module and provides object interfaces.
+module Secp256k1
+end
+
+require 'rbsecp256k1/context'
+require 'rbsecp256k1/util'
+require 'rbsecp256k1/version'
+
+# The ext directory is where the compiled shared object files go for native
+# extension gems. Rubygems adds this to the LOAD_PATH so we should just need to
+# explicitly require the shared object
+require 'rbsecp256k1/rbsecp256k1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbsecp256k1
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.2
 platform: ruby
 authors:
 - Eric Scrivner
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: keccak
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +231,7 @@ files:
 - documentation/xonly_public_key.md
 - ext/rbsecp256k1/extconf.rb
 - ext/rbsecp256k1/rbsecp256k1.c
+- ext/rbsecp256k1/secp256k1_recipe.rb
 - lib/rbsecp256k1.rb
 - lib/rbsecp256k1/context.rb
 - lib/rbsecp256k1/util.rb