lnd-tool 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6d5e1b2aa6a45fc2bc9f9e1fc3d3b5ac739c8deb0708a03beb95d372b0d8ba9
-  data.tar.gz: cc803a39f5a7f95a98ba3b4dfd6a24fa79e863f1b6b74ddcd22dfa8134d74cb1
+  metadata.gz: 50c44439e83989cc928244de008729fdfcd9e7f22c09fb2ea26f67f3016cd187
+  data.tar.gz: b7e009f8bad91d4c6206a1616c8413640a004df2e13d314f40b2eda688bd9e70
 SHA512:
-  metadata.gz: 381b5cdf5cc19157ab025feb2f2a4ec7c40ac5ca3b1af1c38e2786a470d52eadfe2f370cd707b826d0084e34061be18cdf3968936f51fbfa51760f56fbfa122d
-  data.tar.gz: 450bfd39f6963e3c49ea70420fafb48d9acea6b392b4b180a16ed510b573c22493f0b080cc043975a6add3b32f460f9b5dd3e4723767598fd7856742856e75a4
+  metadata.gz: 6c8e2f7557ec6b2cb8dba8582bca88b2e4c122661f7447317dafd0bb70bd08f1ae9bb6ccb84bd633863ded21315f2ecfe376e979579098f0b33286fcd6d71c5d
+  data.tar.gz: 661dc0b47f6af4dc79481fae7f1b7cc4af0efccab93521718cceb595f63cf5dd7bfd00c5b75ed6d5af495edf2e56f953c69b96b0347d38569e0cd6bc6a661ef9

data/README.md

@@ -1,4 +1,4 @@
-# LND::Tool [![Build Status](https://github.com/azuchi/lnd-tool/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/azuchi/lnd-tool/actions/workflows/main.yml) [![Gem Version](https://badge.fury.io/rb/lnd-tool.svg)](https://badge.fury.io/rb/lnd-tool) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+# LND::Tool [![Build Status](https://github.com/azuchi/lnd-tool/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/azuchi/lnd-tool/actions/workflows/main.yml) [![Gem Version](https://badge.fury.io/rb/lnd-tool.svg)](https://badge.fury.io/rb/lnd-tool) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE.txt)
 
 This is a tool for LND written in Ruby. Subscribe to htlc events in LND and save their contents to SQLite3.
 
@@ -83,4 +83,15 @@ Since it is a search to the database, it can be run even if the capture process
 The `query_htlc` command has the following options.
 
 * `event`: Option to specify the event type(`send`, `receive`, `forward`). e.g. `$ lnd-tool query_htlc --event=forward`
-* `limit`: Option to narrows down the number of data. e.g. `$lnd-tool query_htlc --limit=30`
+* `limit`: Option to narrows down the number of data. e.g. `$lnd-tool query_htlc --limit=30`
+
+### Prune HTLC events
+
+When the capture is running, the HTLC event is stored in the DB and the size of the DB grows.
+Since v0.3.0, the `prune_htlc` command to prune(delete) DB records has been added.
+
+The `prune_htlc` command should be executed with one of the following options:
+
+* `max`: This is the maximum number of events to be retained in the DB. 
+Data exceeding this number will be pruned from the oldest data. (e.g.`$lnd-tool prune_htlc --max 10000`)
+* `date`: Delete data prior to this date. (e.g.`$lnd-tool prune_htlc --date 2021-11-24`)

data/exe/lnd-tool

@@ -83,6 +83,26 @@ class CLI < Thor
     puts table
   end
 
+  desc 'prune_htlc', 'Pruning the data for the HTLC event in DB. Run with either the max option or the date option.'
+  option :max, type: :numeric, desc:
+    'This is the maximum number of data to be kept. Data exceeding this limit will be deleted in order of oldest to newest.'
+  option :date, type: :string, desc: 'Date in 2021-09-04 format. Delete data prior to this date.'
+  def prune_htlc
+    begin
+      store = LND::Tool::Store::HTLCEvent.new
+      if options['max']
+        store.prune_up_to(options['max'])
+      elsif options['date']
+        time = Date.parse(options['date']).to_time
+        store.prune_prior_to(time)
+      else
+        raise Thor::Error, 'Either the max or date option should be specified.'
+      end
+      puts "The current number of data is #{store.count}."
+    rescue Date::Error
+      raise Thor::Error, 'The format of the date option is invalid.'
+    end
+  end
 end
 
 CLI.start(ARGV)

data/lib/lnd/tool/store/htlc_event.rb

@@ -80,6 +80,31 @@ module LND
           convert(db.query(query, bind))
         end
 
+        # Get record count.
+        # @return [Integer] record count.
+        def count
+          db.get_first_value('SELECT count(*) FROM HtlcEvent').to_i
+        end
+
+        # Pruning record up to +max+.
+        # @param [Integer] max Maximum number of records for this entity.
+        # @return [Integer] pruning count
+        def prune_up_to(max)
+          pruning_count = count - max
+          return 0 if pruning_count <= 0
+
+          query = 'DELETE FROM HtlcEvent ORDER BY created_datetime ASC LIMIT ?'
+          db.execute(query, [pruning_count])
+          pruning_count
+        end
+
+        # Pruning record prior to +Time+.
+        # @param [Time] time
+        def prune_prior_to(time)
+          query = 'DELETE FROM HtlcEvent WHERE timestamp_ns < ?'
+          db.execute(query, [time.to_i * 1_000_000_000])
+        end
+
         private
 
         def convert(recode_sets)

data/lib/lnd/tool/version.rb

@@ -2,6 +2,6 @@
 
 module LND
   module Tool
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lnd-tool
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2021-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lnrpc