chain-sdk 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b8ac599da94e7d0794f9bf0e81248a85bc36c31
-  data.tar.gz: 661e47cb08a1f23f3754dc26ab3fcad0db72ce42
+  metadata.gz: 54f23f819a849083b45080882adef93353e12d3b
+  data.tar.gz: e88714cdcf76f624b38965d69edb32349aabce1d
 SHA512:
-  metadata.gz: d85b62e5d945073c8b905e82a2e5ffaa2d41156d1edf272824363c0ce44407d51caa1084bbc1e383c7c08ae3c888f9474b1f32a2f0f78683ab9f1d9cee8e3b42
-  data.tar.gz: 5be665c96c11b45be2b78282cec50550f12a539b007c14efd5d80a80cc987dd15ab81caaf5fa046974184cc21969b90a6eccaa0a709895be5c01d6e8cb7d3a38
+  metadata.gz: 16129701fb041747f5605831493653076ba29155c1879ebd0a504ea66b98db03053cacc5c8d62603aae60f7dd39756c6521c182c3124c19634a4ec4e9265a6ba
+  data.tar.gz: 4cff47a5f44808ae2592904e6b8a7d2a41032a92bf2a53ef7ec4e28123b889831175a926794d936d4d4c20250e44a3f3b740f2bd2bfa319f51ac2e3a2c71262f

data/README.md

@@ -4,14 +4,12 @@
 
 ### Get the gem
 
-The Ruby SDK is available [via Rubygems](https://rubygems.org/gems/chain-sdk). Make sure to use the most recent version whose major and minor components (`major.minor.x`) match your version of Chain Core.
-
-Ruby 2.0 or greater is required. We strongly recommend upgrading to Ruby 2.1 or greater, as [Ruby 2.0 has reached end-of-life](https://www.ruby-lang.org/en/downloads/branches/) and will no longer receive security updates and bugfixes.
+The Ruby SDK is available [via Rubygems](https://rubygems.org/gems/chain-sdk). Make sure to use the most recent version whose major and minor components (`major.minor.x`) match your version of Chain Core. Ruby 2.1 or greater is required.
 
 For most applications, you can simply add the following to your `Gemfile`:
 
 ```
-gem 'chain-sdk', '~> 1.0.3', require: 'chain'
+gem 'chain-sdk', '~> 1.1.0', require: 'chain'
 ```
 
 ### In your code

data/lib/chain/access_token.rb

@@ -23,22 +23,25 @@ module Chain
     # @!attribute [r] created_at
     # Timestamp of token creation.
     # @return [Time]
-    attrib(:created_at) { |raw| Time.parse(raw) }
+    attrib :created_at, rfc3339_time: true
 
     class ClientModule < Chain::ClientModule
 
       # Create client/network access token.
       # @param [Hash] opts
-      # @option params [String] :type Type specifiying the type of access token to be created.
+      # @option opts [String] :type Type specifiying the type of access token to be created.
       #                                   You must specify either 'client' or 'network'.
-      # @option params [String] :id ID specifying the ID of newly created access token.
+      # @option opts [String] :id ID specifying the ID of newly created access token.
       #                                   You must specify a unique ID for access token.
       # @return [AccessToken]
       def create(opts = {})
         AccessToken.new(client.conn.request('create-access-token', opts))
       end
 
-      # @param [Hash] opts
+      # 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'.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)

data/lib/chain/account.rb

@@ -2,6 +2,7 @@ require_relative './client_module'
 require_relative './control_program'
 require_relative './errors'
 require_relative './query'
+require_relative './receiver'
 require_relative './response_object'
 
 module Chain
@@ -34,20 +35,25 @@ module Chain
     attrib :tags
 
     class ClientModule < Chain::ClientModule
-      # @param [Hash] opts
+      # @param [Hash] opts Options hash specifiying account creation details.
+      # @option opts [String] alias User specified, unique identifier.
+      # @option opts [Array<String>] root_xpubs The list of keys used to create control programs under the account.
+      # @option opts [Integer] quorum	The number of keys required to sign transactions for the account.
+      # @option opts [Hash] tags User-specified tag structure for the account.
       # @return [Account]
       def create(opts)
         opts = {client_token: SecureRandom.uuid}.merge(opts)
         client.conn.singleton_batch_request('create-account', [opts]) { |item| Account.new(item) }
       end
 
-      # @param [Array<Hash>] opts
-      # @return [Array<Account>]
+      # @param [Array<Hash>] opts An array of options hashes. See {#create} for a description of the hash structure.
+      # @return [BatchResponse<Account>]
       def create_batch(opts)
         opts = opts.map { |i| {client_token: SecureRandom.uuid}.merge(i) }
         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 = {})
@@ -63,10 +69,31 @@ module Chain
         ) { |item| ControlProgram.new(item) }
       end
 
-      # @param [Hash] query
+      # Creates a new receiver under the specified account.
+      #
+      # @param opts [Hash] Options hash
+      # @option opts [String] :account_alias Unique alias for an account. Either account_alias or account_id is required.
+      # @option opts [String] :account_id Unique ID for an account. Either account_alias or account_id is required.
+      # @option opts [String] :expires_at An RFC3339 timestamp indicating when the receiver will expire. Defaults to 30 days in the future.
+      # @return [Receiver]
+      def create_receiver(opts)
+        client.conn.singleton_batch_request('create-account-receiver', [opts]) { |item| Receiver.new(item) }
+      end
+
+      # Creates new receivers under the specified accounts.
+      #
+      # @param opts_list [Array<Hash>] Array of options hashes. See {#create_receiver} for a description of the hash structure.
+      # @return [BatchResponse<Receiver>]
+      def create_receiver_batch(opts_list)
+        client.conn.batch_request('create-account-receiver', opts_list) { |item| Receiver.new(item) }
+      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).
       # @return [Query]
-      def query(query = {})
-        Query.new(client, query)
+      def query(opts = {})
+        Query.new(client, opts)
       end
     end
 

data/lib/chain/asset.rb

@@ -51,24 +51,31 @@ module Chain
     attrib :is_local
 
     class ClientModule < Chain::ClientModule
-      # @param [Hash] opts
+      # @param [Hash] opts Options hash specifiying asset creation details.
+      # @option opts [String] alias User specified, unique identifier.
+      # @option opts [Array<String>] root_xpubs The list of keys used to create the issuance program for the asset.
+      # @option opts [Integer] quorum The number of keys required to issue units of the asset.
+      # @option opts [Hash] tags User-specified, arbitrary/unstructured data local to the asset's originating core.
+      # @option opts [Hash] definition User-specified, arbitrary/unstructured data visible across blockchain networks.
       # @return [Asset]
       def create(opts)
         opts = {client_token: SecureRandom.uuid}.merge(opts)
         client.conn.singleton_batch_request('create-asset', [opts]) { |item| Asset.new(item) }
       end
 
-      # @param [Hash] opts
-      # @return [Array<Asset>]
+      # @param [Array<Hash>] opts An array of options hashes. See {#create} for a description of the hash structure.
+      # @return [BatchResponse<Asset>]
       def create_batch(opts)
         opts = opts.map { |i| {client_token: SecureRandom.uuid}.merge(i) }
         client.conn.batch_request('create-asset', opts) { |item| Asset.new(item) }
       end
 
-      # @param [Hash] query
+      # @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).
       # @return [Query]
-      def query(query = {})
-        Query.new(client, query)
+      def query(opts = {})
+        Query.new(client, opts)
       end
     end
 

data/lib/chain/balance.rb

@@ -16,10 +16,14 @@ module Chain
     attrib :sum_by
 
     class ClientModule < Chain::ClientModule
-      # @param [Hash] query
+      # @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).
+      # @option opts [Array<String>] sum_by List of unspent output attributes to sum by.
+      # @option opts [Integer] timestamp A millisecond Unix timestamp. By using this parameter, you can perform queries that reflect the state of the blockchain at different points in time.
       # @return [Query]
-      def query(query = {})
-        Query.new(client, query)
+      def query(opts = {})
+        Query.new(client, opts)
       end
     end
 

data/lib/chain/batch_response.rb

@@ -18,4 +18,12 @@ module Chain
 
     attr_reader :successes, :errors, :response
   end
+
+  private
+
+  def ensure_key_sorting(h)
+    sorted = h.keys.sort
+    return h if sorted == h.keys
+    sorted.reduce({}) { |memo, k| memo[k] = h[k]; memo }
+  end
 end

data/lib/chain/config.rb

@@ -33,7 +33,7 @@ module Chain
 
       # @!attribute [r] configured_at
       # @return [Time]
-      attrib(:configured_at) { |raw| Time.parse(raw) }
+      attrib :configured_at, rfc3339_time: true
 
       # @!attribute [r] is_signer
       # @return [Boolean]
@@ -43,7 +43,7 @@ module Chain
       # @return [Boolean]
       attrib :is_generator
 
-      # @!attribute [r] is_generator
+      # @!attribute [r] generator_url
       # @return [String]
       attrib :generator_url
 
@@ -65,7 +65,7 @@ module Chain
 
       # @!attribute [r] generator_block_height_fetched_at
       # @return [Time]
-      attrib(:generator_block_height_fetched_at) { |raw| Time.parse(raw) }
+      attrib :generator_block_height_fetched_at, rfc3339_time: true
 
       # @!attribute [r] is_production
       # @return [Boolean]
@@ -105,16 +105,25 @@ module Chain
     end
 
     class ClientModule < Chain::ClientModule
+      # Reset specified Chain Core.
+      # @param [Boolean] everything 	If `true`, all objects including access tokens and MockHSM keys will be deleted. If `false`, then access tokens and MockHSM keys will be preserved.
       # @return [void]
       def reset(everything: false)
         client.conn.request('reset', {everything: everything})
       end
 
+      # Configure specified Chain Core.
+      # @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] blockchain_id The unique ID of the generator's blockchain. Required if `isGenerator` is false.
       # @return [void]
       def configure(opts)
         client.conn.request('configure', opts)
       end
 
+      # Get info on specified Chain Core.
       # @return [Info]
       def info
         Info.new(client.conn.request('info'))

data/lib/chain/control_program.rb

@@ -1,6 +1,7 @@
 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.

data/lib/chain/hsm_signer.rb

@@ -10,6 +10,9 @@ module Chain
       @xpubs_by_signer = {}
     end
 
+    # Add a new key/signer pair to the HSM signer.
+    # @param [MockHsm::Key || String] xpub_or_key An object with an xpub key, or an xpub as a string.
+    # @param [Connection] signer_conn Authenticated connection to a specific HSM instance.
     def add_key(xpub_or_key, signer_conn)
       xpub = xpub_or_key.is_a?(MockHSM::Key) ? xpub_or_key.xpub : xpub_or_key
       @xpubs_by_signer[signer_conn] ||= []
@@ -17,6 +20,8 @@ module Chain
       @xpubs_by_signer[signer_conn].uniq!
     end
 
+    # Sign a single transaction
+    # @param [Hash] tx_template	A single transaction template.
     def sign(tx_template)
       return tx_template if @xpubs_by_signer.empty?
 
@@ -31,6 +36,8 @@ module Chain
       tx_template
     end
 
+    # Sign a batch of transactions
+    # @param [Array<Hash>] tx_templates Array of transaction templates.
     def sign_batch(tx_templates)
       if @xpubs_by_signer.empty?
         # Treat all templates as if signed successfully.

data/lib/chain/mock_hsm.rb

@@ -12,6 +12,7 @@ module Chain
         @keys_module ||= Key::ClientModule.new(client)
       end
 
+      # MockHSM signer connection.
       # @return [Connection]
       def signer_conn
         return @signer_conn if @signer_conn
@@ -37,16 +38,18 @@ module Chain
       class ClientModule < Chain::ClientModule
 
         # Creates a key object.
-        # @param [Hash] opts
+        # @param [Hash] opts Parameters for MockHSM key creation.
+        # @option opts [String] alias User specified, unique identifier.
         # @return [Key]
         def create(opts = {})
           Key.new(client.conn.request('mockhsm/create-key', opts))
         end
 
-        # @param [Hash] query
+        # @param [Hash] opts Filtering information
+        # @option opts [Array<String>] aliases Optional list of requested aliases, max 200.
         # @return [Query]
-        def query(query = {})
-          Query.new(client, query)
+        def query(opts = {})
+          Query.new(client, opts)
         end
       end
 

data/lib/chain/receiver.rb

@@ -0,0 +1,15 @@
+require_relative './response_object'
+
+module Chain
+  class Receiver < ResponseObject
+    # @!attribute [r] control_program
+    # The underlying control program that will be used in transactions paying to this receiver.
+    # @return [String]
+    attrib :control_program
+
+    # @!attribute [r] expires_at
+    # A timestamp indicating when the receiver will expire.
+    # @return [Time]
+    attrib :expires_at, rfc3339_time: true
+  end
+end

data/lib/chain/response_object.rb

@@ -18,7 +18,12 @@ module Chain
     end
 
     def to_json(opts = nil)
-      to_h.to_json(opts)
+      h = to_h.reduce({}) do |memo, (k, v)|
+        memo[k] = self.class.detranslate(k, v)
+        memo
+      end
+
+      h.to_json
     end
 
     def [](attrib_name)
@@ -41,8 +46,9 @@ module Chain
     end
 
     # @!visibility private
-    def self.attrib(attrib_name, &translate)
-      attrib_opts[attrib_name.to_sym] = {translate: translate}
+    def self.attrib(attrib_name, opts = {}, &translate)
+      opts[:translate] = translate
+      attrib_opts[attrib_name.to_sym] = opts
       attr_accessor attrib_name
     end
 
@@ -55,6 +61,8 @@ module Chain
     def self.translate(attrib_name, raw_value)
       attrib_name = attrib_name.to_sym
       opts = attrib_opts[attrib_name]
+
+      return Time.parse(raw_value) if opts[:rfc3339_time]
       return raw_value if opts[:translate].nil?
 
       begin
@@ -64,18 +72,45 @@ module Chain
       end
     end
 
+    # @!visibility private
+    def self.detranslate(attrib_name, raw_value)
+      opts = attrib_opts.fetch(attrib_name, {})
+
+      if opts[:rfc3339_time]
+        begin
+          return raw_value.to_datetime.rfc3339
+        rescue => e
+          raise DetranslateError.new(attrib_name, raw_value, e)
+        end
+      end
+
+      raw_value
+    end
+
     class TranslateError < StandardError
       attr_reader :attrib_name
       attr_reader :raw_value
       attr_reader :source
 
       def initialize(attrib_name, raw_value, source)
-        super "Translation error for attrib #{attrib_name}: #{source}"
+        super "Error translating attrib #{attrib_name}: #{source}"
         @attrib_name = attrib_name
         @raw_value = raw_value
         @source = source
       end
     end
 
+    class DetranslateError < StandardError
+      attr_reader :attrib_name
+      attr_reader :raw_value
+      attr_reader :source
+
+      def initialize(attrib_name, raw_value, source)
+        super "Error de-translating attrib #{attrib_name}: #{source}"
+        @attrib_name = attrib_name
+        @raw_value = raw_value
+        @source = source
+      end
+    end
   end
 end

data/lib/chain/transaction.rb

@@ -1,5 +1,4 @@
 require 'securerandom'
-require 'time'
 
 require_relative './client_module'
 require_relative './query'
@@ -16,7 +15,7 @@ module Chain
     # @!attribute [r] timestamp
     # Time of transaction.
     # @return [Time]
-    attrib(:timestamp) { |raw| Time.parse(raw) }
+    attrib :timestamp, rfc3339_time: true
 
     # @!attribute [r] block_id
     # Unique identifier, or block hash, of the block containing a transaction.
@@ -54,9 +53,10 @@ module Chain
     attrib(:outputs) { |raw| raw.map { |v| Output.new(v) } }
 
     class ClientModule < Chain::ClientModule
-      # @param [Builder] builder
-      # @yield Block defining transaction actions.
-      # @return [Template]
+      # Build an unsigned transaction from a set of actions.
+      # @param [Builder] builder Builder object with actions defined. If provided, overrides block parameter.
+      # @yield Block defining transaction actions. A {Builder} object is passed as the only parameter.
+      # @return [Template] Unsigned transaction template, or error.
       def build(builder = nil, &block)
         if builder.nil?
           builder = Builder.new(&block)
@@ -68,8 +68,9 @@ module Chain
         ) { |item| Template.new(item) }
       end
 
-      # @param [Array<Builder>] builders
-      # @return [Array<Template>]
+      # Build multiple unsigned transactions from multiple sets of actions.
+      # @param [Array<Builder>] builders Multiple builder objects with actions defined.
+      # @return [BatchResponse<Template>] Batch of unsigned transaction templates, or errors.
       def build_batch(builders)
         client.conn.batch_request(
           'build-transaction',
@@ -77,7 +78,8 @@ module Chain
         ) { |item| Template.new(item) }
       end
 
-      # @param [Template] template
+      # Submit a signed transaction to the blockchain.
+      # @param [Template] template Signed transaction template.
       # @return [SubmitResponse]
       def submit(template)
         client.conn.singleton_batch_request(
@@ -86,8 +88,9 @@ module Chain
         ) { |item| SubmitResponse.new(item) }
       end
 
-      # @param [Array<Template>] templates
-      # @return [Array<SubmitResponse>]
+      # Submit multiple signed transactions to the blockchain.
+      # @param [Array<Template>] templates Array of signed transaction templates.
+      # @return [BatchResponse<SubmitResponse>]
       def submit_batch(templates)
         client.conn.batch_request(
           'submit-transaction',
@@ -95,10 +98,16 @@ module Chain
         ) { |item| SubmitResponse.new(item) }
       end
 
-      # @param [Hash] query
+      # List all transactions, optionally filtered
+      # @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).
+      # @option opts [Integer] start_time A Unix timestamp in milliseconds. When specified, only transactions with a block time greater than the start time will be returned.
+      # @option opts [Integer] end_time A Unix timestamp in milliseconds. When specified, only transactions with a block time less than the start time will be returned.
+      # @option opts [Integer] timeout A time in milliseconds after which a server timeout should occur. Defaults to 1000 (1 second).
       # @return [Query]
-      def query(query = {})
-        Query.new(client, query)
+      def query(opts = {})
+        Query.new(client, opts)
       end
     end
 
@@ -150,6 +159,12 @@ module Chain
       # @return [Integer]
       attrib :amount
 
+      # @!attribute [r] spent_output_id
+      # The id of the output consumed by this input. ID is nil if this is an issuance input.
+      # @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]
@@ -172,6 +187,7 @@ 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
@@ -182,6 +198,7 @@ module Chain
       # @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
@@ -197,6 +214,7 @@ module Chain
       # @return [Boolean]
       attrib :is_local
 
+      # @deprecated (as of version 1.1)
       class SpentOutput < ResponseObject
         # @!attribute [r] transaction_id
         # Unique transaction identifier.
@@ -211,6 +229,11 @@ module Chain
     end
 
     class Output < ResponseObject
+      # @!attribute [r] id
+      # The id of the output.
+      # @return [String]
+      attrib :id
+
       # @!attribute [r] type
       # The type of the output.
       #
@@ -340,7 +363,7 @@ module Chain
         to_h.to_json(opts)
       end
 
-      # Add an action to the tranasction builder
+      # Add an action to the transaction builder
       # @param [Hash] params Action parameters containing a type field and the
       #               required parameters for that type
       # @return [Builder]
@@ -366,7 +389,7 @@ module Chain
 
       # Add an issuance action.
       # @param [Hash] params Action parameters
-      # @option params [String] :asset_id Asset ID specifiying the asset to be issued.
+      # @option params [String] :asset_id Asset ID specifying the asset to be issued.
       #                                   You must specify either an ID or an alias.
       # @option params [String] :asset_alias Asset alias specifying the asset to be issued.
       #                                   You must specify either an ID or an alias.
@@ -378,11 +401,11 @@ module Chain
 
       # Add a spend action taken on a particular account.
       # @param [Hash] params Action parameters
-      # @option params [String] :asset_id Asset ID specifiying the asset to be spent.
+      # @option params [String] :asset_id Asset ID specifying the asset to be spent.
       #                                   You must specify either an ID or an alias.
       # @option params [String] :asset_alias Asset alias specifying the asset to be spent.
       #                                   You must specify either an ID or an alias.
-      # @option params [String] :account_id Account ID specifiying the account spending the asset.
+      # @option params [String] :account_id Account ID specifying the account spending the asset.
       #                                   You must specify either an ID or an alias.
       # @option params [String] :account_alias Account alias specifying the account spending the asset.
       #                                   You must specify either an ID or an alias.
@@ -394,8 +417,9 @@ module Chain
 
       # Add a spend action taken on a particular unspent output.
       # @param [Hash] params Action parameters
-      # @option params [String] :transaction_id Transaction ID specifying the tranasction to select an output from.
-      # @option params [Integer] :position Position of the output within the transaction to be spent.
+      # @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))
@@ -403,11 +427,11 @@ module Chain
 
       # Add a control action taken on a particular account.
       # @param [Hash] params Action parameters
-      # @option params [String] :asset_id Asset ID specifiying the asset to be controlled.
+      # @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] :account_id Account ID specifiying the account controlling the asset.
+      # @option params [String] :account_id Account ID specifying the account controlling the asset.
       #                                   You must specify either an ID or an alias.
       # @option params [String] :account_alias Account alias specifying the account controlling the asset.
       #                                   You must specify either an ID or an alias.
@@ -417,9 +441,24 @@ module Chain
         add_action(params.merge(type: :control_account))
       end
 
+      # Sends assets to the specified receiver.
+      #
+      # @param [Hash] params Action parameters
+      # @option params [Receiver] :control_program the receiver object.
+      # @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 [Integer] :amount amount of the asset to be controlled.
+      # @return [Builder]
+      def control_with_receiver(params)
+        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 specifiying the asset to be controlled.
+      # @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.
@@ -432,17 +471,14 @@ module Chain
 
       # Add a retire action.
       # @param [Hash] params Action parameters
-      # @option params [String] :asset_id Asset ID specifiying the asset to be retired.
+      # @option params [String] :asset_id Asset ID specifying the asset to be retired.
       #                                   You must specify either an ID or an alias.
       # @option params [String] :asset_alias Asset alias specifying the asset to be retired.
       #                                   You must specify either an ID or an alias.
       # @option params [Integer] :amount Amount of the asset to be retired.
       # @return [Builder]
       def retire(params)
-        add_action(params.merge(
-          type: :control_program,
-          control_program: '6a'
-        ))
+        add_action(params.merge(type: :retire))
       end
     end
 

data/lib/chain/transaction_feed.rb

@@ -82,15 +82,20 @@ module Chain
 
     class ClientModule < Chain::ClientModule
 
-      # @param [Hash] opts
-      # @return [TransactionFeed]
+      # @param [Hash] opts Parameters for creating a Transaction Feed.
+      # @option opts [String] alias A unique alias for the transaction feed.
+      # @option opts [String] filter A valid filter string for the `/list-transactions` endpoint. The transaction feed will be composed of future transactions that match the filter.
+      # @return [TransactionFeed] Newly created transaction feed
       def create(opts)
         opts = {client_token: SecureRandom.uuid()}.merge(opts)
         TransactionFeed.new(client.conn.request('create-transaction-feed', opts), client.conn)
       end
 
-      # @param [Hash] opts
-      # @return [TransactionFeed]
+      # Get single transaction feed given an id/alias.
+      # @param [Hash] opts Parameters to get single Transaction Feed.
+      # @option opts [String] id The unique ID of a transaction feed. Either `id` or `alias` is required.
+      # @option opts [String] alias The unique alias of a transaction feed. Either `id` or `alias` is required.
+      # @return [TransactionFeed] Requested transaction feed object
       def get(opts)
         TransactionFeed.new(client.conn.request('get-transaction-feed', opts), client.conn)
       end
@@ -104,6 +109,7 @@ module Chain
         nil
       end
 
+      # List all transaction feeds
       # @return [Query]
       def query
         Query.new(client)

data/lib/chain/unspent_output.rb

@@ -4,6 +4,9 @@ require_relative './query'
 
 module Chain
   class UnspentOutput < ResponseObject
+    # @!attribute [r] id
+    # @return [String]
+    attrib :id
 
     # @!attribute [r] type
     # @return [String]
@@ -70,10 +73,13 @@ module Chain
     attrib :is_local
 
     class ClientModule < Chain::ClientModule
-      # @param [Hash] query
-      # @return Query
-      def query(query = {})
-        Query.new(client, query)
+      # @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).
+      # @option opts [Integer] timestamp A millisecond Unix timestamp. By using this parameter, you can perform queries that reflect the state of the blockchain at different points in time.
+      # @return [Query]
+      def query(opts = {})
+        Query.new(client, opts)
       end
     end
 

data/lib/chain/version.rb

@@ -1,3 +1,3 @@
 module Chain
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chain-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Chain Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,7 @@ files:
 - lib/chain/hsm_signer.rb
 - lib/chain/mock_hsm.rb
 - lib/chain/query.rb
+- lib/chain/receiver.rb
 - lib/chain/response_object.rb
 - lib/chain/transaction.rb
 - lib/chain/transaction_feed.rb
@@ -119,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="