binance-connector-ruby 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b029d14cae7ec52f77a9f61775eba15eb33027f47983f2184e49731c5de746a
-  data.tar.gz: 5ecb20e8b7544668b2e4306a5f70548b9e3ce92696f9111b4e4ba4f88b7e4fa4
+  metadata.gz: 79de67acd5f3ce04c90bd7af5a1219d351f2475da326c52dd15d31de87a5fc59
+  data.tar.gz: a6c937781d4becf1574fa0ae75159ef4183c5305ed71886b2a35a46d6f96726e
 SHA512:
-  metadata.gz: 1b779f8bf2a01f165f68748c37385d3a4bf79e9e887a82f5d23c08b111b697cb2280c60c9cfe4609b5c061218f008c4b58dd81e7457e26a7f76dfbafc7f1226e
-  data.tar.gz: 25e0a750c7db5fb5dd26889548d26aa3a3c1e96b0a13ab21898623a79c69393f1df025a4f7b0c3ea6d6ad893d197544d3e24145be6b0a1e335af28dd42a9d19b
+  metadata.gz: 3fe1f8765880b0fb14c08333affda07065579f272b4250b2276544a93e4e4e64cbcdcad5b818903c6ed26b8e1ae932b273c832c337ef6fd45cc26b8a6935b23f
+  data.tar.gz: '085799a56d01d5568f0a4cc98c709d98cba18b70d4011e512fd1e4460c52b2b408344fc5c5e54f4e11e152ff1d99ca73d80f327d5c2e25f6a236e9aacd68f37f'

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 1.4.0 - 2022-12-20
+### Added
+- Add RSA signature
+- Support Ruby 3.1
+
+### Changed
+- Drop support of Ruby 2.5
+
+
+## 1.3.0 - 2022-07-21
+
+### Add
+- New endpoint for Margin:
+  - `POST /sapi/v3/asset/getUserAsset` to get user assets.
+- New endpoint for Wallet:
+  - `GET /sapi/v1/margin/dribblet` to query the historical information of user's margin account small-value asset conversion BNB.
+
+
 ## 1.2.0 - 2022-07-15
 
 ### Add

data/README.md

@@ -86,6 +86,10 @@ It's recommended to pass in the `base_url` parameter, even in production as Bina
 - `https://api2.binance.com`
 - `https://api3.binance.com`
 
+### RSA Signature
+
+Binance support both HMAC and RSA signature. Please find the example at `examples/trade/account.rb` for how to sign in both solutions.
+
 ### RecvWindow
 
 From Binance API, recvWindow is available for all endpoints require signature. By default, it's 5000ms.

data/lib/binance/authentication.rb

@@ -1,13 +1,33 @@
 # frozen_string_literal: true
 
+require 'openssl'
+require 'base64'
+
 module Binance
   # Authentication response to API key and signature
   class Authentication
-    attr_accessor :key, :secret
+    attr_accessor :key, :secret, :private_key, :private_key_pass_phrase
 
-    def initialize(key, secret)
+    def initialize(key, secret, private_key = nil, private_key_pass_phrase = nil)
       @key = key
       @secret = secret
+      @private_key = private_key
+      @private_key_pass_phrase = private_key_pass_phrase
+    end
+
+    def provide_private_key?
+      private_key
+    end
+
+    def hmac_sign(data)
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new('sha256'), secret, data
+      )
+    end
+
+    def rsa_sign(data)
+      pkey = OpenSSL::PKey::RSA.new(private_key, private_key_pass_phrase)
+      Base64.encode64(pkey.sign('SHA256', data))
     end
   end
 end

data/lib/binance/session.rb

@@ -11,7 +11,7 @@ module Binance
 
     def initialize(options = {})
       @base_url = options[:base_url] || 'https://api.binance.com'
-      @auth = Authentication.new(options[:key], options[:secret])
+      @auth = Authentication.new(options[:key], options[:secret], options[:private_key], options[:private_key_pass_phrase])
       @logger = options[:logger]
       @show_weight_usage = options[:show_weight_usage] || false
       @show_header = options[:show_header] || false
@@ -78,7 +78,8 @@ module Binance
       build_connection do |conn|
         conn.headers['X-MBX-APIKEY'] = @auth.key
         conn.use Timestamp
-        conn.use Signature, @auth.secret
+        conn.use RSASignature, @auth if @auth.provide_private_key?
+        conn.use HMACSignature, @auth unless @auth.provide_private_key?
       end
     end
 

data/lib/binance/spot/margin.rb

@@ -725,6 +725,19 @@ module Binance
       def get_margin_order_usage(**kwargs)
         @session.sign_request(:get, '/sapi/v1/margin/rateLimit/order', params: kwargs)
       end
+
+      # Margin Dustlog (USER_DATA)
+      #
+      # GET /sapi/v1/margin/dribblet
+      #
+      # @param kwargs [Hash]
+      # @option kwargs [String] :startTime
+      # @option kwargs [String] :endTime
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#margin-dustlog-user_data
+      def get_margin_dust_log(**kwargs)
+        @session.sign_request(:get, '/sapi/v1/margin/dribblet', params: kwargs)
+      end
     end
   end
 end

data/lib/binance/spot/wallet.rb

@@ -311,6 +311,19 @@ module Binance
       def api_key_permission(**kwargs)
         @session.sign_request(:get, '/sapi/v1/account/apiRestrictions', params: kwargs)
       end
+
+      # User Asset (USER_DATA)
+      #
+      # POST /sapi/v3/asset/getUserAsset
+      #
+      # @param kwargs [Hash]
+      # @option kwargs [String] :asset If asset is blank, then query all positive assets user have.
+      # @option kwargs [Boolean] :needBtcValuation
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#user-asset-user_data
+      def get_user_asset(**kwargs)
+        @session.sign_request(:post, '/sapi/v3/asset/getUserAsset', params: kwargs)
+      end
     end
   end
 end

data/lib/binance/utils/faraday/middleware/{signature.rb → hmac_signature.rb}

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
 require 'openssl'
+require 'base64'
 
 module Binance
   module Utils
     module Faraday
       module Middleware
-        Signature = Struct.new(:app, :secret) do
+        HMACSignature = Struct.new(:app, :auth) do
           def call(env)
-            hash = OpenSSL::HMAC.hexdigest(
-              OpenSSL::Digest.new('sha256'), secret, env.url.query
-            )
-            env.url.query = Url.add_param(env.url.query, 'signature', hash)
+            env.url.query = Url.add_param(env.url.query, 'signature', auth.hmac_sign(env.url.query))
             app.call env
           end
         end

data/lib/binance/utils/faraday/middleware/rsa_signature.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'base64'
+
+module Binance
+  module Utils
+    module Faraday
+      module Middleware
+        RSASignature = Struct.new(:app, :auth) do
+          def call(env)
+            env.url.query = Url.add_param(env.url.query, 'signature', auth.rsa_sign(env.url.query))
+            app.call env
+          end
+        end
+      end
+    end
+  end
+end

data/lib/binance/utils/faraday/middleware.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 require_relative './middleware/timestamp'
-require_relative './middleware/signature'
+require_relative './middleware/rsa_signature'
+require_relative './middleware/hmac_signature'

data/lib/binance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Binance
-  VERSION = '1.2.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance-connector-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Binance
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 description: ''
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -127,7 +127,8 @@ files:
 - lib/binance/spot/websocket.rb
 - lib/binance/utils/faraday/custom_params_encoder.rb
 - lib/binance/utils/faraday/middleware.rb
-- lib/binance/utils/faraday/middleware/signature.rb
+- lib/binance/utils/faraday/middleware/hmac_signature.rb
+- lib/binance/utils/faraday/middleware/rsa_signature.rb
 - lib/binance/utils/faraday/middleware/timestamp.rb
 - lib/binance/utils/url.rb
 - lib/binance/utils/validation.rb
@@ -138,7 +139,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -153,8 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.3.3
+signing_key: 
 specification_version: 4
 summary: This is a lightweight library that works as a connector to the Binance public
   API.