block_io 1.0.8 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9dc992c3a7aa1fc125e1eaf8b16d531318e31fd
-  data.tar.gz: fdf9ae723127d8688e55cdc0c1ffc9f0eb263bda
+SHA256:
+  metadata.gz: 42de3243361e4c2a75e0357745ac507c381332d927453d6b35f81b63f30ea723
+  data.tar.gz: f2416231c346fe92b0f39b665390be3c511aab2b62d9c8c8e2f07c580c12e30e
 SHA512:
-  metadata.gz: 2ed068c30ce271df8745e66288f050b97f5f3ec3f68f3087c88ed3b7068059e29503edc1043521bb55d56f80dfbb57491ce709033e36ef021e850775ee94501f
-  data.tar.gz: e9c4c14b3c2bbd292a20f8a018bd9089b20d5742115b0ebc9d6c2a707e4fac3583e1dc620fb4a580c5ab284b45a4ce3bc911dbd42ba6853930e93524d0e5e412
+  metadata.gz: bdd5177bade408ffcb526b09d62a177ebee4d6cef0352267c1d1578c1223bd598f7900012bfa27c0ae1cb71e9202f862180ecad91ea70b4b077a44f4d06fe080
+  data.tar.gz: ff6f0db6e6bc5b485de84487d805970317fa4f936d015d4fce994302a9e48fd3e37dd076ffb0da8a8fb41e1f988040397905d6b389ca7995ed0e6b88b23544bd

data/.appveyor.yml-disabled

@@ -0,0 +1,26 @@
+version: '{build}'
+
+skip_tags: true
+
+environment:
+  matrix:
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"
+    - ruby_version: "26"
+    - ruby_version: "26-x64"
+    - ruby_version: "27"
+    - ruby_version: "27-x64"
+    - ruby_version: "30"
+    - ruby_version: "30-x64"
+    
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - gem install bundler --no-document -v 2.1.4
+  - bundle install --retry=3
+
+test_script:
+  - bundle exec rspec
+
+build: off

data/.gitignore

@@ -1,2 +1,6 @@
 Gemfile.lock
-pkg
+vendor/
+.bundle/
+*.gem
+*~
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+os:
+- linux
+rvm:
+- 2.4
+- 2.5
+- 2.6
+- 2.7
+- 3.0
+bundler_args: --jobs=2
+script:
+- bundle exec rspec
+cache: bundler
+

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 BlockIo
+Copyright (c) 2021 BlockIo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # BlockIo
 
-This Ruby Gem is the official reference client for the Block.io payments API. To use this, you will need the Dogecoin, Bitcoin, or Litecoin API key(s) from <a href="https://block.io" target="_blank">Block.io</a>. Go ahead, sign up :)
+This Ruby Gem is the official reference client for the Block.io's infrastructure APIs. To use this, you will need the Dogecoin, Bitcoin, or Litecoin API key(s) from <a href="https://block.io" target="_blank">Block.io</a>. Go ahead, sign up :)
 
 ## Installation
 
@@ -10,33 +10,43 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
-    $ gem install block_io -v=1.0.6
+    $ gem install block_io
 
 ## Changelog
+*06/09/21*: Version 3.0.1 implements use of dynamic decryption algorithms.  
+*04/14/21*: BREAKING CHANGES. Version 3.0.0. Remove support for Ruby < 2.4.0, and Windows. Behavior and interfaces have changed. By upgrading you'll need to revise your code and tests.
 
-*01/21/15*: Added ability to sweep coins from one address to another.  
-*11/04/14*: Fix issue with nil parameters in an API call.  
-*11/03/14*: Reduce dependence on OpenSSL. PBKDF2 function is now Ruby-based. Should work well with Heroku's libraries.  
-*10/18/14*: Now using deterministic signatures (RFC6979), and BIP62 to hinder transaction malleability.  
-
+## Important Notes
+* This gem depends on the bitcoinrb gem. By using this gem, your application will load the bitcoinrb gem as well with the Bitcoin namespace. It may conflict with another gem using the same namespace.  
+* Transaction endpoints are updated as of v3.0.0.
+* See the examples/ folder for basic examples.
+* Be careful to test thoroughly before production.  
+* Use of this software is subject to its LICENSE.  
 
 ## Usage
 
 It's super easy to get started. In your Ruby shell ($ irb), for example, do this:
 
     require 'block_io'
-    BlockIo.set_options :api_key => 'API KEY', :pin => 'SECRET PIN', :version => 2
-     
+    blockio = BlockIo::Client.new(:api_key => "API KEY", :pin => "SECRET PIN")    
+
+If you do not have your PIN, or just wish to use your private key backup(s) directly, do this instead:
+
+    blockio = BlockIo::Client.new(:api_key => "API KEY")
+    blockio.get_balance
+    blockio.prepare_transaction(..., :keys => [BlockIo::Key.from_wif("PRIVATE_KEY_BACKUP_IN_WIF").private_key_hex])    
+
 And you're good to go:
 
-    BlockIo.get_new_address
-    BlockIo.get_my_addresses
+    blockio.get_new_address
+    blockio.get_my_addresses
 
-For more information, see https://block.io/api/simple/ruby
+For other initialization options/parameters, see `lib/block_io/client.rb`.  
+For more information, see https://block.io/api/simple/ruby.
 
 ## Contributing
 

data/block_io.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'block_io/version'
@@ -16,14 +15,15 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.required_ruby_version = '>= 2.4.0'
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 0"
-  spec.add_runtime_dependency "ecdsa", "~> 1.2", '>= 1.2.0'
-  spec.add_runtime_dependency "httpclient", "~> 2.8", '>= 2.8.0'
-  spec.add_runtime_dependency "oj", "~> 3.3", '>= 3.3.5'
-  spec.add_runtime_dependency "oj_mimic_json"
-  spec.add_runtime_dependency "connection_pool", "~> 2.2", '>= 2.2.1'
-  spec.add_runtime_dependency "pbkdf2-ruby", '~> 0.2', '>= 0.2.1'
+  spec.add_development_dependency "bundler", ">= 1.16", "< 3.0"
+  spec.add_development_dependency "rake", "~> 13.0", ">= 13.0"
+  spec.add_development_dependency "rspec", "~> 3.6", ">= 3.6"
+  spec.add_development_dependency "webmock", "~> 3.12", "< 4.0"
+  spec.add_runtime_dependency "bitcoinrb", "~> 0.7.0", "= 0.7.0"
+  spec.add_runtime_dependency "http", "~> 4.4.1", ">= 4.4.1"
+  spec.add_runtime_dependency "oj", "~> 3.11", ">= 3.11"
+  spec.add_runtime_dependency "connection_pool", "~> 2.2.5", ">= 2.2"
 end

data/examples/basic.rb

@@ -1,22 +1,50 @@
-# creates a new destination address, withdraws from the default label to it, gets sent transactions, and the current price
+# creates a new destination address, withdraws from the default label to it, gets updated address balances, gets sent/received transactions, and the current price
+#
+# basic example: $ API_KEY=TESTNET_API_KEY PIN=YOUR_SECRET_PIN ruby basic.rb
+# bundler example: $ API_KEY=TESTNET_API_KEY PIN=YOUR_SECRET_PIN bundle exec ruby basic.rb
+#
+# adjust amount below if not using the Litecoin Testnet
 
 require 'block_io'
 
-# please use the Dogecoin Testnet API key here
-puts BlockIo.set_options :api_key => 'YOURDOGECOINTESTNETAPIKEY', :pin => 'YOURSECRETPIN', :version => 2
+blockio = BlockIo::Client.new(:api_key => ENV['API_KEY'], :pin => ENV['PIN'])
+puts blockio.get_balance
+puts blockio.network
 
+# create the address if it doesn't exist
 begin
-  puts BlockIo.get_new_address(:label => 'testDest')
-rescue Exception => e
-  # if this failed, we probably created testDest label before
+  puts blockio.get_new_address(:label => 'testDest')
+rescue BlockIo::APIException => e
   puts e.to_s
 end
+puts " -- "
 
-puts BlockIo.withdraw_from_labels(:from_labels => 'default', :to_label => 'testDest', :amount => '3.5')
+# retrieve unspent outputs and other relevant data to create and sign the transaction
+# you will inspect the prepared transaction for things like network fees being paid, block.io fees being paid, validating what destination addresses receive how much, etc.
+prepared_transaction = blockio.prepare_transaction(:to_label => 'testDest', :amount => '0.012345')
+puts JSON.pretty_generate(prepared_transaction)
+puts " -- "
 
-puts BlockIo.get_address_by_label(:label => 'default')
+# a summary of what's in the prepared transaction
+# for in-depth review of the transaction, look at the prepared_transaction object yourself
+puts JSON.pretty_generate(blockio.summarize_prepared_transaction(prepared_transaction))
+puts " -- "
 
-puts BlockIo.get_transactions(:type => 'sent') # API v2 only
+# once satisfied with the prepared transaction, create and sign it
+# inspect this again if you wish, it will contain the transaction payload in hexadecimal form you want Block.io to sign and broadcast
+transaction_data = blockio.create_and_sign_transaction(prepared_transaction)
+puts JSON.pretty_generate(transaction_data)
+puts " -- "
 
-puts BlockIo.get_current_price(:base_price => 'BTC')
+# ask Block.io to sign and broadcast the transaction
+puts JSON.pretty_generate(blockio.submit_transaction(:transaction_data => transaction_data))
+puts " -- "
+
+puts blockio.get_address_balance(:labels => 'default,testDest')
+
+puts blockio.get_transactions(:type => 'sent')
+
+puts blockio.get_transactions(:type => 'received')
+
+puts blockio.get_current_price(:base_price => 'BTC')
 

data/examples/dtrust.rb

@@ -1,31 +1,51 @@
-# creates a new destination address, withdraws from the default label to it, gets sent transactions, and the current price
+# creates a new dTrust destination address, sends coins to it, withdraws coins from it, gets sent transactions, and the current price
 
 require 'block_io'
+require 'json'
 
-# please use the Dogecoin Testnet API key here
+# please use the Litecoin Testnet API key here
 puts "*** Initialize BlockIo library: "
-puts JSON.pretty_generate(BlockIo.set_options :api_key => 'YourDogecoinTestnetAPIKey', :pin => 'YourSecretPIN', :version => 2)
+blockio = BlockIo::Client.new(:api_key => ENV['API_KEY'], :pin => ENV['PIN'])
 
+puts blockio.get_dtrust_balance
+puts blockio.network
+
+raise "Please use the LTCTEST network API Key here or modify this script for another network." unless blockio.network == "LTCTEST"
 
 # create 4 keys
-keys = [ BlockIo::Key.from_passphrase('alpha1alpha2alpha3alpha4'), BlockIo::Key.from_passphrase('alpha4alpha1alpha2alpha3'), BlockIo::Key.from_passphrase('alpha3alpha4alpha1alpha2'), BlockIo::Key.from_passphrase('alpha2alpha3alpha4alpha1') ]
+# you will generate your own private keys, for instance: key = BlockIo::Key.generate.
+# you will need to record key.to_wif (private key in Wallet Import Format (WIF)) somewhere safe before you use your keys to generate dTrust addresses.
+# if you already have hex private keys, load the keys (see below). Ensure the key's public_key (key.public_key_hex) matches what you expect.
+# WARNING: The keys below are just for demonstration, DO NOT use them on mainnets, DO NOT use insecurely generated keys
+# WARNING: You must ALWAYS use compressed public keys. Use of uncompressed public keys can lead to lost coins when using SegWit addresses.
+
+# these keys will use the appropriate coin's parameters. The library will know what network you're interacting with once you make a successful API call first, like blockio.get_dtrust_balance above
+
+keys = [
+  "b515fd806a662e061b488e78e5d0c2ff46df80083a79818e166300666385c0a2", # alpha1alpha2alpha3alpha4
+  "1584b821c62ecdc554e185222591720d6fe651ed1b820d83f92cdc45c5e21f", # alpha2alpha3alpha4alpha1
+  "2f9090b8aa4ddb32c3b0b8371db1b50e19084c720c30db1d6bb9fcd3a0f78e61", # alpha3alpha4alpha1alpha2
+  "6c1cefdfd9187b36b36c3698c1362642083dcc1941dc76d751481d3aa29ca65" # alpha4alpha1alpha2alpha3
+].freeze
 
 dtrust_address = nil
+dtrust_address_label = "dTrust1_witness_v0"
 
 begin
   # let's create a new address with all 4 keys as signers, but only 3 signers required (i.e., 4 of 5 multisig, with 1 signature being Block.io)
+  # you will need all 4 of your keys to use your address without interacting with Block.io
 
-  signers = ""
-  keys.each { |key| signers += ',' if signers.length > 0; signers += key.public_key; }
+  signers = keys.map{|x| BlockIo::Key.from_private_key_hex(x)}.map(&:public_key_hex).join(',')
 
-  response = BlockIo.get_new_dtrust_address(:label => 'dTrust1', :public_keys => signers, :required_signatures => 3)
+  response = blockio.get_new_dtrust_address(:label => dtrust_address_label, :public_keys => signers, :required_signatures => 3, :address_type => "witness_v0")
 
   dtrust_address = response['data']['address']
-rescue Exception => e
+
+rescue BlockIo::APIException => e
   # if this failed, we probably created the same label before. let's fetch the address then.
   puts e.to_s
   
-  response = BlockIo.get_dtrust_address_by_label(:label => 'dTrust1')
+  response = blockio.get_dtrust_address_by_label(:label => dtrust_address_label)
   
   dtrust_address = response['data']['address']
 end
@@ -33,57 +53,55 @@ end
 puts "*** Our dTrust Address: #{dtrust_address}"
 
 # let's deposit some coins into this new address
-response = BlockIo.withdraw_from_labels(:from_labels => 'default', :to_address => dtrust_address, :amount => '3.5')
 
-puts "*** Withdrawal response:"
-puts JSON.pretty_generate(response)
+# blockio.prepare_transaction gets the appropriate data you need to create and sign your transaction. You will need to inspect it to ensure things are as expected yourself.
+prepared_transaction = blockio.prepare_transaction(:to_address => dtrust_address, :amount => '0.001')
 
+puts JSON.pretty_generate(prepared_transaction)
+puts " -- "
 
-# fetch the dtrust address' balance
-puts "*** dTrust1 Balance:"
-puts JSON.pretty_generate(BlockIo.get_dtrust_address_balance(:label => 'dTrust1'))
-
-# withdraw a few coins from dtrust1 to the default label
-normal_address = BlockIo.get_address_by_label(:label => 'default')['data']['address']
+puts JSON.pretty_generate(blockio.summarize_prepared_transaction(prepared_transaction))
+puts " -- "
 
-puts "*** Withdrawing from dTrust1 to the 'default' label in normal multisig"
+# blockio.create_and_sign_transaction creates the transaction client-side, and appends your signatures (if any)
+transaction_data = blockio.create_and_sign_transaction(prepared_transaction)
 
-response = BlockIo.withdraw_from_dtrust_address(:from_labels => 'dTrust1', :to_addresses => normal_address, :amounts => '2.1')
+# blockio.submit_transaction sends the signatures and transaction payload to Block.io so Block.io can add its signatures and broadcast the transaction to the network
+response = blockio.submit_transaction(:transaction_data => transaction_data)
 
+puts "*** Withdrawal response:"
 puts JSON.pretty_generate(response)
 
-# let's sign for the public keys specified
-
-response['data']['inputs'].each do |input|
-  # for each input
 
-  data_to_sign = input['data_to_sign']
+# fetch the dtrust address' balance
+puts "*** dtrust_address_label Balance:"
+puts JSON.pretty_generate(blockio.get_dtrust_address_balance(:label => dtrust_address_label))
 
-  input['signers'].each do |signer|
+# withdraw a few coins from dtrust_address_label to the default label
+normal_address = blockio.get_address_by_label(:label => 'default')['data']['address']
 
-    # figure out if we have the public key that matches this signer
-    
-    keys.each do |key|
-      # iterate over all keys till we've found the one that we need
+puts "*** Withdrawing from dtrust_address_label to the 'default' label in normal multisig"
 
-      signer['signed_data'] = key.sign(data_to_sign) if key.public_key == signer['signer_public_key']
+# note use of prepare_dtrust_transaction instead of prepare_transaction, since this is a dTrust transaction
+# we're not doing any inspection here, but you will in your own code
+prepared_transaction = blockio.prepare_dtrust_transaction(:from_labels => dtrust_address_label, :to_addresses => normal_address, :amounts => '0.0009')
 
-    end
+# create the transaction and sign it with the keys we've provided
+# we're signing the transaction partially by supplying only 3 of our 4 keys
+transaction_data = blockio.create_and_sign_transaction(prepared_transaction, keys.first(3))
 
-  end
+puts "*** Submitting transaction data:"
+puts JSON.pretty_generate(transaction_data)
 
-end
-
-puts "*** Our signed response: "
-puts JSON.pretty_generate(response['data']) #.to_json
+# if successful, you will get a transaction ID when you submit_transaction.
+response = blockio.submit_transaction(:transaction_data => transaction_data)
 
 # let's final the withdrawal
-puts "*** Finalize withdrawal: "
-puts JSON.pretty_generate(BlockIo.sign_and_finalize_withdrawal(:signature_data => response['data'].to_json))
+puts "*** Submit the transaction: "
+puts JSON.pretty_generate(response)
 
 # get the sent transactions for this dTrust address
 
-puts "*** Get transactions sent by our dTrust1 address: "
-
-puts JSON.pretty_generate(BlockIo.get_dtrust_transactions(:type => 'sent', :labels => 'dTrust1'))
+puts "*** Get transactions sent by our dtrust_address_label address: "
+puts JSON.pretty_generate(blockio.get_dtrust_transactions(:type => 'sent', :labels => dtrust_address_label))
 

data/examples/proxy.rb

@@ -0,0 +1,36 @@
+# creates a new destination address, withdraws from the default label to it,
+# gets updated address balances, gets sent/received transactions, and the
+# current price
+# ... through an https proxy (like Squid)
+#
+# Unauthenticated:
+# $ PROXY_HOST=localhost PROXY_PORT=3128 API_KEY=TESTNET_API_KEY PIN=YOUR_SECRET_PIN ruby proxy.rb
+#
+# Authenticated:
+# $ PROXY_HOST=localhost PROXY_PORT=3128 PROXY_USER=user PROXY_PASS=pass API_KEY=TESTNET_API_KEY PIN=YOUR_SECRET_PIN ruby proxy.rb
+#
+# adjust amount below if not using the Dogecoin Testnet
+
+require '../lib/block_io'
+
+blockio = BlockIo::Client.new(:api_key => ENV['API_KEY'], :pin => ENV['PIN'], :version => 2, :proxy => {
+  :hostname => ENV['PROXY_HOST'],
+  :port => ENV['PROXY_PORT'],
+  :username => ENV['PROXY_USER'],
+  :password => ENV['PROXY_PASS']
+  })
+puts blockio.get_balance
+puts blockio.network
+
+# create the address if it doesn't exist
+puts blockio.get_new_address(:label => 'testDest')
+
+puts blockio.withdraw_from_labels(:from_labels => 'default', :to_label => 'testDest', :amount => '2.5')
+
+puts blockio.get_address_balance(:labels => 'default,testDest')
+
+puts blockio.get_transactions(:type => 'sent')
+
+puts blockio.get_transactions(:type => 'received')
+
+puts blockio.get_current_price(:base_price => 'BTC')

data/examples/sweeper.rb

@@ -4,21 +4,31 @@
 #
 # Contact support@block.io if you have any issues
 
-require "block_io"
+require 'block_io'
 
-BlockIo.set_options :api_key => 'YOUR API KEY', :pin => 'PIN NOT NEEDED', :version => 2
+blockio = BlockIo::Client.new(:api_key => ENV['API_KEY'])
 
-to_address = 'SWEEP COINS TO THIS ADDRESS'
+to_address = ENV['TO_ADDRESS'] # sweep coins into this address
+private_key = ENV['PRIVATE_KEY'] # private key for the address from which you wish to sweep coins (WIF)
 
-from_address = 'SWEEP COINS FROM THIS ADDRESS'
-private_key = 'PRIVATE KEY FOR FROM_ADDRESS'
+# prepare the sweep transaction
+# you will inspect this data to ensure things are in order (the network fees you pay, the amount being swept, etc.)
+# the private key is used to determine the public key by prepare_sweep_transaction client-side
+# the private key never travels to Block.io
+prepared_transaction = blockio.prepare_sweep_transaction(:to_address => to_address, :private_key => private_key)
+puts JSON.pretty_generate(prepared_transaction)
+puts " -- "
 
-begin
-  response = BlockIo.sweep_from_address(:to_address => to_address, :private_key => private_key, :from_address => from_address)
-  
-  puts "Sweep Complete: #{response['data']['amount_sent']} #{response['data']['network']} swept from #{from_address} to #{to_address}."
-  puts "Transaction ID: #{response['data']['txid']}"
-  puts "Network Fee Incurred: #{response['data']['network_fee']} #{response['data']['network']}"
-rescue Exception => e
-  puts "Sweep failed: #{e}"
-end
+# create and sign the transaction
+# the signature is from the key you provided to prepare_sweep_transaction above
+transaction_data = blockio.create_and_sign_transaction(prepared_transaction)
+puts JSON.pretty_generate(transaction_data)
+puts " -- "
+
+# submit the final transaction to Block.io for broadcast to the network, or
+# submit the transaction payload youself elsewhere (like using sendrawtransaction RPC calls with bitcoind, dogecoind, litecoind, etc.)
+response = blockio.submit_transaction(:transaction_data => transaction_data)
+puts JSON.pretty_generate(response)
+puts " -- "
+
+puts "Transaction ID: #{response['data']['txid']}"