> For the complete documentation index, see [llms.txt](https://fifo-docs.gitbook.io/colibri/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fifo-docs.gitbook.io/colibri/colibri-core/overview.md).

# Overview

`@colibri/core` is Colibri's foundation: transaction orchestration, account and contract and native asset clients, exchange offers, liquidity pools, signing, current ledger reads, historical parsing, and events.

```sh
deno add jsr:@colibri/core
```

For a first working integration, use the [Testnet payment tutorial](/colibri/getting-started/quick-start.md) or [contract tutorial](/colibri/getting-started/contract-call.md). They include setup and explain what runs locally and what reaches the network.

## Choose a layer

| Layer    | Use it when                                                                         | Guide                                                                                                                                                                                                              |
| -------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Client   | You want explicit contract, asset, offer, or pool actions through an owned pipeline | [Contract](/colibri/colibri-core/contract.md), [StellarAsset](/colibri/colibri-core/asset/stellar-asset.md), [SDEX](/colibri/colibri-core/sdex.md), [NativeLiquidityPool](/colibri/colibri-core/liquidity-pool.md) |
| Pipeline | You want a complete transaction flow and plugin attachment points                   | [Pipelines](/colibri/colibri-core/pipelines.md)                                                                                                                                                                    |
| Step     | You are composing a workflow and need stable IDs and Conv context                   | [Steps](/colibri/colibri-core/steps.md)                                                                                                                                                                            |
| Process  | You need one operation such as building, simulating, or signing                     | [Processes](/colibri/colibri-core/processes.md)                                                                                                                                                                    |
| Helpers  | You need values, conversions, keys, or local validation                             | [Shared helpers](/colibri/colibri-core/helpers.md)                                                                                                                                                                 |

Clients build on pipelines; pipelines compose steps; steps wrap processes. Plugins target explicit pipeline/step IDs. Using a low-level process does not automatically execute the surrounding validation, signing, or submission flow.

## Values and configuration

* [Network](/colibri/colibri-core/network.md) — network identity, endpoints, and explicit providers.
* [Accounts](/colibri/colibri-core/account.md), [addresses](/colibri/colibri-core/address.md), and [StrKeys](/colibri/colibri-core/strkeys.md) — distinguish account identity, muxed addresses, and signer capabilities.
* [Signers](/colibri/colibri-core/signer.md) and [authorization](/colibri/colibri-core/authorization.md) — envelope signing versus Soroban authorization entries, including delegation.
* [SEP-53 message signing](/colibri/colibri-core/signer/message-signing.md) — an optional capability, separate from either transaction authorization path.
* [Transaction config](/colibri/colibri-core/transaction-config.md) — sources, fee modes, signers, timebounds, and simulation-related parameters.
* [Transaction resources](/colibri/colibri-core/transaction-config/resources.md) — final simulation overrides, padding, network settings and explicit fee calculation.
* [Assets](/colibri/colibri-core/asset.md) — native account actions, canonical identifiers, and SAC/SEP-41 contract clients.
* [SDEX](/colibri/colibri-core/sdex.md) — known-offer lifecycle and exact, unit-labelled price helpers.
* [Native pools](/colibri/colibri-core/liquidity-pool.md) — state reads, explicit pool-share trustlines, deposits, and withdrawals; no automatic tolerance selection.
* [Claim predicates](/colibri/colibri-core/claimable-balance-predicates.md) — static native predicates for explicit conditional claim transactions.
* [SEP-1 discovery](/colibri/colibri-core/sep1.md) — TOML parsing and service discovery.

## Read data without constructing a write transaction

[Ledger Entries](/colibri/colibri-core/ledger-entries.md) reads current typed state through RPC. [Ledger Parser](/colibri/colibri-core/ledger-parser.md) interprets historical ledger/transaction XDR. [Contract.read](/colibri/colibri-core/contract/invocation.md) simulates a contract method without submitting a transaction. These are different operations with different freshness and authorization implications.

[Events](/colibri/colibri-core/overview-1.md) normalizes emitted data; filters and templates help select and decode it. Use [RPC Streamer](/colibri/colibri-rpc-streamer/rpc-streamer.md) for continued ingestion and [TOIDs](/colibri/colibri-core/toid.md) for historical operation locations.

## Errors and API reference

See [handling errors](/colibri/colibri-core/error.md) before adding retries. A local build, a simulation, and confirmed submission are different stages; a generic retry after a submission timeout can create a second operation.

The [module map](/colibri/reference/reference.md#core-module-map) covers the public families, and the [JSR API](https://jsr.io/@colibri/core/doc) provides exact types, overloads, and symbols. Core's `xdr` export is a helper namespace; use the underlying Stellar SDK's `xdr` for XDR classes.