fabric-gateway 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d791b2c862c686b8d4d6877dbf5fedd6563b4d5ba2092c832a018deb5d48c575
-  data.tar.gz: 239128c906f1ac613d562d929a6ff5b9cc72d0e9dc1adfba3b9b4a8e306228f1
+  metadata.gz: 84dbcb3d572350e328ca48178859e0edfc7f57bbc331980612c4c5f537701b12
+  data.tar.gz: 9aaeed65be8ea7b5296e4e4fb12d8027583581cca24c96ccdf4f7a3afb781758
 SHA512:
-  metadata.gz: ec91a9bca5003ec961e93ce670d8006a698c071f51b81a7d9ab6dcd011480597e7decc396607f6f4fbef5b29cd0b7ab2986239f558711ebd333599da8d07eddd
-  data.tar.gz: 6795e691fa38795aacc3e9cf0d9472cb9924105b184d283aa13ad1b7732445a334a713bc6ed79e6c283c70aa51ebbee37ace55f84e5a9d68a0c96aee5711f499
+  metadata.gz: a931d1e6fff596991560afedd817f3091e0c393c4b6aefa9eed5f3dfee19f37db8b1f744c9ea9b4375d661bdf1c0b4c72402eb9048225be7d028569520fb8d23
+  data.tar.gz: 553c329d4dbb5b9b7729e5c1226f2c680901e40e27f630ce1f577fd9f4c33eb648b06a8ab92630873c8ded4be7ba4870b82fbef236a0520d848371b09d5de848

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/README.md

@@ -1,6 +1,6 @@
 # Fabric::Gateway
 
-![Rspec Tests](https://github.com/EthicalIdentity/fabric-gateway-ruby/actions/workflows/rspec.yml/badge.svg) [![codecov](https://codecov.io/gh/EthicalIdentity/fabric-gateway-ruby/branch/master/graph/badge.svg?token=AXHQEN0R2R)](https://codecov.io/gh/EthicalIdentity/fabric-gateway-ruby) [![Maintainability](https://api.codeclimate.com/v1/badges/84bab9bb5911d3564df6/maintainability)](https://codeclimate.com/github/EthicalIdentity/fabric-gateway-ruby/maintainability) ![Gem](https://img.shields.io/gem/v/fabric-gateway) ![Downloads](https://img.shields.io/gem/dt/fabric-gateway)  [![GitHub license](https://img.shields.io/github/license/EthicalIdentity/fabric-gateway-ruby)](https://github.com/EthicalIdentity/fabric-gateway-ruby/blob/master/LICENSE.txt) 
+[![Rspec Tests](https://github.com/EthicalIdentity/fabric-gateway-ruby/actions/workflows/rspec.yml/badge.svg)](https://github.com/EthicalIdentity/fabric-gateway-ruby/actions/workflows/rspec.yml?query=branch%3Amaster) [![codecov](https://codecov.io/gh/EthicalIdentity/fabric-gateway-ruby/branch/master/graph/badge.svg?token=AXHQEN0R2R)](https://codecov.io/gh/EthicalIdentity/fabric-gateway-ruby) [![Maintainability](https://api.codeclimate.com/v1/badges/84bab9bb5911d3564df6/maintainability)](https://codeclimate.com/github/EthicalIdentity/fabric-gateway-ruby/maintainability) [![Gem](https://img.shields.io/gem/v/fabric-gateway)](https://rubygems.org/gems/fabric-gateway) [![Downloads](https://img.shields.io/gem/dt/fabric-gateway)](https://rubygems.org/gems/fabric-gateway)  [![GitHub license](https://img.shields.io/github/license/EthicalIdentity/fabric-gateway-ruby)](https://github.com/EthicalIdentity/fabric-gateway-ruby/blob/master/LICENSE.txt) 
 
 
 
@@ -32,11 +32,13 @@ Will update to new version of grpc when fix is released.
 
 ## Usage
 
-This is an alpha stage library suitable for early adopters. Not all Hyperledger Fabric Gateway operations have been implemented. However the operations that have been implemented have pretty good unit test coverage.
+This is an alpha stage library suitable for early adopters. The basic evaluate and submit gateway functions are implemented. Chaincode events monitoring is not yet implemented.
 
-```
+```ruby
 $ bin/console
 
+# for running in application or script; not needed from bin/console
+require 'fabric' 
 
 def load_certs
   data_dir ='/your/certs/directory' # aka test-network/organizations
@@ -80,12 +82,9 @@ contract = network.new_contract('basic')
 # Evaluate
 puts contract.evaluate_transaction('GetAllAssets')
 
-# Submit - Not Yet Implemented!
-puts contract.submit_transaction('CreateAsset', 'asset13', 'yellow', '5', 'Tom', '1300')
-
-# Endorse - Not Yet Implemented!
-
-# Commit Status - Not Yet Implemented!
+# Submit
+puts contract.submit_transaction('CreateAsset', ['asset13', 'yellow', '5', 'Tom', '1300'])
+puts contract.submit_transaction('UpdateAsset', %w[asset999 yellow 5 Tom 5555])
 
 # Chaincode Events - Not Yet Implemented!
 
@@ -133,13 +132,15 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ethica
 - [x] Setup auto-generation of API docs on rubydoc.info
 - [x] Abstract connection and calls such that the protos aren't being interacted directly
 - [x] Implement, Document & Test Evaluate
-- [ ] Implement, Document & Test Endorse
-- [ ] Implement, Document & Test Submit
-- [ ] Implement, Document & Test CommitStatus
+- [x] Implement, Document & Test Endorse
+- [x] Implement, Document & Test Submit
+- [x] Implement, Document & Test CommitStatus
 - [ ] Implement, Document & Test ChaincodeEvents
-- [ ] Implement off-line signing - https://github.com/hyperledger/fabric-gateway/blob/1e4a926ddb98ec8ee969da3fc1500642ab389d01/node/src/contract.ts#L63 
+- [ ] Support Submit Async (currently blocks waiting for the transaction to be committed)
 - [ ] Consider adding error handling, invalid transaction proposals will result in random GRPC::FailedPrecondition type errors
+- [ ] Consider adding transaction_id information to Fabric::Errors that are raised; would help a lot for debugging.
 - [ ] Consider adding integration tests against blockchain; might be a ton of stuff to setup
+- [ ] Implement off-line signing - https://github.com/hyperledger/fabric-gateway/blob/1e4a926ddb98ec8ee969da3fc1500642ab389d01/node/src/contract.ts#L63 
 - [ ] Support for offline transaction signing (write scenario test for this) - https://github.com/hyperledger/fabric-gateway/blob/cf78fc11a439ced7dfd2f9b55886c55c73119b25/pkg/client/offlinesign_test.go
 
 

data/Rakefile

@@ -2,7 +2,9 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rake/notes/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+

data/fabric-gateway.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('codecov', '~> 0.6.0')
   spec.add_development_dependency('factory_bot', '~> 6.2.0')
   spec.add_development_dependency('grpc-tools', '~> 1.42')
+  spec.add_development_dependency('rake-notes', '~> 0.2.0')
   spec.add_development_dependency('rubocop', '~> 1.23.0')
   spec.add_development_dependency('rubocop-rspec', '~> 2.6.0')
   spec.add_development_dependency('simplecov', '~> 0.21.2')

data/lib/fabric/accessors/contract.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Fabric
+  module Accessors
+    #
+    # Add accessor methods to the given class.
+    #
+    # Usage: make sure the class has a contract accessor method
+    # and then `include Fabric::Accessors::Contract`
+    #
+    module Contract
+      # @!visibility private
+      def self.included(base)
+        base.send :include, Fabric::Accessors::Network
+      end
+
+      # @!parse include Fabric::Accessors::Network
+      # @!parse include Fabric::Accessors::Gateway
+
+      #
+      # Returns the network instance
+      #
+      # @return [Fabric::Network] network
+      # @!parse attr_reader :network
+      #
+      def network
+        contract.network
+      end
+
+      #
+      # Returns the contract name
+      #
+      # @return [String] contract name
+      # @!parse attr_reader :contract_name
+      #
+      def contract_name
+        contract.contract_name
+      end
+
+      #
+      # Returns the chaincode name
+      #
+      # @return [String] chaincode name
+      # @!parse attr_reader :chaincode_name
+      #
+      def chaincode_name
+        contract.chaincode_name
+      end
+    end
+  end
+end

data/lib/fabric/accessors/gateway.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Fabric
+  module Accessors
+    #
+    # Add accessor methods to the given class.
+    #
+    # Usage: make sure the class has a gateway accessor method
+    # and then `include Fabric::Accessors::Gateway`
+    #
+    module Gateway
+      #
+      # Returns the client instance
+      #
+      # @return [Fabric::Client] client
+      # @!parse attr_reader :client
+      #
+      def client
+        gateway.client
+      end
+
+      #
+      # Returns the signer identity instance
+      #
+      # @return [Fabric::Identity] signer
+      # @!parse attr_reader :signer
+      #
+      def signer
+        gateway.signer
+      end
+    end
+  end
+end

data/lib/fabric/accessors/network.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Fabric
+  module Accessors
+    #
+    # Add accessor methods to the given class.
+    #
+    # Usage: make sure the class has a network accessor method
+    # and then `include Fabric::Accessors::Network`
+    #
+    module Network
+      # @!visibility private
+      def self.included(base)
+        base.send :include, Fabric::Accessors::Gateway
+      end
+
+      # @!parse include Fabric::Accessors::Gateway
+
+      #
+      # Returns the gateway instance
+      #
+      # @return [Fabric::Gateway] gateway
+      # @!parse attr_reader :gateway
+      #
+      def gateway
+        network.gateway
+      end
+
+      #
+      # Network name or the channel name or channel id
+      #
+      # @return [String] network name
+      # @!parse attr_reader :network_name
+      #
+      def network_name
+        network.name
+      end
+    end
+  end
+end

data/lib/fabric/client.rb

@@ -10,22 +10,34 @@ module Fabric
     #
     # Initializes a client
     #
-    # @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:initialize
-    #
-    # @param [Gateway::Gateway::Stub] grpc_client grpc gateway client stub
-    # @param [string] host hostname and port of the gateway
-    # @param [GRPC::Core::ChannelCredentials|GRPC::Core::XdsChannelCredentials|Symbol] creds channel credentials
-    #                                                                                  (usually the CA certificate)
-    # @param [Hash] default_call_options call options to use by default for different operations
-    # @option default_call_options [Hash] :endorse_options default options for endorse call; @see keyword arguments in https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
-    # @option default_call_options [Hash] :evaluate_options default options for evaluate call; @see keyword arguments in
-    #                                              https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
-    # @option default_call_options [Hash] :submit_options default options for submit call; @see keyword arguments in https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
-    # @option default_call_options [Hash] :commit_status_options default options for commit_status call;
-    #                                     @see keyword arguments in https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
-    # @option default_call_options [Hash] :chaincode_events_options default options for chaincode_events call;
-    #                                     @see keyword arguments in https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
-    # @param [Hash] **client_opts client initialization options; @see keyword arguments at https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:initialize
+    #
+    # @overload initialize(grpc_client: client, default_call_options: {}, **client_opts)
+    #   Initializes a client from a gRPC Gateway client stub
+    #   @param [Gateway::Gateway::Stub] grpc_client grpc gateway client stub
+    #   @param [Hash] default_call_options call options to use by default for different operations
+    #   @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response Keyword Argument call options for
+    #     *_options default_call_options
+    #   @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:initialize Keyword arguments for **client_opts
+    #   @option default_call_options [Hash] :endorse_options default options for endorse call
+    #   @option default_call_options [Hash] :evaluate_options default options for evaluate call
+    #   @option default_call_options [Hash] :submit_options default options for submit call
+    #   @option default_call_options [Hash] :commit_status_options default options for commit_status call
+    #   @option default_call_options [Hash] :chaincode_events_options default options for chaincode_events call
+    #   @param [Hash] **client_opts client initialization options
+    # @overload initialize(host: host, creds: creds, default_call_options: {}, **client_opts)
+    #   Instantiates a new gRPC Gateway client stub from the parameters
+    #   @param [string] host hostname and port of the gateway
+    #   @param [GRPC::Core::ChannelCredentials|GRPC::Core::XdsChannelCredentials|Symbol] creds channel credentials
+    #     (usually the CA certificate)
+    #   @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response Keyword Argument call options for
+    #     *_options default_call_options
+    #   @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:initialize Keyword arguments for **client_opts
+    #   @option default_call_options [Hash] :endorse_options default options for endorse call
+    #   @option default_call_options [Hash] :evaluate_options default options for evaluate call
+    #   @option default_call_options [Hash] :submit_options default options for submit call
+    #   @option default_call_options [Hash] :commit_status_options default options for commit_status call
+    #   @option default_call_options [Hash] :chaincode_events_options default options for chaincode_events call
+    #   @param [Hash] **client_opts client initialization options
     #
     def initialize(grpc_client: nil, host: nil, creds: nil, default_call_options: {}, **client_opts)
       if grpc_client
@@ -89,8 +101,8 @@ module Fabric
     #
     # Subscribe to chaincode events
     #
-    # @NOTE: This function has never been utilized or tested. This function is probably wrong, missing a block.
-    # @TODO: add testing!
+    # @note This function has never been utilized or tested. This function is probably wrong, missing a block.
+    # @todo add testing!
     #
     # @param [Gateway::ChaincodeEventsRequest] chaincode_events_request
     # @param [Hash] options gRPC call options (merged with default options) @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:server_streamer

data/lib/fabric/contract.rb

@@ -25,28 +25,16 @@ module Fabric
   class Contract
     attr_reader :network, :chaincode_name, :contract_name
 
+    # @!parse include Fabric::Accessors::Network
+    # @!parse include Fabric::Accessors::Gateway
+    include Fabric::Accessors::Network
+
     def initialize(network, chaincode_name, contract_name = '')
       @network = network
       @chaincode_name = chaincode_name
       @contract_name = contract_name
     end
 
-    def client
-      network.client
-    end
-
-    def signer
-      network.signer
-    end
-
-    def gateway
-      network.gateway
-    end
-
-    def network_name
-      network.name
-    end
-
     #
     # Evaluate a transaction function and return its results. A transaction proposal will be evaluated on endorsing
     # peers but the transaction will not be sent to the ordering service and so will not be committed to the ledger.
@@ -66,7 +54,6 @@ module Fabric
     # transaction function will be evaluated on endorsing peers and then submitted to the ordering service to be
     # committed to the ledger.
     #
-    # @TODO: Not yet complete
     #
     # @param [String] transaction_name
     # @param [Array] arguments array of arguments to pass to the transaction
@@ -102,8 +89,6 @@ module Fabric
     # transaction function will be evaluated on endorsing peers and then submitted to the ordering service to be
     # committed to the ledger.
     #
-    # @TODO: Implement Me! - LEFT OFF HERE!
-    #
     # @param [String] transaction_name
     # @param [Hash] proposal_options
     # @option proposal_options [Array] :arguments array of arguments to pass to the transaction
@@ -116,17 +101,15 @@ module Fabric
     #
     def submit(transaction_name, proposal_options = {})
       transaction = new_proposal(transaction_name, **proposal_options).endorse
-      submitted = transaction.submit
+      transaction.submit
 
-      status = submitted.get_status
-
-      raise CommitError, status unless status.get_status == ::GRPC::Core::StatusCodes::OK
+      transaction.result
     end
 
     #
-    # @TODO: unimplemented, not sure if this can be implemented because
-    # the official grpc ruby client does not support non-blocking async
-    # calls (https://github.com/grpc/grpc/issues/10973)
+    # @todo unimplemented, not sure if this can be implemented because
+    #   the official grpc ruby client does not support non-blocking async
+    #   calls (https://github.com/grpc/grpc/issues/10973)
     #
     # not 100% sure if grpc support is necessary for this.
     #
@@ -156,6 +139,14 @@ module Fabric
       Proposal.new(proposed_transaction)
     end
 
+    #
+    # Generates the qualified transaction name for the contract. (prepends the contract name to the transaction name if
+    # contract name is set)
+    #
+    # @param [string] transaction_name
+    #
+    # @return [string] qualified transaction name
+    #
     def qualified_transaction_name(transaction_name)
       contract_name.nil? || contract_name.empty? ? transaction_name : "#{contract_name}:#{transaction_name}"
     end

data/lib/fabric/ec_crypto_suite.rb

@@ -8,7 +8,7 @@ module Fabric
   #
   # Elliptic-curve Crypto Suite using OpenSSL
   #
-  # @TODO missing tests
+  # @todo missing tests
   class ECCryptoSuite # rubocop:disable Metrics/ClassLength
     DEFAULT_KEY_SIZE = 256
     DEFAULT_DIGEST_ALGORITHM = 'SHA256'

data/lib/fabric/entities/envelope.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Fabric
+  #
+  # Encapsulates an Envelop protobuf message
+  #
+  class Envelope
+    # @return [Common::Envelope] transaction envelope
+    attr_reader :envelope
+
+    #
+    # Creates a new Envelope instance.
+    #
+    # @param [Common::Envelope] envelope
+    #
+    def initialize(envelope)
+      @envelope = envelope
+    end
+
+    #
+    # Checks if the envelope has been signed.
+    #
+    # @return [Boolean] true if the envelope has been signed; otherwise false.
+    #
+    def signed?
+      !envelope.signature.empty?
+    end
+
+    #
+    # The protobuffer serialized form of the envelope payload.
+    #
+    # @return [String] serialized payload
+    #
+    def payload_bytes
+      envelope.payload
+    end
+
+    #
+    # The digest of the payload.
+    #
+    # @return [String] payload digest
+    #
+    def payload_digest
+      Fabric.crypto_suite.digest(envelope.payload)
+    end
+
+    #
+    # Sets the envelope signature.
+    #
+    # @param [String] signature
+    #
+    # @return [Void]
+    #
+    def signature=(signature)
+      envelope.signature = signature
+    end
+
+    def result
+      @result ||= parse_result_from_payload
+    end
+
+    #
+    # Returns the deserialized payload.
+    #
+    # @return [Common::Payload] Envelope payload
+    #
+    def payload
+      @payload ||= Common::Payload.decode(envelope.payload)
+    end
+
+    #
+    # Returns the envelope payload header.
+    #
+    # Envelope => Payload => Header
+    #
+    # @return [Common::Header] Envelope Payload Header
+    #
+    def header
+      raise Fabric::Error, 'Missing header' if payload.header.nil?
+
+      @header ||= payload.header
+    end
+
+    #
+    # Returns the deserialized transaction channel header
+    #
+    # Envelope => Payload => Header => ChannelHeader
+    #
+    # @return [Common::ChannelHeader] envelop payload header channel header
+    #
+    def channel_header
+      @channel_header ||= Common::ChannelHeader.decode(header.channel_header)
+    end
+
+    #
+    # Grabs the channel_name frmo the depths of the envelope.
+    #
+    # @return [String] channel name
+    #
+    def channel_name
+      channel_header.channel_id
+    end
+
+    #
+    # Returns the deserialized transaction
+    #
+    # @return [Protos::Transaction] transaction
+    #
+    def transaction
+      @transaction ||= Protos::Transaction.decode(payload.data)
+    end
+
+    private
+
+    #
+    # Parse the transaction actinos from the payload looking for the transaction result payload.
+    #
+    # @return [String] result payload
+    # @raise [Fabric::Error] if the transaction result payload is not found
+    #
+    def parse_result_from_payload
+      errors = []
+      transaction.actions.each do |action|
+        return parse_result_from_transaction_action(action)
+      rescue Fabric::Error => e
+        errors << e
+      end
+
+      raise Fabric::Error, "No proposal response found: #{errors.inspect}"
+    end
+
+    #
+    # Parse a single transaction action looking for the transaction result payload.
+    #
+    # @param [Protos::TransactionAction] transaction_action
+    #
+    # @return [Payload] transaction result payload
+    # @raise [Fabric::Error] if the endorsed_action is missing or the chaincode response is missing
+    #
+    def parse_result_from_transaction_action(transaction_action)
+      action_payload = Protos::ChaincodeActionPayload.decode(transaction_action.payload)
+      endorsed_action = action_payload.action
+      raise Fabric::Error, 'Missing endorsed action' if endorsed_action.nil?
+
+      response_payload = Protos::ProposalResponsePayload.decode(endorsed_action.proposal_response_payload)
+      chaincode_action = Protos::ChaincodeAction.decode(response_payload.extension)
+      chaincode_response = chaincode_action.response
+      raise Fabric::Error, 'Missing chaincode response' if chaincode_response.nil?
+
+      chaincode_response.payload
+    end
+  end
+end

data/lib/fabric/{identity.rb → entities/identity.rb}

@@ -76,9 +76,9 @@ module Fabric
     #
     # Creates a new gateway passing in the current identity
     #
-    # @param [Gateway::Gateway::Stub] connection <description>
+    # @param [Fabric::Client] client
     #
-    # @return [Fabric::Gateway] <description>
+    # @return [Fabric::Gateway] gateway
     #
     def new_gateway(client)
       Fabric::Gateway.new(self, client)

data/lib/fabric/{proposal.rb → entities/proposal.rb}

@@ -22,33 +22,7 @@ module Fabric
       @proposed_transaction.contract
     end
 
-    def network
-      contract.network
-    end
-
-    def client
-      network.client
-    end
-
-    def signer
-      network.signer
-    end
-
-    def gateway
-      network.gateway
-    end
-
-    def network_name
-      network.name
-    end
-
-    def contract_name
-      contract.contract_name
-    end
-
-    def chaincode_name
-      contract.chaincode_name
-    end
+    include Fabric::Accessors::Contract
 
     def transaction_id
       proposed_transaction.transaction_id
@@ -96,7 +70,7 @@ module Fabric
     # @return [String] raw binary digest of the proposal message.
     #
     def digest
-      signer.digest(proposal.to_proto)
+      Fabric.crypto_suite.digest(proposal.to_proto)
     end
 
     #
@@ -153,8 +127,22 @@ module Fabric
       evaluate_response.result.payload
     end
 
-    def endorse
-      # TODO: endorse proposal
+    #
+    # Obtain endorsement for the transaction proposal from sufficient peers to allow it to be committed to the ledger.
+    #
+    # @param [Hash] options gRPC call options @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
+    #
+    # @return [Fabric::Transaction] An endorsed transaction that can be submitted to the ledger.
+    #
+    def endorse(options = {})
+      sign
+      endorse_response = client.endorse(new_endorse_request, options)
+
+      raise Fabric::Error, 'Missing transaction envelope' if endorse_response.prepared_transaction.nil?
+
+      prepared_transaction = new_prepared_transaction(endorse_response.prepared_transaction)
+
+      Fabric::Transaction.new(network, prepared_transaction)
     end
 
     #
@@ -170,13 +158,32 @@ module Fabric
       )
     end
 
+    #
+    # Creates a new endorse request from this proposal.
+    #
+    # @return [Gateway::EndorseRequest] EndorseRequest protobuf message
+    #
     def new_endorse_request
-      # TODO
+      ::Gateway::EndorseRequest.new(
+        transaction_id: transaction_id,
+        channel_id: network_name,
+        proposed_transaction: signed_proposal,
+        endorsing_organizations: proposed_transaction.endorsing_organizations
+      )
     end
 
-    def new_prepared_transaction
-      # TODO
-      # used in endorse
+    #
+    # Creates a new prepared transaction from a transaction envelope.
+    #
+    # @param [Common::Envelope] envelope transaction envelope
+    #
+    # @return [Gateway::PreparedTransaction] prepared transaction protobuf message
+    #
+    def new_prepared_transaction(envelope)
+      ::Gateway::PreparedTransaction.new(
+        transaction_id: transaction_id,
+        envelope: envelope
+      )
     end
   end
 end

data/lib/fabric/{proposed_transaction.rb → entities/proposed_transaction.rb}

@@ -19,6 +19,10 @@ module Fabric
     # This is usually used in conjunction with transientData for private data scenarios.
     attr_reader :endorsing_organizations
 
+    # @!parse include Fabric::Accessors::Network
+    # @!parse include Fabric::Accessors::Gateway
+    include Fabric::Accessors::Contract
+
     def initialize(contract, transaction_name, arguments: [], transient_data: {}, endorsing_organizations: [])
       @contract = contract
       @transaction_name = transaction_name
@@ -29,34 +33,6 @@ module Fabric
       generate_proposed_transaction
     end
 
-    def network
-      contract.network
-    end
-
-    def client
-      network.client
-    end
-
-    def signer
-      network.signer
-    end
-
-    def gateway
-      network.gateway
-    end
-
-    def network_name
-      network.name
-    end
-
-    def contract_name
-      contract.contract_name
-    end
-
-    def chaincode_name
-      contract.chaincode_name
-    end
-
     #
     # Builds the proposed transaction protobuf message
     #

data/lib/fabric/entities/status.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Fabric
+  #
+  # Status of a transaction that is to be committed to the ledger.
+  #
+  class Status
+    TRANSACTION_STATUSES = ::Protos::TxValidationCode.constants.map(&::Protos::TxValidationCode.method(:const_get))
+                                                     .collect do |i|
+      [::Protos::TxValidationCode.lookup(i), i]
+    end.to_h
+
+    # @return [Integer] Block number in which the transaction committed.
+    attr_reader :block_number
+
+    # @return [Integer] Transaction status
+    attr_reader :code
+
+    # @return [Boolean] `true` if the transaction committed successfully; otherwise `false`.
+    attr_reader :successful
+
+    # @return [String] The ID of the transaction.
+    attr_reader :transaction_id
+
+    def initialize(transaction_id, block_number, code)
+      @transaction_id = transaction_id
+      @block_number = block_number
+      @code = code
+      @successful = @code == TRANSACTION_STATUSES[:VALID]
+    end
+  end
+end

data/lib/fabric/entities/transaction.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+module Fabric
+  #
+  # Represents an endorsed transaction that can be submitted to the orderer for commit to the ledger,
+  # query the transaction results and its commit status.
+  #
+  class Transaction
+    attr_reader :network
+
+    include Fabric::Accessors::Network
+
+    # @return [Gateway::PreparedTransaction] Prepared Transaction
+    attr_reader :prepared_transaction
+
+    # @return [Fabric::Envelope]
+    attr_reader :envelope
+
+    #
+    # Creates a new Transaction instance.
+    #
+    # @param [Fabric::Network] network
+    # @param [Gateway::PreparedTransaction] prepared_transaction
+    #
+    def initialize(network, prepared_transaction)
+      @network = network
+      @prepared_transaction = prepared_transaction
+      @envelope = Envelope.new(prepared_transaction.envelope)
+    end
+
+    #
+    # Get the transaction result. This is obtained during the endorsement process when the transaction proposal is
+    # run on endorsing peers.
+    #
+    # @param [boolean] check_status set to true to raise exception if transaction has not yet been committed
+    #
+    # @return [String] Raw transaction result
+    #
+    def result(check_status: true)
+      raise Fabric::CommitError, status if check_status && !status.successful
+
+      envelope.result
+    end
+
+    #
+    # Returns the transaction ID from the prepared transaction.
+    #
+    # @return [String] transaction_id
+    #
+    def transaction_id
+      prepared_transaction.transaction_id
+    end
+
+    #
+    # Submit the transaction to the orderer to be committed to the ledger.
+    #
+    # @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
+    #
+    # @param [Hash] options gRPC call options
+    #
+    # @return [Fabric::Transaction] self
+    def submit(options = {})
+      sign_submit_request
+
+      client.submit(new_submit_request, options)
+
+      self
+    end
+
+    #
+    # Sign the transaction envelope.
+    #
+    # @return [void]
+    def sign_submit_request
+      return if submit_request_signed?
+
+      signature = signer.sign(envelope.payload_bytes)
+      self.submit_request_signature = signature
+    end
+
+    #
+    # Returns true if the transaction envelope has been signed.
+    #
+    # @return [Boolean] true if signed; false otherwise
+    #
+    def submit_request_signed?
+      @envelope.signed?
+    end
+
+    #
+    # Digest to be signed to support offline signing of the submit request
+    #
+    # @return [String] digest of the submit request
+    #
+    def submit_request_digest
+      envelope.payload_digest
+    end
+
+    #
+    # Sets the submit request signature. This is used to support offline signing of the submit request.
+    #
+    # @param [String] signature
+    #
+    # @return [void]
+    #
+    def submit_request_signature=(signature)
+      envelope.signature = signature
+    end
+
+    #
+    # Get status of the committed transaction. If the transaction has not yet committed, this method blocks until the
+    # commit occurs. If status is already queried, this returns status from cache and does not make additional queries.
+    #
+    # @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
+    #
+    # @param [Hash] options gRPC call options
+    #
+    # @return [Fabric::Status] status of the committed transaction
+    #
+    def status(options = {})
+      @status ||= query_status(options)
+    end
+
+    #
+    # Digest to be signed to support offline signing of the commit status request
+    #
+    # @return [String] digest of the commit status request
+    #
+    def status_request_digest
+      Fabric.crypto_suite.digest(signed_commit_status_request.request)
+    end
+
+    #
+    # Sets the status request signature. This is used to support offline signing of the commit status request.
+    #
+    # @param [String] signature
+    #
+    # @return [void]
+    #
+    def status_request_signature=(signature)
+      signed_commit_status_request.signature = signature
+    end
+
+    #
+    # Returns true if the signed commit status request has been signed.
+    #
+    # @return [Boolean] true if signed; false otherwise
+    #
+    def status_request_signed?
+      !signed_commit_status_request.signature.empty?
+    end
+
+    #
+    # Sign the signed commit status request
+    #
+    # @return [Fabric::Transaction] self
+    #
+    def sign_status_request
+      return if status_request_signed?
+
+      signature = signer.sign(signed_commit_status_request.request)
+      signed_commit_status_request.signature = signature
+
+      self
+    end
+
+    #
+    # Returns the current instance of the signed commit status request. Necessary so we can keep the state of the
+    # signature in the transaction object.
+    #
+    # @return [Gateway::SignedCommitStatusRequest] signed commit status request
+    #
+    def signed_commit_status_request
+      @signed_commit_status_request ||= new_signed_commit_status_request
+    end
+
+    private
+
+    #
+    # Actual status query call used by status method.
+    #
+    # @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
+    #
+    # @param [Hash] options gRPC call options
+    #
+    # @return [Fabric::Status] status of the committed transaction
+    #
+    def query_status(options = {})
+      sign_status_request
+
+      commit_status_response = client.commit_status(signed_commit_status_request, options)
+      new_status(commit_status_response)
+    end
+
+    #
+    # Generates a new signed commit status request
+    #
+    # @return [Gateway::SignedCommitStatusRequest] signed commit status request protobuf message
+    #
+    def new_signed_commit_status_request
+      ::Gateway::SignedCommitStatusRequest.new(
+        request: new_commit_status_request.to_proto
+      )
+    end
+
+    #
+    # Generates a new commit status request
+    #
+    # @return [Gateway::CommitStatusRequest] commit status request protobuf message
+    #
+    def new_commit_status_request
+      ::Gateway::CommitStatusRequest.new(
+        channel_id: network_name,
+        transaction_id: transaction_id,
+        identity: signer.to_proto
+      )
+    end
+
+    #
+    # Generates a new submit request.
+    #
+    # @return [Gateway::SubmitRequest] submit request protobuf message
+    #
+    def new_submit_request
+      ::Gateway::SubmitRequest.new(
+        transaction_id: transaction_id,
+        channel_id: network_name,
+        prepared_transaction: envelope.envelope
+      )
+    end
+
+    #
+    # New Status from CommitStatusResponse
+    #
+    # @param [Gateway::CommitStatusResponse] response commit status response
+    #
+    # @return [Fabric::Status] transaction status
+    #
+    def new_status(response)
+      Fabric::Status.new(
+        transaction_id,
+        response.block_number,
+        Fabric::Status::TRANSACTION_STATUSES[response.result]
+      )
+    end
+  end
+end

data/lib/fabric/network.rb

@@ -11,19 +11,14 @@ module Fabric
   class Network
     attr_reader :gateway, :name
 
+    # @!parse include Fabric::Accessors::Gateway
+    include Fabric::Accessors::Gateway
+
     def initialize(gateway, name)
       @gateway = gateway
       @name = name
     end
 
-    def client
-      gateway.client
-    end
-
-    def signer
-      gateway.signer
-    end
-
     #
     # Creates a new contract instance
     #
@@ -37,7 +32,7 @@ module Fabric
     end
 
     #
-    # @TODO: original SDK has getChaincodeEvents and newChaincodeEventsRequest methods
+    # @todo original SDK has getChaincodeEvents and newChaincodeEventsRequest methods
     # @see https://github.com/hyperledger/fabric-gateway/blob/08118cf0a792898925d0b2710b0a9e7c5ec23228/node/src/network.ts
     # @see https://github.com/hyperledger/fabric-gateway/blob/main/pkg/client/network.go
     #
@@ -48,7 +43,7 @@ module Fabric
     end
 
     #
-    # @TODO: original SDK has getChaincodeEvents and newChaincodeEventsRequest methods
+    # @todo original SDK has getChaincodeEvents and newChaincodeEventsRequest methods
     # @see https://github.com/hyperledger/fabric-gateway/blob/08118cf0a792898925d0b2710b0a9e7c5ec23228/node/src/network.ts
     # @see https://github.com/hyperledger/fabric-gateway/blob/main/pkg/client/network.go
     #

data/lib/fabric/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fabric
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/fabric.rb

@@ -1,19 +1,27 @@
 # frozen_string_literal: true
 
+require 'gateway/gateway_pb'
+require 'gateway/gateway_services_pb'
+
+require 'fabric/accessors/gateway'
+require 'fabric/accessors/network'
+require 'fabric/accessors/contract'
+
+require 'fabric/entities/envelope'
+require 'fabric/entities/identity'
+require 'fabric/entities/proposal'
+require 'fabric/entities/proposed_transaction'
+require 'fabric/entities/status'
+require 'fabric/entities/transaction'
+
 require 'fabric/constants'
 require 'fabric/contract'
 require 'fabric/client'
 require 'fabric/ec_crypto_suite'
 require 'fabric/gateway'
-require 'fabric/identity'
 require 'fabric/network'
-require 'fabric/proposal'
-require 'fabric/proposed_transaction'
 require 'fabric/version'
 
-require 'gateway/gateway_pb'
-require 'gateway/gateway_services_pb'
-
 #
 # Hyperledger Fabric Gateway SDK
 #
@@ -25,14 +33,19 @@ module Fabric
   #
   # CommitError
   #
-  # @TODO: TEST ME!
+  # @todo TEST ME!
   #
   class CommitError < Error
     attr_reader :code, :transaction_id
 
+    #
+    # Creates a transaction commit error from the status
+    #
+    # @param [Fabric::Status] status transaction status
+    #
     def initialize(status)
-      super("Transaction #{status.transaction_id} failed to commit with status code #{status.code} -" +
-        Protos::TxValidationCode.lookup(status.code).to_s)
+      super("Transaction #{status.transaction_id} failed to commit with status code #{status.code} - " +
+        Status::TRANSACTION_STATUSES.key(status.code).to_s)
       @code = code
       @transaction_id = status.transaction_id
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fabric-gateway
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonathan Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: rake-notes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -154,6 +168,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - ".vscode/settings.json"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -171,15 +186,21 @@ files:
 - lib/common/policies_pb.rb
 - lib/fabric.rb
 - lib/fabric/.DS_Store
+- lib/fabric/accessors/contract.rb
+- lib/fabric/accessors/gateway.rb
+- lib/fabric/accessors/network.rb
 - lib/fabric/client.rb
 - lib/fabric/constants.rb
 - lib/fabric/contract.rb
 - lib/fabric/ec_crypto_suite.rb
+- lib/fabric/entities/envelope.rb
+- lib/fabric/entities/identity.rb
+- lib/fabric/entities/proposal.rb
+- lib/fabric/entities/proposed_transaction.rb
+- lib/fabric/entities/status.rb
+- lib/fabric/entities/transaction.rb
 - lib/fabric/gateway.rb
-- lib/fabric/identity.rb
 - lib/fabric/network.rb
-- lib/fabric/proposal.rb
-- lib/fabric/proposed_transaction.rb
 - lib/fabric/version.rb
 - lib/gateway/gateway_pb.rb
 - lib/gateway/gateway_services_pb.rb