Setup Guidance
- Operator Checklist
- Registration Instructions
Complete each item in the checklist to ensure your node is properly configured. The checklist verifies all prerequisites are met before registration.
Access CapxCloud Operator Checklist βWallet Configuration: Ledger/Safe vs. EOA
The appropriate environment file should be selected based on the wallet type being used.- Ledger/Safe Wallet
- EOA Wallet
Two key parameters should be configured:
-
PRIVATE_KEY_ATTESTER
(Consensus Key): This parameter holds the private key that is used for consensus-related operations. It is designated as the Consensus Key and is responsible for signing messages and attestations that participate in the consensus process. -
OPERATOR_ADDRESS
(Controller Key Address): This parameter holds the wallet address associated with the controller key. It is used to manage administrative functions and operator configurations. The separation of these keys helps enhance security by ensuring that the key used for consensus operations is distinct from the one controlling operator privileges.
Operator ( Attestor Node ) Setup
This is an early development release (v0.1.1) intended for testing and network growth. Operators should be aware that future updates may include breaking changes as the network evolves.
Key Features
- Basic P2P attestation node implementation
- Network discovery and peer connection
- Integration with Symbiotic protocol security layer
- Attestation service foundations
- Minimal operator configuration requirements
Docker Images
Attester P2P Node (Mainnet)
Validation Service (Mainnet)
Docker Compose file
Instructions for Running the Setup
- Prerequisites:
- It is expected that Docker and Docker Compose are installed.
- Ensure that the required environment variables are configured either in a
.env
file or in your shell environment. - Important: Configure network access for P2P communication
- You must ensure ports 7070 (metrics) and 9876 (P2P communication) are open for inbound traffic in your firewall/router.
- Without proper port forwarding, the attestation node will be unable to communicate with the network.
- If youβre behind NAT or want to use different port mappings, see the configuration note below.
- Port Configuration Note:
- Default setup: The system expects ports 7070 and 9876 to be directly accessible from the internet.
- Custom port mapping: If you need to map the P2P port to a different external port:
- Uncomment the
ANNOUNCED_ADDRESSES
section in the docker-compose file - Set
OPERATOR_PUBLIC_IP
to your actual public IP address - Set
OPERATOR_MAPPED_PORT
to your desired external port (e.g., 9878) - Update
OPERATOR_NODE_ID
with your node ID - Update your router/firewall to forward the chosen external port to port 9876 on your host
- Uncomment the
- Deploying the Services:
- Navigate to the directory containing the Docker Compose file.
-
Execute the following command to start the services in detached mode:
- The services will be initiated in the background.
- Monitoring Logs:
-
To monitor the logs for all services in real time, it is advised to use:
- This command will stream the logs continuously, allowing for live troubleshooting.
-
To monitor the logs for all services in real time, it is advised to use:
- Managing the Deployment:
-
To stop the services, the following command can be used:
-
If an update of the images is needed, it is recommended to run:
-
To stop the services, the following command can be used:
- Verify Connectivity:
- After deployment, verify your node is properly connected to the network by checking:
- Metrics endpoint: http://localhost:7070/metrics
- Service logs for successful P2P connections:
docker logs capxcloud-attester-p2p-node
- After deployment, verify your node is properly connected to the network by checking: