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.

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

Update udp ports information #478

Merged
merged 6 commits into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 0 additions & 5 deletions docker-compose-auto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,13 @@ services:
ports:
# If port 30333 or 30433 is already occupied by another Substrate-based node, replace all
# occurrences of `30333` or `30433` in this file with another value
- "0.0.0.0:30333:30333/udp"
- "0.0.0.0:30333:30333/tcp"
- "0.0.0.0:30433:30433/udp"
- "0.0.0.0:30433:30433/tcp"
restart: unless-stopped
command: [
"--chain", "gemini-3h",
"--base-path", "/var/subspace",
"--listen-on", "30333",
"--dsn-listen-on", "/ip4/0.0.0.0/udp/30433/quic-v1",
"--dsn-listen-on", "/ip4/0.0.0.0/tcp/30433",
"--rpc-cors", "all",
"--rpc-methods", "unsafe",
Expand Down Expand Up @@ -53,13 +50,11 @@ services:
ports:
# If port 30533 is already occupied by something else, replace all
# occurrences of `30533` in this file with another value
- "0.0.0.0:30533:30533/udp"
- "0.0.0.0:30533:30533/tcp"
restart: unless-stopped
command: [
"farm",
"--node-rpc-url", "ws://node:9944",
"--listen-on", "/ip4/0.0.0.0/udp/30533/quic-v1",
"--listen-on", "/ip4/0.0.0.0/tcp/30533",
# Replace `WALLET_ADDRESS` with your Polkadot.js wallet address
"--reward-address", "WALLET_ADDRESS",
Expand Down
13 changes: 6 additions & 7 deletions docs/farming-&-staking/farming/additional-guides/network-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ keywords:
- Port Forwarding
- Subspace Desktop
- Ports
- QUIC
- Networking
- Network
---
Expand All @@ -34,10 +33,10 @@ Below is a table summarizing the necessary port configurations for uninterrupted

| Port | Protocol | Exposure | Short Description | Used By | Purpose |
|-------|---------------------|---------------------------------------------------------|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| 30333 | TCP/UDP (QUIC) | Always public | Substrate networking P2P | <ul><li>[Space Acres](../../../category/space-acres/)</li><li>[Advanced CLI Node (Consensus)](../../../category/advanced-cli)</li></ul> | Connecting to the rest of the network for exchanging blocks, transactions, PoT gossip, etc. |
| 30433 | TCP/UDP (QUIC) | Always public | Subspace networking P2P | <ul><li>[Space Acres](../../../category/space-acres/)</li><li>[Advanced CLI Node (Consensus)](../../../category/advanced-cli)</li></ul> | Connecting to the rest of the network and retrieving archival history. |
| 30533 | TCP/UDP (QUIC) | Always public | Subspace networking P2P | <ul><li>[Advanced CLI Node (Consensus)](../../../category/advanced-cli)</li></ul> | Connecting to the rest of the network and retrieving archival history, not required for Space Acres because the node and the farmer share the Subspace networking stack there. |
| 40333 | TCP (QUIC) | Always public | Subspace networking P2P | <ul><li>[Advanced CLI Node (Domain)](../../../category/operators-and-nominators)</li></ul> | Connecting to the rest of the domain network for transaction gossipping. |
| 30333 | TCP | Always public | Substrate networking P2P | <ul><li>[Space Acres](../../../category/space-acres/)</li><li>[Advanced CLI Node (Consensus)](../../../category/advanced-cli)</li></ul> | Connecting to the rest of the network for exchanging blocks, transactions, PoT gossip, etc. |
| 30433 | TCP | Always public | Subspace networking P2P | <ul><li>[Space Acres](../../../category/space-acres/)</li><li>[Advanced CLI Node (Consensus)](../../../category/advanced-cli)</li></ul> | Connecting to the rest of the network and retrieving archival history. |
| 30533 | TCP | Always public | Subspace networking P2P | <ul><li>[Advanced CLI Node (Consensus)](../../../category/advanced-cli)</li></ul> | Connecting to the rest of the network and retrieving archival history, not required for Space Acres because the node and the farmer share the Subspace networking stack there. |
| 40333 | TCP | Always public | Subspace networking P2P | <ul><li>[Advanced CLI Node (Domain)](../../../category/operators-and-nominators)</li></ul> | Connecting to the rest of the domain network for transaction gossipping. |
| 9944 | TCP (HTTP/WebSocket)| Public: <ul><li>RPC server</li></ul> Private: <ul><li>Internal node-to-farmer connections</li></ul> | Consensus RPC port | <ul><li>[Advanced CLI Node (Consensus)](../../../category/advanced-cli)</li></ul> | RPC server: Exposes various details about the blockchain (real-time and historical events, storage, transactions, etc) as well as submitting transactions to the network (balance transfers, staking, etc). <br /><br /> Farmer connections: The farmer connects in unsafe mode and receives notifications about slot challenges for block/vote production, archival history extension events, querying of various chain details. Nodes that process farmer connections should never be exposed publicly as public exposure of unsafe APIs can be used to not only prevent farmer from working, but even block node sync completely. |
| 9945 | TCP (HTTP/WebSocket)| Public: <ul><li>RPC server</li></ul> | Domain RPC port | <ul><li>[Advanced CLI Node (Domain)](../../../category/operators-and-nominators)</li></ul> | RPC server: Expose various details about blockchain (real-time and historical events, storage, transactions, etc.) as well as submitting transactions to the network (balance transfers, interacting with smart contracts, etc). |

Expand Down Expand Up @@ -70,9 +69,9 @@ The process varies based on your router. Generally, navigate to Advanced Setting

## Network Configuration Scenarios

- **Router Configuration (Desktop):** Forward the specified TCP and UDP ports to the machine running your node.
- **Router Configuration (Desktop):** Forward the specified TCP ports to the machine running your node.
- **No Firewall Scenario:** No additional configuration needed if operating without a firewall.
- **With Firewall:** Ensure TCP and UDP ports are open in your firewall settings.
- **With Firewall:** Ensure TCP ports are open in your firewall settings.
- **Direct Connection:** No further action if directly connected to the internet.

Proper configuration of these ports ensures reliable and secure communication within the Subspace Network.
2 changes: 1 addition & 1 deletion docs/farming-&-staking/farming/prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ For help refer to our wallets section for [Subwallet & Polkadot.js Wallet](../..

### Networking Information

For comprehensive details on network configurations, port management, firewall settings, and related networking requirements, please consult our dedicated [Networking Guide](../additional-guides/networking). This resource provides in-depth information to ensure seamless integration and optimal security of your network connections.
For comprehensive details on network configurations, port management, firewall settings, and related networking requirements, please consult our dedicated [Networking Guide](../../farming-&-staking/farming/additional-guides/network-info.md). This resource provides in-depth information to ensure seamless integration and optimal security of your network connections.

### Storage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ import DownloadButtons from './platforms/_download.mdx'
3. (Optional) If you want to configure advanced settings, toggle the `Advanced configuration` section. This will allow you to set the following:
- Substrate Node P2P Port
- Subspace DSN P2P Port
- Enable Faster Networking (QUIC)
- Enable Faster Networking

For more information on networking and its implications, refer to our [networking guide.](../additional-guides/networking)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,19 +160,15 @@ services:
ports:
# If port 30333 or 30433 is already occupied by another Substrate-based node, replace all
# occurrences of 30333 or 30433 in this file with another value
- "0.0.0.0:30333:30333/udp"
- "0.0.0.0:30333:30333/tcp"
- "0.0.0.0:30433:30433/udp"
- "0.0.0.0:30433:30433/tcp"
- "0.0.0.0:40333:40333/udp"
- "0.0.0.0:40333:40333/tcp"
restart: unless-stopped
command: [
"run",
"--chain", "gemini-3h",
"--base-path", "/var/subspace",
"--listen-on", "0.0.0.0:30333",
"--dsn-listen-on", "/ip4/0.0.0.0/udp/30433/quic-v1",
"--dsn-listen-on", "/ip4/0.0.0.0/tcp/30433",
# Replace INSERT_YOUR_ID with your node ID (will be shown in telemetry)
"--name", "INSERT_YOUR_ID",
Expand Down
6 changes: 0 additions & 6 deletions docs/farming-&-staking/staking/operators/tips-operator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,19 +183,15 @@ services:
ports:
# If port 30333 or 30433 is already occupied by another Substrate-based node, replace all
# occurrences of 30333 or 30433 in this file with another value
- "0.0.0.0:30333:30333/udp"
- "0.0.0.0:30333:30333/tcp"
- "0.0.0.0:30433:30433/udp"
- "0.0.0.0:30433:30433/tcp"
- "0.0.0.0:40333:40333/udp"
- "0.0.0.0:40333:40333/tcp"
restart: unless-stopped
command: [
"run",
"--chain", "gemini-3h",
"--base-path", "/var/subspace",
"--listen-on", "30333",
"--dsn-listen-on", "/ip4/0.0.0.0/udp/30433/quic-v1",
"--dsn-listen-on", "/ip4/0.0.0.0/tcp/30433",
"--rpc-cors", "all",
"--rpc-methods", "unsafe",
Expand Down Expand Up @@ -234,13 +230,11 @@ services:
ports:
# If port 30533 is already occupied by something else, replace all
# occurrences of 30533 in this file with another value
- "0.0.0.0:30533:30533/udp"
- "0.0.0.0:30533:30533/tcp"
restart: unless-stopped
command: [
"farm",
"--node-rpc-url", "ws://node:9944",
"--listen-on", "/ip4/0.0.0.0/udp/30533/quic-v1",
"--listen-on", "/ip4/0.0.0.0/tcp/30533",
# Replace WALLET_ADDRESS with your Polkadot.js wallet address
"--reward-address", "WALLET_ADDRESS",
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -419,4 +419,4 @@ const config = {
}),
};

module.exports = config;
module.exports = config;
5 changes: 0 additions & 5 deletions src/components/DockerFileGenerator/DockerFileLatest.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,7 @@ services:
volumes:
- ${formData.nodeData ? formData.nodeData : "node-data"}:/var/subspace:rw
ports:
- "0.0.0.0:${formData.nodePort}:30333/udp"
- "0.0.0.0:${formData.nodePort}:30333/tcp"
- "0.0.0.0:${formData.nodeDsnPort}:30433/udp"
- "0.0.0.0:${formData.nodeDsnPort}:30433/tcp"
restart: unless-stopped
command:
Expand All @@ -115,7 +113,6 @@ services:
"--chain", "${network}",
"--base-path", "/var/subspace",
"--listen-on", "/ip4/0.0.0.0/tcp/30333",
"--dsn-listen-on", "/ip4/0.0.0.0/udp/30433/quic-v1",
"--dsn-listen-on", "/ip4/0.0.0.0/tcp/30433",
"--rpc-cors", "all",
"--rpc-methods", "unsafe",
Expand All @@ -136,14 +133,12 @@ services:
volumes:
- ${formData.farmerData ? formData.farmerData : "farmer-data"}:/var/subspace:rw
ports:
- "0.0.0.0:${formData.farmerPort}:30533/udp"
- "0.0.0.0:${formData.farmerPort}:30533/tcp"
restart: unless-stopped
command:
[
"farm",
"--node-rpc-url", "ws://node:9944",
"--listen-on", "/ip4/0.0.0.0/udp/30533/quic-v1",
"--listen-on", "/ip4/0.0.0.0/tcp/30533",
"--reward-address", "${formData.rewardAddress}",
"path=/var/subspace,size=${formData.plotSize}"
Expand Down
5 changes: 0 additions & 5 deletions src/components/DockerFileGenerator/DockerFilePreRelease.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,7 @@ services:
volumes:
- ${formData.nodeData ? formData.nodeData : "node-data"}:/var/subspace:rw
ports:
- "0.0.0.0:${formData.nodePort}:30333/udp"
- "0.0.0.0:${formData.nodePort}:30333/tcp"
- "0.0.0.0:${formData.nodeDsnPort}:30433/udp"
- "0.0.0.0:${formData.nodeDsnPort}:30433/tcp"
restart: unless-stopped
command:
Expand All @@ -115,7 +113,6 @@ services:
"--chain", "${network}",
"--base-path", "/var/subspace",
"--listen-on", "/ip4/0.0.0.0/tcp/30333",
"--dsn-listen-on", "/ip4/0.0.0.0/udp/30433/quic-v1",
"--dsn-listen-on", "/ip4/0.0.0.0/tcp/30433",
"--rpc-cors", "all",
"--rpc-methods", "unsafe",
Expand All @@ -136,14 +133,12 @@ services:
volumes:
- ${formData.farmerData ? formData.farmerData : "farmer-data"}:/var/subspace:rw
ports:
- "0.0.0.0:${formData.farmerPort}:30533/udp"
- "0.0.0.0:${formData.farmerPort}:30533/tcp"
restart: unless-stopped
command:
[
"farm",
"--node-rpc-url", "ws://node:9944",
"--listen-on", "/ip4/0.0.0.0/udp/30533/quic-v1",
"--listen-on", "/ip4/0.0.0.0/tcp/30533",
"--reward-address", "${formData.rewardAddress}",
"path=/var/subspace,size=${formData.plotSize}"
Expand Down
2 changes: 0 additions & 2 deletions src/components/SystemdServiceFileGenerator/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ ExecStart=${formData.nodeBinPath} \\
--chain ${chain} \\
--farmer \\
--listen-on /ip4/0.0.0.0/tcp/${formData.nodePort} \\
--dsn-listen-on /ip4/0.0.0.0/udp/${formData.nodeDsnPort}/quic-v1 \\
--dsn-listen-on /ip4/0.0.0.0/tcp/${formData.nodeDsnPort} ${formData.extraNodeArgs === "" ? "" : "\\\n"}\ ${formData.extraNodeArgs}
KillSignal=SIGINT
Restart=always
Expand Down Expand Up @@ -154,7 +153,6 @@ Group=${formData.user}
ExecStart=${formData.farmerBinPath} \\
farm \\
--reward-address ${formData.rewardAddress} \\
--listen-on /ip4/0.0.0.0/udp/${formData.farmerPort}/quic-v1 \\
--listen-on /ip4/0.0.0.0/tcp/${formData.farmerPort} \\
path=${formData.farmerData},size=${formData.plotSize} ${formData.extraFarmerArgs === "" ? "" : "\\\n"}\ ${formData.extraFarmerArgs}
KillSignal=SIGINT
Expand Down
Loading