README
¶
Tendermint Classic
The design goals for Tendermint Classic (and the SDK and related libraries) are:
- Simplicity and Legibility.
- Parallel performance, namely ability to utilize multicore architecture.
- Ability to evolve the codebase bug-free.
- Debuggability.
- Complete correctness that considers all edge cases, esp in concurrency.
- Future-proof modular architecture, message protocol, APIs, and encapsulation remarkably and instructively typical.
- To minimize dependencies to evolving, complex external projects, like protobuf.
- To become free from the influence of state actors, and mega-corpoartions like Google.
- To be uncompromisingly opinionated, without apology.
- To become complete, as a reference standard worthy of promoting for educational purposes.
We start with Tendermint and the Cosmos-SDK versions for cosmoshub-3, and continue to improve the legibility of the codebase by leveraging Amino. In the near future, Amino will become the basis for a fork of Go.
Amino Classi, I mean Tendermint Classic ... burrb... has an attitude, and if Rick and Morty can do it, so can I, so fuck it, deal with it.
``
//:.
`+.-:/.
/-...-//` `-
`.` `o......:+` `-/o`
`+::-.` /:.......:o` `-/:.o`
.+.-:/:-.` `o.........:+ `-:/-...o`
/:...--:/:-.` /:..........+- `-:/:-.....o`
`o.......-::/:/...........-o::--........s
-+..........-......-::::::::--........-o
o-............-://::-----:::///:-..../: ``..
.o.........-:/:-...............::+:-.o...-:/:/:
/:.......:/:.....................:+:+:::-...o`
`+.....-//........................./+......:+
```````..::...-+-..-/:-.....................//....:o`
`.--:::::::::--.....+-...:o+//-....................s...:+`
`//-...............+-......:+o+++:.................o--+:`
`:/-............:/.....:+//:/++/++/-............-+ss.
`/+-..........+....-o/......-/++////////////////:+: -:.`
`/+-.......-+....y/////++:-..-h+++o+++++++/+yho/` s./+`
`//......o-...// -:.:://s:.o/..........y:-//` o...o.
`/-....s....:+ `s::s:::::+///+:-h.../: :/...s`
`-:::.....:+.....+/ :o.-+ : ./d..::- `o...-o
`://-........+-.....-/+/:-...:/+/..-s /o//. o....s`
.-::-.......-/::+-.......:////::-.....:h+. `oy:` o....+:
`::::/:-....//.........................+/./+//::/+y-` o....:+
````.-:/.o..........................s-...:///:+- `.--.+....-+
`/:-.o.......:-............:...-s.........s` -////s:--:o:...-+`
`-/-...-+:...:/-............./+..s-........-+ //....-o-...+...-://`
:+///::o:-//:o-.--:::::::--...:++:.........o. s.......:....-..-..-o
` .+...-o-+........---::/::::-.........+ o.-.................s`
`o-...-y-.-..............---://:::-...+ :o..................s.
/+::::--o.......................-----.s` `s..................s`
``````:..`` /+.........................-:/+ -o.................-o
.-::------:::--.-+:+:.....................::--.` -+................-o`
.::. `-+o...:+:-...............-:/.` .s...............:o.
`::` `-/:o/.....-://+:--------:/:-. -y:............-+/`
`:/. `-+o--:s-......./s/:----...` -s-o/.........-/+-
`-/- -::+----:o+:--:/+:+//-/-` -/o--/++::-::://-`
./: ./-.+--------://:---/./- -/-` `:: o-----://yo+`
`:/` :/` o-----------------+ /- -+. `/- `+:-----o:.s`
`-+- `/- /:-----------------o +. `+:` `/. :+:--+-.-o.
`+/ `.+` `o------------------+. o. :+` .+` .:+///s/
`:+. ``.+` +:------------------:/ `o` .+- -+ `/-
.+- `` -+ `s--------------------o `o //` `:/ -/`
`// `.` -+ :/--------------------o .o -o. `/: /:
`-/` -. ./ o---------------------s :/ +/` `+- `+.
./. .:` `/ s---------------------o` +- -+. `+. :+`
`/: `/- -- -+---------------------o. o` /: `o` +:
`:/ /+ +. +:---------------------+- `+ .:` `+` .o`
-/` -/+. `o s----------------------o/ -/ -. `: //`
.:. `/-`+ .+ s---------------------+/+ /: `.`- `+-
.:. -:` `+ .:- `s--------------------:+-+ `s-.. . -/`
-: .:` -: -/- .o--------------------s--o ./:: `-. ::`
.: ` -.` /` /. -+-------------------+/..o --`+ `.:. ./.
/` `--` o /` //-------------------s...s .:+ `::` -:`
./ `-` o `+` +:------------------o/...s `o. ./: `/-`
:- :. o .+ o:------------------s....s `:. `-/- ./.
`/- :. `+ -/ o------------------o:....s `/ `-/. :/`
`/- :- .+ /: s-----------------:s.....s +. `-/-` `./-
`:: :- -/ +. s-----------------o:.....s /s` `.-:-.`
-/ -::: `o` s-----------------s......s` -/:.
-/` -s- `o y----------------o:......s` .+ .:
.+` -/ .+`y----------------s.......o. `o` `+
`+. ./` :/s---------------+/.......+- +. +
`/- `/` +o---------------s........+::- +
:/ `:` :+--------------/+......../+: /`
-/` :. //--------------o.........:s -:
.+` -. o---------------+.........:+ `+
`+. /.. s--------------+-.........-o o
`/: .+/s` y--------------+...........s o
:/ `//.// `s-------------o-...........s +`
-+ -+-.// ..s------------+/............s /.
`o:.-:+- `ss++++oooossyhs.............s -:
+.`-: :+----mmmmmmmmy.............s` `+
+-` s----Nmmmmmmmy.............s` o
+. /dhhhdddddddho.............+- o
o` /dyyyyyyyyyyyy.............// o`
o` yhyyyyyyyyyyyd.............-o /-
s +dyyyyyyyyyyyyd-.............s -/
s `shhyyyyyyyyyyyyhs.............y `o
s `-odyyyyyyyyyyyyyyyh+............s` s
`s ````ohyyyyyyyyyyyyyyyyh:.........../: o`
`s hhyyyyyyyyyyyyyyyyhy...........-o +.
.o -dyyyyyyyyhhhhyyyyyyho...........s /-
-/ s:-------/hhhyyyyyyyyd:..........o. ./
/: `m/........+hyyyyyyyyyhh..........:+ `o
o. +dy.........shyyyyyyyyyho..........s s
s `dhd-........-yhyyyyyyyyyd:.........o- o`
s /dyh+........./hyyyyyyyyyhh-........-o +.
`o `dhyhy..........ohyyyyyyyyyhs.........s` ::
:/ ohyyyd-..........shyyyyyyyyyd/........:+ `+
+. -dyyyyho..........-hhyyyyyyyyhh-........s` o
s `yhyyyyyh...........:hyyyyyyyyyhs........:/ o
`o +hyyyyyyd:...........+hyyyyyyyyyd+........s` +`
-/ -dyyyyyyyhs............shyyyyyyyyyd-.......:+ :.
+. .hhyyyyyyyyd.............yhyyyyyyyyhh........o` .:
o `sdyyyyyyyyyd/............-dhyyyyyyyyho.......-+ `+
`+ o-hyyyyyyyyyhh.............+dyyyyyyyyyh:......./- +
/. o:.ohyyyyyyyyyd-.............shyyyyyyyyyh-.......+ /
+ +:..:dyyyyyyyyyhs..............yhyyyyyyyyhy.......-/ /`
`/ +:....hyyyyyyyyyhd..............-hhyyyyyyyyho.......:. .-
:. /:.....shyyyyyyyyym:..............-hhyyyyyyyyd:......./ `:
/ /-....../hyyyyyyyyydy///////////////odyyyyyyyyhh-.......: /
`: `/-.......-dyyyyyyyyyhs````````````````/hyyyyyyyyhh/////:--.:
:``/-...-::///hyyyyyyyyyyy `yhyyyyyyyyd.````.-://`
`:./:::::-```` yyyyyyyyyyyh` /hyyyyyyyyh+ `:.
.//:.`` syyyyyyyyyyd` .dyyyyyyyyhs ``
.` syyyyyyyyyyd` `hyyyyyyyyhy
syyyyyyyyyyd` yhyyyyyyyhh
shyyyyyyyyyd` ohyyyyyyyyd
shyyyyyyyyyd` ohyyyyyyyyd
shyyyyyyyyyh` shyyyyyyyhh
yhyyyyyyyyyy yyyyyyyyyhs
yyyyyyyyyyys yyyyyyyyyh+
hyyyyyyyyyyh` hyyyyyyyyd:
`dyyyyyyyyyyh `dyyyyyyyyd.
`dyyyyyyyyyhy `dyyyyyyyyd`
.dyyyyyyyyyho .dyyyyyyyyh`
-dyyyyyyyyyh/ -dyyyyyyyhy
:dyyyyyyyyyd- :dyyyyyyyho
/hyyyyyyyyyd. +hyyyyyyyd/
+hyyyyyyyyyd` ohyyyyyyyd-
shyyyyyyyyhh shyyyyyyyd`
yhyyyyyyyyhs yhyyyyyyyd
hyyyyyyyyyh+ dyyyyyyyhy
dyyyyyyyyyd: `dyyyyyyyho
`dyyyyyyyyyd. `myyyyyyyh/
`dyyyyyyyyyd` .dyyyyyyyd.
-dyyyyyyyyyh -dyyyyyyyd`
:hyyyyyyyyhs /hyyyyyyyy
+hyyyyyyyyh+ +hyyyyyyys
ohyyyyyyyyh: oyyyyyyyh/
ohhhhhhhhyy` /hhhhyyyh-
`/:----..-/ `o.-/+osy`
:- ./ o `/
.//---:::++` +.--:/ohs:`
`hdddddddddds. `hhddddddddh+.
oddddddddddddd/` oddddddddddddds:`
.dddddddddddddddy- .mdddddddddddddddy/.
sddddddddddddddddd+` omdddddddddddddddddho-`
.mddddddddddddddddddy-` yddddddddddddddddddddds-`
smddddddddddddddddddddo. dddddddddddddddddddddddds-`
/++++++++++++++++++++++: `rippedfromkineticsqurrel/`
But is it really?
Directories
¶
| Path | Synopsis |
|---|---|
|
abci
|
|
|
merkle
Package merkle computes a deterministic minimal height Merkle tree hash.
|
Package merkle computes a deterministic minimal height Merkle tree hash. |
|
secp256k1/internal/secp256k1
nolint:gocritic Package secp256k1 wraps the bitcoin secp256k1 C library.
|
nolint:gocritic Package secp256k1 wraps the bitcoin secp256k1 C library. |
|
xchacha20poly1305
Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha.
|
Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha. |
|
libs
|
|
|
events
Package events - Pub-Sub in go with event caching
|
Package events - Pub-Sub in go with event caching |
|
flowrate
Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream.
|
Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream. |
|
Package lite allows you to securely validate headers without a full node.
|
Package lite allows you to securely validate headers without a full node. |
|
client
Package client defines a provider that uses a rpcclient to get information, which is used to get new headers and validators directly from a Tendermint client.
|
Package client defines a provider that uses a rpcclient to get information, which is used to get new headers and validators directly from a Tendermint client. |
|
TODO: Better handle abci client errors.
|
TODO: Better handle abci client errors. |
|
Package node is the main entry point, where the Node struct, which represents a full node, is defined.
|
Package node is the main entry point, where the Node struct, which represents a full node, is defined. |
|
upnp
Taken from taipei-torrent.
|
Taken from taipei-torrent. |
|
Package privval provides different implementations of the types.PrivValidator.
|
Package privval provides different implementations of the types.PrivValidator. |
|
rpc
|
|
|
core
# Introduction Tendermint supports the following RPC protocols: * URI over HTTP * JSONRPC over HTTP * JSONRPC over websockets Tendermint RPC is built using our own RPC library which contains its own set of documentation and tests.
|
# Introduction Tendermint supports the following RPC protocols: * URI over HTTP * JSONRPC over HTTP * JSONRPC over websockets Tendermint RPC is built using our own RPC library which contains its own set of documentation and tests. |
|
lib
HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets Client Requests Suppose we want to expose the rpc function `HelloWorld(name string, num int)`.
|
HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets Client Requests Suppose we want to expose the rpc function `HelloWorld(name string, num int)`. |
|
lib/server
Commons for HTTP handling
|
Commons for HTTP handling |
|
sdk
module
|
|
|
baseapp
Package baseapp contains data structures that provide basic data storage functionality and act as a bridge between the ABCI interface and the SDK abstractions.
|
Package baseapp contains data structures that provide basic data storage functionality and act as a bridge between the ABCI interface and the SDK abstractions. |
|
client
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/client/context ALIASGEN: github.com/tendermint/classic/sdk/client/flags ALIASGEN: github.com/tendermint/classic/sdk/client/keys ALIASGEN: github.com/tendermint/classic/sdk/client/lcd ALIASGEN: github.com/tendermint/classic/sdk/client/rest ALIASGEN: github.com/tendermint/classic/sdk/client/rpc ALIASGEN: github.com/tendermint/classic/sdk/client/tx ALIASGEN: github.com/tendermint/classic/sdk/client/utils ALIASGEN: github.com/tendermint/classic/sdk/client/input
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/client/context ALIASGEN: github.com/tendermint/classic/sdk/client/flags ALIASGEN: github.com/tendermint/classic/sdk/client/keys ALIASGEN: github.com/tendermint/classic/sdk/client/lcd ALIASGEN: github.com/tendermint/classic/sdk/client/rest ALIASGEN: github.com/tendermint/classic/sdk/client/rpc ALIASGEN: github.com/tendermint/classic/sdk/client/tx ALIASGEN: github.com/tendermint/classic/sdk/client/utils ALIASGEN: github.com/tendermint/classic/sdk/client/input |
|
client/lcd/statik
Package statik contains static assets.
|
Package statik contains static assets. |
|
crypto/keys/hd
Package hd provides basic functionality Hierarchical Deterministic Wallets.
|
Package hd provides basic functionality Hierarchical Deterministic Wallets. |
|
server/mock
nolint
|
nolint |
|
simapp
Package simapp implements a full fledged Cosmos SDK application used for executing simulation test suites.
|
Package simapp implements a full fledged Cosmos SDK application used for executing simulation test suites. |
|
types/module
Package module contains application module patterns and associated "manager" functionality.
|
Package module contains application module patterns and associated "manager" functionality. |
|
types/rest
Package rest provides HTTP types and primitives for REST requests validation and responses handling.
|
Package rest provides HTTP types and primitives for REST requests validation and responses handling. |
|
version
Package version is a convenience utility that provides SDK consumers with a ready-to-use version command that produces apps versioning information based on flags passed at compile time.
|
Package version is a convenience utility that provides SDK consumers with a ready-to-use version command that produces apps versioning information based on flags passed at compile time. |
|
x/auth
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/auth/types nolint
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/auth/types nolint |
|
x/auth/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
x/auth/legacy/v0_36
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
x/auth/types
nolint noalias
|
nolint noalias |
|
x/bank
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/bank/types
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/bank/types |
|
x/crisis
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/crisis/types
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/crisis/types |
|
x/crisis/client/cli
nolint
|
nolint |
|
x/distribution
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/distribution/keeper ALIASGEN: github.com/tendermint/classic/sdk/x/distribution/types ALIASGEN: github.com/tendermint/classic/sdk/x/distribution/client
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/distribution/keeper ALIASGEN: github.com/tendermint/classic/sdk/x/distribution/types ALIASGEN: github.com/tendermint/classic/sdk/x/distribution/client |
|
x/distribution/client/cli
nolint
|
nolint |
|
x/distribution/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
x/distribution/legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
x/distribution/types
nolint nolint
|
nolint nolint |
|
x/genaccounts
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/genaccounts/internal/types Package genaccounts contains specialized functionality for initializing accounts from genesis including: - genesis account validation, - initchain processing of genesis accounts, - export processing (to genesis) of accounts, - server command for adding accounts to the genesis file.
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/genaccounts/internal/types Package genaccounts contains specialized functionality for initializing accounts from genesis including: - genesis account validation, - initchain processing of genesis accounts, - export processing (to genesis) of accounts, - server command for adding accounts to the genesis file. |
|
x/genaccounts/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
x/genaccounts/legacy/v0_36
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
x/genutil
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/genutil/types Package genutil contains a variety of genesis utility functionality for usage within a blockchain application.
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/genutil/types Package genutil contains a variety of genesis utility functionality for usage within a blockchain application. |
|
x/gov
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/gov/types nolint:deadcode unused
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/gov/types nolint:deadcode unused |
|
x/gov/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
x/gov/legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
x/gov/types
nolint
|
nolint |
|
x/mint
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/mint/internal/keeper ALIASGEN: github.com/tendermint/classic/sdk/x/mint/internal/types
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/mint/internal/keeper ALIASGEN: github.com/tendermint/classic/sdk/x/mint/internal/types |
|
x/mint/internal/keeper
nolint:deadcode unused
|
nolint:deadcode unused |
|
x/mock
Package mock provides utility methods to ease writing tests.
|
Package mock provides utility methods to ease writing tests. |
|
x/params
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/params/subspace ALIASGEN: github.com/tendermint/classic/sdk/x/params/types nolint: deadcode unused
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/params/subspace ALIASGEN: github.com/tendermint/classic/sdk/x/params/types nolint: deadcode unused |
|
x/simulation
Package simulation implements a simulation framework for any state machine built on the SDK which utilizes auth.
|
Package simulation implements a simulation framework for any state machine built on the SDK which utilizes auth. |
|
x/slashing
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/slashing/types nolint nolint:deadcode unused
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/slashing/types nolint nolint:deadcode unused |
|
x/slashing/types
nolint
|
nolint |
|
x/staking
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/staking/keeper ALIASGEN: github.com/tendermint/classic/sdk/x/staking/types ALIASGEN: github.com/tendermint/classic/sdk/x/staking/exported
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/staking/keeper ALIASGEN: github.com/tendermint/classic/sdk/x/staking/types ALIASGEN: github.com/tendermint/classic/sdk/x/staking/exported |
|
x/staking/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
x/staking/legacy/v0_36
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
x/staking/types
nolint
|
nolint |
|
x/supply
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/supply/internal/keeper ALIASGEN: github.com/tendermint/classic/sdk/x/supply/internal/types
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/tendermint/classic/sdk/x/supply/internal/keeper ALIASGEN: github.com/tendermint/classic/sdk/x/supply/internal/types |
|
x/supply/legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
test
|
|
|
tools
|
|
|
tm-monitor/eventmeter
eventmeter - generic system to subscribe to events and record their frequency.
|
eventmeter - generic system to subscribe to events and record their frequency. |
Click to show internal directories.
Click to hide internal directories.