bitshares 0.1.4.pre → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d78dd854953b6dd4587d6325f78ed684d00cc73a
-  data.tar.gz: 398253f2043e57805839cc50f5a6c1c7be05dc22
+  metadata.gz: f764f9e5559cb963c49a566f4467d52af3885c91
+  data.tar.gz: 396b6b1131c8cbb7bcc05c12cc4d76602b472423
 SHA512:
-  metadata.gz: f847a6172160020215ebc108a63b6cd7b1ab9d0b48e07535996a328f17ec09cfc39ce062ec248c341d449ec2153a7a6cb8062208d9fcc658b0b752228c43d8d6
-  data.tar.gz: 16d6cdebae1a700b0c9dc6d7708d550d7a1c9611fae623ed395ed3010d9610e4ad37b5b9b4483f10913a8052251cab24a7c682ebcd7abc169d7639a6e6edd244
+  metadata.gz: 84208a411b47edd4c940f20db8ed53e3c0f184180579c1d84cb5308ed752599a6622557ec13e5a55dfaabfe109b80159e3dbf6ca0b714505b22a4bd109680a17
+  data.tar.gz: b4d3420d3ca5d92200f0f3d67b9f0bdbd54d54a38eb8dcd2a7dabc5e3644f1903389f55806e28ddadf77422d177cfd8ea491ef9025ffd6da5d7fa0d0aa165417

data/README.md

@@ -40,8 +40,8 @@ To use this functionality - i.e. with the Wallet class (see below) wallet names
 
 **Via a hash**
 ```Ruby
-Bitshares.configure(:wallet => {:name => 'wallet1', :password => 'password1'})
-Bitshares.configure(:wallet => {:name => 'wallet2', :password => 'password2'})
+Bitshares.configure(:wallet => {'wallet1' => 'password1'})
+Bitshares.configure(:wallet => {'wallet2' => 'password2'})
 ...
 ```
 
@@ -61,7 +61,8 @@ Bitshares.config # returns the configuration hash
 ```ruby
 require 'bitshares'
 
-client = Bitshares::Client.init # The object BitShares RPC client calls are routed to.
+client = CLIENT.init # CLIENT = Bitshares::Client -the object BitShares RPC client calls are routed to.
+client.synced? # if you wish to check whether you are synced with the p2p network.
 ```
 Any valid client command can then be issued via a method call with relevant parameters - e.g.
 
@@ -81,7 +82,7 @@ Data is returned as a hash
 
 The blockchain is implemented as a class purely for convenience when calling 'blockchain_' methods:
 ```Ruby
-chain = Bitshares::Blockchain
+chain = Bitshares::Blockchain # CHAIN may be used
 count = chain.get_block_count # equivalent to client.blockchain_get_block_count
 ```
 
@@ -133,42 +134,69 @@ wallet.account_balance # lists the balances for all accounts for this wallet (c.
 
 The market class represents the trading (order book and history) for a given an asset-pair - e.g. CNY/BTS. It is instantiated like this:
 ```Ruby
-market = Bitshares::Market.new('CNY', 'BTS')
+cny_bts = Bitshares::Market.new('CNY', 'BTS')
 ```
-The following 'blockchain_market_' client methods may then be used without specifying the quote and base assets again, but with any other optional params the client accepts:
+_Note that the BitShares market convention is that quote asset_id > base asset_id. Reversing the symbols in the above example results in the client returning  an 'Invalid Market' error._ An asset's id can be found from the asset hash by using:
 ```Ruby
-market.list_asks # equivalent to blockchain_market_list_asks(quote, base) [limit]
-market.list_bids
-market.list_covers
-market.order_book
-market.order_history
-market.price_history # required params are: <start time> <duration> optional: [granularity]
+Bitshares::Blockchain.get_asset 'CNY' # for example
+```
+
+The following 'blockchain_market_' client methods may then be used without specifying the quote and base assets again, but with any other optional args the client accepts:
+```Ruby
+cny_bts.list_asks # equivalent to blockchain_market_list_asks(quote, base) [limit]
+cny_bts.list_bids
+cny_bts.list_covers
+cny_bts.order_book
+cny_bts.order_history
+cny_bts.price_history # required params are: <start time> <duration> optional: [granularity]
 
-market.list_shorts # requires no params and ignores the base asset
-get_asset_collateral # requires no params and returns the collateral for the quote asset (ignores the base asset)
+cny_bts.list_shorts # requires no params and ignores the base asset
+cny_bts.get_asset_collateral # requires no params and returns the collateral for the quote asset (ignores the base asset)
 ```
 
 Additionally, the following methods are available:
 ```Ruby
-market.lowest_ask
-market.highest_bid
-market.mid_price # mean of the above
-market.last_fill # price of the last filled order
+cny_bts.lowest_ask
+cny_bts.highest_bid
+cny_bts.mid_price # mean of the above
+cny_bts.last_fill # price of the last filled order
+```
+
+**Trading**
+
+So, once we have an account and a market, what do we need to trade - why a Trader of course!
+
+```Ruby
+cny_bts_trader = Bitshares::Trader.new(account, cny_bts) # using examples above
+```
+
+You can now do this:
+```Ruby
+cny_bts_trader.order_list # lists orders for the account and market - optional limit arg. Returns orders array
+
+cny_bts_trader.submit_bid(quantity, price) # buy <quantity> of Market base (BTS here) at <price> (quote/base)
+cny_bts_trader.submit_ask(quantity, price) # sell <quantity> of Market base (BTS here) at <price> (quote/base)
+  # both return respective order id
+  
+cny_bts_trader.cancel_orders(*order_ids) # cancels one or more orders for the account and market
+  # returns array of memo's e.g. 'cancel ASK-90189b6e'
 ```
 
 ## Specification & tests
 
-For the full specification please clone this repo and run:
+For the full specification clone this repo and run:
 
 `rake spec`
 
-_Important:_ There is currently no sandbox, so the test suite runs on your live client. If this concerns you - and it should :scream: - feel free to browse the code. In particular, the following client 'fixtures' are required for the full test suite to run and pass:
+**Test Requirements**
+
+There is currently no test blockchain, so the test suite runs on the live one - orders and all. If this concerns you - and it should :scream: - feel free to browse the test code first. The following client 'fixtures' are required for the full test suite to run and pass:
 
-An empty wallet 'test1', with password 'password1' and an account called 'account-test' (please don't register this account!)
+An empty wallet 'test1', with password 'password1' and an account called 'account-test' *Please don't register this account!*. The account will also need funding with a few BTS as trades/cancellations are 0.5 BTS each. 10 BTS (circa 2.5 cents right now) should be more than enough to run the suite a few times.
 
 ## Contributing
 
-Bug reports and pull requests (and feature requests) are welcome on GitHub at https://github.com/MatzFan/bitshares-ruby.
+Bug reports, pull requests (and feature requests) are welcome on GitHub at https://github.com/MatzFan/bitshares-ruby.
 
 
 ## License

data/lib/bitshares.rb

@@ -10,10 +10,15 @@ require 'bitshares/blockchain'
 require 'bitshares/wallet'
 require 'bitshares/account'
 require 'bitshares/market'
+require 'bitshares/trader'
+
+CLIENT = Bitshares::Client
+CHAIN = Bitshares::Blockchain
 
 # stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem
 module Bitshares
-  @config = {:wallets => {nil => nil}} # name/password key/value pairs
+
+  @config = {:wallet => {nil => nil}} # name/password key/value pairs
 
   @valid_keys = @config.keys
 

data/lib/bitshares/account.rb

@@ -2,8 +2,6 @@ module Bitshares
 
   class Account
 
-    CLIENT = Bitshares::Client
-
     attr_reader :wallet, :name
 
     def initialize(wallet, name)
@@ -12,7 +10,7 @@ module Bitshares
     end
 
     def method_missing(m, *args)
-      CLIENT::rpc.request('wallet_account_' + m.to_s, [name] + args)
+      CLIENT.request('wallet_account_' + m.to_s, [name] + args)
     end
 
   end

data/lib/bitshares/blockchain.rb

@@ -3,7 +3,7 @@ module Bitshares
   class Blockchain
 
     def self.method_missing(name, *args)
-      Bitshares::Client::rpc.request('blockchain_' + name.to_s, args)
+      CLIENT.request('blockchain_' + name.to_s, args)
     end
 
   end

data/lib/bitshares/client.rb

@@ -2,66 +2,54 @@ module Bitshares
 
   class Client
 
+    class Err < RuntimeError; end
+
     def self.init
-      @user = ENV['BITSHARES_ACCOUNT']
-      @password = ENV['BITSHARES_PASSWORD']
-      @@rpc_instance = Bitshares::Client::Rpc.new(@user, @password)
+      bitshares_running?
+      user = ENV['BITSHARES_ACCOUNT']
+      password = ENV['BITSHARES_PASSWORD']
+      @uri = URI("http://localhost:#{rpc_http_port}/rpc")
+      @req = Net::HTTP::Post.new(@uri)
+      @req.content_type = 'application/json'
+      @req.basic_auth user, password
       return self
     end
 
-    def self.rpc
-      @@rpc_instance
-    end
-
     def self.synced?
       blockchain_get_block_count >= self.get_info['blockchain_head_block_num']
     end
 
     def self.method_missing(m, *args)
-      @@rpc_instance.request(m, args)
+      self.request(m, args)
     end
 
-    class Rpc
-
-      class Err < RuntimeError; end
-
-      def initialize(user, password)
-        bitshares_running?
-        @uri = URI("http://localhost:#{rpc_http_port}/rpc")
-        @req = Net::HTTP::Post.new(@uri)
-        @req.content_type = 'application/json'
-        @req.basic_auth user, password
-      end
-
-      def request(m, args = [])
-        resp = nil
-        Net::HTTP.start(@uri.hostname, @uri.port) do |http|
-          @req.body = { method: m, params: args, jsonrpc: '2.0', id: 0 }.to_json
-          resp = http.request(@req)
-        end
-        raise Err, 'Bad credentials' if resp.class == Net::HTTPUnauthorized
-        result = JSON.parse(resp.body)
-        e = result['error']
-        raise Err, JSON.pretty_generate(e), "#{m} #{args.join(' ') if args}" if e
-        return result['result']
+    def self.request(m, args = [])
+      resp = nil
+      Net::HTTP.start(@uri.hostname, @uri.port) do |http|
+        @req.body = { method: m, params: args, jsonrpc: '2.0', id: 0 }.to_json
+        resp = http.request(@req)
       end
+      raise Err, 'Bad credentials' if resp.class == Net::HTTPUnauthorized
+      result = JSON.parse(resp.body)
+      e = result['error']
+      raise Err, JSON.pretty_generate(e), "#{m} #{args.join(' ') if args}" if e
+      return result['result']
+    end
 
-      private
-
-      def bitshares_running?
-        raise Err, 'Server not running!' unless rpc_ports.count == 2
-      end
+    private
 
-      def rpc_http_port
-        rpc_ports.each do |port| # only http RPC port raises a non-empty response
-          return port unless `curl -s -I -L http://localhost:#{port}`.empty?
-        end
-      end
+    def self.bitshares_running?
+      raise Err, 'Server not running!' unless rpc_ports.count == 2
+    end
 
-      def rpc_ports # returns bitshares HTTP JSON RPC and JSON RPC server ports
-        `lsof -iTCP@localhost | grep bitshares`.scan(/:(\d+) \(LISTEN\)/).flatten
+    def self.rpc_http_port
+      rpc_ports.each do |port| # only http RPC port raises a non-empty response
+        return port unless `curl -s -I -L http://localhost:#{port}`.empty?
       end
+    end
 
+    def self.rpc_ports # returns bitshares HTTP JSON RPC and JSON RPC server ports
+      `lsof -iTCP@localhost | grep bitshares`.scan(/:(\d+) \(LISTEN\)/).flatten
     end
 
   end

data/lib/bitshares/market.rb

@@ -2,10 +2,7 @@ module Bitshares
 
   class Market
 
-    class AssetError < RuntimeError; end
-
-    CHAIN = Bitshares::Blockchain
-    CLIENT = Bitshares::Client
+    class Error < RuntimeError; end
 
     attr_reader :quote, :base
 
@@ -13,6 +10,7 @@ module Bitshares
       [quote, base].each &:upcase!
       @quote_hash, @base_hash = asset(quote), asset(base)
       @quote, @base = @quote_hash['symbol'], @base_hash['symbol']
+      valid_market?(@quote_hash['id'], @base_hash['id'])
       @multiplier = multiplier
     end
 
@@ -37,21 +35,25 @@ module Bitshares
     end
 
     def list_shorts(limit = nil) # uses quote only, not base
-      CLIENT::rpc.request('blockchain_market_list_shorts', [quote] + [limit])
+      CLIENT.request('blockchain_market_list_shorts', [quote] + [limit])
     end
 
     def get_asset_collateral # uses quote only, not base
-      CLIENT::rpc.request('blockchain_market_get_asset_collateral', [quote])
+      CLIENT.request('blockchain_market_get_asset_collateral', [quote])
     end
 
     def method_missing(m, *args)
-      CLIENT::rpc.request('blockchain_market_' + m.to_s, [quote, base] + args)
+      CLIENT.request('blockchain_market_' + m.to_s, [quote, base] + args)
     end
 
     private
 
     def asset(symbol) # returns hash
-      CHAIN.get_asset(symbol) || (raise AssetError, "Invalid asset: #{symbol}")
+      CHAIN.get_asset(symbol) || (raise Error, "Invalid asset: #{symbol}")
+    end
+
+    def valid_market?(quote_id, base_id)
+      raise Error, 'Invalid market; quote ID <= base ID' if quote_id <= base_id
     end
 
     def order_hist

data/lib/bitshares/trader.rb

@@ -0,0 +1,57 @@
+module Bitshares
+
+  class Trader
+
+    class Error < RuntimeError; end
+
+    WMSA = 'wallet_market_submit_ask'
+    WMSB = 'wallet_market_submit_bid'
+    WMOL = 'wallet_market_order_list'
+    WMCO = 'wallet_market_cancel_orders'
+
+    attr_reader :account, :market
+
+    def initialize(account, market)
+      @account = account
+      @wallet = account.wallet
+      @name = account.name
+      @market = market
+      @base = market.base
+      @quote = market.quote
+    end
+
+    def submit_ask(quantity, price, stupid = false)
+      @wallet.unlock if @wallet.locked?
+      o = CLIENT.request(WMSA, [@name, quantity, @base, price, @quote, stupid])
+      o['record_id'] # return order id
+    end
+
+    def submit_bid(quantity, price, stupid = false)
+      @wallet.unlock if @wallet.locked?
+      o = CLIENT.request(WMSB, [@name, quantity, @base, price, @quote, stupid])
+      o['record_id'] # return order id
+    end
+
+    def order_list(limit = '-1')
+      CLIENT.request(WMOL, [@quote, @base, limit, @name])
+    end
+
+    def cancel_orders(*id_list)
+      @wallet.unlock if @wallet.locked?
+      confirm = CLIENT.request(WMCO, id_list)
+      confirm['ledger_entries'].map { |e| e['memo'] } # returns 'cancel ASK-xxxxxxxx' first 8 chars of order id
+    end
+
+    def cancel_all
+      cancel_orders all_order_ids
+    end
+
+    private
+
+    def all_order_ids
+      order_list.map &:first
+    end
+
+  end
+
+end

data/lib/bitshares/version.rb

@@ -1,3 +1,3 @@
 module Bitshares
-  VERSION = '0.1.4.pre'
+  VERSION = '0.1.5'
 end

data/lib/bitshares/wallet.rb

@@ -7,7 +7,7 @@ module Bitshares
     def initialize(name)
       @name = name
       @account = nil
-      @password = Bitshares.config[:wallets][@name.to_sym]
+      @password = Bitshares.config[:wallet][@name]
     end
 
     def account(name)
@@ -15,17 +15,17 @@ module Bitshares
     end
 
     def open
-      Bitshares::Client::rpc.request('wallet_open', [@name])
+      CLIENT.request('wallet_open', [@name])
     end
 
     def lock
       open # must be opened first
-      Bitshares::Client::rpc.request 'wallet_lock'
+      CLIENT.request 'wallet_lock'
     end
 
     def unlock(timeout = 1776)
       open # must be opened first
-      Bitshares::Client::rpc.request('wallet_unlock', [timeout, @password])
+      CLIENT.request('wallet_unlock', [timeout, @password])
     end
 
     def open?
@@ -46,7 +46,7 @@ module Bitshares
     end
 
     def method_missing(m, *args)
-      Bitshares::Client::rpc.request('wallet_' + m.to_s, args)
+      CLIENT.request('wallet_' + m.to_s, args)
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitshares
 version: !ruby/object:Gem::Version
-  version: 0.1.4.pre
+  version: 0.1.5
 platform: ruby
 authors:
 - Bruce Steedman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,7 @@ files:
 - lib/bitshares/blockchain.rb
 - lib/bitshares/client.rb
 - lib/bitshares/market.rb
+- lib/bitshares/trader.rb
 - lib/bitshares/version.rb
 - lib/bitshares/wallet.rb
 homepage: 
@@ -119,9 +120,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8