fabric-gateway 0.0.2 → 0.4.0

data/lib/fabric/network.rb

@@ -0,0 +1,70 @@
+# 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
+
+    # @!parse include Fabric::Accessors::Gateway
+    include Fabric::Accessors::Gateway
+
+    def initialize(gateway, name)
+      @gateway = gateway
+      @name = name
+    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
+
+    #
+    # Get chaincode events emitted by transaction functions of a specific chaincode.
+    #
+    # @see Fabric::Client#chaincode_events Fabric::Client#chaincode_events - explanation of the different return types
+    #   and example usage.
+    # @see https://www.rubydoc.info/gems/grpc/GRPC%2FClientStub:server_streamer Call options for options parameter
+    #
+    # @param [Fabric::Contract] contract the chaincode to listen for events on
+    # @param [Integer] start_block Block number at which to start reading chaincode events.
+    # @param [Hash] call_options gRPC call options (merged with default_call_options from initializer)
+    # @yield [chaincode_event] loops through the chaincode events
+    # @yieldparam chaincode_event [Gateway::ChaincodeEventsResponse] the chaincode event
+    #
+    # @return [Enumerator|GRPC::ActiveCall::Operation|nil] Dependent on parameters passed;
+    #   please see Fabric::Client#get_chaincode_events
+    #
+    def chaincode_events(contract, start_block: nil, call_options: {}, &block)
+      new_chaincode_events_request(contract, start_block: start_block).get_events(call_options, &block)
+    end
+
+    #
+    # Create a request to receive chaincode events emitted by transaction functions of a specific chaincode. Supports
+    # off-line signing flow.
+    #
+    # @note I'm lying. I just copy and pasted the description from the node SDK. Offline signing should work, but it has
+    #   not been explicitly tested.
+    # @todo Test off-line signing flow.
+    #
+    # @param [Fabric::Contract] contract the chaincode to listen for events on
+    # @param [Integer] start_block Block number at which to start reading chaincode events.
+    # @return [Fabric::ChaincodeEventsRequest] Encapsulated ChaincodeEventsRequest
+    #
+    def new_chaincode_events_request(contract, start_block: nil)
+      ChaincodeEventsRequest.new(contract, start_block: start_block)
+    end
+  end
+end

data/lib/fabric/version.rb

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

data/lib/fabric.rb

@@ -0,0 +1,59 @@
+# 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/entities/chaincode_events_requests'
+
+require 'fabric/constants'
+require 'fabric/contract'
+require 'fabric/client'
+require 'fabric/ec_crypto_suite'
+require 'fabric/gateway'
+require 'fabric/network'
+require 'fabric/version'
+
+#
+# Hyperledger Fabric Gateway SDK
+#
+module Fabric
+  class Error < StandardError; end
+  class InvalidArgument < Error; end
+  class NotYetImplemented < Error; end
+
+  #
+  # CommitError
+  #
+  # TODO: Add RSpec Tests for CommitError
+  # @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} - " +
+        Status::TRANSACTION_STATUSES.key(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

data/lib/msp/identities_pb.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: msp/identities.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("msp/identities.proto", :syntax => :proto3) do
+    add_message "msp.SerializedIdentity" do
+      optional :mspid, :string, 1
+      optional :id_bytes, :bytes, 2
+    end
+    add_message "msp.SerializedIdemixIdentity" do
+      optional :nym_x, :bytes, 1
+      optional :nym_y, :bytes, 2
+      optional :ou, :bytes, 3
+      optional :role, :bytes, 4
+      optional :proof, :bytes, 5
+    end
+  end
+end
+
+module Msp
+  SerializedIdentity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("msp.SerializedIdentity").msgclass
+  SerializedIdemixIdentity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("msp.SerializedIdemixIdentity").msgclass
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fabric-gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Jonathan Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -38,40 +38,192 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
-description: 'Hyperledger Fabric Gateway gRPC SDK generated directly from protos found
-  at: https://github.com/hyperledger/fabric-protos.'
+- !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    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
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+description: Ruby port of the Hyperledger Fabric Gateway SDK
 email:
 - jonathan.chan@ethicalidentity.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/todo.yml"
+- ".github/workflows/yardoc.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
+- ".vscode/settings.json"
+- ".yardopts"
 - 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/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/chaincode_events_requests.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/gateway/version.rb
+- lib/fabric/network.rb
+- lib/fabric/version.rb
 - lib/gateway/gateway_pb.rb
 - lib/gateway/gateway_services_pb.rb
 - lib/gossip/message_pb.rb
 - lib/gossip/message_services_pb.rb
+- lib/msp/identities_pb.rb
 - lib/msp/msp_principal_pb.rb
 - lib/orderer/ab_pb.rb
 - lib/orderer/ab_services_pb.rb
@@ -84,10 +236,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:
@@ -96,15 +245,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Hyperledger Fabric Gateway gRPC SDK
+summary: Hyperledger Fabric Gateway SDK
 test_files: []

data/Gemfile.lock

@@ -1,42 +0,0 @@
-PATH
-  remote: .
-  specs:
-    fabric-gateway (0.0.1)
-      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)
-    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!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.1.4

data/lib/fabric/gateway/version.rb

@@ -1,5 +0,0 @@
-module Fabric
-  module Gateway
-    VERSION = "0.0.2"
-  end
-end