base on How to run an Ink Node # Ink Node > Forked and customized from https://github.com/smartcontracts/simple-optimism-node A simple docker compose script for launching full / archive node for the Ink chain. ## Recommended Hardware ### Mainnet - 16GB+ RAM - 2 TB SSD (NVME Recommended) - 100mb/s+ Download ### Testnet - 16GB+ RAM - 500 GB SSD (NVME Recommended) - 100mb/s+ Download ## Installation and Configuration ### Install docker and docker compose > Note: If you're not logged in as root, you'll need to log out and log in again after installation to complete the docker installation. Note: This command installs docker and docker compose for Ubuntu. For windows and mac desktop or laptop, please use Docker Desktop. For other OS, please find instructions in Google. ```sh # Update and upgrade packages sudo apt-get update sudo apt-get upgrade -y ### Docker and docker compose prerequisites sudo apt-get install -y curl sudo apt-get install -y gnupg sudo apt-get install -y ca-certificates sudo apt-get install -y lsb-release ### Download the docker gpg file to Ubuntu sudo mkdir -p /etc/apt/keyrings curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg ### Add Docker and docker compose support to the Ubuntu's packages list echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null sudo apt-get update ### Install docker and docker compose on Ubuntu sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin sudo usermod -aG docker $(whoami) ### Verify the Docker and docker compose install on Ubuntu sudo docker run hello-world ``` (For non-root user) After logged out and logged back in, test if docker is working by running. ```sh docker ps ``` It should returns an empty container list without having any error. Otherwise, restart your machine if there are errors. ### Clone the Repository ```sh git clone https://github.com/inkonchain/node cd node ``` ### Copy .env.example to .env Make a copy of `.env.example` named `.env`. ```sh cp .env.example .env ``` Open `.env` with your editor of choice ### Mandatory configurations - **NETWORK_NAME** - Choose which Optimism network layer you want to operate on: - `ink-sepolia` - Ink Sepolia (Testnet) - `ink-mainnet` - Ink (Mainnet) - **NODE_TYPE** - Choose the type of node you want to run: - `full` (Full node) - A Full node contains a few recent blocks without historical states. - `archive` (Archive node) - An Archive node stores the complete history of the blockchain, including historical states. - **OP_NODE\_\_RPC_ENDPOINT** - Specify the endpoint for the RPC of Layer 1 (e.g., Ethereum mainnet). For instance, you can use the free plan of Quicknode for the Ethereum mainnet. - **OP_NODE\_\_L1_BEACON** - Specify the beacon endpoint of Layer 1. You can use [QuickNode for the beacon endpoint](https://www.quicknode.com). For example: https://xxx-xxx-xxx.quiknode.pro/db55a3908ba7e4e5756319ffd71ec270b09a7dce - **OP_NODE\_\_RPC_TYPE** - Specify the service provider for the RPC endpoint you've chosen in the previous step. The available options are: - `alchemy` - Alchemy - `quicknode` - Quicknode (ETH only) - `erigon` - Erigon - `basic` - Other providers ### Optional configurations - **OP_GETH\_\_SYNCMODE** - Specify sync mode for the execution client - Unspecified - Use default snap sync for full node and full sync for archive node - `snap` - Snap Sync (Default) - `full` - Full Sync (For archive node, not recommended for full node) - **IMAGE_TAG\_\_[...]** - Use custom docker image for specified components. - **PORT\_\_[...]** - Use custom port for specified components. ## Operating the Node ### Start ```sh docker compose up -d --build ``` Will start the node in a detached shell (`-d`), meaning the node will continue to run in the background. We recommended to add `--build` to make sure that latest changes are being applied. ### View logs ```sh docker compose logs -f --tail 10 ``` To view logs of all containers. ```sh docker compose logs <CONTAINER_NAME> -f --tail 10 ``` To view logs for a specific container. Most commonly used `<CONTAINER_NAME>` are: - op-geth - op-node - bedrock-init ### Stop ```sh docker compose down ``` Will shut down the node without wiping any volumes. You can safely run this command and then restart the node again. ### Restart ```sh docker compose restart ``` Will restart the node safely with minimal downtime but without upgrading the node. ### Upgrade Pull the latest updates from GitHub, and Docker Hub and rebuild the container. ```sh git pull docker compose pull docker compose up -d --build ``` Will upgrade your node with minimal downtime. ### Wipe [DANGER] ```sh docker compose down -v ``` Will shut down the node and WIPE ALL DATA. Proceed with caution! ## Monitoring ### Estimate remaining sync time Run progress.sh to estimate remaining sync time and speed. Uses `Cast` command from Foundry tool set. Installation instructions here: https://getfoundry.sh/. ```sh ./progress.sh ``` This will show the sync speed in blocks per minute and the time until sync is completed. ``` Chain ID: 57073 Please wait Blocks per minute: ... Hours until sync is completed: ... ``` ### Grafana dashboard Grafana is exposed at [http://localhost:3000](http://localhost:3000) and comes with one pre-loaded dashboard ("Simple Node Dashboard"). Simple Node Dashboard includes basic node information and will tell you if your node ever falls out of sync with the reference L2 node or if a state root fault is detected. Use the following login details to access the dashboard: - Username: `admin` - Password: `ink` Navigate over to `Dashboards > Manage > Simple Node Dashboard` to see the dashboard, see the following gif if you need help:  ## Troubleshooting ### Walking back L1Block with curr=0x0000...:0 next=0x0000...:0 If you experience "walking back L1Block with curr=0x0000...:0 next=0x0000...:0" for a long time after the Ecotone upgrade, consider these fixes: 1. Wait for a few minutes. This issue usually resolves itself after some time. 2. Restart docker compose: `docker compose down` and `docker compose up -d --build` ", Assign "at most 3 tags" to the expected json: {"id":"12679","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"