fabric-gateway 0.1.0 → 0.2.0

data/lib/fabric/network.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Fabric
+  #
+  # Network represents a blockchain network, or Fabric channel. The Network can be used to access deployed smart
+  # contracts, and to listen for events emitted when blocks are committed to the ledger.
+  #
+  # JChan & THowe believe this should be called a Channel, however Hyperledger Fabric has decided upon the terminology
+  # network - https://github.com/hyperledger/fabric-gateway/issues/355#issuecomment-997888071
+  #
+  class Network
+    attr_reader :gateway, :name
+
+    def initialize(gateway, name)
+      @gateway = gateway
+      @name = name
+    end
+
+    def client
+      gateway.client
+    end
+
+    def signer
+      gateway.signer
+    end
+
+    #
+    # Creates a new contract instance
+    #
+    # @param [string] chaincode_name name of the chaincode
+    # @param [string] contract_name optional name of the contract
+    #
+    # @return [Fabric::Contract] new contract instance
+    #
+    def new_contract(chaincode_name, contract_name = '')
+      Contract.new(self, chaincode_name, contract_name)
+    end
+
+    #
+    # @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
+    #
+    # @return [?] ?
+    #
+    def new_chaincode_events
+      raise NotYetImplemented
+    end
+
+    #
+    # @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
+    #
+    # @return [?] ?
+    #
+    def new_chaincode_events_request
+      raise NotImplementedError
+    end
+  end
+end

data/lib/fabric/proposal.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Fabric
+  #
+  # Proposal represents a transaction proposal that can be sent to peers for endorsement or evaluated as a query.
+  #
+  # Combined ProposalBuilder with Proposal. Utilizing instance variables and functions in proposal seem adaquate enough
+  # to fully create the proposal. ProposalBuilder did not seem like a native ruby design pattern.
+  class Proposal
+    attr_reader :proposed_transaction
+
+    #
+    # Instantiates a new Proposal
+    #
+    # @param [Fabric::ProposedTransaction] proposed_transaction ProposedTransaction container class
+    #
+    def initialize(proposed_transaction)
+      @proposed_transaction = proposed_transaction
+    end
+
+    def contract
+      @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
+
+    def transaction_id
+      proposed_transaction.transaction_id
+    end
+
+    #
+    # Returns the proposal message as a protobuf Message object.
+    #
+    # @return [Protos::Proposal|nil] Proposal message
+    #
+    def proposal
+      proposed_transaction.proposal
+    end
+
+    #
+    # Returns the signed proposal
+    #
+    # <rant>
+    # Fabric message naming scheme is a mess:
+    # ProposedTransaction has a Proposal which is a SignedProposal
+    #               which has a Proposal which is a Proposal
+    # so.... which proposal do you want to access? Adding this function for clarity
+    # </rant>
+    #
+    # @return [Protos::SignedProposal|nil] SignedProposal message
+    #
+    def signed_proposal
+      proposed_transaction.proposed_transaction.proposal
+    end
+
+    #
+    # Serialized bytes of the proposal message in proto3 format.
+    #
+    # @return [String] Binary representation of the proposal message.
+    #
+    def to_proto
+      proposed_transaction.to_proto
+    end
+
+    #
+    # Proposal digest which can be utilized for offline signing.
+    # If signing offline, call signature= to set signature once
+    # computed.
+    #
+    # @return [String] raw binary digest of the proposal message.
+    #
+    def digest
+      signer.digest(proposal.to_proto)
+    end
+
+    #
+    # Sets the signature of the signed proposal in the proposed transaction
+    #
+    # @param [String] signature raw byte string signature of the proposal message
+    #                 (should be the signature of the proposed message digest)
+    #
+    def signature=(signature)
+      proposed_transaction.signed_proposal.signature = signature
+    end
+
+    #
+    # Returns the signed proposal signature
+    #
+    # @return [String] Raw byte string signature
+    #
+    def signature
+      proposed_transaction.signed_proposal.signature
+    end
+
+    #
+    # Returns true if the signed proposal has a signature
+    #
+    # @return [Boolean] true|false
+    #
+    def signed?
+      # signature cannot be nil because google protobuf won't let it
+      !proposed_transaction.signed_proposal.signature.empty?
+    end
+
+    #
+    # Utilizes the signer to sign the proposal message if it has not been signed yet.
+    #
+    def sign
+      return if signed?
+
+      self.signature = signer.sign proposal.to_proto
+    end
+
+    #
+    # Evaluate the transaction proposal and obtain its result, without updating the ledger. This runs the transaction
+    # on a peer to obtain a transaction result, but does not submit the endorsed transaction to the orderer to be
+    # committed to the ledger.
+    #
+    # @param [Hash] options gRPC call options @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:request_response
+    #
+    # @return [String] The result returned by the transaction function
+    #
+    def evaluate(options = {})
+      sign
+
+      evaluate_response = client.evaluate(new_evaluate_request, options)
+      evaluate_response.result.payload
+    end
+
+    def endorse
+      # TODO: endorse proposal
+    end
+
+    #
+    # Generates an evaluate request from this proposal.
+    #
+    # @return [Gateway::EvaluateRequest] evaluation request with the current proposal
+    #
+    def new_evaluate_request
+      ::Gateway::EvaluateRequest.new(
+        channel_id: network_name,
+        proposed_transaction: signed_proposal,
+        target_organizations: proposed_transaction.endorsing_organizations
+      )
+    end
+
+    def new_endorse_request
+      # TODO
+    end
+
+    def new_prepared_transaction
+      # TODO
+      # used in endorse
+    end
+  end
+end

data/lib/fabric/proposed_transaction.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module Fabric
+  #
+  # Manages the instantiation and creation of the Gateway::ProposedTransaction Protobuf Message.
+  #
+  # Adapted from official fabric-gateway SDK ProposalBuilder and hyperledger-fabric-sdk:
+  # https://github.com/hyperledger/fabric-gateway/blob/1518e03ed3d6db1b6809e23e61a92744fd18e724/node/src/proposalbuilder.ts
+  # https://github.com/kirshin/hyperledger-fabric-sdk/blob/95a5a1a37001852312df25946e960a9ff149207e/lib/fabric/proposal.rb
+  class ProposedTransaction
+    attr_reader :contract,
+                :transaction_name,
+                :transient_data,
+                :arguments,
+                :proposed_transaction
+
+    # Specifies the set of organizations that will attempt to endorse the proposal.
+    # No other organizations' peers will be sent this proposal.
+    # This is usually used in conjunction with transientData for private data scenarios.
+    attr_reader :endorsing_organizations
+
+    def initialize(contract, transaction_name, arguments: [], transient_data: {}, endorsing_organizations: [])
+      @contract = contract
+      @transaction_name = transaction_name
+      @arguments = arguments
+      @transient_data = transient_data
+      @endorsing_organizations = endorsing_organizations
+
+      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
+    #
+    # @return [Gateway::ProposedTransaction]
+    #
+    def generate_proposed_transaction
+      @proposed_transaction = ::Gateway::ProposedTransaction.new(
+        transaction_id: transaction_id,
+        proposal: signed_proposal,
+        endorsing_organizations: endorsing_organizations
+      )
+    end
+
+    def signed_proposal
+      @signed_proposal ||= Protos::SignedProposal.new(
+        proposal_bytes: proposal.to_proto
+      )
+    end
+
+    def proposal
+      @proposal ||= Protos::Proposal.new header: header.to_proto,
+                                         payload: chaincode_proposal_payload.to_proto
+    end
+
+    def header
+      Common::Header.new channel_header: channel_header.to_proto,
+                         signature_header: signature_header.to_proto
+    end
+
+    def channel_header
+      Common::ChannelHeader.new type: Common::HeaderType::ENDORSER_TRANSACTION,
+                                channel_id: network_name, tx_id: transaction_id,
+                                extension: channel_header_extension.to_proto,
+                                timestamp: timestamp, epoch: 0
+      # version: Constants::CHANNEL_HEADER_VERSION # official SDK does not send this.
+    end
+
+    def channel_header_extension
+      Protos::ChaincodeHeaderExtension.new chaincode_id: chaincode_id
+    end
+
+    def chaincode_id
+      Protos::ChaincodeID.new name: chaincode_name
+    end
+
+    def chaincode_proposal_payload
+      chaincode_input = Protos::ChaincodeInput.new args: [transaction_name] + arguments
+      chaincode_spec = Protos::ChaincodeSpec.new type: Protos::ChaincodeSpec::Type::NODE,
+                                                 chaincode_id: chaincode_id,
+                                                 input: chaincode_input
+      input = Protos::ChaincodeInvocationSpec.new chaincode_spec: chaincode_spec
+
+      Protos::ChaincodeProposalPayload.new input: input.to_proto, TransientMap: transient_data
+    end
+
+    #
+    # Returns the current timestamp
+    #
+    # @return [Google::Protobuf::Timestamp] gRPC timestamp
+    #
+    def timestamp
+      now = Time.now
+
+      @timestamp ||= Google::Protobuf::Timestamp.new seconds: now.to_i, nanos: now.nsec
+    end
+
+    #
+    # Generates a random nonce
+    #
+    # @return [String] random nonce
+    #
+    def nonce
+      @nonce ||= signer.crypto_suite.generate_nonce
+    end
+
+    #
+    # Generates a unique transaction ID for the transaction based on a random number and the signer
+    # or returns the existing transaction ID if it has already been generated.
+    #
+    # @return [String] transaction ID
+    #
+    def transaction_id
+      @transaction_id ||= signer.crypto_suite.hexdigest(nonce + signer.to_proto)
+    end
+
+    #
+    # Generates a SignatureHeader protobuf message from the signer and nonce
+    #
+    # @return [Common::SignatureHeader] signature header protobuf message instance
+    #
+    def signature_header
+      Common::SignatureHeader.new creator: signer.to_proto, nonce: nonce
+    end
+
+    # Dev note: if we have more classes that encapsulate protobuffer messages, consider
+    # creating an EncapsulatedPBMessage to hold the message and expose the following methods
+    # as common interface.
+
+    #
+    # Returns the protobuf message instance
+    #
+    # @return [Gateway::ProposedTransaction] protobuf message instance
+    #
+    def as_proto
+      proposed_transaction
+    end
+
+    #
+    # Returns the serialized Protobuf binary form of the proposed transaction
+    #
+    # @return [String] serialized Protobuf binary form of the proposed transaction
+    #
+    def to_proto
+      proposed_transaction.to_proto
+    end
+
+    #
+    # Returns the serialized JSON form of the proposed transaction
+    #
+    # @param [Hash] options JSON serialization options @see https://ruby-doc.org/stdlib-2.6.3/libdoc/json/rdoc/JSON.html#method-i-generate
+    #
+    # @return [String] serialized JSON form of the proposed transaction
+    #
+    def to_json(options = {})
+      proposed_transaction.to_json(options)
+    end
+  end
+end

data/lib/fabric/version.rb

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

data/lib/fabric.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+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
+#
+module Fabric
+  class Error < StandardError; end
+  class InvalidArgument < Error; end
+  class NotYetImplemented < Error; end
+
+  #
+  # CommitError
+  #
+  # @TODO: TEST ME!
+  #
+  class CommitError < Error
+    attr_reader :code, :transaction_id
+
+    def initialize(status)
+      super("Transaction #{status.transaction_id} failed to commit with status code #{status.code} -" +
+        Protos::TxValidationCode.lookup(status.code).to_s)
+      @code = code
+      @transaction_id = status.transaction_id
+    end
+  end
+
+  def self.crypto_suite(opts = {})
+    @crypto_suite ||= Fabric::ECCryptoSuite.new opts
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fabric-gateway
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonathan Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
 description: 'Hyperledger Fabric Gateway gRPC SDK generated directly from protos found
   at: https://github.com/hyperledger/fabric-protos.'
 email:
@@ -60,33 +144,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - TAGS
 - bin/console
 - bin/regenerate
+- bin/release
 - bin/setup
 - fabric-gateway.gemspec
 - lib/.DS_Store
 - lib/common/common_pb.rb
 - lib/common/policies_pb.rb
+- lib/fabric.rb
 - lib/fabric/.DS_Store
+- lib/fabric/client.rb
+- lib/fabric/constants.rb
+- lib/fabric/contract.rb
+- lib/fabric/ec_crypto_suite.rb
 - lib/fabric/gateway.rb
-- lib/fabric/gateway/client.rb
-- lib/fabric/gateway/constants.rb
-- lib/fabric/gateway/ec_crypto_suite.rb
-- lib/fabric/gateway/identity.rb
-- lib/fabric/gateway/proposal.rb
-- lib/fabric/gateway/version.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
 - lib/gossip/message_pb.rb
@@ -104,10 +198,7 @@ homepage: https://github.com/ethicalidentity/fabric-gateway-ruby
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/ethicalidentity/fabric-gateway-ruby
-  source_code_uri: https://github.com/ethicalidentity/fabric-gateway-ruby
-  changelog_uri: https://github.com/EthicalIdentity/fabric-gateway-ruby/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -116,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: .
-  specs:
-    fabric-gateway (0.0.2)
-      google-protobuf (>= 3.19.1)
-      grpc (~> 1.42)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.4.4)
-    google-protobuf (3.19.1)
-    googleapis-common-protos-types (1.3.0)
-      google-protobuf (~> 3.14)
-    grpc (1.42.0)
-      google-protobuf (~> 3.18)
-      googleapis-common-protos-types (~> 1.0)
-    grpc-tools (1.42.0)
-    rake (12.3.2)
-    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.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  fabric-gateway!
-  grpc-tools (~> 1.42)
-  rake (~> 12.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.1.4