cryptomarket-sdk 1.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56104f24b0cf0227d1b07b004a96a0c7bb12f6c0144683fe5286ecf605e229e9
-  data.tar.gz: 1bdebf110497fc4c99fa768ad5f01c4d5d7811f48b90c739b677e84b90d720fd
+  metadata.gz: 7b00c37cd577d6d79dd8e65c6333a5122d28728fa3023f24aa7ca0b13eab2bf6
+  data.tar.gz: a2523b57da4464aed4a0c655fe7316c4445b57cfa622d85425c583e70b424303
 SHA512:
-  metadata.gz: b8db890022384ea30bfaf012af54b37e06eb2951874246aa7b363c603a3672a5d35f5a44b2ad6d02f006247818f04283b1327db62573c7374c3e7f6fdf054af5
-  data.tar.gz: 467cd155cee84cb5e67dd57859eb3c1b5227f9549420d4c7e073e815355ce0842fd5b56d5dfb983f16f4c944b4adcc69aea302f923be3c4dc29126fa43681691
+  metadata.gz: f6f0bf8e26c38b44f686d36b5103ee56eeca2319ab30aa4552c180e8f4535a3aabd8d5b86b38b6c6e05d256cf85f4a9208d9e2877e04cd6ceaa9b42b97545d36
+  data.tar.gz: b859df27e046ecb43e678c4b2e9ca0b3dc03007dbc259c7d56ac23f79fa16b7850f6cfaa1ca7502aa7b477a9833974616b352e874a460d4c0f6c84a0b5da5f07

data/README.md

@@ -1,131 +1,216 @@
 # CryptoMarket-Ruby
-[main page](https://www.cryptomkt.com/)
 
+[main page](https://www.cryptomkt.com/)
 
 [sign up in CryptoMarket](https://www.cryptomkt.com/account/register).
 
 # Installation
-To install Cryptomarket use pip
+
+To install Cryptomarket use gem
+
 ```
-gem install cryptomarket
+gem install cryptomarket-sdk
 ```
-# Documentation
 
-[The api documentation](https://api.exchange.cryptomkt.com/)
+# Documentation
 
+This sdk makes use of the [api version 3](https://api.exchange.cryptomkt.com/) of cryptomarket
 
 # Quick Start
 
 ## rest client
+
 ```ruby
-require "cryptomarket"
+require "cryptomarket-sdk"
 
 # instance a client
 api_key='AB32B3201'
 api_secret='21b12401'
-client = Cryptomarket::Client.new apiKey:apiKey, apiSecret:apiSecret
+client = Cryptomarket::Client.new api_key:api_key, api_secret:api_secret
 
 # get currencies
-currencies = client.getCurrencies()
+currencies = client.get_currencies
 
 # get order books
-order_book = client.getOrderbook('EOSETH')
+order_book = client.get_orderbooks symbols:['EOSETH']
 
 # get your account balances
-account_balance = client.getAccountBalance()
+account_balance = client.get_wallet_balances
 
 # get your trading balances
-trading_balance = client.getTradingBalance()
+trading_balance = client.get_spot_trading_balances
 
 # move balance from account bank to account trading
-result = client.transferMoneyFromBankToExchange('ETH', '3.2')
+result = @client.transfer_between_wallet_and_exchange(
+  currency: "CRO",
+  amount: "0.1",
+  source:"wallet",
+  destination:"spot",
+)
 
 # get your active orders
-orders = client.getActiveOrders('EOSETH')
+orders = client.get_all_active_spot_orders('EOSETH')
 
 # create a new order
-order = client.createOrder('EOSETH', 'buy', '10', order_type=args.ORDER_TYPE.MARKET)
+order = client.create_spot_order(
+  symbol:'EOSETH',
+  side:'buy',
+  quantity:'10',
+  order_type:args.ORDER_TYPE.MARKET
+)
 ```
 
-## websocket client
+## Websocket Clients
 
-All websocket calls work with callbacks, subscriptions also use a callback with one argument for the subscription feed. All the other callbacks takes two arguments, err and result: callback(err, result). If the transaction is successful err is None and the result is in result. If the transaction fails, result is None and the error is in err.
+Ahere are three websocket clients, the `MarketDataClient`, the `TradingClient` and the `WalletClient`. The `MarketDataClient` is public, while the others require authentication to be used.
 
-callbacks are callables like Procs
+All websocket methods take Procs for their callbacks. These procs take two argument, the first is a possible error in the call (such as missing arguments), and the result data of the method.
 
-There are three websocket clients, the PublicClient, the TradingClient and the AccountClient.
-
-```ruby
-require "cryptomarket-sdk"
+Subscriptions also take in a Proc of two parameters, the notification data, and the notification type. The notification type is of type Args::NotificationType, and is either SNAPSHOT, NOTIFICATION or DATA, corresponding to the strings 'snapshot', 'update' and 'data'
 
-# THE PUBLIC CLIENT
+The documentation of a specific subscriptions explains with of this types of notification uses.
 
-wsclient = Cryptomarket::Websocket::PublicClient.new
+### Websocket Market Data Client
 
-wsclient.connect() # blocks until connected
+There are no unsubscriptions methods for the `MarketDataClient`. To stop recieving messages is recomended to close the `MarketDataClient`.
 
-my_callback = Proc.new {|err, data|
+```ruby
+# instance a client
+client = Cryptomarket::Websocket::MarketDataClient.new
+client.connect
+# close the client
+client.close
+# subscribe to public trades
+client.subscribe_to_trades(
+  callback:Proc.new {|notification, type|
+    if type == Args::NotificationType::UPDATE
+      puts "an update"
+    end
+    if type == Args::NotificationType::SNAPSHOT
+      puts "a snapshot"
+    end
+    puts notification
+  },
+  symbols:['eoseth', 'ethbtc'],
+  limit:2,
+  result_callback:Proc.new {|err, result|
     if not err.nil?
-        puts err # deal with error
-        return
+      puts err
+    else
+      puts result
     end
-    puts data
-}
-
-# get currencies
-wsclient.getCurrencies(my_callback)
-
-
-# get an order book feed, 
-# feed_callback is for the subscription feed, with one argument
-# result_callback is for the subscription result (success or failure)
-feed_callback = Proc.new {|feed|
-    puts feed
-}
+  }
+)
+
+# subscribe to symbol tickers
+client.subscribe_to_ticker(
+  speed:"1s",
+  callback:Proc.new {|notificatoin, type|
+    if type == Args::NotificationType::DATA
+      puts "is always data"
+    end
+    puts notification
+  },
+  symbols:['eoseth', 'ethbtc'],
+  result_callback:Proc.new {|err, result|
+    if not err.nil?
+      puts err
+    else
+      puts result
+    end
+  }
+)
+```
 
-wsclient.subscribeToOrderbook('EOSETH', feed_callback, my_callback)
+### Websocket Trading Client
 
-# THE TRADING CLIENT
+Subscription callback to spot trading balances takes only one argument, a list of balances (see example below)
 
-wsclient = Cryptomarket::Websocket::TradingClient.new apiKey:apiKey, apiSecret:apiSecret
+```ruby
+# instance a client with a 15 seconds window
+client = Cryptomarket::Websocket::TradingClient.new(
+  api_key:Keyloader.api_key,
+  api_secret:Keyloader.api_secret,
+  window:15_000
+)
+client.connect
+# close the client
+client.close
+
+# subscribe to order reports
+client.subscribe_to_reports(
+  callback:Proc.new {|notification, type|
+      if type == Args::NotificationType::UPDATE
+        puts "a lonely report in a list"
+      end
+      if type == 'snapshot' # same as Args::NotificationType::SNAPSHOT
+        puts "reports of active orders"
+      end
+      puts notification
+  }
+)
+# unsubscribe from order reports
+client.unsubscribe_to_reports
+
+@wsclient.subscribe_to_spot_balance(
+  callback: ->(balances) {puts balances},
+  result_callback: ->(_) {},
+  mode: 'updates'
+)
+
+client_order_id = Time.now.to_i.to_s
+
+# create an order
+client.create_spot_order(
+  symbol: symbol,
+  price:'10000',
+  quantity:'0.01',
+  side:'sell',
+  clientOrderId:client_order_id
+)
+
+# candel an order
+client.cancel_spot_order(client_order_id)
 
-wsclient.connect() # blocks until connected and authenticated.
+```
 
-# get your trading balances
-wsclient.getTradingBalance(my_callback)
+### Websocket Wallet Management Client
 
-# get your active orders
-wsclient.getActinveOrders(my_callback)
+Subscription callback to transactions takes only one argument, a transaction (see example below)
 
-# create a new order
-wsclient.create_order(
-    clientOrderId:"123123",
-    symbol:'EOSETH', 
-    side:'buy', 
-    quantity:"10",
-    price:"10",
-    callback:my_callback)
+```ruby
+# instance a client with a default window of 10 seconds
+client = Cryptomarket::Websocket::WalletClient.new api_key:Keyloader.api_key, api_secret:Keyloader.api_secret
+client.connect
+# close the client
+defer client.close
 
-# THE ACCONUT CLIENT
+# subscribe to wallet transactions
+def callback(transaction):
+  ->(transaction) { puts(transaction) }
 
-wsclient = Cryptomarket::Websocket::AccountClient apiKey:apiKey, apiSecret:apiSecret
+client.subscribe_to_transactions(callback)
 
-wsclient.connect() # blocks until connected
+# unsubscribe from wallet transactions
+client.unsubscribe_to_transactions(lambda { |is_success| 
+  puts('successful unsubscription') if is_success
+})
 
-wsclient.getAccountBalance(my_callback)
+# get wallet balances
+client.get_wallet_balances(->(balances){ puts balances})
 ```
 
-
 ## exception handling
+
 ```ruby
 require "cryptomarket-sdk"
 
-client = Cryptomarket::Client.new apiKey:apiKey, apiSecret:apiSecret
+client = Cryptomarket::Client.new api_key:api_key, api_secret:api_secret
 
-# catch a wrong argument 
+# catch a wrong argument
 begin
-    order = client.create_order(
-        symbol='EOSETH', 
+    order = client.create_spot_order(
+        symbol='EOSETH',
         side='selllll', # wrong
         quantity='3'
     )
@@ -135,18 +220,18 @@ end
 
 # catch a failed transaction
 begin
-    order = client.create_order(
+    order = client.create_spot_order(
         symbol='eosehtt',  # non existant symbol
         side='sell',
-        quantity='10', 
+        quantity='10',
     )
 rescue Cryptomarket::SDKException => e:
     puts e
 end
 
-wsclient = Cryptomarket::Websocket::TradingClient.new apiKey:apiKey, apiSecret:apiSecret
+wsclient = Cryptomarket::Websocket::TradingClient.new api_key:api_key, api_secret:api_secret
 
-# websocket errors are passed as the first argument to the callback
+# websocket errors are passed as the first argument to the callback. valid for all non subscription methods
 my_callback = Proc.new {|err, data|
     if not err.nil?
         puts err # deal with error
@@ -155,23 +240,21 @@ my_callback = Proc.new {|err, data|
     puts data
 }
 
-wsclient.getTradingBalance(my_callback)
+wsclient.get_spot_trading_balances(my_callback)
 
 # catch authorization error
 # to catch an authorization error on client connection, a on_error function must be defined on the client
-wsclient = TradingClient(apiKey, apiSecret)
+wsclient = TradingClient(api_key, api_secret)
 wsclient.onerror = Proc.new {|error| puts "error", error}
 wsclient.connect
-
-
 ```
+
 # Checkout our other SDKs
-<!-- agregar links -->
 
-python sdk
+[node sdk](https://github.com/cryptomkt/cryptomkt-node)
 
-node sdk
+[java sdk](https://github.com/cryptomkt/cryptomkt-java)
 
-java sdk
+[go sdk](https://github.com/cryptomkt/cryptomkt-go)
 
-go sdk
+[python sdk](https://github.com/cryptomkt/cryptomkt-python)