{"id":14281103,"url":"https://github.com/shardeum/shardeum","last_synced_at":"2025-05-12T05:14:36.132Z","repository":{"id":233759907,"uuid":"787637064","full_name":"shardeum/shardeum","owner":"shardeum","description":"Shardeum is an EVM based autoscaling blockchain","archived":false,"fork":false,"pushed_at":"2025-05-11T01:22:27.000Z","size":28105,"stargazers_count":31911,"open_issues_count":41,"forks_count":684,"subscribers_count":295,"default_branch":"dev","last_synced_at":"2025-05-12T02:43:14.107Z","etag":null,"topics":["blockchain","dapp","ethereum","evm","evm-blockchain","payments","sharding","typescript"],"latest_commit_sha":null,"homepage":"https://shardeum.org/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shardeum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-04-16T22:37:25.000Z","updated_at":"2025-05-12T01:43:07.000Z","dependencies_parsed_at":"2024-04-21T15:10:46.228Z","dependency_job_id":"31261da6-1419-4865-9966-544aaf387b6d","html_url":"https://github.com/shardeum/shardeum","commit_stats":{"total_commits":1632,"total_committers":49,"mean_commits":33.30612244897959,"dds":0.5686274509803921,"last_synced_commit":"7d69f03240fef28807f854d51a497c599666649c"},"previous_names":["shardeum/shardeum"],"tags_count":92,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shardeum%2Fshardeum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shardeum%2Fshardeum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shardeum%2Fshardeum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shardeum%2Fshardeum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shardeum","download_url":"https://codeload.github.com/shardeum/shardeum/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253672640,"owners_count":21945478,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","dapp","ethereum","evm","evm-blockchain","payments","sharding","typescript"],"created_at":"2024-08-23T11:01:04.815Z","updated_at":"2025-05-12T05:14:36.106Z","avatar_url":"https://github.com/shardeum.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","Repos"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/shardeum/.github/raw/dev/shardeum-white-bg.png\" alt=\"Shardeum Logo\" width=\"70%\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eAn EVM-based autoscaling blockchain platform\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/shardeum/shardeum/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\" alt=\"License\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://discord.com/invite/shardeum\"\u003e\u003cimg src=\"https://img.shields.io/discord/933959587462254612?logo=discord\" alt=\"Discord\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://x.com/Shardeum\"\u003e\u003cimg src=\"https://img.shields.io/twitter/follow/Shardeum?style=social\" alt=\"Twitter\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Features](#features)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [Running the Network Locally](#running-the-network-locally)\n  - [Running the JSON-RPC Server](#running-the-json-rpc-server)\n- [Testing with MetaMask](#testing-with-metamask)\n- [Testing with Jest](#testing-with-jest)\n- [Stopping and Cleaning Up](#stopping-and-cleaning-up)\n- [Health Checks](#health-checks)\n- [Contributing](#contributing)\n- [Community](#community)\n- [License](#license)\n\n## Introduction\n\nShardeum 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.\n\n## Features\n\n- **Scalability**: Horizontal scalability through sharding\n- **High Performance**: Low latency and high throughput\n- **Security**: Advanced cryptographic techniques and robust consensus protocols\n- **Decentralization**: Truly decentralized network with no single point of failure\n- **Interoperability**: EVM compatibility for existing DApps and smart contracts\n\n## Getting Started\n\n### Prerequisites\n\n- Node.js (v18.19.1)\n- npm (v10.2.4)\n- Rust (v1.74.1)\n- Docker (optional, for containerized deployment)\n\n### Setting Up Your Environment\n\nShardeum requires specific versions of Nodejs, Rust and other build tools to run. \n\nWe have detailed setup instructions [in this page](local-environment-setup.md) \n\n\u003e[!IMPORTANT] \n\u003e This is a crucial step, ensure your local environment is correctly set up before proceeding with the next steps\n\n### Installation\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/shardeum/shardeum.git\ncd shardeum\n```\n\n2. Install dependencies:\n\n```bash\nnpm ci\n```\n\n3. Network Configuration:\n\n```bash\nexport LOAD_JSON_CONFIGS=[full-path-to-your-local-shardeum-repo]/debug-10-nodes.config.json\n```\nFor instance, if your local shardeum repo is on this path `/Users/john/Desktop/projects/shardeum/` then you would run:\n\n```\nexport LOAD_JSON_CONFIGS=/Users/john/Desktop/projects/shardeum/debug-10-nodes.config.json\n```\n\nLearn more about the different config options [here](local-environment-setup.md)\n\n4. Compile project\n\n```bash\nnpm run prepare\n```\n\n5. Install the Shardus CLI:\n\n```bash\nnpm install -g @shardeum-foundation/tools-shardus-cli\nnpm update @shardeum-foundation/archiver\n```\n\n## Running the Network Locally\n\nTo start a local Shardeum network with 10 nodes, run:\n\n```bash\nshardus start 10\n```\n\n### Running the JSON-RPC Server\n\n1. Clone the JSON-RPC server repository:\n\n```bash\ngit clone https://github.com/shardeum/json-rpc-server.git\ncd json-rpc-server\nnpm install\n```\n\n2. Start the server:\n\n```bash\nnpm run start\n```\n\nThe default RPC URL is `http://localhost:8080`.\n\n## Testing with MetaMask\n\nTo test your local Shardeum network using MetaMask:\n\n1. Install the [MetaMask extension](https://metamask.io/download/).\n2. Add the Shardeum network to MetaMask:\n\n- Network Name: Shardeum\n- RPC URL: http://localhost:8080\n- Chain ID: 8082\n- Currency Symbol: SHM\n- Block Explorer URL: http://localhost:6001/\n\n3. 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:\n\n```json\n\"YOUR-WALLET-ADDRESS\": {\n    \"wei\": \"200000000000000000000000000\"\n},\n```\n\n## Testing with Jest\n\n`src/index.ts` is mocked for all tests. You can see how its mocked out in the `test/unit/setup.ts` file. Don't import the `index` file directly if you can since it has a lot of dependencies, import the specific files you need in your implementation or test files.\n\n## Stopping and Cleaning Up\n\nTo stop the network and clean up resources:\n\n```bash\nshardus stop \u0026\u0026 shardus clean \u0026\u0026 rm -rf instances\n```\n\n## Health Checks\nDiagnostic endpoints to check the health of the node\n\n- GET `/is-alive` this endpoint returns 200 if the server is running.\n- GET `/is-healthy` currently the same as `/is-alive` but will be expanded.\n\n## Contributing\n\nWe 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).\n\n## Community\n\n- [GitHub Discussions](https://github.com/shardeum/shardeum/discussions)\n- [Discord](https://discord.com/invite/shardeum)\n- [X (formerly Twitter)](https://x.com/Shardeum)\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshardeum%2Fshardeum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshardeum%2Fshardeum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshardeum%2Fshardeum/lists"}