https://github.com/libp2p/go-libp2p-consensus

A consensus interface for LibP2P
https://github.com/libp2p/go-libp2p-consensus

Last synced: about 1 year ago
JSON representation

A consensus interface for LibP2P

• Host: GitHub
• URL: https://github.com/libp2p/go-libp2p-consensus
• Owner: libp2p
• Created: 2016-11-10T15:22:35.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-03-29T08:32:23.000Z (about 1 year ago)
• Last Synced: 2025-03-29T16:11:07.634Z (about 1 year ago)
• Language: Go
• Homepage:
• Size: 35.2 KB
• Stars: 23
• Watchers: 23
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# go-libp2p-consensus

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)

[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://github.com/libp2p/libp2p)

[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)

[![GoDoc](https://godoc.org/github.com/libp2p/go-libp2p-raft?status.svg)](https://godoc.org/github.com/libp2p/go-libp2p-consensus)

[![Build Status](https://travis-ci.org/libp2p/go-libp2p-consensus.svg?branch=master)](https://travis-ci.org/libp2p/go-libp2p-consensus)

[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)

> A Consensus interface for LibP2P

The LibP2P Consensus interface allows to abstract different consensus algorithms implemented for libp2p with an standarized layer so they can be swapped seamlessly.

## Table of Contents

- [Install](#install)

- [Usage](#usage)

- [Contribute](#contribute)

- [License](#license)

## Install

Simply `go-get` the module:

```

go get -u github.com/libp2p/go-libp2p-consensus

```

You can run `make deps` and `make test`, although they do very little because this module only declares some interfaces.

## Usage

In a different project just:

```

import "github.com/libp2p/go-libp2p-consensus"

```

This repo is [gomod](https://github.com/golang/go/wiki/Modules)-compatible, and users of

go 1.11 and later with modules enabled will automatically pull the latest tagged release

by referencing this package. Upgrades to future releases can be managed using `go get`,

or by editing your `go.mod` file as [described by the gomod documentation](https://github.com/golang/go/wiki/Modules#how-to-upgrade-and-downgrade-dependencies).

The code is documented in [godoc.org/github.com/libp2p/go-libp2p-consensus](https://godoc.org/github.com/libp2p/go-libp2p-consensus).

## Contribute

PRs accepted.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

MIT © Protocol Labs, Inc.

---

The last gx published version of this module was: 0.0.3: QmZ88KbrvZMJpXaNwAGffswcYKz8EbeafzAFGMCA6MEZKt