sequence-sdk 1.5.2 → 2.pre.rc.1

data/lib/sequence/stats.rb

@@ -9,28 +9,27 @@ module Sequence
   # @private
   class Stats < ResponseObject
     # @!attribute [r] flavor_count
-    #   The number of flavors in the ledger.
+    # The number of flavors in the ledger.
     # @return [Integer]
     attrib :flavor_count
 
-    # @!attribute [r] asset_count
-    #   Deprecated. Use {#flavor_count} instead.
-    #   The number of assets in the ledger.
-    # @return [Integer]
-    attrib :asset_count
-
     # @!attribute [r] account_count
-    #   The number of accounts in the ledger.
+    # The number of accounts in the ledger.
     # @return [Integer]
     attrib :account_count
 
     # @!attribute [r] tx_count
-    #   The number of transactions in the ledger.
+    # The number of transactions in the ledger.
     # @return [Integer]
     attrib :tx_count
 
+    # @!attribute [r] ledger_type
+    # The ledger type. Value can be 'dev' or 'prod'.
+    # @return [Integer]
+    attrib :ledger_type
+
     class ClientModule < Sequence::ClientModule
-      # Gets stats from the ledger.
+      # Get stats from the ledger.
       # @return [Stats]
       def get
         Stats.new(client.session.request('stats'))

data/lib/sequence/token.rb

@@ -8,39 +8,40 @@ module Sequence
   #  More info: {https://dashboard.seq.com/docs/tokens}
   module Token
     class ClientModule < Sequence::ClientModule
-      # @param [Hash] opts
-      #   Options hash.
-      # @option opts [String] filter
+      # Execute a query, returning an enumerable over tokens.
+      # @param filter [String]
       #   A filter expression.
-      # @option opts [Array<String|Integer>] filter_params
+      # @param filter_params [Array<String|Integer>]
       #   A list of values that will be interpolated into the filter expression.
       # @return [Query]
-      def list(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :filter,
-          :filter_params,
-        )
-        GroupQuery.new(client, opts)
+      # @example List all tokens after a certain time
+      #    ledger.tokens.list(
+      #      filter: 'timestamp > $1',
+      #      filter_params: ['1985-10-26T01:21:00Z']
+      #    ).each do |token|
+      #      puts 'amount: ' + token.amount
+      #      puts 'flavor_id: ' + token.flavor_id
+      #      puts 'account_id: ' + token.account_id
+      #    end
+      def list(filter: nil, filter_params: nil)
+        GroupQuery.new(client, filter: filter, filter_params: filter_params)
       end
 
-      # @param [Hash] opts
-      #   Options hash.
-      # @option opts [String] filter
+      # Execute a query, returning an enumerable over sums of tokens.
+      # @param filter [String]
       #   A filter expression.
-      # @option opts [Array<String|Integer>] filter_params
+      # @param filter_params [Array<String|Integer>]
       #   A list of values that will be interpolated into the filter expression.
-      # @option opts [Array<String>] group_by
+      # @param group_by [Array<String>]
       #   A list of token fields to be summed.
       # @return [Query]
-      def sum(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :filter,
-          :filter_params,
-          :group_by,
+      def sum(filter: nil, filter_params: nil, group_by: nil)
+        SumQuery.new(
+          client,
+          filter: filter,
+          filter_params: filter_params,
+          group_by: group_by,
         )
-        SumQuery.new(client, opts)
       end
     end
 

data/lib/sequence/transaction.rb

@@ -5,7 +5,6 @@ require 'securerandom'
 require_relative './client_module'
 require_relative './query'
 require_relative './response_object'
-require_relative './validations'
 
 module Sequence
   # A transaction is an atomic update to the state of the ledger. Transactions
@@ -27,25 +26,13 @@ module Sequence
     # @return [Integer]
     attrib :sequence_number
 
-    # @!attribute [r] reference_data
-    #   Deprecated. Use {Sequence::Action#tags} instead.
-    #   User-specified key-value data embedded into the transaction.
-    # @return [Hash]
-    attrib :reference_data
-
     # @!attribute [r] actions
     #   List of actions taken by the transaction.
     # @return [Array<Action>]
     attrib(:actions) { |raw| raw.map { |v| Action.new(v) } }
 
-    # @!attribute [r] contracts
-    #   Deprecated. Use {Token::ClientModule#list} instead.
-    #   List of contracts created by the transaction.
-    # @return [Array<Contract>]
-    attrib(:contracts) { |raw| raw.map { |v| Contract.new(v) } }
-
     class ClientModule < Sequence::ClientModule
-      # Builds, signs, and submits a transaction.
+      # Build, sign, and submit a transaction.
       # @param [Builder] builder
       #   Builder object with actions defined. If provided, overrides block
       #   parameter.
@@ -62,41 +49,14 @@ module Sequence
         )
       end
 
-      # @deprecated Use list instead.
-      # 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.
-      # @option opts [Integer>] page_size
-      #   Deprecated. Use list.page(size: size) instead.
-      #   The number of items to return in the result set.
-      # @return [Query]
-      def query(opts = {})
-        Query.new(client, opts)
-      end
-
-      # Executes a query, returning an enumerable over individual transactions.
-      # @param [Hash] opts Options hash
-      # @option opts [String] filter
+      # Execute a query, returning an enumerable over individual transactions.
+      # @param filter [String]
       #   A filter expression.
-      # @option opts [Array<String|Integer>] filter_params
+      # @param filter_params [Array<String|Integer>]
       #   A list of values that will be interpolated into the filter expression.
       # @return [Query]
-      def list(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :filter,
-          :filter_params,
-        )
-        Query.new(client, opts)
+      def list(filter: nil, filter_params: nil)
+        Query.new(client, filter: filter, filter_params: filter_params)
       end
     end
 
@@ -112,11 +72,6 @@ module Sequence
 
     # A configuration object for creating and submitting transactions.
     class Builder
-      include Sequence::Validations
-
-      # @deprecated Use {Sequence::Action#tags} instead.
-      attr_accessor :reference_data
-
       def initialize(&block)
         yield(self) if block
       end
@@ -126,17 +81,14 @@ module Sequence
       end
 
       def to_h
-        {
-          actions: actions,
-          reference_data: reference_data,
-        }
+        { actions: actions }
       end
 
       def to_json(opts = nil)
         to_h.to_json(opts)
       end
 
-      # Adds an action to a transaction builder.
+      # Add an action to a transaction builder.
       # @param [Hash] opts
       #   Action parameters.
       # @return [Builder]
@@ -148,205 +100,107 @@ module Sequence
         self
       end
 
-      # Issues new tokens to a destination account.
-      #
-      # @param [Hash] opts
-      #   Options hash
-      # @option opts [Integer] :amount
+      # Issue new tokens to a destination account.
+      # @param amount [Integer]
       #   Amount of the flavor to be issued.
-      # @option opts [String] :flavor_id
+      # @param flavor_id [String]
       #   ID of the flavor to be issued.
-      # @option opts [String] :asset_id
-      #   Deprecated. Use :flavor_id instead.
-      #   ID of the asset to be issued. You must specify either an ID or an
-      #   alias.
-      # @option opts [String] :asset_alias
-      #   Deprecated. Use :flavor_id instead.
-      #   Asset alias of the asset to be issued. You must specify either an ID
-      #   or an alias.
-      # @option opts [String] :destination_account_id
-      #   ID of the account receiving the flavor units. You must specify a
-      #   destination account ID or alias.
-      # @option opts [String] :destination_account_alias
-      #   Deprecated. Use :destination_account_id instead.
-      #   Alias of the account receiving the asset units. You must specify a
-      #   destination account ID or alias.
-      # @option opts [Hash] :token_tags
+      # @param destination_account_id [String]
+      #   ID of the account receiving the flavor units.
+      # @param token_tags [Hash]
       #   Tags to add to the receiving tokens.
-      # @option opts [Hash] :action_tags
+      # @param action_tags [Hash]
       #   Tags to add to the action.
-      # @option opts [Hash] :reference_data
-      #   Deprecated. Use :token_tags or :action_tags instead.
-      #   Reference data for the action.
       # @return [Builder]
-      def issue(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :amount,
-          :flavor_id,
-          :asset_id,
-          :asset_alias,
-          :destination_account_id,
-          :destination_account_alias,
-          :token_tags,
-          :action_tags,
-          :reference_data,
-        )
-        validate_either!(opts, :flavor_id, :asset_id, :asset_alias)
-        validate_either!(
-          opts,
-          :destination_account_id,
-          :destination_account_alias,
+      def issue(
+        amount:,
+        flavor_id:,
+        destination_account_id:,
+        token_tags: {},
+        action_tags: {}
+      )
+        add_action(
+          type: :issue,
+          amount: amount,
+          flavor_id: flavor_id,
+          destination_account_id: destination_account_id,
+          token_tags: token_tags,
+          action_tags: action_tags,
         )
-        add_action(opts.merge(type: :issue))
       end
 
-      # Moves tokens from a source (an account or contract) to a
-      # destination account.
-      #
-      # @param [Hash] opts
-      #   Options hash
-      # @option opts [Integer] :amount
+      # Move tokens from a source account to a destination account.
+      # @param amount [Integer]
       #   Amount of the flavor to be transferred.
-      # @option opts [String] :flavor_id
+      # @param flavor_id [String]
       #   ID of the flavor to be transferred.
-      # @option opts [String] :asset_id
-      #   Deprecated. Use :flavor_id instead.
-      #   ID of the asset to be transferred. You must specify either an ID or an
-      #   alias.
-      # @option opts [String] filter
+      # @param source_account_id [String]
+      #   ID of the account serving as the source of flavor units.
+      # @param destination_account_id [String]
+      #   ID of the account receiving the flavor units.
+      # @param filter [String]
       #   Token filter string. See {https://dashboard.seq.com/docs/filters}.
-      # @option opts [Array<String|Integer>] filter_params
+      # @param filter_params [Array<String|Integer>]
       #   A list of parameter values for filter string (if needed).
-      # @option opts [String] :asset_alias
-      #   Deprecated. Use :flavor_id instead.
-      #   Asset alias of the asset to be transferred. You must specify either an
-      #   ID or an alias.
-      # @option opts [String] :source_account_id
-      #   ID of the account serving as the source of flavor units. You must
-      #   specify a source account ID, account alias, or contract ID.
-      # @option opts [String] :source_account_alias
-      #   Deprecated. Use :source_account_id instead.
-      #   Alias of the account serving as the source of asset units You must
-      #   specify a source account ID, account alias, or contract ID.
-      # @option opts [String] :source_contract_id
-      #   ID of the contract serving as the source of flavor units. You must
-      #   specify a source account ID, account alias, or contract ID.
-      # @option opts [String] :destination_account_id
-      #   ID of the account receiving the flavor units. You must specify a
-      #   destination account ID or alias.
-      # @option opts [String] :destination_account_alias
-      #   Deprecated. Use :destination_account_id instead.
-      #   Alias of the account receiving the asset units. You must specify a
-      #   destination account ID or alias.
-      # @option opts [Hash] :token_tags
+      # @param token_tags [Hash]
       #   Tags to add to the receiving tokens.
-      # @option opts [Hash] :action_tags
+      # @param action_tags [Hash]
       #   Tags to add to the action.
-      # @option opts [Hash] :reference_data
-      #   Deprecated. Use :token_tags or :action_tags instead.
-      #   reference data for the action.
-      # @option opts [Hash] :change_reference_data
-      #   Deprecated. This happens automatically when using token tags.
-      #   reference data for the change contract.
       # @return [Builder]
-      def transfer(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :amount,
-          :flavor_id,
-          :filter,
-          :filter_params,
-          :asset_id,
-          :asset_alias,
-          :source_account_id,
-          :source_account_alias,
-          :source_contract_id,
-          :destination_account_id,
-          :destination_account_alias,
-          :token_tags,
-          :action_tags,
-          :reference_data,
-          :change_reference_data,
-        )
-        validate_either!(opts, :flavor_id, :asset_id, :asset_alias)
-        validate_either!(
-          opts,
-          :source_account_id,
-          :source_account_alias,
-          :source_contract_id,
+      def transfer(
+        amount:,
+        flavor_id:,
+        source_account_id:,
+        destination_account_id:,
+        filter: nil,
+        filter_params: nil,
+        token_tags: {},
+        action_tags: {}
+      )
+        add_action(
+          type: :transfer,
+          amount: amount,
+          flavor_id: flavor_id,
+          source_account_id: source_account_id,
+          destination_account_id: destination_account_id,
+          filter: filter,
+          filter_params: filter_params,
+          token_tags: token_tags,
+          action_tags: action_tags,
         )
-        validate_either!(
-          opts,
-          :destination_account_id,
-          :destination_account_alias,
-        )
-        add_action(opts.merge(type: :transfer))
       end
 
-      # Takes tokens from a source (an account or contract) and
-      # retires them.
-      #
-      # @param [Hash] opts Options hash
-      # @option opts [Integer] :amount
+      # Take tokens from a source account and retire them.
+      # @param amount [Integer]
       #   Amount of the flavor to be retired.
-      # @option opts [String] :flavor_id
+      # @param flavor_id [String]
       #   ID of the flavor to be retired.
-      # @option opts [String] filter
+      # @param source_account_id [String]
+      #   ID of the account serving as the source of flavor units.
+      # @param filter [String]
       #   Token filter string. See {https://dashboard.seq.com/docs/filters}.
-      # @option opts [Array<String|Integer>] filter_params
+      # @param filter_params [Array<String|Integer>]
       #   A list of parameter values for filter string (if needed).
-      # @option opts [String] :asset_id
-      #   Deprecated. Use :flavor_id instead.
-      #   ID of the asset to be retired. You must specify either an ID or an
-      #   alias.
-      # @option opts [String] :asset_alias
-      #   Deprecated. Use :flavor_id instead.
-      #   Asset alias of the asset to be retired. You must specify either an ID
-      #   or an alias.
-      # @option opts [String] :source_account_id
-      #   ID of the account serving as the source of flavor units. You must
-      #   specify a source account ID, account alias, or contract ID.
-      # @option opts [String] :source_account_alias
-      #   Deprecated. Use :source_account_id instead.
-      #   Alias of the account serving as the source of asset units You must
-      #   specify a source account ID, account alias, or contract ID.
-      # @option opts [String] :source_contract_id
-      #   ID of the contract serving as the source of flavor units. You must
-      #   specify a source account ID, account alias, or contract ID.
-      # @option opts [Hash] :action_tags
+      # @param action_tags [Hash]
       #   Tags to add to the action.
-      # @option opts [Hash] :reference_data
-      #   Deprecated. Use :token_tags or :action_tags instead.
-      #   Reference data for the action.
-      # @option opts [Hash] :change_reference_data
-      #   Deprecated. This happens automatically when using token tags.
-      #   Reference data for the change contract.
       # @return [Builder]
-      def retire(opts = {})
-        validate_inclusion_of!(
-          opts,
-          :amount,
-          :flavor_id,
-          :filter,
-          :filter_params,
-          :asset_id,
-          :asset_alias,
-          :source_account_id,
-          :source_account_alias,
-          :source_contract_id,
-          :action_tags,
-          :reference_data,
-          :change_reference_data,
-        )
-        validate_either!(opts, :flavor_id, :asset_id, :asset_alias)
-        validate_either!(
-          opts,
-          :source_account_id,
-          :source_account_alias,
-          :source_contract_id,
+      def retire(
+        amount:,
+        flavor_id:,
+        source_account_id:,
+        filter: nil,
+        filter_params: nil,
+        action_tags: {}
+      )
+        add_action(
+          type: :retire,
+          amount: amount,
+          flavor_id: flavor_id,
+          source_account_id: source_account_id,
+          filter: filter,
+          filter_params: filter_params,
+          action_tags: action_tags,
         )
-        add_action(opts.merge(type: :retire))
       end
     end
   end