flow_client 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f5ab2e4ba804c2d62cb6483b8f79944ac2d9d8e3b29f9c31b4f3fb40bbc8650
-  data.tar.gz: 6cfdbcf1263662d94b7e7623c43904baeb63d992a1fb7ab572b38564377b20d6
+  metadata.gz: 91c782ac6146b291f2691e51a0ff9bf09fafb58d1fec9ec9d10ae80e3ea6c058
+  data.tar.gz: e53438e01826e7a68c0868bed486ca51f256e42b2f574e62bee710be88217450
 SHA512:
-  metadata.gz: 7accd7d47a96f1f8867870b04e7c3fa987a6d157f124c236997fc9b8da42796affa0678ca607696f0e172ab5c4bc10ce363c7a3d42eae538c49051dbde932874
-  data.tar.gz: fcd4d4672971546ac525e378bd33175a94bb69ca83bef0af257a7762cdc911330fb8e28fcc0825a20ae97282ba27d666fcbd1c93b68911ae94e83cc6743d3264
+  metadata.gz: ecec4b82c34c78f62daf55f048cd7a384e17e14a721162eb40b69b00f9d24bc96bae36a03d9c81105fdaa0beb04632a6ce5a05f57b424d97dd1326db460b58a3
+  data.tar.gz: a61e7d290d229a990df2e75af28f27f01ef73afbc5aaf8fabea882d8efbbf15e631fcaedf975076e1776a018194cc8ad6c3d304d0baaf5e344c962fc02e2d626

data/CHANGELOG.md

@@ -12,4 +12,9 @@
 
 - Added multiple signature support
 - Added multi-party signing
-- Added account creation
+- Added account creation
+- 
+## [0.2.1] - 2021-11-08
+
+- Fixed incorrect CadenceType conversions
+- Updated usage examples

data/README.md

@@ -62,7 +62,7 @@ res = client.ping
 After you have established a connection with an access node, you can query the Flow network to retrieve data about blocks, accounts, events and transactions. We will explore how to retrieve each of these entities in the sections below.
 
 ### Get Blocks
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client)
 
 Query the network for block by id, height or get the latest block.
 
@@ -104,7 +104,7 @@ Result output:
 ```
 
 ### Get Account
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient%2FClient:get_account)
 
 Retrieve any account from Flow network's latest block or from a specified block height.
 
@@ -133,7 +133,7 @@ Result output:
 
 
 ### Get Transactions
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#get_transaction-instance_method)
 
 Retrieve transactions from the network by providing a transaction ID. After a transaction has been submitted, you can also get the transaction result to check the status.
 
@@ -233,7 +233,7 @@ Example output:
 
 
 ### Get Events
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#get_events-instance_method)
 
 Retrieve events by a given type in a specified block height range or through a list of block IDs.
 
@@ -277,7 +277,7 @@ Example output:
 ```
 
 ### Get Collections
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#get_collection_by_id-instance_method)
 
 Retrieve a batch of transactions that have been included in the same block, known as ***collections***. 
 Collections are used to improve consensus throughput by increasing the number of transactions per block and they act as a link between a block and a transaction.
@@ -294,7 +294,7 @@ Example output:
 ```
 
 ### Execute Scripts
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#execute_script-instance_method)
 
 Scripts allow you to write arbitrary non-mutating Cadence code on the Flow blockchain and return data. You can learn more about [Cadence and scripts here](https://docs.onflow.org/cadence/language/), but we are now only interested in executing the script code and getting back the data.
 
@@ -312,7 +312,7 @@ script = %{
   }
 }
 
-args = [{ type: 'Int', value: "1" }.to_json]
+args = [FlowClient::CadenceType.Int(1)]
 res = client.execute_script(script, args)
 ```
 
@@ -407,7 +407,7 @@ A transaction will be rejected if it is submitted past its expiry block. Flow ca
 A transaction expires after `600` blocks are committed on top of the reference block, which takes about 10 minutes at average Mainnet block rates.
 
 ### Build Transactions
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Transaction)
 
 Building a transaction involves setting the required properties explained above and producing a transaction object. 
 
@@ -456,7 +456,7 @@ transaction.arguments = arguments
 After you have successfully [built a transaction](#build-transactions) the next step in the process is to sign it.
 
 ### Sign Transactions
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Transaction)
 
 Flow introduces new concepts that allow for more flexibility when creating and signing transactions.
 Before trying the examples below, we recommend that you read through the [transaction signature documentation](https://docs.onflow.org/concepts/accounts-and-keys/).
@@ -478,7 +478,7 @@ Signatures can be generated more securely using keys stored in a hardware device
 
 Simple signature example:
 ```ruby
-account = FlowClient::Account.new(address: 0x01)
+account = client.get_account("0x01")
 signer = FlowClient::LocalSigner.new("<private key hex>")
 
 transaction.proposer_address = account.address
@@ -503,7 +503,7 @@ Flow supports great flexibility when it comes to transaction signing, we can def
 | `0x01`  | 1      | 1.0    |
 
 ```ruby
-account = FlowClient::Account.new(address: 0x01)
+account = client.get_account("0x01")
 
 transaction = FlowClient::Transaction.new
 transaction.reference_block_id = client.get_latest_block.id
@@ -532,7 +532,7 @@ transaction.add_envelope_signature(account.address, account.keys.first.index, si
 | `0x01`  | 2      | 0.5    |
 
 ```ruby
-account = FlowClient::Account.new(address: 0x01)
+account = client.get_account("0x01")
 
 transaction = FlowClient::Transaction.new
 transaction.reference_block_id = client.get_latest_block.id
@@ -563,10 +563,10 @@ transaction.add_envelope_signature(account.address, account.keys[1].index, signe
 
 ```ruby
 payer_signer = FlowClient::LocalSigner.new("<private key hex>")
-payer_account = FlowClient::Account.new(address: 0x02)
+payer_account = client.get_account("0x02")
 
 proposer_signer = FlowClient::LocalSigner.new("<private key hex>")
-proposer_account = FlowClient::Account.new(address: 0x01)
+proposer_account = client.get_account("0x01")
 
 @transaction = FlowClient::Transaction.new
 @transaction.reference_block_id = client.get_latest_block.id
@@ -599,10 +599,10 @@ proposer_account = FlowClient::Account.new(address: 0x01)
 
 ```ruby
 payer_signer = FlowClient::LocalSigner.new("<private key hex>")
-payer_account = FlowClient::Account.new(address: 0x02)
+payer_account = client.get_account("0x02")
 
 proposer_signer = FlowClient::LocalSigner.new("<private key hex>")
-proposer_account = FlowClient::Account.new(address: 0x01)
+proposer_account = client.get_account("0x01")
 
 @transaction = FlowClient::Transaction.new
 @transaction.reference_block_id = client.get_latest_block.id
@@ -637,10 +637,10 @@ proposer_account = FlowClient::Account.new(address: 0x01)
 
 ```ruby
 payer_signer = FlowClient::LocalSigner.new("<private key hex>")
-payer_account = FlowClient::Account.new(address: 0x02)
+payer_account = client.get_account("0x02")
 
 proposer_signer = FlowClient::LocalSigner.new("<private key hex>")
-proposer_account = FlowClient::Account.new(address: 0x01)
+proposer_account = client.get_account("0x01")
 
 @transaction = FlowClient::Transaction.new
 @transaction.reference_block_id = client.get_latest_block.id
@@ -661,7 +661,7 @@ proposer_account = FlowClient::Account.new(address: 0x01)
 
 
 ### Send Transactions
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#send_transaction-instance_method)
 
 After a transaction has been [built](#build-transactions) and [signed](#sign-transactions), it can be sent to the Flow blockchain where it will be executed. If sending was successful you can then [retrieve the transaction result](#get-transactions).
 
@@ -675,7 +675,7 @@ end
 
 
 ### Create Accounts
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#create_account-instance_method)
 
 On Flow, account creation happens inside a transaction. Because the network allows for a many-to-many relationship between public keys and accounts, it's not possible to derive a new account address from a public key offline. 
 
@@ -700,13 +700,13 @@ Account creation happens inside a transaction, which means that somebody must pa
 
 ```ruby
 # The account that will pay for the creation of the new account
-account = FlowClient::Account.new(address: "f8d6e0586b0a20c7")
+payer_account = client.get_account("f8d6e0586b0a20c7")
 # Create an in-memory signer with the payer's private key
 signer = FlowClient::LocalSigner.new("4d9287571c8bff7482ffc27ef68d5b4990f9bd009a1e9fa812aae08ba167d57f")
 # Generate a public key for the new account
 _private_key, public_key = FlowClient::Crypto.generate_key_pair(FlowClient::Crypto::Curves::P256)
 # Create the account
-res = client.create_account([public_key], { "ContractName": "<contract cadence code>" }, account, signer)
+res = client.create_account([public_key], { "ContractName": "<contract cadence code>" }, payer_account, signer)
 ```
 
 ```ruby
@@ -726,7 +726,7 @@ res.address
 ```
 
 ### Generate Keys
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Crypto#generate_key_pair-class_method)
 
 Flow uses [ECDSA](https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm) signatures to control access to user accounts. Each key pair can be used in combination with the `SHA2-256` or `SHA3-256` hashing algorithms.
 
@@ -744,4 +744,4 @@ The example above uses an ECDSA key pair on the P-256 (secp256r1) elliptic curve
 
 ```ruby
 private_key, public_key = FlowClient::Crypto.generate_key_pair(FlowClient::Crypto::Curves::SECP256K1)
-```
+```

data/lib/flow_client/cadence_type.rb

@@ -2,14 +2,6 @@ require "ostruct"
 
 module FlowClient
   module CadenceType
-    # class CadenceType
-    #   def to_json
-    #   end
-    # end
-
-    # class String
-    # end
-
     def self.String(value)
       OpenStruct.new(type: "String", value: value.to_s)
     end
@@ -35,111 +27,87 @@ module FlowClient
     end
 
     def self.UInt(value)
-      OpenStruct.new(type: "UInt", value: value.to_i)
+      OpenStruct.new(type: "UInt", value: value.to_s)
     end
 
     def self.Int8(value)
-      OpenStruct.new(type: "Int8", value: value.to_i)
+      OpenStruct.new(type: "Int8", value: value.to_s)
     end
 
     def self.UInt8(value)
-      OpenStruct.new(type: "UInt8", value: value.to_i)
+      OpenStruct.new(type: "UInt8", value: value.to_s)
     end
 
     def self.Int16(value)
-      OpenStruct.new(type: "Int16", value: value.to_i)
+      OpenStruct.new(type: "Int16", value: value.to_s)
     end
 
     def self.UInt16(value)
-      OpenStruct.new(type: "UInt16", value: value.to_i)
+      OpenStruct.new(type: "UInt16", value: value.to_s)
     end
 
     def self.Int32(value)
-      OpenStruct.new(type: "Int32", value: value.to_i)
+      OpenStruct.new(type: "Int32", value: value.to_s)
     end
 
     def self.UInt32(value)
-      OpenStruct.new(type: "UInt32", value: value.to_i)
+      OpenStruct.new(type: "UInt32", value: value.to_s)
     end
 
     def self.Int64(value)
-      OpenStruct.new(type: "Int64", value: value.to_i)
+      OpenStruct.new(type: "Int64", value: value.to_s)
     end
 
     def self.UInt64(value)
-      OpenStruct.new(type: "UInt64", value: value.to_i)
+      OpenStruct.new(type: "UInt64", value: value.to_s)
     end
 
     def self.Int64(value)
-      OpenStruct.new(type: "Int64", value: value.to_i)
+      OpenStruct.new(type: "Int64", value: value.to_s)
     end
 
     def self.UInt64(value)
-      OpenStruct.new(type: "UInt64", value: value.to_i)
+      OpenStruct.new(type: "UInt64", value: value.to_s)
     end
 
     def self.Int128(value)
-      OpenStruct.new(type: "Int128", value: value.to_i)
+      OpenStruct.new(type: "Int128", value: value.to_s)
     end
 
     def self.UInt128(value)
-      OpenStruct.new(type: "UInt128", value: value.to_i)
+      OpenStruct.new(type: "UInt128", value: value.to_s)
     end
 
     def self.Int256(value)
-      OpenStruct.new(type: "Int256", value: value.to_i)
+      OpenStruct.new(type: "Int256", value: value.to_s)
     end
 
     def self.UInt256(value)
-      OpenStruct.new(type: "UInt256", value: value.to_i)
-    end
-
-    def self.Word8(value)
-      OpenStruct.new(type: "Word8", value: value.to_i)
+      OpenStruct.new(type: "UInt256", value: value.to_s)
     end
 
     def self.Word8(value)
-      OpenStruct.new(type: "Word8", value: value.to_i)
+      OpenStruct.new(type: "Word8", value: value.to_s)
     end
 
     def self.Word16(value)
-      OpenStruct.new(type: "Word16", value: value.to_i)
-    end
-
-    def self.Word16(value)
-      OpenStruct.new(type: "Word16", value: value.to_i)
-    end
-
-    def self.Word32(value)
-      OpenStruct.new(type: "Word32", value: value.to_i)
+      OpenStruct.new(type: "Word16", value: value.to_s)
     end
 
     def self.Word32(value)
-      OpenStruct.new(type: "Word32", value: value.to_i)
+      OpenStruct.new(type: "Word32", value: value.to_s)
     end
 
     def self.Word64(value)
-      OpenStruct.new(type: "Word64", value: value.to_i)
-    end
-
-    def self.Word64(value)
-      OpenStruct.new(type: "Word64", value: value.to_i)
-    end
-
-    def self.Fix64(value)
-      OpenStruct.new(type: "Fix64", value: value.to_i)
+      OpenStruct.new(type: "Word64", value: value.to_s)
     end
 
     def self.Fix64(value)
-      OpenStruct.new(type: "Fix64", value: value.to_i)
-    end
-
-    def self.UFix64(value)
-      OpenStruct.new(type: "Fix64", value: value.to_i)
+      OpenStruct.new(type: "Fix64", value: value.to_s)
     end
 
     def self.UFix64(value)
-      OpenStruct.new(type: "Fix64", value: value.to_i)
+      OpenStruct.new(type: "UFix64", value: value.to_s)
     end
 
     def self.Array(values)
@@ -171,11 +139,11 @@ module FlowClient
 
     def self.Capability(path, address, borrow_type)
       OpenStruct.new(
-        type: "Type",
+        type: "Capability",
         value: OpenStruct.new(
           path: path.to_s,
           address: address.to_s,
-          borrow_type: borrow_type.to_s
+          borrowType: borrow_type.to_s
         )
       )
     end

data/lib/flow_client/client.rb

@@ -26,9 +26,12 @@ module FlowClient
       @stub.ping(req)
     end
 
-    # Accounts
+    # :section: Accounts
 
-    # Gets an account
+    # Returns an account for the address specified at the latest
+    # block.
+    #
+    # @return [FlowClient::Account] the account 
     def get_account(address)
       req = Access::GetAccountAtLatestBlockRequest.new(address: to_bytes(address))
 
@@ -53,14 +56,13 @@ module FlowClient
         end
 
         account.contracts = res.account.contracts
-
         account
       end
     end
 
     # Creates a new account
     #
-    # 
+    # @return [FlowClient::Account] the newly created account 
     def create_account(new_account_public_keys, contracts, payer_account, signer)
       script = File.read(File.join("lib", "cadence", "templates", "create-account.cdc"))
 
@@ -105,14 +107,8 @@ module FlowClient
       script = File.read(File.join("lib", "cadence", "templates", "add-account-key.cdc"))
 
       arguments = [
-        {
-          type: "String",
-          value: public_key_hex
-        }.to_json,
-        {
-          type: "UFix64",
-          value: weight.to_s
-        }.to_json
+        CadenceType.String(public_key_hex),
+        CadenceType.UFix64(weight)
       ]
 
       transaction = FlowClient::Transaction.new
@@ -138,14 +134,8 @@ module FlowClient
       code_hex = code.unpack1("H*")
 
       arguments = [
-        {
-          type: "String",
-          value: name
-        }.to_json,
-        {
-          type: "String",
-          value: code_hex
-        }.to_json
+        CadenceType.String(name),
+        CadenceType.String(code_hex)
       ]
 
       transaction = FlowClient::Transaction.new
@@ -170,10 +160,7 @@ module FlowClient
       script = File.read(File.join("lib", "cadence", "templates", "remove-contract.cdc"))
 
       arguments = [
-        {
-          type: "String",
-          value: name
-        }.to_json
+        CadenceType.String(name),
       ]
 
       transaction = FlowClient::Transaction.new
@@ -199,14 +186,8 @@ module FlowClient
       code_hex = code.unpack1("H*")
 
       arguments = [
-        {
-          type: "String",
-          value: name
-        }.to_json,
-        {
-          type: "String",
-          value: code_hex
-        }.to_json
+        CadenceType.String(name),
+        CadenceType.String(code_hex)
       ]
 
       transaction = FlowClient::Transaction.new
@@ -226,7 +207,9 @@ module FlowClient
       end
     end
 
-    # Scripts
+    # :section: Scripts
+
+    # Executes a script on the blockchain
     def execute_script(script, args = [])
       processed_args = []
       args.to_a.each do |arg|
@@ -243,7 +226,11 @@ module FlowClient
       parse_json(res.value)
     end
 
-    # Blocks
+    # :section: Blocks
+
+    # Returns the latest block
+    #
+    # @return [FlowClient::Block] the block
     def get_latest_block(is_sealed: true)
       req = Access::GetLatestBlockRequest.new(
         is_sealed: is_sealed
@@ -252,6 +239,9 @@ module FlowClient
       Block.parse_grpc_block_response(res)
     end
 
+    # Returns the block with id
+    #
+    # @return [FlowClient::Block] the block
     def get_block_by_id(id)
       req = Access::GetBlockByIDRequest.new(
         id: to_bytes(id)
@@ -260,6 +250,9 @@ module FlowClient
       Block.parse_grpc_block_response(res)
     end
 
+    # Returns the latest with height
+    #
+    # @return [FlowClient::Block] the block
     def get_block_by_height(height)
       req = Access::GetBlockByHeightRequest.new(
         height: height
@@ -268,7 +261,11 @@ module FlowClient
       Block.parse_grpc_block_response(res)
     end
 
-    # Collections
+    # :section: Collections
+
+    # Returns the collection with id
+    #
+    # @return [FlowClient::Collection] the collection
     def get_collection_by_id(id)
       req = Access::GetCollectionByIDRequest.new(
         id: to_bytes(id)
@@ -277,7 +274,9 @@ module FlowClient
       Collection.parse_grpc_type(res)
     end
 
-    # Events
+    # :section: Events
+
+    # Returns events of the given type between the start and end block heights.
     def get_events(type, start_height, end_height)
       req = Access::GetEventsForHeightRangeRequest.new(
         type: type,
@@ -293,9 +292,11 @@ module FlowClient
       end
     end
 
-    # Transactions
+    # :section: Transactions
 
     # Sends a transaction to the blockchain
+    #
+    # @return [FlowClient::TransactionResponse] the transaction response
     def send_transaction(transaction)
       transaction.address_aliases = @address_aliases
       req = Access::SendTransactionRequest.new(
@@ -311,6 +312,9 @@ module FlowClient
       end
     end
 
+    # Returns the transaction with transaction_id
+    #
+    # @return [FlowClient::Transaction] the transaction
     def get_transaction(transaction_id)
       req = Access::GetTransactionRequest.new(
         id: to_bytes(transaction_id)
@@ -326,6 +330,8 @@ module FlowClient
     end
 
     # Returns a transaction result
+    #
+    # @return [FlowClient::TransactionResult] the transaction result
     def get_transaction_result(transaction_id)
       req = Access::GetTransactionRequest.new(
         id: to_bytes(transaction_id)
@@ -340,9 +346,11 @@ module FlowClient
       end
     end
 
+    # Polls the blockchain for the transaction result until it is sealed
+    # or expired
     def wait_for_transaction(transaction_id)
       response = get_transaction_result(transaction_id)
-      while response.status != :SEALED
+      while ![:SEALED, :EXPIRED].include? response.status
         sleep(0.5)
         response = get_transaction_result(transaction_id)
       end

data/lib/flow_client/transaction.rb

@@ -26,7 +26,7 @@ module FlowClient
       @authorizer_addresses = []
       @arguments = []
       @script = ""
-      @gas_limit = 0
+      @gas_limit = 999
       @envelope_signatures = []
       @payload_signatures = []
       @address_aliases = {}
@@ -57,51 +57,6 @@ module FlowClient
       Utils.right_pad_bytes(TRANSACTION_DOMAIN_TAG.bytes, 32).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
-
     def add_envelope_signature(signer_address, key_index, signer)
       domain_tagged_envelope = (Transaction.padded_transaction_domain_tag.bytes + envelope_message.bytes).pack("C*")
 
@@ -160,6 +115,51 @@ module FlowClient
     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

data/lib/flow_client/version.rb

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

data/template.md

@@ -62,7 +62,7 @@ res = client.ping
 After you have established a connection with an access node, you can query the Flow network to retrieve data about blocks, accounts, events and transactions. We will explore how to retrieve each of these entities in the sections below.
 
 ### Get Blocks
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client)
 
 Query the network for block by id, height or get the latest block.
 
@@ -104,7 +104,7 @@ Result output:
 ```
 
 ### Get Account
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient%2FClient:get_account)
 
 Retrieve any account from Flow network's latest block or from a specified block height.
 
@@ -133,7 +133,7 @@ Result output:
 
 
 ### Get Transactions
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#get_transaction-instance_method)
 
 Retrieve transactions from the network by providing a transaction ID. After a transaction has been submitted, you can also get the transaction result to check the status.
 
@@ -233,7 +233,7 @@ Example output:
 
 
 ### Get Events
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#get_events-instance_method)
 
 Retrieve events by a given type in a specified block height range or through a list of block IDs.
 
@@ -277,7 +277,7 @@ Example output:
 ```
 
 ### Get Collections
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#get_collection_by_id-instance_method)
 
 Retrieve a batch of transactions that have been included in the same block, known as ***collections***. 
 Collections are used to improve consensus throughput by increasing the number of transactions per block and they act as a link between a block and a transaction.
@@ -294,7 +294,7 @@ Example output:
 ```
 
 ### Execute Scripts
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#execute_script-instance_method)
 
 Scripts allow you to write arbitrary non-mutating Cadence code on the Flow blockchain and return data. You can learn more about [Cadence and scripts here](https://docs.onflow.org/cadence/language/), but we are now only interested in executing the script code and getting back the data.
 
@@ -312,7 +312,7 @@ script = %{
   }
 }
 
-args = [{ type: 'Int', value: "1" }.to_json]
+args = [FlowClient::CadenceType.Int(1)]
 res = client.execute_script(script, args)
 ```
 
@@ -407,7 +407,7 @@ A transaction will be rejected if it is submitted past its expiry block. Flow ca
 A transaction expires after `600` blocks are committed on top of the reference block, which takes about 10 minutes at average Mainnet block rates.
 
 ### Build Transactions
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Transaction)
 
 Building a transaction involves setting the required properties explained above and producing a transaction object. 
 
@@ -456,7 +456,7 @@ transaction.arguments = arguments
 After you have successfully [built a transaction](#build-transactions) the next step in the process is to sign it.
 
 ### Sign Transactions
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Transaction)
 
 Flow introduces new concepts that allow for more flexibility when creating and signing transactions.
 Before trying the examples below, we recommend that you read through the [transaction signature documentation](https://docs.onflow.org/concepts/accounts-and-keys/).
@@ -478,7 +478,7 @@ Signatures can be generated more securely using keys stored in a hardware device
 
 Simple signature example:
 ```ruby
-account = FlowClient::Account.new(address: 0x01)
+account = client.get_account("0x01")
 signer = FlowClient::LocalSigner.new("<private key hex>")
 
 transaction.proposer_address = account.address
@@ -503,7 +503,7 @@ Flow supports great flexibility when it comes to transaction signing, we can def
 | `0x01`  | 1      | 1.0    |
 
 ```ruby
-account = FlowClient::Account.new(address: 0x01)
+account = client.get_account("0x01")
 
 transaction = FlowClient::Transaction.new
 transaction.reference_block_id = client.get_latest_block.id
@@ -532,7 +532,7 @@ transaction.add_envelope_signature(account.address, account.keys.first.index, si
 | `0x01`  | 2      | 0.5    |
 
 ```ruby
-account = FlowClient::Account.new(address: 0x01)
+account = client.get_account("0x01")
 
 transaction = FlowClient::Transaction.new
 transaction.reference_block_id = client.get_latest_block.id
@@ -563,10 +563,10 @@ transaction.add_envelope_signature(account.address, account.keys[1].index, signe
 
 ```ruby
 payer_signer = FlowClient::LocalSigner.new("<private key hex>")
-payer_account = FlowClient::Account.new(address: 0x02)
+payer_account = client.get_account("0x02")
 
 proposer_signer = FlowClient::LocalSigner.new("<private key hex>")
-proposer_account = FlowClient::Account.new(address: 0x01)
+proposer_account = client.get_account("0x01")
 
 @transaction = FlowClient::Transaction.new
 @transaction.reference_block_id = client.get_latest_block.id
@@ -599,10 +599,10 @@ proposer_account = FlowClient::Account.new(address: 0x01)
 
 ```ruby
 payer_signer = FlowClient::LocalSigner.new("<private key hex>")
-payer_account = FlowClient::Account.new(address: 0x02)
+payer_account = client.get_account("0x02")
 
 proposer_signer = FlowClient::LocalSigner.new("<private key hex>")
-proposer_account = FlowClient::Account.new(address: 0x01)
+proposer_account = client.get_account("0x01")
 
 @transaction = FlowClient::Transaction.new
 @transaction.reference_block_id = client.get_latest_block.id
@@ -637,10 +637,10 @@ proposer_account = FlowClient::Account.new(address: 0x01)
 
 ```ruby
 payer_signer = FlowClient::LocalSigner.new("<private key hex>")
-payer_account = FlowClient::Account.new(address: 0x02)
+payer_account = client.get_account("0x02")
 
 proposer_signer = FlowClient::LocalSigner.new("<private key hex>")
-proposer_account = FlowClient::Account.new(address: 0x01)
+proposer_account = client.get_account("0x01")
 
 @transaction = FlowClient::Transaction.new
 @transaction.reference_block_id = client.get_latest_block.id
@@ -661,7 +661,7 @@ proposer_account = FlowClient::Account.new(address: 0x01)
 
 
 ### Send Transactions
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#send_transaction-instance_method)
 
 After a transaction has been [built](#build-transactions) and [signed](#sign-transactions), it can be sent to the Flow blockchain where it will be executed. If sending was successful you can then [retrieve the transaction result](#get-transactions).
 
@@ -675,7 +675,7 @@ end
 
 
 ### Create Accounts
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Client#create_account-instance_method)
 
 On Flow, account creation happens inside a transaction. Because the network allows for a many-to-many relationship between public keys and accounts, it's not possible to derive a new account address from a public key offline. 
 
@@ -700,13 +700,13 @@ Account creation happens inside a transaction, which means that somebody must pa
 
 ```ruby
 # The account that will pay for the creation of the new account
-account = FlowClient::Account.new(address: "f8d6e0586b0a20c7")
+payer_account = client.get_account("f8d6e0586b0a20c7")
 # Create an in-memory signer with the payer's private key
 signer = FlowClient::LocalSigner.new("4d9287571c8bff7482ffc27ef68d5b4990f9bd009a1e9fa812aae08ba167d57f")
 # Generate a public key for the new account
 _private_key, public_key = FlowClient::Crypto.generate_key_pair(FlowClient::Crypto::Curves::P256)
 # Create the account
-res = client.create_account([public_key], { "ContractName": "<contract cadence code>" }, account, signer)
+res = client.create_account([public_key], { "ContractName": "<contract cadence code>" }, payer_account, signer)
 ```
 
 ```ruby
@@ -726,7 +726,7 @@ res.address
 ```
 
 ### Generate Keys
-[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://github.com/glucode/flow_client)
+[<img src="https://raw.githubusercontent.com/onflow/sdks/main/templates/documentation/ref.svg" width="130">](https://www.rubydoc.info/gems/flow_client/FlowClient/Crypto#generate_key_pair-class_method)
 
 Flow uses [ECDSA](https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm) signatures to control access to user accounts. Each key pair can be used in combination with the `SHA2-256` or `SHA3-256` hashing algorithms.
 
@@ -744,4 +744,4 @@ The example above uses an ECDSA key pair on the P-256 (secp256r1) elliptic curve
 
 ```ruby
 private_key, public_key = FlowClient::Crypto.generate_key_pair(FlowClient::Crypto::Curves::SECP256K1)
-```
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flow_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Nico du Plessis
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -94,7 +94,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -156,7 +155,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
@@ -171,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A Ruby client for the Flow blockchain
 test_files: []

data/Gemfile.lock

@@ -1,108 +0,0 @@
-PATH
-  remote: .
-  specs:
-    flow_client (0.2.0)
-      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.2)
-    rubocop (1.22.1)
-      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.12.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
-  x86_64-linux
-
-DEPENDENCIES
-  flow_client!
-  guard-rspec (~> 4.7)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.22)
-
-BUNDLED WITH
-   2.2.26