base on Shardeum is an EVM based autoscaling blockchain <p align="center"> <img src="https://github.com/shardeum/.github/raw/dev/shardeum-white-bg.png" alt="Shardeum Logo" width="70%"> </p> <p align="center"> <strong>An EVM-based autoscaling blockchain platform</strong> </p> <p align="center"> <a href="https://github.com/shardeum/shardeum/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a> <a href="https://discord.com/invite/shardeum"><img src="https://img.shields.io/discord/933959587462254612?logo=discord" alt="Discord"></a> <a href="https://x.com/Shardeum"><img src="https://img.shields.io/twitter/follow/Shardeum?style=social" alt="Twitter"></a> </p> ## Table of Contents - [Introduction](#introduction) - [Features](#features) - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Running the Network Locally](#running-the-network-locally) - [Running the JSON-RPC Server](#running-the-json-rpc-server) - [Testing with MetaMask](#testing-with-metamask) - [Stopping and Cleaning Up](#stopping-and-cleaning-up) - [Health Checks](#health-checks) - [Contributing](#contributing) - [Community](#community) - [License](#license) ## Introduction Shardeum is an innovative EVM-compliant blockchain platform that leverages dynamic state sharding to achieve unprecedented scalability. By implementing a sharding model, Shardeum ensures faster processing times and lower transaction costs without compromising security or decentralization. ## Features - **Scalability**: Horizontal scalability through sharding - **High Performance**: Low latency and high throughput - **Security**: Advanced cryptographic techniques and robust consensus protocols - **Decentralization**: Truly decentralized network with no single point of failure - **Interoperability**: EVM compatibility for existing DApps and smart contracts ## Getting Started ### Prerequisites - Node.js (v18.19.1) - npm (v10.2.4) - Rust (v1.74.1) - Docker (optional, for containerized deployment) ### Setting Up Your Environment Shardeum requires specific versions of Nodejs, Rust and other build tools to run. We have detailed setup instructions [in this page](local-environment-setup.md) >[!IMPORTANT] > This is a crucial step, ensure your local environment is correctly set up before proceeding with the next steps ### Installation 1. Clone the repository: ```bash git clone https://github.com/shardeum/shardeum.git cd shardeum ``` 2. Install dependencies: ```bash npm ci ``` 3. Network Configuration: ```bash git apply debug-10-nodes.patch ``` Learn more about the different config options [here](local) 4. Compile project ```bash npm run prepare ``` 5. Install the Shardus CLI: ```bash npm install -g shardus npm update @shardus/archiver ``` ## Running the Network Locally To start a local Shardeum network with 10 nodes, run: ```bash shardus start 10 ``` ### Running the JSON-RPC Server 1. Clone the JSON-RPC server repository: ```bash git clone https://github.com/shardeum/json-rpc-server.git cd json-rpc-server npm install ``` 2. Start the server: ```bash npm run start ``` The default RPC URL is `http://localhost:8080`. ## Testing with MetaMask To test your local Shardeum network using MetaMask: 1. Install the [MetaMask extension](https://metamask.io/download/). 2. Add the Shardeum network to MetaMask: - Network Name: Shardeum - RPC URL: http://localhost:8080 - Chain ID: 8082 - Currency Symbol: SHM - Block Explorer URL: http://localhost:6001/ 3. Obtaining Test Tokens and Configuring the Genesis File: To receive SHM tokens for testing on your local Shardeum network, you need to add your wallet address to the [src/config/genesis.json](src/config/genesis.json) file. Open this file in a text editor and add an entry for your wallet address with the desired SHM balance like this: ```json "YOUR-WALLET-ADDRESS": { "wei": "200000000000000000000000000" }, ``` ## Stopping and Cleaning Up To stop the network and clean up resources: ```bash shardus stop && shardus clean && rm -rf instances ``` ## Health Checks Diagnostic endpoints to check the health of the node - GET `/is-alive` this endpoint returns 200 if the server is running. - GET `/is-healthy` currently the same as `/is-alive` but will be expanded. ## Contributing We welcome contributions! Please see our [Contribution Guidelines](CONTRIBUTING.md) for more information. All contributors are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). ## Community - [GitHub Discussions](https://github.com/shardeum/shardeum/discussions) - [Discord](https://discord.com/invite/shardeum) - [X (formerly Twitter)](https://x.com/Shardeum) ## License This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. ", Assign "at most 3 tags" to the expected json: {"id":"11431","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"