Skip to content

Commit

Permalink
chore: clarify connection_opts are not required.
Browse files Browse the repository at this point in the history 
Also add `private_neighbors`.
  • Loading branch information
@diwakergupta @wileyj
diwakergupta authored and wileyj committed Sep 20, 2024
1 parent 33af210 commit 281bec5
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions reference/stacks-node-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,20 +73,19 @@ Contains options for sending events emitted to the [stacks-blockchain-api](https

{% hint style="info" %}
This section is _optional_ and not required.

However, if this section is added, **all** fields are required
{% endhint %}

Specifies configuration options for others connecting to the stacks node.

| Name | Required | Description |
| ------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| public\_ip\_address | ✓ | Public IPv4 to advertise to other nodes |
| download\_interval | ✓ | Time (in seconds) between attempts to download blocks |
| walk\_interval | ✓ | Time (in seconds) between attempts to walk the list of neighbors |
| read\_only\_call\_limit\_read\_length | ✓ | Total number of bytes allowed to be read by an individual read-only function call |
| read\_only\_call\_limit\_read\_count | ✓ | Total number of independent read operations permitted for an individual read-only function call |
| read\_only\_call\_limit\_runtime | ✓ | [Runtime cost](https://github.com/stacksgov/sips/blob/main/sips/sip-006/sip-006-runtime-cost-assessment.md) limit for an individual read-only function call |
| public\_ip\_address | | Public IPv4 to advertise to other nodes |
| download\_interval | | Time (in seconds) between attempts to download blocks |
| walk\_interval | | Time (in seconds) between attempts to walk the list of neighbors |
| private\_neighbors | | If false, this node won't announce or accept neighbors that are behind private networks. Defaults to true. |
| read\_only\_call\_limit\_read\_length | | Total number of bytes allowed to be read by an individual read-only function call |
| read\_only\_call\_limit\_read\_count | | Total number of independent read operations permitted for an individual read-only function call |
| read\_only\_call\_limit\_runtime | | [Runtime cost](https://github.com/stacksgov/sips/blob/main/sips/sip-006/sip-006-runtime-cost-assessment.md) limit for an individual read-only function call |

#### burnchain

Expand Down

0 comments on commit 281bec5

Please sign in to comment.