cryptobank 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4fe9ccdd2658016176c4792badfffefff8034e2
+  data.tar.gz: 98948d1e6ba86e63f4e914b82b6186ff9a9aedcb
+SHA512:
+  metadata.gz: 1abb2b7335db3416df90c26ae7679ec519417a5273b783ee226d7dbc1972d528ee4923856b7aab3189003eab6e3636c95f41a4ae70519bfdcd460c06623ad670
+  data.tar.gz: 39d396125dfa28cb98fd1fc355098db85d75a1bc2b7501add1de0ba6d56ace3f155620b35d2ab1cb166a4165e1c0efaf852c40aae416e45390c518850d7a98af

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea/

data/.travis.yml

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

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 grace@gracefulco.de. 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 cryptobank.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    cryptobank (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.6)
+    minitest (5.10.3)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  cryptobank!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Grace Christenbery
+
+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,67 @@
+# Cryptobank
+
+Cryptobank provides Ruby wrappers for the Bitcoin API JSON-RPC.
+
+This gem is still in development. Please feel free to contribute and make a pull request. As the gem is called 'cryptobank', it will evole into a more general toolbox for working with crypocurrencies.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cryptobank'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cryptobank
+
+## Usage
+
+```
+class Bitcoind
+  extend Cryptobank
+end
+
+Bitcoind.configure do |config|
+  config.host = '127.0.0.1' # default: 'localhost'
+  config.port = 8332           # default: 8543
+  config.user = 'admin'         # default: 'rpcuser'
+  config.password = 'swordfish' # default: 'rpcpassword'
+end
+
+Bitcoind.new_address #=> '14gnToPKhRKhRKXZHV4mJyu8N5EFAoFU6G'
+
+account = "LolCat"
+Bitcoind.balance(account) #=> 3.73094258
+Bitcoind.get_account_addresses(account)
+```
+
+Please see lib/cryptobank/cryptobank.rb for the methods that are currently implemented.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/Cryptobank. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cryptobank project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/Cryptobank/blob/master/CODE_OF_CONDUCT.md).
+
+## Credit
+
+Credit goes to the gem 'Coinable' for inspiring this gem.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cryptobank"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cryptobank.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cryptobank/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cryptobank'
+  spec.version       = Cryptobank::VERSION
+  spec.authors       = ['Grace Christenbery']
+  spec.email         = ['grace@gracefulco.de']
+  spec.summary       = 'A toolbox for working with cryptocurrencies. Cryptobank provides Ruby wrappers for the Bitcoin API JSON-RPC.'
+  spec.homepage      = 'https://github.com/Grace/cryptobank'
+  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_runtime_dependency 'httparty'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/cryptobank.rb

@@ -0,0 +1,471 @@
+require 'json'
+require 'httparty'
+require 'cryptobank/version'
+require 'cryptobank/error'
+
+module Cryptobank # Implements Bitcoin API JSON-RPC to communicate with bitcoind
+
+      HEADERS = {
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      }.freeze
+
+      attr_writer :host, :port, :user, :password
+
+      def host
+        @host || 'localhost'
+      end
+
+      def port
+        @port || 8332
+      end
+
+      def user
+        @user || 'rpcuser'
+      end
+
+      def password
+        @password || 'rpcpassword'
+      end
+
+      def configure
+        yield self
+      end
+
+      # addmultisigaddress
+      def add_multisig_address(minimum_number_of_sigs, key_or_addresses, account = '')
+        payload = {
+          method: 'addmultisigaddress'
+        }
+        payload[:params] = [minimum_number_of_sigs.to_int, key_or_addresses.to_string, account.to_string]
+        request(payload)
+      end
+
+      # addnode
+      def add_node
+        raise NotImplementedError
+      end
+
+      # backupwallet
+      def backup_wallet
+        raise NotImplementedError
+      end
+
+      # createmultisig
+      def create_multisig
+        raise NotImplementedError
+      end
+
+      # createrawtransaction
+      def create_raw_transaction
+        raise NotImplementedError
+      end
+
+      # decoderawtransaction
+      def decode_raw_transaction
+        raise NotImplementedError
+      end
+
+      # dumpprivkey
+      def dump_priv_key
+        raise NotImplementedError
+      end
+
+      # encryptwallet
+      def encrypt_wallet
+        raise NotImplementedError
+      end
+
+      # getaccount
+      # A P2PKH or P2SH Bitcoin address belonging either to a specific account or the default account (“”)
+      # returns a base58 string
+      def account(bitcoin_address)
+        payload = {
+          method: 'getaccount'
+        }
+        payload[:params] = [bitcoin_address.to_string]
+        request(payload)
+      end
+
+      # getaddednodeinfo
+      def added_node_info
+        raise NotImplementedError
+      end
+
+      # getbalance
+      # There are additional parameters on the RPC docs to be implemented https://bitcoin.org/en/developer-reference#getbalance
+      def balance(account = nil)
+        payload = {
+          method: 'getbalance'
+        }
+        payload[:params] = [account] unless account.nil?
+        request(payload)
+      end
+
+      # getbestblockhash
+      def best_block_hash
+        raise NotImplementedError
+      end
+
+      # getblock
+      def block(verbosity = nil)
+        payload = {
+          method: 'getblock'
+        }
+        payload[:params] = [template_request] unless verbosity.nil?
+        request(payload)
+      end
+
+      # getblockhash
+      def block_hash
+        payload = {
+          method: 'getblockhash'
+        }
+        request(payload)
+      end
+
+      # getblockcount
+      def block_count
+        payload = {
+          method: 'getblockcount'
+        }
+        request(payload)
+      end
+
+      # getblocktemplate
+      def block_template(template_request = nil)
+        payload = {
+          method: 'getblocktemplate'
+        }
+        payload[:params] = [template_request] unless template_request.nil?
+        request(payload)
+      end
+
+      # getconnectioncount
+      def connection_count
+        payload = {
+          method: 'getconnectioncount'
+        }
+        request(payload)
+      end
+
+      # getdifficulty
+      def difficulty
+        payload = {
+          method: 'getdifficulty'
+        }
+        request(payload)
+      end
+
+      # getgenerate
+      def generate
+        payload = {
+          method: 'getgenerate'
+        }
+        request(payload)
+      end
+
+      def get_account_addresses(account)
+        payload = {
+          method: 'getaddressesbyaccount'
+        }
+        payload[:params] = [account]
+        request(payload)
+      end
+
+      # gethashespersec
+      def hashes_per_sec
+        raise NotImplementedError
+      end
+
+      # getinfo
+      def info
+        payload = {
+          method: 'getwalletinfo'
+        }
+        request(payload)
+      end
+
+      # getmempoolinfo
+      def memory_pool_info
+        payload = {
+          method: 'getmempoolinfo'
+        }
+        request(payload)
+      end
+    end
+
+    # getmininginfo
+    def mining_info
+      payload = {
+        method: 'getmininginfo'
+      }
+      request(payload)
+    end
+
+    # getnewaddress
+    def new_address(account = nil)
+      payload = {
+        method: 'getnewaddress'
+      }
+      payload[:params] = [account] unless account.nil?
+      request(payload)
+    end
+
+    # getpeerinfo
+    def peer_info
+      payload = {
+        method: 'getpeerinfo'
+      }
+      request(payload)
+    end
+
+    # getrawchangeaddress
+    def raw_change_address
+      payload = {
+        method: 'getrawchangeaddress'
+      }
+      request(payload)
+    end
+
+    # getrawmempool
+    def raw_mem_pool(verbose_format = false)
+      payload = {
+        method: 'getrawmempool'
+      }
+      payload[:params] = [1] if verbose_format?
+      request(payload)
+    end
+
+    # getrawtransaction
+    # The TXID of the transaction to get, encoded as hex in RPC byte order
+    def raw_transaction(txid)
+      payload = {
+        method: 'getrawtransaction'
+      }
+      payload[:params] = [txid]
+      request(payload)
+    end
+
+    # getreceivedbyaddress
+    '''The getreceivedbyaddress RPC returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions.'''
+    def received_by_address(address)
+      payload = {
+        method: 'getreceivedbyaddress'
+      }
+      payload[:params] = [address]
+      request(payload)
+    end
+
+    # gettransaction
+    def transaction(txid)
+      payload = {
+        method: 'gettransaction',
+        params: [txid]
+      }
+
+      request(payload)
+    end
+
+    # gettxout
+    def tx_out
+      raise NotImplementedError
+    end
+
+    # gettxoutsetinfo
+    def tx_out_set_info
+      raise NotImplementedError
+    end
+
+    # getwork
+    def work
+      raise NotImplementedError
+    end
+
+    # help
+    def help
+      raise NotImplementedError
+    end
+
+    # importprivkey
+    def import_priv_key
+      raise NotImplementedError
+    end
+
+    # keypoolrefill
+    def keypool_refill
+      raise NotImplementedError
+    end
+
+    # listaccounts
+    def list_accounts(minconf = nil)
+      payload = {
+        method: 'listaccounts'
+      }
+
+      payload[:params] = [minconf] unless minconf.nil?
+
+      request(payload)
+    end
+
+    # listaddressgroupings
+    def list_address_groupings
+      raise NotImplementedError
+    end
+
+    # listreceivedbyaccount
+    def list_received_by_account
+      raise NotImplementedError
+    end
+
+    # listreceivedbyaddress
+    def list_received_by_address
+      raise NotImplementedError
+    end
+
+    # listsinceblock
+    def list_since_block
+      raise NotImplementedError
+    end
+
+    # listtransactions
+    def list_transactions(account = nil, count = nil, from = nil)
+      payload = {
+        method: 'listtransactions'
+      }
+      unless account.nil?
+        payload[:params] = [account]
+        payload[:params] << count unless count.nil?
+        payload[:params] << from unless from.nil?
+      end
+      request(payload)
+    end
+
+    # listunspent
+    def list_unspent
+      raise NotImplementedError
+    end
+
+    # listlockunspent
+    def list_lock_unspent
+      raise NotImplementedError
+    end
+
+    # lockunspent
+    def lock_unspent
+      raise NotImplementedError
+    end
+
+    # move
+    def move
+      raise NotImplementedError
+    end
+
+    # sendfrom
+    def send_from
+      raise NotImplementedError
+    end
+
+    # sendmany
+    def send_many
+      raise NotImplementedError
+    end
+
+    # sendrawtransaction
+    def send_raw_transaction
+      raise NotImplementedError
+    end
+
+    # sendtoaddress
+    def send_to_address(address, amount, comment = nil, comment_to = nil)
+      payload = {
+        method: 'sendtoaddress',
+        params: [address, amount]
+      }
+      payload[:params] << comment unless comment.nil?
+      payload[:params] << comment_to unless comment_to.nil?
+      request(payload)
+    end
+
+    # setaccount
+    def account=(_)
+      raise NotImplementedError
+    end
+
+    # setgenerate
+    def generate=(_)
+      raise NotImplementedError
+    end
+
+    # settxfee
+    def tx_fee=(_)
+      raise NotImplementedError
+    end
+
+    # signmessage
+    def sign_message
+      raise NotImplementedError
+    end
+
+    # signrawtransaction
+    def sign_raw_transaction
+      raise NotImplementedError
+    end
+
+    # stop
+    def stop
+      raise NotImplementedError
+    end
+
+    # submitblock
+    def submit_block
+      raise NotImplementedError
+    end
+
+    # validateaddress
+    def validate_address(address)
+      payload = {
+        method: 'validateaddress',
+        params: [address]
+      }
+
+      request(payload)
+    end
+
+    # verifymessage
+    def verify_message
+      raise NotImplementedError
+    end
+
+    # walletlock
+    def wallet_lock
+      raise NotImplementedError
+    end
+
+    # walletpassphrase
+    def wallet_passphrase
+      raise NotImplementedError
+    end
+
+    # walletpassphrasechange
+    def wallet_passphrase_change
+      raise NotImplementedError
+    end
+
+    def valid_address?(address)
+      validate_address(address)['isvalid']
+    end
+
+    private
+
+    def request(payload)
+      response = HTTParty.post(url, body: payload.to_json, headers: HEADERS)
+      raise Error, response.message unless response.code == 200
+      JSON.parse(response.body)['result']
+    end
+
+    def url
+      "http://#{user}:#{password}@#{host}:#{port}"
+    end
+  # end
+end

data/lib/cryptobank/error.rb

@@ -0,0 +1,3 @@
+module Cryptobank
+  Error = Class.new(StandardError)
+end

data/lib/cryptobank/version.rb

@@ -0,0 +1,3 @@
+module Cryptobank
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: cryptobank
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grace Christenbery
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- grace@gracefulco.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cryptobank.gemspec
+- lib/cryptobank.rb
+- lib/cryptobank/error.rb
+- lib/cryptobank/version.rb
+homepage: https://github.com/Grace/cryptobank
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A toolbox for working with cryptocurrencies. Cryptobank provides Ruby wrappers
+  for the Bitcoin API JSON-RPC.
+test_files: []