sr25519 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5948eb9d27ac12e520fca97d30f2e94c9a344fc4f8f957e716f34effd37c0a4c
-  data.tar.gz: e3bcbabc050fffffdb7e1d337766b5dcc90c58ca5784cf5eb66c2a81aba56da9
+  metadata.gz: b113b67bbe4a743dfe19a186d10bf4e12b929037e9f11c80628205d5d20a8d1a
+  data.tar.gz: fd5d5f843cdd92ceba67cb1128f410425810641fc417915bfeb1cf79d41088b4
 SHA512:
-  metadata.gz: 23c8de81f3e235f3fc3e0f8a8ce02a6f9ddb14b95722745349c406433fdf5bb13aedb38cdd07200413f396c85766f428f110a49e8f6b014e2c3741cb86ff4146
-  data.tar.gz: e38310955f4aeae6d7d09dddb2961e3c7acd5a01443b72d41f0f57890d3a2bdc91d922c24b084efa9d79b670e9d6c0bc714167122314e59e546018c827ecc74b
+  metadata.gz: a54153363c366648db12f5b10f3afa383ba368d412623c813c095033832f7c74c07b7bfd9fcb373296aa227ac9fd93d2a90a8dea2d7c74ad843691d7d408e3b0
+  data.tar.gz: 18cf9d2b4f91774660e598e82114ec789bca49fcf2e29ecdd17cfc5b6c751edaf915c6a75d7717d1d2c229288ade84570ac625ed47a6c985aa81d89e3383cbcc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sr25519 (0.6.0)
+    sr25519 (0.7.0)
       base58
       blake2b
       ed25519 (~> 1.2, >= 1.2.4)

data/README.md

@@ -54,12 +54,13 @@ address = Address.encode(public_key.to_s)
 #### 5. Decode address
 
 ```ruby
-address = Address.decode(address)
+public_key_str = Address.decode(address)
 ```
 
 #### 6. SR25519 Sign message
 
 ```ruby
+# message = "Hello World"
 signature_result = SR25519.sign(message, keypair)
 
 ```
@@ -82,9 +83,17 @@ keypair = ED25519.keypair_from_seed(seed)
 signature_result = ED25519.sign(message, keypair)
 ```
 
-#### 10. ED25519 Verify message
+#### 10. ED25519 Get public key
 
 ```ruby
+pulick_key_str = ED25519.get_public_key_from_seed(seed)
+```
+
+#### 11. ED25519 Verify message
+
+```ruby
+# public_key_str = ED25519.get_public_key_from_seed(seed)
+# address = Address.encode(public_key_str)
 verify_result = ED25519.verify(address, message, signature_result)
 ```
 

data/lib/address.rb

@@ -1,7 +1,30 @@
+
+# The MIT License (MIT)
+
+# Copyright (c) 2019 Wu Minzhe
+
+# 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.
+
 require 'base58'
 require 'blake2b'
 
- # The code is copy from https://github.com/itering/scale.rb/blob/develop/lib/common.rb
+# The code is copy from https://github.com/itering/scale.rb/blob/develop/lib/common.rb
 class Address
     SS58_PREFIX = 'SS58PRE'
   

data/lib/ed25519_lib.rb

@@ -1,11 +1,29 @@
 require "ed25519"
 class ED25519
   
-  # Creates a signature for given data
+  ##
+  # Sign the given message, Return sign result as hex string
+  # ==== Examples
+  #   message = "Hello world"
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = ED25519.keypair_from_seed(seed)
+  #   signature_result = ED25519.sign(message, keypair)
+
   def self.sign(message, key_pair)
     "0x" + key_pair.sign(message).unpack1("H*")
   end
 
+  ##
+  # Verify the sign result, Return true or false
+  # ==== Examples
+  #   message = "Hello world"
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   public_key = ED25519.get_public_key_from_seed(seed)
+  #   address = Address.encode(public_key)
+  #   keypair = ED25519.keypair_from_seed(seed)
+  #   signature_result = ED25519.sign(message, keypair)
+  #   verify_result = ED25519.verify(address, message, signature_result)
+
   def self.verify(address, message, signature_result)
     if signature_result.start_with?("0x")
       signature_result = signature_result.sub(/0x/, "")
@@ -21,6 +39,12 @@ class ED25519
     end
   end
 
+  ##
+  # Generate ED25519 keypair
+  # ==== Examples
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = ED25519.keypair_from_seed(seed)
+
   def self.keypair_from_seed(seed)
     if seed.start_with?("0x")
       seed = seed.sub(/0x/, "")
@@ -30,6 +54,12 @@ class ED25519
     return signing_key
   end
 
+  ##
+  # Get ED25519 public key, return as hex string
+  # ==== Examples
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   public_key = ED25519.get_public_key_from_seed(seed)
+
   def self.get_public_key_from_seed(seed)
     signing_key = self.keypair_from_seed(seed)
     return signing_key.verify_key.to_bytes.unpack1('H*')

data/lib/sr25519/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sr25519
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/sr25519_lib.rb

@@ -5,7 +5,6 @@ module SR25519Lib
  
   ffi_lib FFI::Library::LIBC
 
-  # The library is compile from https://github.com/Warchant/sr25519-crust
   ffi_lib File.dirname(__FILE__) + '/libsr25519crust.so' if RUBY_PLATFORM =~ /linux/
   ffi_lib File.dirname(__FILE__) + '/libsr25519crust.dylib' if RUBY_PLATFORM =~ /darwin/
 
@@ -19,6 +18,8 @@ class KeyPair < FFI::Struct
   # [32b key | 32b nonce | 32b public]
   layout :String, [:uint8, 96]
 
+  ##
+  # Return the keypair public key
   def public_key
     pub_key = self[:String].to_a[64..96]
     public_key = PublicKey.new
@@ -55,6 +56,8 @@ end
 class SigMessage < FFI::Struct
   layout :String, [:uint8, 64]
 
+  ##
+  # Return the sign message as hex string
   def to_s
     self[:String].to_a.pack("c*").unpack1("H*")
   end
@@ -62,6 +65,12 @@ end
 
 class SR25519
 
+  ##
+  # Return the sign message result as hex string
+  # ==== Examples
+  #   message = "Hello World"
+  #   private_key = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   signature_result = SR25519.sr25519_sign(message, private_key)
   def self.sr25519_sign(message, private_key)
     sig = SigMessage.new
     msg = FFI::MemoryPointer.from_string(message)
@@ -71,8 +80,13 @@ class SR25519
     sig.to_s
   end
 
-
-  # Creates a signature for given data
+  ##
+  # Return the sign message result as hex string
+  # ==== Examples
+  #   message = "Hello World"
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = SR25519.keypair_from_seed(seed)
+  #   signature_result = SR25519.sign(message, keypair)
   def self.sign(message, key_pair)
     sig = SigMessage.new
     msg = FFI::MemoryPointer.from_string(message)
@@ -81,6 +95,16 @@ class SR25519
     sig.to_s
   end
 
+  ##
+  # Verify the sign result, Return true or false
+  # ==== Examples
+  #   message = "Hello World"
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = SR25519.keypair_from_seed(seed)
+  #   public_key = SR25519.get_public_key_from_seed(seed)
+  #   address = Address.encode(public_key.to_s)
+  #   signature_result = SR25519.sign(message, keypair)
+  #   verify_result = SR25519.verify(address, message, signature_result)
   def self.verify(address, message, signature_result)
     pk = PublicKey.new
     public_key = self.decode_address(address)
@@ -97,6 +121,11 @@ class SR25519
     verify = SR25519Lib.sr25519_verify(sig, msg, message.size, pk)
   end
 
+  ##
+  # Generate SR25519 keypair
+  # ==== Examples
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = SR25519.keypair_from_seed(seed)
   def self.keypair_from_seed(seed)
     if seed.start_with?("0x")
       seed = seed.sub(/0x/, "")
@@ -109,11 +138,23 @@ class SR25519
     return key_pair
   end
 
+  ##
+  # Get SR25519 public key, need call to_s to get hex string
+  # ==== Examples
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   public_key = SR25519.get_public_key_from_seed(seed)
   def self.get_public_key_from_seed(seed)
     key_pair = self.keypair_from_seed(seed)
     key_pair.public_key
   end
 
+  ##
+  # Get public from address
+  # ==== Examples
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   public_key = SR25519.get_public_key_from_seed(seed)
+  #   address = Address.encode(public_key.to_s)
+  #   public_key = SR25519.decode_address(address)
   def self.decode_address(address,addr_type=42)
     public_address = Address.decode(address,addr_type)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sr25519
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - xuxh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-13 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake