Class: Radiator::Api

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/radiator/api.rb

Overview

Radiator::Api allows you to call remote methods to interact with the STEEM blockchain. The `Api` class is a shortened name for `Radiator::DatabaseApi`.

Examples:

api = Radiator::Api.new
response = api.get_dynamic_global_properties
virtual_supply = response.result.virtual_supply

… or …

api = Radiator::Api.new
virtual_supply = api.get_dynamic_global_properties do |prop|
  prop.virtual_supply
end

If you need access to the `error` property, they can be accessed as follows:

api = Radiator::Api.new
response = api.get_dynamic_global_properties
if response.result.nil?
  puts response.error
  exit
end

virtual_supply = response.result.virtual_supply

… or …

api = Radiator::Api.new
virtual_supply = api.get_dynamic_global_properties do |prop, error|
  if prop.nil?
    puts error
    exis
  end

  prop.virtual_supply
end

List of remote methods:

set_subscribe_callback
set_pending_transaction_callback
set_block_applied_callback
cancel_all_subscriptions
get_trending_tags
get_tags_used_by_author
get_post_discussions_by_payout
get_comment_discussions_by_payout
get_discussions_by_trending
get_discussions_by_trending30
get_discussions_by_created
get_discussions_by_active
get_discussions_by_cashout
get_discussions_by_payout
get_discussions_by_votes
get_discussions_by_children
get_discussions_by_hot
get_discussions_by_feed
get_discussions_by_blog
get_discussions_by_comments
get_discussions_by_promoted
get_block_header
get_block
get_ops_in_block
get_state
get_trending_categories
get_best_categories
get_active_categories
get_recent_categories
get_config
get_dynamic_global_properties
get_chain_properties
get_feed_history
get_current_median_history_price
get_witness_schedule
get_hardfork_version
get_next_scheduled_hardfork
get_accounts


lookup_accounts

get_conversion_requests

get_owner_history
get_recovery_request
get_escrow
get_withdraw_routes

get_savings_withdraw_from
get_savings_withdraw_to
get_order_book
get_open_orders
get_liquidity_queue
get_transaction_hex
get_transaction
get_required_signatures
get_potential_signatures
verify_authority

get_active_votes

get_content
get_content_replies
get_discussions_by_author_before_date
get_replies_by_last_update
get_witnesses

get_witnesses_by_vote
lookup_witness_accounts
get_witness_count
get_active_witnesses
get_miner_queue
get_reward_fund

These methods and their characteristics are copied directly from methods marked as `database_api` in `steem-js`:

raw.githubusercontent.com/steemit/steem-js/master/src/api/methods.js

Constant Summary

DEFAULT_STEEM_URL =
'https://api.steemit.com'
DEFAULT_GOLOS_URL =
'https://ws.golos.io'
DEFAULT_STEEM_FAILOVER_URLS =
[
  DEFAULT_STEEM_URL,
  'https://api.steemitstage.com',
  'https://gtg.steem.house:8090',
  'https://seed.bitcoiner.me',
  'https://steemd.minnowsupportproject.org',
  'https://steemd.privex.io',
  'https://rpc.steemliberator.com'
]
DEFAULT_GOLOS_FAILOVER_URLS =
[
  DEFAULT_GOLOS_URL,
  'https://api.golos.cf',
  # not recommended:
  # 'http://golos-seed.arcange.eu',
  # not recommended, requires option ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE
  # 'https://golos-seed.arcange.eu',
]
POST_HEADERS =
{
  'Content-Type' => 'application/json',
  'User-Agent' => Radiator::AGENT_ID
}
HEALTH_URI =
'/health'

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils

#debug, #error, #extract_signatures, #hexlify, #pakArr, #pakC, #pakHash, #pakI, #pakL!, #pakS, #pakStr, #pakc, #paks, #send_log, #unhexlify, #varint, #warning

Constructor Details

#initialize(options = {}) ⇒ Api

Cretes a new instance of Radiator::Api.

Examples:

api = Radiator::Api.new(url: 'https://api.example.com')

Parameters:

  • options (Hash) (defaults to: {})

    The attributes to initialize the Radiator::Api with.

Options Hash (options):

  • :url (String)

    URL that points at a full node, like `api.steemit.com`. Default from DEFAULT_URL.

  • :failover_urls (Array<String>)

    An array that contains one or more full nodes to fall back on. Default from DEFAULT_FAILOVER_URLS.

  • :logger (Logger)

    An instance of `Logger` to send debug messages to.

  • :recover_transactions_on_error (Boolean)

    Have Radiator try to recover transactions that are accepted but could not be confirmed due to an error like network timeout. Default: `true`

  • :max_requests (Integer)

    Maximum number of requests on a connection before it is considered expired and automatically closed.

  • :pool_size (Integer)

    Maximum number of connections allowed.

  • :reuse_ssl_sessions (Boolean)

    Reuse a previously opened SSL session for a new connection. There's a slight performance improvement by enabling this, but at the expense of reliability during long execution. Default false.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/radiator/api.rb', line 199

def initialize(options = {})
  @user = options[:user]
  @password = options[:password]
  @chain = options[:chain] || :steem
  @url = options[:url] || Api::default_url(@chain)
  @preferred_url = @url.dup
  @failover_urls = options[:failover_urls]
  @debug = !!options[:debug]
  @logger = options[:logger] || Radiator.logger
  @hashie_logger = options[:hashie_logger] || Logger.new(nil)
  @max_requests = options[:max_requests] || 30
  @ssl_verify_mode = options[:ssl_verify_mode] || OpenSSL::SSL::VERIFY_PEER
  @ssl_version = options[:ssl_version]
  
  if @failover_urls.nil?
    @failover_urls = Api::default_failover_urls(@chain) - [@url]
  end
  
  @failover_urls = [@failover_urls].flatten.compact
  @preferred_failover_urls = @failover_urls.dup
  
  unless @hashie_logger.respond_to? :warn
    @hashie_logger = Logger.new(@hashie_logger)
  end
  
  @recover_transactions_on_error = if options.keys.include? :recover_transactions_on_error
    options[:recover_transactions_on_error]
  else
    true
  end
  
  @persist = if options.keys.include? :persist
    options[:persist]
  else
    true
  end
  
  @reuse_ssl_sessions = if options.keys.include? :reuse_ssl_sessions
    options[:reuse_ssl_sessions]
  else
    true
  end
  
  if defined? Net::HTTP::Persistent::DEFAULT_POOL_SIZE
    @pool_size = options[:pool_size] || Net::HTTP::Persistent::DEFAULT_POOL_SIZE
  end
  
  Hashie.logger = @hashie_logger
  @method_names = nil
  @http_memo = {}
  @api_options = options.dup.merge(chain: @chain)
  @api = nil
  @block_api = nil
  @backoff_at = nil
  
  ObjectSpace.define_finalizer(self, self.class.finalize(self))
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args, &block) ⇒ Object



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
# File 'lib/radiator/api.rb', line 409

def method_missing(m, *args, &block)
  super unless respond_to_missing?(m)
  
  current_rpc_id = rpc_id
  method_name = [api_name, m].join('.')
  response = nil
  options = {
    jsonrpc: "2.0",
    params: [api_name, m, args],
    id: current_rpc_id,
    method: "call"
  }
  
  tries = 0
  timestamp = Time.now.utc
  
  loop do
    tries += 1
    
    begin
      if tries > 1 && @recover_transactions_on_error && api_name == :network_broadcast_api
        signatures, exp = extract_signatures(options)
        
        if !!signatures && signatures.any?
          offset = [(exp - timestamp).abs, 30].min
          
          if !!(response = recover_transaction(signatures, current_rpc_id, timestamp - offset))
            response = Hashie::Mash.new(response)
          end
        end
      end
      
      if response.nil?
        response = request(options)
        
        response = if response.nil?
          error "No response, retrying ...", method_name
        elsif !response.kind_of? Net::HTTPSuccess
          warning "Unexpected response (code: #{response.code}): #{response.inspect}, retrying ...", method_name, true
        else
          case response.code
          when '200'
            body = response.body
            response = JSON[body]
            
            if response['id'] != options[:id]
              warning "Unexpected rpc_id (expected: #{options[:id]}, got: #{response['id']}), retrying ...", method_name, true
            elsif response.keys.include?('error')
              handle_error(response, options, method_name, tries)
            else
              Hashie::Mash.new(response)
            end
          when '400' then warning 'Code 400: Bad Request, retrying ...', method_name, true
          when '429' then warning 'Code 429: Too Many Requests, retrying ...', method_name, true
          when '502' then warning 'Code 502: Bad Gateway, retrying ...', method_name, true
          when '503' then warning 'Code 503: Service Unavailable, retrying ...', method_name, true
          when '504' then warning 'Code 504: Gateway Timeout, retrying ...', method_name, true
          else
            warning "Unknown code #{response.code}, retrying ...", method_name, true
            warning response
          end
        end
      end
    rescue Net::HTTP::Persistent::Error => e
      warning "Unable to perform request: #{e} :: #{!!e.cause ? "cause: #{e.cause.message}" : ''}, retrying ...", method_name, true
    rescue Errno::ECONNREFUSED => e
      warning 'Connection refused, retrying ...', method_name, true
    rescue Errno::EADDRNOTAVAIL => e
      warning 'Node not available, retrying ...', method_name, true
    rescue Errno::ECONNRESET => e
      warning "Connection Reset (#{e.message}), retrying ...", method_name, true
    rescue Net::ReadTimeout => e
      warning 'Node read timeout, retrying ...', method_name, true
    rescue Net::OpenTimeout => e
      warning 'Node timeout, retrying ...', method_name, true
    rescue RangeError => e
      warning 'Range Error, retrying ...', method_name, true
    rescue OpenSSL::SSL::SSLError => e
      warning "SSL Error (#{e.message}), retrying ...", method_name, true
    rescue SocketError => e
      warning "Socket Error (#{e.message}), retrying ...", method_name, true
    rescue JSON::ParserError => e
      warning "JSON Parse Error (#{e.message}), retrying ...", method_name, true
      response = nil
    rescue ApiError => e
      warning "ApiError (#{e.message}), retrying ...", method_name, true
    # rescue => e
    #   warning "Unknown exception from request, retrying ...", method_name, true
    #   warning e
    end
    
    if !!response
      if !!block
        return yield(response.result, response.error, response.id)
      else
        return response
      end
    end

    backoff
  end # loop
end

Class Method Details

.default_failover_urls(chain) ⇒ Object



177
178
179
180
181
182
183
# File 'lib/radiator/api.rb', line 177

def self.default_failover_urls(chain)
  case chain.to_sym
  when :steem then DEFAULT_STEEM_FAILOVER_URLS
  when :golos then DEFAULT_GOLOS_FAILOVER_URLS
  else; raise ApiError, "Unsupported chain: #{chain}"
  end
end

.default_url(chain) ⇒ Object



169
170
171
172
173
174
175
# File 'lib/radiator/api.rb', line 169

def self.default_url(chain)
  case chain.to_sym
  when :steem then DEFAULT_STEEM_URL
  when :golos then DEFAULT_GOLOS_URL
  else; raise ApiError, "Unsupported chain: #{chain}"
  end
end

Instance Method Details

#api_nameObject



399
400
401
# File 'lib/radiator/api.rb', line 399

def api_name
  :database_api
end

#base_per_debtObject Also known as: steem_per_usd

Returns the current base (STEEM) price in the debt asset (SBD).



357
358
359
360
361
362
363
364
365
366
367
# File 'lib/radiator/api.rb', line 357

def base_per_debt
  get_feed_history do |feed_history|
    current_median_history = feed_history.current_median_history
    base = current_median_history.base
    base = base.split(' ').first.to_f
    quote = current_median_history.quote
    quote = quote.split(' ').first.to_f
    
    (base / quote) * steem_per_mvest
  end
end

#base_per_mvestObject Also known as: steem_per_mvest

Returns the current base (STEEM) price in the vest asset (VESTS).



344
345
346
347
348
349
350
351
# File 'lib/radiator/api.rb', line 344

def base_per_mvest
  api.get_dynamic_global_properties do |properties|
    total_vesting_fund_steem = properties.total_vesting_fund_steem.to_f
    total_vesting_shares_mvest = properties.total_vesting_shares.to_f / 1e6
  
    total_vesting_fund_steem / total_vesting_shares_mvest
  end
end

#find_account(id, &block) ⇒ Hash

Find a specific account.

Example:

api = Radiator::Api.new
ned = api.('ned')
vesting_shares = ned.vesting_shares

… or …

api = Radiator::Api.new
vesting_shares = api.('ned') do |ned|
  ned.vesting_shares
end

Parameters:

  • id (String)

    Name of the account to find.

  • block

    the block to execute for each result, optional.

Returns:

  • (Hash)


334
335
336
337
338
339
340
# File 'lib/radiator/api.rb', line 334

def (id, &block)
  if !!block
    yield api.get_accounts([id]).result.first
  else
    api.get_accounts([id]).result.first
  end
end

#find_block(block_number, &block) ⇒ Hash

Find a specific block.

Example:

api = Radiator::Api.new
block = api.find_block(12345678)
transactions = block.transactions

… or …

api = Radiator::Api.new
transactions = api.find_block(12345678) do |block|
  block.transactions
end

Parameters:

  • block_number (Fixnum)
  • block

    the block to execute for each result, optional.

Returns:

  • (Hash)


308
309
310
311
312
313
314
# File 'lib/radiator/api.rb', line 308

def find_block(block_number, &block)
  if !!block
    yield api.get_blocks(block_number).first
  else
    api.get_blocks(block_number).first
  end
end

#get_blocks(block_number, &block) ⇒ Array

Get a specific block or range of blocks.

Example:

api = Radiator::Api.new
blocks = api.get_blocks(10..20)
transactions = blocks.flat_map(&:transactions)

… or …

api = Radiator::Api.new
transactions = []
api.get_blocks(10..20) do |block|
  transactions += block.transactions
end

Parameters:

  • block_number (Fixnum || Array<Fixnum>)
  • block

    the block to execute for each result, optional.

Returns:

  • (Array)


276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/radiator/api.rb', line 276

def get_blocks(block_number, &block)
  block_number = [*(block_number)].flatten
  
  if !!block
    block_number.each do |i|
      yield block_api.get_block(i).result, i
    end
  else
    block_number.map do |i|
      block_api.get_block(i).result
    end
  end
end

#inspectObject



512
513
514
515
516
517
518
519
520
521
522
523
# File 'lib/radiator/api.rb', line 512

def inspect
  properties = %w(
    chain url backoff_at max_requests ssl_verify_mode ssl_version persist
    recover_transactions_on_error reuse_ssl_sessions pool_size
  ).map do |prop|
    if !!(v = instance_variable_get("@#{prop}"))
      "@#{prop}=#{v}" 
    end
  end.compact.join(', ')
  
  "#<#{self.class.name} [#{properties}]>"
end

#method_namesObject



390
391
392
393
394
395
396
# File 'lib/radiator/api.rb', line 390

def method_names
  return @method_names if !!@method_names
  
  @method_names = Radiator::Api.methods(api_name).map do |e|
    e['method'].to_sym
  end
end

#respond_to_missing?(m, include_private = false) ⇒ Boolean

Returns:

  • (Boolean)


404
405
406
# File 'lib/radiator/api.rb', line 404

def respond_to_missing?(m, include_private = false)
  method_names.include?(m.to_sym)
end

#shutdownObject

Stops the persistant http connections.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'lib/radiator/api.rb', line 373

def shutdown
  @uri = nil
  @http_id = nil
  @http_memo.each do |k|
    v = @http_memo.delete(k)
    if defined?(v.shutdown)
      debug "Shutting down instance #{k} (#{v})"
      v.shutdown
    end
  end
  @api.shutdown if !!@api && @api != self
  @api = nil
  @block_api.shutdown if !!@block_api && @block_api != self
  @block_api = nil
end