monero 0.0.0.8 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 27c4e033d415d77d4ce9ab1cd1da67606c1c6f96
-  data.tar.gz: 752cea86b3569ade300a446bd5bedcaeff2e6aa1
+SHA256:
+  metadata.gz: e9e8cc4121eff928d8b1c72f84f3af18dcc5d8cceab58fd8472fbb9a038c79a6
+  data.tar.gz: d70534fb325c85d99a7ad217209b04584aa6d2bfe31854a88dcbf0285f835d68
 SHA512:
-  metadata.gz: 8180e1eeb59f2702cb2876125126c1bc2a59ca755c4737e0f7ad5663f606cef38d455017b3deca1080ad98e69d181519149009590d6b04186d96dd7e96f53e2a
-  data.tar.gz: 47b89d0a8b8e941310e8e05c3f6af5bf4470263ec3aed46950f8c852db3c6df31b83cf71ad0b1028432ed95f45a2f0ac48f51fe8a369762606177903daa445f8
+  metadata.gz: 3f1c396f5d309f9b132caec7b0eed269714041f5a373ab679a1b5b32cf1e7bf3d999646bb0a53a47cf3e5c1f334bc52255808c1d236bfd32dbc68b4f461264d6
+  data.tar.gz: 8ab32be640a75e40929f508e7e3ec4bd59b071a74f6d8ec5f2088417c1393f1c09f617771df9243c185d69b91480148d56ff384a224e5da47740a44b1e8c42df

data/.gitignore

@@ -1 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/config.yml
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
 monero-*.gem

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 monero.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    monero (0.0.0.11)
+      money
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    money (6.13.4)
+      i18n (>= 0.6.4, <= 2)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  monero!
+  rake
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tim Kretschmer
+
+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

@@ -1,179 +1,206 @@
-*Heavy development. Tested against 0.12.0 without issues. Please contribute. If you want to send Testnet transactions, please always send them back to https://dis.gratis*
-
 # Monero Ruby Client
 
 Ruby client to connect and use [Monero Wallet RPC](https://getmonero.org/resources/developer-guides/wallet-rpc.html).
 
+*Tested against [0.14.1.2 Boron Butterfly](https://web.getmonero.org/downloads/) without issues. Please contribute. If you want to send testnet transactions, please always send them back to https://dis.gratis or any other faucet*
 
-___
+---
 #### Disclaimer - before you start - *important notice!*
-To try out please make sure that you run your **monerod** and your **monero-wallet-rpc** with the `--testnet` option. Always use the Testchain to play around. Be careful with your wallet, you might lose coins if you try out on the real chain.
+To try out please make sure that you run your **monerod** and your **monero-wallet-rpc** with the `--stagenet` or `--testnet` option. Always use the stagenet or testnet to play around. Be careful with your wallet, you might lose coins if you try out on the real chain.
 
+- Stagenet Faucet: https://community.xmr.to/faucet/stagenet/
 - Testnet Faucet: https://dis.gratis/
 - Testnet Blockexplorer: https://testnet.xmrchain.com
+- in case the faucets are offline or empty just ask on reddit or in IRC #monero, #monero-dev or #monero-pools
 ---
 
-
-
-
 ## Installation
 For easy installation add `gem 'monero'` to your Gemfile or run `gem install monero`
 
-
 ## Preparation
+Start your daemon `./monerod --testnet` or `./monerod --stagenet`
 
-Start your daemon `./monerod --testnet`
+Start your RPC Client `./monero-wallet-rpc --testnet  --rpc-bind-port 28081 --rpc-bind-ip 127.0.0.1  --rpc-login username:password --log-level 4`
 
-Start your RPC Client `./monero-wallet-rpc --testnet  --rpc-bind-port 18081 --rpc-bind-ip 127.0.0.1  --rpc-login username:password --log-level 4`
 
 - To open a wallet at start use `--wallet-file filename` and `--password pass`
 - In case you need to access the client from another machine, you need to set `--confirm-external-bind`.
 - To be able to create/open other wallets you need to specify `--wallet-file /path/to/wallets/on/your/machine`
-- if you don't specify `--rpc-login` a file will be created that stores the login data (`cat monero-wallet-rpc.18081.login`)
+- if you don't specify `--rpc-login` a file will be created that stores the login data (`cat monero-wallet-rpc.28081.login`)
+
+You can also use
+[monerod-rpc-docker](https://github.com/xaviablaza/monerod-rpc-docker) by
+xaviablaza to run monerod and the RPC client.
 
 ## Getting started
 
 ### Configuration
-    RPC.config.host = "127.0.0.1"
-    RPC.config.port = "18081"
-    RPC.config.username = "username"
-    RPC.config.password = "password"
-    RPC.config.transfer_clazz = "MoneroTransfer" # you can set your own class to get incoming transfers as a model rather then a json
-
+You can predefine all variables via configuration. You don't need to do this.
+```ruby
+
+MoneroRPC.config.host = "127.0.0.1"
+MoneroRPC.config.port = "18081"
+MoneroRPC.config.username = "username"
+MoneroRPC.config.password = "password"
+MoneroRPC.config.debug = true
+# If you call for transfers you already receive objects MoneroRPC::IncomingTransfer and MoneroRPC::OutgoingTransfer. However, you can use your own classes.
+# MoneroRPC.config.in_transfer_clazz = "MyOwnClassForIncomingTransfers"
+# MoneroRPC.config.out_transfer_clazz = "OutgoinMoneroTransfer"
+```
 
 ### Usage
 
 Monero Ruby Client is very easy to use. Full documentation of RPC Client: https://getmonero.org/resources/developer-guides/wallet-rpc.html#transfer
 
-___
-
+just crate a new instance
+`$monero_rpc = MoneroRPC.new(host: "192.168.0.202", port: "28081", username: "username", password: "password")`
 
+---
 Get the current address
+```ruby
+$monero_rpc.address
+=> "9wm6oNA5nP3LnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjTDpKXAE"
+```
 
-    RPC::Wallet.address
-	=> "9wm6oNA5nP3LnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjTDpKXAE"
-
-___
-
-Create a new Subaddress with a label
-
-    RPC::Wallet.create_address "family savings"
-    => {"address"=>"BZFWM5MrhK64DD5TH1JVxR4JbuQpmRSFKi4SHQD2TrSrDFU8AK16YSjN7K8WSfjAfnZeJeskBtkgr73LbPZc4vMbQr3YvHj", "address_index"=>1}
-
-___
+---
+Create a new subaddress with a label (label is optional)
+```ruby
+$monero_rpc.create_address "family savings"
+=> {"address"=>"BZFWM5MrhK64DD5TH1JVxR4JbuQpmRSFKi4SHQD2TrSrDFU8AK16YSjN7K8WSfjAfnZeJeskBtkgr73LbPZc4vMbQr3YvHj", "address_index"=>1}
+```
 
+---
 Create a new address for a payment (integrated address)
+```ruby
+$monero_rpc.make_integrated_address
+=> {"integrated_address"=>"A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfufSYUchQ8hH2R272H",
+    "payment_id"=>"9d985c985ce58a8e"}
+```
 
-	RPC::Wallet.make_integrated_address
-	=> {"integrated_address"=>"A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfufSYUchQ8hH2R272H",
- 	"payment_id"=>"9d985c985ce58a8e"}
-  ___
-
-Get a list of all Adresses of your wallet
-
-    RPC::Wallet.get_addresses
-
-___
-
+---
+Get a list of all addresses of your wallet
+```ruby
+$monero_rpc.get_addresses
+```
 
+---
 To get the balance of the current wallet (we use the gem 'money')
+```ruby
+$monero_rpc.balance
+# returns an ::XMR object which is just a shortcut for ::Money(amount, :xmr)
+=> <Money fractional:9980629640000 currency:XMR>
 
-    RPC::Wallet.balance
-    # returns an ::XMR object which is just a shortcut for ::Money(amount, :xmr)
-    => #<Money fractional:9980629640000 currency:XMR>
-
-    RPC::Wallet.balance.format
-    => "9.980629640000 XMR"
+$monero_rpc.balance.format
+=> "9.980629640000 XMR"
+```
 
 To get the unlocked balance, which is currently available
-
-    RPC::Wallet.unlocked_balance
-    => #<Money fractional:10000 currency:XMR>
+```ruby
+$monero_rpc.unlocked_balance
+=> <Money fractional:10000 currency:XMR>
+```
 
 To get both combined
+```ruby
+$monero_rpc.getbalance
+=> {"balance"=>9961213880000, "unlocked_balance"=>10000}
+```
 
-    RPC::Wallet.getbalance
-    => {"balance"=>9961213880000, "unlocked_balance"=>10000}
-
-
-
-___
+---
 To get the current block height
+```ruby
+$monero_rpc.getheight
+=> 1008032
+```
 
-    RPC::Wallet.getheight
-    => 1008032
-
-
-___
-
-Send XMR to an address via `RPC::Transfer.create`. If successfull you will get the transaction  details. If not succesfull you'll get returned nil.
+---
+Send XMR to an address via `$monero_rpc.create_transfer`. If successful you will get the transaction details. If not successful you'll get returned nil.
 
-    amount= 20075 #in atomic units. 1000000000000 == 1.0 XMR    
-    RPC::Transfer.create("A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfwGRvbCHYCZAaKSzDx", amount)
-	=> {"fee"=>19415760000,
- 		"tx_blob"=>"020001020005bbcf0896e3.......
+```ruby
+amount= 20075 # in atomic units; 1000000000000 == 1.0 XMR
+$monero_rpc.create_transfer("A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfwGRvbCHYCZAaKSzDx", amount)
+=> {"fee"=>19415760000,
+    "tx_blob"=>"020001020005bbcf0896e3.......
+```
 
+The return hash consists of:
+```
+{amount, fee, multisig_txset, tx_blog, tx_hash, tx_key, tx_metadata,
+unsigned_txset}
+```
 
 To send payments you can also specify the following options:
 
-    options = { fee: fee, mixin: 5, unlock_time: unlock_time, payment_id: "c7e7146b3335aa54", get_tx_key: true, priority: 0, do_not_relay: false, get_tx_hex: true}
-Please note that `fee` is currently ignored by the chain.
+```ruby
+options = { fee: fee, mixin: 5, unlock_time: unlock_time, payment_id: "c7e7146b3335aa54", get_tx_key: true, priority: 0, do_not_relay: false, get_tx_hex: true}
+```
 
+Please note that `fee` is currently ignored by the chain.
 
 To send payments to multiple recipients simply use an array of `[:recipient, :amount]`. For example:
 
-    recipients = [
-    	{address:A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfwGRvbCHYCZAaKSzDx amount: 1599999},
-    	{address:A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9Hjftr1RgJ6RM4BMMPLUc amount: 130000},
-    	{address:A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfrgPgAEasYGSVhUdwe amount: 442130000}
-    ]
-
-    RPC::Transfer.send_bulk(recipients, options)
-
-___
+```ruby
+recipients = [
+  {address:"A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfwGRvbCHYCZAaKSzDx" amount: 1599999},
+  {address:"A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9Hjftr1RgJ6RM4BMMPLUc" amount: 130000},
+  {address:"A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfrgPgAEasYGSVhUdwe" amount: 442130000}
+]
 
+$monero_rpc.send_bulk_transfer(recipients, options)
+```
 
+---
 To get a list of transfers you call `get_transfers(args)`. Options are `in (true)`, `out (false)`, `pending (true)`, `failed (false)`, `pool (true)`, `filter_by_height (false)`, `min_height` and `max_height`
 
-___
+---
+To get all incoming transfers use `get_all_incoming_transfers(args)`. Args can be `min_height` and `max_height` to filter accordingly. Result is a list of `MoneroRPC::IncomingTransfer` objects.
 
-To get all incoming transfers use `get_all_incoming_transfers(args)`. Args can be `min_height` and `max_height` to filter accordingly. Result is a list of `RPC::IncomingTransfer` objects.
+```ruby
+incomes = $monero_rpc.get_all_incoming_transfers(min_height: 1087400)
+=> [#<MoneroRPC::IncomingTransfer:0x000000036d3ca8 ...>, #<MoneroRPC::IncomingTransfer:0x000000036d38c0 ...>, #<MoneroRPC::IncomingTransfer:0x000000036d3258 ...>, #<MoneroRPC::IncomingTransfer:0x000000036d2c90 ...> ....
 
-    incomes = RPC::Wallet.get_all_incoming_transfers(min_height: 1087400)
-    => [#<RPC::IncomingTransfer:0x000000036d3ca8 ...>, #<RPC::IncomingTransfer:0x000000036d38c0 ...>, #<RPC::IncomingTransfer:0x000000036d3258 ...>, #<RPC::IncomingTransfer:0x000000036d2c90 ...> ....
+incomes.first.confirmed?
+=> false
 
-    incomes.first.confirmed?
-    => false
+incomes.first.pending?
+=> true
 
-    incomes.first.pending?
-    => true
+incomes.first.confirmations?
+=> 0
 
-    incomes.first.confirmations?
-    => 0
+incomes.first.address
+=> "9vN5sHeH2a6AbRsB1dZ3APavL3YyFLguhh5pu2cAHb4CTY9GtnsEsBYTzwxzL6XH4Uby2Svju8sYvZN7mDMcd6MTKDvBgVR"
 
-    incomes.first.address
-    => "9vN5sHeH2a6AbRsB1dZ3APavL3YyFLguhh5pu2cAHb4CTY9GtnsEsBYTzwxzL6XH4Uby2Svju8sYvZN7mDMcd6MTKDvBgVR"
+incomes.first.amount
+=> 0.40123
+```
 
-    incomes.first.amount
-    => 0.40123
+You can use your own custom class by using the config `MoneroRPC.config.in_transfer_clazz = "MyCustomMoneroTransfer"`
 
-You can use your own custom class by using the config `RPC.config.transfer_clazz = "MyCustomMoneroTransfer"`
+The same works for outgoing transfers where we have "MoneroRPC::OutgoingTransfer"
 
-___
+    $monero_rpc.get_all_outgoing_transfers
 
-For a specific Transfer simply call `get_transfer_by_txid(tx_id)`
 
-___
+---
+For a specific Transfer simply call `$monero_rpc.get_transfer_by_txid(tx_id)`
 
+---
+## Running tests
 
+Configure the RPC singleton in
+[spec_helper.rb](https://github.com/krtschmr/monero/blob/master/spec/spec_helper.rb)
 
 ## Donations
 If this was useful you might consider a small donation:
 
-- XMR: 42gYBRdXZbDdpV8gn7ntZySQuY4kzF7upNw67cj1LkkxV3kgjqoBBU9fBPeh4mZMMb75WAkNisvKdehdiE3g7Awx3JSdd5Y
+krtschmr:
+```
+42gYBRdXZbDdpV8gn7ntZySQuY4kzF7upNw67cj1LkkxV3kgjqoBBU9fBPeh4mZMMb75WAkNisvKdehdiE3g7Awx3JSdd5Y
+```
 
 Even better would be your contribution to the code. Let's work together and make this gem a great place for all Monero fans! Don't just fork and do your own thing. My idea for this gem isn't the way we have to do. Feel free to bring yourself into this project. I'm willing to change everything from scratch if it will benefit the future.
 
-
-## LICENSE
-MIT
+## License
+This gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "monero"
+
+# 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/lib/monero.rb

@@ -1,26 +1,50 @@
 require 'money'
-require 'rpc/config'
-require 'rpc/payment'
-require 'rpc/client'
-require 'rpc/version'
-require 'rpc/wallet'
-require 'rpc/transfer'
-require 'rpc/incoming_transfer'
+require 'monero_rpc/config'
+require 'monero_rpc/payment'
+require 'monero_rpc/wallet'
+require 'monero_rpc/version'
+require 'monero_rpc/transfer'
+require 'monero_rpc/transfer_class'
+require 'monero_rpc/client'
 
-module RPC
+module MoneroRPC
   def self.config
-    @@config ||= RPC::Config.instance    
+    @@config ||= MoneroRPC::Config.instance
   end
+
+  def self.new(args={})
+    host     = args.fetch(:host,     MoneroRPC.config.host) || raise("missing host")
+    port     = args.fetch(:port,     MoneroRPC.config.port) || raise("missing port")
+    username = args.fetch(:username, MoneroRPC.config.username) || raise("missing username")
+    password = args.fetch(:password, MoneroRPC.config.password) || raise("missing password")
+    debug    = args.fetch(:debug,    MoneroRPC.config.debug)
+    in_transfer_clazz = args.fetch(:in_transfer_clazz, MoneroRPC.config.in_transfer_clazz)
+    out_transfer_clazz = args.fetch(:out_transfer_clazz, MoneroRPC.config.out_transfer_clazz)
+
+    Client.new(host: host, port: port, username: username, password: password, debug: debug, in_transfer_clazz: in_transfer_clazz, out_transfer_clazz: out_transfer_clazz)
+  end
+
 end
 
-Money::Currency.register({ :priority            => 1, :iso_code            => "xmr", :iso_numeric         => "846", :name                => "Monero", :symbol              => "XMR", :subunit             => "", :subunit_to_unit     => 1000000000000, :decimal_mark        => ".", :thousands_separator => ""})
-#
+Money::Currency.register({
+  :priority => 1,
+  :iso_code => "xmr",
+  :iso_numeric => "846",
+  :name => "Monero",
+  :symbol => "XMR",
+  :subunit => "",
+  :subunit_to_unit => 1000000000000,
+  :decimal_mark => ".",
+  :thousands_separator => ""
+})
 
 unless Object.const_defined?('XMR')
-
   class XMR
     def self.new(amount); Money.new(amount, :xmr); end
     def to_s; Money.new(amount, :xmr).format.to_s; end
   end
-
 end
+
+I18n.enforce_available_locales = false
+Money.locale_backend = :i18n
+I18n.locale = :en