sequence-sdk 0.0.1

data/lib/chain/transaction.rb

@@ -0,0 +1,256 @@
+require 'securerandom'
+
+require_relative './client_module'
+require_relative './query'
+require_relative './response_object'
+
+module Chain
+  class Transaction < ResponseObject
+
+    # @!attribute [r] id
+    # Unique transaction identifier.
+    # @return [String]
+    attrib :id
+
+    # @!attribute [r] timestamp
+    # Time of transaction.
+    # @return [Time]
+    attrib :timestamp, rfc3339_time: true
+
+    # @!attribute [r] reference_data
+    # User specified, unstructured data embedded within a transaction.
+    # @return [Hash]
+    attrib :reference_data
+
+    # @!attribute [r] actions
+    # List of a transaction's actions.
+    # @return [Array<Input>]
+    attrib(:actions) { |raw| raw.map { |v| Action.new(v) } }
+
+    class ClientModule < Chain::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.
+      # @return Transaction
+      def transact(builder = nil, &block)
+        if builder.nil?
+          builder = Builder.new(&block)
+        end
+
+        tpl = client.conn.request('build-transaction', builder)
+        tpl = client.conn.request(
+          '/sign-transaction',
+          transaction: tpl,
+        )
+        Transaction.new(client.conn.request(
+          'submit-transaction',
+          {transaction: tpl}
+        ))
+      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).
+      # @return [Query]
+      def query(opts = {})
+        Query.new(client, opts)
+      end
+    end
+
+    class Query < Chain::Query
+      def fetch(query)
+        client.conn.request('list-transactions', query)
+      end
+
+      def translate(raw)
+        Transaction.new(raw)
+      end
+    end
+
+    class Action < ResponseObject
+      # @!attribute [r] type
+      # The type of the action.
+      #
+      # Possible values are "issue", "transfer" and "retire".
+      # @return [String]
+      attrib :type
+
+      # @!attribute [r] asset_id
+      # The id of the action's asset.
+      # @return [String]
+      attrib :asset_id
+
+      # @!attribute [r] asset_alias
+      # The alias of the action's asset (possibly null).
+      # @return [String]
+      attrib :asset_alias
+
+      # @!attribute [r] asset_tags
+      # The tags of the action's asset (possibly null).
+      # @return [Hash]
+      attrib :asset_tags
+
+      # @!attribute [r] amount
+      # The number of units of the action's asset.
+      # @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).
+      # @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).
+      # @return [String]
+      attrib :source_account_alias
+
+      # @!attribute [r] source_account_tags
+      # The tags associated with the source account (possibly null).
+      # @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).
+      # @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).
+      # @return [String]
+      attrib :destination_account_alias
+
+      # @!attribute [r] destination_account_tags
+      # The tags associated with the destination account (possibly null).
+      # @return [String]
+      attrib :destination_account_tags
+
+      # @!attribute [r] reference_data
+      # User specified, unstructured data embedded within an action
+      # (possibly null).
+      # @return [Hash]
+      attrib :reference_data
+    end
+
+    class Builder
+      attr_accessor :ttl, :reference_data
+
+      def initialize(&block)
+        block.call(self) if block
+      end
+
+      # @return [Array<Hash>]
+      def actions
+        @actions ||= []
+      end
+
+      # @param [Template, String] template_or_raw_tx
+      # @return [Builder]
+      def base_transaction(template_or_raw_tx)
+        if template_or_raw_tx.is_a?(Transaction::Template)
+          @base_transaction = template_or_raw_tx.raw_transaction
+        else
+          @base_transaction = template_or_raw_tx
+        end
+        self
+      end
+
+      # @return [Hash]
+      def to_h
+        {
+          actions: actions,
+          base_transaction: @base_transaction,
+          reference_data: reference_data,
+          ttl: ttl,
+        }
+      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
+      # @return [Builder]
+      def add_action(params)
+        # Some actions require an idempotency token, so we'll add it here as a
+        # generic parameter.
+        params = {client_token: SecureRandom.uuid}.merge(params)
+        actions << params
+        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.
+      #                                   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.
+      # @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.
+      # @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.
+      # @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.
+      # @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.
+      # @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.
+      #
+      # @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.
+      # @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.
+      # @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.
+      #                                   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] :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.
+      # @return [Builder]
+      def transfer(params)
+        add_action(params.merge(type: :transfer))
+      end
+    end
+  end
+end

data/lib/chain/unspent_output.rb

@@ -0,0 +1,72 @@
+require_relative './client_module'
+require_relative './response_object'
+require_relative './query'
+
+module Chain
+  class UnspentOutput < ResponseObject
+    # @!attribute [r] id
+    # @return [String]
+    attrib :id
+
+    # @!attribute [r] type
+    # @return [String]
+    attrib :type
+
+    # @!attribute [r] transaction_id
+    # @return [String]
+    attrib :transaction_id
+
+    # @!attribute [r] asset_id
+    # @return [String]
+    attrib :asset_id
+
+    # @!attribute [r] asset_alias
+    # @return [String]
+    attrib :asset_alias
+
+    # @!attribute [r] asset_tags
+    # @return [Hash]
+    attrib :asset_tags
+
+    # @!attribute [r] amount
+    # @return [Integer]
+    attrib :amount
+
+    # @!attribute [r] account_id
+    # @return [String]
+    attrib :account_id
+
+    # @!attribute [r] account_alias
+    # @return [String]
+    attrib :account_alias
+
+    # @!attribute [r] account_tags
+    # @return [Hash]
+    attrib :account_tags
+
+    # @!attribute [r] reference_data
+    # @return [Hash]
+    attrib :reference_data
+
+    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 [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-unspent-outputs', query)
+      end
+
+      def translate(raw)
+        UnspentOutput.new(raw)
+      end
+    end
+  end
+end

data/lib/chain/version.rb

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

data/lib/chain.rb

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

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: sequence-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chain Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-18 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: 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
+    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
+email: 
+executables: []
+extensions: []
+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
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: SDK for Sequence
+test_files: []