frostrb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec10bec048f4bbf00419a36f27e901afb7ca0b12ae20140d827e1e2eaba107e
-  data.tar.gz: 13bce5e0d48b971619c698224e0051162b57b0e08dcc9dabad7eef8a770ecda5
+  metadata.gz: 971ebd8ce7d6cf7faae3a152a2ac1ab89af43ba8317276b1a9595610c543b5b5
+  data.tar.gz: 03b261ac549b8745c35ef35b61a9b5c63534d4043e2b287a58d680c79e510318
 SHA512:
-  metadata.gz: 21d11540bbb90c3f3e0e4e96b17204140b40ee52b783da59d12de0898e64d11ed7a4feefc937fd08dff87c001592c14eed39f4d06757211198581047045aa98f
-  data.tar.gz: ca60c7fd06432c8c8d6b72fd2a5fb77b42e6184f892af8496c1d540d4215c36ca074fef9c5b495ea8bbcd1e675649a166d41a07b8ab64257f520490ae4ffd869
+  metadata.gz: 96d05d23ca3dec9b7d187a4a6ffdda6c78e193d7bf9f56699e0abbb85926d3763a61ceb7b05952fcd16ad748f15a7ad1712c03719ba0ac75ae11613d80cda895
+  data.tar.gz: 8f7a5926c9c755704f8cc13260956c08d4a2ba1f46ed8e20e8ec8786cfc7fe70fad27250d03ce83e64168b99a100f4eaec42c96025e02d1ed1d665be88d998d2

data/README.md

@@ -1,6 +1,6 @@
 # FROST for Ruby [![Build Status](https://github.com/azuchi/frostrb/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/azuchi/frostrb/actions/workflows/main.yml)
 
-This library is ruby implementations of ['Two-Round Threshold Schnorr Signatures with FROST'](https://datatracker.ietf.org/doc/draft-irtf-cfrg-frost/).
+This library is a ruby implementation of ['Two-Round Threshold Schnorr Signatures with FROST'](https://datatracker.ietf.org/doc/draft-irtf-cfrg-frost/).
 
 Note: This library has not been security audited and tested widely, so should not be used in production.
 
@@ -37,20 +37,18 @@ require 'frost'
 # Setup context.
 ctx = FROST::Context.new(ECDSA::Group::Secp256k1, FROST::Type::RFC9591)
 
-# Dealer generate secret.
-secret = FROST::SigningKey.generate(ctx)
-group_pubkey = secret.to_point
+max_signers = 3
+min_signers = 2
 
-# Generate polynomial(f(x) = ax + b)
-polynomial = secret.gen_poly(1)
+# Setup dealer.
+dealer = FROST::Dealer.new(ctx, max_signers, min_signers)
+group_pubkey = dealer.group_public_key
 
 # Calculate secret shares.
-share1 = polynomial.gen_share(1)
-share2 = polynomial.gen_share(2)
-share3 = polynomial.gen_share(3)
+share1, _, share3 = dealer.gen_shares
 
 # Round 1: Generate nonce and commitment
-## each party generate hiding and binding nonce.
+## each party generates hiding and binding nonce.
 hiding_nonce1 = FROST::Nonce.gen_from_secret(share1)
 binding_nonce1 = FROST::Nonce.gen_from_secret(share1)
 hiding_nonce3 = FROST::Nonce.gen_from_secret(share3)
@@ -79,7 +77,7 @@ FROST.verify(sig, group_pubkey, msg)
 
 ### Bitcoin support
 
-When using Bitcoin(taproot), the context type must be `FROST::Type::Taproot` instead of `FROST::Type::RFC9591`.
+When using Bitcoin(taproot), the context type must be `FROST::Type::TAPROOT` instead of `FROST::Type::RFC9591`.
 
 ```ruby
 ctx = FROST::Context.new(ECDSA::Group::Secp256k1, FROST::Type::TAPROOT)
@@ -106,13 +104,13 @@ round1_outputs = {}
   round1_outputs[i] = secret_package.public_package
 end
 
-# Each participant send their commitments and proof to other participants.
+# Each participant sends their commitments and proof to other participants.
 received_package = {}
 1.upto(max_signer) do |i|
   received_package[i] = round1_outputs.select {|k, _| k != i}.values
 end
 
-# Each participant verify knowledge of proof in received package.
+# Each participant verifies knowledge of proof in a received package.
 received_package.each do |id, packages|
   secret_package = secret_packages[id]
   packages.each do |package|
@@ -121,7 +119,7 @@ received_package.each do |id, packages|
 end
 
 # Round 2:
-# Each participant generate share for other participants and send it.
+# Each participant generates a share for other participants and send it.
 received_shares = {}
 1.upto(max_signer) do |i|
   secret_package = secret_packages[i] # own secret
@@ -140,7 +138,7 @@ end
   end
 end
 
-# Each participant computes signing share.
+# Each participant computes a signing share.
 signing_shares = {}
 1.upto(max_signer) do |i|
   shares = received_shares[i].map{|_, share| share}
@@ -159,11 +157,14 @@ Using `FROST::Repairable` module, you can repair existing (or new) participant's
 
 ```ruby
 ctx = FROST::Context.new(ECDSA::Group::Secp256k1, FROST::Type::RFC9591)
-dealer = FROST::SigningKey.generate(ctx)
+max_signers = 5
+min_signers = 3
 
-# Dealer generate shares.
-polynomial = dealer.gen_poly(min_signers - 1)
-shares = 1.upto(max_signers).map {|identifier| polynomial.gen_share(identifier) }
+# Setup daler
+dealer = FROST::SigningKey.generate(ctx, max_signers, min_signers)
+
+# Dealer generates shares.
+shares = dealer.gen_shares
 
 # Signer 2 will lose their share
 # Signers (helpers) 1, 4 and 5 will help signer 2 (participant) to recover their share

data/lib/frost/dealer.rb

@@ -0,0 +1,50 @@
+module FROST
+  # Dealer
+  class Dealer
+    attr_reader :ctx
+    attr_reader :max_signers
+    attr_reader :min_signers
+    attr_reader :polynomial
+
+    # Create a new dealer.
+    # @param [FROST::Context] ctx FROST context.
+    # @param [Integer] max_signers Maximum number of signers.
+    # @return [FROST::Dealer]
+    # @raise [ArgumentError]
+    def initialize(ctx, max_signers, min_signers)
+      raise ArgumentError, "context must be FROST::Context." unless ctx.is_a?(FROST::Context)
+      raise ArgumentError, "min_signers must be Integer." unless min_signers.is_a?(Integer)
+      raise ArgumentError, "min_signers must be greater than 1." if min_signers < 2
+      raise ArgumentError, "max_signers must be Integer." unless max_signers.is_a?(Integer)
+      raise ArgumentError, "max_signers must be greater than or equal to min_signers." if max_signers < min_signers
+      @ctx = ctx
+      @min_signers = min_signers
+      @max_signers = max_signers
+      key = SigningKey.generate(ctx)
+      @polynomial = key.gen_poly(min_signers - 1)
+    end
+
+    # Generate shares.
+    # @return [Array] Array of shares(FROST::SecretShare).
+    # @raise [ArgumentError]
+    def gen_shares(identifiers = nil)
+      raise ArgumentError, "identifiers must be Array." if identifiers && !identifiers.is_a?(Array)
+      identifiers = if identifiers
+                      identifiers.each do |id|
+                        raise ArgumentError, "identifier must be Integer." unless id.is_a?(Integer)
+                        raise ArgumentError, "identifier must be greater than 0." if id < 1
+                      end
+                      identifiers
+                    else
+                      (1..max_signers).to_a
+                    end
+      identifiers.map{ |i| polynomial.gen_share(i) }
+    end
+
+    # Get a group public key.
+    # @return [ECDSA::Point]
+    def group_public_key
+      polynomial.verification_point
+    end
+  end
+end

data/lib/frost/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FROST
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/frost.rb

@@ -17,6 +17,7 @@ module FROST
   autoload :SecretShare, "frost/secret_share"
   autoload :Polynomial, "frost/polynomial"
   autoload :SigningKey, "frost/signing_key"
+  autoload :Dealer, "frost/dealer"
   autoload :DKG, "frost/dkg"
   autoload :Repairable, "frost/repairable"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: frostrb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - azuchi
 bindir: exe
 cert_chain: []
-date: 2025-05-15 00:00:00.000000000 Z
+date: 2025-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa_ext
@@ -59,6 +59,7 @@ files:
 - lib/frost.rb
 - lib/frost/commitments.rb
 - lib/frost/context.rb
+- lib/frost/dealer.rb
 - lib/frost/dkg.rb
 - lib/frost/dkg/public_package.rb
 - lib/frost/dkg/secret_package.rb