block_io 2.0.0 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb3eee8a4c13ad41febe0e5f07271c0e9d8cab44cfc5540d898aa8802c89e334
-  data.tar.gz: 52c0524074d9ea5da705be0190b613c56e10b1f52f5bdd10bbac163a415ba2e5
+  metadata.gz: c290c375f3fb3278c9a27bc3950b2fab5933631d3e3e8eff1e7564c5ebfd9e8b
+  data.tar.gz: a42456ef38ce4785622494a8b95171416eb9da05d776d269ac9984f49a977897
 SHA512:
-  metadata.gz: 8b85df794d052257b15add0e7a298b6b3482f04eaa67db0d4fe8b944898fd8a9e00451a2f4f6b351f867a8e33db7694421b2a419102941e41b9543a0a5ba2048
-  data.tar.gz: b58bb5628274ac2609a6103e68ba0fe5b829705231ee4264126521703907b83e46da97b6ebc9a8698c5d3ff39c11685011fcd4aa6e3d287fdb5ead9e0553054d
+  metadata.gz: 317e3939e17806aedaec69f82cdd843c016342af51db8fc308fad666212f812153c239af4c768528fd7cce61f984af7704b5b06317f020a0a924f5c1b2a48969
+  data.tar.gz: 4d2223d07edcb8ddee3a16745c10e17b8a4a802cc793e3fd8b8c6673f7138ed728bd418799e3e4eb8ee163f2407463decf1fcad0e960822240cf9afcf606d831

data/{.appveyor.yml → .appveyor.yml-disabled}

@@ -4,8 +4,6 @@ skip_tags: true
 
 environment:
   matrix:
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
     - ruby_version: "24"
     - ruby_version: "24-x64"
     - ruby_version: "25"
@@ -14,6 +12,8 @@ environment:
     - 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%

data/.gitignore

@@ -3,3 +3,4 @@ vendor/
 .bundle/
 *.gem
 *~
+.DS_Store

data/.travis.yml

@@ -2,11 +2,11 @@ language: ruby
 os:
 - linux
 rvm:
-- 2.3
 - 2.4
 - 2.5
 - 2.6
 - 2.7
+- 3.0
 bundler_args: --jobs=2
 script:
 - bundle exec rspec

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
 
@@ -14,29 +14,33 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install block_io -v=2.0.0
+    $ gem install block_io
 
 ## Changelog
-
-*07/02/20*: BREAKING CHANGES. Version 2.0.0. Remove support for Ruby < 2.3.0. Behavior and interfaces have changed. By upgrading you'll need to revise your code and tests.  
-*05/10/19*: Prevent inadvertent passing of PINs (user error).  
-*06/25/18*: Remove support for Ruby < 1.9.3 (OpenSSL::Cipher::Cipher). Remove connection_pool dependency.  
-*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.  
-
+*09/28/21*: Version 3.0.3 supports witness_v1 outputs (Bech32m).  
+*07/21/21*: Version 3.0.2 fixes Litecoin P2SH address version.  
+*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.
+
+## 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 = BlockIo::Client.new(:api_key => "API KEY", :pin => "SECRET PIN")
+    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 directly, do this:
+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", :keys => [BlockIo::Key.from_wif("PRIVATE KEY BACKUP")])
+    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:
 

data/block_io.gemspec

@@ -15,15 +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.3.0'
+  spec.required_ruby_version = '>= 2.4.0'
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", ">= 1.16", "< 3.0"
-  spec.add_development_dependency "rake", "~> 12.3", ">= 12.3.3"
+  spec.add_development_dependency "rake", "~> 13.0", ">= 13.0"
   spec.add_development_dependency "rspec", "~> 3.6", ">= 3.6"
-  spec.add_development_dependency "webmock", "~> 3.8", "< 4.0"
-  spec.add_runtime_dependency "ecdsa", "~> 1.2.0", ">= 1.2.0"
-  spec.add_runtime_dependency "http", "~> 4.4.1", ">= 4.4.1"
-  spec.add_runtime_dependency "oj", "~> 3.10.6", ">= 3.10"
-  spec.add_runtime_dependency "connection_pool", "~> 2.2.3", ">= 2.2"
+  spec.add_development_dependency "webmock", "~> 3.12", "< 4.0"
+  spec.add_runtime_dependency "bitcoinrb", "~> 0.8.0", "= 0.8.0"
+  spec.add_runtime_dependency "http", ">= 4.4.1", "< 6.0"
+  spec.add_runtime_dependency "oj", "~> 3.0", "< 4.0"
+  spec.add_runtime_dependency "connection_pool", ">= 2.2", "< 3.0"
 end

data/examples/basic.rb

@@ -3,18 +3,42 @@
 # 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 Dogecoin Testnet
+# adjust amount below if not using the Litecoin Testnet
 
 require 'block_io'
 
-blockio = BlockIo::Client.new(:api_key => ENV['API_KEY'], :pin => ENV['PIN'], :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
-puts blockio.get_new_address(:label => 'testDest')
-
-puts blockio.withdraw_from_labels(:from_labels => 'default', :to_label => 'testDest', :amount => '2.5')
+begin
+  puts blockio.get_new_address(:label => 'testDest')
+rescue BlockIo::APIException => e
+  puts e.to_s
+end
+puts " -- "
+
+# 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 " -- "
+
+# 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 " -- "
+
+# 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 " -- "
+
+# 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')
 

data/examples/dtrust.rb

@@ -1,25 +1,31 @@
-# 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 Litecoin Testnet API key here
 puts "*** Initialize BlockIo library: "
-blockio = BlockIo::Client.new(:api_key => ENV['API_KEY'], :pin => ENV['PIN'], :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
-# you will generate your own private keys, for instance: key = BlockIo::Key.new. Just note down key.public_key and key.private_key somewhere safe before you use your keys to generate dTrust addresses.
-# if you already have hex private keys, load the keys with BlockIo::Key.new(private_key_hex). Ensure the key's .public_key matches what you expect.
+# 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 = [
-  BlockIo::Key.new("b515fd806a662e061b488e78e5d0c2ff46df80083a79818e166300666385c0a2"), # alpha1alpha2alpha3alpha4
-  BlockIo::Key.new("1584b821c62ecdc554e185222591720d6fe651ed1b820d83f92cdc45c5e21f"), # alpha2alpha3alpha4alpha1
-  BlockIo::Key.new("2f9090b8aa4ddb32c3b0b8371db1b50e19084c720c30db1d6bb9fcd3a0f78e61"), # alpha3alpha4alpha1alpha2
-  BlockIo::Key.new("6c1cefdfd9187b36b36c3698c1362642083dcc1941dc76d751481d3aa29ca65") # alpha4alpha1alpha2alpha3
+  "b515fd806a662e061b488e78e5d0c2ff46df80083a79818e166300666385c0a2", # alpha1alpha2alpha3alpha4
+  "1584b821c62ecdc554e185222591720d6fe651ed1b820d83f92cdc45c5e21f", # alpha2alpha3alpha4alpha1
+  "2f9090b8aa4ddb32c3b0b8371db1b50e19084c720c30db1d6bb9fcd3a0f78e61", # alpha3alpha4alpha1alpha2
+  "6c1cefdfd9187b36b36c3698c1362642083dcc1941dc76d751481d3aa29ca65" # alpha4alpha1alpha2alpha3
 ].freeze
 
 dtrust_address = nil
@@ -29,15 +35,13 @@ 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.map{|k| k.public_key}.join(',')
+  signers = keys.map{|x| BlockIo::Key.from_private_key_hex(x)}.map(&:public_key_hex).join(',')
 
   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']
 
-  raise response["data"]["error_message"] unless response["status"].eql?("success")
-  
-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
   
@@ -49,7 +53,21 @@ 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 => '0.001')
+
+# 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 " -- "
+
+puts JSON.pretty_generate(blockio.summarize_prepared_transaction(prepared_transaction))
+puts " -- "
+
+# 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)
+
+# 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)
@@ -64,25 +82,26 @@ normal_address = blockio.get_address_by_label(:label => 'default')['data']['addr
 
 puts "*** Withdrawing from dtrust_address_label to the 'default' label in normal multisig"
 
-response = blockio.withdraw_from_dtrust_address(:from_labels => dtrust_address_label, :to_addresses => normal_address, :amounts => '0.0009')
-
-puts JSON.pretty_generate(response)
+# 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')
 
-# let's sign for the public keys specified
-signatures_added = BlockIo::Helper.signData(response["data"]["inputs"], keys)
+# 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))
 
-puts "*** Signatures added? #{signatures_added}"
+puts "*** Submitting transaction data:"
+puts JSON.pretty_generate(transaction_data)
 
-puts "*** Our (signed) request:"
-puts JSON.pretty_generate(response['data'])
+# 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"]}))
+puts "*** Submit the transaction: "
+puts JSON.pretty_generate(response)
 
 # get the sent transactions for this dTrust address
 
 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/sweeper.rb

@@ -4,26 +4,31 @@
 #
 # Contact support@block.io if you have any issues
 
-require "block_io"
+require 'block_io'
 
-blockio = BlockIo::Client.new(:api_key => ENV['API_KEY'], :version => 2)
-puts blockio.get_balance
-puts blockio.network
+blockio = BlockIo::Client.new(:api_key => ENV['API_KEY'])
 
 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 = ENV['FROM_ADDRESS'] # sweep coins from this address
-private_key = ENV['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)
+# 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 " -- "
 
-  raise response["data"]["error_message"] unless response["status"].eql?("success")
+# 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 "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
+puts "Transaction ID: #{response['data']['txid']}"

data/lib/block_io/api_exception.rb

@@ -0,0 +1,11 @@
+module BlockIo
+  class APIException < Exception
+    
+    attr_reader :raw_data
+    
+    def set_raw_data(data)
+      @raw_data = data
+    end
+  end
+end
+

data/lib/block_io/chainparams/BTC.yml

@@ -0,0 +1,8 @@
+--- !ruby/object:Bitcoin::ChainParams
+network: "BTC"
+address_version: "00"
+p2sh_version: "05"
+bech32_hrp: 'bc'
+privkey_version: "80"
+extended_privkey_version: "0488ade4"
+extended_pubkey_version: "0488b21e"

data/lib/block_io/chainparams/BTCTEST.yml

@@ -0,0 +1,8 @@
+--- !ruby/object:Bitcoin::ChainParams
+network: "BTCTEST"
+address_version: "6f"
+p2sh_version: "c4"
+bech32_hrp: 'tb'
+privkey_version: "ef"
+extended_privkey_version: "04358394"
+extended_pubkey_version: "043587cf"

data/lib/block_io/chainparams/DOGE.yml

@@ -0,0 +1,8 @@
+--- !ruby/object:Bitcoin::ChainParams
+network: "DOGE"
+address_version: "1e"
+p2sh_version: "16"
+bech32_hrp: "doge"
+privkey_version: "9e"
+extended_privkey_version: "02fac398"
+extended_pubkey_version: "02facafd"

data/lib/block_io/chainparams/DOGETEST.yml

@@ -0,0 +1,8 @@
+--- !ruby/object:Bitcoin::ChainParams
+network: "DOGETEST"
+address_version: "71"
+p2sh_version: "c4"
+bech32_hrp: "tdge"
+privkey_version: "f1"
+extended_privkey_version: "0432a243"
+extended_pubkey_version: "0432a9a8"

data/lib/block_io/chainparams/LTC.yml

@@ -0,0 +1,8 @@
+--- !ruby/object:Bitcoin::ChainParams
+network: "LTC"
+address_version: "30"
+p2sh_version: "50"
+bech32_hrp: 'ltc'
+privkey_version: "b0"
+extended_privkey_version: "019d9cfe"
+extended_pubkey_version: "019da462"

data/lib/block_io/chainparams/LTCTEST.yml

@@ -0,0 +1,8 @@
+--- !ruby/object:Bitcoin::ChainParams
+network: "LTCTEST"
+address_version: "6f"
+p2sh_version: "3a"
+bech32_hrp: 'tltc'
+privkey_version: "ef"
+extended_privkey_version: "0436f6e1"
+extended_pubkey_version: "0436ef7d"