flow_client 0.2.3-arm64-darwin-21

data/lib/flow_client/transaction.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require "flow/entities/transaction_pb"
+require "openssl"
+require "rlp"
+
+module FlowClient
+  # A Transaction is a full transaction object containing a payload and signatures.
+  class Transaction
+    TRANSACTION_DOMAIN_TAG = "FLOW-V0.0-transaction"
+
+    attr_accessor :script,
+                  :arguments,
+                  :reference_block_id,
+                  :gas_limit,
+                  :payer_address,
+                  :authorizer_addresses,
+                  :address_aliases,
+                  :proposal_key,
+                  :envelope_signatures,
+                  :payload_signatures
+
+    def initialize
+      @authorizer_addresses = []
+      @arguments = []
+      @script = ""
+      @gas_limit = 999
+      @envelope_signatures = []
+      @payload_signatures = []
+      @address_aliases = {}
+      @signers = {}
+      @proposal_key = ProposalKey.new
+    end
+
+    def arguments=(arguments)
+      arguments.to_a.each do |arg|
+        processed_arg = arg.instance_of?(OpenStruct) ? Utils.openstruct_to_json(arg) : arg
+        @arguments << processed_arg
+      end
+    end
+
+    def proposer_address=(address)
+      @proposal_key.address = address
+    end
+
+    def proposer_key_index=(index)
+      @proposal_key.key_id = index
+    end
+
+    def proposer_key_sequence_number=(sequence_number)
+      @proposal_key.sequence_number = sequence_number
+    end
+
+    def self.padded_transaction_domain_tag
+      Utils.right_pad_bytes(TRANSACTION_DOMAIN_TAG.bytes, 32).pack("c*")
+    end
+
+    def add_envelope_signature(signer_address, key_index, signer)
+      domain_tagged_envelope = (Transaction.padded_transaction_domain_tag.bytes + envelope_message.bytes).pack("C*")
+
+      @envelope_signatures << Entities::Transaction::Signature.new(
+        address: padded_address(signer_address),
+        key_id: key_index,
+        signature: signer.sign(domain_tagged_envelope)
+      )
+    end
+
+    def add_payload_signature(signer_address, key_index, signer)
+      domain_tagged_payload = (Transaction.padded_transaction_domain_tag.bytes + payload_message.bytes).pack("C*")
+
+      @payload_signatures << Entities::Transaction::Signature.new(
+        address: padded_address(signer_address),
+        key_id: key_index,
+        signature: signer.sign(domain_tagged_payload)
+      )
+    end
+
+    def to_protobuf_message
+      payload = payload_canonical_form
+
+      proposal_key = Entities::Transaction::ProposalKey.new(
+        address: payload[4],
+        key_id: payload[5],
+        sequence_number: payload[6]
+      )
+
+      Entities::Transaction.new(script: payload[0], arguments: payload[1],
+                                reference_block_id: payload[2], gas_limit: payload[3], proposal_key: proposal_key,
+                                payer: payload[7], authorizers: payload[8], payload_signatures: @payload_signatures,
+                                envelope_signatures: @envelope_signatures)
+    end
+
+    def self.parse_grpc_type(type)
+      tx = Transaction.new
+      tx.script = type.script
+      tx.arguments = type.arguments
+      tx.reference_block_id = type.reference_block_id.unpack1("H*")
+      tx.gas_limit = type.gas_limit
+      tx.authorizer_addresses = type.authorizers.map { |address| address.unpack1("H*") }
+      tx.envelope_signatures = type.envelope_signatures.map { |sig| Signature.parse_grpc_type(sig) }
+      tx.payload_signatures = type.payload_signatures.map { |sig| Signature.parse_grpc_type(sig) }
+      tx.proposal_key = ProposalKey.parse_grpc_type(type.proposal_key)
+      tx.payer_address = type.payer.unpack1("H*")
+      tx
+    end
+
+    protected
+    
+    def resolved_script
+      FlowClient::Utils.substitute_address_aliases(@script, @address_aliases)
+    end
+
+    def padded_address(address_hex_string)
+      Utils.left_pad_bytes([address_hex_string].pack("H*").bytes, 8).pack("C*")
+    end
+
+    def payload_canonical_form
+      [
+        resolved_script, @arguments,
+        [@reference_block_id].pack("H*"), @gas_limit,
+        padded_address(@proposal_key.address), @proposal_key.key_id,
+        @proposal_key.sequence_number, padded_address(@payer_address),
+        @authorizer_addresses.map { |address| padded_address(address) }
+      ]
+    end
+
+    def payload_message
+      payload = payload_canonical_form
+      RLP.encode(payload)
+    end
+
+    def envelope_canonical_form
+      @signers[@proposal_key.address] = 0
+
+      @payload_signatures.each do |sig|
+        @signers[sig.address] = @signers.keys.count
+      end
+
+      signatures = []
+      @payload_signatures.each do |sig|
+        signatures << [
+          @signers[sig.address.unpack1("H*")],
+          sig.key_id,
+          sig.signature
+        ]
+      end
+
+      [
+        payload_canonical_form,
+        signatures
+      ]
+    end
+
+    def envelope_message
+      RLP.encode(envelope_canonical_form)
+    end
+
+    def payload_message
+      RLP.encode(payload_canonical_form)
+    end
+  end
+
+  class TransactionResult
+    attr_accessor :status,
+                  :status_code,
+                  :error_message,
+                  :events,
+                  :block_id
+
+    def self.parse_grpc_type(type)
+      result = TransactionResult.new
+      result.block_id = type.block_id.unpack1("H*")
+      result.status = type.status
+      result.status_code = type.status_code
+      result.error_message = type.error_message
+      result.events = type.events.to_a.map { |event| FlowClient::Event.parse_grpc_type(event) }
+      result
+    end
+  end
+
+  class TransactionResponse
+    attr_accessor :id
+
+    def self.parse_grpc_type(type)
+      response = TransactionResponse.new
+      response.id = type.id.unpack1("H*")
+      response
+    end
+  end
+end

data/lib/flow_client/utils.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module FlowClient
+  # A collection of utilities.
+  module Utils
+    # Left pads a byte array with 0 to length
+    def self.left_pad_bytes(byte_array, length)
+      required_pad_count = length - byte_array.count
+      padding = []
+      (1..required_pad_count).each do |_i|
+        padding << 0
+      end
+      padding + byte_array
+    end
+
+    # Right pads a byte array with 0 to length
+    def self.right_pad_bytes(byte_array, length)
+      required_pad_count = length - byte_array.count
+      padding = []
+      (1..required_pad_count).each do |_i|
+        padding << 0
+      end
+      byte_array + padding
+    end
+
+    # Substitutes Candence import statements using aliases with addresses
+    # e.g. import FungibleToken from 0xFUNGIBLE_TOKEN_ADDRESS.
+    #
+    # aliases is a hash with aliases as string keys and addresses as values,
+    # e.g. { "0xFUNGIBLE_TOKEN_ADDRESS": "0x0" }
+    def self.substitute_address_aliases(script_or_transaction, aliases = {})
+      new_string = script_or_transaction
+      aliases.each do |key, value|
+        new_string = new_string.gsub(key.to_s, value.to_s)
+      end
+      new_string
+    end
+
+    def self.strip_address_prefix(address)
+      address[0..1]
+    end
+
+    def self.parse_protobuf_timestamp(timestamp)
+      epoch_micros = timestamp.nanos / 10 ** 6
+      Time.at(timestamp.seconds, epoch_micros)
+    end
+
+    def self.openstruct_to_json(struct)
+      struct.deep_to_h.to_json
+    end
+  end
+end
+
+class OpenStruct
+  def deep_to_h
+    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
+  end
+end

data/lib/flow_client/version.rb

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

data/lib/flow_client.rb

@@ -0,0 +1,22 @@
+# 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"
+  require "flow_client/account"
+  require "flow_client/block"
+  require "flow_client/collection"
+  require "flow_client/signer"
+  require "flow_client/proposal_key"
+  require "flow_client/event"
+  require "flow_client/cadence_type"
+  require "flow_client/signature"
+end

data/logo.svg

@@ -0,0 +1,121 @@
+<svg width="520" height="520" viewBox="0 0 520 520" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M259.501 0L389.251 34.8334L484.235 130L519.002 260L484.235 390L389.251 485.167L259.501 520L129.75 485.167L34.7665 390L0 260L34.7665 130L129.75 34.8334L259.501 0Z" fill="#9B1106"/>
+<path d="M266.488 391L369.026 131L484.069 390.301L266.488 391Z" fill="url(#paint0_linear_10:64)"/>
+<path d="M34.9328 390.301L149.002 131L266.487 391L34.9328 390.301Z" fill="url(#paint1_linear_10:64)"/>
+<path d="M34.9328 390.298L68.7848 313L266.487 391L34.9328 390.298Z" fill="url(#paint2_linear_10:64)"/>
+<path d="M266.488 391L369.11 131L394.242 391H266.488Z" fill="url(#paint3_linear_10:64)"/>
+<path d="M369.29 131H148.714L259.853 390L369.29 131Z" fill="url(#paint4_linear_10:64)"/>
+<path d="M369.29 131H148.714L322.522 249L369.29 131Z" fill="url(#paint5_linear_10:64)"/>
+<path d="M484.069 130L369.29 130.699L484.069 390V130Z" fill="url(#paint6_linear_10:64)"/>
+<path d="M425.661 131H369.29L484.069 390L425.661 131Z" fill="url(#paint7_linear_10:64)"/>
+<path d="M484.069 130L520 260L484.069 390V130Z" fill="url(#paint8_linear_10:64)"/>
+<path d="M34.9328 130L148.714 130.699L34.9328 390V130Z" fill="url(#paint9_linear_10:64)"/>
+<path d="M96.7071 131H148.714L34.9328 390L96.7071 131Z" fill="url(#paint10_linear_10:64)"/>
+<path d="M34.9328 130L-2.28882e-05 260L34.9328 390V130Z" fill="url(#paint11_linear_10:64)"/>
+<path d="M369.02 131L484.069 130.299L259.501 0L369.02 131Z" fill="url(#paint12_linear_10:64)"/>
+<path d="M388.846 34.5923L484.069 130L259.501 0L388.846 34.5923Z" fill="url(#paint13_linear_10:64)"/>
+<path d="M148.984 131L34.9328 130.299L259.501 0L148.984 131Z" fill="url(#paint14_linear_10:64)"/>
+<path d="M129.26 34.5923L34.9328 130L259.501 0L129.26 34.5923Z" fill="url(#paint15_linear_10:64)"/>
+<path d="M42.9175 391L259.119 520L266.488 391H42.9175Z" fill="url(#paint16_linear_10:64)"/>
+<path d="M34.9328 390L259.501 520V390.699L34.9328 390Z" fill="url(#paint17_linear_10:64)"/>
+<path d="M34.9328 390L259.501 520L129.985 484.85L34.9328 390Z" fill="url(#paint18_linear_10:64)"/>
+<path d="M484.069 390L259.501 520V390.699L484.069 390Z" fill="url(#paint19_linear_10:64)"/>
+<path d="M484.069 390L259.501 520L395.687 485.753L484.069 390Z" fill="url(#paint20_linear_10:64)"/>
+<path d="M369.29 131H148.714L259.7 0L369.29 131Z" fill="url(#paint21_linear_10:64)"/>
+<path d="M259.501 131H148.714L259.501 0V131Z" fill="url(#paint22_linear_10:64)"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M402.71 183.598H326.687C312.821 183.598 301.346 195.096 301.346 208.988V217.611H233.928V208.988C233.928 157.729 275.526 116.052 326.687 116.052H402.71V183.598ZM233.928 285.158L233.928 217.611L208.587 217.611C157.427 217.611 115.829 259.289 115.829 310.548C115.829 361.807 157.427 403.485 208.587 403.485C259.748 403.485 301.346 361.807 301.346 310.548V285.158H233.928ZM233.928 285.158V310.548C233.928 324.441 222.453 335.938 208.587 335.938C194.721 335.938 183.246 324.441 183.246 310.548C183.246 296.656 194.721 285.158 208.587 285.158H233.928ZM368.764 217.611H301.346V285.158H368.764V217.611Z" fill="white"/>
+<defs>
+<linearGradient id="paint0_linear_10:64" x1="445.058" y1="354.656" x2="336.044" y2="254.925" gradientUnits="userSpaceOnUse">
+<stop stop-color="#D9190A"/>
+<stop offset="1" stop-color="#9A1106"/>
+</linearGradient>
+<linearGradient id="paint1_linear_10:64" x1="70.4467" y1="246.323" x2="207.909" y2="346.264" gradientUnits="userSpaceOnUse">
+<stop stop-color="#D9190A"/>
+<stop offset="1" stop-color="#9A1106"/>
+</linearGradient>
+<linearGradient id="paint2_linear_10:64" x1="91.3021" y1="353.11" x2="253.431" y2="390.337" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FF3323"/>
+<stop offset="1" stop-color="#9A1106"/>
+</linearGradient>
+<linearGradient id="paint3_linear_10:64" x1="362.827" y1="177.129" x2="336.238" y2="363.733" gradientUnits="userSpaceOnUse">
+<stop stop-color="#9A1106"/>
+<stop offset="1" stop-color="#9A1106" stop-opacity="0"/>
+</linearGradient>
+<linearGradient id="paint4_linear_10:64" x1="318.334" y1="268.528" x2="181.125" y2="126.36" gradientUnits="userSpaceOnUse">
+<stop stop-color="#D9190A"/>
+<stop offset="1" stop-color="#A91004"/>
+</linearGradient>
+<linearGradient id="paint5_linear_10:64" x1="325.314" y1="189.651" x2="172.62" y2="124.665" gradientUnits="userSpaceOnUse">
+<stop stop-color="#A91004" stop-opacity="0"/>
+<stop offset="1" stop-color="#961106"/>
+</linearGradient>
+<linearGradient id="paint6_linear_10:64" x1="457.674" y1="134.194" x2="473.116" y2="350.851" gradientUnits="userSpaceOnUse">
+<stop stop-color="#CF190A"/>
+<stop offset="1" stop-color="#FF2312"/>
+</linearGradient>
+<linearGradient id="paint7_linear_10:64" x1="457.674" y1="134.491" x2="468.878" y2="217.557" gradientUnits="userSpaceOnUse">
+<stop stop-color="#CF190A"/>
+<stop offset="1" stop-color="#FF2312"/>
+</linearGradient>
+<linearGradient id="paint8_linear_10:64" x1="456.972" y1="134.194" x2="500.804" y2="357.522" gradientUnits="userSpaceOnUse">
+<stop offset="0.522094" stop-color="#CF190A"/>
+<stop offset="1" stop-color="#FF2312"/>
+</linearGradient>
+<linearGradient id="paint9_linear_10:64" x1="49.5543" y1="339.677" x2="109.359" y2="136.545" gradientUnits="userSpaceOnUse">
+<stop stop-color="#CF190A"/>
+<stop offset="1" stop-color="#FF2312"/>
+</linearGradient>
+<linearGradient id="paint10_linear_10:64" x1="103.641" y1="202.208" x2="149.194" y2="115.195" gradientUnits="userSpaceOnUse">
+<stop stop-color="#CF190A"/>
+<stop offset="1" stop-color="#FF2312"/>
+</linearGradient>
+<linearGradient id="paint11_linear_10:64" x1="19.4657" y1="246.72" x2="-53.0048" y2="146.796" gradientUnits="userSpaceOnUse">
+<stop stop-color="#CF190A"/>
+<stop offset="1" stop-color="#FF2312"/>
+</linearGradient>
+<linearGradient id="paint12_linear_10:64" x1="445.753" y1="121.893" x2="239.447" y2="-12.5097" gradientUnits="userSpaceOnUse">
+<stop stop-color="#9E1206"/>
+<stop offset="1" stop-color="#FC2312"/>
+</linearGradient>
+<linearGradient id="paint13_linear_10:64" x1="370.415" y1="65" x2="389.301" y2="35.6784" gradientUnits="userSpaceOnUse">
+<stop stop-color="#9E1206"/>
+<stop offset="1" stop-color="#FC2312"/>
+</linearGradient>
+<linearGradient id="paint14_linear_10:64" x1="76.0017" y1="127.497" x2="226.893" y2="24.2219" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FF4E40"/>
+<stop offset="1" stop-color="#FC2312"/>
+</linearGradient>
+<linearGradient id="paint15_linear_10:64" x1="124.657" y1="38.4409" x2="129.576" y2="84.5642" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FF4E40"/>
+<stop offset="1" stop-color="#FC2312"/>
+</linearGradient>
+<linearGradient id="paint16_linear_10:64" x1="112.565" y1="411.919" x2="267.243" y2="480.12" gradientUnits="userSpaceOnUse">
+<stop stop-color="#A21207"/>
+<stop offset="1" stop-color="#FE4132"/>
+</linearGradient>
+<linearGradient id="paint17_linear_10:64" x1="112.981" y1="411.667" x2="267.752" y2="479.734" gradientUnits="userSpaceOnUse">
+<stop stop-color="#A21207"/>
+<stop offset="1" stop-color="#FF2412"/>
+</linearGradient>
+<linearGradient id="paint18_linear_10:64" x1="93.4836" y1="419.355" x2="148.744" y2="488.347" gradientUnits="userSpaceOnUse">
+<stop stop-color="#A21207"/>
+<stop offset="1" stop-color="#F82312"/>
+</linearGradient>
+<linearGradient id="paint19_linear_10:64" x1="374.101" y1="438.925" x2="258.309" y2="374.99" gradientUnits="userSpaceOnUse">
+<stop stop-color="#A21207"/>
+<stop offset="1" stop-color="#EA1F0F"/>
+</linearGradient>
+<linearGradient id="paint20_linear_10:64" x1="356.693" y1="471.075" x2="453.582" y2="432.186" gradientUnits="userSpaceOnUse">
+<stop stop-color="#A21207"/>
+<stop offset="1" stop-color="#F92413"/>
+</linearGradient>
+<linearGradient id="paint21_linear_10:64" x1="259.002" y1="0" x2="259.002" y2="99.4759" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FC2312"/>
+<stop offset="1" stop-color="#AE1508"/>
+</linearGradient>
+<linearGradient id="paint22_linear_10:64" x1="241.385" y1="38.5294" x2="189.428" y2="119.538" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FC2312"/>
+<stop offset="1" stop-color="#A01106"/>
+</linearGradient>
+</defs>
+</svg>