bft blockchain consensus consistency cryptocurrency cryptography db distributed-systems go

History

M. J. Fromberger cf7537ea5f cleanup: Reduce and normalize import path aliasing. (#6975 ) The code in the Tendermint repository makes heavy use of import aliasing. This is made necessary by our extensive reuse of common base package names, and by repetition of similar names across different subdirectories. Unfortunately we have not been very consistent about which packages we alias in various circumstances, and the aliases we use vary. In the spirit of the advice in the style guide and https://github.com/golang/go/wiki/CodeReviewComments#imports, his change makes an effort to clean up and normalize import aliasing. This change makes no API or behavioral changes. It is a pure cleanup intended o help make the code more readable to developers (including myself) trying to understand what is being imported where. Only unexported names have been modified, and the changes were generated and applied mechanically with gofmt -r and comby, respecting the lexical and syntactic rules of Go. Even so, I did not fix every inconsistency. Where the changes would be too disruptive, I left it alone. The principles I followed in this cleanup are: - Remove aliases that restate the package name. - Remove aliases where the base package name is unambiguous. - Move overly-terse abbreviations from the import to the usage site. - Fix lexical issues (remove underscores, remove capitalization). - Fix import groupings to more closely match the style guide. - Group blank (side-effecting) imports and ensure they are commented. - Add aliases to multiple imports with the same base package name.		3 years ago
..
batch	crypto: Use a different library for ed25519/sr25519 (#6526)	3 years ago
ed25519	crypto: Use a different library for ed25519/sr25519 (#6526)	3 years ago
encoding	cleanup: Reduce and normalize import path aliasing. (#6975)	3 years ago
internal/benchmarking	crypto: API modifications (#5236)	4 years ago
merkle	Fix and clarify breaks from select cases. (#6781)	3 years ago
secp256k1	cleanup: Reduce and normalize import path aliasing. (#6975)	3 years ago
sr25519	crypto: Use a different library for ed25519/sr25519 (#6526)	3 years ago
tmhash	linter: (1/2) enable errcheck (#5064)	4 years ago
xchacha20poly1305	cleanup: Reduce and normalize import path aliasing. (#6975)	3 years ago
xsalsa20symmetric	linters: enable stylecheck (#4153)	5 years ago
CHANGELOG.md	mv go-crypto files to crypto dir	6 years ago
README.md	crypto: reword readme (#5349)	4 years ago
crypto.go	crypto: Use a different library for ed25519/sr25519 (#6526)	3 years ago
doc.go	crypto: delete unused code (#3426)	6 years ago
example_test.go	crypto: delete unused code (#3426)	6 years ago
hash.go	linter: fix nolintlint warnings (#6257)	4 years ago
random.go	remove MixEntropy (#3278)	6 years ago
random_test.go	crypto/random: Use chacha20, add forward secrecy (#2562)	6 years ago
version.go	mv go-crypto files to crypto dir	6 years ago

README.md

crypto

crypto is the cryptographic package adapted for Tendermint's uses

Importing it

To get the interfaces, import "github.com/tendermint/tendermint/crypto"

For any specific algorithm, use its specific module e.g. import "github.com/tendermint/tendermint/crypto/ed25519"

Binary encoding

For Binary encoding, please refer to the Tendermint encoding specification.

JSON Encoding

JSON encoding is done using tendermint's internal json encoder. For more information on JSON encoding, please refer to Tendermint JSON encoding

Example JSON encodings:

ed25519.PrivKey     - {"type":"tendermint/PrivKeyEd25519","value":"EVkqJO/jIXp3rkASXfh9YnyToYXRXhBr6g9cQVxPFnQBP/5povV4HTjvsy530kybxKHwEi85iU8YL0qQhSYVoQ=="}
ed25519.PubKey      - {"type":"tendermint/PubKeyEd25519","value":"AT/+aaL1eB0477Mud9JMm8Sh8BIvOYlPGC9KkIUmFaE="}
sr25519.PrivKeySr25519   - {"type":"tendermint/PrivKeySr25519","value":"xtYVH8UCIqfrY8FIFc0QEpAEBShSG4NT0zlEOVSZ2w4="}
sr25519.PubKeySr25519    - {"type":"tendermint/PubKeySr25519","value":"8sKBLKQ/OoXMcAJVxBqz1U7TyxRFQ5cmliuHy4MrF0s="}
crypto.PrivKeySecp256k1   - {"type":"tendermint/PrivKeySecp256k1","value":"zx4Pnh67N+g2V+5vZbQzEyRerX9c4ccNZOVzM9RvJ0Y="}
crypto.PubKeySecp256k1    - {"type":"tendermint/PubKeySecp256k1","value":"A8lPKJXcNl5VHt1FK8a244K9EJuS4WX1hFBnwisi0IJx"}