Skip to content

iov-one/weave

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8a36752 · Feb 21, 2019
Feb 7, 2019
Feb 6, 2019
Sep 17, 2018
Feb 21, 2019
Feb 14, 2019
Mar 22, 2018
Feb 6, 2019
Jan 24, 2019
Feb 21, 2019
Feb 21, 2019
Feb 1, 2019
Feb 19, 2019
Feb 14, 2019
Dec 19, 2018
Feb 21, 2019
Mar 22, 2018
Oct 9, 2018
Feb 20, 2019
Aug 13, 2018
Feb 5, 2019
Jan 27, 2019
Jan 2, 2019
Feb 20, 2019
Feb 7, 2019
Jul 27, 2018
Feb 12, 2019
Feb 12, 2019
Aug 13, 2018
Nov 19, 2018
Oct 29, 2018
Mar 16, 2018
Feb 20, 2018
Feb 15, 2019
Mar 16, 2018
Mar 16, 2018
Feb 19, 2019
Feb 12, 2019
May 23, 2018
Sep 6, 2018

Repository files navigation

Iov Weave

Build Status TravisCI codecov LoC Go Report Card API Reference ReadTheDocs license

IOV Weave is a framework for quickly building your custom ABCI application to run a blockchain on top of the best-of-class BFT Proof-of-stake Tendermint consensus engine. It provides much commonly used functionality that can quickly be imported in your custom chain, as well as a simple framework for adding the custom functionality unique to your project.

Note: Requires Go 1.9+

It is inspired by the routing and middleware model of many web application frameworks, and informed by years of wrestling with blockchain state machines. More directly, it is based on the official cosmos-sdk, both the 0.8 release as well as the future 0.9 rewrite. Naturally, as I was the main author of 0.8.

While both of those are extremely powerful and flexible and contain advanced features, they have a steep learning curve for novice users. Thus, this library aims to favor simplicity over power when there is a choice. If you hit limitations in the design of this library (such as maintaining multiple merkle stores in one app), I highly advise you to use the official cosmos sdk.

On the other hand, if you want to try out tendermint, or have a design that doesn't require an advanced setup, you should try this library and give feedback, especially on ease-of-use. The end goal is to make blockchain development almost as productive as web development (in golang), by providing defaults and best practices for many choices, while allowing extreme flexibility in business logic and data modelling.

For more details on the design goals, see the Design Document

Prerequisites

Instructions

First, make sure you have set up the requirements. If you have a solid go and node developer setup, you may skip this, but good to go through it to be sure.

Once you are set up, you should be able to run something like the following to compile both mycoind (sample app) and tendermint (a BFT consensus engine):

go get github.com/iov-one/weave
cd $GOPATH/src/github.com/iov-one/weave
make deps
make install
# test it built properly
tendermint version
# 0.29.1-xxxxx
mycoind version
# v0.11.1

Note that this app relies on a separate tendermint process to drive it. It is helpful to first read a primer on tendermint as well as the documentation on the tendermint cli commands.

Once it compiles, I highly suggest going through the tutorials on readthedocs

Compatibility Charts

Weave Tendermint
v0.11.1 v0.29.1
v0.11.0 v0.27.4
v0.10.x v0.27.4
v0.9.3 v0.25.0
Weave Protobuf compatible to previous version
v0.11.1 ✔️
v0.11.0 ✔️
v0.10.2 ✔️
v0.10.1
v0.10.0
v0.9.3 ✔️

History

The original version, until v0.6.0 was released under confio/weave. The original author, Ethan Frey, had previously worked on the Cosmos SDK and wanted to make a simpler framework he could use to start building demo apps, while the main sdk matured. Thus, confio/weave was born the first few months of 2018. This framework was designed to be open source and shared, but the only real usage and development was by IOV, so it was donated to that organization in August 2018 to be developed further for their BNS blockchain, as well as a companion to iov-core client libraries that deprecated confio/weave-js