monero 0.0.0.1 → 0.0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd84009849fb3291334b23b153374a56390dac55
-  data.tar.gz: e772a95b40ea13a21aa82ac9bfc037837404ba45
+  metadata.gz: 8b0549acfa68f3efdc2d4a1a141a460ed180a699
+  data.tar.gz: a554fde5c534e43c9e019ae008630f8c792c9b05
 SHA512:
-  metadata.gz: 45c2b677f3a24f406d8cd8366c8ac724e3ea675a4e9dd4b4b5664a2f4200de3ec2fe11a258384f4782e1da96810bf52e98024a3c1148a8acc2b7533ee6a79466
-  data.tar.gz: e560bc30710f1cd45745f529f992fb5b490aebde01c8ae199348b3681d0f07b1fa5e21145a9f29ac9d97a3011db417e1019547ad9b2f4fb7989d75462d0e4065
+  metadata.gz: c756cdb2a4b451692e704219ad76b768f9ea3e183618fa1de2fe4207d0b111ebcd7e9e448e5fdca044aa3f149ddabb1fca919cdd9c415e80fed53fbc25e1ef12
+  data.tar.gz: dd78a9e2f341d2665ee4e7cb7277bde30e851914f44787723a163c9bc26cd9cc81eb9c8e8ea6c444d2675f50920af4a92ac1057b96fd94ca2c6317a4bc616684

data/.gitignore

@@ -0,0 +1 @@
+monero-*.gem

data/README.md

@@ -1,18 +1,117 @@
 # Monero Ruby Client
 
-Ruby client to connect and use Monero via monero-wallet-rpc.
+Ruby client to connect and use [Monero Wallet RPC](https://getmonero.org/resources/developer-guides/wallet-rpc.html).
 
 
-Set your rpc details
+___
+#### 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.
 
-    Monero.config.host = "192.168.1.226"
+- Testnet Faucet: https://dis.gratis/
+- Testnet Blockexplorer: https://testnet.xmrchain.com
+---
+
+
+
+
+## Installation
+For easy installation add `gem 'monero'` to your Gemfile or run `gem install monero`
+
+
+## Preparation
+
+Start your daemon `./monerod --testnet`
+
+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 --wallet-dir ./`
+
+- 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`)
+
+## Getting started
+
+### Configuration
+    Monero.config.host = "127.0.0.1"
     Monero.config.port = "18081"
     Monero.config.username = "username"
     Monero.config.password = "password"
 
 
-usage:
 
-   Monero::Wallet.balance
+### Usage
+
+Monero Ruby Client is very easy to use. Full documentation of RPC Client: https://getmonero.org/resources/developer-guides/wallet-rpc.html#transfer
+
+___
+
+
+Get the current address
+
+    Monero::Wallet.address
+	=> "9wm6oNA5nP3LnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjTDpKXAE"
+___
+
+Create a new address for a payment (integrated address)
+
+	Monero::Wallet.make_integrated_address
+	=> {"integrated_address"=>"A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfufSYUchQ8hH2R272H",
+ 	"payment_id"=>"9d985c985ce58a8e"}
+___
+To get the balance of the current wallet (we use the gem 'money')
+
+    Monero::Wallet.balance
+    # returns an ::XMR object which is just a shortcut for ::Money(amount, :xmr)
+    => #<Money fractional:9980629640000 currency:XMR>
+
+    Monero::Wallet.balance.format
+    => "9.980629640000 XMR"
+
+___
+To get the current block height
+
+    Monero::Wallet.getheight
+    => 1008032
+
+
+___
+
+Send XMR to an address via `Monero::Transfer.create`. If successfull you will get the transaction  details. If not succesfull you'll get returned nil.
+
+    amount= 20075 #in atomic units. 1000000000000 == 1.0 XMR    
+    Monero::Transfer.create("A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfwGRvbCHYCZAaKSzDx", amount)
+	=> {"fee"=>19415760000,
+ 		"tx_blob"=>"020001020005bbcf0896e3.......
+
+
+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.
+
+
+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}
+    ]
+
+    Monero::Transfer.send_bulk(recipients, options)
+
+___
+
+
+## Donations
+If this was useful you might consider a small donation:
+
+- XMR: 4H19KAdSw1pL2v1iaEx31ngQCQcEGobUpevqtzSzKPTAEAt1Ay7NZrQgU6mnN2mVyWi7yk2ig68KsU8bfXQ45ainLTZFWU7m94yT3D9qUX
+- BTC:
+- LTC:
+
+
+
 
-   ...
+## LICENSE
+MIT

data/lib/monero.rb

@@ -4,6 +4,7 @@ require 'monero/payment'
 require 'monero/client'
 require 'monero/version'
 require 'monero/wallet'
+require 'monero/transfer'
 
 module Monero
   def self.config

data/lib/monero/client.rb

@@ -1,20 +1,21 @@
 module Monero
   class Client
 
-    def self.request(method, params=nil)
-      params_string = ""
-      if params
-        # TODO multi params looping
-        k,v = params.first
-        params_string = '"'+k.to_s+'": "'+v.to_s+'"'
-      end
-
-      data = '{"jsonrpc":"2.0","id":"0","method": "'+method+'", "params": { '+params_string+' } }'
+    def self.close!
+      request("stop_wallet")
+    end
+
+    def self.request(method, params="")
+      data = '{"jsonrpc":"2.0","id":"0","method": "'+method+'", "params": '+params.to_json+' }'
+
       args = " -s"
       args << " -u #{Monero.config.username}:#{Monero.config.password} --digest"
       args << " -X POST #{base_uri}/json_rpc"
       args << " -d '#{data}'"
       args << " -H 'Content-Type: application/json'"
+
+      p "curl #{args}" if Monero.config.debug
+
       json = JSON.parse(`curl #{args}`)
       json["result"]
     end
@@ -26,5 +27,5 @@ module Monero
     end
 
   end
-  
+
 end

data/lib/monero/config.rb

@@ -1,9 +1,7 @@
 require 'singleton'
-
 module Monero
   class Config
     include Singleton
-    attr_accessor :host, :port, :username, :password
-
+    attr_accessor :host, :port, :username, :password, :debug
   end
 end

data/lib/monero/transfer.rb

@@ -0,0 +1,55 @@
+# transfer
+# Send monero to a number of recipients.
+# Inputs:
+# destinations - array of destinations to receive XMR:
+# amount - unsigned int; Amount to send to each destination, in atomic units.
+# address - string; Destination public address.
+
+# fee - unsigned int; Ignored, will be automatically calculated.
+
+# mixin - unsigned int; Number of outpouts from the blockchain to mix with (0 means no mixing).
+
+# unlock_time - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).
+
+# payment_id - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.
+
+# get_tx_key - boolean; (Optional) Return the transaction key after sending.
+
+# priority - unsigned int; Set a priority for the transaction. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.
+
+# do_not_relay - boolean; (Optional) If true, the newly created transaction will not be relayed to the monero network. (Defaults to false)
+
+# get_tx_hex - boolean; Return the transaction as hex string after sending
+
+
+module Monero
+  # => {"integrated_address"=>"A7TmpAyaPeZLnugTKRSwGJhW4vnYv8RAVdRvYyvbistbHUnojyTHyHcYpbZvbTZHDsi4rF1EK5TiYgnCN6FWM9HjfwGRvbCHYCZAaKSzDx", "payment_id"=>"c7e7146b3335aa54"}
+
+  class Transfer
+
+    def self.create(address, amount, args={})
+      send_bulk([address: address, amount: amount], args)
+    end
+
+    def self.send_bulk(destinations, args={})
+
+      mixin = args.fetch(:mixin, 4)
+      fee = args.fetch(:fee, 1) # ignored anyways
+      unlock_time = args.fetch(:unlock_time, 0)
+      payment_id = args.fetch(:payment_id, nil)
+      get_tx_key = args.fetch(:get_tx_key, true)
+      priority = args.fetch(:priority, 0)
+      do_not_relay = args.fetch(:do_not_relay, false)
+      get_tx_hex = args.fetch(:get_tx_hex, false)
+
+
+      options = {
+        destinations: destinations, fee: fee, mixin: mixin, unlock_time: unlock_time, 
+        payment_id: payment_id, get_tx_key: get_tx_key, priority: priority, do_not_relay: do_not_relay, get_tx_hex: get_tx_hex
+      }
+
+      Monero::Client.request("transfer", options)
+    end
+
+  end
+end

data/lib/monero/version.rb

@@ -1,3 +1,3 @@
 module Monero
-  VERSION = "0.0.0.1"
+  VERSION = "0.0.0.2"
 end

data/lib/monero/wallet.rb

@@ -31,6 +31,9 @@ module Monero
       raise ArgumentError unless ["mnemonic", "view_key"].include?(type.to_s)
       Monero::Client.request("query_key", {key_type: type})["key"]
     end
+    def self.view_key; query_key(:view_key); end
+    def self.mnemonic_seed; query_key(:mnemonic); end
+
 
     def self.make_integrated_address(payment_id = "")
       # TODO
@@ -51,10 +54,63 @@ module Monero
       payments.map{|x| Payment.from_raw(x) }
     end
 
+
+      # in - boolean;
+      # out - boolean;
+      # pending - boolean;
+      # failed - boolean;
+      # pool - boolean;
+      # filter_by_height - boolean;
+      # min_height - unsigned int;
+      # max_height - unsigned int;
+    def self.get_transfers(args={})
+      f_in = args.fetch(:in, true)
+      out = args.fetch(:out, false)
+      pending = args.fetch(:pending, true)
+      failed = args.fetch(:failed, false)
+      pool = args.fetch(:pool, true)
+      filter_by_height = args.fetch(:filter_by_height, false)
+      min_height = args.fetch(:min_height, 0)
+      max_height = args.fetch(:max_height, 0)
+
+      options = {in: f_in, out: out, pending: pending, failed: failed, pool: pool, filter_by_height: filter_by_height, min_height: min_height, max_height: max_height}
+
+      Monero::Client.request("get_transfers", options)
+    end
+
     def self.get_transfer_by_txid(txid)
       Monero::Client.request("get_transfer_by_txid", {txid: txid })
     end
 
+    # creates a wallet and uses it
+    # if wallet exists, will automatically uses it!
+    def self.create_wallet(filename, password, language="English")
+      # TODO
+      # language correct format?
+      options = { filename: filename, password: password, language: language }
+      !! Monero::Client.request("create_wallet", options)
+    end
+    singleton_class.send(:alias_method, :create, :create_wallet)
+
+    # returns current balance if open successfull
+    def self.open_wallet(filename, password)
+      options = { filename: filename, password: password}
+      if Monero::Client.request("open_wallet", options)
+        balance
+      else
+        false
+      end
+    end
+    singleton_class.send(:alias_method, :open, :open_wallet)
+
+    # stops current wallet
+    def self.stop_wallet
+      Monero::Client.close!
+    end
+    singleton_class.send(:alias_method, :close, :stop_wallet)
+
+
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monero
 version: !ruby/object:Gem::Version
-  version: 0.0.0.1
+  version: 0.0.0.2
 platform: ruby
 authors:
 - Tim Kretschmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,11 +73,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - README.md
 - lib/monero.rb
 - lib/monero/client.rb
 - lib/monero/config.rb
 - lib/monero/payment.rb
+- lib/monero/transfer.rb
 - lib/monero/version.rb
 - lib/monero/wallet.rb
 - lib/xmr.rb