sequence-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93b43395a8383a8c4edd19c99c50de2dada0a75c
+  data.tar.gz: 53afaf9fa088eedd79d9911036ebbbdd2892a4c7
+SHA512:
+  metadata.gz: 74ce7aefe71e28a2553caa702cdcb717274eb0abc0af9220ac8c39c60bffdace868f0fac477a6b0300cd9ad0eab61c6cf5bd870ffa19a9861d6d83ae4412e9ab
+  data.tar.gz: ab8ee3bcd99c650c6f9e58c87882c53df5aeae0f838f3b9ed018655b63d4830c2c2332cec7cbca0921c1059e6ec310cb64a50c15369433c02616b7b436f52efd

data/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2016 Chain, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,41 @@
+# Chain 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.
+
+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'
+```
+
+### 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:
+
+```
+bundle exec rspec
+```
+
+## Documenation
+
+To build documentation as you're working us the `yard` command:
+
+```
+yard server
+```

data/lib/chain/account.rb

@@ -0,0 +1,80 @@
+require_relative './client_module'
+require_relative './errors'
+require_relative './query'
+require_relative './response_object'
+
+module Chain
+  class Account < ResponseObject
+
+    # @!attribute [r] id
+    # Unique account identifier.
+    # @return [String]
+    attrib :id
+
+    # @!attribute [r] alias
+    # User specified, unique 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.
+    # @return [Array<Key>]
+    attrib(:keys) { |raw| raw.map { |k| Key.new(k) } }
+
+    # @!attribute [r] tags
+    # User-specified tag structure for the account.
+    # @return [Hash]
+    attrib :tags
+
+    class Key < ResponseObject
+      attrib :id
+      attrib :alias
+    end
+
+    class ClientModule < Chain::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.
+      # @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.
+      # @option opts [String] id The ID of the account. Either an ID or alias should be provided, but not both.
+      # @option opts [String] alias The alias of the account. Either an ID or alias should be provided, but not both.
+      # @option opts [Hash] tags A new set of tags, which will replace the existing tags.
+      # @return [Hash] a success message.
+      def update_tags(opts)
+        client.conn.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).
+      # @return [Query]
+      def query(opts = {})
+        Query.new(client, opts)
+      end
+    end
+
+    class Query < Chain::Query
+      def fetch(query)
+        client.conn.request('list-accounts', query)
+      end
+
+      def translate(raw)
+        Account.new(raw)
+      end
+    end
+
+  end
+end

data/lib/chain/asset.rb

@@ -0,0 +1,85 @@
+require 'securerandom'
+
+require_relative './client_module'
+require_relative './errors'
+require_relative './query'
+require_relative './response_object'
+
+module Chain
+  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
+    # @return [String]
+    attrib :id
+
+    # @!attribute [r] alias
+    # User specified, unique identifier.
+    # @return [String]
+    attrib :alias
+
+    # @!attribute [r] keys
+    # The set of keys used for signing issuance transactions for this asset.
+    # @return [Array<Key>]
+    attrib(:keys) { |raw| raw.map { |k| Key.new(k) } }
+
+    # @!attribute [r] quorum
+    # @return [Integer]
+    attrib :quorum
+
+    # @!attribute [r] tags
+    # @return [Hash]
+    attrib :tags
+
+    class Key < ResponseObject
+      attrib :id
+      attrib :alias
+    end
+
+    class ClientModule < Chain::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.
+      # @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.
+      # @option opts [String] id The ID of the asset. Either an ID or alias should be provided, but not both.
+      # @option opts [String] alias The alias of the asset. Either an ID or alias should be provided, but not both.
+      # @option opts [Hash] tags A new set of tags, which will replace the existing tags.
+      # @return [Hash] a success message.
+      def update_tags(opts)
+        client.conn.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).
+      # @return [Query]
+      def query(opts = {})
+        Query.new(client, opts)
+      end
+    end
+
+    class Query < Chain::Query
+      def fetch(query)
+        client.conn.request('list-assets', query)
+      end
+
+      def translate(raw)
+        Asset.new(raw)
+      end
+    end
+
+  end
+end

data/lib/chain/balance.rb

@@ -0,0 +1,40 @@
+require_relative './client_module'
+require_relative './response_object'
+require_relative './query'
+
+module Chain
+  class Balance < ResponseObject
+
+    # @!attribute [r] amount
+    # Sum of the unspent outputs.
+    # @return [Integer]
+    attrib :amount
+
+    # @!attribute [r] sum_by
+    # List of parameters on which to sum unspent outputs.
+    # @return [Hash<String => String>]
+    attrib :sum_by
+
+    class ClientModule < Chain::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 [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
+
+    class Query < Chain::Query
+      def fetch(query)
+        client.conn.request('list-balances', query)
+      end
+
+      def translate(raw)
+        Balance.new(raw)
+      end
+    end
+  end
+end

data/lib/chain/batch_response.rb

@@ -0,0 +1,21 @@
+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/client.rb

@@ -0,0 +1,71 @@
+require_relative './account'
+require_relative './asset'
+require_relative './balance'
+require_relative './constants'
+require_relative './dev_utils'
+require_relative './key'
+require_relative './stats'
+require_relative './transaction'
+require_relative './unspent_output'
+
+module Chain
+  class Client
+
+    def initialize(opts = {})
+      if !opts.key?(:url) || opts[:url].empty?
+        raise ArgumentError.new('missing :url parameter')
+      end
+      @opts = opts
+    end
+
+    def opts
+      @opts.dup
+    end
+
+    # @return [Connection]
+    def conn
+      @conn ||= Connection.new(@opts)
+    end
+
+    # @return [Account::ClientModule]
+    def accounts
+      @accounts ||= Account::ClientModule.new(self)
+    end
+
+    # @return [Asset::ClientModule]
+    def assets
+      @assets ||= Asset::ClientModule.new(self)
+    end
+
+    # @return [Balance::ClientModule]
+    def balances
+      @balances ||= Balance::ClientModule.new(self)
+    end
+
+    # @return [Key::ClientModule]
+    def keys
+      @keys ||= Key::ClientModule.new(self)
+    end
+
+    # @return [Transaction::ClientModule]
+    def transactions
+      @transactions ||= Transaction::ClientModule.new(self)
+    end
+
+    # @return [UnspentOutput::ClientModule]
+    def unspent_outputs
+      @unspent_outputs ||= UnspentOutput::ClientModule.new(self)
+    end
+
+    # @return [Stats::ClientModule]
+    def stats
+      @stats ||= Stats::ClientModule.new(self)
+    end
+
+    # @return [DevUtils::ClientModule]
+    def dev_utils
+      @dev_utils ||= DevUtils::ClientModule.new(self)
+    end
+
+  end
+end

data/lib/chain/client_module.rb

@@ -0,0 +1,11 @@
+module Chain
+  class ClientModule
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+  end
+end