docs(filters): added split_block

txpipe · Aug 9, 2023 · 7415731 · 7415731
1 parent d1660ea
commit 7415731
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/pages/v2/filters.mdx b/docs/pages/v2/filters.mdx
@@ -7,6 +7,7 @@ _Filters_ are intermediate steps in the pipeline that process events as they tra
 These are the existing filters that are included as part the main _Oura_ codebase:
 
 - [ParseCbor](filters/parse_cbor.mdx): a filter that maps cbor transactions to a data structure.
+- [SplitBlock](filters/split_block.mdx): a filter that will decode the cbor block and extract all transactions in an event in the format CborTx.
 
 ### Legacy V1
 - [Fingerprint](filters/fingerprint.mdx): a filter that adds a (probably) unique identifier (fingerprint) to each event.

diff --git a/docs/pages/v2/filters/split_block.mdx b/docs/pages/v2/filters/split_block.mdx
@@ -0,0 +1,14 @@
+# Split CBOR Block filter
+
+The `split_block` filter will decode the Cbor block and map each transaction within the block to the CborTx format.
+
+Therefore the next stage will receive each transaction that was in the block as an event in the pipeline, i.e. if the block contains 5 transactions the next stage will receive 5 events with each transaction, in CborTx format.
+
+## Configuration
+
+Adding the following section to the daemon config file will enable the filter as part of the pipeline:
+
+```toml
+[[filters]]
+type = "SplitBlock"
+```