diff --git a/README.md b/README.md index 97eda75..1535116 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ A DAppNode package for running [Pathfinder](https://github.com/eqlabs/pathfinder - **JSON-RPC API**: Access StarkNet through standard JSON-RPC endpoints - **WebSocket Support**: Real-time data access via WebSocket connections - **Easy Configuration**: Simple setup wizard for network configuration -- **Grafana Dashboard**: Built-in monitoring dashboard for node metrics - **Multi-Architecture**: Supports both AMD64 and ARM64 architectures ## 📋 Prerequisites @@ -51,11 +50,11 @@ During installation, you'll need to configure: ## 🌐 Network Variants This package supports multiple StarkNet networks: + | Network | Package | RPC Port | Monitor Port | RPC Endpoint | WebSocket Endpoint | |-----------|-------------------------------------|----------|--------------|---------------------------------------------|-----------------------------------------------------| -| **Mainnet** | `pathfinder.dnp.dappnode.eth` | 9545 | 9547 | http://pathfinder.dappnode:9545/ | ws://pathfinder.dappnode:9546/ws | -| **Sepolia** | `pathfinder-sepolia.dappnode.eth` | 9555 | 9557 | http://pathfinder-sepolia.dappnode:9555/ | ws://pathfinder-sepolia.dappnode:9556/ws | - +| **Mainnet** | `pathfinder.dnp.dappnode.eth` | 6060 | 9547 | | ws://pathfinder.dappnode:6061/ | +| **Sepolia** | `pathfinder-sepolia.dappnode.eth` | 6060 | 9547 | | ws://pathfinder-sepolia.dappnode:6061/ | > **Note**: The Monitor port is used for metrics and health check endpoints for monitoring and observability. @@ -70,33 +69,20 @@ The Pathfinder node exposes a StarkNet JSON-RPC API compatible with the official curl -X POST \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","method":"starknet_blockNumber","params":[],"id":1}' \ - http://pathfinder.dappnode:9545/ + http://pathfinder.dappnode:6060/ # Sepolia - Get chain ID curl -X POST \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","method":"starknet_chainId","params":[],"id":1}' \ - http://pathfinder-sepolia.dappnode:9555/ + http://pathfinder-sepolia.dappnode:6060/ ``` -## 📊 Monitoring - -The package includes a Grafana dashboard for monitoring: - -- Node synchronization status -- Block height and sync progress -- RPC call metrics -- Resource usage (CPU, memory, disk) -- Network connectivity - ## 🐳 Technical Details ### Docker Configuration - **Base Image**: `eqlabs/pathfinder` -- **Exposed Ports**: - - **Mainnet**: `9545` (JSON-RPC), `9547` (Monitor) - - **Sepolia**: `9555` (JSON-RPC), `9557` (Monitor) - **Data Persistence**: Node data stored in persistent Docker volume - **Environment Variables**: - `PATHFINDER_ETHEREUM_API_URL`: L1 Ethereum node URL @@ -132,6 +118,7 @@ The package includes a Grafana dashboard for monitoring: ### Logs Access View logs through the DAppNode interface: + 1. Go to Packages → Pathfinder 2. Click on "Logs" tab 3. Adjust log level in configuration if needed @@ -173,6 +160,6 @@ This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) --- -**Made with ❤️ by the DAppNode community** +**Made with ❤️ by the DAppNode Association** -For support, join our [Discord](https://discord.gg/dappnode) or visit our [forum](https://discourse.dappnode.io/). +For support, join our [Discord](https://discord.gg/dappnode). diff --git a/dappnode_package.json b/dappnode_package.json index 878a7c8..eda08b8 100644 --- a/dappnode_package.json +++ b/dappnode_package.json @@ -4,19 +4,27 @@ "description": "Pathfinder - Starknet Node Client", "type": "service", "author": "DAppNode Association (https://github.com/dappnode)", - "categories": ["Developer tools", "Blockchain"], - "keywords": ["starknet"], - "architectures": ["linux/amd64", "linux/arm64"], + "categories": [ + "Developer tools", + "Blockchain" + ], + "keywords": [ + "starknet" + ], + "architectures": [ + "linux/amd64", + "linux/arm64" + ], "upstreamArg": "UPSTREAM_VERSION", "upstreamVersion": "v0.21.2", "upstreamRepo": "eqlabs/pathfinder", "links": { "homepage": "https://github.com/dappnode/DAppNodePackage-pathfinder-generic", - "api": "http://pathfinder.dappnode:9545/" + "api": "http://pathfinder.dappnode:6060/" }, "repository": { "type": "git", "url": "https://github.com/dappnode/DAppNodePackage-pathfinder-generic" }, "license": "GPL-3.0" -} +} \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index 526fc60..2354aea 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -12,8 +12,8 @@ services: RUST_LOG: info PATHFINDER_DB_DIR: /usr/share/pathfinder/data PATHFINDER_WEBSOCKET_ENABLED: "true" - PATHFINDER_HTTP_RPC_ADDRESS: 0.0.0.0:9545 - PATHFINDER_WS_RPC_ADDRESS: 0.0.0.0:9546 + PATHFINDER_HTTP_RPC_ADDRESS: 0.0.0.0:6060 + PATHFINDER_WS_RPC_ADDRESS: 0.0.0.0:6061 PATHFINDER_MONITOR_ADDRESS: 0.0.0.0:9547 volumes: - pathfinder-data:/usr/share/pathfinder/data diff --git a/getting-started.yml b/getting-started.yml index eec382b..f35f580 100644 --- a/getting-started.yml +++ b/getting-started.yml @@ -29,8 +29,8 @@ This package supports multiple StarkNet networks: | Network | Package | RPC Port | Monitor Port | RPC Endpoint | WebSocket Endpoint | |---------|---------|----------|----------------|--------------|--------------|-------------------| -| **Mainnet** | `pathfinder.dnp.dappnode.eth` | 9545 | 9547 | `http://pathfinder.dappnode:9545/` | `ws://pathfinder.dappnode:9545/ws` | -| **Sepolia** | `pathfinder-sepolia.dappnode.eth` | 9555 | 9557 | `http://pathfinder-sepolia.dappnode:9555/` | `ws://pathfinder-sepolia.dappnode:9555/ws` | +| **Mainnet** | `pathfinder.dnp.dappnode.eth` | 6060 | 9547 | `http://pathfinder.dappnode:6060/` | `ws://pathfinder.dappnode:6061/` | +| **Sepolia** | `pathfinder-sepolia.dappnode.eth` | 6060 | 9547 | `http://pathfinder-sepolia.dappnode:6060/` | `ws://pathfinder-sepolia.dappnode:6061/` | > **Note**: The Monitor port is used for metrics and health check endpoints for monitoring and observability. @@ -45,23 +45,23 @@ The Pathfinder node exposes a StarkNet JSON-RPC API compatible with the official curl -X POST \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","method":"starknet_blockNumber","params":[],"id":1}' \ - http://pathfinder.dappnode:9545/ + http://pathfinder.dappnode:6060/ # Sepolia - Get chain ID curl -X POST \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","method":"starknet_chainId","params":[],"id":1}' \ - http://pathfinder-sepolia.dappnode:9555/ + http://pathfinder-sepolia.dappnode:6060/ ``` ### WebSocket Interface ```javascript // Mainnet WebSocket -const wsMainnet = new WebSocket('ws://pathfinder.dappnode:9545/ws'); +const wsMainnet = new WebSocket('ws://pathfinder.dappnode:6060/'); // Sepolia WebSocket -const wsSepolia = new WebSocket('ws://pathfinder-sepolia.dappnode:9555/ws'); +const wsSepolia = new WebSocket('ws://pathfinder-sepolia.dappnode:6061/'); wsMainnet.onopen = function() { wsMainnet.send(JSON.stringify({ @@ -88,9 +88,6 @@ The package includes a Grafana dashboard for monitoring: ### Docker Configuration - **Base Image**: `eqlabs/pathfinder` -- **Exposed Ports**: - - **Mainnet**: `9545` (JSON-RPC), `9547` (Monitor) - - **Sepolia**: `9555` (JSON-RPC), `9557` (Monitor) - **Data Persistence**: Node data stored in persistent Docker volume - **Environment Variables**: - `PATHFINDER_ETHEREUM_API_URL`: L1 Ethereum node URL @@ -167,6 +164,6 @@ This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) --- -**Made with ❤️ by the DAppNode community** +**Made with ❤️ by the DAppNode Association** -For support, join our [Discord](https://discord.gg/dappnode) or visit our [forum](https://discourse.dappnode.io/). +For support, join our [Discord](https://discord.gg/dappnode). diff --git a/package_variants/sepolia/dappnode_package.json b/package_variants/sepolia/dappnode_package.json index 6d00e27..2bc3ec5 100644 --- a/package_variants/sepolia/dappnode_package.json +++ b/package_variants/sepolia/dappnode_package.json @@ -3,19 +3,19 @@ "version": "0.1.0", "shortDescription": "Pathfinder - StarkNet full node in Sepolia", "links": { - "RPC": "http://pathfinder-sepolia.dappnode:9545/", - "WS": "ws://pathfinder-sepolia.dappnode:9545/ws" + "RPC": "http://pathfinder-sepolia.dappnode:6060/", + "WS": "ws://pathfinder-sepolia.dappnode:6061/" }, "exposable": [ { "name": "Pathfinder Sepolia RPC", "description": "JSON RPC endpoint for Pathfinder Sepolia", - "port": 9555 + "port": 6060 }, { "name": "Pathfinder Sepolia WebSocket", "description": "WebSocket RPC endpoint for StarkNet Sepolia", - "port": 9556 + "port": 6061 } ] }