History

Dev Ojha a31dc20e6a Merge PR #2990 : Update f1 spec * Update f1 spec: * Improves exposition of the base scheme * Fix inflation section / add sketch of how to do it * Add future work section I've also realized that using the ideas of the inflation section, we could even remove the iteration over slashes when withdrawing! (Note, inflation section equations / proof of correctness has not been thoroughly transcribed from my head onto paper, so its not guaranteed to be correct at the moment. However the inflation section of this describes something separate from inflation in the hub. It has inflation happen by having each staked token produce more staked tokens, instead of having it come through block rewards. This inflation can also happen per validator, so as to enable non-signing validators to not get inflation) * Fix grammar Co-Authored-By: ValarDragon <ValarDragon@users.noreply.github.com> * Add proof of correctness to the inflation section * Re-update PDF after merging chris' fixes * address more of @cwgoes' suggestions		2018-12-12 13:13:53 +01:00
..
_attic	Run make format	2018-12-10 14:27:25 +00:00
.vuepress	docs: add tutorial to sidebar (#2865 )	2018-12-03 08:23:49 -08:00
architecture	Documentation Structure Change and Cleanup (#2808 )	2018-11-14 11:44:17 -08:00
clients	deleted obsolete file (#2817 )	2018-11-14 14:32:41 -08:00
examples	Run make format	2018-12-10 14:27:25 +00:00
gaia	make sidebar titles nicer	2018-12-11 12:12:29 -05:00
intro	Add Safety Measures to Coin/Coins (#2797 )	2018-11-20 01:22:35 -08:00
modules	add links for modules and clients	2018-06-29 01:59:52 -04:00
reference	Merge reference/baseapp and spec/baseapp/WIP_abci_application.md	2018-11-20 20:23:09 -08:00
spec	Merge PR #2990 : Update f1 spec	2018-12-12 13:13:53 +01:00
cosmos-docs.jpg	Documentation Structure Change and Cleanup (#2808 )	2018-11-14 11:44:17 -08:00
cosmos-sdk-image.png	Bring back banner (#2814 )	2018-11-14 12:01:59 -08:00
DOCS_README.md	Update contributing.md with new merge policy (#2789 )	2018-11-14 13:12:03 -08:00
PRIORITIES.md	Merge PR #2642 : Add todo diagrams	2018-10-31 12:07:06 +01:00
README.md	Improve testnet docs (#2928 )	2018-12-01 09:54:59 -08:00
RELEASE_PROCESS.md	Suggest opening pending PR back to develop	2018-09-07 01:04:58 +02:00
RELEASE_TEST_SCRIPT.md	update release test script links, closes #2606	2018-12-11 14:40:25 -05:00

README.md

Welcome to the SDK Docs!

Welcome to the SDK docs!

Learn the SDK

SDK Intro

If you are a newcomer and would like to learn more about the Cosmos SDK, this intro is a good starting place.

SDK tutorial

If you like to learn by doing, you can follow the SDK application tutorial. It showcases how to build an SDK-based blockchain from scratch, and teaches you about the basic principles the SDK in the process.

Use the SDK

The following sections contain the information you need if you want to build a fully-functional SDK-based blockchain:

Note

: We are currently working on improving the docs. Some info might be missing. If that is the case, try the Cosmos Forum. Failing that, open an issue.

Introduction: Contains introductory high-level material on the Cosmos SDK.
Gaia: Contains all documentation related to the gaia application (current name for the Cosmos-Hub). Also contains info on how to join gaia testnets.
Clients: Documentation about SDK clients like the SDK Command-Line interface and the SDK Light-client.
Specifications: Contains SDK and modules specifications.

If you are reading this on the Cosmos Website, please know that you can find more information on github. Also if you find any issues with the documentation please open a Pull Request, or at least open an Issue to update the docs!

Cosmos Hub testnet

To install the latest version of the gaia application (application of the Cosmos Hub) and join the public testnet, click here

To start your own gaia testnet, click here

Contribute

See this file for details of the build process and considerations when making changes.

Version

This documentation is built from the following commit: