appchain.rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cf165b17b0de81dc3dcc848600339523ad2e7920be7a4f620bdcca802d3525b
-  data.tar.gz: 4067ce5f69b9e1b76c7143117ddd6d032348802b478e5afc953f53da722384b1
+  metadata.gz: dd176c97f662397947072cd9b6b08cb967cbc1ea171b44e5e2c9d4b348cd5e4a
+  data.tar.gz: 354f3c9e6dbad28a6d7e8a4c9053b942d11c889615e60903145d03daa879e1bb
 SHA512:
-  metadata.gz: 839817784fd7e9351b8050e86d7c9353078a971c0d00bc7316f09fb928461ddc3359f05f082d420441f48a8034d559688d3c245424f4fe50cb0059256d6ab9bd
-  data.tar.gz: 6fd4a13f92717af89484f62c05f2816e9e19d4521706ddfe4e1ed17540572c375b5358f4d4cce296f1d56ca5a5dc076503ca4038367652dbed49b3b99c494e04
+  metadata.gz: 57c287fc34a72b7b0fa5d51a859a11dcb37a69fa81455a659b75327ec42e0a0e5eebcddce7a90c9b256eaf7f29f3cf0fe9417d04013fccbb042296adb7c390df
+  data.tar.gz: 78cd56fc25a1ed429be686b1db3ae2b958b585e8aa3207b2ee40b95bf81b5fb4a679082c98dc4b8b0a4fa740450db7151a1d2f3d8a8363f892dbeba99416c2c3

data/.travis.yml

@@ -3,9 +3,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.4.4
-  - 2.5.1
-before_install: gem install bundler -v 1.16.4
+  - 2.4.5
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6
 install:
   - cd secp256k1 && ./autogen.sh && ./configure --enable-module-recovery --enable-experimental --enable-module-ecdh && make && sudo make install && cd ..
   - bundle install

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    appchain.rb (0.1.0)
+    appchain.rb (0.2.0)
       activesupport (~> 5.2.1)
       ciri-crypto (= 0.1.1)
       faraday (~> 0.15.3)
@@ -33,7 +33,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     ffi (1.9.25)
     google-protobuf (3.6.1-universal-darwin)
-    i18n (1.1.0)
+    i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     method_source (0.9.0)

data/README.md

@@ -1,6 +1,7 @@
 # AppChain.rb
 
 [![Build Status](https://travis-ci.org/cryptape/appchain.rb.svg?branch=master)](https://travis-ci.org/cryptape/appchain.rb)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/github/cryptape/appchain.rb/master)
 
 Nervos AppChain Ruby SDK
 
@@ -44,8 +45,8 @@ transaction = AppChain::Transaction.new(
   valid_until_block: 1882078,
   data: "",
   value: "0x3e8",
-  chain_id: 1,
-  version: 0
+  chain_id: "1",
+  version: 1
 )
 
 # sign transaction with your private key
@@ -74,6 +75,18 @@ response = contract.call_func(method: :symbol)
 response = contract.send_func(tx: tx, private_key: private_key, method: :transfer, params: [address, tokens])
 ```
 
+## CHANGELOG
+
+### v0.1
+
+* supports CITA 0.19
+
+### 0.2
+ 
+* supports CITA 0.20 and 0.19
+* set default transaction version to 1
+* update TransactionSinger.decode output type to hash with symbol keys
+* parse TransactionSinger.decode hash value to hex string if it's bytes. 
 
 ## Contributing
 

data/lib/appchain/contract.rb

@@ -40,7 +40,7 @@ module AppChain
     # @param tx [Hash] see rpc `call` doc for more info
     #
     # @return [any]
-    def call_func(method:, params: [], tx: {})
+    def call_func(method:, params: [], tx: {}) # rubocop:disable Naming/UncommunicativeMethodParamName
       data, output_types = function_data_with_ot(method, *params)
       resp = @rpc.call_rpc(:call, params: [tx.merge(data: data, to: address), "latest"])
       result = resp["result"]
@@ -60,7 +60,7 @@ module AppChain
     # @param *params [Array] your params
     #
     # @return [nil | Hash] {hash: "", status: ""}, sendRawTransactionResult
-    def send_func(tx:, private_key:, method:, params: [])
+    def send_func(tx:, private_key:, method:, params: []) # rubocop:disable Naming/UncommunicativeMethodParamName
       data, _output_types = function_data_with_ot(method, *params)
       transaction = if tx.is_a?(Hash)
                       Transaction.from_hash(tx)

data/lib/appchain/protos/blockchain_pb.rb

@@ -15,8 +15,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :state_root, :bytes, 4
     optional :transactions_root, :bytes, 5
     optional :receipts_root, :bytes, 6
-    optional :gas_used, :uint64, 7
-    optional :gas_limit, :uint64, 8
+    optional :quota_used, :uint64, 7
+    optional :quota_limit, :uint64, 8
     optional :proof, :message, 9, "Proof"
     optional :proposer, :bytes, 10
   end
@@ -25,8 +25,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :height, :uint64, 2
   end
   add_message "AccountGasLimit" do
-    optional :common_gas_limit, :uint64, 1
-    map :specific_gas_limit, :string, :uint64, 2
+    optional :common_quota_limit, :uint64, 1
+    map :specific_quota_limit, :string, :uint64, 2
   end
   add_message "RichStatus" do
     optional :hash, :bytes, 1
@@ -34,6 +34,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :nodes, :bytes, 3
     optional :interval, :uint64, 4
     optional :version, :uint32, 5
+    repeated :validators, :bytes, 6
   end
   add_message "Transaction" do
     optional :to, :string, 1
@@ -44,6 +45,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :value, :bytes, 6
     optional :chain_id, :uint32, 7
     optional :version, :uint32, 8
+    optional :to_v1, :bytes, 9
+    optional :chain_id_v1, :bytes, 10
   end
   add_message "UnverifiedTransaction" do
     optional :transaction, :message, 1, "Transaction"
@@ -107,4 +110,3 @@ module AppChain::Protos
   ProofType = Google::Protobuf::DescriptorPool.generated_pool.lookup("ProofType").enummodule
   Crypto = Google::Protobuf::DescriptorPool.generated_pool.lookup("Crypto").enummodule
 end
-

data/lib/appchain/rpc.rb

@@ -70,8 +70,14 @@ module AppChain
     # @return [Hash]
     def transfer(to:, private_key:, value:, quota: 30_000)
       valid_until_block = block_number["result"].hex + 88
-      chain_id = get_meta_data("latest").dig "result", "chainId"
-      transaction = Transaction.new(nonce: Utils.nonce, valid_until_block: valid_until_block, chain_id: chain_id, to: to, value: value, quota: quota)
+      meta_data = get_meta_data("latest")["result"]
+      version = meta_data["version"]
+      chain_id = if version.zero?
+                   meta_data["chainId"]
+                 elsif version == 1
+                   meta_data["chainIdV1"]
+                 end
+      transaction = Transaction.new(nonce: Utils.nonce, valid_until_block: valid_until_block, chain_id: chain_id, to: to, value: value, quota: quota, version: version)
       send_transaction(transaction, private_key)
     end
   end

data/lib/appchain/transaction.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
+require "active_support/core_ext/string"
 
 module AppChain
   class Transaction
+    class VersionError < StandardError
+    end
+
     attr_accessor :to, :nonce, :quota, :valid_until_block, :data, :value, :chain_id, :version
 
-    # @param nonce [String]
+    # @param nonce [String] default is SecureRandom.hex; if you provide with nil or empty string, it will be assigned a random string.
     # @param valid_until_block [Integer]
-    # @param chain_id [Integer]
+    # @param chain_id [Integer | String] hex string if version == 1
     # @param version [Integer]
     # @param to [String]
     # @param data [String]
@@ -14,13 +18,19 @@ module AppChain
     # @param quota [Integer]
     #
     # @return [void]
-    def initialize(nonce:, valid_until_block:, chain_id:, version: 0, to: nil, data: nil, value: "0", quota: 1_000_000)
+    def initialize(valid_until_block:, chain_id:, nonce: nil, version: 1, to: nil, data: nil, value: "0", quota: 1_000_000) # rubocop:disable Metrics/ParameterLists
+      raise VersionError, "transaction version error, expected 0 or 1, got #{version}" unless [0, 1].include?(version)
+
       @to = to
-      @nonce = nonce
+      @nonce = nonce.blank? ? SecureRandom.hex : nonce
       @quota = quota
       @valid_until_block = valid_until_block
       @data = data
-      @chain_id = chain_id
+      @chain_id = if chain_id.is_a?(String)
+                    chain_id.delete("-")
+                  else
+                    chain_id
+                  end
       @version = version
       @value = if value.is_a?(Integer)
                  Utils.to_hex(value)
@@ -38,7 +48,7 @@ module AppChain
         chain_id: h[:chain_id],
         to: h[:to],
         data: h[:data],
-        version: h[:version] || 0,
+        version: h[:version] || 1,
         value: h[:value] || "0",
         quota: h[:quota] || 1_000_000
       )

data/lib/appchain/transaction_signer.rb

@@ -13,16 +13,23 @@ module AppChain
       def encode(transaction, private_key)
         tx = AppChain::Protos::Transaction.new
 
-        tx.nonce = transaction.nonce
         to = AppChain::Utils.remove_hex_prefix(transaction.to)&.downcase
-        tx.to = to unless to.nil?
+
+        tx.nonce = transaction.nonce
         tx.quota = transaction.quota
         tx.data = AppChain::Utils.to_bytes(transaction.data)
+        tx.value = hex_to_bytes(transaction.value)
         tx.version = transaction.version
-        tx.value = process_value(transaction.value)
-        tx.chain_id = transaction.chain_id
         tx.valid_until_block = transaction.valid_until_block
 
+        if transaction.version.zero?
+          tx.to = to unless to.nil?
+          tx.chain_id = transaction.chain_id
+        elsif transaction.version == 1
+          tx.to_v1 = Utils.to_bytes(to) unless to.nil?
+          tx.chain_id_v1 = hex_to_bytes(transaction.chain_id)
+        end
+
         encoded_tx = Protos::Transaction.encode(tx)
 
         private_key_bytes = AppChain::Utils.to_bytes(private_key)
@@ -41,7 +48,7 @@ module AppChain
       # unsign transaction
       #
       # @param tx_content [String] hex string
-      def decode(tx_content)
+      def simple_decode(tx_content)
         content_bytes = AppChain::Utils.to_bytes(tx_content)
         unverified_transaction = Protos::UnverifiedTransaction.decode(content_bytes)
 
@@ -57,22 +64,73 @@ module AppChain
         from_address_hex = Utils.from_bytes(from_address)
 
         sender = {
-          "address" => from_address_hex,
-          "public_key" => pubkey_hex
+          address: from_address_hex,
+          public_key: pubkey_hex
         }
 
         {
-          "unverified_transaction" => unverified_transaction,
-          "sender" => sender
+          unverified_transaction: unverified_transaction.to_h,
+          sender: sender
         }
       end
 
+      # decode and support forks
+      #
+      # @param tx_content [String] hex string
+      # @return [Hash]
+      def original_decode(tx_content)
+        data = simple_decode(tx_content)
+        utx = data[:unverified_transaction]
+        tx = utx[:transaction]
+        version = tx[:version]
+
+        if version == 0 # rubocop:disable Style/NumericPredicate
+          tx.delete(:to_v1)
+          tx.delete(:chain_id_v1)
+        elsif version == 1
+          tx[:to] = tx.delete(:to_v1)
+          tx[:chain_id] = tx.delete(:chain_id_v1)
+        else
+          raise Transaction::VersionError, "transaction version error, expected 0 or 1, got #{version}"
+        end
+
+        data
+      end
+
+      # decode and parse bytes to hex string
+      #
+      # @param tx_content [String] hex string
+      # @return [Hash]
+      def decode(tx_content)
+        data = original_decode(tx_content)
+        utx = data[:unverified_transaction]
+        tx = utx[:transaction]
+        version = tx[:version]
+
+        tx[:value] = Utils.from_bytes(tx[:value])
+        tx[:data] = Utils.from_bytes(tx[:data])
+        tx[:nonce] = Utils.add_prefix_for_not_blank(tx[:nonce])
+        utx[:signature] = Utils.from_bytes(utx[:signature])
+
+        if version == 0 # rubocop:disable Style/NumericPredicate
+          tx.delete(:to_v1)
+          tx.delete(:chain_id_v1)
+          tx[:to] = Utils.add_prefix_for_not_blank(tx[:to])
+        elsif version == 1
+          tx[:to] = Utils.from_bytes(tx[:to])
+          tx[:chain_id] = Utils.from_bytes(tx[:chain_id])
+        end
+
+        data
+      end
+
       private
 
       # @param value [String] hex string with or without `0x` prefix
+      # @param length [Integer] length, default is 64
       # @return [String] byte code string
-      def process_value(value)
-        AppChain::Utils.to_bytes(AppChain::Utils.remove_hex_prefix(value).rjust(64, "0"))
+      def hex_to_bytes(value, length = 64)
+        AppChain::Utils.to_bytes(AppChain::Utils.remove_hex_prefix(value).rjust(length, "0"))
       end
     end
   end

data/lib/appchain/utils.rb

@@ -15,6 +15,15 @@ module AppChain
         HEX_PREFIX + hex
       end
 
+      # add `0x` prefix to not blank hex string
+      #
+      # @param hex [String]
+      def add_prefix_for_not_blank(hex)
+        return add_hex_prefix(hex) unless hex.blank?
+
+        hex
+      end
+
       # remove `0x` prefix from hex string
       #
       # @param hex [String]
@@ -55,7 +64,10 @@ module AppChain
       # @param bytes_str [String] byte code string
       # @return [String] normal string
       def from_bytes(bytes_str)
-        AppChain::Utils.add_hex_prefix(bytes_str.unpack1("H*"))
+        hex = bytes_str.unpack1("H*")
+        return AppChain::Utils.add_hex_prefix(hex) unless hex.blank?
+
+        hex
       end
 
       # keccak 256 hash

data/lib/appchain/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appchain.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - classicalliu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby Nervos AppChain SDK