Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update Mapper to include cbor #137

Merged
merged 1 commit into from
Feb 7, 2022
Merged

Docs: Update Mapper to include cbor #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions book/src/sources/n2c.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand All @@ -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

Expand Down Expand Up @@ -71,4 +79,5 @@ magic = "mainnet"

[source.mapper]
include_transaction_details = true
include_block_cbor = true
```
9 changes: 9 additions & 0 deletions book/src/sources/n2n.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand All @@ -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

Expand Down Expand Up @@ -70,4 +78,5 @@ magic = "mainnet"

[source.mapper]
include_transaction_details = true
include_block_cbor = true
```