cita-sdk-ruby 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 191e6e673e063a855ab3d9bff925ed99d88cb211d3a6600fbead317c5059ca87
-  data.tar.gz: 320fb2ce7b5b1fdec68fa20f1b68d171599bf682caaaa539e4f1d3b18750a57b
+  metadata.gz: 13fa5f39c9959e2ad5e9ac909e53abd2b28e9a4622c2e6308092dc7d973b4689
+  data.tar.gz: 7e1cfdbf8c05e9c0505d563d5ffd7141894b9ef23b878623d863066b50e18087
 SHA512:
-  metadata.gz: cda5eb17355ba2889eeb10faed7cd1755f62a7c19fd0981b03447c2dacbb04ed009488dcacaeff314bf59dce6cee241d8493b76551f2345e6afc793bb3fb33a5
-  data.tar.gz: eb19a729cb48b60b23890925955b5839c7f2ac31983e9de6e4779eac22fadd8621d8cd264ef2974c6b833663d1c789b4f1f987ea6a3804f44551fdce6c40e6a3
+  metadata.gz: a6a162dd52d2c41de0c2b62126b36a1094fdd25d0e1f063f46ecf3e2cd33dc3fba44532ce2f49eddb4130c4f5276b2788282b51a79303a3a7ab071ef0146dea1
+  data.tar.gz: c02e438621c191e2d9eadd074e6c95a409334dee6e914b139e6df8662d00b707659ce4856c3f1b3ffe56453f3c970b9f3eeccc771969cb3107091a82676893f4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cita-sdk-ruby (0.20.0)
+    cita-sdk-ruby (0.21.0)
       activesupport (~> 5.2.1)
       ciri-crypto (= 0.1.1)
       faraday (~> 0.15.3)

data/README.md

@@ -54,6 +54,8 @@ content = CITA::TransactionSigner.encode(transaction, "you private key")
 
 # you can unsign content by `decode` method
 CITA::TransactionSigner.decode(content) 
+# you can set `recover` to false if you don't want to recover from address and public key
+CITA::TransactionSigner.decode(content, recover: false)
 ```
 
 send transaction
@@ -63,7 +65,7 @@ cita.rpc.send_transaction(transaction, private_key)
 
 transfer tokens
 ```ruby
-cita.rpc.transfer(to: "to address", value: 1000, private_key)
+cita.rpc.transfer(to: "to address", value: 1000, private_key: "your private key")
 ```
 
 contract
@@ -93,6 +95,10 @@ response = contract.send_func(tx: tx, private_key: private_key, method: :transfe
 * rename to `cita-sdk-ruby`
 * rename top module name to `CITA`
 
+### v0.21.0
+* add `recover` option for decode transaction, for CITA v0.21 provide `from` in `getTransaction` rpc call
+* rename protobuf `Crypto` enum
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/cryptape/cita-sdk-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/cita/protos/blockchain_pb.rb

@@ -61,11 +61,19 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "BlockBody" do
     repeated :transactions, :message, 1, "SignedTransaction"
   end
+  add_message "CompactBlockBody" do
+    repeated :tx_hashes, :bytes, 1
+  end
   add_message "Block" do
     optional :version, :uint32, 1
     optional :header, :message, 2, "BlockHeader"
     optional :body, :message, 3, "BlockBody"
   end
+  add_message "CompactBlock" do
+    optional :version, :uint32, 1
+    optional :header, :message, 2, "BlockHeader"
+    optional :body, :message, 3, "CompactBlockBody"
+  end
   add_message "BlockWithProof" do
     optional :blk, :message, 1, "Block"
     optional :proof, :message, 2, "Proof"
@@ -87,8 +95,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     value :Bft, 2
   end
   add_enum "Crypto" do
-    value :SECP, 0
-    value :SM2, 1
+    value :DEFAULT, 0
+    value :RESERVED, 1
   end
 end
 
@@ -102,7 +110,9 @@ module CITA::Protos
   UnverifiedTransaction = Google::Protobuf::DescriptorPool.generated_pool.lookup("UnverifiedTransaction").msgclass
   SignedTransaction = Google::Protobuf::DescriptorPool.generated_pool.lookup("SignedTransaction").msgclass
   BlockBody = Google::Protobuf::DescriptorPool.generated_pool.lookup("BlockBody").msgclass
+  CompactBlockBody = Google::Protobuf::DescriptorPool.generated_pool.lookup("CompactBlockBody").msgclass
   Block = Google::Protobuf::DescriptorPool.generated_pool.lookup("Block").msgclass
+  CompactBlock = Google::Protobuf::DescriptorPool.generated_pool.lookup("CompactBlock").msgclass
   BlockWithProof = Google::Protobuf::DescriptorPool.generated_pool.lookup("BlockWithProof").msgclass
   BlockTxs = Google::Protobuf::DescriptorPool.generated_pool.lookup("BlockTxs").msgclass
   BlackList = Google::Protobuf::DescriptorPool.generated_pool.lookup("BlackList").msgclass

data/lib/cita/transaction_signer.rb

@@ -45,13 +45,11 @@ module CITA
         CITA::Utils.from_bytes(encoded_unverified_tx)
       end
 
-      # unsign transaction
+      # get sender info (from address & public key)
       #
-      # @param tx_content [String] hex string
-      def simple_decode(tx_content)
-        content_bytes = CITA::Utils.to_bytes(tx_content)
-        unverified_transaction = Protos::UnverifiedTransaction.decode(content_bytes)
-
+      # @param unverified_transaction [Hash]
+      # @return [Hash] address & public_key
+      def sender_info(unverified_transaction)
         signature = unverified_transaction["signature"]
 
         transaction = unverified_transaction["transaction"]
@@ -63,23 +61,40 @@ module CITA
         from_address = Utils.keccak256(pubkey[1..-1])[-20..-1]
         from_address_hex = Utils.from_bytes(from_address)
 
-        sender = {
+        {
           address: from_address_hex,
           public_key: pubkey_hex
         }
+      end
 
-        {
-          unverified_transaction: unverified_transaction.to_h,
-          sender: sender
+      # decode transaction, CITA v0.21 returns the `from` address in `getTransaction` RPC call
+      # so you can not to recover `from` address from context
+      #
+      # @param tx_content [String] hex string
+      # @param recover [Boolean] set to false if you don't want to recover from address, default is true
+      def simple_decode(tx_content, recover: true)
+        content_bytes = CITA::Utils.to_bytes(tx_content)
+        unverified_transaction = Protos::UnverifiedTransaction.decode(content_bytes)
+
+        info = {
+          unverified_transaction: unverified_transaction.to_h
         }
+
+        if recover
+          sender = sender_info(unverified_transaction)
+          info[:sender] = sender
+        end
+
+        info
       end
 
       # decode and support forks
       #
       # @param tx_content [String] hex string
+      # @param recover [Boolean] set to false if you don't want to recover from address, default is true
       # @return [Hash]
-      def original_decode(tx_content)
-        data = simple_decode(tx_content)
+      def original_decode(tx_content, recover: true)
+        data = simple_decode(tx_content, recover: recover)
         utx = data[:unverified_transaction]
         tx = utx[:transaction]
         version = tx[:version]
@@ -100,9 +115,10 @@ module CITA
       # decode and parse bytes to hex string
       #
       # @param tx_content [String] hex string
+      # @param recover [Boolean] set to false if you don't want to recover from address, default is true
       # @return [Hash]
-      def decode(tx_content)
-        data = original_decode(tx_content)
+      def decode(tx_content, recover: true)
+        data = original_decode(tx_content, recover: recover)
         utx = data[:unverified_transaction]
         tx = utx[:transaction]
         version = tx[:version]

data/lib/cita/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CITA
-  VERSION = "0.20.0"
+  VERSION = "0.21.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cita-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - classicalliu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler