huginn_lnd_node_info_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7c3b5b8bc6e490358c405e3044794c0533c685d12fdb566025d82d6daf990b0
+  data.tar.gz: 79d71cdce5c4d77a5023c28c6de380f7190cf597a98be323f524329c7128cd50
+SHA512:
+  metadata.gz: 07060472cf084aea28c7bcd7f7471652f629b0a62c8845d0873359c5b7fc775486149a5504ea6a9d5f6c9abdccaa49f8ebf6d55dadcfdb3355156ab83936bb45
+  data.tar.gz: a18c604f5721fadc34a6bec4085c3d51618c9362045ef442e4d5952e616db6f3858817f7428a843866f94c98154c7fc183353e2d0f7fd0ddedd7abfcfefaf3fa

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2020 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_lnd_node_info_agent/lnd_node_info_agent.rb

@@ -0,0 +1,230 @@
+module Agents
+  class LndNodeInfoAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Github notification agent fetches notifications and creates an event by notification.
+
+      `mark_as_read` is used to post request for mark as read notification.
+
+      `result_limit` is used when you want to limit result per page.
+
+      `real_value` is used for calculating token value with the tokenDecimal applied.
+
+      `debug` is used for verbose mode.
+
+      `with_confirmations` is used to avoid an event as soon as it increases.
+
+      `type` can be tokentx type (you can see api documentation).
+      Get a list of "ERC20 - Token Transfer Events" by Address
+
+      `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
+    end
+
+    event_description <<-MD
+      Events look like this:
+
+        {
+            "version": {
+              "version": "0.11.0-beta commit=",
+              "commit_hash": "",
+              "identity_pubkey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+              "alias": "XXXXXXXXXXX",
+              "color": "XXXXXXX",
+              "num_pending_channels": 0,
+              "num_active_channels": 5,
+              "num_inactive_channels": 0,
+              "num_peers": 5,
+              "block_height": 644844,
+              "block_hash": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+              "best_header_timestamp": "1598100386",
+              "synced_to_chain": true,
+              "synced_to_graph": true,
+              "testnet": false,
+              "chains": [
+                {
+                  "chain": "bitcoin",
+                  "network": "mainnet"
+                }
+              ],
+              "uris": [
+                "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+              ],
+              "features": {
+                "0": {
+                  "name": "data-loss-protect",
+                  "is_required": true,
+                  "is_known": true
+                },
+                "5": {
+                  "name": "upfront-shutdown-script",
+                  "is_required": false,
+                  "is_known": true
+                },
+                "7": {
+                  "name": "gossip-queries",
+                  "is_required": false,
+                  "is_known": true
+                },
+                "9": {
+                  "name": "tlv-onion",
+                  "is_required": false,
+                  "is_known": true
+                },
+                "13": {
+                  "name": "static-remote-key",
+                  "is_required": false,
+                  "is_known": true
+                },
+                "15": {
+                  "name": "payment-addr",
+                  "is_required": false,
+                  "is_known": true
+                },
+                "17": {
+                  "name": "multi-path-payments",
+                  "is_required": false,
+                  "is_known": true
+                }
+              }
+            }
+          }
+    MD
+
+    def default_options
+      {
+        'url' => '',
+        'changes_only' => 'true',
+        'expected_receive_period_in_days' => '2',
+        'debug' => 'false',
+        'macaroon' => '',
+      }
+    end
+
+    form_configurable :url, type: :string
+    form_configurable :changes_only, type: :boolean
+    form_configurable :macaroon, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+
+    def validate_options
+      unless options['url'].present?
+        errors.add(:base, "url 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['macaroon'].present?
+        errors.add(:base, "macaroon is a required field")
+      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
+      fetch
+    end
+
+    private
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "request status : #{code}"
+        log "body"
+        log body
+      end
+
+    end
+
+    def fetch
+      uri = URI.parse("#{interpolated['url']}/v1/getinfo")
+      request = Net::HTTP::Get.new(uri)
+      request["Grpc-Metadata-Macaroon"] = "#{interpolated['macaroon']}"
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+        verify_mode: OpenSSL::SSL::VERIFY_NONE,
+      }
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload_ori = JSON.parse(response.body)
+      payload = payload_ori.dup
+
+      if interpolated['changes_only'] == 'true'
+        if payload != memory['last_status']
+          if "#{memory['last_status']}" == ''
+              create_event payload: payload
+          else
+            last_status = memory['last_status']
+            found = false
+            if payload['num_active_channels'] != last_status['num_active_channels']
+              payload[:num_active_channels_changed] = true
+              found = true
+              if interpolated['debug'] == 'true'
+                log "number of active channels changed"
+              end
+            end
+            if payload['num_inactive_channels'] != last_status['num_inactive_channels']
+              payload[:num_inactive_channels_changed] = true
+              found = true
+              if interpolated['debug'] == 'true'
+                log "number of inactive channels changed"
+              end
+            end
+            if payload['version'] != last_status['version']
+              payload[:version_changed] = true
+              found = true
+              if interpolated['debug'] == 'true'
+                log "version changed"
+              end
+            end
+            if payload['identity_pubkey'] != last_status['identity_pubkey']
+              payload[:identity_pubkey_changed] = true
+              if interpolated['debug'] == 'true'
+                log "identity pubkey changed"
+              end
+              found = true
+            end
+            if found == true
+                create_event payload: payload
+            end
+          end
+          memory['last_status'] = payload_ori
+        else
+          log "no diff"
+        end
+      else
+        create_event payload: payload
+        if payload != memory['last_status']
+          memory['last_status'] = payload_ori
+        end
+      end
+    end
+  end
+end

data/lib/huginn_lnd_node_info_agent.rb

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

data/spec/lnd_node_info_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::LndNodeInfoAgent do
+  before(:each) do
+    @valid_options = Agents::LndNodeInfoAgent.new.default_options
+    @checker = Agents::LndNodeInfoAgent.new(:name => "LndNodeInfoAgent", :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_lnd_node_info_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-12-08 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_lnd_node_info_agent.rb
+- lib/huginn_lnd_node_info_agent/lnd_node_info_agent.rb
+- spec/lnd_node_info_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_lnd_node_info_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/lnd_node_info_agent_spec.rb