node - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #llm #go #android #machine-learning #rust #deep-learning #docker #nodejs #cli #kubernetes #open-source

node

(★ 71)

Everything required to run your own GIWA node

File Explorer

Download Latest Version (.zip)

- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- - sepolia-rollup.json
- - sepolia-genesis.json
- Dockerfile
- entrypoint.sh
- logo.png
- Dockerfile
- entrypoint.sh
.env
.env.sepolia
.gitignore
docker-compose.yaml
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/giwa-io/node

Downloads the entire project code from GitHub to your computer.

cd node

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose build --parallel

Runs the command against the services defined in the compose file.

NETWORK_ENV=<.env.{network}> docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose down

Runs the command against the services defined in the compose file.

docker compose down -v && rm -rf ./${DATA_DIR}

Runs the command against the services defined in the compose file.

docker compose logs -f giwa-el

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![GIWA](https://raw.githubusercontent.com/giwa-io/node/main/resources/logo.png)

# GIWA Node

**GIWA** is a Ethereum Layer 2 network built on Optimism's [OP Stack](https://stack.optimism.io/).  
This repository provides everything you need to run your own node on the GIWA network.

## 💡 Supported Networks

| Network           | Status |
|-------------------|--------|
| Mainnet           | 🚧     |
| Testnet (Sepolia) | ✅      |

## 🚀 Quick Start

1. Ensure you have an Ethereum L1 full node RPC available
2. Choose your network
    - For **mainnet**: *Coming soon – mainnet is currently under development.*
    - For **Testnet (Sepolia)**: Use `.env.sepolia`
3. Configure your L1 endpoints in the env file. You can also customize other runtime parameters (e.g. network, cache, logging, metrics) directly in the env file.
   ```bash
   OP_NODE_L1_ETH_RPC=<your-preferred-l1-eth-rpc>
   OP_NODE_L1_BEACON=<your-preferred-l1-beacon>
   ```
4. Build and run
   ```bash
   docker compose build --parallel
   NETWORK_ENV=<.env.{network}> docker compose up -d
   ```

5. Stop
    ```bash
    docker compose down
    ```

6. Cleanup
    ```bash
    docker compose down -v && rm -rf ./${DATA_DIR}
    ```

## 🛠️ Configuration

### Required Configuration

| Variable             | Description                        |
|----------------------|------------------------------------|
| `OP_NODE_L1_ETH_RPC` | Your Ethereum L1 node RPC endpoint |
| `OP_NODE_L1_BEACON`  | Your L1 beacon node endpoint       |

### Execution Client
GIWA nodes run [op-reth](https://github.com/ethereum-optimism/optimism/tree/main/rust/op-reth) as the execution client.

> [!NOTE]
> op-geth is no longer supported. It cannot follow GIWA once the Karst hardfork is active. See the [op-geth sunset notice](https://docs.giwa.io/notices/giwa-chain/op-geth-sunset).

### Sync Configuration

Choose one of the following sync strategies depending on your preference.
> Enable the corresponding **OPTION** block in your `.env.{network}` (only one at a time).

#### 1) Snap Sync — Fast & Practical
- **What it does:** Downloads a recent state snapshot and syncs to the current head without executing every historical block.
- **Use when:** You want to bring up a production/full node quickly (RPC nodes, followers).
- **Trade‑offs:** Fastest to get online; not suitable for deep historical state queries.

#### 2) Archive Sync — Full History
- **What it does:** Executes every block from genesis and **retains all historical state** (archive).
- **Use when:** You run an indexer, do research/debugging, or need historical state at arbitrary blocks.
- **Trade‑offs:** Significantly slower and requires much more disk; most operators don’t need this for day‑to‑day operations.

#### 3) Consensus‑Driven Sync — Trust‑Minimized
- **What it does:** The consensus client **drives** the execution client by inserting unsafe blocks; no L2 peer discovery required for the execution client.
- **Use when:** You prefer replay‑based syncing and tighter control (e.g. L2 verifier).
- **Trade‑offs:** Slower than snap; operationally simpler for controlled environments.

### Flashblocks (Optional)
To enable Flashblocks:

1. Edit your `.env.{network}` and uncomment:
   ```bash
   FLASHBLOCKS_WEBSOCKET_URL=
   ```

2. Run your node:
   ```bash
   NETWORK_ENV=<.env.{network}> docker compose up -d
   ```

## 💽 Persisting Data

By default, execution data is mounted to `{PROJECT_ROOT}/reth_data`.  
To customize the mount path, set the `$DATA_DIR` environment variable.

## ⚙️ Hardware Requirements

### Testnet

| Resource | Minimum       | Recommended |
|----------|---------------|-------------|
| CPU      | 4 cores       | 8+ cores    |
| RAM      | 8 GB          | 16+ GB      |
| Disk     | 500 GB (NVMe) | 1+ TB       |

## 🚀 Snapshot

For the fastest sync experience, you can restore from a snapshot instead of syncing from genesis.  
👉 **[Snapshot Guide](https://docs.giwa.io/node-operators/snapshots)** — Follow the step-by-step instructions to download and restore a snapshot.

## 🙋 Troubleshooting

- To check logs:
```bash
docker compose logs -f giwa-el
docker compose logs -f giwa-cl
```

## 🛑 Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.  
By running this node, you are responsible for your infrastructure, security, and compliance.

## 🌐 Join the GIWA Community

- [📖 Documentation](https://docs.giwa.io)
- [🆇 X](https://x.com/giwachain)
- 💬 Discord: *Coming Soon*