Cosmos-sdk: explain tendermint and update use of tendermint in tutorials

Created on 3 Jul 2017  路  6Comments  路  Source: cosmos/cosmos-sdk

Just curious if there is a good way to deal with this issue - currently you are required to have tendermint installed to run the tutorial basecoin-tool.md - this is also true for running the shelldown auto-tutorial verifier. For this reason the circle.yaml file has some setup included in it:

go get -u github.com/tendermint/tendermint/cmd/tendermint

When one is running on a local machine, there is a whole bunch of headache associated with making sure you have the correct version of tendermint installed etc. - The above line doesn't always work, and it would be a bit much to program in the whole install guide. Maybe we just leave it and let each user deal with their own machine in this instance? Or alternatively, by default maybe we don't need to test the tutorials on local machines - but just test only on circle when uploading code? not sure.

docs

Most helpful comment

I like the idea of not requiring tendermint at all for tutorials.

That said, in a tutorial that explains how the basecoin tool works, it makes sense to demonstrate the basecoin can be run independently and driven by Tendermint in another process.

All 6 comments

Yeah, it is just to show you can run it out of process.

@ebuchman we should discuss this a bit more. How we want to present basecoin to the users.

Maybe it is good to run it as one app in the tutorials, and have all stuff with two apps, deployment, etc. documented in the testnets repo or something like that. This repo for dev, another for deployment. For dev, there is no reason not to run them in-process... for production, sure.

@ebuchman @zramsay What do you think?

I would be happy to remove all dependencies on the tendermint executable in our tutorials. It makes them cleaner and easier to follow.

I guess much will move to cosmos-academy anyway...

I like the idea of not requiring tendermint at all for tutorials.

That said, in a tutorial that explains how the basecoin tool works, it makes sense to demonstrate the basecoin can be run independently and driven by Tendermint in another process.

some tutorials require tendermint, although those specific tools are currently being re-worked (e.g, ethermint automatically starting tendermint ... but tendermint must still be installed

consolidate with #221:

What is quark? Start with main readme or have intro sentence. 
- Transaction: What is special about it? Transactions are the building block for custom blockchains. 
- What's with these boxes with the two boxes attached? 
- What is CheckTx and DeliverTx? 
- Dispatcher: the dispatcher handler...? which one? why am I interested? 
- Use of "state space" <- wtf, storage? 
- Needs overview:    
    - Middleware    
    - Dispatcher    
    - App (end handler?) 
- Security:    
    - Ok now we're talking about the app from the outside?    
    - Confusing diagram.    
- How do permissions help here? Permission to what? Example?    
- Data store        
    - Why is the implementation explained?        
    - Either explain why a merkle tree is needed or just say that middlewares can only access their own data.

stale

Was this page helpful?
0 / 5 - 0 ratings