flow_client 0.1.0

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "flow_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flow_client.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/flow_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "flow_client"
+  spec.version       = FlowClient::VERSION
+  spec.authors       = ["Nico du Plessis"]
+  spec.email         = ["nico@glucode.com"]
+
+  spec.summary       = "A Ruby client for the Flow blockchain"
+  spec.description   = "A Ruby client for the Flow blockchain"
+  spec.homepage      = "https://github.com/glucode/flow_client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/glucode/flow_client"
+  spec.metadata["changelog_uri"] = "https://github.com/glucode/flow_client"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "digest-sha3"
+  spec.add_dependency "ecdsa"
+  spec.add_dependency "grpc"
+  spec.add_dependency "grpc-tools"
+  spec.add_dependency "json"
+  spec.add_dependency "openssl"
+  spec.add_dependency "rlp"
+  spec.add_dependency "rspec"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/flow/access/access_pb.rb

@@ -0,0 +1,168 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/access/access.proto
+
+require 'google/protobuf'
+
+require 'flow/entities/account_pb'
+require 'flow/entities/block_header_pb'
+require 'flow/entities/block_pb'
+require 'flow/entities/collection_pb'
+require 'flow/entities/event_pb'
+require 'flow/entities/transaction_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/access/access.proto", :syntax => :proto3) do
+    add_message "flow.access.PingRequest" do
+    end
+    add_message "flow.access.PingResponse" do
+    end
+    add_message "flow.access.GetLatestBlockHeaderRequest" do
+      optional :is_sealed, :bool, 1
+    end
+    add_message "flow.access.GetBlockHeaderByIDRequest" do
+      optional :id, :bytes, 1
+    end
+    add_message "flow.access.GetBlockHeaderByHeightRequest" do
+      optional :height, :uint64, 1
+    end
+    add_message "flow.access.BlockHeaderResponse" do
+      optional :block, :message, 1, "flow.entities.BlockHeader"
+    end
+    add_message "flow.access.GetLatestBlockRequest" do
+      optional :is_sealed, :bool, 1
+    end
+    add_message "flow.access.GetBlockByIDRequest" do
+      optional :id, :bytes, 1
+    end
+    add_message "flow.access.GetBlockByHeightRequest" do
+      optional :height, :uint64, 1
+    end
+    add_message "flow.access.BlockResponse" do
+      optional :block, :message, 1, "flow.entities.Block"
+    end
+    add_message "flow.access.GetCollectionByIDRequest" do
+      optional :id, :bytes, 1
+    end
+    add_message "flow.access.CollectionResponse" do
+      optional :collection, :message, 1, "flow.entities.Collection"
+    end
+    add_message "flow.access.SendTransactionRequest" do
+      optional :transaction, :message, 1, "flow.entities.Transaction"
+    end
+    add_message "flow.access.SendTransactionResponse" do
+      optional :id, :bytes, 1
+    end
+    add_message "flow.access.GetTransactionRequest" do
+      optional :id, :bytes, 1
+    end
+    add_message "flow.access.TransactionResponse" do
+      optional :transaction, :message, 1, "flow.entities.Transaction"
+    end
+    add_message "flow.access.TransactionResultResponse" do
+      optional :status, :enum, 1, "flow.entities.TransactionStatus"
+      optional :status_code, :uint32, 2
+      optional :error_message, :string, 3
+      repeated :events, :message, 4, "flow.entities.Event"
+      optional :block_id, :bytes, 5
+    end
+    add_message "flow.access.GetAccountRequest" do
+      optional :address, :bytes, 1
+    end
+    add_message "flow.access.GetAccountResponse" do
+      optional :account, :message, 1, "flow.entities.Account"
+    end
+    add_message "flow.access.GetAccountAtLatestBlockRequest" do
+      optional :address, :bytes, 1
+    end
+    add_message "flow.access.AccountResponse" do
+      optional :account, :message, 1, "flow.entities.Account"
+    end
+    add_message "flow.access.GetAccountAtBlockHeightRequest" do
+      optional :address, :bytes, 1
+      optional :block_height, :uint64, 2
+    end
+    add_message "flow.access.ExecuteScriptAtLatestBlockRequest" do
+      optional :script, :bytes, 1
+      repeated :arguments, :bytes, 2
+    end
+    add_message "flow.access.ExecuteScriptAtBlockIDRequest" do
+      optional :block_id, :bytes, 1
+      optional :script, :bytes, 2
+      repeated :arguments, :bytes, 3
+    end
+    add_message "flow.access.ExecuteScriptAtBlockHeightRequest" do
+      optional :block_height, :uint64, 1
+      optional :script, :bytes, 2
+      repeated :arguments, :bytes, 3
+    end
+    add_message "flow.access.ExecuteScriptResponse" do
+      optional :value, :bytes, 1
+    end
+    add_message "flow.access.GetEventsForHeightRangeRequest" do
+      optional :type, :string, 1
+      optional :start_height, :uint64, 2
+      optional :end_height, :uint64, 3
+    end
+    add_message "flow.access.GetEventsForBlockIDsRequest" do
+      optional :type, :string, 1
+      repeated :block_ids, :bytes, 2
+    end
+    add_message "flow.access.EventsResponse" do
+      repeated :results, :message, 1, "flow.access.EventsResponse.Result"
+    end
+    add_message "flow.access.EventsResponse.Result" do
+      optional :block_id, :bytes, 1
+      optional :block_height, :uint64, 2
+      repeated :events, :message, 3, "flow.entities.Event"
+      optional :block_timestamp, :message, 4, "google.protobuf.Timestamp"
+    end
+    add_message "flow.access.GetNetworkParametersRequest" do
+    end
+    add_message "flow.access.GetNetworkParametersResponse" do
+      optional :chain_id, :string, 1
+    end
+    add_message "flow.access.GetLatestProtocolStateSnapshotRequest" do
+    end
+    add_message "flow.access.ProtocolStateSnapshotResponse" do
+      optional :serializedSnapshot, :bytes, 1
+    end
+  end
+end
+
+
+module Access
+  PingRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.PingRequest").msgclass
+  PingResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.PingResponse").msgclass
+  GetLatestBlockHeaderRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetLatestBlockHeaderRequest").msgclass
+  GetBlockHeaderByIDRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetBlockHeaderByIDRequest").msgclass
+  GetBlockHeaderByHeightRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetBlockHeaderByHeightRequest").msgclass
+  BlockHeaderResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.BlockHeaderResponse").msgclass
+  GetLatestBlockRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetLatestBlockRequest").msgclass
+  GetBlockByIDRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetBlockByIDRequest").msgclass
+  GetBlockByHeightRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetBlockByHeightRequest").msgclass
+  BlockResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.BlockResponse").msgclass
+  GetCollectionByIDRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetCollectionByIDRequest").msgclass
+  CollectionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.CollectionResponse").msgclass
+  SendTransactionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.SendTransactionRequest").msgclass
+  SendTransactionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.SendTransactionResponse").msgclass
+  GetTransactionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetTransactionRequest").msgclass
+  TransactionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.TransactionResponse").msgclass
+  TransactionResultResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.TransactionResultResponse").msgclass
+  GetAccountRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetAccountRequest").msgclass
+  GetAccountResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetAccountResponse").msgclass
+  GetAccountAtLatestBlockRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetAccountAtLatestBlockRequest").msgclass
+  AccountResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.AccountResponse").msgclass
+  GetAccountAtBlockHeightRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetAccountAtBlockHeightRequest").msgclass
+  ExecuteScriptAtLatestBlockRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.ExecuteScriptAtLatestBlockRequest").msgclass
+  ExecuteScriptAtBlockIDRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.ExecuteScriptAtBlockIDRequest").msgclass
+  ExecuteScriptAtBlockHeightRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.ExecuteScriptAtBlockHeightRequest").msgclass
+  ExecuteScriptResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.ExecuteScriptResponse").msgclass
+  GetEventsForHeightRangeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetEventsForHeightRangeRequest").msgclass
+  GetEventsForBlockIDsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetEventsForBlockIDsRequest").msgclass
+  EventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.EventsResponse").msgclass
+  EventsResponse::Result = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.EventsResponse.Result").msgclass
+  GetNetworkParametersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetNetworkParametersRequest").msgclass
+  GetNetworkParametersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetNetworkParametersResponse").msgclass
+  GetLatestProtocolStateSnapshotRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.GetLatestProtocolStateSnapshotRequest").msgclass
+  ProtocolStateSnapshotResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.access.ProtocolStateSnapshotResponse").msgclass
+end

data/lib/flow/access/access_services_pb.rb

@@ -0,0 +1,96 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: flow/access/access.proto for package 'flow.access'
+
+require 'grpc'
+require 'flow/access/access_pb'
+
+module Access
+  module AccessAPI
+    # AccessAPI is the public-facing API provided by access nodes.
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'flow.access.AccessAPI'
+
+      # Ping is used to check if the access node is alive and healthy.
+      rpc :Ping, ::Access::PingRequest, ::Access::PingResponse
+      # Block Headers
+      #
+      # GetLatestBlockHeader gets the latest sealed or unsealed block header.
+      rpc :GetLatestBlockHeader, ::Access::GetLatestBlockHeaderRequest, ::Access::BlockHeaderResponse
+      # GetBlockHeaderByID gets a block header by ID.
+      rpc :GetBlockHeaderByID, ::Access::GetBlockHeaderByIDRequest, ::Access::BlockHeaderResponse
+      # GetBlockHeaderByHeight gets a block header by height.
+      rpc :GetBlockHeaderByHeight, ::Access::GetBlockHeaderByHeightRequest, ::Access::BlockHeaderResponse
+      # Blocks
+      #
+      # GetLatestBlock gets the full payload of the latest sealed or unsealed
+      # block.
+      rpc :GetLatestBlock, ::Access::GetLatestBlockRequest, ::Access::BlockResponse
+      # GetBlockByID gets a full block by ID.
+      rpc :GetBlockByID, ::Access::GetBlockByIDRequest, ::Access::BlockResponse
+      # GetBlockByHeight gets a full block by height.
+      rpc :GetBlockByHeight, ::Access::GetBlockByHeightRequest, ::Access::BlockResponse
+      # Collections
+      #
+      # GetCollectionByID gets a collection by ID.
+      rpc :GetCollectionByID, ::Access::GetCollectionByIDRequest, ::Access::CollectionResponse
+      # Transactions
+      #
+      # SendTransaction submits a transaction to the network.
+      rpc :SendTransaction, ::Access::SendTransactionRequest, ::Access::SendTransactionResponse
+      # GetTransaction gets a transaction by ID.
+      rpc :GetTransaction, ::Access::GetTransactionRequest, ::Access::TransactionResponse
+      # GetTransactionResult gets the result of a transaction.
+      rpc :GetTransactionResult, ::Access::GetTransactionRequest, ::Access::TransactionResultResponse
+      # Accounts
+      #
+      # GetAccount is an alias for GetAccountAtLatestBlock.
+      #
+      # Warning: this function is deprecated. It behaves identically to
+      # GetAccountAtLatestBlock and will be removed in a future version.
+      rpc :GetAccount, ::Access::GetAccountRequest, ::Access::GetAccountResponse
+      # GetAccountAtLatestBlock gets an account by address from the latest sealed
+      # execution state.
+      rpc :GetAccountAtLatestBlock, ::Access::GetAccountAtLatestBlockRequest, ::Access::AccountResponse
+      # GetAccountAtBlockHeight gets an account by address at the given block
+      # height
+      rpc :GetAccountAtBlockHeight, ::Access::GetAccountAtBlockHeightRequest, ::Access::AccountResponse
+      # Scripts
+      #
+      # ExecuteScriptAtLatestBlock executes a read-only Cadence script against the
+      # latest sealed execution state.
+      rpc :ExecuteScriptAtLatestBlock, ::Access::ExecuteScriptAtLatestBlockRequest, ::Access::ExecuteScriptResponse
+      # ExecuteScriptAtBlockID executes a ready-only Cadence script against the
+      # execution state at the block with the given ID.
+      rpc :ExecuteScriptAtBlockID, ::Access::ExecuteScriptAtBlockIDRequest, ::Access::ExecuteScriptResponse
+      # ExecuteScriptAtBlockHeight executes a ready-only Cadence script against the
+      # execution state at the given block height.
+      rpc :ExecuteScriptAtBlockHeight, ::Access::ExecuteScriptAtBlockHeightRequest, ::Access::ExecuteScriptResponse
+      # Events
+      #
+      # GetEventsForHeightRange retrieves events emitted within the specified block
+      # range.
+      rpc :GetEventsForHeightRange, ::Access::GetEventsForHeightRangeRequest, ::Access::EventsResponse
+      # GetEventsForBlockIDs retrieves events for the specified block IDs and event
+      # type.
+      rpc :GetEventsForBlockIDs, ::Access::GetEventsForBlockIDsRequest, ::Access::EventsResponse
+      # NetworkParameters
+      #
+      # GetNetworkParameters retrieves the Flow network details
+      rpc :GetNetworkParameters, ::Access::GetNetworkParametersRequest, ::Access::GetNetworkParametersResponse
+      # ProtocolState
+      #
+      # GetLatestProtocolStateSnapshot retrieves the latest sealed protocol state
+      # snapshot. Used by Flow nodes joining the network to bootstrap a
+      # space-efficient local state.
+      rpc :GetLatestProtocolStateSnapshot, ::Access::GetLatestProtocolStateSnapshotRequest, ::Access::ProtocolStateSnapshotResponse
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end
+

data/lib/flow/entities/account_pb.rb

@@ -0,0 +1,30 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/entities/account.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/entities/account.proto", :syntax => :proto3) do
+    add_message "flow.entities.Account" do
+      optional :address, :bytes, 1
+      optional :balance, :uint64, 2
+      optional :code, :bytes, 3
+      repeated :keys, :message, 4, "flow.entities.AccountKey"
+      map :contracts, :string, :bytes, 5
+    end
+    add_message "flow.entities.AccountKey" do
+      optional :index, :uint32, 1
+      optional :public_key, :bytes, 2
+      optional :sign_algo, :uint32, 3
+      optional :hash_algo, :uint32, 4
+      optional :weight, :uint32, 5
+      optional :sequence_number, :uint32, 6
+      optional :revoked, :bool, 7
+    end
+  end
+end
+
+module Entities
+  Account = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.entities.Account").msgclass
+  AccountKey = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.entities.AccountKey").msgclass
+end

data/lib/flow/entities/block_header_pb.rb

@@ -0,0 +1,20 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/entities/block_header.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/entities/block_header.proto", :syntax => :proto3) do
+    add_message "flow.entities.BlockHeader" do
+      optional :id, :bytes, 1
+      optional :parent_id, :bytes, 2
+      optional :height, :uint64, 3
+      optional :timestamp, :message, 4, "google.protobuf.Timestamp"
+    end
+  end
+end
+
+module Entities
+  BlockHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.entities.BlockHeader").msgclass
+end

data/lib/flow/entities/block_pb.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/entities/block.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+require 'flow/entities/collection_pb'
+require 'flow/entities/block_seal_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/entities/block.proto", :syntax => :proto3) do
+    add_message "flow.entities.Block" do
+      optional :id, :bytes, 1
+      optional :parent_id, :bytes, 2
+      optional :height, :uint64, 3
+      optional :timestamp, :message, 4, "google.protobuf.Timestamp"
+      repeated :collection_guarantees, :message, 5, "flow.entities.CollectionGuarantee"
+      repeated :block_seals, :message, 6, "flow.entities.BlockSeal"
+      repeated :signatures, :bytes, 7
+    end
+  end
+end
+
+module Entities
+  Block = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.entities.Block").msgclass
+end

data/lib/flow/entities/block_seal_pb.rb

@@ -0,0 +1,19 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/entities/block_seal.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/entities/block_seal.proto", :syntax => :proto3) do
+    add_message "flow.entities.BlockSeal" do
+      optional :block_id, :bytes, 1
+      optional :execution_receipt_id, :bytes, 2
+      repeated :execution_receipt_signatures, :bytes, 3
+      repeated :result_approval_signatures, :bytes, 4
+    end
+  end
+end
+
+module Entities
+  BlockSeal = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("flow.entities.BlockSeal").msgclass
+end