sequence-sdk 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28c08904ccde3f52784afaafd26a1b29bd355766
-  data.tar.gz: f2d920c03bcace1947a502e6318a017c01343e88
+  metadata.gz: 94c78d487e125ca4d9436ba7651feeaa4df4e42c
+  data.tar.gz: 4686db08afa33c144752c475e682e133b3e7dad7
 SHA512:
-  metadata.gz: f0d1206153259d71dd09f2650c1c23c707fb4030994f8b1e0cabd30f0eff9c93900f1ff19677c1759e1d611c8c0490638d1c6ed7a1837f8a325ac27d688d0d74
-  data.tar.gz: c7dfa259a099af2aaff4d52ec10203a24ea6bc35cd552210b416c2f2f0a41900371c665982c39c7ea11cee457d702b5aba6f4de5808f85a8a3ffe6c5d611c033
+  metadata.gz: 3b8efcc73ad670aa4df6b2adadc9e6be07043b77e06b0098f918e332dd3df4563e870f31ea561a4bde52e2720d5c3a8904a20cb8db36c30743713dd1caf0c8b6
+  data.tar.gz: 46da2a5e7ab4800d88c47dc98725da383fa56c54eb8b64a08ed232a50fb750b87277904d90d48a9163c88a34a7ba70a2d80d71389ff7df9d35276ac653e5084b

data/lib/sequence.rb

@@ -1,3 +1,2 @@
 require_relative './sequence/client'
-require_relative './sequence/constants'
 require_relative './sequence/version'

data/lib/sequence/account.rb

@@ -4,30 +4,31 @@ require_relative './query'
 require_relative './response_object'
 
 module Sequence
+  # A container for asset balances on a ledger.
   class Account < ResponseObject
 
     # @!attribute [r] id
-    # Unique account identifier.
+    # Unique, auto-generated identifier.
     # @return [String]
     attrib :id
 
     # @!attribute [r] alias
-    # User specified, unique identifier.
+    # Unique, user-specified identifier.
     # @return [String]
     attrib :alias
 
-    # @!attribute [r] quorum
-    # The number of keys required to sign transactions for the account.
-    # @return [Integer]
-    attrib :quorum
-
     # @!attribute [r] keys
-    # The set of keys used for signing issuance transactions for this asset.
+    # The set of keys used for signing transactions that spend from the account.
     # @return [Array<Key>]
     attrib(:keys) { |raw| raw.map { |k| Key.new(k) } }
 
+    # @!attribute [r] quorum
+    # The number of keys required to sign transactions that spend from the account.
+    # @return [Integer]
+    attrib :quorum
+
     # @!attribute [r] tags
-    # User-specified tag structure for the account.
+    # User-specified key-value data describing the account.
     # @return [Hash]
     attrib :tags
 
@@ -37,29 +38,32 @@ module Sequence
     end
 
     class ClientModule < Sequence::ClientModule
-      # @param [Hash] opts Options hash specifiying account creation details.
-      # @option opts [String] alias User specified, unique identifier.
-      # @option opts [Array<Hash>] keys The list of keys used to create control programs under the account. A key is a hash containing either an `id` or `alias` key.
-      # @option opts [Integer] quorum	The number of keys required to sign transactions for the account. Defaults to the size of root_xpubs.
-      # @option opts [Hash] tags User-specified tag structure for the account.
+      # Creates a new account in the ledger.
+      # @param [Hash] opts Options hash
+      # @option opts [String] alias Unique, user-specified identifier.
+      # @option opts [Array<Hash>, Array<Sequence::Key>] keys The set of keys used for signing transactions that spend from the account. A key can be either a key object, or a hash containing either an `id` or `alias` field.
+      # @option opts [Integer] quorum	The number of keys required to sign transactions that spend from the account. Defaults to the number of keys provided.
+      # @option opts [Hash] tags User-specified key-value data describing the account.
       # @return [Account]
       def create(opts)
         opts = {client_token: SecureRandom.uuid}.merge(opts)
         Account.new(client.conn.request('create-account', opts))
       end
 
-      # @param [Hash] opts Options hash specifiying account creation details.
+      # Updates an account's tags.
+      # @param [Hash] opts Options hash
       # @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.
+      # @return [void]
       def update_tags(opts)
         client.conn.request('update-account-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).
+      # Executes a query, returning an enumerable over individual accounts.
+      # @param [Hash] opts Options hash
+      # @option opts [String] filter A filter expression.
+      # @option opts [Array<String|Integer>] filter_params A list of values that will be interpolated into the filter expression.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)

data/lib/sequence/asset.rb

@@ -6,33 +6,31 @@ require_relative './query'
 require_relative './response_object'
 
 module Sequence
+  # A type or class of value that can be tracked on a ledger.
   class Asset < ResponseObject
 
     # @!attribute [r] id
-    # Globally unique identifier of the asset.
-    # Asset version 1 specifies the asset id as the hash of:
-    # - the asset version
-    # - the asset's issuance program
-    # - the core's VM version
-    # - the hash of the network's initial block
+    # Unique, auto-generated identifier.
     # @return [String]
     attrib :id
 
     # @!attribute [r] alias
-    # User specified, unique identifier.
+    # Unique, user-specified identifier.
     # @return [String]
     attrib :alias
 
     # @!attribute [r] keys
-    # The set of keys used for signing issuance transactions for this asset.
+    # The set of keys used to sign transactions that issue the asset.
     # @return [Array<Key>]
     attrib(:keys) { |raw| raw.map { |k| Key.new(k) } }
 
     # @!attribute [r] quorum
+    # The number of keys required to sign transactions that issue the asset.
     # @return [Integer]
     attrib :quorum
 
     # @!attribute [r] tags
+    # User-specified key-value data describing the asset.
     # @return [Hash]
     attrib :tags
 
@@ -42,29 +40,32 @@ module Sequence
     end
 
     class ClientModule < Sequence::ClientModule
-      # @param [Hash] opts Options hash specifiying asset creation details.
-      # @option opts [String] alias User specified, unique identifier.
-      # @option opts [Array<Hash>] keys The list of keys used to create the issuance program for the asset. A key is a hash containing either an `id` or `alias` key.
-      # @option opts [Integer] quorum The number of keys required to issue units of the asset.  Defaults to the size of root_xpubs.
-      # @option opts [Hash] tags User-specified, arbitrary/unstructured data local to the asset's originating core.
+      # Creates a new asset in the ledger.
+      # @param [Hash] opts Options hash
+      # @option opts [String] alias Unique, user-specified identifier.
+      # @option opts [Array<Hash>, Array<Sequence::Key>] keys The set of keys used for signing transactions that issue the asset. A key can be either a key object, or a hash containing either an `id` or `alias` field.
+      # @option opts [Integer] quorum The number of keys required to sign transactions that issue the asset. Defaults to the number of keys provided.
+      # @option opts [Hash] tags User-specified key-value data describing the asset.
       # @return [Asset]
       def create(opts)
         opts = {client_token: SecureRandom.uuid}.merge(opts)
         Asset.new(client.conn.request('create-asset', opts))
       end
 
-      # @param [Hash] opts Options hash specifiying asset creation details.
+      # Updates an asset's tags.
+      # @param [Hash] opts Options hash
       # @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.
+      # @return [void]
       def update_tags(opts)
         client.conn.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).
+      # Executes a query, returning an enumerable over individual assets.
+      # @param [Hash] opts Options hash
+      # @option opts [String] filter A filter expression.
+      # @option opts [Array<String|Integer>] filter_params A list of values that will be interpolated into the filter expression.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)

data/lib/sequence/balance.rb

@@ -2,25 +2,30 @@ require_relative './client_module'
 require_relative './response_object'
 require_relative './query'
 
+
 module Sequence
+  # A summation of contract amounts. Contracts are selected using a filter, and
+  # their values are summed using the common values of one or more contract
+  # fields.
   class Balance < ResponseObject
 
     # @!attribute [r] amount
-    # Sum of the contracts.
+    # Summation of contract amounts.
     # @return [Integer]
     attrib :amount
 
     # @!attribute [r] sum_by
-    # List of parameters on which to sum contracts.
+    # List of parameters along which contract amounts were summed.
     # @return [Hash<String => String>]
     attrib :sum_by
 
     class ClientModule < Sequence::ClientModule
-      # @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 contract 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.
+      # Executes a query, returning an enumerable over individual balances.
+      # @param [Hash] opts Options hash
+      # @option opts [String] filter A filter expression.
+      # @option opts [Array<String|Integer>] filter_params A list of values that will be interpolated into the filter expression.
+      # @option opts [Array<String>] sum_by A list of fields along which contract values will be summed.
+      # @option opts [Integer] timestamp A millisecond Unix timestamp. Indicates that the query should be run over the state of the ledger at a given point in time.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)

data/lib/sequence/client.rb

@@ -1,7 +1,6 @@
 require_relative './account'
 require_relative './asset'
 require_relative './balance'
-require_relative './constants'
 require_relative './contract'
 require_relative './dev_utils'
 require_relative './key'
@@ -11,6 +10,10 @@ require_relative './transaction'
 module Sequence
   class Client
 
+    # @param [Hash] opts Options hash
+    # @option opts [String] url The ledger API URL.
+    # @option opts [String] access_token The ledger access token.
+    # @return [Query]
     def initialize(opts = {})
       if !opts.key?(:url) || opts[:url].empty?
         raise ArgumentError.new('missing :url parameter')

data/lib/sequence/client_module.rb

@@ -1,4 +1,6 @@
 module Sequence
+  # Base class for ledger client components.
+  # @abstract
   class ClientModule
 
     attr_reader :client

data/lib/sequence/contract.rb

@@ -3,56 +3,69 @@ require_relative './response_object'
 require_relative './query'
 
 module Sequence
+  # An entry in the ledger that contains value that can be spent.
   class Contract < ResponseObject
     # @!attribute [r] id
+    # A unique ID.
     # @return [String]
     attrib :id
 
     # @!attribute [r] type
+    # The type of the contract. Currently, this is always "account".
     # @return [String]
     attrib :type
 
     # @!attribute [r] transaction_id
+    # The ID of the transaction in which the contract appears.
     # @return [String]
     attrib :transaction_id
 
     # @!attribute [r] asset_id
+    # The ID of the asset held by the contract.
     # @return [String]
     attrib :asset_id
 
     # @!attribute [r] asset_alias
+    # The alias of the asset held by the contract.
     # @return [String]
     attrib :asset_alias
 
     # @!attribute [r] asset_tags
+    # The tags of the asset held by the contract.
     # @return [Hash]
     attrib :asset_tags
 
     # @!attribute [r] amount
+    # The number of units of the asset held by the contract.
     # @return [Integer]
     attrib :amount
 
     # @!attribute [r] account_id
+    # The ID of the account controlling the contract.
     # @return [String]
     attrib :account_id
 
     # @!attribute [r] account_alias
+    # The alias of the account controlling the contract.
     # @return [String]
     attrib :account_alias
 
     # @!attribute [r] account_tags
+    # The tags of the account controlling the contract.
     # @return [Hash]
     attrib :account_tags
 
     # @!attribute [r] reference_data
+    # User-specified key-value data embedded in the contract.
     # @return [Hash]
     attrib :reference_data
 
     class ClientModule < Sequence::ClientModule
-      # @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.
+      # Executes a query, returning an enumerable over individual contracts.
+      # @param [Hash] opts Options hash
+      # @option opts [String] filter A filter expression.
+      # @option opts [Array<String|Integer>] filter_params A list of values that will be interpolated into the filter expression.
+      # @option opts [Integer] timestamp A millisecond Unix timestamp. Indicates that the query should be run over the state of the ledger at a given point in time.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)

data/lib/sequence/dev_utils.rb

@@ -4,8 +4,9 @@ require_relative './client_module'
 
 module Sequence
   class DevUtils
+    # A namespace for development-only methods.
     class ClientModule < Sequence::ClientModule
-      # Deletes all data in the ledger. (development ledgers only)
+      # Deletes all data in the ledger.
       def reset
         client.conn.request('/reset', client_token: SecureRandom.uuid)
       end

data/lib/sequence/errors.rb

@@ -1,23 +1,23 @@
 module Sequence
 
-  # Base class for all errors raised by the Chain SDK.
+  # Base class for all errors raised by the Sequence SDK.
   class BaseError < StandardError; end
 
   # InvalidRequestIDError arises when an HTTP response is received, but it does
-  # not contain headers that are included in all Chain API responses. This
+  # not contain headers that are included in all Sequence API responses. This
   # could arise due to a badly-configured proxy, or other upstream network
   # issues.
   class InvalidRequestIDError < BaseError
     attr_accessor :response
 
     def initialize(response)
-      super "Response HTTP header field Chain-Request-ID is unset. There may be network issues. Please check your local network settings."
+      super "Response HTTP header field Sequence-Request-ID is unset. There may be network issues. Please check your local network settings."
       self.response = response
     end
   end
 
   # JSONError should be very rare, and will only arise if there is a bug in the
-  # Chain API, or if the upstream server is spoofing common Chain API response
+  # Sequence API, or if the upstream server is spoofing common Sequence API response
   # headers.
   class JSONError < BaseError
     attr_accessor :request_id
@@ -30,7 +30,7 @@ module Sequence
     end
   end
 
-  # APIError describes errors that are codified by the Chain API. They have
+  # APIError describes errors that are codified by the Sequence API. They have
   # an error code, a message, and an optional detail field that provides
   # additional context for the error.
   class APIError < BaseError
@@ -53,7 +53,7 @@ module Sequence
       self.temporary = body['temporary']
 
       self.response = response
-      self.request_id = response['Chain-Request-ID'] if response
+      self.request_id = response['Sequence-Request-ID'] if response
 
       super self.class.format_error_message(code, chain_message, detail, request_id)
     end

data/lib/sequence/key.rb

@@ -4,29 +4,31 @@ require_relative './query'
 require_relative './response_object'
 
 module Sequence
+  # Keys are used to sign transactions.
   class Key < ResponseObject
-    # @!attribute [r] alias
-    # User specified, unique identifier of the key.
-    # @return [String]
-    attrib :alias
-
     # @!attribute [r] id
     # Unique identifier of the key, based on the public key material itself.
     # @return [String]
     attrib :id
 
+    # @!attribute [r] alias
+    # Unique, user-specified identifier of the key.
+    # @return [String]
+    attrib :alias
+
     class ClientModule < Sequence::ClientModule
 
-      # Creates a key object.
-      # @param [Hash] opts Parameters for MockHSM key creation.
-      # @option opts [String] alias User specified, unique identifier.
+      # Creates a key.
+      # @param [Hash] opts Options hash
+      # @option opts [String] alias Unique, user-specified identifier of the key.
       # @return [Key]
       def create(opts = {})
         Key.new(client.conn.request('create-key', opts))
       end
 
-      # @param [Hash] opts Filtering information
-      # @option opts [Array<String>] aliases Optional list of requested aliases, max 200.
+      # Executes a query, returning an enumerable over individual keys.
+      # @param [Hash] opts Options hash
+      # @option opts [Array<String>] aliases A list of aliases of keys to retrieve.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)

data/lib/sequence/stats.rb

@@ -3,24 +3,26 @@ require_relative './response_object'
 require_relative './query'
 
 module Sequence
+  # An object describing summary information about a ledger.
   class Stats < ResponseObject
 
     # @!attribute [r] asset_count
-    # Total number of assets in the ledger.
+    # The number of assets in the ledger.
     # @return [Integer]
     attrib :asset_count
 
     # @!attribute [r] account_count
-    # Total number of accounts in the ledger.
+    # The number of accounts in the ledger.
     # @return [Integer]
     attrib :account_count
 
     # @!attribute [r] tx_count
-    # Total number of transactions in the ledger.
+    # The number of transactions in the ledger.
     # @return [Integer]
     attrib :tx_count
 
     class ClientModule < Sequence::ClientModule
+      # Gets stats from the ledger.
       # @return [Stats]
       def get
         Stats.new(client.conn.request('stats'))

data/lib/sequence/transaction.rb

@@ -5,10 +5,13 @@ require_relative './query'
 require_relative './response_object'
 
 module Sequence
+  # A transaction is an atomic update to the state of the ledger. Transactions
+  # can issue new asset units, transfer of asset units from one account to
+  # another, and/or the retire asset units from an account.
   class Transaction < ResponseObject
 
     # @!attribute [r] id
-    # Unique transaction identifier.
+    # A unique ID.
     # @return [String]
     attrib :id
 
@@ -23,17 +26,17 @@ module Sequence
     attrib :sequence_number
 
     # @!attribute [r] reference_data
-    # User specified, unstructured data embedded within a transaction.
+    # User-specified key-value data embedded into the transaction.
     # @return [Hash]
     attrib :reference_data
 
     # @!attribute [r] actions
-    # List of a transaction's actions.
+    # List of actions taken by the transaction.
     # @return [Array<Action>]
     attrib(:actions) { |raw| raw.map { |v| Action.new(v) } }
 
     # @!attribute [r] contracts
-    # List of a transaction's contracts.
+    # List of contracts created by the transaction.
     # @return [Array<Contract>]
     attrib(:contracts) { |raw| raw.map { |v| Contract.new(v) } }
 
@@ -58,13 +61,12 @@ module Sequence
         ))
       end
 
-      # 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).
+      # Executes a query, returning an enumerable over individual transactions.
+      # @param [Hash] opts Options hash
+      # @option opts [String] filter A filter expression.
+      # @option opts [Array<String|Integer>] filter_params A list of values that will be interpolated into the filter expression.
+      # @option opts [Integer] start_time A Unix timestamp in milliseconds of the earliest transaction timestamp to include in the query results.
+      # @option opts [Integer] end_time A Unix timestamp in milliseconds of the most recent transaction timestamp to include in the query results.
       # @return [Query]
       def query(opts = {})
         Query.new(client, opts)
@@ -81,11 +83,10 @@ module Sequence
       end
     end
 
+    # An action taken by a transaction.
     class Action < ResponseObject
       # @!attribute [r] type
-      # The type of the action.
-      #
-      # Possible values are "issue", "transfer" and "retire".
+      # The type of the action. Possible values are "issue", "transfer" and "retire".
       # @return [String]
       attrib :type
 
@@ -95,61 +96,57 @@ module Sequence
       attrib :asset_id
 
       # @!attribute [r] asset_alias
-      # The alias of the action's asset (possibly null).
+      # The alias of the action's asset.
       # @return [String]
       attrib :asset_alias
 
       # @!attribute [r] asset_tags
-      # The tags of the action's asset (possibly null).
+      # The tags of the action's asset.
       # @return [Hash]
       attrib :asset_tags
 
       # @!attribute [r] amount
-      # The number of units of the action's asset.
+      # The number of asset units issues, transferred, or retired.
       # @return [Integer]
       attrib :amount
 
       # @!attribute [r] source_account_id
-      # The id of the account transferring the asset (possibly null if the
-      # action is an issuance).
+      # The ID of the account serving as the source of asset units. Null for issuances.
       # @return [String]
       attrib :source_account_id
 
       # @!attribute [r] source_account_alias
-      # The alias of the account transferring the asset (possibly null if the
-      # action is an issuance).
+      # The alias of the account serving as the source of asset units. Null for issuances.
       # @return [String]
       attrib :source_account_alias
 
       # @!attribute [r] source_account_tags
-      # The tags associated with the source account (possibly null).
+      # The tags of the account serving as the source of asset units. Null for issuances.
       # @return [String]
       attrib :source_account_tags
 
       # @!attribute [r] destination_account_id
-      # The id of the account receiving the asset (possibly null if the
-      # action is a retirement).
+      # The ID of the account receiving the asset units. Null for retirements.
       # @return [String]
       attrib :destination_account_id
 
       # @!attribute [r] destination_account_alias
-      # The alias of the account receiving the asset (possibly null if the
-      # action is an retirement).
+      # The alias of the account receiving the asset units. Null for retirements.
       # @return [String]
       attrib :destination_account_alias
 
       # @!attribute [r] destination_account_tags
-      # The tags associated with the destination account (possibly null).
+      # The tags of the account receiving the asset units. Null for retirements.
       # @return [String]
       attrib :destination_account_tags
 
       # @!attribute [r] reference_data
-      # User specified, unstructured data embedded within an action
-      # (possibly null).
+      # User-specified, key-value data embedded into the action.
       # @return [Hash]
       attrib :reference_data
     end
 
+    # A configuration object for creating and submitting transactions.
     class Builder
       attr_accessor :reference_data
 
@@ -157,12 +154,10 @@ module Sequence
         block.call(self) if block
       end
 
-      # @return [Array<Hash>]
       def actions
         @actions ||= []
       end
 
-      # @return [Hash]
       def to_h
         {
           actions: actions,
@@ -170,14 +165,12 @@ module Sequence
         }
       end
 
-      # @return [String]
       def to_json(opts = nil)
         to_h.to_json(opts)
       end
 
-      # Add an action to the transaction builder
-      # @param [Hash] params Action parameters containing a type field and the
-      #               required parameters for that type
+      # Adds an action to a transaction builder.
+      # @param [Hash] params Action parameters.
       # @return [Builder]
       def add_action(params)
         # Some actions require an idempotency token, so we'll add it here as a
@@ -187,66 +180,68 @@ module Sequence
         self
       end
 
-      # Issue new units of an asset into an account.
-      # @param [Hash] params Action parameters
-      # @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.
-      # @option params [Integer] :amount amount of the asset to be issued
-      # @option params [String] :destination_account_id ID of account receiving the newly-issued asset units.
+      # Issues new units of an asset to a destination account.
+      #
+      # @param [Hash] params Options hash
+      # @option params [String] :asset_id ID of the asset to be issued.
       #                                   You must specify either an ID or an alias.
-      # @option params [String] :destination_account_alias Alias of account receiving the newly-issued asset units.
+      # @option params [String] :asset_alias Asset alias of the asset to be issued.
       #                                   You must specify either an ID or an alias.
-      # @option params [Hash] :reference_data Reference data to add to the receiving contract.
+      # @option params [Integer] :amount amount of the asset to be issued.
+      # @option params [String] :destination_account_id ID of the account receiving the asset units.
+      #                                   You must specify a destination account ID or alias.
+      # @option params [String] :destination_account_alias alias of the account receiving the asset units.
+      #                                   You must specify a destination account ID or alias.
+      # @option params [Hash] :reference_data reference data for the action.
       # @return [Builder]
       def issue(params)
         add_action(params.merge(type: :issue))
       end
 
-      # Takes units of an asset from a source (an account or contract) and retires them.
-      # @param [Hash] params Action parameters
-      # @option params [String] :source_account_id Account ID specifying the account controlling the asset.
+      # Moves units of an asset from a source (an account or contract) to a destination account.
+      #
+      # @param [Hash] params Options hash
+      # @option params [String] :source_account_id ID of the account serving as the source of asset units.
       #                                   You must specify a source account ID, account alias, or contract ID.
-      # @option params [String] :source_account_alias Account alias specifying the account controlling the asset.
+      # @option params [String] :source_account_alias Alias of the account serving as the source of asset units
       #                                   You must specify a source account ID, account alias, or contract ID.
-      # @option params [String] :source_contract_id Contract holding the asset.
+      # @option params [String] :source_contract_id ID of the contract serving as the source of asset units.
       #                                   You must specify a source account ID, account alias, or contract ID.
-      # @option params [String] :asset_id Asset ID specifying the asset to be retired.
+      # @option params [String] :asset_id ID of the asset to be transferred.
       #                                   You must specify either an ID or an alias.
-      # @option params [String] :asset_alias Asset alias specifying the asset to be retired.
+      # @option params [String] :asset_alias Asset alias of the asset to be transferred.
       #                                   You must specify either an ID or an alias.
-      # @option params [Integer] :amount Amount of the asset to be retired.
-      # @option params [Hash] :reference_data Reference data to add to the receiving contract.
-      # @option params [Hash] :change_reference_data Reference data to add to the change contract, if it is necessary.
+      # @option params [Integer] :amount amount of the asset to be transferred.
+      # @option params [String] :destination_account_id ID of the account receiving the asset units.
+      #                                   You must specify a destination account ID or alias.
+      # @option params [String] :destination_account_alias alias of the account receiving the asset units.
+      #                                   You must specify a destination account ID or alias.
+      # @option params [Hash] :reference_data reference data for the action.
+      # @option params [Hash] :change_reference_data reference data for the change contract.
       # @return [Builder]
-      def retire(params)
-        add_action(params.merge(type: :retire))
+      def transfer(params)
+        add_action(params.merge(type: :transfer))
       end
 
-      # Moves units of an asset from a source (an account or contract) to a destination account.
+      # Takes units of an asset from a source (an account or contract) and retires them.
       #
-      # @param [Hash] params Action parameters
-      # @option params [String] :source_account_id Account ID specifying the account controlling the asset.
+      # @param [Hash] params Options hash
+      # @option params [String] :source_account_id ID of the account serving as the source of asset units.
       #                                   You must specify a source account ID, account alias, or contract ID.
-      # @option params [String] :source_account_alias Account alias specifying the account controlling the asset.
+      # @option params [String] :source_account_alias Alias of the account serving as the source of asset units
       #                                   You must specify a source account ID, account alias, or contract ID.
-      # @option params [String] :source_contract_id Contract holding the asset.
+      # @option params [String] :source_contract_id ID of the contract serving as the source of asset units.
       #                                   You must specify a source account ID, account alias, or contract ID.
-      # @option params [String] :asset_id Asset ID specifying the asset to be transferred.
+      # @option params [String] :asset_id ID of 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 transferred.
+      # @option params [String] :asset_alias Asset alias of the asset to be retired.
       #                                   You must specify either an ID or an alias.
-      # @option params [Integer] :amount Amount of the asset to be transferred.
-      # @option params [String] :destination_account_id Account ID specifying the account controlling the asset.
-      #                                   You must specify a destination account ID or alias.
-      # @option params [String] :destination_account_alias Account alias specifying the account controlling the asset.
-      #                                   You must specify a destination account ID or alias.
-      # @option params [Hash] :reference_data Reference data to add to the receiving contract.
-      # @option params [Hash] :change_reference_data Reference data to add to the change contract, if it is necessary.
+      # @option params [Integer] :amount amount of the asset to be retired.
+      # @option params [Hash] :reference_data reference data for the action.
+      # @option params [Hash] :change_reference_data reference data for the change contract.
       # @return [Builder]
-      def transfer(params)
-        add_action(params.merge(type: :transfer))
+      def retire(params)
+        add_action(params.merge(type: :retire))
       end
     end
   end

data/lib/sequence/version.rb

@@ -1,3 +1,3 @@
 module Sequence
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,137 +1,137 @@
 --- !ruby/object:Gem::Specification
 name: sequence-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Chain Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.5.0
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.5.0
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.5
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.5
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.5
 description: SDK for Sequence
@@ -140,16 +140,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
 - README.md
-- lib/sequence.rb
+- LICENSE
 - lib/sequence/account.rb
 - lib/sequence/asset.rb
 - lib/sequence/balance.rb
 - lib/sequence/client.rb
 - lib/sequence/client_module.rb
 - lib/sequence/connection.rb
-- lib/sequence/constants.rb
 - lib/sequence/contract.rb
 - lib/sequence/dev_utils.rb
 - lib/sequence/errors.rb
@@ -160,6 +158,7 @@ files:
 - lib/sequence/stats.rb
 - lib/sequence/transaction.rb
 - lib/sequence/version.rb
+- lib/sequence.rb
 homepage: https://dashboard.sequenceledger.com
 licenses:
 - Apache-2.0
@@ -170,17 +169,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ~>
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: SDK for Sequence

data/lib/sequence/constants.rb

@@ -1,3 +0,0 @@
-module Sequence
-  MAX_BLOCK_HEIGHT = (2 ** 63) - 1
-end