blockchain-node 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84fc82f7e1b3fc091280581c9fbf718f96993914d0bd2e8d81812ade1cf9a5f9
+  data.tar.gz: 51b0caecb2abe1986ec3967d56c6f7287563bf1a719d5e27eeb87e8c74faf857
+SHA512:
+  metadata.gz: e8a31a95fdbaf5631d74cbcaab974f6c09fcf98cce1dccc9c15ad08fadfce9e1181e8a190440005c58841406edea14afc121cd01cf5c17a851488a5695b98fbc
+  data.tar.gz: 48104e3e93f3d8d631f9569f233f772eb8582014ad93f3099cdaebb145e7c7ee464a208fc54effaae994e389f3fa6e2eaa2d263c5fd7d200f127b06f86bc1e58

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README-RPC-BTC.md

@@ -0,0 +1,55 @@
+# Bitcoin RPC Methods Calls
+
+
+```
+backupwallet "destination"
+bumpfee "txid" ( options )
+createwallet "wallet_name" ( disable_private_keys )
+dumpprivkey "address"
+dumpwallet "filename"
+encryptwallet "passphrase"
+getaddressesbylabel "label"
+getaddressinfo "address"
+getbalance ( "dummy" minconf include_watchonly )
+getnewaddress ( "label" "address_type" )
+getrawchangeaddress ( "address_type" )
+getreceivedbyaddress "address" ( minconf )
+getreceivedbylabel "label" ( minconf )
+gettransaction "txid" ( include_watchonly )
+getunconfirmedbalance
+getwalletinfo
+importaddress "address" ( "label" rescan p2sh )
+importmulti "requests" ( "options" )
+importprivkey "privkey" ( "label" rescan )
+importprunedfunds "rawtransaction" "txoutproof"
+importpubkey "pubkey" ( "label" rescan )
+importwallet "filename"
+keypoolrefill ( newsize )
+listaddressgroupings
+listlabels ( "purpose" )
+listlockunspent
+listreceivedbyaddress ( minconf include_empty include_watchonly "address_filter" )
+listreceivedbylabel ( minconf include_empty include_watchonly )
+listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )
+listtransactions ( "label" count skip include_watchonly )
+listunspent ( minconf maxconf ["address",...] include_unsafe query_options )
+listwalletdir
+listwallets
+loadwallet "filename"
+lockunspent unlock ( [{"txid":"hex","vout":n},...] )
+removeprunedfunds "txid"
+rescanblockchain ( start_height stop_height )
+sendmany "" {"address":amount} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode" )
+sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode" )
+sethdseed ( newkeypool "seed" )
+setlabel "address" "label"
+settxfee amount
+signmessage "address" "message"
+signrawtransactionwithwallet "hexstring" ( [{"txid":"hex","vout":n,"scriptPubKey":"hex","redeemScript":"hex","amount":amount},...] "sighashtype" )
+unloadwallet ( "wallet_name" )
+walletcreatefundedpsbt [{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount},{"data":"hex"},...] ( locktime options bip32derivs )
+walletlock
+walletpassphrase "passphrase" timeout
+walletpassphrasechange "oldpassphrase" "newpassphrase"
+walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs )
+```

data/README-RPC-ETH.md

@@ -0,0 +1,61 @@
+# Ethereum RPC Methods Calls
+
+
+```
+
+web3_clientVersion
+web3_sha3
+net_version
+net_peerCount
+net_listening
+eth_protocolVersion
+eth_syncing
+eth_coinbase
+eth_mining
+eth_hashrate
+eth_gasPrice
+eth_accounts
+eth_blockNumber
+eth_getBalance
+eth_getStorageAt
+eth_getTransactionCount
+eth_getBlockTransactionCountByHash
+eth_getBlockTransactionCountByNumber
+eth_getUncleCountByBlockHash
+eth_getUncleCountByBlockNumber
+eth_getCode
+eth_sign
+eth_sendTransaction
+eth_sendRawTransaction
+eth_call
+eth_estimateGas
+eth_getBlockByHash
+eth_getBlockByNumber
+eth_getTransactionByHash
+eth_getTransactionByBlockHashAndIndex
+eth_getTransactionByBlockNumberAndIndex
+eth_getTransactionReceipt
+eth_getUncleByBlockHashAndIndex
+eth_getUncleByBlockNumberAndIndex
+eth_getCompilers
+eth_compileLLL
+eth_compileSolidity
+eth_compileSerpent
+eth_newFilter
+eth_newBlockFilter
+eth_newPendingTransactionFilter
+eth_uninstallFilter
+eth_getFilterChanges
+eth_getFilterLogs
+eth_getLogs
+eth_getWork
+eth_submitWork
+eth_submitHashrate
+eth_getProof
+db_putString
+db_getString
+db_putHex
+db_getHex
+
+
+```

data/README.md

@@ -0,0 +1,75 @@
+# BlockchainNode (BCN) Ruby Client
+
+This gem is a secure RPC wrapper to connect to nodes launched by 
+[https://blockchainnode.io](https://blockchainnode.io). 
+
+Provides a Ruby library to the complete Bitcoin JSON-RPC API. Implements all methods listed
+at {https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list}[https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list].
+Also supports customizing the host and port number to connect to.
+
+## Installation and Configuration
+
+```bash
+gem install blockchain-node
+```
+
+The client is secured using a client-credentials OAUTH flow. You can generate API keys in your BCN account. 
+
+If you are using a Rails application, add the following initializer to `config/initializers/blockchain_node.rb`
+ 
+```ruby
+BlockchainNode.configure do |config|
+  config.client_id = "CLIENT_ID"
+  config.client_secret = "CLIENT_SECRET"
+end
+```
+
+**Security Note:**
+It is recommended that you secure your `CLIENT_ID` and `CLIENT_SECRET` and do not check that into your code repo.
+If your `CLIENT_ID` and `CLIENT_SECRET` are comprimised, your wallet will be secure as long as the it is
+encrypted and not left unlocked.
+
+
+## Usage
+
+### Initialize the library
+
+```ruby
+# the node ID from your BCN console
+node_id = "123ABC"
+client = BlockchainNode::Client.new(node_id)
+```
+
+### Bitcoin Example
+
+
+[Link to RPC Calls](README-RPC-BTC.md)
+
+### Ethereum Example
+
+Make any RPC method call directly. Pass in parameters as args to the method call.
+
+Notice, for geth, responses are returned in hex so they have to be converted to an integer.
+
+Balances are stored as integers with 18 decimals of spacing (wei).  Convert to ether.
+[Helpful Calculator](https://etherconverter.online/) 
+
+```ruby
+resp = client.eth_blockNumber
+Integer(resp[:response])
+
+client.personal_listAccounts
+
+resp = client.eth_getBalance("0xf4c2a25fcbaad4e568fb74d6644b164e999d3132", "latest")
+Integer(resp[:response]) / 1000000000000000000.0
+```
+
+[Link to RPC Calls](README-ETH-BTC.md)
+
+## Contact
+
+Comments and feedback are welcome. Send an email to matt at blockchainnode.io.
+
+## License
+
+This code is free to use under the terms of the MIT license.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/lib/blockchain-node/client.rb

@@ -0,0 +1,68 @@
+module BlockchainNode
+  class Client
+
+    @@_auth_token
+    AuthToken = Struct.new(:token, :expires_at)
+
+    attr_reader :node_id
+    attr_accessor :configuration
+
+    def initialize(node_id)
+      @node_id = node_id
+      # allow a different configuration per client instance
+      @configuration = BlockchainNode::Configuration.new
+    end
+
+    # convenience method to get nodes index
+    def nodes
+      request.get(path: node_index_path, auth_token: auth_token)
+    end
+
+    def auth_token
+      @@_auth_token ||= get_new_auth_token
+      @@_auth_token = get_new_auth_token if auth_token_expired?
+      @@_auth_token.token
+    end
+
+    private
+
+    # catch all other method calls and assume its the RPC method call
+    def method_missing(method, *args, &block)
+      data = { method: method, parameters: args }
+      request.post(path: nodes_path, data: data, auth_token: auth_token)
+    end
+
+    def auth_token_expired?
+      @@_auth_token.nil? || @@_auth_token.expires_at < Time.now.utc - 30
+    end
+
+    def get_new_auth_token
+      data = {
+        grant_type: "client_credentials",
+        client_id: configuration.client_id,
+        client_secret: configuration.client_secret,
+      }
+      response = request.post(path: oauth_token_path, data: data)
+      token = response["access_token"]
+      expires_at = Time.at(response["created_at"] + response["expires_in"]).utc
+      AuthToken.new(token, expires_at)
+    end
+
+    def request
+      @request ||= BlockchainNode::Request.new(configuration.request_options)
+    end
+
+    def oauth_token_path
+      "/oauth/token"
+    end
+
+    def node_index_path
+      "/api/nodes"
+    end
+
+    def nodes_path
+      "/api/nodes/#{@node_id}"
+    end
+
+  end
+end

data/lib/blockchain-node/configuration.rb

@@ -0,0 +1,24 @@
+module BlockchainNode
+  class Configuration
+    ATTRIBUTES = [:client_id, :client_secret, :request_options]
+
+    # class attributes
+    class << self
+      ATTRIBUTES.each do |attr|
+        attr_accessor attr
+      end
+    end
+
+    # instance attributes
+    ATTRIBUTES.each do |attr|
+      attr_accessor attr
+    end
+
+    def initialize
+      @client_id = self.class.client_id
+      @client_secret = self.class.client_secret
+      @request_options = self.class.request_options || {}
+    end
+
+  end
+end

data/lib/blockchain-node/errors.rb

@@ -0,0 +1,7 @@
+module BlockchainNode
+  module Errors
+    class BadRequest < StandardError; end
+    class UnAuthorized < StandardError; end
+    class Unknown < StandardError; end
+  end
+end

data/lib/blockchain-node/request.rb

@@ -0,0 +1,64 @@
+require 'json'
+require 'net/http'
+
+module BlockchainNode
+  class Request
+
+    DEFAULT_BASE_URL = "https://api.blockchainnode.io"
+
+    def initialize(options)
+      @host = options[:host] || DEFAULT_BASE_URL
+      @read_timeout = options[:read_timeout] || 45
+      @open_timeout = options[:open_timeout] || 3
+    end
+
+    def get(path:, auth_token:)
+      uri = URI(@host + path)
+
+      request = Net::HTTP::Get.new(uri)
+      request['Content-Type'] = "application/json"
+      request['Authorization'] = "Bearer #{auth_token}" if auth_token
+
+      process_request(uri, request)
+    end
+
+    def post(path:, data: {}, auth_token: nil)
+      uri = URI(@host + path)
+
+      request = Net::HTTP::Post.new(uri)
+      request['Content-Type'] = "application/json"
+      request['Authorization'] = "Bearer #{auth_token}" if auth_token
+      request.body = data.to_json
+
+      process_request(uri, request)
+    end
+
+    private
+
+    def process_request(uri, request)
+      response = Net::HTTP.start(uri.hostname, uri.port,
+                                 use_ssl: uri.scheme == 'https',
+                                 read_timeout: @read_timeout,
+                                 open_timeout: @open_timeout
+      ) do |http|
+        http.request(request)
+      end
+
+      if response.code == "200"
+        begin
+          JSON.parse(response.body)
+        rescue JSON::ParserError
+          { response: response.body }
+        end
+      elsif response.code == "400"
+        raise BlockchainNode::Errors::BadRequest.new(response.body)
+      elsif response.code == "401"
+        raise BlockchainNode::Errors::UnAuthorized.new(response.body)
+      else
+        raise BlockchainNode::Errors::Unknown.new("#{response.code} #{response.body}")
+      end
+
+    end
+
+  end
+end

data/lib/blockchain-node/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module BlockchainNode
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+
+  VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
+end

data/lib/blockchain-node.rb

@@ -0,0 +1,20 @@
+module BlockchainNode
+  autoload :Client, 'blockchain-node/client'
+  autoload :Configuration, 'blockchain-node/configuration'
+  autoload :Errors, 'blockchain-node/errors'
+  autoload :Request,'blockchain-node/request'
+  autoload :VERSION,'blockchain-node/version'
+
+  def self.configure
+    yield Configuration if block_given?
+  end
+
+  def self.config
+    config = {}
+    Configuration::ATTRIBUTES.each do |attribute|
+      config[attribute] = BlockchainNode::Configuration.send(attribute)
+    end
+    config
+  end
+
+end

data/spec/lib/blockchain-node_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe BlockchainNode::Configuration do
+
+  before :each do
+    BlockchainNode.configure do |config|
+      config.client_id = CLIENT_ID
+      config.client_secret = CLIENT_SECRET
+      config.request_options = { }
+    end
+  end
+
+  describe "configuration" do
+    it "should be accessible as a class property" do
+      expect(BlockchainNode.config[:client_id]).to eq CLIENT_ID
+      expect(BlockchainNode.config[:client_secret]).to eq CLIENT_SECRET
+    end
+
+    it "should configure properly" do
+      client = BlockchainNode::Client.new(NODE_ID)
+      expect(client.configuration.client_id).to eq CLIENT_ID
+      expect(client.configuration.client_secret).to eq CLIENT_SECRET
+    end
+
+    it "should allow api host override" do
+      host = "http://localhost:3000"
+      BlockchainNode.configure do |config|
+        config.request_options = { host: host }
+      end
+      expect(BlockchainNode.config[:request_options][:host]).to eq host
+    end
+  end
+
+  describe "oauth tokens" do
+    it "requests a new token if 1 is expired" do
+      expect_any_instance_of(BlockchainNode::Request).to receive(:process_request).exactly(3).times.and_return(
+        {
+          "access_token" => "a9b29c6810ba513f08f87fafadaa6154690f9246aa663b1b708c1c94a5887386",
+          "expires_in"  => 7200, "created_at"  => Time.now.to_i
+        }
+      )
+      client = BlockchainNode::Client.new(NODE_ID)
+      client.auth_token
+      Timecop.travel(Time.now + 7300)
+      client.auth_token
+      Timecop.travel(Time.now + 7200)
+      client.auth_token
+    end
+  end
+
+  describe "api calls" do
+    it "should make a successful API call" do
+      stub_oauth
+      stub_basic_method
+
+      client = BlockchainNode::Client.new(NODE_ID)
+      response = client.eth_blockNumber
+      expect(Integer(response[:response])).to eq 4666
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'pry'
+require 'timecop'
+require 'webmock/rspec'
+
+require File.expand_path('../lib/blockchain-node', File.dirname(__FILE__))
+
+Dir[File.expand_path("support/**/*.rb", File.dirname(__FILE__))].each { |f| require f }

data/spec/support/webmock.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+CLIENT_ID = "12345ABC"
+CLIENT_SECRET = "1234567890ABCDEFG"
+NODE_ID = "ABC123"
+
+OAUTH_REQUEST = { grant_type: "client_credentials", client_id: CLIENT_ID, client_secret: CLIENT_SECRET }
+OAUTH_RESPONSE = {
+  access_token: "a9b29c6810ba513f08f87fafadaa6154690f9246aa663b1b708c1c94a5887386",
+  token_type: "Bearer",
+  expires_in: 7200,
+  created_at: Time.now.to_i
+}
+def stub_oauth
+  stub_request(:post, "#{BlockchainNode::Request::DEFAULT_BASE_URL}/oauth/token").
+    with(body: OAUTH_REQUEST ).
+    to_return(status: 200, body: OAUTH_RESPONSE.to_json)
+end
+
+def stub_basic_method
+  stub_request(:post, "#{BlockchainNode::Request::DEFAULT_BASE_URL}/api/nodes/#{NODE_ID}").
+    with(body: api_method_body('eth_blockNumber')).
+    to_return(status: 200, body: '0x123A ')
+end
+
+
+def api_method_body(method, *params)
+  {
+    method: method,
+    parameters: params
+  }.to_json
+end
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: blockchain-node
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Pestritto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Client SDK for accessing BlockchainNode API.
+email:
+- matt@blockchainnode.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README-RPC-BTC.md
+- README-RPC-ETH.md
+- README.md
+- Rakefile
+- lib/blockchain-node.rb
+- lib/blockchain-node/client.rb
+- lib/blockchain-node/configuration.rb
+- lib/blockchain-node/errors.rb
+- lib/blockchain-node/request.rb
+- lib/blockchain-node/version.rb
+- spec/lib/blockchain-node_spec.rb
+- spec/spec_helper.rb
+- spec/support/webmock.rb
+homepage: https://blockchainnode.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: BlockchainNode Ruby Client
+test_files: []