docs/

directory
v0.29.0-dev0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2018 License: Apache-2.0

README

Welcome to the SDK Docs!

Welcome to the SDK docs!

cosmonaut reading the cosmos docs in space

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.
  • SDK API Reference: Godocs of the Cosmos-SDK.
  • REST API spec: List of endpoints to interract with a gaia full-node through REST.

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:

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL