binance-ruby 1.2 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce807af0caee4eca993399b1ae95a56a6b55af597be3d08581724d717f81d62
-  data.tar.gz: 32668b0a998b6cad851be4ba03b0f9299721a6d8ae1a48f1eec93b674ca2d47e
+  metadata.gz: a7677d8d24f74b422c6060ea3950cd05ecbb92fe9740560351eb4e4bb0db89bb
+  data.tar.gz: 4c5cd1be93bcb44cec31ff006e720390dec12a93bf8e777f12b2a4b5bf1372fb
 SHA512:
-  metadata.gz: 93b84cfdcf54bf21f114d6f5b11cc993dccebfa61f67b0e49c79197eefe57744d4ce448196deed94a74d025718d34f1f078c74eb0142d6ff5cf8a33179eb733f
-  data.tar.gz: 5c0c6caf1f7d8dd8a2be8771ae8bdba8f671dc1fb425685c23dba324f4e3daa9a58269fe6b1ad17f923ab920a397e45e3b250e765ee51a4a4df4735a8cd55559
+  metadata.gz: 7e9eb96b126d8e16f2e443b992ef78a9b942a86b7f5b826d714458b3d5c0dec64cad208a50590929ca1b49b3907ceb8478443b85d1c6feec370c2adbff115f5f
+  data.tar.gz: 9fb99018e375191ca37b6a5b5c9d11034e04ca7df6c4f5f9013aa3afeb59ba3d5bad957c637910a5cc2e749eddc9131150c06d5a798ba23826855124e6099bb6

data/lib/binance-ruby.rb

@@ -6,12 +6,13 @@ require "faye/websocket"
 require "binance/api"
 require "binance/api/account"
 require "binance/api/configuration"
-require "binance/api/data_stream"
 require "binance/api/error"
 require "binance/api/margin"
 require "binance/api/margin/account"
 require "binance/api/margin/order"
 require "binance/api/order"
 require "binance/api/request"
+require "binance/api/trade"
+require "binance/api/user_data_stream"
 require "binance/api/version"
 require "binance/websocket"

data/lib/binance/api/account.rb

@@ -27,6 +27,23 @@ module Binance
                         params: params.delete_if { |key, value| value.nil? },
                         security_type: :user_data, api_key: api_key, api_secret_key: api_secret_key)
         end
+
+        # @note have not tested this for binance.us yet.
+        def withdraw!(coin: nil, withdrawOrderId: nil, network: nil, address: nil, addressTag: nil, amount: nil,
+                      transactionFeeFlag: false, name: nil, recvWindow: nil, api_key: nil, api_secret_key: nil)
+          raise Error.new(message: "amount is required") if amount.nil?
+          raise Error.new(message: "coin is required") if coin.nil?
+          raise Error.new(message: "address is required") if address.nil?
+          timestamp = Configuration.timestamp
+          params = {
+            coin: coin, withdrawOrderId: withdrawOrderId, network: network, address: address, timestamp: timestamp,
+            addressTag: addressTag, amount: amount, transactionFeeFlag: transactionFeeFlag,
+            name: name, recvWindow: recvWindow,
+          }
+          Request.send!(api_key_type: :read_info, path: "/sapi/v1/capital/withdraw/apply",
+                        params: params.delete_if { |key, value| value.nil? }, method: :post,
+                        security_type: :user_data, api_key: api_key, api_secret_key: api_secret_key)
+        end
       end
     end
   end

data/lib/binance/api/request.rb

@@ -10,8 +10,10 @@ module Binance
           raise Error.new(message: "invalid security type #{security_type}") unless security_types.include?(security_type)
           all_headers = default_headers(api_key_type: api_key_type, security_type: security_type, api_key: api_key)
           params.delete_if { |k, v| v.nil? }
-          signature = signed_request_signature(params: params, api_secret_key: api_secret_key)
-          params.merge!(signature: signature) if [:trade, :user_data].include?(security_type)
+          if %w(trade user_data).include?(security_type&.to_s)
+            signature = signed_request_signature(params: params, api_secret_key: api_secret_key)
+            params.merge!(signature: signature)
+          end
           # send() is insecure so don't use it.
           case method
           when :get

data/lib/binance/api/trade.rb

@@ -0,0 +1,27 @@
+module Binance
+  module Api
+    class Trade
+      class << self
+        def get_bnb_burn_status!(recvWindow: nil, api_key: nil, api_secret_key: nil)
+          timestamp = Configuration.timestamp
+          params = { recvWindow: recvWindow, timestamp: timestamp }
+          Request.send!(api_key_type: :read_info, path: "/sapi/v1/bnbBurn",
+                        params: params.delete_if { |key, value| value.nil? },
+                        security_type: :user_data, tld: Configuration.tld, api_key: api_key,
+                        api_secret_key: api_secret_key)
+        end
+
+        def toggle_bnb_burn!(spot_bnb_burn: true, interest_bnb_burn: false, recvWindow: nil, api_key: nil,
+                             api_secret_key: nil)
+          timestamp = Configuration.timestamp
+          params = { spotBNBBurn: spot_bnb_burn, interestBNBBurn: interest_bnb_burn,
+                     recvWindow: recvWindow, timestamp: timestamp }
+          Request.send!(api_key_type: :read_info, path: "/sapi/v1/bnbBurn", method: :post,
+                        params: params.delete_if { |key, value| value.nil? },
+                        security_type: :user_data, tld: Configuration.tld, api_key: api_key,
+                        api_secret_key: api_secret_key)
+        end
+      end
+    end
+  end
+end

data/lib/binance/api/{data_stream.rb → user_data_stream.rb}

@@ -1,17 +1,18 @@
 module Binance
   module Api
-    class DataStream
+    class UserDataStream
       class << self
         # It's recommended to send a ping about every 30 minutes.
         def keepalive!(listen_key: nil, api_key: nil, api_secret_key: nil)
           raise Error.new(message: "listen_key is required") if listen_key.nil?
           Request.send!(api_key_type: :none, method: :put, path: "/api/v1/userDataStream",
-                        params: { listenKey: listen_key }, security_type: :user_stream)
+                        params: { listenKey: listen_key }, security_type: :user_stream,
+                        api_key: api_key, api_secret_key: api_secret_key)
         end
 
         def start!(api_key: nil, api_secret_key: nil)
           Request.send!(api_key_type: :none, method: :post, path: "/api/v1/userDataStream",
-                        security_type: :user_stream, api_key: api_key, api_secret_key: api_secret_key)
+                        security_type: :user_stream, api_key: api_key, api_secret_key: api_secret_key)[:listenKey]
         end
 
         def stop!(listen_key: nil, api_key: nil, api_secret_key: nil)

data/lib/binance/api/version.rb

@@ -1,5 +1,5 @@
 module Binance
   module Api
-    VERSION = "1.2"
+    VERSION = "1.2.8"
   end
 end

data/lib/binance/websocket.rb

@@ -1,12 +1,15 @@
 module Binance
   class WebSocket < Faye::WebSocket::Client
-    def initialize
+    class Error < StandardError; end
+
+    def initialize(on_open: nil, on_close: nil)
       super "wss://stream.binance.com:9443/stream", nil, ping: 180
 
       @request_id_inc = 0
+      @user_stream_handlers = {}
 
       on :open do |event|
-        p [:open]
+        on_open&.call(event)
       end
 
       on :message do |event|
@@ -14,7 +17,7 @@ module Binance
       end
 
       on :close do |event|
-        p [:close, event.code, event.reason]
+        on_close&.call(event)
       end
     end
 
@@ -50,6 +53,11 @@ module Binance
       subscribe(symbols_fmt.map { |s| "#{s.downcase}@kline_#{interval}" })
     end
 
+    def user_data_stream!(listen_key, &on_receive)
+      @user_stream_handlers[listen_key] = on_receive
+      subscribe([listen_key])
+    end
+
     private
 
     def process_data(data)
@@ -62,6 +70,11 @@ module Binance
         case json[:data][:e]&.to_sym
         when :kline
           @candlesticks_handler&.call(json[:stream], json[:data])
+        when :outboundAccountPosition
+        when :balanceUpdate
+        when :executionReport # order update
+          listen_key = json[:stream]
+          @user_stream_handlers[listen_key]&.call(listen_key, json[:data])
         end
       end
     end
@@ -78,12 +91,15 @@ module Binance
       }.to_json)
     end
 
-    def unsubscribe(streams)
-      send({
-        method: "UNSUBSCRIBE",
-        params: streams,
-        id: request_id,
-      }.to_json)
-    end
+    # Terminating socket connection achieves the same result.
+    # If you have a use-case for this, please create a GitHub issue.
+    #
+    # def unsubscribe(streams)
+    #   send({
+    #     method: "UNSUBSCRIBE",
+    #     params: streams,
+    #     id: request_id,
+    #   }.to_json)
+    # end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance-ruby
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.2.8
 platform: ruby
 authors:
 - Jake Peterson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 11.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 11.1.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.0
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: awrence
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
 description: Ruby wrapper for the Binance API.
 email:
 - hello@jakenberg.io
@@ -203,7 +203,6 @@ files:
 - lib/binance/api.rb
 - lib/binance/api/account.rb
 - lib/binance/api/configuration.rb
-- lib/binance/api/data_stream.rb
 - lib/binance/api/error.rb
 - lib/binance/api/margin.rb
 - lib/binance/api/margin/account.rb
@@ -211,6 +210,8 @@ files:
 - lib/binance/api/market_stream.rb
 - lib/binance/api/order.rb
 - lib/binance/api/request.rb
+- lib/binance/api/trade.rb
+- lib/binance/api/user_data_stream.rb
 - lib/binance/api/version.rb
 - lib/binance/websocket.rb
 homepage: https://github.com/jakenberg/binance-ruby
@@ -236,5 +237,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: binance-ruby-1.2
+summary: binance-ruby-1.2.8
 test_files: []