From 3f5d24a6c10c3bd66983c1b41bb293c150c12397 Mon Sep 17 00:00:00 2001 From: lash Date: Tue, 8 Aug 2023 09:10:33 +0100 Subject: [PATCH] Update man pages --- CHANGELOG | 2 ++ eth_monitor/cli/rules.py | 2 -- man/eth-monitor.custom.groff | 9 +++++++-- man/eth-monitor.overrides | 1 + setup.cfg | 2 +- 5 files changed, 11 insertions(+), 5 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 83978ac..63c0fc3 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,5 @@ +- 0.8.3 + * Update man pages - 0.8.2 * Handle undefined content-key argument - 0.8.1 diff --git a/eth_monitor/cli/rules.py b/eth_monitor/cli/rules.py index 563f2d8..74232f2 100644 --- a/eth_monitor/cli/rules.py +++ b/eth_monitor/cli/rules.py @@ -14,5 +14,3 @@ rules_data_args = [ def to_config_names(v): v = v.upper() return ('ETHMONITOR_' + v, 'ETHMONITOR_X_' + v) - - diff --git a/man/eth-monitor.custom.groff b/man/eth-monitor.custom.groff index dfffe96..694638d 100644 --- a/man/eth-monitor.custom.groff +++ b/man/eth-monitor.custom.groff @@ -29,14 +29,19 @@ Rendering filters will be executed in order, and the first filter to return \fIF .SH DEFINING FILTERS +Filters will strictly be executed in the order which they are defined on the command line. + A python module used for filter must fulfill two conditions: .IP 1. It must provide a class named \fIFilter\fP in the package base namespace. .IP -2. The \fIFilter\fP class must include a method named \fIfilter\fP with the signature \fIdef filter(self, conn, block, tx, db_session=None)\fP. +2. The \fIFilter\fP class must extend the \fIchainsyncer.filter.SyncFilter\fP interface, and at least override the \fIfilter\fP method. -Filters will strictly be executed in the order which they are defined on the command line. + +.SS SYNCER AND FILTER CONTEXT + +Key-value pairs specified with `--context-key` will be passed to the filter's \fIprepare\fP method, aswell as the \fIctx\fP parameter of the \fIfilter\fP method. .SH FURTHER READING diff --git a/man/eth-monitor.overrides b/man/eth-monitor.overrides index dc6a47b..75a82f4 100644 --- a/man/eth-monitor.overrides +++ b/man/eth-monitor.overrides @@ -13,3 +13,4 @@ storetx Store transaction data in cache for matching transactions. Requires \fB- storeblock Store block data in cache for matching transactions. Requires \fB--cache-dir\fP. --store-block-data renderer Add output renderer filter to all matched transactions. The argument must be a python module path. Several renderers may be added by supplying the option multiple times. See \fBRENDERERS\fP section of \fBeth-monitor (1)\fP for more details. --renderer module filter Add code execution filter to all matched transactions. The argument must be a python module path. Several filters may be added by supplying the option multiple times. Filters will be executed in the order the options are given. See \fBDEFINING FILTERS\fP section of \fBeth-monitor (1)\fP for more details. --filter module +context_key Add a key-value pair that gets passed to the syncer context. May be specified several times. --context-key key=value diff --git a/setup.cfg b/setup.cfg index b64da99..f4bc5a0 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = eth-monitor -version = 0.8.2 +version = 0.8.3 description = Monitor and cache transactions using match filters author = Louis Holbrook author_email = dev@holbrook.no