Auki SDK Overview
This page mirrors README.md in the auki-sdk repo (branch develop).
The repository is the source of truth.
Auki SDK lets your app sign in, find peers, and exchange data on the Auki
network. Configure and create an AukiPeer inside your existing app to get started.
Use Auki's discovery service or supply peer IDs and addresses yourself. Your app chooses which protocols to handle.
Start here
Run two peers and send a message with the Rust Echo example. For Python, Web, Swift, or Expo, see installation.
Documentation
| I want to… | Read |
|---|---|
| Sign in and choose a Domain | Authenticate |
| Use discovery or connect to a known address | Connect to a peer |
| Exchange my own messages | Use a custom protocol |
| Keep a Peer ID and stop cleanly | Manage a peer |
| Understand peers, Domains, and task handling | How networking works |
| Look up APIs, defaults, or errors | Networking reference |
| Look up SDK terminology | Glossary |
| Understand the core SDK's direction | Vision |
| Build an app with a coding agent | App-builder skill |
What are you building?
| Build | Use | Start with |
|---|---|---|
| User app, such as Web or iOS | Talk to peers with an email/password or ZITADEL user login | User authentication |
| Backend service, such as Rust or Python | Talk to peers with an App access key and secret | Service authentication |
| Compute node | Use a Posemesh runner to process eligible DMS tasks across Domains | Compute requirements |
| Robot | Use Posemesh's robot entrypoint to process DMS tasks in its assigned Domain | Robot requirements |
Compute nodes use a signing wallet and follow DDS staking requirements. SDK apps, services, and robots do not require a node wallet or stake. See apps, services, compute nodes, and robots for authentication and Domain restrictions.
Use P2P for data exchange. Submit tasks through DMS, the source of truth for task state; Posemesh runners handle execution.
Repository
| Directory | Contents |
|---|---|
core/ | Stable crates: auki-sdk, auki-p2p, auki-auth, auki-relay-booking, auki-dms |
core/bindings/ / core/examples/ | SDK bindings and networking examples |
labs/ | Experimental crates, including the optional auki-protocols and auki-urdf-fk |
labs/bindings/ / labs/examples/ | Experimental bindings and examples |
To work on the SDK, see Contributing.