diff --git a/docs/pages/v2/filters.mdx b/docs/pages/v2/filters.mdx index 06c87152..708e5f55 100644 --- 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 new file mode 100644 index 00000000..c8f715d4 --- /dev/null +++ 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" +```