Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.6.0 #116

Merged
merged 82 commits into from
Jun 23, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
82 commits
Select commit Hold shift + click to select a range
016d7e5
Merge tag 'v0.5.2' into develop
melekes Jun 2, 2017
1f34535
fix broken build script (it relies on make tools)
melekes Jun 2, 2017
2655bf8
dist: dont mkdir in container
ebuchman Jun 2, 2017
e242345
fix panic when genesis file does not include app_options (Fixes #101)
melekes Jun 5, 2017
7624c66
Merge pull request #102 from tendermint/bugfix/101-genesis-without-ap…
ebuchman Jun 5, 2017
25e7a79
replace basecli state presenters with cmds
rigelrozanski Jun 14, 2017
863e372
Update deps to latest light-client pr, breaking changes
ethanfrey Jun 15, 2017
65837cf
Clean up queries, part 1
ethanfrey Jun 15, 2017
66ec2f2
Port sendtx to new format
ethanfrey Jun 15, 2017
8f67b6b
Got counter tx working, needs testing
ethanfrey Jun 15, 2017
282a157
Update to use new helper methods, less code dups
ethanfrey Jun 15, 2017
66c9010
Starting bash cli tests
ethanfrey Jun 15, 2017
cfe13e9
Cleanup proof format, complete basic cli tests
ethanfrey Jun 15, 2017
6e390a6
Updated to newest of develop
ethanfrey Jun 15, 2017
1a1d5d4
Merge pull request #107 from tendermint/lcquery
ethanfrey Jun 15, 2017
3c18c33
Fix basecli --chainid to --chain-id
ethanfrey Jun 15, 2017
e356fc1
makefile cleanup
rigelrozanski Jun 15, 2017
226546e
circle bash integration
rigelrozanski Jun 15, 2017
789ebad
pulled out common helpers, prepare to support ibc
ethanfrey Jun 15, 2017
9341b8b
Support other binaries
ethanfrey Jun 15, 2017
81d6d24
Added counter tests as well
ethanfrey Jun 15, 2017
ad17fcf
makefile cleanup
rigelrozanski Jun 15, 2017
9c8ccef
reorganize basecli appTx commands
rigelrozanski Jun 16, 2017
985db9c
Merge pull request #111 from tendermint/apptxReorg
ethanfrey Jun 16, 2017
75425b9
Update CHANGELOG for some of the 0.6 enhancements
ethanfrey Jun 16, 2017
4d41378
Cache shunit2 in Makefile, so we don't wget everytime
ethanfrey Jun 16, 2017
2f3c700
Create new command, countercli, removed counter from basecli
ethanfrey Jun 16, 2017
526e213
Fix cli tests for new countercli app
ethanfrey Jun 16, 2017
fb7fc78
clean up cli tests
ethanfrey Jun 16, 2017
4606fc8
Add ibc test scaffolding
ethanfrey Jun 16, 2017
cba5523
Clear output of test failures in ibc
ethanfrey Jun 16, 2017
33d4f93
basecli sendtx handles chain/addr format
ethanfrey Jun 16, 2017
6eac364
Complete ibc tests with "basecoin ibc register" and "basecoin relay"
ethanfrey Jun 16, 2017
f75ebca
Fix Makefile, remove no longer needed demo!
ethanfrey Jun 16, 2017
b15f882
Ripped out query, tx send, account, keys, and more
ethanfrey Jun 16, 2017
9bf34cb
Removed many more unneeded commands
ethanfrey Jun 16, 2017
22918ba
Remove example-plugin code, need to fix docs
ethanfrey Jun 16, 2017
6c01988
Merge pull request #115 from tendermint/feature/remove-client-from-ba…
ethanfrey Jun 16, 2017
d7cddb2
Cleaned up comments
ethanfrey Jun 16, 2017
b63f8bd
Move relay to basecoin relay start
ethanfrey Jun 16, 2017
cb075bb
Working with relay init
ethanfrey Jun 16, 2017
a57e2d3
Remove remnants of basecoin tx as ibc functions are now under relay
ethanfrey Jun 16, 2017
6658421
Cleanup tests a bit
ethanfrey Jun 16, 2017
4b65d8b
Update changelog notes for relay update
ethanfrey Jun 16, 2017
a20b640
Better error output when setup fails
ethanfrey Jun 16, 2017
7dad89b
doc revisit basecoin-basics.md
rigelrozanski Jun 18, 2017
24bd0f5
update docs, move counter
rigelrozanski Jun 18, 2017
06c854f
"make fresh" when things are getting stale
ethanfrey Jun 19, 2017
1e76d92
Supress ugly kill message with disown - bash magick
ethanfrey Jun 19, 2017
9bb3493
Ran through the docs, more cleanup, everything except ibc ready
ethanfrey Jun 19, 2017
0b7b639
Rewrote ibc guide for basecli and relay
ethanfrey Jun 19, 2017
83346f5
Merge pull request #120 from tendermint/docs
ethanfrey Jun 19, 2017
f204144
Fix up ``` ticks
ethanfrey Jun 19, 2017
a3bc96c
basecoin init takes an account address
ebuchman Jun 21, 2017
7b595b3
user ErrNoData from light-client
ebuchman Jun 21, 2017
9b0f4fc
docs: update basics and plugins
ebuchman Jun 21, 2017
105cdba
cmd/commands -> cmd/basecoin/commands
ebuchman Jun 21, 2017
e671ce6
bring back key.json. ibc guide edits
ebuchman Jun 21, 2017
43378a9
fix up basecli readme and basecoin-tool.md
ebuchman Jun 21, 2017
05e23ed
update changelog
ebuchman Jun 21, 2017
824050a
basecoin init --chain-id
ebuchman Jun 21, 2017
4cabad0
Minor cleanup
ethanfrey Jun 21, 2017
22057b9
Merge pull request #128 from tendermint/ux-edits
ethanfrey Jun 21, 2017
a78a24b
bash test cleanup
rigelrozanski Jun 20, 2017
dcb4a40
quick setup/tear-down
rigelrozanski Jun 21, 2017
3b66483
Fix up one comment
ethanfrey Jun 21, 2017
662c632
Merge pull request #122 from tendermint/rebash
ethanfrey Jun 21, 2017
fd28e4e
Added tests on handling restarts well, cleaned up common
ethanfrey Jun 20, 2017
0fc0a62
Added restart cli test to Makefile
ethanfrey Jun 20, 2017
f249748
Update to latest merkleeyes:fix-restart-height branch
ethanfrey Jun 21, 2017
0b81676
abci handshake
ebuchman Jun 21, 2017
682f9ec
Cleanup after rebase
ethanfrey Jun 21, 2017
4ed03ac
Merge pull request #129 from tendermint/bugfix/106-wrong-height-on-re…
ethanfrey Jun 21, 2017
aa18ff4
Update go-crypto with keys seedphrase, better testable password prompts
ethanfrey Jun 21, 2017
e94ea20
Super rough summary of key recovery - please complete
ethanfrey Jun 21, 2017
da38448
docs: ibc guide all in one terminal
ebuchman Jun 21, 2017
c9b0290
Add roadmap to repo
ethanfrey Jun 22, 2017
5d147d1
Add thoughts on a release process
ethanfrey Jun 22, 2017
f5e96a8
Bump version to 0.6.0, add to basecli command
ethanfrey Jun 22, 2017
19999ea
ibc: UpdateChain fix blockid
ebuchman Jun 23, 2017
9627b7c
update changelog
ebuchman Jun 23, 2017
3747f23
Add basecli to packaging script
ethanfrey Jun 23, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
*.swp
vendor
merkleeyes.db
build
shunit2
docs/guide/*.sh

44 changes: 44 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,49 @@
# Changelog

## 0.6.0 (June 22, 2017)

Make the basecli command the only way to use client-side, to enforce best
security practices. Lots of enhancements to get it up to production quality.

BREAKING CHANGES:
- ./cmd/commands -> ./cmd/basecoin/commands
- basecli
- `basecli proof state get` -> `basecli query key`
- `basecli proof tx get` -> `basecli query tx`
- `basecli proof state get --app=account` -> `basecli query account`
- use `--chain-id` not `--chainid` for consistency
- update to use `--trace` not `--debug` for stack traces on errors
- complete overhaul on how tx and query subcommands are added. (see counter or trackomatron for examples)
- no longer supports counter app (see new countercli)
- basecoin
- `basecoin init` takes an argument, an address to allocate funds to in the genesis
- removed key2.json
- removed all client side functionality from it (use basecli now for proofs)
- no tx subcommand
- no query subcommand
- no account (query) subcommand
- a few other random ones...
- enhanced relay subcommand
- relay start did what relay used to do
- relay init registers both chains on one another (to set it up so relay start just works)
- docs
- removed `example-plugin`, put `counter` inside `docs/guide`
- app
- Implements ABCI handshake by proxying merkleeyes.Info()

ENHANCEMENTS:
- `basecoin init` support `--chain-id`
- intergrates tendermint 0.10.0 (not the rc-2, but the real thing)
- commands return error code (1) on failure for easier script testing
- add `reset_all` to basecli, and never delete keys on `init`
- new shutil based unit tests, with better coverage of the cli actions
- just `make fresh` when things are getting stale ;)

BUG FIXES:
- app: no longer panics on missing app_options in genesis (thanks, anton)
- docs: updated all docs... again
- ibc: fix panic on getting BlockID from commit without 100% precommits (still a TODO)

## 0.5.2 (June 2, 2017)

BUG FIXES:
Expand Down
52 changes: 36 additions & 16 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,36 +1,56 @@
all: test install
GOTOOLS = github.com/mitchellh/gox \
github.com/Masterminds/glide

NOVENDOR = go list ./... | grep -v /vendor/
all: get_vendor_deps install test

build:
go build ./cmd/...

install:
go install ./cmd/...
go install ./docs/guide/counter/cmd/...

dist:
@ sudo bash scripts/dist.sh
@ bash scripts/publish.sh
@bash scripts/dist.sh
@bash scripts/publish.sh

test:
go test `${NOVENDOR}`
#go run tests/tendermint/*.go
test: test_unit test_cli

get_deps:
go get -d ./...
test_unit:
go test `glide novendor`
#go run tests/tendermint/*.go

update_deps:
go get -d -u ./...
test_cli: tests/cli/shunit2
# sudo apt-get install jq
@./tests/cli/basictx.sh
@./tests/cli/counter.sh
@./tests/cli/restart.sh
@./tests/cli/ibc.sh

get_vendor_deps:
go get github.com/Masterminds/glide
get_vendor_deps: tools
glide install

build-docker:
docker run -it --rm -v "$(PWD):/go/src/github.com/tendermint/basecoin" -w "/go/src/github.com/tendermint/basecoin" -e "CGO_ENABLED=0" golang:alpine go build ./cmd/basecoin
docker run -it --rm -v "$(PWD):/go/src/github.com/tendermint/basecoin" -w \
"/go/src/github.com/tendermint/basecoin" -e "CGO_ENABLED=0" golang:alpine go build ./cmd/basecoin
docker build -t "tendermint/basecoin" .

tests/cli/shunit2:
wget "https://raw.githubusercontent.com/kward/shunit2/master/source/2.1/src/shunit2" \
-q -O tests/cli/shunit2

tools:
@go get $(GOTOOLS)

clean:
@rm -f ./basecoin
# maybe cleaning up cache and vendor is overkill, but sometimes
# you don't get the most recent versions with lots of branches, changes, rebases...
@rm -rf ~/.glide/cache/src/https-github.com-tendermint-*
@rm -rf ./vendor
@rm -f $GOPATH/bin/{basecoin,basecli,counter,countercli}

# when your repo is getting a little stale... just make fresh
fresh: clean get_vendor_deps install
@if [[ `git status -s` ]]; then echo; echo "Warning: uncommited changes"; git status -s; fi

.PHONY: all build install test get_deps update_deps get_vendor_deps build-docker clean
.PHONY: all build install test test_cli test_unit get_vendor_deps build-docker clean fresh
33 changes: 33 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Release Process

Basecoin is the heart of most demo apps and the testnets, but the last few releases have been a little chaotic. In order to guarantee a higher, production-quality release in the future, we will work on a release process to check before the push to master. This is a work-in-progress and should be trialed on the 0.6.x patches, and used for the 0.7.0 release.

This is a rough-guide. Please add comments here, let's try it out for 0.6.1 and see what is annoying and useless, and what is missing and useful.

## Preparation

* Clarify scope of release
* Create issues
* Write code
* Update CHANGELOG
* Create PR for release
* Update version

## QA

Once we have a PR for the release and think it is ready, we should test it out internally:

* Code review (in addition to individual code reviews on the merged issue)
* Manual run-through of tutorials (and feedback on bad UX)
* Deployment of a private testnet, multiple users test out manually (feedback on bugs, or annoying UX)
* Test out upgrading existing testnet from last version, document or add tools for easier upgrade.
* If outstanding issues here, fix the issues, and repeat.

## Release

Once QA passes, we need to orchestrate the release.

* Merge to master
* Set all glide dependencies to proper master versions of repos
* Push code with new version tag
* Upgrade our public-facing testnets with the latest versions
66 changes: 66 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Roadmap for future basecoin development

Warning: there are current plans, they may change based on other developments, needs. The further in the future, the less clear, like all plans.

## 0.6.x - Testnet and Light Client (late June 2017)

The current release cycle is making sure the server is usable for deploying testnets (easy config, safe restarts, moving nodes). Also that we have a useable light client that does full cryptographic prooofs without syncing the entire block headers. See the [changelog](CHANGELOG.md).

Patch release here involve improving the usability of the cli tools, adding subcommands, more flags, helper functions, shell integrations, etc. Please add issues if you find the client tool difficult to use, or deployment troublesome.

## 0.7.x - Towards a modular framework (late July 2017)

**Breaking changes**

* Renaming likely: this release may well lead to a [renaming of the repository](https://github.com/tendermint/basecoin/issues/119) to emphasize that it is a generalized framework. `basecoin` and `basecli` executables will remain with generally unchanged usage.
* This will also provide a tx structure that is very different than the current one, and a non-trivial upgrade of running chains.

The next release cycle involves a big upgrade to the core, especially how one can write modules (aka plugins) as well as configure a basecoin-based executable. The main goal is to leave us with basecoin as a single executable with a similar API, but create a new module/middleware system with a number of standard modules provided (and easy addition of third party modules), so developers can quickly mix-and-match pieces and add custom business logic for there chain.

The main goal here is to migrate from a basecoin with plugins for extra enhancements, to a proper app development framework, of which basecoin is one example app that can quickly be built.

Some ideas:

* Flexible fee/gas system (good for both public and private blockchains)
* Flexible authentication systems (with multi-sig support)
* Basic role permission system
* Abstract IBC to support other transactions from various modules (not just sendtx)

This will be done in conjunction with some sample apps also building on this framework, where other logic is interesting and money transfers is not the central goal, like [trackomatron](https://github.com/tendermint/trackomatron)

## Next steps

The following are three planned steps, the order of which may change. At least one or two of these will most likely occur before any other developments. Clearly, any other feature that are urgent for cosmos can jump the list in priority, but all these pieces are part of the cosmos roadmap, especially the first two.

### 0.8.x??? - Local client API for UI

Beyond the CLI, we want to add more interfaces for easily building a UI on top of the basecoin client. One clear example is a local REST API, so you can easily integrate with an electron app, or a chrome app, just as if you wrote a normal Single-Page Application, but connecting to a local proxy to do full crypto-graphic proofs.

Another **possible** development is providing an SDK, which we can compile with [go-mobile](https://github.com/golang/go/wiki/Mobile) for both Android and iOS to support secure mobile applications. Progress on this front is contingent on participation of an experienced mobile developer.

Further, when the planned enhancements to real-time events happen in tendermint core, we should expose that via a simple subscriber/listener model in these local APIs.

### 0.9.x??? - Proof of Stake and Voting Modules

We should integrate developments on a [proof-of-stake module](https://github.com/tendermint/basecoin-stake) (currently a work-in-progress) and basic voting modules (currently planned) into properly supported for modules. These would provide the basis for dynamic validator set changes with bondign periods, and the basis for making governance decisions (eg. voting to change the block reward).

At this point we would have to give full support to these plugins, and third-party devs can build on them to add more complex delegation or governance logic.

### 0.10.x??? - Database enhancements

Depending on developments with merkleeyes, we would like to increase the expressiveness of the storage layer while maintaining provability of all queries. We would also add a number of new primatives to the key-value store, to allow some general data-structures.

Also, full support for historical queries and performance optimizations of the storage later. But this all depends on supporting developments of another repo, so timing here is unclear. Here are some example ideas:

Merkle proofs:

* **Proof of key-value**: only current proof
* **Proof of missing key**: prove there is no data for that key
* **Proof of range**: one proof for all key-values in a range of keys
* **Proof of highest/lowest in range**: just get one key, for example, prove validator hash with highest height <= H

Data structures:

* **Queues**: provable push-pop operations, split over multiple keys, so it can scale to 1000s of entries without deserializing them all every time.
* **Priority Queues**: as above, but ordered by priority instead of FIFO.
* **Secondary Indexes**: add support for secondary indexes with proofs. So, I can not only prove my balance, but for example, the list of all accouns with a balance of > 1000000 atoms. These indexes would have to be created by the application and stored extra in the database, but if you have a common query that you want proofs/trust, it can be very useful.
14 changes: 11 additions & 3 deletions app/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
abci "github.com/tendermint/abci/types"
wire "github.com/tendermint/go-wire"
eyes "github.com/tendermint/merkleeyes/client"
. "github.com/tendermint/tmlibs/common"
cmn "github.com/tendermint/tmlibs/common"
"github.com/tendermint/tmlibs/log"

sm "github.com/tendermint/basecoin/state"
Expand Down Expand Up @@ -53,7 +53,15 @@ func (app *Basecoin) GetState() *sm.State {

// ABCI::Info
func (app *Basecoin) Info() abci.ResponseInfo {
return abci.ResponseInfo{Data: Fmt("Basecoin v%v", version.Version)}
resp, err := app.eyesCli.InfoSync()
if err != nil {
cmn.PanicCrisis(err)
}
return abci.ResponseInfo{
Data: cmn.Fmt("Basecoin v%v", version.Version),
LastBlockHeight: resp.LastBlockHeight,
LastBlockAppHash: resp.LastBlockAppHash,
}
}

func (app *Basecoin) RegisterPlugin(plugin types.Plugin) {
Expand Down Expand Up @@ -172,7 +180,7 @@ func (app *Basecoin) Commit() (res abci.Result) {
app.cacheState = app.state.CacheWrap()

if res.IsErr() {
PanicSanity("Error getting hash: " + res.Error())
cmn.PanicSanity("Error getting hash: " + res.Error())
}
return res
}
Expand Down
5 changes: 5 additions & 0 deletions app/genesis.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ func (app *Basecoin) LoadGenesis(path string) error {
r := app.SetOption(kv.Key, kv.Value)
app.logger.Info("Done setting Plugin key-value pair via SetOption", "result", r, "k", kv.Key, "v", kv.Value)
}

return nil
}

Expand Down Expand Up @@ -71,6 +72,10 @@ func loadGenesis(filePath string) (*FullGenesisDoc, error) {
return nil, errors.Wrap(err, "unmarshaling genesis file")
}

if genDoc.AppOptions == nil {
genDoc.AppOptions = new(GenesisDoc)
}

pluginOpts, err := parseGenesisList(genDoc.AppOptions.PluginOptions)
if err != nil {
return nil, err
Expand Down
9 changes: 8 additions & 1 deletion app/genesis_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/tendermint/basecoin/types"
"github.com/tendermint/go-crypto"
crypto "github.com/tendermint/go-crypto"
eyescli "github.com/tendermint/merkleeyes/client"
cmn "github.com/tendermint/tmlibs/common"
)

const genesisFilepath = "./testdata/genesis.json"
const genesisAcctFilepath = "./testdata/genesis2.json"

func TestLoadGenesisDoNotFailIfAppOptionsAreMissing(t *testing.T) {
eyesCli := eyescli.NewLocalClient("", 0)
app := NewBasecoin(eyesCli)
err := app.LoadGenesis("./testdata/genesis3.json")
require.Nil(t, err, "%+v", err)
}

func TestLoadGenesis(t *testing.T) {
assert, require := assert.New(t), require.New(t)

Expand Down
3 changes: 3 additions & 0 deletions app/testdata/genesis3.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"chain_id": "foo_bar_chain"
}
6 changes: 1 addition & 5 deletions circle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,5 @@ dependencies:

test:
override:
- "cd $REPO && glide install && go install ./cmd/basecoin"
- "cd $REPO && make all"
- ls $GOPATH/bin
- "cd $REPO && make test"
- "cd $REPO/demo && bash start.sh"


2 changes: 1 addition & 1 deletion cmd/basecli/LIGHT_NODE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Just initialize your client with the proper validator set as in the [README](REA

```
$ export BCHOME=~/.lightnode
$ basecli init --node tcp://<host>:<port> --chainid <chain>
$ basecli init --node tcp://<host>:<port> --chain-id <chain>
```

## Running
Expand Down
30 changes: 10 additions & 20 deletions cmd/basecli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@ To keep things clear, let's have two shells...

`$` is for basecoin (server), `%` is for basecli (client)

## Set up a clean basecoin, but don't start the chain

```
$ export BCHOME=~/.demoserve
$ basecoin init
```

## Set up your basecli with a new key

```
Expand All @@ -24,40 +17,37 @@ And set up a few more keys for fun...
```
% basecli keys new buddy
% basecli keys list
% ME=`basecli keys get demo -o json | jq .address | tr -d '"'`
% YOU=`basecli keys get buddy -o json | jq .address | tr -d '"'`
% ME=$(basecli keys get demo | awk '{print $2}')
% YOU=$(basecli keys get buddy | awk '{print $2}')
```

## Update genesis so you are rich, and start
## Set up a clean basecoin, initialized with your account

```
$ vi $BCHOME/genesis.json
-> cut/paste your pubkey from the results above

$ export BCHOME=~/.demoserve
$ basecoin init $ME
$ basecoin start
```

## Connect your basecli the first time

```
% basecli init --chainid test_chain_id --node tcp://localhost:46657
% basecli init --chain-id test_chain_id --node tcp://localhost:46657
```

## Check your balances...

```
% basecli proof state get --app=account --key=$ME
% basecli proof state get --app=account --key=$YOU
% basecli query account $ME
% basecli query account $YOU
```

## Send the money

```
% basecli tx send --name demo --amount 1000mycoin --sequence 1 --to $YOU
-> copy hash to HASH
% basecli proof tx get --key $HASH

% basecli proof tx get --key $HASH --app base
% basecli proof state get --key $YOU --app account
% basecli query tx $HASH
% basecli query account $YOU
```

Loading