https://github.com/0xpolygon/go-ibft

A minimal and compact IBFT 2.0 implementation, written in Go
https://github.com/0xpolygon/go-ibft

blockchain consensus distributed go ibft ibft2 protocol

Last synced: 4 days ago
JSON representation

A minimal and compact IBFT 2.0 implementation, written in Go

• Host: GitHub
• URL: https://github.com/0xpolygon/go-ibft
• Owner: 0xPolygon
• License: apache-2.0
• Created: 2022-06-10T10:13:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-20T11:50:48.000Z (4 months ago)
• Last Synced: 2024-12-10T08:42:26.672Z (12 days ago)
• Topics: blockchain, consensus, distributed, go, ibft, ibft2, protocol
• Language: Go
• Homepage:
• Size: 570 KB
• Stars: 21
• Watchers: 6
• Forks: 22
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![codecov](https://codecov.io/gh/0xPolygon/go-ibft/branch/main/graph/badge.svg?token=0vLkmaEq3h)](https://codecov.io/gh/0xPolygon/go-ibft)

# go-ibft README

## Overview

`go-ibft` is a simple, straightforward, IBFT state machine implementation.

It doesn't contain fancy synchronization logic, or any kind of transaction execution layer.

Instead, `go-ibft` is designed from the ground up to respect and adhere to the `IBFT 2.0` specification document.

Inside 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.

As 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.

## Installation

To get up and running with the `go-ibft` package, you can pull it into your project using:

`go get github.com/0xPolygon/go-ibft`

Currently, the minimum required go version is `go 1.17`.

## Usage Examples

```go

package main

import "github.com/0xPolygon/go-ibft"

// IBFTBackend is the structure that implements all required

// go-ibft Backend interfaces

type IBFTBackend struct {

	// ...

}

// IBFTLogger is the structure that implements all required

// go-ibft Logger interface

type IBFTLogger struct {

	// ...

}

// IBFTTransport is the structure that implements all required

// go-ibft Transport interface

type IBFTTransport struct {

	// ...

}

// ...

func main() {

	backend := NewIBFTBackned(...)

	logger := NewIBFTLogger(...)

	transport := NewIBFTTransport(...)

	ibft := NewIBFT(logger, backend, transport)

	blockHeight := uint64(1)

	ctx, cancelFn := context.WithCancel(context.Background())

	go func () {

		// Run the consensus sequence for the block height.

		// When the method returns, that means that

		// consensus was reached

		i := RunSequence(ctx, blockHeight)

	}

	// ...

	// Stop the sequence by cancelling the context

	cancelFn()

}

```

## License

Copyright 2022 Polygon Technology

Licensed 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

### http://www.apache.org/licenses/LICENSE-2.0

Unless 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.