ggxchain / ggxnode

Apache License 2.0
6 stars 5 forks source link

light-client .scale metadata update, docker-compose documentation, fetch_metadata.sh and README short fix. #285

Closed matsuro-hadouken closed 4 months ago

matsuro-hadouken commented 4 months ago

Summary of Changes

README Update:

A warning has been added to the main README.md to inform users that the current data is outdated. A redirection link to the official documentation is provided. Outdated options like --telemetry and --bootnode has been removed to avoid confusion.

fetch_metadata.sh Script:

The script has been rewritten to align with the official RPC endpoints. It now provides clear usage instructions and examples for connecting to the Sydney and Brooklyn networks, as well as using custom RPC endpoints.

Usage Instructions:

Usage: fetch_metadata.sh <network> [<custom RPC>]
Networks:
  sydney     - Use Sydney network RPC
  brooklyn   - Use Brooklyn network RPC
  custom     - Use a custom RPC endpoint (provide RPC URL as second argument)
Example:
  fetch_metadata.sh sydney
  fetch_metadata.sh custom "http://127.0.0.1:1234"

Docker Compose Adjustments and Documentation:

The documentation has been updated to include instructions for using Docker Compose with the newly released Docker images available on Docker Hub. This update includes detailed steps on pulling the latest images and deploying nodes efficiently. The new CI/CD pipeline ensures that these images are automatically built and published, facilitating a smoother deployment process.

Testing Artifacts:

eth_light_client_brooklyn.scale
eth_light_client_sydney.scale

Uploaded necessary .scale files for testing the Ethereum light client on the Brooklyn and Sydney networks. The allowlist_metadata.scale file is preserved for use with the whitelist pallet, which remains relevant for permissioned network environments.