test: separates withdraw crypto tests

Author: Insmael

lib/cryptomarket/client.rb

@@ -394,7 +394,7 @@ def get_active_spot_order(client_order_id:)
     # +String+ +quantity+:: Order quantity
     # +String+ +client_order_id+:: Optional. If given must be unique within the trading day, including all active orders. If not given, is generated by the server
     # +String+ +type+:: Optional. 'limit', 'market', 'stopLimit', 'stopMarket', 'takeProfitLimit' or 'takeProfitMarket'. Default is 'limit'
-    # +String+ +time_in_force+:: Optional. 'GTC', 'IOC', 'FOK', 'Day', 'GTD'. Default to 'GTC'
+    # +String+ +time_in_force+:: Optional. 'GTC', 'IOC', 'FOK', 'Day', 'GTD'. Default is 'GTC' if 'limit', 'stopLimit' or 'takeProfitLimit' order, Default is 'FOK' if 'market', 'stopMarket' or 'takeProfitMarket' order
     # +String+ +price+:: Optional. Required for 'limit' and 'stopLimit'. limit price of the order
     # +String+ +stop_price+:: Optional. Required for 'stopLimit' and 'stopMarket' orders. stop price of the order
     # +String+ +expire_time+:: Optional. Required for orders with timeInForce = GDT
@@ -419,10 +419,10 @@ def create_spot_order( # rubocop:disable Metrics/ParameterLists
     # creates a list of spot orders
     #
     # = Types or contingency
-    # - Args::Contingency::ALL_OR_NONE (Args::Contingency::AON)
-    # - Args::Contingency::ONE_CANCEL_OTHER (Args::Contingency::OCO)
-    # - Args::Contingency::ONE_TRIGGER_OTHER (Args::Contingency::OTO)
-    # - Args::Contingency::ONE_TRIGGER_ONE_CANCEL_OTHER (Args::Contingency::OTOCO)
+    # - 'allOrNone' (AON)
+    # - 'oneCancelAnother' (OCO)
+    # - 'oneTriggerOther' (OTO)
+    # - 'oneTriggerOneCancelOther' (OTOCO)
     #
     # = Restriction in the number of orders:
     # - An AON list must have 2 or 3 orders
@@ -437,21 +437,21 @@ def create_spot_order( # rubocop:disable Metrics/ParameterLists
     # - For an OTOCO order list, the symbol code of orders must be the same for all orders in the list (placing orders in different order books is not supported).
     #
     # = OrderType restrictions
-    # - For an AON order list, orders must be Args::OrderType::LIMIT or Args::OrderType::Market
-    # - For an OCO order list, orders must be Args::OrderType::LIMIT, Args::OrderType::STOP_LIMIT, Args::OrderType::STOP_MARKET, Args::OrderType::TAKE_PROFIT_LIMIT or Args::OrderType::TAKE_PROFIT_MARKET.
+    # - For an AON order list, orders must be 'limit' or 'market'
+    # - For an OCO order list, orders must be 'limit', 'stopLimit', 'stopMarket', takeProfitLimit or takeProfitMarket.
     # - An OCO order list cannot include more than one limit order (the same
     # applies to secondary orders in an OTOCO order list).
     # - For OTO order list, there are no order type restrictions.
-    # - For an OTOCO order list, the first order must be Args::OrderType::LIMIT, Args::OrderType::MARKET, Args::OrderType::STOP_LIMIT, Args::OrderType::STOP_MARKET, Args::OrderType::TAKE_PROFIT_LIMIT or Args::OrderType::TAKE_PROFIT_MARKET.
+    # - For an OTOCO order list, the first order must be 'limit', 'market', 'stopLimit', 'stopMarket', takeProfitLimit or takeProfitMarket.
     # - For an OTOCO order list, the secondary orders have the same restrictions as an OCO order
-    # - Default is Args::OrderType::Limit
+    # - Default is 'limit'
     #
     # https://api.exchange.cryptomkt.com/#create-new-spot-order-list
     #
     # ==== Params
     # +String+ +order_list_id+:: order list identifier. If ommited, it will be generated by the system. Must be equal to the client order id of the first order in the request
-    # +String+ +contingency_type+:: order list type. allOrNone, oneCancelOther or oneTriggerOneCancelOther
-    # +Array[]+ +orders+:: the list of orders
+    # +String+ +contingency_type+:: order list type. 'allOrNone', 'oneCancelOther' or 'oneTriggerOneCancelOther'
+    # +Array[]+ +orders+:: the list of orders. aech order in the list has the same parameters of a new spot order
 
     def create_spot_order_list(
       contingency_type:,

lib/cryptomarket/exceptions.rb

@@ -8,15 +8,16 @@ class SDKException < ::StandardError
   class APIException < SDKException
     def initialize(hash)
       @code = hash['code']
-      @message = hash['message']
-      @description = hash['description']
+      raw_message = hash['message']
+      @description = hash.key?('description') ? hash['description'] : ''
+      @message = "#{self.class.name} (code=#{@code}): #{raw_message}. #{@description}"
       super
     end
 
     attr_reader :code, :message, :description
 
     def to_s
-      "#{self.class.name} (code=#{@code}): #{@message}: #{@description}"
+      @message
     end
   end
 end

lib/cryptomarket/http_manager.rb

@@ -89,10 +89,8 @@ def handle_response(response)
       parsed_result = JSON.parse result
       if (response.code != 200) && !parsed_result['error'].nil?
         error = parsed_result['error']
-        msg = "(code=#{error['code']}): #{error['message']}"
-        msg += ": #{error['description']}" unless error['description'].nil?
         exception = Cryptomarket::APIException.new error
-        raise exception, msg
+        raise exception
       end
       parsed_result
     end

lib/cryptomarket/websocket/trading_client.rb

@@ -7,7 +7,7 @@
 module Cryptomarket
   module Websocket
     # TradingClient connects via websocket to cryptomarket to enable the user to manage orders.
-    # uses SHA256 as auth method and authenticates automatically.
+    # uses SHA256 as auth method and authenticates automatically after ceonnection.
     class TradingClient < AuthClient
       # Creates a new client
       # ==== Params
@@ -42,7 +42,6 @@ def build_subscription_hash
       # ==== Params
       # +Proc+ +callback+:: A +Proc+ that recieves notifications as a list of reports, and the type of notification (either 'snapshot' or 'update')
       # +Proc+ +result_callback+:: Optional. A +Proc+ called with a boolean value, indicating the success of the subscription
-
       def subscribe_to_reports(callback:, result_callback: nil)
         interceptor = proc { |notification, type|
           if type == Args::NotificationType::SNAPSHOT
@@ -60,7 +59,6 @@ def subscribe_to_reports(callback:, result_callback: nil)
       #
       # ==== Params
       # +Proc+ +callback+:: Optional. A +Proc+ called with a boolean value, indicating the success of the unsubscription
-
       def unsubscribe_to_reports(callback: nil)
         send_unsubscription('spot_unsubscribe', callback, nil)
       end
@@ -75,7 +73,7 @@ def unsubscribe_to_reports(callback: nil)
       # +Proc+ +result_callback+:: Optional. A +Proc+ called with a boolean value, indicating the success of the subscription
       # +Proc+ +String+ +mode+:: Optional. The type of subscription, Either 'updates' or 'batches'. Update messages arrive after an update. Batch messages arrive at equal intervals after a first update
       def subscribe_to_spot_balance(callback:, mode: nil, result_callback: nil)
-        interceptor = proc { |notification, _type|
+        interceptor = lambda { |notification, _type|
           callback.call(notification)
         }
         send_subscription('spot_balance_subscribe', interceptor, { mode: mode }, result_callback)
@@ -87,7 +85,6 @@ def subscribe_to_spot_balance(callback:, mode: nil, result_callback: nil)
       #
       # ==== Params
       # +Proc+ +callback+:: Optional. A +Proc+ of two arguments, An exception and a result, called either with the exception or with the result, a boolean value indicating the success of the unsubscription
-
       def unsubscribe_to_spot_balance(result_callback: nil)
         send_unsubscription(
           'spot_balance_unsubscribe',
@@ -102,7 +99,6 @@ def unsubscribe_to_spot_balance(result_callback: nil)
       #
       # ==== Params
       # +Proc+ +callback+:: A +Proc+ of two arguments, An exception and a result, called either with the exception or with the result, a list of reports for all active spot orders
-
       def get_active_spot_orders(callback:)
         request('spot_get_orders', callback)
       end
@@ -128,7 +124,6 @@ def get_active_spot_orders(callback:)
       # +String+ +take_rate+:: Optional. Liquidity taker fee, a fraction of order volume, such as 0.001 (for 0.1% fee). Can only increase the fee. Used for fee markup.
       # +String+ +make_rate+:: Optional. Liquidity provider fee, a fraction of order volume, such as 0.001 (for 0.1% fee). Can only increase the fee. Used for fee markup.
       # +Proc+ +callback+:: Optional. A +Proc+ of two arguments, An exception and a result, called either with the exception or with the result, the report of the created order
-
       def create_spot_order( # rubocop:disable Metrics/ParameterLists
         symbol:, side:, quantity:, client_order_id: nil, type: nil, time_in_force: nil, price: nil, stop_price: nil,
         expire_time: nil, strict_validate: nil, post_only: nil, take_rate: nil, make_rate: nil, callback: nil
@@ -142,10 +137,10 @@ def create_spot_order( # rubocop:disable Metrics/ParameterLists
       # creates a list of spot orders
       #
       # = Types or contingency
-      # - Contingency::ALL_OR_NONE (AON)
-      # - Contingency::ONE_CANCEL_OTHER (OCO)
-      # - Contingency::ONE_TRIGGER_OTHER (OTO)
-      # - Contingency::ONE_TRIGGER_ONE_CANCEL_OTHER (OTOCO)
+      # - 'allOrNone' (AON)
+      # - 'oneCancelAnother' (OCO)
+      # - 'oneTriggerOther' (OTO)
+      # - 'oneTriggerOneCancelOther' (OTOCO)
       #
       # = Restriction in the number of orders:
       # - An AON list must have 2 or 3 orders
@@ -160,23 +155,21 @@ def create_spot_order( # rubocop:disable Metrics/ParameterLists
       # - For an OTOCO order list, the symbol code of orders must be the same for all orders in the list (placing orders in different order books is not supported).
       #
       # = OrderType restrictions
-      # - For an AON order list, orders must be OrderType.LIMIT or OrderType.Market
-      # - For an OCO order list, orders must be OrderType.LIMIT, OrderType.STOP_LIMIT, OrderType.STOP_MARKET, OrderType.TAKE_PROFIT_LIMIT or OrderType.TAKE_PROFIT_MARKET.
+      # - For an AON order list, orders must be 'limit' or 'market'
+      # - For an OCO order list, orders must be 'limit', 'stopLimit', 'stopMarket', takeProfitLimit or takeProfitMarket.
       # - An OCO order list cannot include more than one limit order (the same
       # applies to secondary orders in an OTOCO order list).
       # - For OTO order list, there are no order type restrictions.
-      # - For an OTOCO order list, the first order must be OrderType.LIMIT, OrderType.MARKET, OrderType.STOP_LIMIT, OrderType.STOP_MARKET, OrderType.TAKE_PROFIT_LIMIT or OrderType.TAKE_PROFIT_MARKET.
+      # - For an OTOCO order list, the first order must be 'limit', 'market', 'stopLimit', 'stopMarket', takeProfitLimit or takeProfitMarket.
       # - For an OTOCO order list, the secondary orders have the same restrictions as an OCO order
-      # - Default is OrderType.Limit
+      # - Default is 'limit'
       #
-      # https://api.exchange.cryptomkt.com/#create-new-spot-order-list-2
+      # https://api.exchange.cryptomkt.com/#create-new-spot-order-list
       #
       # ==== Params
       # +String+ +order_list_id+:: order list identifier. If ommited, it will be generated by the system. Must be equal to the client order id of the first order in the request
-      # +String+ +contingency_type+:: order list type. allOrNone, oneCancelOther or oneTriggerOneCancelOther
-      # +Array[]+ +orders+:: the list of orders
-      # +Proc+ +callback+:: Optional. A +Proc+ of two arguments, An exception and a result, called either with the exception or with the result, a list of reports of the created orders
-
+      # +String+ +contingency_type+:: order list type. 'allOrNone', 'oneCancelOther' or 'oneTriggerOneCancelOther'
+      # +Array[]+ +orders+:: the list of orders. aech order in the list has the same parameters of a new spot order
       def create_spot_order_list(
         orders:, contingency_type:, order_list_id: nil, callback: nil
       )
@@ -203,7 +196,6 @@ def cancel_spot_order(client_order_id:, callback: nil)
       #
       # ==== Params
       # +Proc+ +callback+:: A +Proc+ of two arguments, An exception and a result, called either with the exception or with the result, a report of the canceled order
-
       def cancel_spot_orders(callback: nil)
         request('spot_cancel_orders', callback)
       end
@@ -274,7 +266,6 @@ def get_spot_commissions(callback:)
       # ==== Params
       # +String+ +symbol+:: The symbol of the commission rate
       # +Proc+ +callback+:: A +Proc+ of two arguments, An exception and a result, called either with the exception or with the result, a commission for a symbol for the user
-
       def get_spot_commission(symbol:, callback:)
         request('spot_fee', callback, { symbol: symbol })
       end

lib/cryptomarket/websocket/wallet_client.rb

@@ -6,13 +6,15 @@
 
 module Cryptomarket
   module Websocket
-    # WalletClient connects via websocket to cryptomarket to get wallet information of the user. uses SHA256 as auth method and authenticates automatically.
+    # WalletClient connects via websocket to cryptomarket to get wallet information of the user.
+    # Uses SHA256 as auth method and authenticates automatically.
     class WalletClient < AuthClient
       # Creates a new client and authenticates it to the server
       # ==== Params
       # +String+ +api_key+:: the user api key
       # +String+ +api_secret+:: the user api secret
       # +Integer+ +window+:: Maximum difference between the creation of the request and the moment of request processing in milliseconds. Max is 60_000. Defaul is 10_000
+
       def initialize(api_key:, api_secret:, window: nil)
         super(
           url: 'wss://api.exchange.cryptomkt.com/api/3/ws/wallet',
@@ -44,7 +46,10 @@ def build_subscription_hash
       # +Proc+ +result_callback+:: Optional. A +Proc+ of two arguments, An exception and a result, called either with the exception or with the result, a boolean value, indicating the success of the subscription
 
       def subscribe_to_transactions(callback:, result_callback: nil)
-        send_subscription('subscribe_transactions', callback, nil, result_callback)
+        interceptor = lambda { |notification, _type|
+          callback.call(notification)
+        }
+        send_subscription('subscribe_transactions', interceptor, nil, result_callback)
       end
 
       # stop recieving the feed of transactions changes

tests/checker_generator.rb

@@ -83,6 +83,10 @@ def gen_check_notification_w_n_type_callback(check_fn, veredict_checker)
   ->(notification, _notification_type) { check_val(notification, check_fn, veredict_checker) }
 end
 
+def gen_check_notification_callback(check_fn, veredict_checker)
+  ->(notification) { check_val(notification, check_fn, veredict_checker) }
+end
+
 def gen_check_notification_list_callback(check_fn, veredict_checker)
   ->(notification) { check_list(notification, check_fn, veredict_checker) }
 end

tests/rest/wallet_management.rb

@@ -45,36 +45,6 @@ def test_get_last_10_withdrawal_crypto_addresses
     assert(good_list(->(address) { Check.good_address(address) }, result))
   end
 
-  def test_withdraw_crypto
-    ada_address = @client.get_deposit_crypto_address(currency: 'ADA')['address']
-    transaction_id = @client.withdraw_crypto(currency: 'ADA', amount: '0.1', address: ada_address)
-    assert(!transaction_id.empty?)
-  end
-
-  def test_withdraw_crypto_commit
-    ada_address = @client.get_deposit_crypto_address(currency: 'ADA')['address']
-    transaction_id = @client.withdraw_crypto(
-      currency: 'ADA',
-      amount: '0.1',
-      address: ada_address,
-      auto_commit: false
-    )
-    success = @client.withdraw_crypto_commit id: transaction_id
-    assert(success)
-  end
-
-  def test_withdraw_crypto_rollback
-    ada_address = @client.get_deposit_crypto_address(currency: 'ADA')['address']
-    transaction_id = @client.withdraw_crypto(
-      currency: 'ADA',
-      amount: '0.1',
-      address: ada_address,
-      auto_commit: false
-    )
-    success = @client.withdraw_crypto_rollback id: transaction_id
-    assert(success)
-  end
-
   def test_get_estimate_withdrawal_fees
     result = @client.get_estimate_withdrawal_fees [{ currency: 'ETH', amount: '12' }, { currency: 'BTC', amount: '1' }]
     assert(result.count == 2)

tests/rest/wallet_management_withdraw_crypto.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+require_relative '../key_loader'
+require_relative '../wallet'
+require_relative '../checks'
+require_relative '../../lib/cryptomarket/client'
+
+class TestRestTradingMethods < Test::Unit::TestCase # rubocop:disable Style/Documentation
+  def setup
+    @wallet = Wallet.new
+    @client = Cryptomarket::Client.new api_key: KeyLoader.api_key, api_secret: KeyLoader.api_secret
+  end
+
+  def test_withdraw_crypto_commit
+    transaction_id = @client.withdraw_crypto(
+      currency: 'ETH',
+      amount: '0.00001',
+      address: @wallet.eth,
+      auto_commit: false
+    )
+    success = @client.withdraw_crypto_commit id: transaction_id
+    assert(success)
+  end
+
+  def test_withdraw_crypto_rollback
+    transaction_id = @client.withdraw_crypto(
+      currency: 'ETH',
+      amount: '0.00001',
+      address: @wallet.eth,
+      auto_commit: false
+    )
+    success = @client.withdraw_crypto_rollback id: transaction_id
+    assert(success)
+  end
+end

tests/wallet.rb

@@ -0,0 +1,12 @@
+require 'json'
+
+# loads a json with keys
+class Wallet
+  def initialize
+    file = File.open '../../wallet.json'
+    keys = JSON.load file # rubocop:disable Security/JSONLoad
+    @eth = keys['eth']
+  end
+
+  attr_reader :eth
+end

tests/websocket/wallet_client_subscriptions.rb

@@ -7,7 +7,7 @@
 require_relative '../checks'
 require_relative '../checker_generator'
 
-class TestWSaccount < Test::Unit::TestCase
+class TestWSWalletClientSubscriptions < Test::Unit::TestCase # rubocop:disable Style/Documentation
   def setup
     @wsclient = Cryptomarket::Websocket::WalletClient.new api_key: KeyLoader.api_key, api_secret: KeyLoader.api_secret
     @wsclient.connect
@@ -22,12 +22,12 @@ def teardown
 
   def test_transaction_and_balance_subscription # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
     @wsclient.subscribe_to_transactions(
-      callback: gen_check_notification_w_n_type_callback(WSCheck.good_transaction, @veredict_checker),
+      callback: gen_check_notification_callback(WSCheck.good_transaction, @veredict_checker),
       result_callback: gen_result_callback(@veredict_checker)
     )
     sleep(3)
     @restclient.transfer_between_wallet_and_exchange(
-      currency: 'EOS',
+      currency: 'CRO',
       amount: '0.1',
       source: 'spot',
       destination: 'wallet'
@@ -39,7 +39,7 @@ def test_transaction_and_balance_subscription # rubocop:disable Metrics/MethodLe
     )
     sleep(3)
     @restclient.transfer_between_wallet_and_exchange(
-      currency: 'EOS',
+      currency: 'CRO',
       amount: '0.1',
       source: 'wallet',
       destination: 'spot'