Skip to content

Commit

Permalink
Fix: fullnode template ipv4 docs (#20452)
Browse files Browse the repository at this point in the history
## Description 

Fixes the fullnode template: incorrect documentation on how to set ipv4
address.

See reference:
[sui/creates/sui-config/src/node.rs:478](https://github.com/MystenLabs/sui/blob/8bd53998f88c4619f39dcf298f699199a0071e7c/crates/sui-config/src/node.rs#L478)

## Test plan 

How did you test the new or updated feature?

Set the configuration value on a locally running node. Setting to
`/ipv4/...` crashes on boot. Setting to `/ip4/...` continues to boot.

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] REST API:
  • Loading branch information
robmcl4 authored Nov 29, 2024
1 parent 360e9a2 commit 9acc021
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions crates/sui-config/data/fullnode-template-with-path.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Update this value to the location you want Sui to store its database
db-path: "suidb"

# For ipv4, update this to "/ipv4/X.X.X.X/tcp/8080/http"
# For ipv4, update this to "/ip4/X.X.X.X/tcp/8080/http"
network-address: "/dns/localhost/tcp/8080/http"
metrics-address: "0.0.0.0:9184"
# this address is also used for web socket connections
Expand All @@ -27,4 +27,4 @@ network-key-pair:
account-key-pair:
path: "account.key"
worker-key-pair:
path: "worker.key"
path: "worker.key"
2 changes: 1 addition & 1 deletion crates/sui-config/data/fullnode-template.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Update this value to the location you want Sui to store its database
db-path: "/opt/sui/db"

# For ipv4, update this to "/ipv4/X.X.X.X/tcp/8080/http"
# For ipv4, update this to "/ip4/X.X.X.X/tcp/8080/http"
network-address: "/dns/localhost/tcp/8080/http"
metrics-address: "0.0.0.0:9184"
# this address is also used for web socket connections
Expand Down

0 comments on commit 9acc021

Please sign in to comment.