ruby-client 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f91d1357cebee6d662eff00309fa181670968f188ae0d80b45e0212871baea1
-  data.tar.gz: 5a3e51a481c1f925e6cde7b8755fd16a11518371a1572f6f6f6e4811b9f60c81
+  metadata.gz: 35d36e085b3b62d4f91a7265548b390421e6feeefe8473e4d1a7bfd327b89755
+  data.tar.gz: a278f24af7c7ae31b3ee4c941495fe451f56d84b9a211de32a649a328b7c6c40
 SHA512:
-  metadata.gz: 94936b259bd28aa4011861b39b6569a6950fb712bd0c74cee23650e8294440f79de092d973db808d071b978e1d71096118e0a67898c76261f80d8e948c5a9faa
-  data.tar.gz: 1c117e1ca9bbd5c7ad090b0d89910ad278625513bdfd0a2998694ef3bb7a1f1f6055c77bb4fb38ae68307dbbcd8596554ffcd0c856084aa8a14c649ecfdfdf52
+  metadata.gz: 6c351e529143d5315e911e06b85b30319f5276ef97afd9ade2bc53a0c98ae1b51130b20fc8f168f765571e4b25d2b59ad6cf12d34f0680bd0828f30162ccc660
+  data.tar.gz: b5f999bacad15ce501218cc29a4f1200702faf9a3a5b981567abcb7ebe986b9ea15ca47c5c5292a53f964aaf6a4a6454eb36d8d794851fba1b99a829d9df2a58

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rspec-rails", "~> 3.5"

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    ruby-client (1.0.2)
+      oj (~> 2.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    i18n (1.8.4)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nokogiri (1.10.10-x64-mingw32)
+      mini_portile2 (~> 2.4.0)
+    oj (2.18.5)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rspec-rails (~> 3.5)
+  ruby-client!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,49 @@
+# Nimiq Ruby RPC Client
+
+> Ruby implementation of the Nimiq RPC client specs.
+
+## Info
+
+Nimiq Ruby RPC client. It will allow you to interact with the Nimiq Blockchain, to collect data, sync with the network etc.. This library covers all the current [Nimiq JSON-RPC specification](https://github.com/nimiq/core-js/wiki/JSON-RPC-API#remotejs-client).
+
+# What is Nimiq?
+
+Inspired by the Bitcoin, Nimiq is a blockchain / cryptocurrency that runs in your browser seamlessly.
+
+Fast, easy and fun to use, for more information visit the [Nimiq website](https://www.nimiq.com/).
+
+### Usage
+
+Example to use this ruby client:
+
+```ruby
+options = {
+  host: "http://127.0.0.1",
+  port: "8000",
+  # user: "user",
+  # pass: "pass",
+  # uri: "http://USER:PASS@IP:PORT",
+}
+nimiq = Nimiq::Client.new(options)
+consensus = nimiq.consensus()
+get_balance = nimiq.get_balance("NQ27 B9ED 98G5 3VH7 FY8D BFP0 XNF4 BD8L TN4B")
+
+puts "Consensus #{consensus}"
+puts "My account balance #{get_balance}"
+```
+
+## Development
+
+This section is for developments. If you only want to use this client go to the [Usage](#Usage) section. After cloning the repo, run `bundle` to install the required dependencies. For testing it requires a running Nimiq RPC node, to connect to. You can then run tests by typing `rspec --format documentation`.
+
+For a private node connection that require a username/password, don't forget to set these in the configuration spec file.
+
+## Contributions
+
+This implementation was originally contributed by [jxdv](https://github.com/jxdv/).
+
+Bug reports and pull requests are welcome.
+
+## License
+
+[Apache 2.0](LICENSE)

data/Rakefile

@@ -0,0 +1,14 @@
+# require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << "test"
+#   t.libs << "lib"
+#   t.test_files = FileList["test/**/*_test.rb"]
+# end
+
+# task :default => :test

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "nimiq"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/api.rb

@@ -0,0 +1,317 @@
+=begin
+  Copyright 2020 Nimiq community.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+module Api
+  attr_accessor :rpc
+
+  # accounts - Returns a list of addresses owned by client.
+  def accounts
+    result = @rpc.request("accounts")
+    return result
+  end
+
+  # block_number - Returns the height of most recent block.
+  def block_number
+    result = @rpc.request("blockNumber")
+    return result
+  end
+
+  # consensus - Returns information on the current consensus state.
+  def consensus
+    result = @rpc.request("consensus")
+    return result
+  end
+
+  # constant - Returns or overrides a constant value.
+  # When no parameter is given, it returns the value of the constant.
+  # When giving a value as parameter, it sets the constant to the given value.
+  # To reset the constant to the default value, the parameter "reset" should be used.
+  # - @param [String] name - The class and name of the constant. (format should be Class.CONSTANT)
+  # - @param [Integer] value - The new value of the constant or "reset". (optional)
+  def constant(name, value = nil)
+    if value
+      result = @rpc.request("constant", name, value)
+    else
+      result = @rpc.request("constant", name)
+    end
+    return result
+  end
+
+  # create_account - Creates a new account and stores its private key in the client store.
+  def create_account
+    result = @rpc.request("createAccount")
+    return result
+  end
+
+  # create_raw_transaction - Creates and signs a transaction without sending it.
+  # The transaction can then be send via `send_raw_transaction` without accidentally replaying it.
+  # - @param [TransactionObject] transaction - The transaction object.
+  def create_raw_transaction(transaction)
+    result = @rpc.request("createRawTransaction", transaction)
+    return result
+  end
+
+  # # new: update with more info
+  # # get_raw_transaction_info - Checks signed_transaction raw information.
+  # # - @param [String] signed_transaction - The hex encoded signed transaction.
+  # def get_raw_transaction_info(signed_transaction)
+  #   result = @rpc.request("getRawTransactionInfo", signed_transaction)
+  #   return result
+  # end
+
+  # get_account - Returns details for the account of given address.
+  # - @param [String] address - Address to get account details.
+  def get_account(address)
+    result = @rpc.request("getAccount", address)
+    return result
+  end
+
+  # get_balance - Returns the balance of the account of given address.
+  # - @param [String] address - Address to check for balance.
+  def get_balance(address)
+    result = @rpc.request("getBalance", address)
+    return result
+  end
+
+  # get_block_by_hash - Returns information about a block by hash.
+  # - @param [String] block_hash - Hash of the block to gather information on.
+  # - @param [Boolean] full_transactions (optional) - If true it returns the full transaction objects, if false only the hashes of the transactions. (default false)
+  def get_block_by_hash(block_hash, full_transactions = nil)
+    if full_transactions
+      result = @rpc.request("getBlockByHash", block_hash, full_transactions)
+    else
+      result = @rpc.request("getBlockByHash", block_hash)
+    end
+    return result
+  end
+
+  # get_block_by_number - Returns information about a block by block number.
+  # - @param [Integer] block_number - The height of the block to gather information on.
+  # - @param [Boolean] full_transactions (optional) - If true it returns the full transaction objects, if false only the hashes of the transactions. (default false)
+  def get_block_by_number(block_number, full_transactions = nil)
+    if full_transactions
+      result = @rpc.request("getBlockByNumber", block_number, full_transactions)
+    else
+      result = @rpc.request("getBlockByNumber", block_number)
+    end
+    return result
+  end
+
+  # get_block_template - Returns a template to build the next block for mining.
+  # This will consider pool instructions when connected to a pool.
+  # - @param [String] address (optional) - Address to use as a miner for this block. This overrides the address provided during startup or from the pool.
+  # - @param [String] dada_field (optional) - Hex-encoded value for the extra data field. This overrides the address provided during startup or from the pool.
+  def get_block_template(address = nil, dada_field = nil)
+    result = @rpc.request("getBlockTemplate")
+    return result
+  end
+
+  # get_block_transaction_count_by_hash - Returns the number of transactions in a block from a block matching the given block hash.
+  # - @param [String] block_hash - Hash of the block.
+  def get_block_transaction_count_by_hash(block_hash)
+    result = @rpc.request("getBlockTransactionCountByHash", block_hash)
+    return result
+  end
+
+  # get_block_transaction_count_by_number - Returns the number of transactions in a block matching the given block number.
+  # - @param [Integer] block_number - Height of the block.
+  def get_block_transaction_count_by_number(block_number)
+    result = @rpc.request("getBlockTransactionCountByNumber", block_number)
+    return result
+  end
+
+  # get_transaction_by_block_hash_and_index - Returns information about a transaction by block hash and transaction index position.
+  # - @param [Integer] block_hash - Hash of the block containing the transaction.
+  # - @param [Integer] transaction_index - Index of the transaction in the block.
+  def get_transaction_by_block_hash_and_index(block_hash, transaction_index)
+    result = @rpc.request("getTransactionByBlockHashAndIndex", block_hash, transaction_index)
+    return result
+  end
+
+  # get_transaction_by_block_number_and_index - Returns information about a transaction by block number and transaction index position.
+  # - @param [Integer] block_height - Height of the block containing the transaction.
+  # - @param [Integer] transaction_index - Index of the transaction in the block.
+  def get_transaction_by_block_number_and_index(block_height, transaction_index)
+    result = @rpc.request("getTransactionByBlockNumberAndIndex", block_height, transaction_index)
+    return result
+  end
+
+  # get_transaction_by_hash - Returns the information about a transaction requested by transaction hash.
+  # - @param [String] transaction_hash - Hash of a transaction.
+  def get_transaction_by_hash(transaction_hash)
+    result = @rpc.request("getTransactionByHash", transaction_hash)
+    return result
+  end
+
+  # get_transaction_receipt - Returns the receipt of a transaction by transaction hash.
+  # Note That the receipt is not available for pending transactions.
+  # - @param [String] transaction_hash - Hash of a transaction.
+  def get_transaction_receipt(transaction_hash)
+    result = @rpc.request("getTransactionReceipt", transaction_hash)
+    return result
+  end
+
+  # get_transactions_by_address - Returns the latest transactions successfully performed by or for an address.
+  # - @param [String] address - Address of which transactions should be gathered.
+  # - @param [Integer] transactions_number (optional) - Number of transactions that shall be returned. (default 1000)
+  def get_transactions_by_address(address, transactions_number = nil)
+    if transactions_number
+      result = @rpc.request("getTransactionsByAddress", address, transactions_number)
+    else
+      result = @rpc.request("getTransactionsByAddress", address)
+    end
+    return result
+  end
+
+  # get_work - Returns instructions to mine the next block. This will consider pool instructions when connected to a pool.
+  # - @param [String] address (optional) - Address to use as a miner for this block. This overrides the address provided during startup or from the pool.
+  # - @param [String] dada_field (optional) - Hex-encoded value for the extra data field. This overrides the address provided during startup or from the pool.
+  def get_work(address = nil, dada_field = nil)
+    result = @rpc.request("getWork", address, dada_field)
+    return result
+  end
+
+  # hashrate - Returns the number of hashes per second that the node is mining with.
+  def hashrate
+    result = @rpc.request("hashrate")
+    return result
+  end
+
+  # log - Sets the log level of the node.
+  # - @param [String] tag - If the tag is '*' the log level will be set globally, otherwise the log level is applied only on this tag.
+  # - @param [String] log_level - Log levels valid options: `trace`, `verbose`, `debug`, `info`, `warn`, `error`, `assert`.
+  def log(tag, log_level)
+    result = @rpc.request("log", tag, log_level)
+    return result
+  end
+
+  # mempool - Returns information on the current mempool situation. This will provide an overview of the number of transactions sorted into buckets based on their fee per byte (in smallest unit).
+  def mempool
+    result = @rpc.request("mempool")
+    return result
+  end
+
+  # mempool_content - Returns transactions that are currently in the mempool.
+  def mempool_content
+    result = @rpc.request("mempoolContent")
+    return result
+  end
+
+  # miner_address - Returns the miner address.
+  def miner_address
+    result = @rpc.request("minerAddress")
+    return result
+  end
+
+  # miner_threads - Returns or sets the number of CPU threads for the miner.
+  # - @param [Integer] set_threads (optional) - The number of threads to allocate for mining.
+  def miner_threads(set_threads = nil)
+    if set_threads
+      result = @rpc.request("minerThreads", set_threads)
+    else
+      result = @rpc.request("minerThreads")
+    end
+    return result
+  end
+
+  # min_fee_per_byte - Returns or sets the minimum fee per byte.
+  # - @param [Integer] set_min_fee (optional) - The new minimum fee per byte.
+  def min_fee_per_byte(set_min_fee = nil)
+    if set_min_fee
+      result = @rpc.request("minFeePerByte", set_min_fee)
+    else
+      result = @rpc.request("minFeePerByte")
+    end
+    return result
+  end
+
+  # mining - Returns `true` if client is actively mining new blocks.
+  def mining
+    result = @rpc.request("mining")
+    return result
+  end
+
+  # peer_count - Returns number of peers currently connected to the client.
+  def peer_count
+    result = @rpc.request("peerCount")
+    return result
+  end
+
+  # peer_list - Returns list of peers known to the client.
+  def peer_list
+    result = @rpc.request("peerList")
+    return result
+  end
+
+  # peer_state - Returns the state of the peer.
+  # - @param [String] peer_address - The address of the peer.
+  def peer_state(peer_address)
+    result = @rpc.request("peerState", peer_address)
+    return result
+  end
+
+  # pool - Returns or sets the mining pool.
+  # When no parameter is given, it returns the current mining pool. When a value is given as parameter, it sets the mining pool to that value.
+  # - @param [String/Boolean] pool_address (optional) - The mining pool connection string (url:port) or boolean to enable/disable pool mining.
+  def pool(pool_address = nil)
+    if pool_address
+      result = @rpc.request("pool", pool_address)
+    else
+      result = @rpc.request("pool")
+    end
+    return result
+  end
+
+  # pool_confirmed_balance - Returns the confirmed mining pool balance.
+  def pool_confirmed_balance
+    result = @rpc.request("poolConfirmedBalance")
+    return result
+  end
+
+  # pool_connection_state - Returns the connection state to mining pool.
+  def pool_connection_state
+    result = @rpc.request("poolConnectionState")
+    return result
+  end
+
+  # send_raw_transaction - Sends a signed message call transaction or a contract creation, if the data field contains code.
+  # - @param [String] signed_transaction - The hex encoded signed transaction.
+  def send_raw_transaction(signed_transaction)
+    result = @rpc.request("sendRawTransaction", signed_transaction)
+    return result
+  end
+
+  # send_transaction - Creates new message call transaction or a contract creation, if the data field contains code.
+  # - @param [TransactionObject] transaction - The transaction object.
+  def send_transaction(transaction)
+    result = @rpc.request("sendTransaction", transaction)
+    return result
+  end
+
+  # submit_block - Submits a block to the node. When the block is valid, the node will forward it to other nodes in the network.
+  # When submitting work from getWork, remember to include the suffix.
+  # - @param [String] block - Hex-encoded full block (including header, interlink and body).
+  def submit_block(block)
+    result = @rpc.request("submitBlock", block)
+    return result
+  end
+
+  # syncing - Returns an object with data about the sync status or `false`.
+  def syncing
+    result = @rpc.request("syncing")
+    return result
+  end
+end

data/lib/rpcclient.rb

@@ -0,0 +1,108 @@
+=begin
+  Copyright 2020 Nimiq community.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+require "oj"
+require "net/http"
+
+# :nodoc: all
+module ClientRPC
+  class Connect
+    attr_accessor :options, :uri
+
+    DEFAULTS = {
+      host: "localhost",
+      port: 18332,
+    # dev: true,
+    }.freeze
+
+    def initialize(host)
+      @options = DEFAULTS.dup.merge(host.dup)
+      @uri = @options[:uri] ? URI(@options[:uri]) : URI(uri_check())
+    end
+
+    def request(name, *args)
+      puts "\n> #{name}: #{args.join(",")}" if options[:dev]
+      response = request_http_post(name, args)
+      puts "< #{response.code} #{response.message}" if options[:dev]
+      raise Error, response.message unless (200...300).cover?(response.code.to_i)
+      begin
+        response = Oj.load(response.body, symbol_keys: true, bigdecimal_load: true)
+      rescue StandardError => e
+        puts "WARN < Failed to parse JSON response: #{e}" if options[:dev]
+        raise
+      end
+      puts "\n> #{name}: #{args.join(",")}" if options[:dev]
+      puts response[:result] if options[:dev]
+      raise Error, response[:error] if response[:error]
+      response[:result]
+    end
+
+    def ping_node
+      user = uri.user
+      pass = uri.password
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.basic_auth(user, pass)
+      request.body = request_body("", nil)
+      request["Content-Type"] = "application/json".freeze
+      response = http.request(request)
+      @pingres = (response.code).to_i.dup
+    end
+
+    private
+
+    def request_http_post(name, params)
+      user = uri.user
+      pass = uri.password
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.basic_auth(user, pass)
+      request.body = request_body(name, params)
+      request["Content-Type"] = "application/json".freeze
+      http.request(request)
+    end
+
+    def request_body(name, params)
+      Oj.dump({
+        id: "rpc",
+        jsonrpc: "2.0",
+        method: name,
+        params: params,
+      }, mode: :compat)
+    end
+
+    def uri_check
+      if (options[:host].include? "http://" or options[:host].include? "https://")
+        host = options[:host]
+        newhost = url_strip(host.dup)
+        if (options[:host].include? "https")
+          return "https://#{options[:user]}:#{options[:pass]}@#{newhost}:#{options[:port]}"
+        else
+          return "http://#{options[:user]}:#{options[:pass]}@#{newhost}:#{options[:port]}"
+        end
+      else
+        return "http://#{options[:user]}:#{options[:pass]}@#{options[:host]}:#{options[:port]}"
+      end
+    end
+
+    def url_strip(url)
+      return url.to_s.sub!(/https?(\:)?(\/)?(\/)?(www\.)?/, "") if url.include?("http")
+      url.to_s.sub!(/(www\.)?/, "") if url.include?("www")
+    end
+
+    class Error < RuntimeError; end
+  end
+end

data/lib/ruby-client.rb

@@ -0,0 +1,46 @@
+=begin
+  Copyright 2020 Nimiq community.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+require_relative "nimiq/version"
+require_relative "rpcclient"
+require_relative "api"
+require "json"
+
+module Nimiq
+  class Error < StandardError; end # :nodoc: all
+
+  attr_reader :rpc # :nodoc: all
+
+  class Client
+    include Api
+
+    def initialize(opts)
+      return @rpc = ClientRPC::Connect.new(opts)
+      puts "Connecting to #{@opts}"
+    end
+
+    # Sends a raw request to the Nimiq node.
+    def request(name, params = nil)
+      return @rpc.request(name, params)
+    end
+
+    # Ping the Nimiq node.
+    def ping
+      @rpc.ping_node
+      @pingres = @rpc.instance_variable_get(:@pingres)
+    end
+  end
+end

data/main.rb

@@ -0,0 +1,153 @@
+require_relative "./lib/ruby-client"
+require "json"
+
+# :main: README.MD
+options = {
+  host: "http://127.0.0.1",
+  port: "8005",
+  user: "user",
+  pass: "pass",
+  dev: true,
+# uri: "http://USER:PASS@IP:PORT",
+}
+
+nimiq = Nimiq::Client.new(options)
+puts "nimiq init #{nimiq}"
+
+# nimiq.ping
+# print ">>> ", nimiq.instance_variable_get(:@pingres)
+
+consensus = nimiq.request("consenasus")
+puts "custom #{consensus}"
+
+# accounts = nimiq.accounts()
+# puts "accounts #{accounts}"
+
+# blockNumber = nimiq.block_number()
+# puts "blockNumber #{blockNumber}"
+
+# consensus = nimiq.consensus()
+# puts "consensus #{consensus}"
+
+# constant = nimiq.constant("BaseConsensus.MAX_ATTEMPTS_TO_FETCH", 10)
+# puts "constant #{constant}"
+
+# createAccount = nimiq.create_account()
+# puts "createAccount #{createAccount}"
+
+# transaction = {
+#   "from": "NQ94 VESA PKTA 9YQ0 XKGC HVH0 Q9DF VSFU STSP",
+#   "to": "NQ16 61ET MB3M 2JG6 TBLK BR0D B6EA X6XQ L91U",
+#   "value": 100000,
+#   "fee": 0,
+# }
+# createRawTransaction = nimiq.create_raw_transaction(transaction)
+# puts "createRawTransaction #{createRawTransaction}"
+
+# # new
+# getRawTransactionInfo = nimiq.get_raw_transaction_info("010000...abcdef")
+# puts "getRawTransactionInfo #{getRawTransactionInfo}"
+
+# getAccount = nimiq.get_account("NQ30 JLD6 U347 DFVU 40J3 F93V 9TCF YMMX RKY3")
+# puts "GetAccount #{getAccount}"
+
+# getBalance = nimiq.get_balance("NQ30 JLD6 U347 DFVU 40J3 F93V 9TCF YMMX RKY3")
+# puts "GetBalance #{getBalance}"
+
+# getBlockByHash = nimiq.get_block_by_hash("14c91f6d6f3a0b62271e546bb09461231ab7e4d1ddc2c3e1b93de52d48a1da87", true)
+# puts "getBlockByHash #{getBlockByHash}"
+
+# getBlockByNumber = nimiq.get_block_by_number(76415, true)
+# puts "getBlockByNumber #{getBlockByNumber}"
+
+# getBlockTemplate = nimiq.get_block_template()
+# puts "getBlockTemplate #{getBlockTemplate}"
+
+# getBlockTransactionCountByHash = nimiq.get_block_transaction_count_by_hash("dfe7d166f2c86bd10fa4b1f29cd06c13228f893167ce9826137c85758645572f")
+# puts "getBlockTransactionCountByHash #{getBlockTransactionCountByHash}"
+
+# getBlockTransactionCountByNumber = nimiq.get_block_transaction_count_by_number(76415)
+# puts "getBlockTransactionCountByNumber #{getBlockTransactionCountByNumber}"
+
+# getTransactionByBlockHashAndIndex = nimiq.get_transaction_by_block_hash_and_index("dfe7d166f2c86bd10fa4b1f29cd06c13228f893167ce9826137c85758645572f", 20)
+# puts "getTransactionByBlockHashAndIndex #{getTransactionByBlockHashAndIndex}"
+
+# getTransactionByBlockNumberAndIndex = nimiq.get_transaction_by_block_number_and_index(76415, 20)
+# puts "getTransactionByBlockNumberAndIndex #{getTransactionByBlockNumberAndIndex}"
+
+# getTransactionByHash = nimiq.get_transaction_by_hash("9eb228482138a8e64c5bb60608979904aa2be5721c115a9e3db54a0c481bb398")
+# puts "getTransactionByHash #{getTransactionByHash}"
+
+# getTransactionReceipt = nimiq.get_transaction_receipt("465a63b73aa0b9b54b777be9a585ea00b367a17898ad520e1f22cb2c986ff554")
+# puts "getTransactionReceipt #{getTransactionReceipt}"
+
+# getTransactionsByAddress = nimiq.get_transactions_by_address("NQ699A4AMB83HXDQ4J46BH5R4JFFQMA9C3GN", 100)
+# puts "getTransactionsByAddress #{getTransactionsByAddress}"
+
+# getWork = nimiq.get_work()
+# puts "getWork #{getWork}"
+
+# hashrate = nimiq.hashrate()
+# puts "hashrate #{hashrate}"
+
+# log = nimiq.log("BaseConsensus", "debug")
+# puts "log #{log}"
+
+# mempool = nimiq.mempool()
+# puts "mempool #{mempool}"
+
+# mempoolContent = nimiq.mempool_content()
+# puts "mempoolContent #{mempoolContent}"
+
+# minerAddress = nimiq.miner_address()
+# puts "minerAddress #{minerAddress}"
+
+# minerThreads = nimiq.miner_threads(2)
+# puts "minerThreads #{minerThreads}"
+
+# minFeePerByte = nimiq.min_fee_per_byte(0)
+# puts "minFeePerByte #{minFeePerByte}"
+
+# mining = nimiq.mining()
+# puts "mining #{mining}"
+
+# peerCount = nimiq.peer_count()
+# puts "peerCount #{peerCount}"
+
+# peerList = nimiq.peer_list()
+# puts "peerList #{peerList}"
+
+# peerState = nimiq.peer_state("wss://seed-1.nimiq.com:8443/dfd55fe967d6c0ca707d3a73ec31e4ac")
+# puts "peerState #{peerState}"
+
+# pool = nimiq.pool("eu.nimpool.io:8444")
+# puts "pool #{pool}"
+
+# poolConfirmedBalance = nimiq.pool_confirmed_balance()
+# puts "poolConfirmedBalance #{poolConfirmedBalance}"
+
+# poolConnectionState = nimiq.pool_connection_state()
+# puts "poolConnectionState #{poolConnectionState}"
+
+# sendRawTransaction = nimiq.send_raw_transaction("010000...abcdef")
+# puts "sendRawTransaction #{sendRawTransaction}"
+
+# transaction = {
+#   "from": "NQ94 VESA PKTA 9YQ0 XKGC HVH0 Q9DF VSFU STSP",
+#   "to": "NQ16 61ET MB3M 2JG6 TBLK BR0D B6EA X6XQ L91U",
+#   "value": 100000,
+#   "fee": 0,
+# }
+# sendTransaction = nimiq.send_transaction(transaction)
+# puts "sendTransaction #{sendTransaction}"
+
+# block="0000000"
+# submitBlock = nimiq.submit_block(block)
+# puts "submitBlock #{submitBlock}"
+
+# syncing = nimiq.syncing()
+# puts "syncing #{syncing}"
+
+# require_relative "./lib/ruby-client"
+# aaaaaaaa = Nimiq::Client.new()
+# puts aaaaaaaa.world

data/ruby-client.gemspec

@@ -0,0 +1,32 @@
+# lib = File.expand_path("lib", __dir__)
+# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# require "nimiq/version"
+require_relative "lib/ruby-client"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-client"
+  spec.version = Nimiq::VERSION
+  spec.authors = ["jxdv"]
+  spec.email = ["root@localhost"]
+
+  spec.summary = %q{Ruby implementation of the Nimiq RPC client specifications.}
+  spec.homepage = "https://github.com/jxdv/ruby-client"
+  spec.license = "Apache-2.0"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jxdv/ruby-client"
+  spec.metadata["changelog_uri"] = "https://github.com/jxdv/ruby-client/readme.md"
+
+  spec.add_dependency "oj", "~> 2.15"
+
+  spec.files = Dir["lib/*.rb"] + Dir["lib/rubyclient/*.rb"] + Dir["bin/*"]
+  spec.files += Dir["[A-Z]*"] + Dir["test/**/*"]
+  spec.files.reject! { |fn| fn.include? "CVS" }
+  # spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+  #   `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - jxdv
@@ -31,7 +31,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/nimiq.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/api.rb
+- lib/rpcclient.rb
+- lib/ruby-client.rb
+- main.rb
+- ruby-client-1.0.0.gem
+- ruby-client-1.0.1.gem
+- ruby-client-1.0.2.gem
+- ruby-client-1.0.3.gem
+- ruby-client-1.0.4.gem
+- ruby-client-1.0.5.gem
+- ruby-client-1.1.1.gem
+- ruby-client-1.1.2.gem
+- ruby-client.gemspec
+- rubyclient-1.0.0.gem
 homepage: https://github.com/jxdv/ruby-client
 licenses:
 - Apache-2.0

data/lib/nimiq.rb

@@ -1,58 +0,0 @@
-# =begin
-#   Copyright 2020 Nimiq community.
-
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-# =end
-
-# require_relative "nimiq/version"
-# require_relative "rpcclient"
-# require_relative "api"
-# require "json"
-
-# module Nimiq
-#   class Error < StandardError; end # :nodoc: all
-
-#   attr_reader :rpc # :nodoc: all
-
-#   class Client
-#     include Api
-
-#     def initialize(opts)
-#       return @rpc = ClientRPC::Connect.new(opts)
-#       puts "Connecting to #{@opts}"
-#     end
-
-#     # Sends a raw request to the Nimiq node.
-#     def request(name, params = nil)
-#       return @rpc.request(name, params)
-#     end
-
-#     # Ping the Nimiq node.
-#     def ping
-#       @rpc.ping_node
-#       @pingres = @rpc.instance_variable_get(:@pingres)
-#     end
-#   end
-# end
-
-require "nimiq/version"
-
-module Nimiq
-  class Error < StandardError; end
-
-  class Client
-    def world
-      puts "hey world"
-    end
-  end
-end