quorum_sdk 0.2.0 → 0.3.0

data/lib/quorum_sdk/client.rb

@@ -1,23 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'api/light_node'
-
 module QuorumSdk
   # HTTP Client wrapper
   class Client
     attr_reader :domains
 
-    def initialize(domains)
-      @domains = domains || []
-      uri = Addressable::URI.parse @domains.first
+    def initialize(chain_url, jwt = nil)
+      chain_url =
+        case chain_url
+        when Array
+          chain_url.first
+        when String
+          chain_url
+        end
+
+      uri = Addressable::URI.parse chain_url
       url = Addressable::URI.new(scheme: uri.scheme, host: uri.host, port: uri.port).to_s
-      jwt = uri.query_values['jwt']
+      jwt ||= uri.query_values['jwt']
 
-      @conn = Faraday.new(url:, headers: { Authorization: "Bearer #{jwt}" }) do |f|
-        f.request :json
-        f.response :json
-        f.response :logger
-      end
+      @conn =
+        Faraday.new(
+          url:,
+          headers: { Authorization: "Bearer #{jwt}" }
+        ) do |f|
+          f.request :json
+          f.response :json
+          f.response :logger
+        end
     end
 
     def post(path, **body)

data/lib/quorum_sdk/node/announce.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module QuorumSdk
+  class Node
+    # Announce module
+    module Announce
+      def announce(**kwargs)
+        group_id = kwargs[:group_id] || @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        payload = {
+          data: {
+            Action: kwargs[:action],
+            AnnouncerSignature: kwargs[:announce_signature],
+            EncryptPubkey: kwargs[:encrypt_pubkey],
+            GroupId: group_id,
+            Memo: kwargs[:memo],
+            OwnerPubkey: kwargs[:owner_pubkey],
+            OwnerSignature: kwargs[:owner_signature],
+            Result: kwargs[:result],
+            SignPubkey: kwargs[:sign_pubkey],
+            TimeStamp: kwargs[:timestamp],
+            Type: kwargs[:type]
+          }
+        }
+
+        path = "/api/v1/node/#{group_id}/announce"
+        client.post(path, **payload).body
+      end
+
+      def announced_producers(group_id: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        path = "/api/v1/node/#{group_id}/announced/producer"
+        client.get(path).body
+      end
+
+      def announced_users(group_id: nil, pubkey: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        params = {
+          pubkey:
+        }.compact
+
+        path = "/api/v1/node/#{group_id}/announced/user"
+        client.get(path, **params).body
+      end
+    end
+  end
+end

data/lib/quorum_sdk/node/app_config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module QuorumSdk
+  class Node
+    # Appconfig module
+    module AppConfig
+      def app_config(key, group_id: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+        raise ArgumentError, 'key must be provided' if key.blank?
+
+        path = "api/v1/node/#{group_id}/appconfig/by/#{key}"
+        client.get(path).body
+      end
+
+      def app_config_keys(group_id: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        path = "api/v1/node/#{group_id}/appconfig/keylist"
+        client.get(path).body
+      end
+    end
+  end
+end

data/lib/quorum_sdk/node/auth.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module QuorumSdk
+  class Node
+    # Auth module
+    module Auth
+      def allow_list(group_id: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        path = "api/v1/node/#{group_id}/auth/alwlist"
+        client.get(path).body
+      end
+
+      def deny_list(group_id: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        path = "api/v1/node/#{group_id}/auth/denylist"
+        client.get(path).body
+      end
+
+      def auth_type(group_id: nil, trx_type: 'POST')
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        path = "api/v1/node/#{group_id}/auth/by/#{trx_type}"
+        client.get(path).body
+      end
+    end
+  end
+end

data/lib/quorum_sdk/node/group.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module QuorumSdk
+  class Node
+    # group module
+    module Group
+      def info(group_id: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        path = "api/v1/node/#{group_id}/info"
+        client.get(path).body
+      end
+
+      def producers(group_id: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        path = "api/v1/node/#{group_id}/producers"
+        client.get(path).body
+      end
+
+      def user_encrypt_pubkeys(group_id: nil)
+        group_id ||= @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        path = "api/v1/node/#{group_id}/userencryptpubkeys"
+        client.get(path).body
+      end
+    end
+  end
+end

data/lib/quorum_sdk/node/trx.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module QuorumSdk
+  class Node
+    # Wrapper for HTTP APIs as light node client
+    module Trx
+      ARGUMENTS_FOR_BUILD_TRX = %i[private_key data].freeze
+      def build_trx(**kwargs)
+        group_id = kwargs[:group_id] || @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        cipher_key = kwargs[:cipher_key] || @cipher_key
+        raise ArgumentError, 'cipher_key must be provided' if cipher_key.blank?
+
+        raise ArgumentError, "Keyword arguments #{ARGUMENTS_FOR_BUILD_TRX} must be provided" unless ARGUMENTS_FOR_BUILD_TRX.all?(&->(arg) { arg.in? kwargs.keys })
+
+        kwargs = kwargs.merge(
+          group_id:,
+          cipher_key:
+        )
+        QuorumSdk::Utils.build_trx(**kwargs)
+      end
+
+      ARGUMENTS_FOR_SEND_TRX = %i[data sender_pubkey sender_sign trx_id version].freeze
+      def send_trx(trx = nil, **kwargs)
+        trx ||= kwargs
+        raise ArgumentError, "Keyword arguments #{ARGUMENTS_FOR_SEND_TRX} must be provided" unless ARGUMENTS_FOR_SEND_TRX.all?(&->(arg) { arg.in? trx.keys })
+
+        group_id = trx[:group_id] || @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        payload = {
+          data: trx[:data],
+          sender_pubkey: trx[:sender_pubkey],
+          sender_sign: trx[:sender_sign],
+          timestamp: trx[:time_stamp] || trx[:timestamp],
+          trx_id: trx[:trx_id],
+          version: trx[:version]
+        }.compact
+        payload.deep_transform_values!(&->(v) { v.is_a?(String) ? v : v.to_s })
+
+        path = "api/v1/node/#{group_id}/trx"
+        client.post(path, **payload).body
+      end
+
+      def list_trx(**kwargs)
+        group_id = kwargs[:group_id] || @group_id
+        raise ArgumentError, 'group_id must be provided' if group_id.blank?
+
+        cipher_key = kwargs[:cipher_key] || @cipher_key
+
+        params = {
+          group_id:,
+          start_trx: kwargs[:start_trx],
+          num: kwargs[:num] || 100,
+          senders: kwargs[:senders],
+          reverse: kwargs[:reverse],
+          include_start_trx: kwargs[:include_start_trx]
+        }.compact
+
+        path = "api/v1/node/#{group_id}/groupctn"
+        list = client.get(path, **params).body
+
+        return list unless list.is_a?(Array)
+        return list if cipher_key.blank?
+
+        list.each do |trx|
+          next if trx['Data'].blank?
+
+          data = Base64.strict_decode64 trx['Data']
+          trx['DecryptedData'] = QuorumSdk::Utils.decrypt_trx_data data, key: cipher_key
+        end
+
+        list
+      end
+    end
+  end
+end

data/lib/quorum_sdk/node.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+require_relative 'node/announce'
+require_relative 'node/app_config'
+require_relative 'node/auth'
+require_relative 'node/group'
+require_relative 'node/trx'
+
+module QuorumSdk
+  # Wrapper for HTTP APIs as light node client
+  class Node
+    attr_reader :group_id, :group_name, :consensus_type, :encryption_type, :app_key, :owner_pubkey, :signature,
+                :cipher_key, :chain_url, :jwt, :client
+
+    def initialize(**kwargs)
+      config =
+        if kwargs[:seed].present?
+          QuorumSdk::Utils.parse_seed kwargs[:seed]
+        else
+          kwargs
+        end
+
+      @group_id = config[:group_id]
+      @group_name = config[:group_name]
+      @consensus_type = config[:consensus_type]
+      @encryption_type = config[:encryption_type]
+      @app_key = config[:app_key]
+      @owner_pubkey = config[:owner_pubkey]
+      @signature = config[:signature]
+      @cipher_key = config[:cipher_key]
+      @chain_url = config[:chain_url]
+      @jwt = config[:jwt]
+
+      @client = QuorumSdk::Client.new(@chain_url, @jwt)
+    end
+
+    include QuorumSdk::Node::Announce
+    include QuorumSdk::Node::AppConfig
+    include QuorumSdk::Node::Auth
+    include QuorumSdk::Node::Group
+    include QuorumSdk::Node::Trx
+  end
+end

data/lib/quorum_sdk/utils.rb

@@ -3,8 +3,10 @@
 module QuorumSdk
   # Wrapper for some useful methods
   module Utils
+    TRX_VERSION = '2.0.0'
+
     class << self
-      def parse_seed_url(url)
+      def parse_seed(url)
         url = Addressable::URI.parse(url.gsub(/\\u([a-f0-9]{4})/i) { [::Regexp.last_match(1).hex].pack('U') })
         query_values = url.query_values
 
@@ -17,7 +19,7 @@ module QuorumSdk
         app_key = query_values['y']
         consensus_type = query_values['n'].to_s == '1' ? 'pos' : 'poa'
         encryption_type = query_values['e'].to_s == '0' ? 'public' : 'private'
-        chain_urls = query_values['u'].split('|')
+        chain_url = query_values['u'].split('|')
 
         {
           group_id:,
@@ -29,7 +31,7 @@ module QuorumSdk
           app_key:,
           consensus_type:,
           encryption_type:,
-          chain_urls:
+          chain_url:
         }
       end
 
@@ -48,7 +50,7 @@ module QuorumSdk
       end
 
       ARGUMENTS_FOR_ENCRYPT_TRX = %i[private_key group_id cipher_key data].freeze
-      def encrypt_trx(**kwargs)
+      def build_trx(**kwargs)
         raise ArgumentError, "Keyword arguments #{ARGUMENTS_FOR_ENCRYPT_TRX} must be provided" unless ARGUMENTS_FOR_ENCRYPT_TRX.all?(&->(arg) { arg.in? kwargs.keys })
 
         data =
@@ -58,29 +60,52 @@ module QuorumSdk
           else
             kwargs[:data].to_s
           end
-        encrypted_data = aes_encrypt data, key: kwargs[:cipher_key]
+        encrypted_data = aes_encrypt(data, key: kwargs[:cipher_key])
 
         account = QuorumSdk::Account.new priv: kwargs[:private_key]
 
-        msg =
+        trx =
           Quorum::Pb::Trx.new(
             TrxId: (kwargs[:trx_id] || SecureRandom.uuid),
             GroupId: kwargs[:group_id],
             Data: encrypted_data,
-            TimeStamp: (kwargs[:timestamp].to_i || (Time.now.to_f * 1e9).to_i),
+            TimeStamp: (kwargs[:timestamp].presence || (Time.now.to_f * 1e9)).to_i,
             Version: (kwargs[:version] || TRX_VERSION),
-            Expired: (kwargs[:expired].to_i || (30.seconds.from_now.to_f * 1e9).to_i),
             SenderPubkey: Base64.urlsafe_encode64(account.public_bytes_compressed, padding: false)
           )
 
-        hash = Digest::SHA256.hexdigest msg.to_proto
+        hash = Digest::SHA256.hexdigest trx.to_proto
         signature = account.sign [hash].pack('H*')
-        msg.SenderSign = [signature].pack('H*')
-        trx_json = {
-          TrxBytes: Base64.strict_encode64(msg.to_proto)
-        }
-        encrypted = aes_encrypt trx_json.to_json, key: kwargs[:cipher_key]
-        Base64.strict_encode64 encrypted
+        trx.SenderSign = [signature].pack('H*')
+
+        json = Quorum::Pb::Trx.encode_json trx
+        JSON.parse(json).deep_transform_keys! { |key| key.to_s.underscore.to_sym }
+      end
+
+      def verify_trx(trx = nil, **kwargs)
+        trx ||= kwargs
+        trx.deep_transform_keys! { |key| key.to_s.camelize.to_sym }
+        trx = trx.with_indifferent_access
+        trx['TimeStamp'] = trx['TimeStamp'].to_i if trx['TimeStamp'].present? && trx['TimeStamp'].is_a?(String)
+        trx['Expired'] = trx['Expired'].to_i if trx['Expired'].present? && trx['Expired'].is_a?(String)
+
+        signature = Base64.urlsafe_decode64(trx['SenderSign']).unpack1('H*')
+
+        trx = Quorum::Pb::Trx.new(
+          TrxId: trx['TrxId'],
+          GroupId: trx['GroupId'],
+          Data: Base64.decode64(trx['Data']),
+          TimeStamp: trx['TimeStamp'],
+          Expired: trx['Expired'],
+          Version: trx['Version'],
+          SenderPubkey: trx['SenderPubkey']
+        )
+
+        hash = Digest::SHA256.hexdigest trx.to_proto
+        public_key = Secp256k1::PublicKey.from_data(Base64.urlsafe_decode64(trx.SenderPubkey)).uncompressed.unpack1('H*')
+        recover_key = Eth::Signature.recover [hash].pack('H*'), signature
+
+        public_key == recover_key
       end
 
       def decrypt_trx(cipher, key:)

data/lib/quorum_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QuorumSdk
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/quorum_sdk.rb

@@ -9,16 +9,14 @@ require 'faraday'
 require 'faraday/retry'
 require 'google/protobuf/well_known_types'
 
-require_relative 'proto/activity_stream_pb'
 require_relative 'proto/chain_pb'
 require_relative 'quorum_sdk/account'
-require_relative 'quorum_sdk/api'
+require_relative 'quorum_sdk/chain'
+require_relative 'quorum_sdk/node'
 require_relative 'quorum_sdk/utils'
 require_relative 'quorum_sdk/version'
 
 module QuorumSdk
-  TRX_VERSION = '2.0.0'
-
   class Error < StandardError; end
   class ArgumentError < Error; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quorum_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - an-lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,18 +123,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/proto/activity_stream.proto
-- lib/proto/activity_stream_pb.rb
 - lib/proto/chain.proto
 - lib/proto/chain_pb.rb
 - lib/quorum_sdk.rb
 - lib/quorum_sdk/account.rb
-- lib/quorum_sdk/api.rb
-- lib/quorum_sdk/api/chain.rb
-- lib/quorum_sdk/api/group.rb
-- lib/quorum_sdk/api/light_node.rb
-- lib/quorum_sdk/api/management.rb
+- lib/quorum_sdk/chain.rb
+- lib/quorum_sdk/chain/chain.rb
+- lib/quorum_sdk/chain/group.rb
+- lib/quorum_sdk/chain/management.rb
+- lib/quorum_sdk/chain/node.rb
 - lib/quorum_sdk/client.rb
+- lib/quorum_sdk/node.rb
+- lib/quorum_sdk/node/announce.rb
+- lib/quorum_sdk/node/app_config.rb
+- lib/quorum_sdk/node/auth.rb
+- lib/quorum_sdk/node/group.rb
+- lib/quorum_sdk/node/trx.rb
 - lib/quorum_sdk/utils.rb
 - lib/quorum_sdk/version.rb
 - sig/quorum_sdk.rbs

data/lib/proto/activity_stream.proto

@@ -1,134 +0,0 @@
-/* https://github.com/rumsystem/quorum/blob/main/pkg/pb/activity_stream.proto */
-syntax = "proto3";
-package quorum.pb;
-option go_package = "github.com/rumsystem/quorum/pkg/pb";
-
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/any.proto";
-
-message AnyObj {
-    google.protobuf.Any any=1;
-}
-
-message Object {
-  string id = 1;
-  string type = 2;
-  repeated Object attachments = 3;
-  repeated Object attributedTo = 4;
-  Object audience = 5;
-  string content = 6;
-  Object context = 7;
-  string name = 8;
-  google.protobuf.Timestamp endtime = 9;
-  Object generator= 10;
-  repeated Object icon = 11;
-  repeated Image image = 12;
-  Reply inreplyto = 13;
-  Object location = 14;
-  Object preview = 15;
-  google.protobuf.Timestamp published = 16;
-  Object replies  = 17;
-  google.protobuf.Timestamp startTime = 18;
-  string summary = 19;
-  repeated Object tag = 20;
-  google.protobuf.Timestamp updated = 21;
-  repeated Link url = 22;
-  repeated Object to = 23;
-  repeated Object bto = 24;
-  repeated Object cc = 25;
-  repeated Object bcc = 26;
-  string mediaType= 27;
-  string duration = 28;
-  File file = 29;
-}
-
-message Link {
-  string href = 1;
-  repeated string rel = 2;
-  string mediaType= 3;
-  string name = 4;
-  string hreflang = 5;
-  uint32 height = 6;
-  uint32 width = 7;
-  Object preview =8;
-}
-
-message Reply {
-    string trxid = 1;
-    string  groupid  = 2;
-}
-
-message Image {
-  string id = 1;
-  string name = 2;
-  string mediaType= 3;
-  bytes content = 4;
-  string url = 5;
-}
-
-message File {
-  string id = 1;
-  string name = 2;
-  string mediaType= 3;
-  enum Compression {
-    none = 0;
-    gz = 1;
-    zip = 2;
-    zstd = 3;
-  }
-  Compression compression = 4;
-  bytes content = 5;
-  string url = 6;
-}
-
-message Person {
-  string id = 1;
-  string name = 2;
-  Image image = 3;
-  repeated Payment wallet = 11;
-}
-
-message Payment {
-    string id = 1;
-    string type = 2;
-    string name = 3;
-}
-
-message Activity {
-  string id = 1;
-  string type = 2;
-  repeated Object attachments = 3;
-  repeated Object attributedTo = 4;
-  Object audience = 5;
-  string content = 6;
-  Object context = 7;
-  string name = 8;
-  google.protobuf.Timestamp endtime = 9;
-  Object generator= 10;
-  repeated Object icon = 11;
-  repeated Object image = 12;
-  Object inReplyTo = 13;
-  Object location = 14;
-  Object preview = 15;
-  google.protobuf.Timestamp published = 16;
-  Object replies  = 17;
-  google.protobuf.Timestamp startTime = 18;
-  string summary = 19;
-  repeated Object tag = 20;
-  google.protobuf.Timestamp updated = 21;
-  repeated Link url = 22;
-  repeated Object to = 23;
-  repeated Object bto = 24;
-  repeated Object cc = 25;
-  repeated Object bcc = 26;
-  string mediaType = 27;
-  string duration = 28;
-
-  Object actor = 29;
-  Object object = 30;
-  Object target = 31;
-  Object result = 32;
-  Object origin = 33;
-  Object instrument = 34;
-  Person person = 35;
-}