Copyright 2020 Nimiq community.\n
Licensed under the Apache License, Version 2.0 (the “License”); …\n"],["ClientRPC","","ClientRPC.html","",""],["ClientRPC::Connect","","ClientRPC/Connect.html","",""],["ClientRPC::Connect::Error","","ClientRPC/Connect/Error.html","",""],["Nimiq","","Nimiq.html","",""],["Nimiq::Client","","Nimiq/Client.html","",""],["accounts","Api","Api.html#method-i-accounts","()","
accounts - Returns a list of addresses owned by client.\n"],["block_number","Api","Api.html#method-i-block_number","()","
block_number - Returns the height of most recent block.\n"],["consensus","Api","Api.html#method-i-consensus","()","
consensus - Returns information on the current consensus state.\n"],["constant","Api","Api.html#method-i-constant","(name, value = nil)","
constant - Returns or overrides a constant value. When no parameter is given, it returns the value of …\n"],["create_account","Api","Api.html#method-i-create_account","()","
create_account - Creates a new account and stores its private key in the client store.\n"],["create_raw_transaction","Api","Api.html#method-i-create_raw_transaction","(transaction)","
create_raw_transaction - Creates and signs a transaction without sending it. The transaction can then …\n"],["get_account","Api","Api.html#method-i-get_account","(address)","
get_account - Returns details for the account of given address.\n
@param [String] address - Address to get …\n\n"],["get_balance","Api","Api.html#method-i-get_balance","(address)","
get_balance - Returns the balance of the account of given address.\n
@param [String] address - Address to …\n\n"],["get_block_by_hash","Api","Api.html#method-i-get_block_by_hash","(block_hash, full_transactions = nil)","
get_block_by_hash - Returns information about a block by hash.\n
@param [String] block_hash - Hash of the …\n"],["get_block_by_number","Api","Api.html#method-i-get_block_by_number","(block_number, full_transactions = nil)","
get_block_by_number - Returns information about a block by block number.\n
@param [Integer] block_number …\n"],["get_block_template","Api","Api.html#method-i-get_block_template","(address = nil, dada_field = nil)","
get_block_template - Returns a template to build the next block for mining. This will consider pool instructions …\n"],["get_block_transaction_count_by_hash","Api","Api.html#method-i-get_block_transaction_count_by_hash","(block_hash)","
get_block_transaction_count_by_hash - Returns the number of transactions in a block from a block matching …\n"],["get_block_transaction_count_by_number","Api","Api.html#method-i-get_block_transaction_count_by_number","(block_number)","
get_block_transaction_count_by_number - Returns the number of transactions in a block matching the given …\n"],["get_transaction_by_block_hash_and_index","Api","Api.html#method-i-get_transaction_by_block_hash_and_index","(block_hash, transaction_index)","
get_transaction_by_block_hash_and_index - Returns information about a transaction by block hash and transaction …\n"],["get_transaction_by_block_number_and_index","Api","Api.html#method-i-get_transaction_by_block_number_and_index","(block_height, transaction_index)","
get_transaction_by_block_number_and_index - Returns information about a transaction by block number and …\n"],["get_transaction_by_hash","Api","Api.html#method-i-get_transaction_by_hash","(transaction_hash)","
get_transaction_by_hash - Returns the information about a transaction requested by transaction hash. …\n"],["get_transaction_receipt","Api","Api.html#method-i-get_transaction_receipt","(transaction_hash)","
get_transaction_receipt - Returns the receipt of a transaction by transaction hash. Note That the receipt …\n"],["get_transactions_by_address","Api","Api.html#method-i-get_transactions_by_address","(address, transactions_number = nil)","
get_transactions_by_address - Returns the latest transactions successfully performed by or for an address. …\n"],["get_work","Api","Api.html#method-i-get_work","(address = nil, dada_field = nil)","
get_work - Returns instructions to mine the next block. This will consider pool instructions when connected …\n"],["hashrate","Api","Api.html#method-i-hashrate","()","
hashrate - Returns the number of hashes per second that the node is mining with.\n"],["log","Api","Api.html#method-i-log","(tag, log_level)","
log - Sets the log level of the node.\n
@param [String] tag - If the tag is '*' the log level will …\n"],["mempool","Api","Api.html#method-i-mempool","()","
mempool - Returns information on the current mempool situation. This will provide an overview of the …\n"],["mempool_content","Api","Api.html#method-i-mempool_content","()","
mempool_content - Returns transactions that are currently in the mempool.\n"],["min_fee_per_byte","Api","Api.html#method-i-min_fee_per_byte","(set_min_fee = nil)","
min_fee_per_byte - Returns or sets the minimum fee per byte.\n
@param [Integer] set_min_fee (optional) - …\n\n"],["miner_address","Api","Api.html#method-i-miner_address","()","
miner_address - Returns the miner address.\n"],["miner_threads","Api","Api.html#method-i-miner_threads","(set_threads = nil)","
miner_threads - Returns or sets the number of CPU threads for the miner.\n
@param [Integer] set_threads …\n\n"],["mining","Api","Api.html#method-i-mining","()","
mining - Returns `true` if client is actively mining new blocks.\n"],["new","Nimiq::Client","Nimiq/Client.html#method-c-new","(opts)",""],["peer_count","Api","Api.html#method-i-peer_count","()","
peer_count - Returns number of peers currently connected to the client.\n"],["peer_list","Api","Api.html#method-i-peer_list","()","
peer_list - Returns list of peers known to the client.\n"],["peer_state","Api","Api.html#method-i-peer_state","(peer_address)","
peer_state - Returns the state of the peer.\n
@param [String] peer_address - The address of the peer.\n\n"],["ping","Nimiq::Client","Nimiq/Client.html#method-i-ping","()","
Ping the Nimiq node.\n"],["pool","Api","Api.html#method-i-pool","(pool_address = nil)","
pool - Returns or sets the mining pool. When no parameter is given, it returns the current mining pool. …\n"],["pool_confirmed_balance","Api","Api.html#method-i-pool_confirmed_balance","()","
pool_confirmed_balance - Returns the confirmed mining pool balance.\n"],["pool_connection_state","Api","Api.html#method-i-pool_connection_state","()","
pool_connection_state - Returns the connection state to mining pool.\n"],["request","Nimiq::Client","Nimiq/Client.html#method-i-request","(name, params = nil)","
Sends a raw request to the Nimiq node.\n"],["send_raw_transaction","Api","Api.html#method-i-send_raw_transaction","(signed_transaction)","
send_raw_transaction - Sends a signed message call transaction or a contract creation, if the data field …\n"],["send_transaction","Api","Api.html#method-i-send_transaction","(transaction)","
send_transaction - Creates new message call transaction or a contract creation, if the data field contains …\n"],["submit_block","Api","Api.html#method-i-submit_block","(block)","
submit_block - Submits a block to the node. When the block is valid, the node will forward it to other …\n"],["syncing","Api","Api.html#method-i-syncing","()","
syncing - Returns an object with data about the sync status or `false`.\n"],["Gemfile","","Gemfile.html","","
source “rubygems.org”\n
gemspec\n
gem “minitest”, “~> 5.0” gem “rspec-rails”, …\n"],["Gemfile.lock","","Gemfile_lock.html","","
PATH\n\n
remote: .\nspecs:\n ruby-client (1.0.0)\n oj (~> 2.15)\n
GEM\n"],["LICENSE","","LICENSE.html","","\n
Apache License\n Version 2.0, January 2004\nhttp://www.apache.org/licenses/\n
TERMS AND CONDITIONS …\n"],["Rakefile","","Rakefile.html","","
# require “bundler/gem_tasks” require “rake/testtask”\n
Rake::TestTask.new do |t|\n\n
t.pattern ...\n\n"],["setup","","bin/setup.html","","
#!/usr/bin/env bash set -euo pipefail IFS=$'nt' set -vx\n
bundle install\n"],["readme","","readme_md.html","","
Nimiq Ruby RPC Client\n\n
\nRuby implementation of the Nimiq RPC client specs.\n
Info\n"]]}}