{"id":18953148,"url":"https://github.com/0xpolygon/go-ibft","last_synced_at":"2025-12-14T20:29:37.024Z","repository":{"id":48243421,"uuid":"501995723","full_name":"0xPolygon/go-ibft","owner":"0xPolygon","description":"A minimal and compact IBFT 2.0 implementation, written in Go","archived":false,"fork":false,"pushed_at":"2024-08-20T11:50:48.000Z","size":584,"stargazers_count":22,"open_issues_count":10,"forks_count":23,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-13T15:07:00.587Z","etag":null,"topics":["blockchain","consensus","distributed","go","ibft","ibft2","protocol"],"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/0xPolygon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2022-06-10T10:13:39.000Z","updated_at":"2025-02-10T05:06:37.000Z","dependencies_parsed_at":"2024-06-18T18:15:04.061Z","dependency_job_id":"801d1bd2-07ba-40c0-a1f5-fa9f2fafb295","html_url":"https://github.com/0xPolygon/go-ibft","commit_stats":{"total_commits":81,"total_committers":15,"mean_commits":5.4,"dds":0.691358024691358,"last_synced_commit":"e81a63ff50d79dbe8099bdf3fa5ec495bcf42d51"},"previous_names":["trapesys/go-ibft"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xPolygon%2Fgo-ibft","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xPolygon%2Fgo-ibft/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xPolygon%2Fgo-ibft/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xPolygon%2Fgo-ibft/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0xPolygon","download_url":"https://codeload.github.com/0xPolygon/go-ibft/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248732484,"owners_count":21152852,"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","consensus","distributed","go","ibft","ibft2","protocol"],"created_at":"2024-11-08T13:36:44.809Z","updated_at":"2025-12-14T20:29:36.949Z","avatar_url":"https://github.com/0xPolygon.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![codecov](https://codecov.io/gh/0xPolygon/go-ibft/branch/main/graph/badge.svg?token=0vLkmaEq3h)](https://codecov.io/gh/0xPolygon/go-ibft)\n# go-ibft README\n\n## Overview\n\n`go-ibft` is a simple, straightforward, IBFT state machine implementation.\n\nIt doesn't contain fancy synchronization logic, or any kind of transaction execution layer.\nInstead, `go-ibft` is designed from the ground up to respect and adhere to the `IBFT 2.0` specification document.\n\nInside this package, you’ll find that it solves the underlying liveness and persistence issues of the original IBFT specification, as well as that it contains a plethora of optimizations that make it faster and more lightweight. For a complete specification overview on the package, you can check out the official documentation.\n\nAs mentioned before, `go-ibft` implements basic IBFT 2.0 state machine logic, meaning it doesn’t have any kind of transaction execution or block building mechanics. That responsibility is left to the `Backend` implementation.\n\n## Installation\n\nTo get up and running with the `go-ibft` package, you can pull it into your project using:\n\n`go get github.com/0xPolygon/go-ibft`\n\nCurrently, the minimum required go version is `go 1.17`.\n\n## Usage Examples\n\n```go\npackage main\n\nimport \"github.com/0xPolygon/go-ibft\"\n\n// IBFTBackend is the structure that implements all required\n// go-ibft Backend interfaces\ntype IBFTBackend struct {\n\t// ...\n}\n\n// IBFTLogger is the structure that implements all required\n// go-ibft Logger interface\ntype IBFTLogger struct {\n\t// ...\n}\n\n// IBFTTransport is the structure that implements all required\n// go-ibft Transport interface\ntype IBFTTransport struct {\n\t// ...\n}\n\n// ...\n\nfunc main() {\n\tbackend := NewIBFTBackned(...)\n\tlogger := NewIBFTLogger(...)\n\ttransport := NewIBFTTransport(...)\n\n\tibft := NewIBFT(logger, backend, transport)\n\n\tblockHeight := uint64(1)\n\tctx, cancelFn := context.WithCancel(context.Background())\n\n\tgo func () {\n\t\t// Run the consensus sequence for the block height.\n\t\t// When the method returns, that means that\n\t\t// consensus was reached\n\t\ti := RunSequence(ctx, blockHeight)\n\t}\n\n\t// ...\n\n\t// Stop the sequence by cancelling the context\n\tcancelFn()\n}\n```\n\n## License\n\nCopyright 2022 Polygon Technology\nLicensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\n### http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “ AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xpolygon%2Fgo-ibft","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0xpolygon%2Fgo-ibft","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xpolygon%2Fgo-ibft/lists"}