feat: update the docs for the mapper config for the cbor change (#137)

txpipe · Feb 7, 2022 · 6d8636d · 6d8636d
1 parent 35f8ebd
commit 6d8636d
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/book/src/sources/n2c.md b/book/src/sources/n2c.md
@@ -14,7 +14,10 @@ magic = <network magic>
 since = [<slot>, "<block hash>"]
 
 [source.mapper]
+include_block_end_events = <bool>
 include_transaction_details = <bool>
+include_transaction_end_events = <bool>
+include_block_cbor = <bool>
 ```
 
 ### Section `source`:
@@ -28,7 +31,12 @@ include_transaction_details = <bool>
 
 This section provides options to tweak the behaviour of how raw chain data is mapped into _Oura_ events.
 
+- `include_block_end_events`: instructs the mapper to include an event for when the mapper
+  finishes crawling a block record.
 - `include_transaction_details`: instructs the mapper to include all details in the transaction event payload (inputs, outputs, metadata, mint, etc)
+- `include_transaction_end_events`: instructs the mapper to include an event for when the mapper
+  finishes crawling a transaction record.
+- `include_block_cbor`: instructs the mapper to include the hex of the cbor in the block record.
 
 ## Examples
 
@@ -71,4 +79,5 @@ magic = "mainnet"
 
 [source.mapper]
 include_transaction_details = true
+include_block_cbor = true
 ```
diff --git a/book/src/sources/n2n.md b/book/src/sources/n2n.md
@@ -13,7 +13,10 @@ magic = <network magic>
 since = [<slot>, "<block hash>"]
 
 [source.mapper]
+include_block_end_events = <bool>
 include_transaction_details = <bool>
+include_transaction_end_events = <bool>
+include_block_cbor = <bool>
 ```
 
 ### Section `source`:
@@ -27,7 +30,12 @@ include_transaction_details = <bool>
 
 This section provides options to tweak the behaviour of how raw chain data is mapped into _Oura_ events.
 
+- `include_block_end_events`: instructs the mapper to include an event for when the mapper
+  finishes crawling a block record.
 - `include_transaction_details`: instructs the mapper to include all details in the transaction event payload (inputs, outputs, metadata, mint, etc)
+- `include_transaction_end_events`: instructs the mapper to include an event for when the mapper
+  finishes crawling a transaction record.
+- `include_block_cbor`: instructs the mapper to include the hex of the cbor in the block record.
 
 ## Examples
 
@@ -70,4 +78,5 @@ magic = "mainnet"
 
 [source.mapper]
 include_transaction_details = true
+include_block_cbor = true
 ```