Osmosis Documentation
Osmosis is the cross-chain DEX and liquidity hub. Whether you want to understand how the protocol works, connect your app or assets, build on the chain, or run a node, these docs cover it. Use the sections below to find your path, or jump straight in.
Learn
What is Osmosis?
Osmosis is the premier cross-chain DEX and DeFi hub for the Cosmos ecosystem and beyond. Start here for the concepts behind the protocol.
The OSMO Token
Tokenomics, staking, governance, and fees of the OSMO token.
Get Started
Connect a wallet and make your first trade on Osmosis.
Features
Concentrated liquidity, the fee market, fee abstraction, ProtoRev, and more.
Glossary
Definitions for the DeFi and Cosmos terms used throughout the docs.
Integrate
List an Asset
The end-to-end workflow for bringing a token to Osmosis: connect over IBC, register, source liquidity, create a pool, and add incentives.
Endpoints
Public RPC, REST, gRPC, and SQS infrastructure for mainnet and testnet.
Feature Integrations
Integrate against concentrated liquidity, alloyed assets, and smart accounts.
Swap Integration
Get a routed quote from SQS, build the swap message, and broadcast it.
Prices and Oracles
Get a USD or spot price for an asset, and when to use each source.
Build
Install osmosisd
Minimum specs, installation, building from source, and the osmosisd command reference. The starting point for chain development.
Key Management
Manage keys via the CLI, including multisig wallets.
Local Testing
Spin up a containerized LocalOsmosis chain to develop against.
Chain Development
Specifications for every x/ module: messages, state, and parameters.
CosmWasm
Write, deploy, and interact with CosmWasm smart contracts on Osmosis.
🖥 Frontend & SDKs
TypeScript and JavaScript libraries for building on Osmosis.
Osmosis Frontend
Architecture of the app.osmosis.zone web interface.
OsmoJS
Compose and broadcast Osmosis and Cosmos messages, with proto and amino encoding handled for you.
Telescope
TypeScript transpiler for Cosmos protobufs, used to generate chain libraries.
CosmosKit
A wallet adapter for React with mobile WalletConnect support for the Cosmos ecosystem.
Osmosis-Labs Math
NPM package with math functions for the Osmosis AMM, useful for estimating state changes.
Osmosis-Labs Pools
NPM package defining the pool interface and routing logic for the Osmosis DEX.
Validate
Running a Node on Mainnet
Sync and run a full Osmosis node on mainnet, the foundation for validating and relaying.
Install osmosisd
Minimum specs and installation for the osmosisd binary.
Validating on Mainnet
Create a validator and go live on mainnet.
Using TMKMS
Production key security for a validator with the Tendermint KMS.
Relayer Guide
Run IBC relaying infrastructure (Hermes) between Osmosis and other chains.
