Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iov-one/weave
Easy-to-use SDK to build Tendermint ABCI applications
https://github.com/iov-one/weave
abci blockchain framework tendermint
Last synced: about 1 month ago
JSON representation
Easy-to-use SDK to build Tendermint ABCI applications
- Host: GitHub
- URL: https://github.com/iov-one/weave
- Owner: iov-one
- License: other
- Created: 2018-01-21T19:24:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T03:42:20.000Z (over 1 year ago)
- Last Synced: 2024-06-18T14:05:48.471Z (3 months ago)
- Topics: abci, blockchain, framework, tendermint
- Language: Go
- Homepage: https://weave.iov.one/docs/intro.html
- Size: 6.42 MB
- Stars: 1,119
- Watchers: 183
- Forks: 47
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Audit: audit/AUDIT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome - Github
README
# IOV Weave
[](https://travis-ci.com/iov-one/weave)
[](https://codecov.io/gh/iov-one/weave/branch/master)
[](https://github.com/iov-one/weave)
[](https://goreportcard.com/report/github.com/iov-one/weave)
[](https://godoc.org/github.com/iov-one/weave)
[](http://weave.readthedocs.io/en/latest/)
[](https://github.com/iov-one/weave/blob/master/LICENSE)
IOV Weave is a framework for quickly building your custom
[ABCI application](https://github.com/tendermint/abci)
to run a blockchain on top of the best-of-class
BFT Proof-of-stake [Tendermint consensus engine](https://tendermint.com).
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.
Join the Weave [community channel](https://riot.im/app/#/room/#weave:matrix.org) :loudspeaker:
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](https://github.com/cosmos/cosmos-sdk/tree/v0.8.0) as well as the
future [0.9 rewrite](https://github.com/cosmos/cosmos-sdk/tree/develop). 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](https://github.com/cosmos/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](./docs/design/overview.rst)
## Prerequisites
* [Go](https://golang.org/doc/install)
* [docker](https://docs.docker.com/install/)
* [tendermint 0.31.12](https://github.com/tendermint/tendermint/tree/v0.31.12)
* [Installation](https://github.com/tendermint/tendermint/blob/master/docs/introduction/install.md)
## Instructions
First, make sure you have
[set up the requirements](https://weave.readthedocs.io/en/latest/mycoind/setup.html).
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 `bnsd` (IOV blockchain application)
and `bnscli` (a client side app to interact with `bnsd`).
You will have to
[install a compatible version of tendermint](https://github.com/tendermint/tendermint/blob/master/docs/introduction/install.md)
separately. (Currently we use the v0.31.5 release).
```
# cd into to your workspace that is not in your $GOPATH
git clone https://github.com/iov-one/weave.git
cd weave
make install
```
Note that this app relies on a separate tendermint process
to drive it. It is helpful to first read a primer on
[tendermint](https://tendermint.readthedocs.io/en/master/introduction.html)
as well as the documentation on the
[tendermint cli commands](https://tendermint.readthedocs.io/en/master/using-tendermint.html).
Once it compiles, I highly suggest going through the
[readthedocs](https://weave.readthedocs.io/en/latest)
## Compatibility
Check out [compatibility charts](./COMPATIBILITY.md)
## Protobuf Documentation
We generate documentation from the *.proto files to keep it up to date.
You can view the [documentation for all packages used in the `bns` app](http://htmlpreview.github.io/?https://github.com/iov-one/weave/blob/master/docs/proto/index.html).
Or generate it yourself:
```shell
make protodocs
open ./docs/proto/index.html
```
## Contributions
When opening a pull request with a change that does not require a CHANGELOG
entry, include `!nochangelog` in the description. This will inform our build
system to not fail the build due to a missing CHANGELOG update. This
instruction is needed only if you are changing any of the Go source files.
## 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](https://github.com/cosmos/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](https://github.com/iov-one), 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](https://github.com/iov-one/iov-core)
client libraries that deprecated `confio/weave-js`
## Audit
Check out our latest [audit report](https://github.com/iov-one/weave/tree/master/audit).
Thanks to [newfinal100](https://github.com/newfinal100) for designing the weave logo.