Git Product home page Git Product logo

geth-ulc-compose's Introduction

Geth ULC Docker Compose

This project sets up a Dockerized instance of Geth (Go Ethereum) running in Ultra Light Client (ULC) mode.

Prerequisites

  • Docker and Docker-compose installed on your machine.
  • Understanding of Ethereum, Geth and Docker is recommended.

Setup Instructions

  1. Clone the repository:

    git clone <repository-url>
    
  2. Navigate to the cloned repository:

    cd <repository-directory>
    
  3. Start the Docker service with a specified network. You can specify --goerli, --mainnet or --sepolia as a command line option to determine which network you would like to connect to:

    # For Ethereum mainnet
    EXTRA_OPTS='--mainnet' docker-compose up -d
    
    # For Görli network
    EXTRA_OPTS='--goerli' docker-compose up -d
    
    # For Sepolia network
    EXTRA_OPTS='--sepolia' docker-compose up -d
    

The provided docker-compose.yml file configures a Geth instance in ULC mode, listening on HTTP, and connected to specified trusted ULC servers.

You may replace the servers listed in --ulc.servers with addresses of your trusted servers.

Ports

The service exposes the following ports:

  • 8545: JSON-RPC HTTP interface
  • 30303: P2P network interface

Persisting data

Blockchain data is persisted in a Docker volume mapped to ./eth in your host system.

JSON-RPC APIs

The service enables the following JSON-RPC APIs: eth, net, web3, debug, and admin.

Security

Ensure to properly manage your Docker environment and restrict access to your system, as your Geth instance will allow external connections due to the --http.addr=0.0.0.0 and --http.vhosts=\* settings. Consider additional security measures for production environments.

Notes

This setup allows you to select the network for the Geth ULC client to connect to. You can specify --goerli, --mainnet or --sepolia using the EXTRA_OPTS environment variable while starting the docker service.

Contributing

For any issues, questions, or suggestions for improvement, please open an issue in the GitHub issue tracker. Contributions are welcome.

geth-ulc-compose's People

Contributors

wantaekchoi avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.