Introduction

Colibri packages have independent versions. See [compatibility and releases](getting-started/compatibility.md) for the stability and versioning policy.

Colibri is a TypeScript toolkit for Stellar applications. Use a focused client for a common workflow, a transaction pipeline when you need to attach plugins, or an individual process when you need to control orchestration.

These guides explain how and why to use the APIs. The API and error reference links every package's generated symbol documentation and lists every declared error code by context.

Choose your task

I want to…	Start here
Install a package and submit a payment	Installation, first transaction
Read or invoke a Soroban contract	Contract tutorial, Contract client
Generate a typed contract client	Contract Bindings
Build a React application	React setup, common workflows
Choose fees, signers, and authorization	Transaction config, authorization
Adjust Soroban budgets and resource fees	Resource overrides, padding and calculation
Read current ledger state	Ledger Entries
Follow events or historical ledgers	RPC Streamer
Authenticate a wallet or contract account	WebAuth
Rebuild and compare a contract's Wasm	Build Verification
Render an account or contract identicon	Identicons
Run a disposable local ledger	Test Tooling

Packages

Install only the packages your application needs. Events, account/address helpers, ledger readers, and transaction orchestration belong to Core; the other packages provide focused capabilities.

Package	Scope
@colibri/core	Accounts, assets, contracts, signing, processes, pipelines, ledger data, and events
@colibri/contract-bindings	Typed clients, validated values and event definitions from a contract ABI
@colibri/react	Providers, wallet connections, queries and explicit transaction hooks
@colibri/rpc-streamer	Live/archive ingestion with callbacks and checkpoints
@colibri/webauth	SEP-10 and SEP-45 client authentication
@colibri/build-verification	SEP-58 and caller-supplied reproducible build verification, API and CLI
@colibri/identicon	SEP-33 SVG, PNG and image data, with extended C-address support
@colibri/plugin-fee-bump	Fee sponsorship for transaction pipelines
@colibri/plugin-channel-accounts	Reusable sponsored transaction-source accounts
@colibri/plugin-sep29	Opt-in receiving-account memo checks
@colibri/test-tooling	Docker-backed Stellar Quickstart lifecycle

How to read the guides

Start with a complete tutorial, then follow the scoped guides for configuration, failure handling, or customization. Short fragments illustrate one step; they are not independent scripts unless explicitly labeled. Placeholder secrets, contract IDs, and example domains must be supplied by your application.

The architecture guide explains the shared process → step → pipeline → client layering. The error-handling guide explains stable codes and safe diagnostics.

Resources

• Colibri source

• Runnable examples repository

• Stellar developer documentation