sr25519 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93fc6ca0e55ea4d15ae49a88cb2038384901fec0a71a617a447495f63e178729
-  data.tar.gz: affe4dfe032464e979efe50bac31ee4f09e670b979ae2e11ed12d6ea37043e38
+  metadata.gz: 5948eb9d27ac12e520fca97d30f2e94c9a344fc4f8f957e716f34effd37c0a4c
+  data.tar.gz: e3bcbabc050fffffdb7e1d337766b5dcc90c58ca5784cf5eb66c2a81aba56da9
 SHA512:
-  metadata.gz: 2aab04310f8565ac93f2b805df811fc9410f54605f7d461843c7763321465c169544b88eb7c49f47ddbacc681025a1848b1c0fe4a4a08704be16599407d39ffc
-  data.tar.gz: 6a9382481ace7d5daeaa59f5cfd3acf131f9745a5bcbeb2d508b38f8f4b2c2edb89fa539356a9d0efdc57e9542d6268f04bd9e100e16cde22d53a4cfa9cfcb3f
+  metadata.gz: 23c8de81f3e235f3fc3e0f8a8ce02a6f9ddb14b95722745349c406433fdf5bb13aedb38cdd07200413f396c85766f428f110a49e8f6b014e2c3741cb86ff4146
+  data.tar.gz: e38310955f4aeae6d7d09dddb2961e3c7acd5a01443b72d41f0f57890d3a2bdc91d922c24b084efa9d79b670e9d6c0bc714167122314e59e546018c827ecc74b

data/.github/workflows/ruby.yml

@@ -0,0 +1,50 @@
+name: Docker
+
+on:
+  push:
+
+    # Publish `v1.2.3` tags as releases.
+    tags:
+      - v*
+
+env:
+  # TODO: Change variable to your image's name.
+  IMAGE_NAME: sr25519
+
+jobs:
+
+  # Push image to GitHub Packages.
+  # See also https://docs.docker.com/docker-hub/builds/
+  push:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build image
+        run: docker build . --file Dockerfile --tag $IMAGE_NAME
+
+      - name: Log into registry
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Push image
+        run: |
+          IMAGE_ID=uniart/$IMAGE_NAME
+          # Change all uppercase to lowercase
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+          # Strip git ref prefix from version
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+          # Strip "v" prefix from tag name
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+          # Use Docker `latest` tag convention
+          [ "$VERSION" == "master" ] && VERSION=latest
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION
+          docker tag $IMAGE_NAME $IMAGE_ID:latest
+          docker push $IMAGE_ID:latest

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    sr25519 (0.1.0)
+    sr25519 (0.6.0)
       base58
       blake2b
+      ed25519 (~> 1.2, >= 1.2.4)
 
 GEM
   remote: https://rubygems.org/
@@ -11,6 +12,7 @@ GEM
     base58 (0.2.3)
     blake2b (0.10.0)
     diff-lcs (1.4.4)
+    ed25519 (1.2.4)
     ffi (1.15.4)
     rake (13.0.6)
     rspec (3.10.0)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 xuxh
+Copyright (c) 2021 UniArts Network
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # Sr25519
 
-This is a ruby libraray for Sr25519.
+This is a ruby libraray for Sr25519. Use to sign and verify message.
 
 More info at: https://github.com/w3f/schnorrkel
 
@@ -22,15 +22,21 @@ Or install it yourself as:
 
 ## Usage
 
-1.  keypair
+#### 1. Require ed25519.rb in your Ruby program:
+```ruby
+require "sr25519"
+```
+
+#### 2. SR25519 Generate keypair
 
 ```ruby
 # seed is priviate key, is a hex string.
-keypaire = SR25519.sr25519_keypair_from_seed(seed)
+# example: SR25519.keypair_from_seed("0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e")
+keypair = SR25519.keypair_from_seed(seed)
 
 ```
 
-2. public_key
+#### 3. SR25519 Generate public_key
 
 ```ruby
 public_key = SR25519.get_public_key_from_seed(seed)
@@ -40,30 +46,49 @@ public_key_str = public_key.to_s
 
 ```
 
-3. encode address
+#### 4. Encode address
 ```ruby
 address = Address.encode(public_key.to_s)
 ```
 
-4. decode address
+#### 5. Decode address
 
 ```ruby
 address = Address.decode(address)
 ```
 
-5. sign
+#### 6. SR25519 Sign message
 
 ```ruby
 signature_result = SR25519.sign(message, keypair)
 
 ```
 
-6. verify
+#### 7. SR25519 Verify message
+
+```ruby
+verify_result = SR25519.verify(address, message, signature_result)
+```
+
+#### 8.  ED25519 Generate keypair
+
+```ruby
+keypair = ED25519.keypair_from_seed(seed)
+```
+
+#### 9.  ED25519 Sign message
+
+```ruby
+signature_result = ED25519.sign(message, keypair)
+```
+
+#### 10. ED25519 Verify message
 
 ```ruby
-SR25519.verify(address, message, signature_result)
+verify_result = ED25519.verify(address, message, signature_result)
 ```
 
+
 ## Running tests
 1. Run all tests
 
@@ -74,13 +99,13 @@ rspec
 
 ## Docker
 
-1. update to latest image
+1. Update to latest image
 
-   `docker pull uni-arts-chain/sr25519:latest`
+   `docker pull uniart/sr25519:latest`
 
 2. Run image:
 
-   `docker run -it uni-arts-chain/sr25519:latest`
+   `docker run -it uniart/sr25519:latest bash`
 
    This  will enter the container with a linux shell opened. 
 

data/lib/ed25519_lib.rb

@@ -0,0 +1,38 @@
+require "ed25519"
+class ED25519
+  
+  # Creates a signature for given data
+  def self.sign(message, key_pair)
+    "0x" + key_pair.sign(message).unpack1("H*")
+  end
+
+  def self.verify(address, message, signature_result)
+    if signature_result.start_with?("0x")
+      signature_result = signature_result.sub(/0x/, "")
+    end
+    signature = [signature_result].pack("H*")
+    public_key = Address.decode(address)
+    verify_key_bytes = [public_key].pack("H*")
+    verify_key  = Ed25519::VerifyKey.new(verify_key_bytes)
+    begin
+      verify_key.verify(signature, message)
+    rescue
+      return false
+    end
+  end
+
+  def self.keypair_from_seed(seed)
+    if seed.start_with?("0x")
+      seed = seed.sub(/0x/, "")
+    end
+    seed = "".tap { |binary| seed.scan(/../) { |hn| binary << hn.to_i(16).chr } }
+    signing_key = Ed25519::SigningKey.new(seed)
+    return signing_key
+  end
+
+  def self.get_public_key_from_seed(seed)
+    signing_key = self.keypair_from_seed(seed)
+    return signing_key.verify_key.to_bytes.unpack1('H*')
+  end
+
+end

data/lib/sr25519/version.rb

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

data/lib/sr25519.rb

@@ -3,6 +3,7 @@
 require_relative "sr25519/version"
 require "address"
 require "sr25519_lib"
+require "ed25519_lib"
 
 module Sr25519
   class Error < StandardError; end

data/lib/sr25519_lib.rb

@@ -6,8 +6,8 @@ module SR25519Lib
   ffi_lib FFI::Library::LIBC
 
   # The library is compile from https://github.com/Warchant/sr25519-crust
-  ffi_lib [File.expand_path('lib/libsr25519crust.so')] if RUBY_PLATFORM =~ /linux/
-  ffi_lib [File.expand_path('lib/libsr25519crust.dylib')] if RUBY_PLATFORM =~ /darwin/
+  ffi_lib File.dirname(__FILE__) + '/libsr25519crust.so' if RUBY_PLATFORM =~ /linux/
+  ffi_lib File.dirname(__FILE__) + '/libsr25519crust.dylib' if RUBY_PLATFORM =~ /darwin/
 
   attach_function :sr25519_keypair_from_seed, [:pointer, :pointer], :void
   attach_function :sr25519_verify, [:pointer, :pointer, :uint, :pointer], :bool
@@ -65,7 +65,7 @@ class SR25519
   def self.sr25519_sign(message, private_key)
     sig = SigMessage.new
     msg = FFI::MemoryPointer.from_string(message)
-    key_pair = self.sr25519_keypair_from_seed(private_key)
+    key_pair = self.keypair_from_seed(private_key)
     public_key = key_pair.public_key
     SR25519Lib.sr25519_sign(sig, public_key, key_pair, msg, message.length)
     sig.to_s
@@ -94,10 +94,13 @@ class SR25519
     end
     signature_result = [signature_result].pack("H*").unpack("C*")
     sig[:String].to_ptr.write_array_of_uint8(signature_result)
-    verify = SR25519Lib.verify(sig, msg, message.size, pk)
+    verify = SR25519Lib.sr25519_verify(sig, msg, message.size, pk)
   end
 
-  def self.sr25519_keypair_from_seed(seed)
+  def self.keypair_from_seed(seed)
+    if seed.start_with?("0x")
+      seed = seed.sub(/0x/, "")
+    end
     seed_array = [seed].pack("H*").unpack("C*")
     seed = Seed.new
     seed[:String].to_ptr.write_array_of_uint8(seed_array)
@@ -107,7 +110,7 @@ class SR25519
   end
 
   def self.get_public_key_from_seed(seed)
-    key_pair = self.sr25519_keypair_from_seed(seed)
+    key_pair = self.keypair_from_seed(seed)
     key_pair.public_key
   end
 

data/sr25519.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "blake2b"
   spec.add_dependency "base58"
   spec.add_development_dependency "ffi", "~> 1.15.0"
-
+  spec.add_dependency "ed25519", '~> 1.2', '>= 1.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sr25519
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - xuxh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.4
 description: Sign and verify message with sr25519
 email:
 - xxh2611@gmail.com
@@ -87,6 +107,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md
@@ -99,6 +120,7 @@ files:
 - bin/console
 - bin/setup
 - lib/address.rb
+- lib/ed25519_lib.rb
 - lib/libsr25519crust.dylib
 - lib/libsr25519crust.so
 - lib/sr25519.rb