bcoin-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6876db8d74297101f7ef5390d33e5cc767f3a08
+  data.tar.gz: 2685d89a4404151f62da43c10a6122eb6c0cd726
+SHA512:
+  metadata.gz: 88ade4d1a2930e92983f15d2a298f8cd6afce79fa2becfcfd97cf54222e01f2d4845d309534d4653e9132be32451d2a73aeec4bf970afbcec6fab006075bca07
+  data.tar.gz: a051953e56260071fed081575398c0ff6b01831373bbfade5ed9fa13050240e1d23bb428ab8e35650b0c1d78ac84227be91466744e41ebb5769d47ed45696c05

data/.env

@@ -0,0 +1,2 @@
+BCOIN_API_KEY=bcoin-ruby
+BCOIN_NETWORK=testnet

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/config/containers/bcoin/node_modules/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dknox@threedotloft.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bcoin-client.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1 @@
+./config/Guardfile

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dan Knox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,292 @@
+# Bcoin::Client
+
+[![Build Status](https://travis-ci.org/DanKnox-BitFS/bcoin-client.svg?branch=master)](https://travis-ci.org/DanKnox-BitFS/bcoin-client)
+
+Ruby client for the [bcoin.io](http://bcoin.io) bitcoin node. This
+client implements the HTTP wallet API methods. Perhaps one day I will
+add a consumer for the WebSocket wallet events API.
+
+This gem is developed and maintained by Dan Knox <dk@bitfs.us>.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bcoin-client'
+```
+
+And then execute:
+
+$ bundle
+
+Or install it yourself as:
+
+$ gem install bcoin-client
+
+## Usage
+
+```bash
+$ console
+```
+
+Initialize the client with your API key:
+
+```ruby
+pry> client = Bcoin::Client.new password: 'bcoin-ruby'
+=> #<Bcoin::Client:0x007f85161b74c8 @options={:password=>"bcoin-ruby"}>
+```
+
+Retrieve the full list of wallets or skip to ahead to learn how to find a
+single wallet.
+Refreshing the full list performs a GET for each individual
+wallet so don't do this if you have a ton of wallets.
+
+```ruby
+pry> client.wallets.refresh!
+=> #<Bcoin::Client::Wallets @collection=[...]>
+```
+
+Lets find a wallet by id.
+
+```ruby
+# You can also pass the :token parameter if wallet auth is on.
+pry> wallet = client.wallets.find id: 'primary'
+=> #<Bcoin::Client::Wallet @attributes={
+  :network=>"main",
+  :wid=>1,
+  :id=>"primary",
+  :initialized=>true,
+  :watchOnly=>false,
+  :accountDepth=>1,
+  :token=>"87499ed1df632246b3a3b98222668b030d5b9ed3617833f9ec08683af20c0dfb",
+  :tokenDepth=>0,
+  :state=>{
+    "tx"=>0,
+    "coin"=>0,
+    "unconfirmed"=>0,
+    "confirmed"=>0
+  },
+  :master=>{
+    "encrypted"=>false
+  },
+  :account=>{
+    "name"=>"default",
+    "initialized"=>true,
+    "witness"=>false,
+    "watchOnly"=>false,
+    "type"=>"pubkeyhash",
+    "m"=>1, "n"=>1,
+    "accountIndex"=>0,
+    "receiveDepth"=>1,
+    "changeDepth"=>1,
+    "nestedDepth"=>0,
+    "lookahead"=>10,
+    "receiveAddress"=>"14Uk3qcs8RNxeprNunzNbunFXn6AbWHJBF",
+    "nestedAddress"=>nil,
+    "changeAddress"=>"1n5KTQbqcwcpuLfw47YFQwmyyM5Lgmbcd",
+    "accountKey"=>"xpub6CuW3mzkvLHFZtNPGs3xN8tJCF8AighD7RjtPqTS6dwQay8iMqFguQuYC6cHXKYeBTM5qEofMDJ3CsgXwr59Se2HeBS3PoYYtRVySbaMvVX",
+    "keys"=>[]
+  }
+}>
+```
+
+Now we can retrieve this wallet's master key.
+
+```ruby
+pry> wallet.master
+=> #<Bcoin::Client::Master @attributes={
+  :encrypted=>false,
+  :key=>{
+    "xprivkey"=>"xprv9s21ZrQH143K3VfDtnoq7BMDhh8JGwytkEfztoXfgoJUgLsWAisFTtZssbhh41JEN7BWtuLQeWdRyn4tQo4Wcc5xQYkoZNZ42RLCHUErCrN"},
+    :mnemonic=>{
+      "bits"=>128,
+      "language"=>"english",
+      "entropy"=>"46df98f5245d73bd707694d8b3b666d8",
+      "phrase"=>"egg wolf diary emerge strong team scrub spoon suffer oval often ramp",
+      "passphrase"=>""
+    }
+  }
+}>
+```
+
+Create a new wallet:
+
+```ruby
+pry> wallet = client.wallets.create id: 'dan', type: :pubkeyhash
+=> #<Bcoin::Client::Wallet @attributes={
+  :network=>"main",
+  :wid=>2,
+  :id=>"dan",
+  :initialized=>true, :watchOnly=>false, :accountDepth=>1,
+  :token=>"1b7e6fb0a94e3432cafe6fbe58c057ac2d6c0048650769c45ecd551eb39ba003",
+  :tokenDepth=>0,
+  :state=>{
+    "tx"=>0, "coin"=>0,
+    "unconfirmed"=>0,
+    "confirmed"=>0
+  },
+  :master=>{"encrypted"=>false},
+  :account=>{
+    "name"=>"default",
+    "initialized"=>true,
+    "witness"=>false,
+    "watchOnly"=>false,
+    "type"=>"pubkeyhash",
+    "m"=>1, "n"=>1,
+    "accountIndex"=>0, "receiveDepth"=>1, "changeDepth"=>1,
+    "nestedDepth"=>0, "lookahead"=>10,
+    "receiveAddress"=>"1LYEVNtioaiVkkhpJgPA4m5hAitpXFSeNc",
+    "nestedAddress"=>nil,
+    "changeAddress"=>"1N17f1HExuPvcyB4cUZcRPGmHHCSN7J9Uf",
+    "accountKey"=>"xpub6DPi9Arcao3wG8oBBuGH4okiCQhifqwgZ86jnJJioqjeShe7MMhqE4Ykfe2YmBzD3Kto7vrszH9scYxGGShTJWjkCQfPWYH5rCDtaLJvqRv",
+    "keys"=>[]
+  }
+}>
+```
+
+When the wallet is created without a passphrase, it's master key should be
+unencrypted when retrieved.
+
+```ruby
+pry> wallet.master
+=> #<Bcoin::Client::Master @attributes={
+  :encrypted=>false,
+  :key=>{
+    "xprivkey"=>"xprv9s21ZrQH143K4VDn4ZZH9b1u3vbDGFesKy6g8uLqjsmwUiLwcsNusyHDzeVjQgdBfwNPfL5Fjgk13WNkuFL68LskGbDGn29nwcgYhZwviWc"},
+    :mnemonic=>{
+      "bits"=>128,
+      "language"=>"english",
+      "entropy"=>"09f479f97e705138b78233880985b4da",
+      "phrase"=>"antique phrase layer woman agree ordinary task edit marine equip honey relax",
+      "passphrase"=>""
+    }
+  }
+}>
+```
+
+Lets go ahead and set a passphrase on this wallet.
+
+```ruby
+pry> wallet.passphrase new: 'testpass'
+=> true
+```
+
+Now lets lock the wallet master key.
+
+```ruby
+pry> wallet.lock
+=> true
+```
+
+With the wallet locked, the master key will now be returned encrypted.
+
+```ruby
+pry> wallet.master.refresh!
+#<Bcoin::Client::Master @attributes={
+  :encrypted=>true,
+  :until=>0,
+  :iv=>"ac51c8e4c2251ca0e3a8d32f282fa829",
+  :ciphertext=>"4ce1c061359564c1e0e47e500cf44cb7271880129e86c03adec0986b85b714dbd5983afc4a77b93dd068f275bacc5b8493b454aee3ffbf2ccd40b527bd8176fa9ce5ae1d41e153d15ed18081478610d55e1470cc8d2267c88a82e5eb5af5af6e94178fd7f9efeb2aa334e7893c7e1094342d471c157873a80a99a0831b417847ccbafa16aa59d75cf79f487508687092002f2c15a682163cb6173d907ff4a6036958e3fb3604a035527ea4c5b4d2c6965dd275e42d3e2f7406c1f7621bcf4619",
+  :algorithm=>"pbkdf2",
+  :N=>50000,
+  :r=>0,
+  :p=>0
+}>
+```
+
+We can unlock the wallet for a number of seconds to perform sensitive operations.
+
+```ruby
+pry> wallet.unlock passphrase: 'testpass', timeout: 60
+=> true
+```
+
+With the wallet unlocked, we can now retrieve the private key and plain text mnemonic.
+
+```ruby
+pry> wallet.master.refresh!
+=> #<Bcoin::Client::Master @attributes={
+  :encrypted=>false,
+  :key=>{
+    "xprivkey"=>"xprv9s21ZrQH143K4VDn4ZZH9b1u3vbDGFesKy6g8uLqjsmwUiLwcsNusyHDzeVjQgdBfwNPfL5Fjgk13WNkuFL68LskGbDGn29nwcgYhZwviWc"},
+    :mnemonic=>{
+      "bits"=>128,
+      "language"=>"english",
+      "entropy"=>"09f479f97e705138b78233880985b4da",
+      "phrase"=>"antique phrase layer woman agree ordinary task edit marine equip honey relax",
+      "passphrase"=>""
+    }
+  }>
+```
+
+Finally, lets go ahead and send a transaction.
+
+```ruby
+pry> wallet.send rate: 0.0003, outputs: [{value: 1.5, address: '1LYEVNtioaiVkkhpJgPA4m5hAitpXFSeNc'}]
+=> {
+  {
+    "wid": 2,
+    "id": "dan",
+    "hash": "d9c7526b00f6d563200f685e6e229f0b41982153502467497153f7f466bd46d2",
+    "height": -1,
+    "block": null,
+    "ts": 0,
+    "ps": 1502837803,
+    "date": "2017-08-15T22:56:43Z",
+    "index": -1,
+    "size": 225,
+    "virtualSize": 225,
+    "fee": 4540,
+    "rate": 20177,
+    "confirmations": 0,
+    "inputs": [
+      {
+        "value": 5000000000,
+        "address": "RMKoN2RDoNMCvGKx2xigLezsDHBVV2WQ77",
+        "path": {
+          "name": "default",
+          "account": 0,
+          "change": false,
+          "derivation": "m/0'/0/0"
+        }
+      }
+    ],
+    "outputs": [
+      {
+        "value": 500000000,
+        "address": "RW6vfe34Qz3d6SmS3cnnQ2VyhQr6whWxpa",
+        "path": null
+      },
+      {
+        "value": 4499995460,
+        "address": "RWFa7WXvhnc6GWeFhDUHAR38CYarWaMw9S",
+        "path": {
+          "name": "default",
+          "account": 0,
+          "change": true,
+          "derivation": "m/0'/1/0"
+        }
+      }
+    ],
+    "tx": "0100000001659a478b1eb89bc5df48cd3a641d7996a644e2b05138a5e85c6483b9add9d4b0000000006a4730440220787987deb06a23e03b969abe8a95489aea604c1f5ff38657c40ced41b80b166102204d84297cf720344fa4f2119b8bd43b206b811a0fd535c24dcc80140eab0d0788012102354eb584896a4a2aea9729d0eff420f73193b8de6c55bdf6e6857cfede22ffbcffffffff020065cd1d000000001976a914e4699de8892b8623e1f87700fabc53470f698adc88ac447b380c010000001976a914e60c33f1d0c47fe550c33de373f0af79a58e788988ac00000000"
+  }>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DanKnox/bcoin-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bcoin::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/DanKnox/bcoin-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bcoin-client.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bcoin/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bcoin-client"
+  spec.version       = Bcoin::Client::VERSION
+  spec.authors       = ["Dan Knox"]
+  spec.email         = ["dknox@threedotloft.com"]
+
+  spec.summary       = %q{Client for the bcoin.io bitcoin node.}
+  spec.description   = %q{Client for the bcoin.io bitcoin node including their wallet API.}
+  spec.homepage      = "http://github.com/DanKnox-BitFS/bcoin-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry-doc", "~> 0.11"
+  spec.add_dependency "httparty", "~> 0.15"
+end