binance_client 2.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16763512a190393e8a071e5e0840de77416ec615e91edf8f86cc1b897ca40c4b
-  data.tar.gz: e30373d8442ad67cd59a43bd5e4c1c97b8bf93724d2a1d0820d02363ae7387d1
+  metadata.gz: f3b7cc28ee5e49a6bd911193495c4fe75c8cb8854567a26aee1e4c4ab644403e
+  data.tar.gz: 8b2deb1fb0a89194fb839c4ed21949955c564f2cea8bfaccd35fb18a15619e72
 SHA512:
-  metadata.gz: a92884dc017a7a2ae3b868acd953eb7c89e95f08e537176e7298fff4112f5acb6c4582f73156fb7b4a99b9c7523b0e57a5219a423e4903ea38052f1a03ba8186
-  data.tar.gz: cf6a0272acc771014477ed8946a293c688a5a5679814f4f96d24cdf09fbd605843d0bfce113a2ae819f4d969f85e5331f758b72299fccbd08f32bb1c57f26672
+  metadata.gz: ac8076c646803401ee62a4320dc8f45335a0d0b3b7647e9c106816ffc5349853b789a3d83760f254cf4bf8e9c0ab32109e71b29225355a5100692fbf4ace5487
+  data.tar.gz: 47bea0043b15597afc809976f0389a8824b984115324fa430b115db2467559d9312c13a5f7d4790bb02ad22f3ffd8ac7fe2e5aaf3996d11a4f34e54d380ffb9b

data/CHANGELOG.md

@@ -4,7 +4,36 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.5.0]
+## [4.0.0]
+### Added
+- Add optional `network` parameter when getting deposit address of a specific network
+- Use keyword arguments when calling `sub_account_deposit_address`
+
+## [3.0.1]
+### Fixed
+- `Coin#network_list` is initialized properly
+- Return decimal for the following methods of `Network`:
+  - `#withdraw_fee`
+  - `#withdraw_integer_multiple`
+  - `#withdraw_max`
+  - `#withdraw_min`
+
+## [3.0.0]
+### Changed
+- Rename `#get_all` to `#coins_info` and give access to info via the response's `#coins` method
+
+### Fixed
+- `Deposit#insert_time` returns `Time` and not an Integer of milliseconds
+
+### Added
+- Add Deposit, RateLimit factories
+
+## [2.1.0]
+### Added
+- `exchange_info` endpoint
+- `sub_account_deposit_history` endpoint
+
+## [2.0.0]
 ### Changed
 - Remove `used_weight` from responses
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    binance_client (2.0.0)
+    binance_client (4.0.0)
       activesupport
       api_client_base (~> 1.11)
       typhoeus
@@ -39,7 +39,7 @@ GEM
       ffi (>= 1.15.0)
     factory_bot (6.2.0)
       activesupport (>= 5.0.0)
-    ffi (1.15.4)
+    ffi (1.15.5)
     gem_config (0.3.2)
     hashdiff (1.0.1)
     i18n (1.8.11)
@@ -102,4 +102,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.28
+   2.2.29

data/README.md

@@ -34,11 +34,13 @@ We provide one method per API endpoint.
 ```
 client.system_status
 client.account_snapshot
-client.get_all
+client.coins_info
 client.book_ticker(symbol: "BTCETH")
 client.order_book_depth(symbol: "BTCUSDT", limit: 100)
 ```
 
+See `spec/acceptance` for all calls.
+
 ## Responses
 The default representation of response data is a JSON hash
 
@@ -55,10 +57,7 @@ What you assign can be a proc -- it just needs to respond to `call` and accept t
 class DoSomethingAfterBinanceResponse
 
   def self.call(request, response)
-    one_minute_weight = response.used_weight("1m")
-    if one_minute_weight > 1200
-      Rails.logger.info "Looks like we've hit the request limit!"
-    end
+    response.used_weights # Ruby hash of the headers of all the possible used weights
   end
 
 end

data/lib/binance_client/client.rb

@@ -5,11 +5,13 @@ module BinanceClient
     api_action :account
     api_action :system_status
     api_action :account_snapshot
-    api_action :get_all
+    api_action :coins_info
+    api_action :exchange_info
     api_action :book_ticker
     api_action :order_book_depth
     api_action :sub_account_assets, args: [:email]
-    api_action :sub_account_deposit_address, args: [:email, :coin]
+    api_action :sub_account_deposit_address
+    api_action :sub_account_deposit_history
 
     attribute :host
     attribute :api_key

data/lib/binance_client/factories.rb

@@ -10,4 +10,59 @@ FactoryBot.define do
     end
   end
 
+  factory :binance_client_deposit, class: "BinanceClient::Deposit" do
+    sequence(:sub_account_id) { |n| n.to_s }
+    sequence(:address) { |n| "address#{n}" }
+    sequence(:address_tag) { |n| "address_tag#{n}" }
+    sequence(:amount) { |n| n * 10 }
+    sequence(:coin) { |n| "coin#{n}" }
+    sequence(:insert_time) { |n| Time.now }
+    sequence(:network) { |n| "network#{n}" }
+    sequence(:status) { |n| "status#{n}" }
+    sequence(:tx_id) { |n| "tx_id#{n}" }
+    sequence(:source_address) { |n| "source_address#{n}" }
+    sequence(:confirm_times) { |n| "#{n}/#{n}" }
+  end
+
+  factory :binance_client_rate_limit, class: "BinanceClient::RateLimit" do
+    rate_limit_type { "REQUEST_WEIGHT" }
+    interval { %w[SECOND MINUTE DAY].sample }
+    sequence(:interval_num) { |n| n }
+    sequence(:limit) { |n| n }
+  end
+
+  factory :binance_client_coin, class: "BinanceClient::Coin" do
+    sequence(:coin) { |n| "ASSET#{n}" }
+    sequence(:name) { |n| "Asset #{n}" }
+    free { 0.001 }
+    freeze { 0.001 }
+    ipoable { 0.002 }
+    ipoing { 0.003 }
+    locked { 0.004 }
+    storage { 0.005 }
+    withdrawing { 0.006 }
+  end
+
+  factory :binance_client_network, class: "BinanceClient::Network" do
+    address_regex { "^(bnb1)[0-9a-z]{38}$" }
+    coin { "BTC" }
+    deposit_desc { "Wallet Maintenance" }
+    deposit_enable { false }
+    is_default { false }
+    memo_regex { "^[0-9A-Za-z\\-_]{1,120}$" }
+    min_confirm { 1 }
+    name { "BEP2" }
+    network { "BNB" }
+    reset_address_status { false }
+    special_tips { "Both a MEMO is required" }
+    un_lock_confirm { 0 }
+    withdraw_desc { "Wallet Maintenance" }
+    withdraw_enable { false }
+    withdraw_fee { "0.00000220" }
+    withdraw_integer_multiple { "0.00000001" }
+    withdraw_max { "9999999999.99999999" }
+    withdraw_min { "0.00000440" }
+    same_address { true }
+  end
+
 end

data/lib/binance_client/models/base_model.rb

@@ -3,5 +3,12 @@ module BinanceClient
 
     include Virtus.model
 
+    private
+
+    def memoize_results(key)
+      return instance_variable_get(key) if instance_variable_defined?(key)
+      instance_variable_set key, yield
+    end
+
   end
 end

data/lib/binance_client/models/coin.rb

@@ -0,0 +1,70 @@
+module BinanceClient
+  class Coin < BaseModel
+
+    STR_METHODS = %i[
+      coin
+      name
+    ].freeze
+
+    DECIMAL_METHODS = %i[
+      free
+      freeze
+      ipoable
+      ipoing
+      locked
+      storage
+      withdrawing
+    ].freeze
+
+    BOOL_MAP = {
+      deposit_all_enable: :deposit_all_enabled?,
+      is_legal_money: :legal_money?,
+      trading: :trading?,
+      withdraw_all_enable: :withdraw_all_enabled?,
+    }.freeze
+
+    METHODS = (STR_METHODS + DECIMAL_METHODS + BOOL_MAP.keys).freeze
+
+    attr_accessor :raw_hash
+    attr_writer *METHODS
+
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    STR_METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
+      end
+    end
+
+    DECIMAL_METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)].to_d
+        end
+      end
+    end
+
+    BOOL_MAP.each do |original_method_name, alias_method_name|
+      define_method original_method_name do
+        memoize_results "@#{original_method_name}" do
+          raw_hash[original_method_name.to_s.camelcase(:lower)]
+        end
+      end
+
+      alias_method alias_method_name, original_method_name
+    end
+
+    def network_list
+      @network_list ||= raw_hash["networkList"].map do |network_hash|
+        Network.new(raw_hash: network_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/models/deposit.rb

@@ -0,0 +1,40 @@
+module BinanceClient
+  class Deposit < BaseModel
+
+    METHODS = %i[
+      sub_account_id
+      address
+      address_tag
+      amount
+      coin
+      network
+      status
+      tx_id
+      source_address
+      confirm_times
+      insert_time
+    ].freeze
+
+    attr_accessor :raw_hash
+    attr_writer *METHODS
+
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
+      end
+    end
+
+    def insert_time
+      @insert_time ||= Time.at(raw_hash["insertTime"] / 1_000)
+    end
+
+  end
+end

data/lib/binance_client/models/market.rb

@@ -0,0 +1,58 @@
+module BinanceClient
+  class Market < BaseModel
+
+    METHODS = %i[
+      symbol
+      status
+      base_asset
+      base_asset_precision
+      quote_asset
+      quote_precision
+      quote_asset_precision
+      base_commission_precision
+      quote_commission_precision
+      order_types
+      iceberg_allowed
+      oco_allowed
+      quote_order_qty_market_allowed
+      is_spot_trading_allowed
+      is_margin_trading_allowed
+    ].freeze
+
+    BOOL_MAP = {
+      iceberg_allowed: :iceberg_allowed?,
+      oco_allowed: :oco_allowed?,
+      quote_order_qty_market_allowed: :quote_order_qty_market_allowed?,
+      is_spot_trading_allowed: :spot_trading_allowed?,
+      is_margin_trading_allowed: :margin_trading_allowed?,
+    }.freeze
+
+    attr_accessor :raw_hash
+    attr_writer *METHODS
+
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
+      end
+    end
+
+    BOOL_MAP.each do |original_method_name, alias_method_name|
+      alias_method alias_method_name, original_method_name
+    end
+
+    def filters
+      @filters ||= raw_hash["filters"].map do |filter_hash|
+        MarketFilter.new(raw_hash: filter_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/models/market_filter.rb

@@ -0,0 +1,25 @@
+module BinanceClient
+  class MarketFilter
+
+    attr_reader :raw_hash
+
+    def initialize(raw_hash:)
+      @raw_hash = raw_hash
+    end
+
+    def method_missing(method_name, *args)
+      key = method_name.to_s.camelcase(:lower)
+      super if raw_hash[key].nil?
+
+      self.class.define_method method_name do
+        value = raw_hash[method_name.to_s.camelcase(:lower)]
+
+        value = value.to_d if value =~ /^[\d\.]+$/
+
+        value
+      end
+      send(method_name)
+    end
+
+  end
+end

data/lib/binance_client/models/network.rb

@@ -0,0 +1,70 @@
+module BinanceClient
+  class Network < BaseModel
+
+    PLAIN_METHODS = %i[
+      address_regex
+      coin
+      deposit_desc
+      memo_regex
+      min_confirm
+      name
+      network
+      special_tips
+      un_lock_confirm
+      withdraw_desc
+    ].freeze
+
+    DECIMAL_METHODS = %i[
+      withdraw_fee
+      withdraw_integer_multiple
+      withdraw_max
+      withdraw_min
+    ].freeze
+
+    BOOL_MAP = {
+      deposit_enable: :deposit_enabled?,
+      is_default: :default?,
+      reset_address_status: :reset_address_status?,
+      withdraw_enable: :withdraw_enabled?,
+      same_address: :same_address?
+    }.freeze
+
+    METHODS = (PLAIN_METHODS + DECIMAL_METHODS + BOOL_MAP.keys).freeze
+
+    attr_accessor :raw_hash
+    attr_writer *METHODS
+
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    PLAIN_METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
+      end
+    end
+
+    DECIMAL_METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results "@#{method_name}" do
+          raw_hash[method_name.to_s.camelcase(:lower)].to_d
+        end
+      end
+    end
+
+    BOOL_MAP.each do |original_method_name, alias_method_name|
+      define_method original_method_name do
+        memoize_results "@#{original_method_name}" do
+          raw_hash[original_method_name.to_s.camelcase(:lower)]
+        end
+      end
+
+      alias_method alias_method_name, original_method_name
+    end
+
+  end
+end

data/lib/binance_client/models/rate_limit.rb

@@ -0,0 +1,36 @@
+module BinanceClient
+  class RateLimit < BaseModel
+
+    INTERVALS = %w[SECOND MINUTE DAY].freeze
+    METHODS = %i[
+      rate_limit_type
+      interval
+      interval_num
+      limit
+    ].freeze
+
+    attr_accessor :raw_hash
+    attr_writer *METHODS
+
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    METHODS.each do |method_name|
+      define_method method_name do
+        memoize_results("@#{method_name}") do
+          raw_hash[method_name.to_s.camelcase(:lower)]
+        end
+      end
+    end
+
+    INTERVALS.each do |interval|
+      define_method "#{interval.downcase}?" do
+        interval == self.interval
+      end
+    end
+
+  end
+end

data/lib/binance_client/requests/{get_all_request.rb → coins_info_request.rb}

@@ -1,5 +1,5 @@
 module BinanceClient
-  class GetAllRequest < AuthenticatedBaseRequest
+  class CoinsInfoRequest < AuthenticatedBaseRequest
     private
 
     def path

data/lib/binance_client/requests/exchange_info_request.rb

@@ -0,0 +1,10 @@
+module BinanceClient
+  class ExchangeInfoRequest < BaseRequest
+    private
+
+    def path
+      "api/v1/exchangeInfo"
+    end
+
+  end
+end

data/lib/binance_client/requests/sub_account_deposit_history_request.rb

@@ -0,0 +1,36 @@
+module BinanceClient
+  class SubAccountDepositHistoryRequest < AuthenticatedBaseRequest
+    attribute :sub_account_id, String
+    attribute :start_time, DateTime
+    attribute :end_time, DateTime
+    attribute :coin, String
+    attribute :status, Integer
+    attribute :limit, Integer
+    attribute :offset, Integer
+
+    PARAMS = [
+      :sub_account_id,
+      :start_time,
+      :end_time,
+      :coin,
+      :status,
+      :limit,
+      :offset,
+    ].freeze
+
+    private
+
+    def path
+      "/sapi/v1/broker/subAccount/depositHist"
+    end
+
+    def params_without_signature
+      PARAMS.each_with_object({}) do |param, hash|
+        key = param.to_s.camelcase(:lower)
+        value = send(param)
+        value = value.to_i * 1_000 if value.is_a?(DateTime)
+        hash[key] = value
+      end
+    end
+  end
+end

data/lib/binance_client/responses/coins_info_response.rb

@@ -0,0 +1,11 @@
+module BinanceClient
+  class CoinsInfoResponse < BaseResponse
+
+    def coins
+      @coins ||= body.map do |coin_hash|
+        Coin.new(raw_hash: coin_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/responses/exchange_info_response.rb

@@ -0,0 +1,30 @@
+module BinanceClient
+  class ExchangeInfoResponse < BaseResponse
+
+    def timezone
+      body["timezone"]
+    end
+
+    def timezone
+      body["timezone"]
+    end
+
+    def server_time
+      body["serverTime"]
+    end
+
+    def markets
+      @markets ||= body["symbols"].map do |market_hash|
+        Market.new(raw_hash: market_hash)
+      end
+    end
+    alias_method :symbols, :markets
+
+    def rate_limits
+      @rate_limits ||= body["rateLimits"].map do |rate_limit_hash|
+        RateLimit.new(raw_hash: rate_limit_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/responses/sub_account_deposit_history_response.rb

@@ -0,0 +1,11 @@
+module BinanceClient
+  class SubAccountDepositHistoryResponse < BaseResponse
+
+    def deposits
+      body.map do |deposit_hash|
+        Deposit.new(raw_hash: deposit_hash)
+      end
+    end
+
+  end
+end

data/lib/binance_client/version.rb

@@ -1,3 +1,3 @@
 module BinanceClient
-  VERSION = "2.0.0"
+  VERSION = "4.0.0"
 end

data/lib/binance_client.rb

@@ -3,6 +3,8 @@ require "api_client_base"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/object/to_query"
 require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/date_time"
+require "active_support/core_ext/integer"
 require "json"
 require "openssl"
 
@@ -13,25 +15,35 @@ require "binance_client/models/order_book_entry"
 require "binance_client/models/order_book"
 require "binance_client/models/asset_balance"
 require "binance_client/models/deposit_address"
+require "binance_client/models/market"
+require "binance_client/models/market_filter"
+require "binance_client/models/rate_limit"
+require "binance_client/models/deposit"
+require "binance_client/models/network"
+require "binance_client/models/coin"
 
 require "binance_client/requests/base_request"
 require "binance_client/requests/authenticated_base_request"
 require "binance_client/responses/base_response"
 require "binance_client/requests/system_status_request"
 require "binance_client/requests/account_snapshot_request"
-require "binance_client/requests/get_all_request"
+require "binance_client/requests/exchange_info_request"
+require "binance_client/requests/coins_info_request"
 require "binance_client/requests/book_ticker_request"
 require "binance_client/requests/order_book_depth_request"
 require "binance_client/requests/sub_account_assets_request"
 require "binance_client/requests/sub_account_deposit_address_request"
+require "binance_client/requests/sub_account_deposit_history_request"
 require "binance_client/requests/account_request"
 require "binance_client/responses/system_status_response"
 require "binance_client/responses/account_snapshot_response"
-require "binance_client/responses/get_all_response"
+require "binance_client/responses/coins_info_response"
+require "binance_client/responses/exchange_info_response"
 require "binance_client/responses/book_ticker_response"
 require "binance_client/responses/order_book_depth_response"
 require "binance_client/responses/sub_account_assets_response"
 require "binance_client/responses/sub_account_deposit_address_response"
+require "binance_client/responses/sub_account_deposit_history_response"
 require "binance_client/responses/account_response"
 
 module BinanceClient

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance_client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - AJ Villalobos
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2022-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_client_base
@@ -119,27 +119,37 @@ files:
 - lib/binance_client/factories.rb
 - lib/binance_client/models/asset_balance.rb
 - lib/binance_client/models/base_model.rb
+- lib/binance_client/models/coin.rb
+- lib/binance_client/models/deposit.rb
 - lib/binance_client/models/deposit_address.rb
+- lib/binance_client/models/market.rb
+- lib/binance_client/models/market_filter.rb
+- lib/binance_client/models/network.rb
 - lib/binance_client/models/order_book.rb
 - lib/binance_client/models/order_book_entry.rb
+- lib/binance_client/models/rate_limit.rb
 - lib/binance_client/requests/account_request.rb
 - lib/binance_client/requests/account_snapshot_request.rb
 - lib/binance_client/requests/authenticated_base_request.rb
 - lib/binance_client/requests/base_request.rb
 - lib/binance_client/requests/book_ticker_request.rb
-- lib/binance_client/requests/get_all_request.rb
+- lib/binance_client/requests/coins_info_request.rb
+- lib/binance_client/requests/exchange_info_request.rb
 - lib/binance_client/requests/order_book_depth_request.rb
 - lib/binance_client/requests/sub_account_assets_request.rb
 - lib/binance_client/requests/sub_account_deposit_address_request.rb
+- lib/binance_client/requests/sub_account_deposit_history_request.rb
 - lib/binance_client/requests/system_status_request.rb
 - lib/binance_client/responses/account_response.rb
 - lib/binance_client/responses/account_snapshot_response.rb
 - lib/binance_client/responses/base_response.rb
 - lib/binance_client/responses/book_ticker_response.rb
-- lib/binance_client/responses/get_all_response.rb
+- lib/binance_client/responses/coins_info_response.rb
+- lib/binance_client/responses/exchange_info_response.rb
 - lib/binance_client/responses/order_book_depth_response.rb
 - lib/binance_client/responses/sub_account_assets_response.rb
 - lib/binance_client/responses/sub_account_deposit_address_response.rb
+- lib/binance_client/responses/sub_account_deposit_history_response.rb
 - lib/binance_client/responses/system_status_response.rb
 - lib/binance_client/version.rb
 homepage: https://github.com/bloom-solutions/binance_client-ruby
@@ -149,7 +159,7 @@ metadata:
   homepage_uri: https://github.com/bloom-solutions/binance_client-ruby
   source_code_uri: https://github.com/bloom-solutions/binance_client-ruby
   changelog_uri: https://github.com/bloom-solutions/binance_client-ruby/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -165,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Binance API
 test_files: []

data/lib/binance_client/responses/get_all_response.rb

@@ -1,4 +0,0 @@
-module BinanceClient
-  class GetAllResponse < BaseResponse
-  end
-end