Merge branch 'develop'

Author: Pedro Pablo Bustamante Barrera

Gemfile.lock

@@ -53,9 +53,9 @@ GEM
     websocket-extensions (0.1.5)
 
 PLATFORMS
-  x86_64-linux
   arm64-darwin-23
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   eventmachine (= 1.2.7)

README.md

@@ -9,7 +9,7 @@
 To install Cryptomarket use gem
 
 ```
-gem install cryptomarket-sdk
+gem install cryptomarket-sdk -v 3.2.0
 ```
 
 # Documentation

cryptomarket-sdk.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "cryptomarket-sdk"
-  s.version     = "3.1.0"
+  s.version     = "3.2.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["T. Ismael Verdugo"]
   s.email       = ["[email protected]"]

lib/cryptomarket/client.rb

@@ -39,36 +39,24 @@ def delete(endpoint, params = nil)
       @http_manager.make_request(method: 'delete', endpoint: endpoint, params: params)
     end
 
-    ###########
-    # aliases #
-    ###########
+    # Changes the user credentials used for authentication in calls
+    #
+    # ==== Params
+    # +String+ +api_key+:: The user public key used in new calls
+    # +String+ +api_secret+:: The user secret key used in new calls
 
-    # market data
+    def change_credentials(api_key:, api_secret:)
+      @http_manager.change_credentials(api_key: api_key, api_secret: api_secret)
+    end
 
-    # alias of get ticker
-    alias get_ticker_by_symbol get_ticker
-    alias get_ticker_of_symbol get_ticker
-    alias get_ticker_price_by_symbol get_ticker_price
-    alias get_ticker_price_of_symbol get_ticker_price
-    alias get_trades_of_symbol get_trades_by_symbol
-    alias get_orderbook_by_symbol get_orderbook
-    alias get_orderbook_of_symbol get_orderbook
-    alias get_orderbook_volume_by_symbol get_orderbook_volume
-    alias get_orderbook_volume_of_symbol get_orderbook_volume
-    alias get_candles_of_symbol get_candles_by_symbol
-    alias get_converted_candles_of_symbol get_converted_candles_by_symbol
-    #  spot trading
-    alias get_spot_trading_balance_of_currency get_spot_trading_balance
-    alias get_spot_trading_balance_by_currency get_spot_trading_balance
-    alias get_all_trading_commissions get_all_trading_commission
-    alias get_trading_commission get_all_trading_commission
-    alias get_trading_commission_of_symbol get_trading_commission
-    alias get_trading_commission_by_symbol get_trading_commission
-    # wallet management
-    alias get_wallet_balance_of_currency get_wallet_balance
-    alias get_wallet_balance_by_currency get_wallet_balance
-    alias get_deposit_crypto_address_of_cyrrency get_deposit_crypto_address
-    alias get_deposit_crypto_address_by_cyrrency get_deposit_crypto_address
+    # Changes the window used in authenticated calls
+    #
+    # ==== Params
+    # +Integer+ +window+:: Acceptable time between request and server execution in millis
+
+    def change_window(window:)
+      @http_manager.change_window(window: window)
+    end
 
     ################
     # public calls #
@@ -863,11 +851,25 @@ def withdraw_crypto_rollback(id:)
     # ==== Params
     # +Array[]+ +fee_requests+:: the list of fee requests, each request is a Hash in the form {currency:"string", amount:"string", network_code:"optional string"}
 
-    def get_estimate_withdrawal_fees(fee_requests)
+    def get_estimate_withdrawal_fees(fee_requests:)
       params = fee_requests
       post('wallet/crypto/fees/estimate', params)
     end
 
+    # Get an estimates for withdrawal fees of currencies
+    #
+    # Requires the "Payment information" API key Access Right
+    #
+    # https://api.exchange.cryptomkt.com/#bulk-estimate-withdrawal-fee
+    #
+    # ==== Params
+    # +Array[]+ +fee_requests+:: the list of fee requests, each request is a Hash in the form {currency:"string", amount:"string", network_code:"optional string"}
+
+    def get_bulk_estimate_withdrawal_fees(fee_requests:)
+      params = fee_requests
+      post('wallet/crypto/fee/estimate/bulk', params)
+    end
+
     # Get an estimate of the withdrawal fee
     #
     # Requires the "Payment information" API key Access Right
@@ -883,6 +885,34 @@ def get_estimate_withdrawal_fee(currency:, amount:, network_code: nil)
       get('wallet/crypto/fee/estimate', params)['fee']
     end
 
+    # # Get an estimates for deposit fees of currencies
+    # #
+    # # Requires the "Payment information" API key Access Right
+    # #
+    # # https://api.exchange.cryptomkt.com/#bulk-estimate-deposit-fee
+    # #
+    # # ==== Params
+    # # +Array[]+ +fee_requests+:: the list of fee requests, each request is a Hash in the form {currency:"string", amount:"string", network_code:"optional string"}
+    # def get_bulk_estimate_deposit_fees(fee_requests:)
+    #   params = fee_requests
+    #   post('wallet/crypto/fee/deposit/estimate/bulk', params)
+    # end
+
+    # # Get an estimate of the deposit fee
+    # #
+    # # Requires the "Payment information" API key Access Right
+    # #
+    # # https://api.exchange.cryptomkt.com/#estimate-deposit-fee
+    # #
+    # # ==== Params
+    # # +String+ +currency+:: the currency code for deposit
+    # # +float+ +amount+:: the expected deposit amount
+
+    # def get_estimate_deposit_fee(currency:, amount:, network_code: nil)
+    #   params = { amount: amount, currency: currency, network_code: network_code }
+    #   get('wallet/crypto/fee/deposit/estimate', params)['fee']
+    # end
+
     # Converts between currencies
     # Successful response to the request does not necessarily mean the resulting transaction got executed immediately. It has to be processed first and may eventually be rolled back
     # To see whether a transaction has been finalized, call #get_transaction
@@ -986,9 +1016,9 @@ def transfer_money_to_another_user(currency:, amount:, by:, identifier:)
     # +Array[String]+ +statuses+:: Optional. List of statuses to query. valid subtypes are: 'CREATED', 'PENDING', 'FAILED', 'SUCCESS' and 'ROLLED_BACK'
     # +Array[String]+ +currencies+:: Optional. Currency codes of the transactions to fetch
     # +Array[String]+ +networks+:: Optional. Network codes of the transactions to fetch
-    # +String+ +order_by+:: Optional. sorting parameter.'created_at' or 'id'. Default is 'created_at'
-    # +String+ +from+:: Optional. Interval initial value when ordering by 'created_at'. As Datetime
-    # +String+ +till+:: Optional. Interval end value when ordering by 'created_at'. As Datetime
+    # +String+ +order_by+:: Optional. sorting parameter.'created_at', 'updated_at', 'last_activity_at' 'or 'id'.
+    # +String+ +from+:: Optional. Optional. Interval initial value (inclusive). The value type depends on order_by
+    # +String+ +till+:: Optional. Interval end value (inclusive). The value type depends on order_BY
     # +String+ +id_from+:: Optional. Interval initial value when ordering by id. Min is 0
     # +String+ +id_till+:: Optional. Interval end value when ordering by id. Min is 0
     # +String+ +sort+:: Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
@@ -1238,5 +1268,38 @@ def get_sub_account_crypto_address(
         "sub-account/crypto/address/#{sub_account_id}/#{currency}"
       )['result']['address']
     end
+
+    ###########
+    # aliases #
+    ###########
+
+    # market data
+    alias get_ticker_by_symbol get_ticker
+    alias get_ticker_of_symbol get_ticker
+    alias get_ticker_price_by_symbol get_ticker_price
+    alias get_ticker_price_of_symbol get_ticker_price
+    alias get_trades_of_symbol get_trades_by_symbol
+    alias get_orderbook_by_symbol get_orderbook
+    alias get_orderbook_of_symbol get_orderbook
+    alias get_orderbook_volume_by_symbol get_orderbook_volume
+    alias get_orderbook_volume_of_symbol get_orderbook_volume
+    alias get_candles_of_symbol get_candles_by_symbol
+    alias get_converted_candles_of_symbol get_converted_candles_by_symbol
+
+    #  spot trading
+    alias get_spot_trading_balance_of_currency get_spot_trading_balance
+    alias get_spot_trading_balance_by_currency get_spot_trading_balance
+    alias get_all_trading_commissions get_all_trading_commission
+    alias get_trading_commissions get_all_trading_commission
+    alias get_trading_commission_of_symbol get_trading_commission
+    alias get_trading_commission_by_symbol get_trading_commission
+
+    # wallet management
+    alias get_wallet_balance_of_currency get_wallet_balance
+    alias get_wallet_balance_by_currency get_wallet_balance
+    alias get_deposit_crypto_address_of_cyrrency get_deposit_crypto_address
+    alias get_deposit_crypto_address_by_cyrrency get_deposit_crypto_address
   end
 end
+
+# rubocop:enable Layout/LineLength

lib/cryptomarket/credentials_factory.rb

@@ -18,6 +18,15 @@ def initialize(api_version:, api_key:, api_secret:, window: nil)
       @window = window
     end
 
+    def change_credentials(api_key:, api_secret:)
+      @api_key = api_key
+      @api_secret = api_secret
+    end
+
+    def change_window(window:)
+      @window = window
+    end
+
     def get_credential(http_method, method, params)
       timestamp = DateTime.now.strftime('%Q')
       msg = build_credential_message(http_method, method, timestamp, params)
@@ -37,7 +46,7 @@ def build_credential_message(http_method, method, timestamp, params)
                not_post_params(http_method, params)
              end
       msg += timestamp
-      msg += @window unless @window.nil?
+      msg += @window.to_s unless @window.nil?
       msg
     end
 

lib/cryptomarket/http_manager.rb

@@ -37,6 +37,14 @@ def initialize(api_key:, api_secret:, window: nil)
       )
     end
 
+    def change_credentials(api_key:, api_secret:)
+      @credential_factory.change_credentials(api_key: api_key, api_secret: api_secret)
+    end
+
+    def change_window(window:)
+      @credential_factory.change_window(window: window)
+    end
+
     def make_request(method:, endpoint:, params: nil, public: false)
       uri = URI(@@API_URL + @@API_VERSION + endpoint)
       payload = build_payload(params)

lib/cryptomarket/websocket/trading_client.rb

@@ -35,11 +35,6 @@ def build_subscription_hash
           'spot_balance' => [balances, Args::NotificationType::SNAPSHOT] }
       end
 
-      alias get_spot_trading_balance_of_currency get_spot_trading_balance
-      alias get_spot_trading_balance_by_currency get_spot_trading_balance
-      alias get_spot_commission_of_symbol get_spot_commission
-      alias get_spot_commission_by_symbol get_spot_commission
-
       # subscribe to a feed of execution reports of the user's orders
       #
       # https://api.exchange.cryptomkt.com/#socket-spot-trading
@@ -274,6 +269,11 @@ def get_spot_commissions(callback:)
       def get_spot_commission(symbol:, callback:)
         request('spot_fee', callback, { symbol: symbol })
       end
+
+      alias get_spot_trading_balance_of_currency get_spot_trading_balance
+      alias get_spot_trading_balance_by_currency get_spot_trading_balance
+      alias get_spot_commission_of_symbol get_spot_commission
+      alias get_spot_commission_by_symbol get_spot_commission
     end
   end
 end

lib/cryptomarket/websocket/wallet_client.rb

@@ -37,9 +37,6 @@ def build_subscription_hash
           'wallet_balance_update' => [balance, Args::NotificationType::UPDATE] }
       end
 
-      alias get_wallet_balance_of_currency get_wallet_balance
-      alias get_wallet_balance_by_currency get_wallet_balance
-
       # A transaction notification occurs each time a transaction has been changed, such as creating a transaction, updating the pending state (e.g., the hash assigned) or completing a transaction
       #
       # https://api.exchange.cryptomkt.com/#subscribe-to-transactions
@@ -148,11 +145,11 @@ def get_wallet_balance(currency:, callback:)
       # +Array[String]+ +subtyes+:: Optional. List of subtypes to query. valid subtypes are: 'UNCLASSIFIED', 'BLOCKCHAIN', 'AIRDROP', 'AFFILIATE', 'STAKING', 'BUY_CRYPTO', 'OFFCHAIN', 'FIAT', 'SUB_ACCOUNT', 'WALLET_TO_SPOT', 'SPOT_TO_WALLET', 'WALLET_TO_DERIVATIVES', 'DERIVATIVES_TO_WALLET', 'CHAIN_SWITCH_FROM', 'CHAIN_SWITCH_TO' and 'INSTANT_EXCHANGE'
       # +Array[String]+ +statuses+:: Optional. List of statuses to query. valid subtypes are: 'CREATED', 'PENDING', 'FAILED', 'SUCCESS' and 'ROLLED_BACK'
       # +Array[String] +currencies+:: Optional. List of currencies ids.
-      # +String+ +from+:: Optional. Interval initial value when ordering by 'created_at'. As Datetime
-      # +String+ +till+:: Optional. Interval end value when ordering by 'created_at'. As Datetime
+      # +String+ +from+:: Optional. Optional. Interval initial value (inclusive). The value type depends on order_by
+      # +String+ +till+:: Optional. Interval end value (inclusive). The value type depends on order_by
       # +String+ +id_from+:: Optional. Interval initial value when ordering by id. Min is 0
       # +String+ +id_till+:: Optional. Interval end value when ordering by id. Min is 0
-      # +String+ +order_by+:: Optional. sorting parameter.'created_at' or 'id'. Default is 'created_at'
+      # +String+ +order_by+:: Optional. sorting parameter.'created_at', 'updated_at', 'last_activity_at' 'or 'id'.
       # +String+ +sort+:: Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
       # +Integer+ +limit+:: Optional. Transactions per query. Defaul is 100. Max is 1_000
       # +Integer+ +offset+:: Optional. Default is 0. Max is 100_000
@@ -168,6 +165,9 @@ def get_transactions( # rubocop:disable Metrics/ParameterLists
                   limit: limit, offset: offset, group_transactions: group_transactions
                 })
       end
+
+      alias get_wallet_balance_of_currency get_wallet_balance
+      alias get_wallet_balance_by_currency get_wallet_balance
     end
   end
 end

tests/rest/change_credentials.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+require_relative '../key_loader'
+require_relative '../checks'
+require_relative '../../lib/cryptomarket/client'
+
+class ChangeCredentials < Test::Unit::TestCase # rubocop:disable Style/Documentation
+  def setup
+    @client = Cryptomarket::Client.new api_key: KeyLoader.api_key, api_secret: KeyLoader.api_secret
+  end
+
+  def test_change_credentials
+    result = @client.get_wallet_balances
+    assert(good_list(->(balance) { Check.good_balance(balance) }, result))
+
+    @client.change_credentials api_key: '', api_secret: ''
+    begin
+      @client.get_wallet_balances
+      assert(false)
+    rescue Cryptomarket::APIException
+      nil
+    end
+
+    @client.change_credentials api_key: KeyLoader.api_key, api_secret: KeyLoader.api_secret
+    result = @client.get_wallet_balances
+    assert(good_list(->(balance) { Check.good_balance(balance) }, result))
+  end
+end

tests/rest/change_window.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+require_relative '../key_loader'
+require_relative '../checks'
+require_relative '../../lib/cryptomarket/client'
+
+class ChangeWindow < Test::Unit::TestCase # rubocop:disable Style/Documentation
+  def setup
+    @client = Cryptomarket::Client.new api_key: KeyLoader.api_key, api_secret: KeyLoader.api_secret
+  end
+
+  def test_change_window
+    result = @client.get_wallet_balances
+    assert(good_list(->(balance) { Check.good_balance(balance) }, result))
+
+    @client.change_window window: 100
+    begin
+      @client.get_wallet_balances
+      assert(false)
+    rescue Cryptomarket::APIException
+      nil
+    end
+
+    @client.change_window window: 10_000
+    result = @client.get_wallet_balances
+    assert(good_list(->(balance) { Check.good_balance(balance) }, result))
+  end
+end