beowulf-ruby-testnet 0.0.1

data/lib/beowulf/base_error.rb

@@ -0,0 +1,21 @@
+module Beowulf
+  class BaseError < StandardError
+    def initialize(error, cause = nil)
+      @error = error
+      @cause = cause
+    end
+    
+    def to_s
+      if !!@cause
+        JSON[error: @error, cause: @cause] rescue {error: @error, cause: @cause}.to_s
+      else
+        JSON[@error] rescue @error
+      end
+    end
+  end
+end
+
+module Beowulf; class ApiError < BaseError; end; end
+module Beowulf; class TypeError < BaseError; end; end
+module Beowulf; class OperationError < BaseError; end; end
+module Beowulf; class TransactionError < BaseError; end; end

data/lib/beowulf/block_api.rb

@@ -0,0 +1,14 @@
+module Beowulf
+  class BlockApi < Api
+    def method_names
+      @method_names ||= [
+          :get_block_header,
+          :get_block
+      ].freeze
+    end
+
+    def api_name
+      :block_api
+    end
+  end
+end

data/lib/beowulf/broadcast_operations.json

@@ -0,0 +1,74 @@
+[
+  {
+    "roles": ["owner"],
+    "operation": "transfer",
+    "params": [
+      "from",
+      "to",
+      "amount",
+      "fee",
+      "memo"
+    ]
+  },
+  {
+    "roles": ["owner"],
+    "operation": "transfer_to_vesting",
+    "params": [
+      "from",
+      "to",
+      "amount",
+      "fee"
+    ]
+  },
+  {
+    "roles": ["owner"],
+    "operation": "withdraw_vesting",
+    "params": [
+      "account",
+      "vesting_shares",
+      "fee"
+    ]
+  },
+  {
+    "roles": ["owner"],
+    "operation": "account_create",
+    "params": [
+      "fee",
+      "creator",
+      "new_account_name",
+      "owner",
+      "json_metadata"
+    ]
+  },
+  {
+    "roles": ["owner"],
+    "operation": "account_update",
+    "params": [
+      "account",
+      "owner",
+      "json_metadata",
+      "fee"
+    ]
+  },
+  {
+    "roles": ["owner"],
+    "operation": "supernode_update",
+    "params": [
+      "owner",
+      "url",
+      "block_signing_key",
+      "props",
+      "fee"
+    ]
+  },
+  {
+    "roles": ["owner"],
+    "operation": "account_supernode_vote",
+    "params": [
+      "account",
+      "supernode",
+      "approve",
+      "fee"
+    ]
+  }
+]

data/lib/beowulf/chain_config.rb

@@ -0,0 +1,15 @@
+module Beowulf
+  module ChainConfig
+    EXPIRE_IN_SECS = 600
+    EXPIRE_IN_SECS_PROPOSAL = 24 * 60 * 60
+
+    NETWORKS_BEOWULF_CHAIN_ID = '430b37f23cf146d42f15376f341d7f8f5a1ad6f4e63affdeb5dc61d55d8c95a7'
+    NETWORKS_BEOWULF_ADDRESS_PREFIX = 'BEO'
+    NETWORKS_BEOWULF_BWF_ASSET = 'BWF'
+    NETWORKS_BEOWULF_W_ASSET = 'W'
+    NETWORKS_BEOWULF_VEST_ASSET = 'M'
+    NETWORKS_BEOWULF_DEFAULT_NODE = 'https://testnet-bw.beowulfchain.com/rpc'
+    
+    NETWORK_CHAIN_IDS = [NETWORKS_BEOWULF_CHAIN_ID]
+  end
+end

data/lib/beowulf/condenser_api.rb

@@ -0,0 +1,48 @@
+module Beowulf
+  class CondenserApi < Api
+    METHOD_NAMES = [
+      # :broadcast_block,
+      :broadcast_transaction,
+      :broadcast_transaction_synchronous,
+      :get_account_count,
+      :get_accounts,
+      :get_balance,
+      :get_active_supernodes,
+      :get_block,
+      :get_block_header,
+      :get_config,
+      :get_dynamic_global_properties,
+      :get_hardfork_version,
+      :get_key_references,
+      :get_next_scheduled_hardfork,
+      :get_owner_history,
+      :get_potential_signatures,
+      :get_required_signatures,
+      :get_transaction,
+      :get_transaction_hex,
+      :get_transaction_with_status,
+      :get_version,
+      :get_supernode_by_account,
+      :get_supernode_count,
+      :get_supernode_schedule,
+      :get_supernodes,
+      :get_supernodes_by_vote,
+      :lookup_account_names,
+      :lookup_accounts,
+      :lookup_supernode_accounts,
+      :list_smt_tokens,
+      :verify_authority,
+      :find_smt_tokens_by_name,
+      :get_supernode_voted_by_acc,
+      :get_pending_transaction_count
+    ].freeze
+    
+    def method_names
+      METHOD_NAMES
+    end
+    
+    def api_name
+      :condenser_api
+    end
+  end
+end

data/lib/beowulf/database_api.rb

@@ -0,0 +1,5 @@
+module Beowulf
+  # @see Api
+  class DatabaseApi < Api
+  end
+end

data/lib/beowulf/error_parser.rb

@@ -0,0 +1,228 @@
+module Beowulf
+  class ErrorParser
+    include Utils
+
+    attr_reader :response, :error, :error_code, :error_message,
+                :api_name, :api_method, :api_params,
+                :expiry, :can_retry, :can_reprepare, :node_degraded, :trx_id, :debug
+
+    alias expiry? expiry
+    alias can_retry? can_retry
+    alias can_reprepare? can_reprepare
+    alias node_degraded? node_degraded
+
+    REPREPARE_WHITELIST = [
+        'is_canonical( c ): signature is not canonical',
+        'now < trx.expiration: '
+    ]
+
+    DUPECHECK = '(skip & skip_transaction_dupe_check) || trx_idx.indices().get<by_trx_id>().find(trx_id) == trx_idx.indices().get<by_trx_id>().end(): Duplicate transaction check failed'
+
+    REPREPARE_BLACKLIST = [DUPECHECK]
+
+    def initialize(response)
+      @response = response
+
+      @error = nil
+      @error_code = nil
+      @error_message = nil
+      @api_name = nil
+      @api_method = nil
+      @api_params = nil
+
+      @expiry = nil
+      @can_retry = nil
+      @can_reprepare = nil
+      @trx_id = nil
+      @debug = nil
+
+      parse_error_response
+    end
+
+    def parse_error_response
+      if response.nil?
+        @expiry = false
+        @can_retry = false
+        @can_reprepare = false
+
+        return
+      end
+
+      @response = JSON[response] if response.class == String
+
+      @error = if !!@response['error']
+                 response['error']
+               else
+                 response
+               end
+
+      begin
+        if !!@error['data']
+          # These are, by far, the more interesting errors, so we try to pull
+          # them out first, if possible.
+
+          @error_code = @error['data']['code']
+          stacks = @error['data']['stack']
+          stack_formats = nil
+
+          @error_message = if !!stacks
+                             stack_formats = stacks.map { |s| s['format'] }
+                             stack_datum = stacks.map { |s| s['data'] }
+                             data_call_method = stack_datum.find { |data| data['call.method'] == 'call' }
+                             data_name = stack_datum.find { |data| !!data['name'] }
+
+                             # See if we can recover a transaction id out of this hot mess.
+                             data_trx_ix = stack_datum.find { |data| !!data['trx_ix'] }
+                             @trx_id = data_trx_ix['trx_ix'] if !!data_trx_ix
+
+                             stack_formats.reject(&:empty?).join('; ')
+                           else
+                             @error_code ||= @error['code']
+                             @error['message']
+                           end
+
+          @api_name, @api_method, @api_params = if !!data_call_method
+                                                  @api_name = data_call_method['call.params']
+                                                end
+        else
+          @error_code = @error['code']
+          @error_message = @error['message']
+          @expiry = false
+          @can_retry = false
+          @can_reprepare = false
+        end
+
+        case @error_code
+        when -32603
+          if error_match?('Internal Error')
+            @expiry = false
+            @can_retry = true
+            @can_reprepare = true
+          end
+        when -32003
+          if error_match?('Unable to acquire database lock')
+            @expiry = false
+            @can_retry = true
+            @can_reprepare = true
+          end
+        when -32000
+          @expiry = false
+          @can_retry = coerce_backtrace
+          @can_reprepare = if @api_name == 'network_broadcast_api'
+                             error_match(REPREPARE_WHITELIST)
+                           else
+                             false
+                           end
+        when 10
+          @expiry = false
+          @can_retry = coerce_backtrace
+          @can_reprepare = !!stack_formats && (stack_formats & REPREPARE_WHITELIST).any?
+        when 13
+          @error_message = @error['data']['message']
+          @expiry = false
+          @can_retry = false
+          @can_reprepare = false
+        when 3030000
+          @error_message = @error['data']['message']
+          @expiry = false
+          @can_retry = false
+          @can_reprepare = false
+        when 4030100
+          # Code 4030100 is "transaction_expiration_exception: transaction
+          # expiration exception".  If we assume the expiration was valid, the
+          # node might be bad and needs to be dropped.
+
+          @expiry = true
+          @can_retry = true
+          @can_reprepare = false
+        when 4030200
+          # Code 4030200 is "transaction tapos exception".  They are recoverable
+          # if the transaction hasn't expired yet.  A tapos exception can be
+          # retried in situations where the node is behind and the tapos is
+          # based on a block the node doesn't know about yet.
+
+          @expiry = false
+          @can_retry = true
+
+          # Allow fall back to reprepare if retry fails.
+          @can_reprepare = true
+        else
+          @expiry = false
+          @can_retry = false
+          @can_reprepare = false
+        end
+      rescue => e
+        if defined? ap
+          if ENV['DEBUG'] == 'true'
+            ap error_parser_exception: e, original_response: response, backtrace: e.backtrace
+          else
+            ap error_parser_exception: e, original_response: response
+          end
+        end
+
+        @expiry = false
+        @can_retry = false
+        @can_reprepare = false
+      end
+    end
+
+    def coerce_backtrace
+      can_retry = false
+
+      case @error['code']
+      when -32003
+        any_of = [
+            'Internal Error"',
+            '_api_plugin not enabled.'
+        ]
+
+        can_retry = error_match?('Unable to acquire database lock')
+
+        if !can_retry && error_match?(any_of)
+          can_retry = true
+          @node_degraded = true
+        else
+          @node_degraded = false
+        end
+      when -32002
+        can_retry = @node_degraded = error_match?('Could not find API')
+      when 1
+        can_retry = @node_degraded = error_match?('no method with name \'condenser_api')
+      end
+
+      can_retry
+    end
+
+    def error_match?(matches)
+      matches = [matches].flatten
+
+      any = matches.map do |match|
+        case match
+        when String
+          @error['message'] && @error['message'].include?(match)
+        when ::Array
+          if @error['message']
+            match.map { |m| m.include?(match) }.include? true
+          else
+            false
+          end
+        else; false
+        end
+      end
+
+      any.include?(true)
+    end
+
+    def to_s
+      if !!error_message && !error_message.empty?
+        "#{error_code}: #{error_message}"
+      else
+        error_code.to_s
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name} [#{to_s}]>"
+    end
+  end
+end

data/lib/beowulf/logger.rb

@@ -0,0 +1,20 @@
+require 'logger'
+
+module Beowulf
+  # The logger that Beowulf uses for reporting errors.
+  #
+  # @return [Logger]
+  def self.logger
+    @@logger ||= Logger.new(STDOUT).tap do |logger|
+      logger.progname = 'beowulf'
+    end
+  end
+
+  # Sets the logger that Beowulf uses for reporting errors.
+  #
+  # @param logger [Logger] The logger to set as Beowulf's logger.
+  # @return [void]
+  def self.logger=(logger)
+    @@logger = logger
+  end
+end

data/lib/beowulf/methods.json

@@ -0,0 +1,129 @@
+[
+  {
+    "api": "database_api",
+    "method": "get_block_header",
+    "params": ["blockNum"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_block",
+    "params": ["blockNum"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_config"
+  },
+  {
+    "api": "database_api",
+    "method": "get_dynamic_global_properties"
+  },
+  {
+    "api": "database_api",
+    "method": "get_supernode_schedule"
+  },
+  {
+    "api": "database_api",
+    "method": "get_hardfork_version"
+  },
+  {
+    "api": "database_api",
+    "method": "get_next_scheduled_hardfork"
+  },
+  {
+    "api": "account_by_key_api",
+    "method": "get_key_references",
+    "params": ["key"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_accounts",
+    "params": ["names"]
+  },
+  {
+    "api": "database_api",
+    "method": "lookup_account_names",
+    "params": ["accountNames"]
+  },
+  {
+    "api": "database_api",
+    "method": "lookup_accounts",
+    "params": ["lowerBoundName", "limit"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_account_count"
+  },
+  {
+    "api": "database_api",
+    "method": "get_owner_history",
+    "params": ["account"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_transaction_hex",
+    "params": ["trx"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_transaction",
+    "params": ["trxId"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_required_signatures",
+    "params": ["trx", "availableKeys"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_potential_signatures",
+    "params": ["trx"]
+  },
+  {
+    "api": "database_api",
+    "method": "verify_authority",
+    "params": ["trx"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_supernodes",
+    "params": ["supernodeIds"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_supernode_by_account",
+    "params": ["accountName"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_supernodes_by_vote",
+    "params": ["from", "limit"]
+  },
+  {
+    "api": "database_api",
+    "method": "lookup_supernode_accounts",
+    "params": ["lowerBoundName", "limit"]
+  },
+  {
+    "api": "database_api",
+    "method": "get_supernode_count"
+  },
+  {
+    "api": "database_api",
+    "method": "get_active_supernodes"
+  },
+  {
+    "api": "network_broadcast_api",
+    "method": "broadcast_transaction",
+    "params": ["trx"]
+  },
+  {
+    "api": "network_broadcast_api",
+    "method": "broadcast_transaction_synchronous",
+    "params": ["trx"]
+  },
+  {
+    "api": "network_broadcast_api",
+    "method": "broadcast_block",
+    "params": ["b"]
+  }
+]