This is the authoritative guide to all things Stellar. Here, you will find helpful tutorials, guides for deploying infrastructure, a glossary of common terms, and more! The documentation is designed to be modular, organized around different learning paths that expand as network use cases evolve.
In addition to the docs here, you’ll also see a link at the bottom of the left nav to the API Reference. You should check those out, too: that’s a resource most developers consult as they build on Stellar.
As you read through these docs, you may find bugs, errors, typos, or omissions. When you do, please file PRs or issues in this repo. Like the Stellar codebase, the docs are open source, so we welcome and appreciate your contributions!
A rundown of what’s here:
If you’re new to Stellar and want to get an overview of the network, this is where to start. The early tutorials will show you how to do some basic things like create an account and make payments. The later tutorials cover more advanced topics like Stellar smart contracts. If you want to issue an asset or build an app, you’re better served checking the sections dedicated to those paths.Read More
Stellar is a multi-currency network by design. The ability to issue assets is fundamental to Stellar, and it’s something you can do quickly, safely, and in a few lines of code. Once you’ve issued an asset, you can also publish canonical information about it for wallets and consumers, control access to it by setting simple flags, and make it available for trade on the Stellar decentralized exchange. This section will show you how.Read More
Organizations can connect assets issued on Stellar with external banking and payment systems, allowing users and businesses to transfer assets onto or through the Stellar network. Specifically, organizations can anchor assets issued on the Stellar network by facilitating 1-1 trades for the off-chain representation of the tokenized asset.
For example, a USD anchor could accept $1000 USD from a customer’s wire transfer and send 1000 USDX tokens to the customer’s Stellar account. Conversely, another customer could send USDX tokens to the anchor on Stellar and expect an incoming $1000 USD wire transfer from the anchor. These kinds of deposit and withdrawal operations are facilitated by wallet applications and SEP-24 anchor servers.Read More
Anchors can also facilitate payments made through Stellar instead of simply on Stellar.
For example, a customer could want to send \$1000 USD worth of EUR to a friend’s bank account in Germany. Anchor A could collect the sending and receiving customer’s information, make a USD->EUR path payment on Stellar to Anchor B (in Germany), and Anchor B could deposit the funds into the recipent’s bank account.Read More
Stellar is a self-serve distributed ledger that you can use as a backend to power all kinds of apps and services. Any app built on Stellar relies on the same basic functions: key storage, account creation, transaction signing, and queries to the Stellar database. This section of the docs will walk you through the process of building a basic wallet that does all those things, and will show you how to add features to it like the support for in-app deposits and withdrawals from anchors.Read More
This section explains the technical and operational aspects of installing, configuring, and maintaining a Stellar Core node, which is a server that connects to the Stellar peer-to-peer network to keep a common distributed ledger. You don’t have to run a node to get started on Stellar, but you will likely want to if you’re in production, need high-availability access network, or want to help increase network health and decentralization.Read More
Most developers access the network using Horizon, the Stellar API. It takes the performance-oriented data structures from Stellar Core and converts them into a friendlier format. If you’re running your own Stellar Core node and using it to submit transactions or get network data, you will likely also want to run your own Horizon instance, and this section will show you how. If you’re just looking to use Horizon (vs. setting up a Horizon server), consult the API Reference.Read More
This is where you’ll find all the Stellar SDKs. There are a lot of them, and they’re all pretty well maintained and documented, so you should be able to build on Stellar in your language of choice. This section is also home to some tools and reference implementations created and maintained by the Stellar Development Foundation to kickstart development.Read More
This section defines all the terms and explains all the concepts germane to Stellar. Use it to look up a word, or to dig deeper into nitty-gritty details.Read More
Last updated Nov. 18, 2021