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 configuration documentation and config.toml for fanout #24

Merged
merged 2 commits into from
Feb 12, 2025
Merged

docs: update configuration documentation and config.toml for fanout #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc8a36d
docs: update configuration documentation and config.toml for fanout
lancevincentsalera Feb 12, 2025
b177cb2
Merge branch 'main' into docs/update-config-file-and-documentation-fo…
paulobressan Feb 12, 2025
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
6 changes: 6 additions & 0 deletions docs/app/configuration/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ peers = [
"Node:3001",
"Node:3001",
]
desired_peer_count = 10
peers_per_request = 10

[monitor]
retry_slot_diff = 1000
Expand Down Expand Up @@ -63,8 +65,12 @@ The `peer_manager` section defines the options that the peer manager uses to con
| property | type | example |
| -------------- | ------ | ---------------------------- |
| peers | array | [ "Node:3001", "Node:3001" ] |
| desired_peer_count | number | 10 |
| peers_per_request | number | 10 |

- `peers`: The peers address (`DNS or IP:PORT`) to connect to the Cardano Node and to propagate transactions.
- `desired_peer_count`: The maximum allowable number of peer client connections.
- `peers_per_request`: The maximum number of peers that the peer client will request via peer sharing mini-protocol.

### `monitor` section

Expand Down
5 changes: 4 additions & 1 deletion examples/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,7 @@ cardano-cli
tx.raw
tx.signed

node_modules/

/js/node_modules/

node_modules/
2 changes: 2 additions & 0 deletions examples/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ peers = [
"Node:3001",
"Node:3001",
]
desired_peer_count = 10
peers_per_request = 10

[monitor]
# old tx inflight will be retried when reach a value bigger than retry_slot_diff
Expand Down