chain-sdk 1.1.1 → 1.2.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a348719a289fcc08cad489af9b14a29c7881314
-  data.tar.gz: 4fe43ec3cb47aec507adfc11c5a11defd87c9184
+  metadata.gz: c013135b3eeaa68f8b9ff51ce82c5605c8373bfb
+  data.tar.gz: 07dbf685e55001d5f69546ffa128b7923dc6eca1
 SHA512:
-  metadata.gz: 52d194b3870c8dc07fb2a4be7866e4dd5e6a8106614ac5380c231a3845bd3bc3587e402ed8b132a1d6fbbd696e66db78e71b2ddb5cf53c13dc1ac5dbe2627124
-  data.tar.gz: 90acba9d91d5061d1f0614787cd3703b4a31a3dab45247fa7a94dd42b9eb10a599d9b974a8f6bbdb75109663ff451624b1122ebff9139f1995c357f5acbb8e64
+  metadata.gz: 1945dea88d0fe6a69a43c34f0c582e0813a369301e6ca675ce0974118e5417d018c55acd7cc2bdeee6d438f5742edd43895e5feb2729a341d97f093f1935c6d5
+  data.tar.gz: 79b0b783a89ed29eb35cfcacf370a7673c5bca7d27870952fbdc1b123b4e31578e4b79abb04105dbd132116686bdea18ab7105ee52ea95ce4cffee1236307cfc

data/README.md

@@ -11,7 +11,7 @@ Ruby 2.0 or greater is required. We strongly recommend upgrading to Ruby 2.1 or
 For most applications, you can simply add the following to your `Gemfile`:
 
 ```
-gem 'chain-sdk', '~> 1.1.1', require: 'chain'
+gem 'chain-sdk', '~> 1.2.0.rc2', require: 'chain'
 ```
 
 ### In your code

data/lib/chain/access_token.rb

@@ -15,8 +15,9 @@ module Chain
     # @return [String]
     attrib :token
 
+    # @deprecated
     # @!attribute [r] type
-    # Either 'client' or 'network'.
+    # Either 'client' or 'network'. Ignore in 1.2 or greater.
     # @return [String]
     attrib :type
 
@@ -27,12 +28,11 @@ module Chain
 
     class ClientModule < Chain::ClientModule
 
-      # Create client/network access token.
+      # Create an access token.
       # @param [Hash] opts
-      # @option opts [String] :type Type specifiying the type of access token to be created.
-      #                                   You must specify either 'client' or 'network'.
       # @option opts [String] :id ID specifying the ID of newly created access token.
       #                                   You must specify a unique ID for access token.
+      # @option opts [String] :type DEPRECATED. Do not use in 1.2 or greater.
       # @return [AccessToken]
       def create(opts = {})
         AccessToken.new(client.conn.request('create-access-token', opts))
@@ -41,7 +41,7 @@ module Chain
       # Get all access tokens sorted by descending creation time,
       # optionally filtered by type.
       # @param [Hash] opts Filtering information
-      # @option opts [String] :type Type of access tokens to return; either 'client' or 'network'.
+      # @option opts [String] :type DEPRECATED. Do not use in 1.2 or greater.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)
@@ -53,7 +53,7 @@ module Chain
       # @return [void]
       def delete(id)
         client.conn.request('delete-access-token', {id: id})
-        return
+        nil
       end
 
       class Query < Chain::Query

data/lib/chain/account.rb

@@ -1,5 +1,4 @@
 require_relative './client_module'
-require_relative './control_program'
 require_relative './errors'
 require_relative './query'
 require_relative './receiver'
@@ -53,20 +52,19 @@ module Chain
         client.conn.batch_request('create-account', opts) { |item| Account.new(item) }
       end
 
-      # @deprecated (as of version 1.1) Use {#create_receiver} instead.
-      # @param [Hash] opts
-      # @return [ControlProgram]
-      def create_control_program(opts = {})
-        # We don't use keyword params here because 'alias' is a Ruby reserverd
-        # word.
-        params = {}
-        params[:account_alias] = opts[:alias] if opts.key?(:alias)
-        params[:account_id] = opts[:id] if opts.key?(:id)
-
-        client.conn.singleton_batch_request(
-          'create-control-program',
-          [{type: :account, params: params}]
-        ) { |item| ControlProgram.new(item) }
+      # @param [Hash] opts Options hash specifiying account creation details.
+      # @option opts [String] id The ID of the account. Either an ID or alias should be provided, but not both.
+      # @option opts [String] alias The alias of the account. Either an ID or alias should be provided, but not both.
+      # @option opts [Hash] tags A new set of tags, which will replace the existing tags.
+      # @return [Hash] a success message.
+      def update_tags(opts)
+        client.conn.singleton_batch_request('update-account-tags', [opts])
+      end
+
+      # @param [Array<Hash>] opts An array of options hashes. See {#update_tags} for a description of the hash structure.
+      # @return [BatchResponse<Hash>]
+      def update_tags_batch(opts)
+        client.conn.batch_request('update-account-tags', opts)
       end
 
       # Creates a new receiver under the specified account.

data/lib/chain/asset.rb

@@ -70,6 +70,21 @@ module Chain
         client.conn.batch_request('create-asset', opts) { |item| Asset.new(item) }
       end
 
+      # @param [Hash] opts Options hash specifiying asset creation details.
+      # @option opts [String] id The ID of the asset. Either an ID or alias should be provided, but not both.
+      # @option opts [String] alias The alias of the asset. Either an ID or alias should be provided, but not both.
+      # @option opts [Hash] tags A new set of tags, which will replace the existing tags.
+      # @return [Hash] a success message.
+      def update_tags(opts)
+        client.conn.singleton_batch_request('update-asset-tags', [opts])
+      end
+
+      # @param [Array<Hash>] opts An array of options hashes. See {#update_tags} for a description of the hash structure.
+      # @return [BatchResponse<Hash>]
+      def update_tags_batch(opts)
+        client.conn.batch_request('update-asset-tags', opts)
+      end
+
       # @param [Hash] opts Filtering information
       # @option opts [String] filter Filter string, see {https://chain.com/docs/core/build-applications/queries}.
       # @option opts [Array<String|Integer>] filter_params Parameter values for filter string (if needed).

data/lib/chain/authorization_grant.rb

@@ -0,0 +1,139 @@
+require_relative './client_module'
+require_relative './query'
+require_relative './response_object'
+
+module Chain
+  class AuthorizationGrant < ResponseObject
+
+    # @!attribute [r] guard_type
+    # The type of credential that the guard matches against. Only "access_token"
+    # and "x509" are allowed.
+    # @return [String]
+    attrib :guard_type
+
+    # @!attribute [r] guard_data
+    # A list of parameters that match specific credentials.
+    # @return [Hash]
+    attrib :guard_data
+
+    # @!attribute [r] policy
+    # @return [String]
+    attrib :policy
+
+    # @!attribute [r] protected
+    # @return [Boolean]
+    # Whether the grant can be deleted. Only used for internal purposes.
+    attrib :protected
+
+    # @!attribute [r] created_at
+    # Timestamp of token creation.
+    # @return [Time]
+    attrib :created_at, rfc3339_time: true
+
+    class ClientModule < Chain::ClientModule
+
+      # Create an authorization grant, which provides the specified
+      # credential with access to the given policy. Credentials are identified
+      # using predicates called guards. Guards identify credentials by type
+      # and by patterns specific to that type.
+      #
+      # @param [Hash] opts
+      # @option opts [String] :guard_type Either "access_token" or "x509".
+      # @option opts [Hash] :guard_data Parameters that describe a credential.
+      #
+      #   For guards of type "access_token", provide a Hash with a single key,
+      #   "id", whose value is the unique ID of the access token.
+      #
+      #   For guards of type "x509", there should be a single top-level key,
+      #   "subject", which maps to a hash of Subject attributes. Valid
+      #   keys include:
+      #     - "C" (Country, string or array of strings)
+      #     - "O" (Organization, string or array of strings)
+      #     - "OU" (Organizational Unit, string or array of strings)
+      #     - "L" (Locality, string or array of strings)
+      #     - "ST" (State or Province, string or array of strings)
+      #     - "STREET" (Street Address, string or array of strings)
+      #     - "POSTALCODE" (Postal Code, string or array of strings)
+      #     - "SERIALNUMBER" (Serial Number, string)
+      #     - "CN" (Common Name, string)
+      #
+      # @option opts [String] :policy One of the following:
+      #
+      #   - "client-readwrite": full access to the Client API, including
+      #      accounts, assets, transactions, access tokens, MockHSM, etc.
+      #   - "client-readonly": read-only access to the Client API.
+      #   - "monitoring": read-only access to diagnostic components of the API,
+      #      including fetching configuration info.
+      #   - "crosscore": access to the cross-core API, including fetching blocks
+      #      and submitting transactions, but not including block signing.
+      #   - "crosscore-signblock": access to the cross-core API's block-signing
+      #      API call.
+      # @return [AuthorizationGrant]
+      def create(opts)
+        # Copy input and stringify keys
+        opts = opts.reduce({}) do |memo, (k, v)|
+          memo[k.to_s] = v
+          memo
+        end
+
+        if opts['guard_type'].to_s == 'x509'
+          opts['guard_data'] = self.class.sanitize_x509(opts['guard_data'])
+        end
+
+        AuthorizationGrant.new(client.conn.request('create-authorization-grant', opts))
+      end
+
+      # List all authorization grants. The sort order is not defined.
+      # @return [Array<AuthorizationGrant>]
+      def list_all
+        client.conn.request('list-authorization-grants')['items'].map { |item| AuthorizationGrant.new(item) }
+      end
+
+      # Delete the specified authorization grant.
+      # @param opts Identical to {#create}.
+      # @return [void]
+      def delete(opts)
+        client.conn.request('delete-authorization-grant', opts)
+        nil
+      end
+
+      SUBJECT_ATTRIBUTES = {
+        'C' => {array: true},
+        'O' => {array: true},
+        'OU' => {array: true},
+        'L' => {array: true},
+        'ST' => {array: true},
+        'STREET' => {array: true},
+        'POSTALCODE' => {array: true},
+        'SERIALNUMBER' => {array: false},
+        'CN' => {array: false},
+      }
+
+      def self.sanitize_x509(guard_data)
+        first_key = guard_data.keys.first
+        if guard_data.size != 1 || first_key.to_s.downcase != 'subject'
+          raise ArgumentError.new('Guard data must contain exactly one key, "subject"')
+        end
+
+        res = {}
+        res[first_key] = guard_data.values.first.reduce({}) do |memo, (k, v)|
+          attrib = SUBJECT_ATTRIBUTES[k.to_s.upcase]
+          raise ArgumentError.new("Invalid subject attrib: #{k}") unless attrib
+
+          if attrib[:array] && !v.is_a?(Array)
+            memo[k] = [v]
+          elsif !attrib[:array] && v.is_a?(Array)
+            raise ArgumentError.new("Invalid array value for #{k}: #{v}")
+          else
+            memo[k] = v
+          end
+
+          memo
+        end
+        res
+      end
+
+    end
+
+  end
+end

data/lib/chain/client.rb

@@ -1,4 +1,5 @@
 require_relative './access_token'
+require_relative './authorization_grant'
 require_relative './account'
 require_relative './asset'
 require_relative './balance'
@@ -31,6 +32,11 @@ module Chain
       @access_tokens ||= AccessToken::ClientModule.new(self)
     end
 
+    # @return [AuthorizationGrant::ClientModule]
+    def authorization_grants
+      @authorization_grants ||= AuthorizationGrant::ClientModule.new(self)
+    end
+
     # @return [Account::ClientModule]
     def accounts
       @accounts ||= Account::ClientModule.new(self)

data/lib/chain/config.rb

@@ -5,6 +5,30 @@ module Chain
   module Config
 
     class Info < ResponseObject
+      class BuildConfig < ResponseObject
+        # @!attribute [r] is_localhost_auth
+        # @return [Boolean]
+        # Whether any request from the loopback device (localhost) should be
+        # automatically authenticated and authorized, without additional
+        # credentials.
+        attrib :is_localhost_auth
+
+        # @!attribute [r] is_mockhsm
+        # @return [Boolean]
+        # Whether the MockHSM API is enabled.
+        attrib :is_mockhsm
+
+        # @!attribute [r] is_reset
+        # @return [Boolean]
+        # Whether the core reset API call is enabled.
+        attrib :is_reset
+
+        # @!attribute [r] is_http_ok
+        # @return [Boolean]
+        # Whether non-TLS HTTP requests (http://...) are allowed.
+        attrib :is_http_ok
+      end
+
       class Snapshot < ResponseObject
         # @!attribute [r] attempt
         # @return [Integer]
@@ -71,8 +95,14 @@ module Chain
       # @return [Boolean]
       attrib :is_production
 
+      # @!attribute [r] crosscore_rpc_version
+      # @return [Integer]
+      attrib :crosscore_rpc_version
+
+      # @deprecated
       # @!attribute [r] network_rpc_version
       # @return [Integer]
+      # Ignore in 1.2 or greater. Superseded by crosscore_rpc_version.
       attrib :network_rpc_version
 
       # @!attribute [r] core_id
@@ -95,6 +125,10 @@ module Chain
       # @return [String]
       attrib :build_date
 
+      # @!attribute [r] build_config
+      # @return [BuildConfig]
+      attrib(:build_config) { |raw| BuildConfig.new(raw) }
+
       # @!attribute [r] health
       # @return [Hash]
       attrib :health
@@ -116,7 +150,7 @@ module Chain
       # @param [Hash] opts Options for configuring Chain Core.
       # @option opts [Boolean] is_generator Whether the local core will be a block generator for the blockchain; i.e., you are starting a new blockchain on the local core. `false` if you are connecting to a pre-existing blockchain.
       # @option opts [String] generator_url A URL for the block generator. Required if `isGenerator` is false.
-      # @option opts [String] generator_access_token 	A network access token provided by administrators of the block generator. Required if `isGenerator` is false.
+      # @option opts [String] generator_access_token 	An access token provided by administrators of the block generator. Required if `isGenerator` is false.
       # @option opts [String] blockchain_id The unique ID of the generator's blockchain. Required if `isGenerator` is false.
       # @return [void]
       def configure(opts)

data/lib/chain/connection.rb

@@ -57,7 +57,11 @@ module Chain
         if !!item['code']
           errors[i] = APIError.new(item, response)
         else
-          successes[i] = translate.call(item)
+          if translate
+            successes[i] = translate.call(item)
+          else
+            successes[i] = item
+          end
         end
       end
 
@@ -182,6 +186,18 @@ module Chain
       if @url.scheme == 'https'
         @http.use_ssl = true
         @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        if @opts.key?(:ssl_params)
+          ssl_params = @opts[:ssl_params]
+          if ssl_params.key?(:ca_file)
+            @http.ca_file = ssl_params[:ca_file]
+          end
+          if ssl_params.key?(:cert)
+            @http.cert = ssl_params[:cert]
+          end
+          if ssl_params.key?(:key)
+            @http.key = ssl_params[:key]
+          end
+        end
       end
 
       @http

data/lib/chain/transaction.rb

@@ -164,12 +164,6 @@ module Chain
       # @return [String]
       attrib :spent_output_id
 
-      # @deprecated (as of version 1.1) Use {#spent_output_id} instead.
-      # @!attribute [r] spent_output
-      # The output consumed by this input.
-      # @return [SpentOutput]
-      attrib(:spent_output) { |raw| SpentOutput.new(raw) }
-
       # @!attribute [r] account_id
       # The id of the account transferring the asset (possibly null if the
       # input is an issuance or an unspent output is specified).
@@ -187,22 +181,12 @@ module Chain
       # @return [String]
       attrib :account_tags
 
-      # @deprecated (as of version 1.1) Do not use this field.
-      # @!attribute [r] input_witness
-      # @return [String]
-      attrib :input_witness
-
       # @!attribute [r] issuance_program
       # A program specifying a predicate for issuing an asset (possibly null
       # if input is not an issuance).
       # @return [String]
       attrib :issuance_program
 
-      # @deprecated (as of version 1.1) Do not use this field.
-      # @!attribute [r] control_program
-      # @return [String]
-      attrib :control_program
-
       # @!attribute [r] reference_data
       # User specified, unstructured data embedded within an input
       # (possibly null).
@@ -213,19 +197,6 @@ module Chain
       # A flag indicating if the input is local.
       # @return [Boolean]
       attrib :is_local
-
-      # @deprecated (as of version 1.1)
-      class SpentOutput < ResponseObject
-        # @!attribute [r] transaction_id
-        # Unique transaction identifier.
-        # @return [String]
-        attrib :transaction_id
-
-        # @!attribute [r] position
-        # Position of an output within the transaction.
-        # @return [Integer]
-        attrib :position
-      end
     end
 
     class Output < ResponseObject
@@ -418,8 +389,6 @@ module Chain
       # Add a spend action taken on a particular unspent output.
       # @param [Hash] params Action parameters
       # @option params [String] :output_id Output ID specifying the transaction output to spend.
-      # @option params [String] :transaction_id DEPRECATED (as of version 1.1) Transaction ID specifying the transaction to select an output from.
-      # @option params [Integer] :position DEPRECATED (as of version 1.1) Position of the output within the transaction to be spent.
       # @return [Builder]
       def spend_account_unspent_output(params)
         add_action(params.merge(type: :spend_account_unspent_output))
@@ -455,20 +424,6 @@ module Chain
         add_action(params.merge(type: :control_receiver))
       end
 
-      # @deprecated (as of version 1.1) Use {#control_with_receiver} instead.
-      # Add a control action taken on a control program.
-      # @param [Hash] params Action parameters
-      # @option params [String] :asset_id Asset ID specifying the asset to be controlled.
-      #                                   You must specify either an ID or an alias.
-      # @option params [String] :asset_alias Asset alias specifying the asset to be controlled.
-      #                                   You must specify either an ID or an alias.
-      # @option params [String] :control_program The control program to be used
-      # @option params [Integer] :amount amount of the asset to be controlled.
-      # @return [Builder]
-      def control_with_program(params)
-        add_action(params.merge(type: :control_program))
-      end
-
       # Add a retire action.
       # @param [Hash] params Action parameters
       # @option params [String] :asset_id Asset ID specifying the asset to be retired.

data/lib/chain/version.rb

@@ -1,3 +1,3 @@
 module Chain
-  VERSION = '1.1.1'
+  VERSION = '1.2.0.rc2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chain-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0.rc2
 platform: ruby
 authors:
 - Chain Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ files:
 - lib/chain/access_token.rb
 - lib/chain/account.rb
 - lib/chain/asset.rb
+- lib/chain/authorization_grant.rb
 - lib/chain/balance.rb
 - lib/chain/batch_response.rb
 - lib/chain/client.rb
@@ -97,7 +98,6 @@ files:
 - lib/chain/config.rb
 - lib/chain/connection.rb
 - lib/chain/constants.rb
-- lib/chain/control_program.rb
 - lib/chain/errors.rb
 - lib/chain/hsm_signer.rb
 - lib/chain/mock_hsm.rb
@@ -123,9 +123,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8

data/lib/chain/control_program.rb

@@ -1,11 +0,0 @@
-require_relative './response_object'
-
-module Chain
-  # @deprecated (as of version 1.1) Use {Receiver} instead.
-  class ControlProgram < ResponseObject
-    # @!attribute [r] control_program
-    # Hex-encoded string representation of the control program.
-    # @return [String]
-    attrib :control_program
-  end
-end