sr25519 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b113b67bbe4a743dfe19a186d10bf4e12b929037e9f11c80628205d5d20a8d1a
-  data.tar.gz: fd5d5f843cdd92ceba67cb1128f410425810641fc417915bfeb1cf79d41088b4
+  metadata.gz: f850eb36c7764e13d17631a64774c526e4358d6943d22148e8fe73ef3dc4fba1
+  data.tar.gz: 23599472953b497a43cd86b4f3352315bb5b5fca9b8ee26fead4c8f3ee50a672
 SHA512:
-  metadata.gz: a54153363c366648db12f5b10f3afa383ba368d412623c813c095033832f7c74c07b7bfd9fcb373296aa227ac9fd93d2a90a8dea2d7c74ad843691d7d408e3b0
-  data.tar.gz: 18cf9d2b4f91774660e598e82114ec789bca49fcf2e29ecdd17cfc5b6c751edaf915c6a75d7717d1d2c229288ade84570ac625ed47a6c985aa81d89e3383cbcc
+  metadata.gz: 868da7d03a1d747a65d093704c160f37e61714aa273f186da73ed38587ccd08bbfbc20df40e2d6344ee2d305a2f83f7d6e1876fe4ed5433dd60faf8ec53a5962
+  data.tar.gz: 97679a83b7680568aaf8a709ce165fd24af6e048e114b4a43b75c06971abf5eedbfb2ac0aa717e3ac50f4df9c3cdc8440149ac08b75f9f7f835eaed6262ca4bd

data/Gemfile.lock

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

data/lib/ed25519_lib.rb

@@ -1,9 +1,11 @@
 require "ed25519"
 class ED25519
   
-  ##
-  # Sign the given message, Return sign result as hex string
-  # ==== Examples
+  # Sign the given message
+  # @param message [String] the message
+  # @param key_pair [Class] ED25519 keypair
+  # @return [String] sign result as a hex string
+  # @example
   #   message = "Hello world"
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   keypair = ED25519.keypair_from_seed(seed)
@@ -14,8 +16,11 @@ class ED25519
   end
 
   ##
-  # Verify the sign result, Return true or false
-  # ==== Examples
+  # Verify the sign result
+  # @param message [String] the message
+  # @param key_pair [Class] ED25519 keypair
+  # @return [String] sign result as a hex string
+  # @example
   #   message = "Hello world"
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   public_key = ED25519.get_public_key_from_seed(seed)
@@ -41,7 +46,9 @@ class ED25519
 
   ##
   # Generate ED25519 keypair
-  # ==== Examples
+  # @param seed [String] private key
+  # @return [Class] ED25519 keypair
+  # @example
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   keypair = ED25519.keypair_from_seed(seed)
 
@@ -55,8 +62,10 @@ class ED25519
   end
 
   ##
-  # Get ED25519 public key, return as hex string
-  # ==== Examples
+  # Get ED25519 public key
+  # @param seed [String] private key
+  # @return [String] public key
+  # @example
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   public_key = ED25519.get_public_key_from_seed(seed)
 

data/lib/sr25519/version.rb

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

data/lib/sr25519_lib.rb

@@ -65,9 +65,11 @@ end
 
 class SR25519
 
-  ##
-  # Return the sign message result as hex string
-  # ==== Examples
+  # Sign message result
+  # @param message [String] message
+  # @param private_key [String] private_key
+  # @return [String] sign result
+  # @example
   #   message = "Hello World"
   #   private_key = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   signature_result = SR25519.sr25519_sign(message, private_key)
@@ -80,9 +82,11 @@ class SR25519
     sig.to_s
   end
 
-  ##
-  # Return the sign message result as hex string
-  # ==== Examples
+  # Sign message result
+  # @param message [String] message
+  # @param key_pair [KeyPair] Sr25519 keypair
+  # @return [String] sign result
+  # @example
   #   message = "Hello World"
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   keypair = SR25519.keypair_from_seed(seed)
@@ -95,9 +99,12 @@ class SR25519
     sig.to_s
   end
 
-  ##
-  # Verify the sign result, Return true or false
-  # ==== Examples
+  # Verify the sign result
+  # @param address [String] account address
+  # @param message [String] message
+  # @param signature_result [String] Sr25519 sign result
+  # @return [boolean] sign result
+  # @example
   #   message = "Hello World"
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   keypair = SR25519.keypair_from_seed(seed)
@@ -121,9 +128,10 @@ class SR25519
     verify = SR25519Lib.sr25519_verify(sig, msg, message.size, pk)
   end
 
-  ##
   # Generate SR25519 keypair
-  # ==== Examples
+  # @param seed [String] private key
+  # @return [KeyPair] SR25519 keypair
+  # @example
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   keypair = SR25519.keypair_from_seed(seed)
   def self.keypair_from_seed(seed)
@@ -138,9 +146,10 @@ class SR25519
     return key_pair
   end
 
-  ##
-  # Get SR25519 public key, need call to_s to get hex string
-  # ==== Examples
+  # Get SR25519 public key
+  # @param seed [String] private key
+  # @return [String] public key
+  # @example
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   public_key = SR25519.get_public_key_from_seed(seed)
   def self.get_public_key_from_seed(seed)
@@ -148,9 +157,11 @@ class SR25519
     key_pair.public_key
   end
 
-  ##
-  # Get public from address
-  # ==== Examples
+  # Get SR25519 public key
+  # @param address [String] account address
+  # @param addr_type [Interger] address type
+  # @return [String] public key
+  # @example
   #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
   #   public_key = SR25519.get_public_key_from_seed(seed)
   #   address = Address.encode(public_key.to_s)

data/sr25519.gemspec

@@ -28,6 +28,9 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.extra_rdoc_files = [
+    "README.md"
+  ]
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.2"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sr25519
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - xuxh
@@ -105,7 +105,8 @@ email:
 - xxh2611@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"