flow_client 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c782ac6146b291f2691e51a0ff9bf09fafb58d1fec9ec9d10ae80e3ea6c058
-  data.tar.gz: e53438e01826e7a68c0868bed486ca51f256e42b2f574e62bee710be88217450
+  metadata.gz: 5af7d7f1ba7669936797c908286ae084ca35d28ce1403767c7e670516391c744
+  data.tar.gz: 9ece3c471fb71a3bd5fadaac858e72681ee5db0e9259cc6871c4c413e56b2f8a
 SHA512:
-  metadata.gz: ecec4b82c34c78f62daf55f048cd7a384e17e14a721162eb40b69b00f9d24bc96bae36a03d9c81105fdaa0beb04632a6ce5a05f57b424d97dd1326db460b58a3
-  data.tar.gz: a61e7d290d229a990df2e75af28f27f01ef73afbc5aaf8fabea882d8efbbf15e631fcaedf975076e1776a018194cc8ad6c3d304d0baaf5e344c962fc02e2d626
+  metadata.gz: 88ba90c30234850aea96ef88fa41592429634a475fce24d931396a17b1214fa6c9e4080e04d754cb7429629e007dff51a6ecf6a94346ccea0ddae02d7af8ddfc
+  data.tar.gz: 5b3a241597f592be576678ac36e6c2196bb9efca62442c2ba27dd8fb185db70028d30e6185845a122fa7276f43bac21195db3388308413927faad6b7032ebd7b

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    flow_client (0.2.2)
+      grpc
+      grpc-tools
+      json
+      openssl
+      rlp
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ffi (1.15.4)
+    formatador (0.3.0)
+    google-protobuf (3.19.1-x86_64-darwin)
+    googleapis-common-protos-types (1.3.0)
+      google-protobuf (~> 3.14)
+    grpc (1.41.0-universal-darwin)
+      google-protobuf (~> 3.17)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.41.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    ipaddr (1.2.3)
+    json (2.6.1)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    openssl (2.2.1)
+      ipaddr
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rlp (0.7.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    thor (1.1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  flow_client!
+  guard-rspec (~> 4.7)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.22)
+
+BUNDLED WITH
+   2.2.26

data/README.md

@@ -669,7 +669,7 @@ After a transaction has been [built](#build-transactions) and [signed](#sign-tra
 ```ruby
 tx_res = client.send_transaction(@transaction)
 client.wait_for_transaction(tx_res.id) do |response|
-  expect(response.status_code).to eq(0)
+  # use response here
 end
 ```
 

data/lib/flow_client/account.rb

@@ -24,6 +24,7 @@ module FlowClient
       @keys = keys
       @address = address
       @balance = balance
+      @contracts = contracts
       @contracts = {}
     end
   end

data/lib/flow_client/block.rb

@@ -1,5 +1,6 @@
-module FlowClient
+# frozen_string_literal: true
 
+module FlowClient
   # Represents a block
   class Block
     attr_accessor :id,
@@ -9,7 +10,7 @@ module FlowClient
                   :collection_guarantees,
                   :block_seals,
                   :signatures
-                  
+
     def initialize
       @id = nil
       @parent_id = nil
@@ -26,8 +27,12 @@ module FlowClient
       block.parent_id = block_response.block.parent_id.unpack1("H*")
       block.height = block_response.block.height
       block.timestamp = FlowClient::Utils.parse_protobuf_timestamp(block_response.block.timestamp)
-      block.collection_guarantees = block_response.block.collection_guarantees.to_a.map { |cg| FlowClient::CollectionGuarantee.parse_grpc_type(cg) }
-      block.block_seals = block_response.block.block_seals.to_a.map { |seal| FlowClient::BlockSeal.parse_grpc_type(seal) }
+      block.collection_guarantees = block_response.block.collection_guarantees.to_a.map do |cg|
+        FlowClient::CollectionGuarantee.parse_grpc_type(cg)
+      end
+      block.block_seals = block_response.block.block_seals.to_a.map do |seal|
+        FlowClient::BlockSeal.parse_grpc_type(seal)
+      end
       block.signatures = block_response.block.signatures.to_a.map { |sig| sig.unpack1("H*") }
       block
     end
@@ -51,7 +56,9 @@ module FlowClient
       block_seal = BlockSeal.new
       block_seal.block_id = grpc_type.block_id.unpack1("H*")
       block_seal.execution_receipt_id = grpc_type.execution_receipt_id.unpack1("H*")
-      block_seal.execution_receipt_signatures = grpc_type.execution_receipt_signatures.to_a.map { |sig| sig.unpack1("H*") }
+      block_seal.execution_receipt_signatures = grpc_type.execution_receipt_signatures.to_a.map do |sig|
+        sig.unpack1("H*")
+      end
       block_seal.result_approval_signatures = grpc_type.result_approval_signatures.to_a.map { |sig| sig.unpack1("H*") }
       block_seal
     end
@@ -61,8 +68,7 @@ module FlowClient
   class BlockHeader
     attr_accessor :id, :parent_id, :height, :timestamp
 
-    def initialize
-    end
+    def initialize; end
 
     def self.parse_grpc_type(grpc_type)
       header = BlockHeader.new
@@ -72,4 +78,4 @@ module FlowClient
       header
     end
   end
-end
+end

data/lib/flow_client/cadence_type.rb

@@ -1,16 +1,41 @@
+# frozen_string_literal: true
+
 require "ostruct"
 
 module FlowClient
   module CadenceType
+    # Returns an OpenStruct representing a Cadence String type
+    #
+    # @example
+    #   @arg = FlowClient::CadenceType.String("Hello world!")
+    #
+    # @param [String] the string value
+    #
+    # @returns [OpenStruct] the Cadence String struct
     def self.String(value)
       OpenStruct.new(type: "String", value: value.to_s)
     end
 
+    # Returns an OpenStruct representing a Cadence Optional type
+    #
+    # @example
+    #   @arg = FlowClient::CadenceType.Optional("Hello world!")
+    #   @arg = FlowClient::CadenceType.Optional()
+    #
+    # @param [String] the string value
+    #
+    # @returns [OpenStruct] the Cadence Optional struct
     def self.Optional(value = nil)
       OpenStruct.new(type: "Optional", value: value)
     end
 
-    def self.Void()
+    # Returns an OpenStruct representing a Cadence Void type
+    #
+    # @example
+    #   @arg = FlowClient::CadenceType.Void()
+    #
+    # @returns [OpenStruct] the Cadence Void struct
+    def self.Void
       OpenStruct.new(type: "Void")
     end
 
@@ -62,14 +87,6 @@ module FlowClient
       OpenStruct.new(type: "UInt64", value: value.to_s)
     end
 
-    def self.Int64(value)
-      OpenStruct.new(type: "Int64", value: value.to_s)
-    end
-
-    def self.UInt64(value)
-      OpenStruct.new(type: "UInt64", value: value.to_s)
-    end
-
     def self.Int128(value)
       OpenStruct.new(type: "Int128", value: value.to_s)
     end
@@ -123,9 +140,9 @@ module FlowClient
     end
 
     def self.Path(domain, identifier)
-      raise raise ArgumentError.new(
-        "Domain can only be one of storage, private or public"
-      ) unless ["storage", "private", "public"].include? domain.to_s.downcase
+      unless %w[storage private public].include? domain.to_s.downcase
+        raise raise ArgumentError, "Domain can only be one of storage, private or public"
+      end
 
       OpenStruct.new(
         type: "Path",
@@ -149,8 +166,11 @@ module FlowClient
     end
 
     def self.Composite(type, value)
-      valid_types = [:struct, :resource, :event, :contract, :enum]
-      raise ArgumentError.new("incorrect type, expected :struct, :resource, :event, :contract or :enum") unless valid_types.include? type
+      valid_types = %i[struct resource event contract enum]
+      unless valid_types.include? type
+        raise ArgumentError, "incorrect type, expected :struct, :resource, :event, :contract or :enum"
+      end
+
       OpenStruct.new(type: type.to_s.capitalize, value: value)
     end
 
@@ -162,4 +182,4 @@ module FlowClient
       OpenStruct.new(name: name, value: value)
     end
   end
-end
+end

data/lib/flow_client/client.rb

@@ -31,6 +31,8 @@ module FlowClient
     # Returns an account for the address specified at the latest
     # block.
     #
+    # @param [String] the address string value
+    #
     # @return [FlowClient::Account] the account 
     def get_account(address)
       req = Access::GetAccountAtLatestBlockRequest.new(address: to_bytes(address))
@@ -252,6 +254,8 @@ module FlowClient
 
     # Returns the latest with height
     #
+    # @param [Integer] block height
+    #
     # @return [FlowClient::Block] the block
     def get_block_by_height(height)
       req = Access::GetBlockByHeightRequest.new(
@@ -265,6 +269,8 @@ module FlowClient
 
     # Returns the collection with id
     #
+    # @param [String] collection id
+    #
     # @return [FlowClient::Collection] the collection
     def get_collection_by_id(id)
       req = Access::GetCollectionByIDRequest.new(
@@ -276,7 +282,13 @@ module FlowClient
 
     # :section: Events
 
-    # Returns events of the given type between the start and end block heights.
+    # Returns events of the given type between the start and end block heights
+    #
+    # @param [String] event name
+    # @param [Integer] start block height
+    # @param [Integer] end block height
+    #
+    # @return [FlowClient::EventsResult] the events response
     def get_events(type, start_height, end_height)
       req = Access::GetEventsForHeightRangeRequest.new(
         type: type,

data/lib/flow_client/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlowClient
   class Collection
     attr_accessor :id, :transaction_ids
@@ -30,4 +32,4 @@ module FlowClient
       collection_guarantee
     end
   end
-end
+end

data/lib/flow_client/crypto.rb

@@ -19,7 +19,7 @@ module FlowClient
     def self.sign(data, private_key_hex, hash_algo = HashAlgos::SHA3_256)
       ssl_key = FlowClient::Crypto.key_from_hex_keys(private_key_hex)
       # TODO: Fix this so that both hashing algos will work
-      asn = ssl_key.dsa_sign_asn1(OpenSSL::Digest.digest("SHA3-256", data))
+      asn = ssl_key.dsa_sign_asn1(OpenSSL::Digest.digest(hash_algo, data))
       r, s = OpenSSL::ASN1.decode(asn).value
       combined_bytes = Utils.left_pad_bytes([r.value.to_s(16)].pack("H*").unpack("C*"), 32) +
                        Utils.left_pad_bytes([s.value.to_s(16)].pack("H*").unpack("C*"), 32)
@@ -46,7 +46,7 @@ module FlowClient
     # Crypto::Curves::SECP256K1
     #
     # The 04 prefix indicating that the public key is uncompressed is stripped.
-    # https://datatracker.ietf.org/doc/html/rfc5480
+    # @see https://datatracker.ietf.org/doc/html/rfc5480
     #
     # Usage example:
     # private_key, public_key = FlowClient::Crypto.generate_key_pair(FlowClient::Crypto::Curves::P256)

data/lib/flow_client/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlowClient
   class EventsResult
     attr_accessor :block_id,
@@ -9,7 +11,7 @@ module FlowClient
       @block_id = nil
       @block_height = nil
       @events = nil
-      @block_timestamp= nil
+      @block_timestamp = nil
     end
 
     def self.parse_grpc_type(type)
@@ -28,7 +30,7 @@ module FlowClient
                   :transaction_index,
                   :event_index,
                   :payload
-                  
+
     def initialize
       @type = nil
       @transaction_id = nil
@@ -47,4 +49,4 @@ module FlowClient
       event
     end
   end
-end
+end

data/lib/flow_client/proposal_key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlowClient
   class ProposalKey
     attr_accessor :address,
@@ -18,4 +20,4 @@ module FlowClient
       signature
     end
   end
-end
+end

data/lib/flow_client/signature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlowClient
   class Signature
     attr_accessor :address,
@@ -18,4 +20,4 @@ module FlowClient
       signature
     end
   end
-end
+end

data/lib/flow_client/transaction.rb

@@ -16,8 +16,6 @@ module FlowClient
                   :payer_address,
                   :authorizer_addresses,
                   :address_aliases,
-                  :envelope_signatures,
-                  :payload_signatures,
                   :proposal_key
 
     attr_reader :envelope_signatures, :payload_signatures
@@ -36,7 +34,7 @@ module FlowClient
 
     def arguments=(arguments)
       arguments.to_a.each do |arg|
-        processed_arg = arg.class == OpenStruct ? Utils.openstruct_to_json(arg) : arg
+        processed_arg = arg.instance_of?(OpenStruct) ? Utils.openstruct_to_json(arg) : arg
         @arguments << processed_arg
       end
     end
@@ -189,4 +187,4 @@ module FlowClient
       response
     end
   end
-end
+end

data/lib/flow_client/utils.rb

@@ -47,18 +47,7 @@ module FlowClient
 
     def self.openstruct_to_json(struct)
       struct.deep_to_h.to_json
-      # struct.each_pair.map do |key, value|
-      #   [
-      #     key,
-      #     case value
-      #       when OpenStruct then value.deep_to_h
-      #       when Array then value.map {|el| el.class == OpenStruct ? el.deep_to_h : el}
-      #       else value
-      #     end
-      #   ]
-      # end.to_h.to_json
     end
-
   end
 end
 

data/lib/flow_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FlowClient
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/flow_client.rb

@@ -17,6 +17,6 @@ module FlowClient
   require "flow_client/signer"
   require "flow_client/proposal_key"
   require "flow_client/event"
-  require "flow_client/cadence_type.rb"
+  require "flow_client/cadence_type"
   require "flow_client/signature"
 end

data/template.md

@@ -669,7 +669,7 @@ After a transaction has been [built](#build-transactions) and [signed](#sign-tra
 ```ruby
 tx_res = client.send_transaction(@transaction)
 client.wait_for_transaction(tx_res.id) do |response|
-  expect(response.status_code).to eq(0)
+  # use response here
 end
 ```
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flow_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Nico du Plessis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -94,6 +94,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -155,7 +156,7 @@ metadata:
   homepage_uri: https://github.com/glucode/flow_client
   source_code_uri: https://github.com/glucode/flow_client
   changelog_uri: https://github.com/glucode/flow_client
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: A Ruby client for the Flow blockchain
 test_files: []