flow_client 0.1.0

data/lib/flow/legacy/entities/account_pb.rb

@@ -0,0 +1,28 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/legacy/entities/account.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/legacy/entities/account.proto", :syntax => :proto3) do
+    add_message "entities.Account" do
+      optional :address, :bytes, 1
+      optional :balance, :uint64, 2
+      optional :code, :bytes, 3
+      repeated :keys, :message, 4, "entities.AccountKey"
+    end
+    add_message "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
+    end
+  end
+end
+
+module Entities
+  Account = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.Account").msgclass
+  AccountKey = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.AccountKey").msgclass
+end

data/lib/flow/legacy/entities/block_header_pb.rb

@@ -0,0 +1,20 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/legacy/entities/block_header.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/legacy/entities/block_header.proto", :syntax => :proto3) do
+    add_message "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("entities.BlockHeader").msgclass
+end

data/lib/flow/legacy/entities/block_pb.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/legacy/entities/block.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+require 'flow/legacy/entities/collection_pb'
+require 'flow/legacy/entities/block_seal_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/legacy/entities/block.proto", :syntax => :proto3) do
+    add_message "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, "entities.CollectionGuarantee"
+      repeated :block_seals, :message, 6, "entities.BlockSeal"
+      repeated :signatures, :bytes, 7
+    end
+  end
+end
+
+module Entities
+  Block = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.Block").msgclass
+end

data/lib/flow/legacy/entities/block_seal_pb.rb

@@ -0,0 +1,19 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/legacy/entities/block_seal.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/legacy/entities/block_seal.proto", :syntax => :proto3) do
+    add_message "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("entities.BlockSeal").msgclass
+end

data/lib/flow/legacy/entities/collection_pb.rb

@@ -0,0 +1,22 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/legacy/entities/collection.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/legacy/entities/collection.proto", :syntax => :proto3) do
+    add_message "entities.Collection" do
+      optional :id, :bytes, 1
+      repeated :transaction_ids, :bytes, 2
+    end
+    add_message "entities.CollectionGuarantee" do
+      optional :collection_id, :bytes, 1
+      repeated :signatures, :bytes, 2
+    end
+  end
+end
+
+module Entities
+  Collection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.Collection").msgclass
+  CollectionGuarantee = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.CollectionGuarantee").msgclass
+end

data/lib/flow/legacy/entities/event_pb.rb

@@ -0,0 +1,20 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/legacy/entities/event.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/legacy/entities/event.proto", :syntax => :proto3) do
+    add_message "entities.Event" do
+      optional :type, :string, 1
+      optional :transaction_id, :bytes, 2
+      optional :transaction_index, :uint32, 3
+      optional :event_index, :uint32, 4
+      optional :payload, :bytes, 5
+    end
+  end
+end
+
+module Entities
+  Event = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.Event").msgclass
+end

data/lib/flow/legacy/entities/transaction_pb.rb

@@ -0,0 +1,45 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/legacy/entities/transaction.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/legacy/entities/transaction.proto", :syntax => :proto3) do
+    add_message "entities.Transaction" do
+      optional :script, :bytes, 1
+      repeated :arguments, :bytes, 2
+      optional :reference_block_id, :bytes, 3
+      optional :gas_limit, :uint64, 4
+      optional :proposal_key, :message, 5, "entities.Transaction.ProposalKey"
+      optional :payer, :bytes, 6
+      repeated :authorizers, :bytes, 7
+      repeated :payload_signatures, :message, 8, "entities.Transaction.Signature"
+      repeated :envelope_signatures, :message, 9, "entities.Transaction.Signature"
+    end
+    add_message "entities.Transaction.ProposalKey" do
+      optional :address, :bytes, 1
+      optional :key_id, :uint32, 2
+      optional :sequence_number, :uint64, 3
+    end
+    add_message "entities.Transaction.Signature" do
+      optional :address, :bytes, 1
+      optional :key_id, :uint32, 2
+      optional :signature, :bytes, 3
+    end
+    add_enum "entities.TransactionStatus" do
+      value :UNKNOWN, 0
+      value :PENDING, 1
+      value :FINALIZED, 2
+      value :EXECUTED, 3
+      value :SEALED, 4
+      value :EXPIRED, 5
+    end
+  end
+end
+
+module Entities
+  Transaction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.Transaction").msgclass
+  Transaction::ProposalKey = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.Transaction.ProposalKey").msgclass
+  Transaction::Signature = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.Transaction.Signature").msgclass
+  TransactionStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("entities.TransactionStatus").enummodule
+end

data/lib/flow/legacy/execution/execution_pb.rb

@@ -0,0 +1,65 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flow/legacy/execution/execution.proto
+
+require 'google/protobuf'
+
+require 'flow/legacy/entities/account_pb'
+require 'flow/legacy/entities/event_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("flow/legacy/execution/execution.proto", :syntax => :proto3) do
+    add_message "execution.PingRequest" do
+    end
+    add_message "execution.PingResponse" do
+    end
+    add_message "execution.GetAccountAtBlockIDRequest" do
+      optional :block_id, :bytes, 1
+      optional :address, :bytes, 2
+    end
+    add_message "execution.GetAccountAtBlockIDResponse" do
+      optional :account, :message, 1, "entities.Account"
+    end
+    add_message "execution.ExecuteScriptAtBlockIDRequest" do
+      optional :block_id, :bytes, 1
+      optional :script, :bytes, 2
+      repeated :arguments, :bytes, 3
+    end
+    add_message "execution.ExecuteScriptAtBlockIDResponse" do
+      optional :value, :bytes, 1
+    end
+    add_message "execution.GetEventsForBlockIDsResponse" do
+      repeated :results, :message, 1, "execution.GetEventsForBlockIDsResponse.Result"
+    end
+    add_message "execution.GetEventsForBlockIDsResponse.Result" do
+      optional :block_id, :bytes, 1
+      optional :block_height, :uint64, 2
+      repeated :events, :message, 3, "entities.Event"
+    end
+    add_message "execution.GetEventsForBlockIDsRequest" do
+      optional :type, :string, 1
+      repeated :block_ids, :bytes, 2
+    end
+    add_message "execution.GetTransactionResultRequest" do
+      optional :block_id, :bytes, 1
+      optional :transaction_id, :bytes, 2
+    end
+    add_message "execution.GetTransactionResultResponse" do
+      optional :status_code, :uint32, 1
+      optional :error_message, :string, 2
+      repeated :events, :message, 3, "entities.Event"
+    end
+  end
+end
+
+module Execution
+  PingRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.PingRequest").msgclass
+  PingResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.PingResponse").msgclass
+  GetAccountAtBlockIDRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.GetAccountAtBlockIDRequest").msgclass
+  GetAccountAtBlockIDResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.GetAccountAtBlockIDResponse").msgclass
+  ExecuteScriptAtBlockIDRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.ExecuteScriptAtBlockIDRequest").msgclass
+  ExecuteScriptAtBlockIDResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.ExecuteScriptAtBlockIDResponse").msgclass
+  GetEventsForBlockIDsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.GetEventsForBlockIDsResponse").msgclass
+  GetEventsForBlockIDsResponse::Result = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.GetEventsForBlockIDsResponse.Result").msgclass
+  GetEventsForBlockIDsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.GetEventsForBlockIDsRequest").msgclass
+  GetTransactionResultRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.GetTransactionResultRequest").msgclass
+  GetTransactionResultResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("execution.GetTransactionResultResponse").msgclass
+end

data/lib/flow/legacy/execution/execution_services_pb.rb

@@ -0,0 +1,42 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: flow/legacy/execution/execution.proto for package 'execution'
+
+require 'grpc'
+require 'flow/legacy/execution/execution_pb'
+
+module Execution
+  module ExecutionAPI
+    # ExecutionAPI is the API provided by the execution nodes.
+    class Service
+
+      include ::GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'execution.ExecutionAPI'
+
+      # Ping is used to check if the access node is alive and healthy.
+      rpc :Ping, ::Execution::PingRequest, ::Execution::PingResponse
+      # Accounts
+      #
+      # GetAccountAtBlockID gets an account by address at the given block ID
+      rpc :GetAccountAtBlockID, ::Execution::GetAccountAtBlockIDRequest, ::Execution::GetAccountAtBlockIDResponse
+      # Scripts
+      #
+      # ExecuteScriptAtBlockID executes a ready-only Cadence script against the
+      # execution state at the block with the given ID.
+      rpc :ExecuteScriptAtBlockID, ::Execution::ExecuteScriptAtBlockIDRequest, ::Execution::ExecuteScriptAtBlockIDResponse
+      # Events
+      #
+      # GetEventsForBlockIDs retrieves events for all the specified block IDs that
+      # have the given type
+      rpc :GetEventsForBlockIDs, ::Execution::GetEventsForBlockIDsRequest, ::Execution::GetEventsForBlockIDsResponse
+      # Transaction
+      #
+      # GetTransactionResult gets the result of a transaction.
+      rpc :GetTransactionResult, ::Execution::GetTransactionResultRequest, ::Execution::GetTransactionResultResponse
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/flow_client.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "flow_client/version"
+require "openssl"
+require "rlp"
+
+# Collection of classes to interact with the Flow blockchain
+module FlowClient
+  class Error < StandardError; end
+  require "flow_client/crypto"
+  require "flow_client/utils"
+  require "flow_client/client"
+  require "flow_client/transaction"
+end

data/lib/flow_client/client.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "flow/access/access_services_pb"
+require "flow/execution/execution_services_pb"
+require "json"
+
+# Collection of classes to interact with the Flow blockchain
+module FlowClient
+  # Flow client
+  class Client
+    attr_accessor :address_aliases
+
+    def initialize(node_address)
+      @stub = Access::AccessAPI::Stub.new(node_address, :this_channel_is_insecure)
+      @address_aliases = {}
+    end
+
+    def ping
+      req = Access::PingRequest.new
+      @stub.ping(req)
+    end
+
+    # Accounts
+    def get_account(address)
+      req = Access::GetAccountAtLatestBlockRequest.new(address: to_bytes(address))
+      res = @stub.get_account_at_latest_block(req)
+      res.account
+    end
+
+    # Scripts
+    def execute_script(script, args = [])
+      req = Access::ExecuteScriptAtLatestBlockRequest.new(
+        script: FlowClient::Utils.substitute_address_aliases(script, @address_aliases),
+        arguments: args
+      )
+      res = @stub.execute_script_at_latest_block(req)
+      parse_json(res.value)
+    end
+
+    # Blocks
+    def get_latest_block(is_sealed: true)
+      req = Access::GetLatestBlockRequest.new(
+        is_sealed: is_sealed
+      )
+
+      @stub.get_latest_block(req)
+    end
+
+    # Events
+    def get_events(type, start_height, end_height)
+      req = Access::GetEventsForHeightRangeRequest.new(
+        type: type,
+        start_height: start_height,
+        end_height: end_height
+      )
+      @stub.get_events_for_height_range(req)
+    end
+
+    # Transactions
+
+    # Send a FlowClient::Transaction transaction to the blockchain
+    def send_transaction(transaction)
+      transaction.address_aliases = @address_aliases
+      req = Access::SendTransactionRequest.new(
+        transaction: transaction.message
+      )
+      @stub.send_transaction(req)
+    end
+
+    def get_transaction(transaction_id)
+      req = Access::GetTransactionRequest.new(
+        id: to_bytes(transaction_id)
+      )
+      @stub.get_transaction(req)
+    end
+
+    def get_transaction_result(transaction_id)
+      req = Access::GetTransactionRequest.new(
+        id: to_bytes(transaction_id)
+      )
+      @stub.get_transaction_result(req)
+    end
+
+    private
+
+    def parse_json(event_payload)
+      JSON.parse(event_payload, object_class: OpenStruct)
+    end
+
+    def to_bytes(string)
+      [string].pack("H*")
+    end
+
+    def to_string(bytes)
+      bytes.unpack1("H*")
+    end
+  end
+end

data/lib/flow_client/crypto.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+module FlowClient
+  class Crypto
+    def self.sign(data, key)
+      digest = OpenSSL::Digest.digest("SHA3-256", data)
+      asn = key.dsa_sign_asn1(digest)
+      asn1 = OpenSSL::ASN1.decode(asn)
+      r, s = asn1.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)
+      combined_bytes.pack("C*")
+    end
+
+    # TODO: Handle both sig algos here
+    # secp256k1
+    # prime256v1
+    def self.key_from_hex_keys(private_hex, public_hex)
+      asn1 = OpenSSL::ASN1::Sequence(
+        [
+          OpenSSL::ASN1::Integer(1),
+          OpenSSL::ASN1::OctetString([private_hex].pack("H*")),
+          OpenSSL::ASN1::ObjectId("prime256v1", 0, :EXPLICIT),
+          OpenSSL::ASN1::BitString([public_hex].pack("H*"), 1, :EXPLICIT)
+        ]
+      )
+
+      OpenSSL::PKey::EC.new(asn1.to_der)
+    end
+  end
+end