mpex 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 658fe66b10c2a22bcfa1eada43373cad3bd62f74
-  data.tar.gz: a99ab6a7c1cfcd058f4e4f6430c651286d8ea6d6
+  metadata.gz: cd9551c09a979bed1c63ec2de3ec1361a8991d33
+  data.tar.gz: a6db4d8d13748dcc459fdf3f848936734b4fdf93
 SHA512:
-  metadata.gz: cdfbe7c29b3622eb97223f26847b7ac06d1a012b7e9e91c5c2eb207287d3b2ea7463e75b96dc21c01a74ca955cba3d665fc5931c370e07af382e760fe47a31f1
-  data.tar.gz: 25cba8ee8577f4b39a51a0629467ff3f635e3e0f2c5b9f24f2561ce6ba860fe43ed86d4dd5a62f4992ba9ba652e0efaa87b9e80b6f08aabc2200f98974a16671
+  metadata.gz: d60556f322dfac6963e4b6d8ba5654d55d5bed58d6c4000e10b0e9e66b8de38419051cdfb720339ac935eea70df8e287d13e91fbcd5d944baa665e6e12a79fdc
+  data.tar.gz: c44f83886cccbfc6dd350facf76c5e7b2a68e7be47ba56ede007da63be1dc281a599cdb76216dc62512a93eb54797994afe7dc108eb500e5dc6c1e632069c3c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mpex (0.5.0)
+    mpex (0.6.0)
       cri (~> 2.2)
       gpgme
       highline

data/README.md

@@ -11,11 +11,11 @@ MPEx.rb is a commandline client for [MPEx](http://mpex.co), a Bitcoin security e
 
 ## Usage
 
-  $ mpex help
+  * mpex help
 
 If you want to use MPEx via IRC, use the interactive mode:
 
-  $ mpex -i
+  * mpex -i
 
 ## License
 

data/config.yaml.sample

@@ -0,0 +1,4 @@
+url: http://mpex.co/
+keyid: Default
+mpexkeyid: CFE0F3E1
+interactive: true

data/lib/mpex/cli.rb

@@ -1,12 +1,13 @@
 require 'cri'
 require 'json'
+require 'highline/import'
 
 module Mpex::CLI
 
 @cmd = Cri::Command.define do
   name 'mpex'
   usage 'mpex [options] [command] [options]'
-  summary 'commandline interface for MPEX trading'
+  summary 'commandline interface for MPEx trading'
   description <<-DESC
     To change default settings edit ~/.mpex/config.yaml 
 
@@ -17,12 +18,14 @@ module Mpex::CLI
     exit 0
   end
 
-  option :s, :url, 'URL to MPEX (defaults to mpex.co)'
+  option :s, :url, 'URL to MPEx (defaults to http://mpex.co)'
   option :u, :keyid, 'key id of your gnupg key to use'
-  option :m, :mpexkeyid, 'mpex public key id'
+  option :m, :mpexkeyid, 'MPEx public key id (see FAQ#8)'
   option :p, :password, 'passphrase of your private key (unless provided you\'ll be asked for it)'
 
-  opt :i, :interactive, "start alternative interactive mode to mpex, useful for irc" do
+  option "0", :isinteractive, "internal flag set automatically in interactive mode"
+
+  opt :i, :interactive, "Start interactive mode to MPEx.rb. Required for irc. (think: an MPEx shell)" do
     Mpex::Interactive.run
     exit 0
   end
@@ -42,12 +45,12 @@ Mpex::Mpex.new.create_configfile_unless_exists # makes sure config file is prese
   name 'stat'
   aliases [:STAT, :status]
   usage 'stat [options]'
-  summary 'old style standard mpex STAT'
+  summary 'Formatted MPEx STATJSON'
 
   run do |opts, args|
     mpex = Mpex::Mpex.new
-    mpex.send_plain('STAT', opts) do |answer|
-      puts answer
+    mpex.statjson(opts) do |stat|
+      puts mpex.format_stat(stat)
     end
   end
 end
@@ -60,7 +63,7 @@ end
 
   run do |opts, args|
     mpex = Mpex::Mpex.new
-    mpex.send_plain('STATJSON', opts) do |answer|
+    mpex.statjson(opts, false) do |answer|
       puts answer
     end
   end
@@ -70,7 +73,7 @@ end
   name 'plain'
   aliases :p
   usage "plain [options] 'MPX|FOO|BAR'"
-  summary "send string as is signed/encrypted to mpex"
+  summary "send string as is signed/encrypted to MPEx"
 
   run do |opts, args|
     mpex = Mpex::Mpex.new
@@ -88,11 +91,14 @@ end
   run do |opts, args|
     mpex = Mpex::Mpex.new
     mpsic = mpex.validate_mpsic(args[0])
-    if args[2].match(/\./)
+    amount = args[1]
+    price = args[2]
+    if price.match(/\./)
       puts "Provide price in Satoshis!"
       exit 0
     end
-    order_string = "BUY|#{mpsic}|#{args[1]}|#{args[2]}"
+    say "<%= color('Buy #{amount} #{mpsic} @ #{Mpex::Converter.satoshi_to_btc(price.to_i)} BTC = #{Mpex::Converter.satoshi_to_btc(amount.to_i*price.to_i)} total BTC', :bold) %>"
+    order_string = "BUY|#{mpsic}|#{amount}|#{price}"
     mpex.send_plain(order_string, opts) do |answer|
       puts answer
     end
@@ -107,11 +113,14 @@ end
   run do |opts, args|
     mpex = Mpex::Mpex.new
     mpsic = mpex.validate_mpsic(args[0])
-    if args[2].match(/\./)
+    amount = args[1]
+    price = args[2]
+    if price.match(/\./)
       puts "Provide price in Satoshis!"
       exit 0
     end
-    order_string = "SELL|#{mpsic}|#{args[1]}|#{args[2]}"
+    say "<%= color('Sell #{amount} #{mpsic} @ #{Mpex::Converter.satoshi_to_btc(price.to_i)} BTC = #{Mpex::Converter.satoshi_to_btc(amount.to_i*price.to_i)} total BTC', :bold) %>"
+    order_string = "SELL|#{mpsic}|#{amount}|#{price}"
     mpex.send_plain(order_string, opts) do |answer|
       puts answer
     end
@@ -152,7 +161,7 @@ end
   usage "withdraw [options] [address] [amount in satoshi]"
 
   run do |opts, args|
-    puts .run('help'); exit 0 unless args.length == 2
+    #puts .run('help'); exit 0 unless args.length == 2
     mpex = Mpex::Mpex.new
     order_string = "WITHDRAW|#{args[0]}|#{args[1]}"
     mpex.send_plain(order_string, opts) do |answer|
@@ -168,8 +177,8 @@ end
 
   run do |opts, args|
     mpex = Mpex::Mpex.new
-    mpex.send_plain('STATJSON', opts) do |stat|
-      mpex.portfolio(opts, JSON.parse(stat)) do |portfolio|
+    mpex.statjson(opts) do |stat|
+      mpex.portfolio(opts, stat) do |portfolio|
         puts portfolio
       end if stat
     end
@@ -195,8 +204,13 @@ end
   summary 'connects an irc bot to freenode to talk to mpex via its bots'
 
   run do |opts, args|
-    $IRC_LEAK = Mpex::Irc.new
-    $IRC_LEAK.connect
+    if opts[:isinteractive]
+      $IRC_LEAK = Mpex::Irc.new
+      $IRC_LEAK.connect
+    else
+      puts "Connecting to IRC works in interactive mode only. Run 'mpex -i' to start MPEx.rb in interactive shell mode."
+      exit 0
+    end
   end
 end
 
@@ -209,7 +223,7 @@ end
     mpex = Mpex::Mpex.new
     mpex.list_proxies do |proxies|
       puts proxies
-      puts "To use a proxy, edit ~/.mpex/config.yaml and restart mpex cli"
+      puts "To use a proxy, edit ~/.mpex/config.yaml and restart mpex -i"
     end
   end
 end

data/lib/mpex/converter.rb

@@ -16,10 +16,10 @@ module Mpex
     
     def self.satoshi_to_btc(satoshi)
       satoshiStr = satoshi.to_s;
-      
+
       satoshiPart = "";
       btcPart = "0";
-      
+
       denominator = "";
 
       if (satoshiStr.size > 8)
@@ -38,13 +38,8 @@ module Mpex
           end
       end
 
-      # cut trailing zeros
-      while (satoshiPart.end_with?("0")) do
-          satoshiPart = satoshiPart.chomp("0");
-      end
-
       return denominator + btcPart + "." + satoshiPart;
     end
-    
+
   end
-end
+end

data/lib/mpex/interactive.rb

@@ -4,15 +4,17 @@ require 'highline/import'
 module Mpex::Interactive
 
   def self.run
-    puts "Welcome to MPEX repl. Type 'help' and 'help [command]' to get a help or 'quit' to exit."
+    puts "Welcome to MPEx.rb shell. Type 'help' and 'help [command]' to get a help or 'quit' to exit."
     puts "Donations welcome: 1DrqwLjksrXZHdSzzieaNhQuhrnbNTeiQr"
     puts "Type 'irc' to connect to Freenode to use MPEx IRC bots"
     loop do
       line = ask("mpex>> ") {|q| q.readline = true }
 
+      next if line.empty?
+
       exit 0 if line =~ /^(exit|quit|q)$/
 
-      args = line.split(" ")
+      args = line.split(" ") + ["--isinteractive"]
 
       begin
         Mpex::CLI.command.run(args) unless args.empty?

data/lib/mpex/irc.rb

@@ -14,7 +14,7 @@ module Mpex
       @irc = Net::YAIL.new(
         :address    => 'irc.freenode.net',
         :username   => 'mp_rb_client',
-        :realname   => 'mpex ruby irc client',
+        :realname   => 'MPEx.rb irc client',
         :nicknames  => ["mp_rb_client#{Random.rand(42..4096)}", "mp_rb_client#{Random.rand(42..4096)}"]
       )
       log = Logger.new(STDOUT)

data/lib/mpex/mpex.rb

@@ -11,6 +11,7 @@ module Mpex
 
     CONFIG_FILE_PATH = File.join(Dir.home, ".mpex", "config.yaml")
     LOGFILE_PATH = File.join(Dir.home, ".mpex", "response.log")
+    TRADES_LOGFILE_PATH = File.join(Dir.home, ".mpex", "trades.log")
 
     def initialize
       @crypto = GPGME::Crypto.new(:armor => true)
@@ -18,7 +19,14 @@ module Mpex
         dirname = File.dirname(File.expand_path(LOGFILE_PATH))
         Dir.mkdir(dirname) unless Dir.exist?(dirname)
       end
-      @logger = Logger.new(LOGFILE_PATH)
+      @logger = Logger.new(LOGFILE_PATH, 'daily')
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        "#{severity} Log entry @ #{datetime}:\n#{msg}\n\n"
+      end
+      @trades_log = Logger.new(TRADES_LOGFILE_PATH, 'daily')
+      @trades_log.formatter = proc do |severity, datetime, progname, msg|
+        "#{msg}\n"
+      end
     end
 
     def sign(msg, opts)
@@ -29,7 +37,7 @@ module Mpex
     end
 
     def verify(msg)
-      @crypto.verify(msg) do |signature|
+      verified_plain_msg = @crypto.verify(msg) do |signature|
         if signature.valid?
           say("<%= color('#{signature}', :green) %>")
         else
@@ -37,16 +45,19 @@ module Mpex
           raise "WARNING: Invalid signature! Don't trust!"
         end
       end
+      verified_plain_msg.to_s
     end
 
     def encrypt(signed_msg, opts)
-      @crypto.encrypt(signed_msg, :recipients => opts[:mpexkeyid])
+      encrypted = @crypto.encrypt(signed_msg, :recipients => opts[:mpexkeyid])
+      encrypted.to_s
     end
 
     def decrypt(encrypted_data, opts)
-      @crypto.decrypt(encrypted_data, :password => opts[:password]) do |signature|
+      decrypted = @crypto.decrypt(encrypted_data, :password => opts[:password]) do |signature|
         raise "Signature could not be verified" unless signature.valid?
       end
+      decrypted.to_s
     end
 
     def send_plain(cleartext_command, opts, &block)
@@ -72,12 +83,58 @@ module Mpex
     end
 
     def handle_answer(encrypted_answer, opts)
-      decrypted_response = decrypt(encrypted_answer.to_s, opts)
+      decrypted_response = decrypt(encrypted_answer, opts)
 
-      @logger.info(decrypted_response.to_s)
+      @logger.info(decrypted_response)
 
       verified_response = verify(decrypted_response)
-      verified_response.to_s
+      verified_response
+    end
+
+    def statjson(opts, parsed=true, &block)
+      send_plain('STATJSON', opts) do |statjson|
+        stat = JSON.parse(statjson)
+        log_trade_histroy(stat)
+        if parsed
+          yield stat
+        else
+          yield statjson
+        end
+      end
+    end
+
+    def log_trade_histroy(stat)
+      stat["TradeHistory"].each do |t|
+        unixtime = t.keys.first
+        unless unixtime == "md5Checksum"
+          @trades_log.info(t)
+        end
+      end
+    end
+
+    def format_stat(stat)
+      header = {}
+      stat["Header"].map { |h| header[h.keys.first] = h[h.keys.first] }
+<<-STAT
+Stats for #{header["Name"]} (fingerprint #{header["Fingerprint"]})
+Issued at #{header["DateTime"]} (#{header["Microtime"]})
+
+Holdings:
+#{holdings_formatted(stat)}
+To which add orders in the book fully paid in advance:
+#{book_formatted(stat)}
+Options Cover:
+  #{stat["OptionsCover"].size > 1 ? stat["OptionsCover"] : ""}
+Futures Cover:
+  #{stat["IMMCover"].size > 1 ? stat["IMMCover"] : ""}
+Excercises:
+  #{stat["Exercises"].size > 1 ? stat["Exercises"] : ""}
+Your transactions since 1 hour before your last STAT:
+#{trade_history_formatted(stat)}
+Dividends:
+  #{stat["Dividends"].size > 1 ? stat["Dividends"] : ""}
+Formatted STATJSON. If you want the original run 'plain STAT'. Logs can be found here: #{LOGFILE_PATH}.
+STAT
     end
 
     def validate_mpsic(mpsic)
@@ -100,13 +157,42 @@ module Mpex
       orders_value
     end
 
+    def cumulated_amounts(stat)
+      cumulated_amounts = {}
+      stat["Book"].each do |order|
+        mpsic = order[order.keys.first]["MPSIC"]
+        if (mpsic and order[order.keys.first]["BS"] == "S")
+          cumulated_amounts[mpsic] = cumulated_amounts[mpsic].to_i + order[order.keys.first]["Quantity"].to_i
+        elsif (mpsic and order[order.keys.first]["BS"] == "B")
+          cumulated_amounts["CxBTC"] = cumulated_amounts["CxBTC"].to_i + order[order.keys.first]["Quantity"].to_i * order[order.keys.first]["Price"].to_i
+        end
+      end
+      stat["Holdings"].each do |h|
+        mpsic = h.keys.first
+        cumulated_amounts[mpsic] = cumulated_amounts[mpsic].to_i + h[mpsic].to_i if (mpsic and mpsic!="md5Checksum")
+      end
+      cumulated_amounts
+    end
+
+    def cumulated_amounts_formatted(stat)
+      formatted = ""
+      cumulated_amounts(stat).each do |mpsic, amount|
+        if (mpsic == "CxBTC")
+          formatted << "  #{mpsic}:\t#{Converter.satoshi_to_btc(amount)}\n"
+        else
+          formatted << "  #{mpsic}:\t#{amount}\n"
+        end
+      end
+      formatted
+    end
+
     def orders_vwap_sum(stat, vwaps)
       orders_value = stat["Book"].map do |order|
         if order[order.keys.first]["BS"] == "B"
           order[order.keys.first]["Price"].to_i * order[order.keys.first]["Quantity"].to_i
         elsif order[order.keys.first]["BS"] == "S"
           mpsic = order[order.keys.first]["MPSIC"]
-          vwaps[mpsic]["1d"]["max"].to_i * order[order.keys.first]["Quantity"].to_i
+          vwaps[mpsic] ? vwaps[mpsic]["1d"]["max"].to_i * order[order.keys.first]["Quantity"].to_i : 0
         else
           0
         end
@@ -178,13 +264,42 @@ module Mpex
 Holdings:
 #{holdings_formatted(stat)}
 Totals:
-  Your optimistic valuation: #{Converter.satoshi_to_btc(optimistic_value)}"
+  Your optimistic valuation: #{Converter.satoshi_to_btc(optimistic_value)}
   VWAP valuation: #{Converter.satoshi_to_btc(vwap_valuation)}
+
+Holdings including those stuck in open orders:
+#{cumulated_amounts_formatted(stat)}
         PORTFOLIO
         yield portfolio
       end
     end
 
+    def trade_history_formatted(stat)
+      history = ""
+      stat["TradeHistory"].each do |t|
+        unixtime = t.keys.first
+        total = t[unixtime]["Quantity"].to_i * t[unixtime]["Price"].to_i
+        unless unixtime == "md5Checksum"
+          history << "  #{Time.at(unixtime.to_i)} #{t[unixtime]["MPSIC"]} - #{t[unixtime]["Quantity"]} #{t[unixtime]["BS"] == "S" ? "sold" : "bought"} @#{Converter.satoshi_to_btc(t[unixtime]["Price"])}, total: #{Converter.satoshi_to_btc(total)}\n"
+        end
+      end
+      history
+    end
+
+    def book_formatted(stat)
+      book = ""
+      stat["Book"].sort_by { |o| o.keys.first == "md5Checksum" ? -1 : o[o.keys.first]["Price"].to_i }.each do |o|
+        order_number = o.keys.first
+        unless order_number == "md5Checksum"
+          book << "  #{o[order_number]["MPSIC"]}: #{o[order_number]["BS"]}\t"
+          book << "#{o[order_number]["Quantity"]}\t@"
+          book << "#{Converter.satoshi_to_btc(o[order_number]['Price'])}"
+          book << "\t(order ##{order_number})\n"
+        end
+      end
+      book
+    end
+
     def holdings_formatted(stat)
       holdings = ""
       stat["Holdings"].each do |h|
@@ -203,9 +318,11 @@ Totals:
         elsif h["S.MPOE"]
           h["S.MPOE"].to_i*vwaps["S.MPOE"]["1d"]["avg"].to_i
         elsif h["S.DICE"]
-          h["S.DICE"].to_i*vwaps["S.BBET"]["1d"]["avg"].to_i
+          h["S.DICE"].to_i*vwaps["S.DICE"]["1d"]["avg"].to_i
         elsif h["S.BBET"]
           h["S.BBET"].to_i*vwaps["S.BBET"]["1d"]["avg"].to_i
+        elsif h["S.MG"]
+          h["S.MG"].to_i*vwaps["S.MG"]["1d"]["avg"].to_i
         else
           0
         end

data/lib/mpex/version.rb

@@ -1,3 +1,3 @@
 module Mpex
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/mpex.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{MPEx.rb: a commandline client for MPEx}
   s.description = %q{MPEx.rb is a commandline client for "MPEx":http://mpex.co a Bitcoin security exchange. Make sure to carefully read its "FAQ":http://mpex.co/faq.html before using it.}
 
-  s.files         = Dir['[A-Z]*'] + Dir['{bin,lib,tasks,test}/**/*'] + [ 'mpex.gemspec' ]
+  s.files         = Dir['[A-Z]*'] + Dir['{bin,lib,tasks,test}/**/*'] + [ 'mpex.gemspec', 'config.yaml.sample', 'FAQ.html' ]
   s.extra_rdoc_files = ['README.md']
   s.rdoc_options  = [ '--main', 'README.md' ]
   s.executables   = [ 'mpex' ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mpex
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Fa Wuxi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -148,6 +148,7 @@ files:
 - lib/mpex/version.rb
 - lib/mpex.rb
 - mpex.gemspec
+- config.yaml.sample
 homepage: https://github.com/fawuxi/mpex
 licenses: []
 metadata: {}