{"id":13564552,"url":"https://github.com/rollkit/rollkit","last_synced_at":"2025-04-03T21:31:11.814Z","repository":{"id":37446948,"uuid":"335571729","full_name":"rollkit/rollkit","owner":"rollkit","description":"A modular framework for rollups, with an ABCI-compatible client interface.","archived":false,"fork":false,"pushed_at":"2024-10-29T13:39:58.000Z","size":53101,"stargazers_count":334,"open_issues_count":107,"forks_count":158,"subscribers_count":23,"default_branch":"main","last_synced_at":"2024-10-29T16:12:21.384Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rollkit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-03T09:28:24.000Z","updated_at":"2024-10-28T05:20:20.000Z","dependencies_parsed_at":"2024-01-02T00:28:38.525Z","dependency_job_id":"6f0baf40-8d51-4700-99ca-8db6d6c69a6f","html_url":"https://github.com/rollkit/rollkit","commit_stats":null,"previous_names":["lazyledger/optimint","celestiaorg/optimint","celestiaorg/rollmint"],"tags_count":67,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollkit%2Frollkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollkit%2Frollkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollkit%2Frollkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollkit%2Frollkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rollkit","download_url":"https://codeload.github.com/rollkit/rollkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247083146,"owners_count":20880779,"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":[],"created_at":"2024-08-01T13:01:32.867Z","updated_at":"2025-04-03T21:31:06.806Z","avatar_url":"https://github.com/rollkit.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Rollkit\n\nRollkit is the first soveriegn rollup framework. For more in-depth information about Rollkit, please visit our [website][docs].\n\n\u003c!-- markdownlint-disable MD013 --\u003e\n[![build-and-test](https://github.com/rollkit/rollkit/actions/workflows/test.yml/badge.svg)](https://github.com/rollkit/rollkit/actions/workflows/test.yml)\n[![golangci-lint](https://github.com/rollkit/rollkit/actions/workflows/lint.yml/badge.svg)](https://github.com/rollkit/rollkit/actions/workflows/lint.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/rollkit/rollkit)](https://goreportcard.com/report/github.com/rollkit/rollkit)\n[![codecov](https://codecov.io/gh/rollkit/rollkit/branch/main/graph/badge.svg?token=CWGA4RLDS9)](https://codecov.io/gh/rollkit/rollkit)\n[![GoDoc](https://godoc.org/github.com/rollkit/rollkit?status.svg)](https://godoc.org/github.com/rollkit/rollkit)\n\u003c!-- markdownlint-enable MD013 --\u003e\n\n## Using Rollkit\n\n### Rollkit CLI\n\nThe easiest way to use rollkit is via the rollkit CLI.\n\nRequires Go version \u003e= 1.22.\n\nA cli tool that allows you to run different kinds of nodes for a rollkit network\nwhile also helping you generate the required configuration files\n\n#### Install\n\nTo install `rollkit`, simply run the following command at the root of the\nrollkit repo\n\n```bash\nmake install\n```\n\nThe latest Rollkit is now installed. You can verify the installation by running:\n\n```bash\nrollkit version\n```\n\n#### Quick Start\n\nYou can spin up a local rollkit network with the following command:\n\n```bash\nrollkit start\n```\n\nExplore the CLI documentation [here](./cmd/rollkit/docs/rollkit.md)\n\n## Building with Rollkit\n\nRollkit is the first sovereign rollup framework that allows you to launch\na sovereign, customizable blockchain as easily as a smart contract.\n\nCheck out our tutorials on our [website][docs].\n\n## Contributing\n\nWe welcome your contributions! Everyone is welcome to contribute, whether it's\nin the form of code, documentation, bug reports, feature\nrequests, or anything else.\n\nIf you're looking for issues to work on, try looking at the\n[good first issue list](https://github.com/rollkit/rollkit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).\nIssues with this tag are suitable for a new external contributor and is a great\nway to find something you can help with!\n\nSee\n[the contributing guide](https://github.com/rollkit/rollkit/blob/main/CONTRIBUTING.md)\nfor more details.\n\nPlease join our\n[Community Discord](https://discord.com/invite/YsnTPcSfWQ)\nto ask questions, discuss your ideas, and connect with other contributors.\n\n### Helpful commands\n\n```sh\n# Run unit tests\nmake test\n\n# Generate protobuf files (requires Docker)\nmake proto-gen\n\n# Run linters (requires golangci-lint, markdownlint, hadolint, and yamllint)\nmake lint\n\n# Lint protobuf files (requires Docker and buf)\nmake proto-lint\n\n```\n\n### Tools\n\n1. Install [golangci-lint](https://golangci-lint.run/welcome/install/)\n1. Install [markdownlint](https://github.com/DavidAnson/markdownlint)\n1. Install [hadolint](https://github.com/hadolint/hadolint)\n1. Install [yamllint](https://yamllint.readthedocs.io/en/stable/quickstart.html)\n\n## Dependency graph\n\nTo see our progress and a possible future of Rollkit visit our [Dependency\nGraph](https://github.com/rollkit/rollkit/blob/main/specs/src/specs/rollkit-dependency-graph.md).\n\n## Audits\n\n| Date | Auditor | Version | Report |\n|---|---|---|---|\n| 2024/01/12 | [Informal Systems](https://informal.systems/) | [eccdd...bcb9d](https://github.com/rollkit/rollkit/commit/eccdd0f1793a5ac532011ef4d896de9e0d8bcb9d) | [informal-systems.pdf](specs/audit/informal-systems.pdf) |\n| 2024/01/10 | [Binary Builders](https://binary.builders/)   | [eccdd...bcb9d](https://github.com/rollkit/rollkit/commit/eccdd0f1793a5ac532011ef4d896de9e0d8bcb9d) | [binary-builders.pdf](specs/audit/binary-builders.pdf)   |\n\n[docs]: https://rollkit.dev\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frollkit%2Frollkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frollkit%2Frollkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frollkit%2Frollkit/lists"}