Welcome. This is EasyA's legendary handbook. If you want to learn Stellar like a legend, then you're in the right place.
This handbook serves as a guide to the Stellar ecosystem, geared towards those just joining for the first time. It isn't just a beginners' handbook; it's a legendary handbook. Even if you've already immersed yourself in the ecosystem, you'll find tons of helpful tidbits around here!
Of course, the best place to start is always the EasyA app! Download it here for the fastest and most fun way to learn about Stellar. Download it directly right here!
- Introduction
- Getting Started
- Core Concepts
- Development Tools
- Smart Contracts
- Stellar Network
- Ecosystem Projects
- Resources
- Handy Code Snippets
- Contributing
What is Stellar:
- Stellar Overview - An introduction to Stellar's mission of creating an open and affordable financial system for all.
The no-fluff starter:
- Official Stellar documentation - Comprehensive documentation covering all aspects of building on Stellar, from basic concepts to advanced integrations.
- Stellar 101 - A beginner-friendly guide to understanding Stellar's key features and use cases.
Explanation of fundamental concepts in the Stellar ecosystem:
- Stellar Consensus Protocol (SCP) - The original whitepaper detailing Stellar's unique approach to consensus.
- Stellar Assets and Anchors - A video explaining how assets are created and managed on the Stellar network, and the role of anchors in the ecosystem.
Key tools and environments for Stellar:
- Stellar Laboratory - An interactive webapp for creating and testing Stellar transactions and operations.
- Stellar SDKs - Official tools/SDKs for various programming languages to interact with the Stellar network.
- Horizon API - The REST API that serves as the interface between Stellar Core and applications that want to access the Stellar network.
How to write and deploy smart contracts on Stellar:
- Stellar Smart Contracts - An overview of Stellar's approach to smart contracts, focusing on simplicity and safety.
- Stellar Smart Contract Tutorial - A practical guide to implementing simple smart contracts on Stellar.
Going into the network level:
- Stellar Dashboard - A real-time view of Stellar network statistics, including ledger closures, fee stats, and lumen distribution.
- StellarExpert - A comprehensive block explorer and analytics platform for the Stellar network.
- Stellar Status Updates - Current operational status of various Stellar services and APIs.
Cool projects built on Stellar:
- SatoshiPay - A platform enabling content monetization and micropayments using Stellar.
Extra stuff:
- Stellar Community Blog - A collection of articles from community members covering various aspects of the Stellar ecosystem.
- Stellar Developers Blog - Official blog posts from the Stellar Development Foundation, focusing on technical updates and developer resources.
Get a taste of Stellar development with these code snippets:
const StellarSdk = require('stellar-sdk');
const server = new StellarSdk.Server('https://horizon-testnet.stellar.org');
// Create a completely new and unique pair of keys
const pair = StellarSdk.Keypair.random();
console.log('Secret key:', pair.secret());
console.log('Public key:', pair.publicKey());
(async function createAccount() {
try {
const response = await fetch(
`https://friendbot.stellar.org?addr=${encodeURIComponent(pair.publicKey())}`
);
const responseJSON = await response.json();
console.log("SUCCESS! You have a new account :)\n", responseJSON);
} catch (e) {
console.error("ERROR!", e);
}
})();const StellarSdk = require('stellar-sdk');
const server = new StellarSdk.Server('https://horizon-testnet.stellar.org');
// Keys for accounts to issue and receive the payment
const sourceSecretKey = 'SCZANGBA5YHTNYVVV4C3U252E2B6P6F5T3U6MM63WBSBZATAQI3EBTQ4';
const destinationId = 'GA2C5RFPE6GCKMY3US5PAB6UZLKIGSPIUKSLRB6Q723BM2OARMDUYEJ5';
// Transaction will hold a built transaction we can resubmit if the result is unknown.
let transaction;
(async function main() {
// Transactions require a valid sequence number that is specific to this account.
// We can fetch the current sequence number for the source account from Horizon.
const account = await server.loadAccount(sourceSecretKey);
// Right now, there's one function that fetches the base fee.
// In the future, we'll have functions that are smarter about suggesting fees,
// e.g.: `fetchBaseFee` or `recommendFee`.
const fee = await server.fetchBaseFee();
transaction = new StellarSdk.TransactionBuilder(account, {
fee,
networkPassphrase: StellarSdk.Networks.TESTNET
})
.addOperation(StellarSdk.Operation.payment({
destination: destinationId,
// Make a payment in XLM
asset: StellarSdk.Asset.native(),
amount: "10"
}))
// Wait a maximum of three minutes for the transaction
.setTimeout(180)
.build();
// Sign the transaction to prove you are actually the person sending it.
transaction.sign(StellarSdk.Keypair.fromSecret(sourceSecretKey));
try {
const transactionResult = await server.submitTransaction(transaction);
console.log(JSON.stringify(transactionResult, null, 2));
console.log('\nSuccess! View the transaction at: ');
console.log(transactionResult._links.transaction.href);
} catch (e) {
console.log('An error has occurred:');
console.log(e);
}
})();These examples showcase:
- How to create a new Stellar account on the testnet.
- How to send a payment on the Stellar network.
We welcome contributions to make this handbook even more legendary! Here's how you can contribute:
- Fork the repository
- Create a new branch (
git checkout -b feature/amazing-addition) - Make your changes
- Commit your changes (
git commit -am 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-addition) - Create a new Pull Request
Please ensure your contributions align with our code of conduct and contribution guidelines.
This handbook was inspired by the famous awesome lists by sindresorhus and the Awesome Stellar list. We need awesome lists for Web3 ecosystems, with more of a hacker's guide to how they work. This is the answer to that need.