huginn_bybit_agent 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7360ce7d5fecdfe21e247f68024b0318287b48d78dab1dda7d6bc931e45c456
+  data.tar.gz: 20077cb7a7c0cc765109cad94c232573ed7f5a35054e3ee3f9e9adc801a222eb
+SHA512:
+  metadata.gz: ddac1285c25e75dee7b67db9d3086edcd495bdf8bc0e9bcf3015a85b31cf3a7bd2360b639b8e59a9559a4ad67b6300b0784c3c18d728a66da901d374e44b83ba
+  data.tar.gz: da1f959963c9649645357fc29b251790510d369205c9c0bb9889a34a49de7925c7c692d281392e43cd412f93ba00cc1688716cd2ad6c0817036e75862a3bac99

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2023 Nicolas Germain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/huginn_bybit_agent/bybit_agent.rb

@@ -0,0 +1,362 @@
+module Agents
+  class BybitAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description <<-MD
+      The Bybit Agent interacts with the Bybit API and can create events / tasks if wanted / needed.
+
+      The `type` can be like checking the wallet's balance, alerts.
+
+      `apikey` is needed for auth endpoint.
+
+      `secretkey` is needed for auth endpoint.
+
+      `windows` to specify how long an HTTP request is valid.
+
+      `limit` to timit for data size.
+
+      `debug` is for adding verbosity.
+
+      `expected_receive_period_in_days` is used to determine if the Agent is working. Set it to the maximum number of days
+      that you anticipate passing without this Agent receiving an incoming Event.
+    MD
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "retCode": 0,
+            "retMsg": "OK",
+            "result": {
+              "balances": [
+                {
+                  "coin": "ADA",
+                  "coinId": "ADA",
+                  "total": "500000000000",
+                  "free": "500000000000",
+                  "locked": "0"
+                }
+              ]
+            },
+            "retExtInfo": {},
+            "time": 1676117370511
+          }
+    MD
+
+    def default_options
+      {
+        'type' => '',
+        'apikey' => '',
+        'windows' => '5000',
+        'limit' => '10',
+        'secretkey' => '',
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+        'changes_only' => 'true'
+      }
+    end
+
+    form_configurable :debug, type: :boolean
+    form_configurable :apikey, type: :string
+    form_configurable :secretkey, type: :string
+    form_configurable :limit, type: :string
+    form_configurable :windows, type: :string
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :changes_only, type: :boolean
+    form_configurable :type, type: :array, values: ['get_balances', 'order_history', 'trade_history']
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'get_balances' 'order_history' 'trade_history'") if interpolated['type'].present? && !%w(get_balances order_history trade_history).include?(interpolated['type'])
+
+      unless options['apikey'].present? || !['get_balances', 'order_history', 'trade_history'].include?(options['type'])
+        errors.add(:base, "apikey is a required field")
+      end
+
+      unless options['secretkey'].present? || !['get_balances', 'order_history', 'trade_history'].include?(options['type'])
+        errors.add(:base, "secretkey is a required field")
+      end
+
+      unless options['limit'].present? || !['order_history', 'trade_history'].include?(options['type'])
+        errors.add(:base, "limit is a required field")
+      end
+
+      if options.has_key?('changes_only') && boolify(options['changes_only']).nil?
+        errors.add(:base, "if provided, changes_only must be true or false")
+      end
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      end
+
+      unless options['expected_receive_period_in_days'].present? && options['expected_receive_period_in_days'].to_i > 0
+        errors.add(:base, "Please provide 'expected_receive_period_in_days' to indicate how many days can pass before this Agent is considered to be not working")
+      end
+    end
+
+    def working?
+      event_created_within?(options['expected_receive_period_in_days']) && !recent_error_logs?
+    end
+
+    def check
+      trigger_action
+    end
+
+    private
+
+
+    def new_nonce
+      (Time.now.to_f * 1000000).floor.to_s
+    end
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def genSignature(payload,time_stamp)
+        param_str = time_stamp + interpolated['apikey'] + interpolated['windows'] + payload
+      if interpolated['debug'] == 'true'
+        log "param_str"
+        log param_str
+      end
+        OpenSSL::HMAC.hexdigest('sha256', interpolated['secretkey'], param_str)
+    end
+
+    def trade_history(base_url)
+
+      time_stamp = DateTime.now.strftime('%Q')
+      endPoint = "/spot/v3/private/my-trades"
+      tradeLinkId = SecureRandom.uuid
+      payload = "tradeLinkId=" + tradeLinkId + '&limit' + interpolated['limit']
+      signature = genSignature(payload,time_stamp)
+      payload="?"+payload
+
+      if interpolated['debug'] == 'true'
+        log "signature"
+        log signature
+      end
+      fullUrl = base_url + endPoint + payload
+      uri = URI.parse(fullUrl)
+      request = Net::HTTP::Get.new(uri)
+      request["X-BAPI-SIGN"] = signature
+      request["X-BAPI-API-KEY"] = interpolated['apikey']
+      request["X-BAPI-TIMESTAMP"] = time_stamp
+      request["X-BAPI-RECV-WINDOW"] = interpolated['windows']
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+      if interpolated['changes_only'] == 'true'
+        if payload.to_s != memory['last_status']
+          if "#{memory['last_status']}" == ''
+            payload['result']['list'].each do | trade |
+              create_event :payload => trade
+            end
+          else
+            last_status = memory['last_status'].gsub("=>", ": ").gsub(": nil,", ": null,")
+            last_status = JSON.parse(last_status)
+            payload['result']['list'].each do | trade |
+              found = false
+              last_status['result']['list'].each do | tradebis |
+                if trade == tradebis
+                  found = true
+                end
+              end
+              if interpolated['debug'] == 'true'
+                log found
+              end
+              if found == false
+                create_event :payload => trade
+              end
+            end
+          end
+          memory['last_status'] = payload.to_s
+        end
+      else
+        create_event payload: payload
+        if payload.to_s != memory['last_status']
+          memory['last_status'] = payload.to_s
+        end
+      end
+    end
+
+    def order_history(base_url)
+
+      time_stamp = DateTime.now.strftime('%Q')
+      endPoint = "/v5/order/history"
+      orderLinkId = SecureRandom.uuid
+      payload = "orderLinkId=" + orderLinkId + '&limit' + interpolated['limit'] + '&category=spot'
+      signature = genSignature(payload,time_stamp)
+      payload="?"+payload
+    
+      if interpolated['debug'] == 'true'
+        log "signature"
+        log signature
+      end
+      fullUrl = base_url + endPoint + payload
+      uri = URI.parse(fullUrl)
+      request = Net::HTTP::Get.new(uri)
+      request["X-BAPI-SIGN"] = signature
+      request["X-BAPI-API-KEY"] = interpolated['apikey']
+      request["X-BAPI-TIMESTAMP"] = time_stamp
+      request["X-BAPI-RECV-WINDOW"] = interpolated['windows']
+    
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+      if interpolated['changes_only'] == 'true'
+        if payload != memory['last_status']
+          payload['result']['list'].each do | order |
+            found = false
+            if interpolated['debug'] == 'true'
+              log "order"
+              log order
+            end
+            if !memory['last_status'].nil? and memory['last_status'].present?
+              if interpolated['debug'] == 'true'
+                log "memory"
+                log memory['last_status']
+              end
+              last_status = memory['last_status']
+              last_status['result']['list'].each do |orderbis|
+                if order['id'] == orderbis['id']
+                  found = true
+                end
+                if interpolated['debug'] == 'true'
+                  log "orderbis"
+                  log orderbis
+                  log "found is #{found}!"
+                end
+              end
+            end
+            if found == false
+              create_event payload: order
+            end
+          end
+        else
+          if interpolated['debug'] == 'true'
+            log "nothing to compare"
+          end
+        end
+      else
+        create_event payload: payload
+        if payload != memory['last_status']
+        end
+      end
+      memory['last_status'] = payload
+    end
+
+    def get_balances(base_url)
+
+      time_stamp = DateTime.now.strftime('%Q')
+      endPoint = "/v5/account/wallet-balance"
+      orderLinkId = SecureRandom.uuid
+      payload = "accountType=UNIFIED" 
+      signature = genSignature(payload,time_stamp)
+      payload="?"+payload
+    
+      if interpolated['debug'] == 'true'
+        log "signature"
+        log signature
+      end
+      fullUrl = base_url + endPoint + payload
+      uri = URI.parse(fullUrl)
+      request = Net::HTTP::Get.new(uri)
+      request["X-BAPI-SIGN"] = signature
+      request["X-BAPI-API-KEY"] = interpolated['apikey']
+      request["X-BAPI-TIMESTAMP"] = time_stamp 
+      request["X-BAPI-RECV-WINDOW"] = interpolated['windows']
+    
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+      if interpolated['changes_only'] == 'true'
+        if payload != memory['last_status']
+          payload['result']['list'][0]['coin'].each do | coin |
+            found = false
+            if interpolated['debug'] == 'true'
+              log "coin"
+              log coin
+            end
+            if !memory['last_status'].nil? and memory['last_status'].present?
+              if interpolated['debug'] == 'true'
+                log "memory"
+                log memory['last_status']
+              end
+              last_status = memory['last_status']
+              last_status['result']['list'][0]['coin'].each do |coinbis|
+                if coin['id'] == coinbis['id']
+                  found = true
+                end
+                if interpolated['debug'] == 'true'
+                  log "coinbis"
+                  log coinbis
+                  log "found is #{found}!"
+                end
+              end
+            end
+            if found == false
+              create_event payload: coin
+            end
+          end
+        else
+          if interpolated['debug'] == 'true'
+            log "nothing to compare"
+          end
+        end
+      else
+        create_event payload: payload
+        if payload != memory['last_status']
+        end
+      end
+      memory['last_status'] = payload
+    end
+
+    def trigger_action()
+
+      base_url = 'https://api.bybit.com'
+      case interpolated['type']
+      when "get_balances"
+        get_balances(base_url)
+      when "order_history"
+        order_history(base_url)
+      when "trade_history"
+        trade_history(base_url)
+      else
+        log "Error: type has an invalid value (#{type})"
+      end
+    end
+  end
+end

data/lib/huginn_bybit_agent.rb

@@ -0,0 +1,4 @@
+require 'huginn_agent'
+
+#HuginnAgent.load 'huginn_bybit_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_bybit_agent/bybit_agent'

data/spec/bybit_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::BybitAgent do
+  before(:each) do
+    @valid_options = Agents::BybitAgent.new.default_options
+    @checker = Agents::BybitAgent.new(:name => "BybitAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  pending "add specs here"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_bybit_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.11
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description or delete this line.
+email:
+- ngermain@hihouhou.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_bybit_agent.rb
+- lib/huginn_bybit_agent/bybit_agent.rb
+- spec/bybit_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_bybit_agent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/bybit_agent_spec.rb