chain-sdk 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0aa5bb32b142eae9a8ccad181ddfa907e75215b
+  data.tar.gz: dd2f336ad6c531de0cee5bf0ceb525b4b4c3f750
+SHA512:
+  metadata.gz: 7a888f2ff7604a2edb0d5ec4713e07e6086a774cad048e529073be20630e0339450b73d3fb238cea744b8cd3c2540282cc8d10e4851880c05668009de3108527
+  data.tar.gz: 7f8c2c45ae8ed6fc39914df1c34f803ab128eea95b36d1c4008497aa8eb43341171a3d28e07d5cc120424248291402a81e523c92850e569fb2e2180caa06620c

data/README.md

@@ -0,0 +1,33 @@
+# Chain Ruby SDK
+
+## Usage
+
+### Installing the library
+
+#### Via Rubygems
+
+TBA
+
+#### Via downloaded .gem
+
+Install the gem into your gem library:
+
+```
+gem install --local chain-sdk-<VERSION>.gem
+```
+
+### In your code
+
+```
+require 'chain'
+
+chain = Chain::Client.new
+```
+
+## Testing
+
+To run integration tests, run a configured, empty Chain Core on http://localhost:1999. Then run:
+
+```
+bundle exec rspec
+```

data/lib/chain/access_token.rb

@@ -0,0 +1,66 @@
+require_relative './client_module'
+require_relative './query'
+require_relative './response_object'
+
+module Chain
+  class AccessToken < ResponseObject
+
+    # @!attribute [r] id
+    # User specified, unique identifier.
+    # @return [String]
+    attrib :id
+
+    # @!attribute [r] token
+    # Only returned in the response from {ClientModule.create}.
+    # @return [String]
+    attrib :token
+
+    # @!attribute [r] type
+    # Either 'client' or 'network'.
+    # @return [String]
+    attrib :type
+
+    # @!attribute [r] created_at
+    # Timestamp of token creation.
+    # @return [Time]
+    attrib(:created_at) { |raw| Time.parse(raw) }
+
+    class ClientModule < Chain::ClientModule
+
+      # @return [AccessToken]
+      def create(type:, id:)
+        AccessToken.new(client.conn.request(
+          'create-access-token',
+          {type: type, id: id}
+        ))
+      end
+
+      # @param [Hash] opts
+      # @return [Query]
+      def query(opts = {})
+        Query.new(client, opts)
+      end
+
+      # Delete the access token specified.
+      # @param [String] id access token ID
+      # @raise [APIError]
+      # @return [void]
+      def delete(id)
+        client.conn.request('delete-access-token', {id: id})
+        return
+      end
+
+      class Query < Chain::Query
+        def fetch(query)
+          client.conn.request('list-access-tokens', query)
+        end
+
+        def translate(raw)
+          AccessToken.new(raw)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/chain/account.rb

@@ -0,0 +1,101 @@
+require_relative './client_module'
+require_relative './control_program'
+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] keys
+    # The list of keys used to create control programs under the account.
+    # Signatures from these keys are required for spending funds held in the account.
+    # @return [Array<Key>]
+    attrib(:keys) { |raw| raw.map { |v| Key.new(v) } }
+
+    # @!attribute [r] quorum
+    # The number of keys required to sign transactions for the account.
+    # @return [Integer]
+    attrib :quorum
+
+    # @!attribute [r] tags
+    # User-specified tag structure for the account.
+    # @return [Hash]
+    attrib :tags
+
+    class ClientModule < Chain::ClientModule
+      # @param [Hash] opts
+      # @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>]
+      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
+
+      # @param [Hash] opts
+      # @return [ControlProgram]
+      def create_control_program(opts = {})
+        # We don't use keyword params here because 'alias' is a Ruby reserverd
+        # word.
+        params = {}
+        params[:account_alias] = opts[:alias] if opts.key?(:alias)
+        params[:account_id] = opts[:id] if opts.key?(:id)
+
+        client.conn.singleton_batch_request(
+          'create-control-program',
+          [{type: :account, params: params}]
+        ) { |item| ControlProgram.new(item) }
+      end
+
+      # @param [Hash] query
+      # @return [Query]
+      def query(query = {})
+        Query.new(client, query)
+      end
+    end
+
+    class Query < Chain::Query
+      def fetch(query)
+        client.conn.request('list-accounts', query)
+      end
+
+      def translate(raw)
+        Account.new(raw)
+      end
+    end
+
+    class Key < ResponseObject
+      # @!attribute [r] root_xpub
+      # Hex-encoded representation of the root extended public key.
+      # @return [String]
+      attrib :root_xpub
+
+      # @!attribute [r] account_xpub
+      # The extended public key used to create control programs for the account.
+      # @return [String]
+      attrib :account_xpub
+
+      # @!attribute [r] account_derivation_path
+      # The derivation path of the extended key.
+      # @return [String]
+      attrib :account_derivation_path
+    end
+
+  end
+end

data/lib/chain/asset.rb

@@ -0,0 +1,103 @@
+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] issuance_program
+    # @return [String]
+    attrib :issuance_program
+
+    # @!attribute [r] keys
+    # @return [Array<Key>]
+    attrib(:keys) { |raw| raw.map { |v| Key.new(v) } }
+
+    # @!attribute [r] quorum
+    # @return [Integer]
+    attrib :quorum
+
+    # @!attribute [r] definition
+    # User-specified, arbitrary/unstructured data visible across
+    # blockchain networks. Version 1 assets specify the definition in their
+    # issuance programs, rendering the definition immutable.
+    # @return [Hash]
+    attrib :definition
+
+    # @!attribute [r] tags
+    # @return [Hash]
+    attrib :tags
+
+    # @!attribute [r] is_local
+    # @return [Boolean]
+    attrib :is_local
+
+    class ClientModule < Chain::ClientModule
+      # @param [Hash] opts
+      # @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>]
+      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
+      # @return [Query]
+      def query(query = {})
+        Query.new(client, query)
+      end
+    end
+
+    class Query < Chain::Query
+      def fetch(query)
+        client.conn.request('list-assets', query)
+      end
+
+      def translate(raw)
+        Asset.new(raw)
+      end
+    end
+
+    class Key < ResponseObject
+      # @!attribute [r] root_xpub
+      # Hex-encoded representation of the root extended public key.
+      # @return [String]
+      attrib :root_xpub
+
+      # @!attribute [r] asset_pubkey
+      # The derived public key, used in the asset's issuance program.
+      # @return [String]
+      attrib :asset_pubkey
+
+      # @!attribute [r] asset_derivation_path
+      # The derivation path of the extended key.
+      # @return [String]
+      attrib :asset_derivation_path
+    end
+
+  end
+end

data/lib/chain/balance.rb

@@ -0,0 +1,36 @@
+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] query
+      # @return [Query]
+      def query(query = {})
+        Query.new(client, query)
+      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,75 @@
+require_relative './access_token'
+require_relative './account'
+require_relative './asset'
+require_relative './balance'
+require_relative './config'
+require_relative './constants'
+require_relative './hsm_signer'
+require_relative './mock_hsm'
+require_relative './transaction'
+require_relative './transaction_feed'
+require_relative './unspent_output'
+
+module Chain
+  class Client
+
+    def initialize(opts = {})
+      @opts = {url: DEFAULT_API_HOST}.merge(opts)
+    end
+
+    def opts
+      @opts.dup
+    end
+
+    # @return [Connection]
+    def conn
+      @conn ||= Connection.new(@opts)
+    end
+
+    # @return [AccessToken::ClientModule]
+    def access_tokens
+      @access_tokens ||= AccessToken::ClientModule.new(self)
+    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 [Config::ClientModule]
+    def config
+      @config ||= Config::ClientModule.new(self)
+    end
+
+    # @return [MockHSM::ClientModule]
+    def mock_hsm
+      @mock_hsm ||= MockHSM::ClientModule.new(self)
+    end
+
+    # @return [Transaction::ClientModule]
+    def transactions
+      @transactions ||= Transaction::ClientModule.new(self)
+    end
+
+    # @return [TransactionFeed::ClientModule]
+    def transaction_feeds
+      @transaction_feeds ||= TransactionFeed::ClientModule.new(self)
+    end
+
+    # @return [UnspentOutput::ClientModule]
+    def unspent_outputs
+      @unspent_outputs ||= UnspentOutput::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

data/lib/chain/config.rb

@@ -0,0 +1,121 @@
+require_relative './client_module'
+require_relative './response_object'
+
+module Chain
+  module Config
+
+    class Info < ResponseObject
+      class Snapshot < ResponseObject
+        # @!attribute [r] attempt
+        # @return [Integer]
+        attrib :attempt
+
+        # @!attribute [r] height
+        # @return [Integer]
+        attrib :height
+
+        # @!attribute [r] size
+        # @return [Integer]
+        attrib :size
+
+        # @!attribute [r] downloaded
+        # @return [Integer]
+        attrib :downloaded
+
+        # @!attribute [r] in_progress
+        # @return [Boolean]
+        attrib :in_progress
+      end
+
+      # @!attribute [r] is_configured
+      # @return [Boolean]
+      attrib :is_configured
+
+      # @!attribute [r] configured_at
+      # @return [Time]
+      attrib(:configured_at) { |raw| Time.parse(raw) }
+
+      # @!attribute [r] is_signer
+      # @return [Boolean]
+      attrib :is_signer
+
+      # @!attribute [r] is_generator
+      # @return [Boolean]
+      attrib :is_generator
+
+      # @!attribute [r] is_generator
+      # @return [String]
+      attrib :generator_url
+
+      # @!attribute [r] generator_access_token
+      # @return [String]
+      attrib :generator_access_token
+
+      # @!attribute [r] blockchain_id
+      # @return [String]
+      attrib :blockchain_id
+
+      # @!attribute [r] block_height
+      # @return [Integer]
+      attrib :block_height
+
+      # @!attribute [r] generator_block_height
+      # @return [Integer]
+      attrib :generator_block_height
+
+      # @!attribute [r] generator_block_height_fetched_at
+      # @return [Time]
+      attrib(:generator_block_height_fetched_at) { |raw| Time.parse(raw) }
+
+      # @!attribute [r] is_production
+      # @return [Boolean]
+      attrib :is_production
+
+      # @!attribute [r] network_rpc_version
+      # @return [Integer]
+      attrib :network_rpc_version
+
+      # @!attribute [r] core_id
+      # @return [String]
+      attrib :core_id
+
+      # @!attribute [r] build_commit
+      # @return [String]
+      attrib :build_commit
+
+      # @!attribute [r] build_date
+      # Date when the core binary was compiled.
+      #
+      # The API may not return this field as an RFC3399 timestamp,
+      # so it is not converted into a Time object.
+      # @return [String]
+      attrib :build_date
+
+      # @!attribute [r] health
+      # @return [Hash]
+      attrib :health
+
+      # @!attribute [r] snapshot
+      # @return [Snapshot]
+      attrib(:snapshot) { |raw| Snapshot.new(raw) }
+    end
+
+    class ClientModule < Chain::ClientModule
+      # @return [void]
+      def reset(everything: false)
+        client.conn.request('reset', {everything: everything})
+      end
+
+      # @return [void]
+      def configure(opts)
+        client.conn.request('configure', opts)
+      end
+
+      # @return [Info]
+      def info
+        Info.new(client.conn.request('info'))
+      end
+    end
+
+  end
+end