sequence-sdk 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93b43395a8383a8c4edd19c99c50de2dada0a75c
-  data.tar.gz: 53afaf9fa088eedd79d9911036ebbbdd2892a4c7
+  metadata.gz: abe132b7e4e1918feefd27530475e9c4632927bb
+  data.tar.gz: 45212dce65e2fa5cec782900b024d4ae671b5e97
 SHA512:
-  metadata.gz: 74ce7aefe71e28a2553caa702cdcb717274eb0abc0af9220ac8c39c60bffdace868f0fac477a6b0300cd9ad0eab61c6cf5bd870ffa19a9861d6d83ae4412e9ab
-  data.tar.gz: ab8ee3bcd99c650c6f9e58c87882c53df5aeae0f838f3b9ed018655b63d4830c2c2332cec7cbca0921c1059e6ec310cb64a50c15369433c02616b7b436f52efd
+  metadata.gz: 5a0212cc63fbfaa9483ce87dfa9f7f3d24884f25d3aeacc81ae08bde699bd40eec0f5b14f1e21939128eabecf0a5740c8d3419587aa5f781c1433a07e9197a34
+  data.tar.gz: 8de4aa0cb76b510678044afb5dcc7b7a2477f1c2fb078eed32e34c15a9a9dc5c5a54148ab3e7848229d84a3841c314e83cb9b06565405e9a495689313b5f4d70

data/LICENSE

@@ -176,7 +176,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2016 Chain, Inc.
+   Copyright 2017 Chain, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,41 +1,30 @@
-# Chain Ruby SDK
+# Sequence Ruby SDK
 
 ## Usage
 
 ### 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.
+The Ruby SDK is available [via Rubygems](https://rubygems.org/gems/sequence-sdk).
 
 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.
 
 For most applications, you can simply add the following to your `Gemfile`:
 
 ```
-gem 'chain-sdk', '~> 1.2.0', require: 'chain'
+gem 'sequence-sdk', '~> 1.0.0'
 ```
 
 ### In your code
 
 ```
-chain = Chain::Client.new
-```
-
-## Testing
-
-To run integration tests, run ledgerd listening on ports 1998 and 1999, and then provision the
-subdomain `test`. The `ledgerd provision` command will output an access token: export this to the
-`ACCESS_TOKEN` environment variable.
-
-The explorer will be up at https://test.chain.localhost:1999. Run:
+require 'sequence'
 
+ledger = Sequence::Client.new(
+  url: 'https://example-ledger.sequenceledger.com',
+  access_token: '...'
+)
 ```
-bundle exec rspec
-```
-
-## Documenation
 
-To build documentation as you're working us the `yard` command:
+### Documentation
 
-```
-yard server
-```
+Comprehensive instructions and examples are available in the [developer documentation](https://dashboard.sequenceledger.com/docs).

data/lib/sequence.rb

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

data/lib/{chain → sequence}/account.rb

@@ -3,7 +3,7 @@ require_relative './errors'
 require_relative './query'
 require_relative './response_object'
 
-module Chain
+module Sequence
   class Account < ResponseObject
 
     # @!attribute [r] id
@@ -36,7 +36,7 @@ module Chain
       attrib :alias
     end
 
-    class ClientModule < Chain::ClientModule
+    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.
@@ -66,7 +66,7 @@ module Chain
       end
     end
 
-    class Query < Chain::Query
+    class Query < Sequence::Query
       def fetch(query)
         client.conn.request('list-accounts', query)
       end

data/lib/{chain → sequence}/asset.rb

@@ -5,7 +5,7 @@ require_relative './errors'
 require_relative './query'
 require_relative './response_object'
 
-module Chain
+module Sequence
   class Asset < ResponseObject
 
     # @!attribute [r] id
@@ -41,7 +41,7 @@ module Chain
       attrib :alias
     end
 
-    class ClientModule < Chain::ClientModule
+    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.
@@ -71,7 +71,7 @@ module Chain
       end
     end
 
-    class Query < Chain::Query
+    class Query < Sequence::Query
       def fetch(query)
         client.conn.request('list-assets', query)
       end

data/lib/{chain → sequence}/balance.rb

@@ -2,24 +2,24 @@ require_relative './client_module'
 require_relative './response_object'
 require_relative './query'
 
-module Chain
+module Sequence
   class Balance < ResponseObject
 
     # @!attribute [r] amount
-    # Sum of the unspent outputs.
+    # Sum of the contracts.
     # @return [Integer]
     attrib :amount
 
     # @!attribute [r] sum_by
-    # List of parameters on which to sum unspent outputs.
+    # List of parameters on which to sum contracts.
     # @return [Hash<String => String>]
     attrib :sum_by
 
-    class ClientModule < Chain::ClientModule
+    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 unspent output attributes to sum by.
+      # @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.
       # @return [Query]
       def query(opts = {})
@@ -27,7 +27,7 @@ module Chain
       end
     end
 
-    class Query < Chain::Query
+    class Query < Sequence::Query
       def fetch(query)
         client.conn.request('list-balances', query)
       end

data/lib/{chain → sequence}/client.rb

@@ -2,13 +2,13 @@ require_relative './account'
 require_relative './asset'
 require_relative './balance'
 require_relative './constants'
+require_relative './contract'
 require_relative './dev_utils'
 require_relative './key'
 require_relative './stats'
 require_relative './transaction'
-require_relative './unspent_output'
 
-module Chain
+module Sequence
   class Client
 
     def initialize(opts = {})
@@ -52,9 +52,9 @@ module Chain
       @transactions ||= Transaction::ClientModule.new(self)
     end
 
-    # @return [UnspentOutput::ClientModule]
-    def unspent_outputs
-      @unspent_outputs ||= UnspentOutput::ClientModule.new(self)
+    # @return [Contract::ClientModule]
+    def contracts
+      @contracts ||= Contract::ClientModule.new(self)
     end
 
     # @return [Stats::ClientModule]

data/lib/{chain → sequence}/client_module.rb

@@ -1,4 +1,4 @@
-module Chain
+module Sequence
   class ClientModule
 
     attr_reader :client

data/lib/{chain → sequence}/connection.rb

@@ -4,11 +4,10 @@ require 'net/https'
 require 'openssl'
 require 'thread'
 
-require_relative './batch_response'
 require_relative './errors'
 require_relative './version'
 
-module Chain
+module Sequence
   class Connection
 
     # Parameters to the retry exponential backoff function.
@@ -45,47 +44,6 @@ module Chain
       _request_with_retries(path, body)[:body]
     end
 
-    def batch_request(path, body = {}, &translate)
-      res = _request_with_retries(path, body)
-      body = res[:body]
-      response = res[:response]
-
-      successes = {}
-      errors = {}
-
-      body.each_with_index do |item, i|
-        if !!item['code']
-          errors[i] = APIError.new(item, response)
-        else
-          if translate
-            successes[i] = translate.call(item)
-          else
-            successes[i] = item
-          end
-        end
-      end
-
-      BatchResponse.new(
-        successes: successes,
-        errors: errors,
-        response: response,
-      )
-    end
-
-    def singleton_batch_request(path, body = {}, &translate)
-      batch = batch_request(path, body, &translate)
-
-      if batch.size != 1
-        raise "Invalid response, expected a single response object but got #{batch.items.size}"
-      end
-
-      raise batch.errors.values.first if batch.errors.size == 1
-
-      batch.successes.values.first
-    end
-
-    private
-
     def _request_with_retries(path, body)
       attempts = 0
 
@@ -121,7 +79,7 @@ module Chain
         req = Net::HTTP::Post.new(full_path)
         req['Accept'] = 'application/json'
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = 'chain-sdk-ruby/' + Chain::VERSION
+        req['User-Agent'] = 'chain-sdk-ruby/' + Sequence::VERSION
         req.body = JSON.dump(body)
 
         if @access_token

data/lib/{chain → sequence}/constants.rb

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

data/lib/{chain/unspent_output.rb → sequence/contract.rb}

@@ -2,8 +2,8 @@ require_relative './client_module'
 require_relative './response_object'
 require_relative './query'
 
-module Chain
-  class UnspentOutput < ResponseObject
+module Sequence
+  class Contract < ResponseObject
     # @!attribute [r] id
     # @return [String]
     attrib :id
@@ -48,7 +48,7 @@ module Chain
     # @return [Hash]
     attrib :reference_data
 
-    class ClientModule < Chain::ClientModule
+    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).
@@ -59,13 +59,13 @@ module Chain
       end
     end
 
-    class Query < Chain::Query
+    class Query < Sequence::Query
       def fetch(query)
-        client.conn.request('list-unspent-outputs', query)
+        client.conn.request('list-contracts', query)
       end
 
       def translate(raw)
-        UnspentOutput.new(raw)
+        Contract.new(raw)
       end
     end
   end

data/lib/{chain → sequence}/dev_utils.rb

@@ -2,9 +2,9 @@ require 'securerandom'
 
 require_relative './client_module'
 
-module Chain
+module Sequence
   class DevUtils
-    class ClientModule < Chain::ClientModule
+    class ClientModule < Sequence::ClientModule
       # Deletes all data in the ledger. (development ledgers only)
       def reset
         client.conn.request('/reset', client_token: SecureRandom.uuid)

data/lib/{chain → sequence}/errors.rb

@@ -1,4 +1,4 @@
-module Chain
+module Sequence
 
   # Base class for all errors raised by the Chain SDK.
   class BaseError < StandardError; end

data/lib/{chain → sequence}/key.rb

@@ -3,7 +3,7 @@ require_relative './connection'
 require_relative './query'
 require_relative './response_object'
 
-module Chain
+module Sequence
   class Key < ResponseObject
     # @!attribute [r] alias
     # User specified, unique identifier of the key.
@@ -15,7 +15,7 @@ module Chain
     # @return [String]
     attrib :id
 
-    class ClientModule < Chain::ClientModule
+    class ClientModule < Sequence::ClientModule
 
       # Creates a key object.
       # @param [Hash] opts Parameters for MockHSM key creation.
@@ -33,7 +33,7 @@ module Chain
       end
     end
 
-    class Query < Chain::Query
+    class Query < Sequence::Query
       def fetch(query)
         client.conn.request('list-keys', query)
       end

data/lib/{chain → sequence}/page.rb

@@ -1,6 +1,6 @@
 require_relative './response_object'
 
-module Chain
+module Sequence
   class Page < ResponseObject
     # @!attribute [r] items
     # List of items.

data/lib/{chain → sequence}/query.rb

@@ -1,6 +1,6 @@
 require_relative './page'
 
-module Chain
+module Sequence
   class Query
     include ::Enumerable
 

data/lib/{chain → sequence}/response_object.rb

@@ -1,7 +1,7 @@
 require 'json'
 require 'time'
 
-module Chain
+module Sequence
   class ResponseObject
     def initialize(raw_attribs)
       raw_attribs.each do |k, v|

data/lib/{chain → sequence}/stats.rb

@@ -2,7 +2,7 @@ require_relative './client_module'
 require_relative './response_object'
 require_relative './query'
 
-module Chain
+module Sequence
   class Stats < ResponseObject
 
     # @!attribute [r] asset_count
@@ -20,7 +20,7 @@ module Chain
     # @return [Integer]
     attrib :tx_count
 
-    class ClientModule < Chain::ClientModule
+    class ClientModule < Sequence::ClientModule
       # @return [Stats]
       def get
         Stats.new(client.conn.request('stats'))

data/lib/{chain → sequence}/transaction.rb

@@ -4,7 +4,7 @@ require_relative './client_module'
 require_relative './query'
 require_relative './response_object'
 
-module Chain
+module Sequence
   class Transaction < ResponseObject
 
     # @!attribute [r] id
@@ -17,6 +17,11 @@ module Chain
     # @return [Time]
     attrib :timestamp, rfc3339_time: true
 
+    # @!attribute [r] sequence_number
+    # Sequence number of the transaction.
+    # @return [Integer]
+    attrib :sequence_number
+
     # @!attribute [r] reference_data
     # User specified, unstructured data embedded within a transaction.
     # @return [Hash]
@@ -24,10 +29,15 @@ module Chain
 
     # @!attribute [r] actions
     # List of a transaction's actions.
-    # @return [Array<Input>]
+    # @return [Array<Action>]
     attrib(:actions) { |raw| raw.map { |v| Action.new(v) } }
 
-    class ClientModule < Chain::ClientModule
+    # @!attribute [r] contracts
+    # List of a transaction's contracts.
+    # @return [Array<Contract>]
+    attrib(:contracts) { |raw| raw.map { |v| Contract.new(v) } }
+
+    class ClientModule < Sequence::ClientModule
       # Builds, signs, and submits a transaction.
       # @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.
@@ -61,7 +71,7 @@ module Chain
       end
     end
 
-    class Query < Chain::Query
+    class Query < Sequence::Query
       def fetch(query)
         client.conn.request('list-transactions', query)
       end
@@ -201,41 +211,41 @@ module Chain
       #                                   You must specify either an ID or an alias.
       # @option params [String] :destination_account_alias Alias of account receiving the newly-issued asset units.
       #                                   You must specify either an ID or an alias.
-      # @option params [Hash] :destination_reference_data Reference data to add to the receiving output.
+      # @option params [Hash] :reference_data Reference data to add to the receiving contract.
       # @return [Builder]
       def issue(params)
         add_action(params.merge(type: :issue))
       end
 
-      # Takes units of an asset from a source (an account or output) and retires them.
+      # 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.
-      #                                   You must specify a source account ID, account alias, or output ID.
+      #                                   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.
-      #                                   You must specify a source account ID, account alias, or output ID.
-      # @option params [String] :source_output_id Output controlling the asset.
-      #                                   You must specify a source account ID, account alias, or output ID.
+      #                                   You must specify a source account ID, account alias, or contract ID.
+      # @option params [String] :source_contract_id Contract holding the asset.
+      #                                   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.
       #                                   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.
-      # @option params [Hash] :destination_reference_data Reference data to add to the receiving output.
-      # @option params [Hash] :change_reference_data Reference data to add to the change output, if it is necessary.
+      # @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.
       # @return [Builder]
       def retire(params)
         add_action(params.merge(type: :retire))
       end
 
-      # Moves units of an asset from a source (an account or output) to a destination account.
+      # Moves units of an asset from a source (an account or contract) to a destination account.
       #
       # @param [Hash] params Action parameters
       # @option params [String] :source_account_id Account ID specifying the account controlling the asset.
-      #                                   You must specify a source account ID, account alias, or output ID.
+      #                                   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.
-      #                                   You must specify a source account ID, account alias, or output ID.
-      # @option params [String] :source_output_id Output controlling the asset.
-      #                                   You must specify a source account ID, account alias, or output ID.
+      #                                   You must specify a source account ID, account alias, or contract ID.
+      # @option params [String] :source_contract_id Contract holding the asset.
+      #                                   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.
       #                                   You must specify either an ID or an alias.
       # @option params [String] :asset_alias Asset alias specifying the asset to be transferred.
@@ -245,8 +255,8 @@ module Chain
       #                                   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] :destination_reference_data Reference data to add to the receiving output.
-      # @option params [Hash] :change_reference_data Reference data to add to the change output, if it is necessary.
+      # @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.
       # @return [Builder]
       def transfer(params)
         add_action(params.merge(type: :transfer))

data/lib/sequence/version.rb

@@ -0,0 +1,3 @@
+module Sequence
+  VERSION = '1.0.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequence-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Chain Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,20 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: parallel_tests
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -156,26 +142,25 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/chain.rb
-- lib/chain/account.rb
-- lib/chain/asset.rb
-- lib/chain/balance.rb
-- lib/chain/batch_response.rb
-- lib/chain/client.rb
-- lib/chain/client_module.rb
-- lib/chain/connection.rb
-- lib/chain/constants.rb
-- lib/chain/dev_utils.rb
-- lib/chain/errors.rb
-- lib/chain/key.rb
-- lib/chain/page.rb
-- lib/chain/query.rb
-- lib/chain/response_object.rb
-- lib/chain/stats.rb
-- lib/chain/transaction.rb
-- lib/chain/unspent_output.rb
-- lib/chain/version.rb
-homepage: https://sequence.chain.com
+- lib/sequence.rb
+- 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
+- lib/sequence/key.rb
+- lib/sequence/page.rb
+- lib/sequence/query.rb
+- lib/sequence/response_object.rb
+- lib/sequence/stats.rb
+- lib/sequence/transaction.rb
+- lib/sequence/version.rb
+homepage: https://dashboard.sequenceledger.com
 licenses:
 - Apache-2.0
 metadata: {}

data/lib/chain.rb

@@ -1,3 +0,0 @@
-require_relative './chain/client'
-require_relative './chain/constants'
-require_relative './chain/version'

data/lib/chain/batch_response.rb

@@ -1,21 +0,0 @@
-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
-
-module Chain
-  class BatchResponse
-    def initialize(successes: {}, errors: {}, response: nil)
-      @successes = ensure_key_sorting(successes)
-      @errors = ensure_key_sorting(errors)
-      @response = response
-    end
-
-    def size
-      successes.size + errors.size
-    end
-
-    attr_reader :successes, :errors, :response
-  end
-end

data/lib/chain/version.rb

@@ -1,3 +0,0 @@
-module Chain
-  VERSION = '0.0.1'
-end