Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.0xkey.io/llms.txt

Use this file to discover all available pages before exploring further.

Legend: Supported — available in Phase 1 · Partial — some flows work or known field differences · Coming soon — planned, not yet productized · N/A — not exposed in the current public API

Runtime services

ComponentStatusNotes
Coordinator (activity orchestration, gRPC)SupportedOrganization / sub-org, wallet, policy, session dispatch
Registrar (tenant, proxy config, magic-link session)SupportedControl plane; coordinates with Coordinator for root org creation
Auth Proxy (POST /v1/*)Supported9 endpoints: signup, otp_init, otp_verify, otp_login, oauth2_authenticate, oauth_login, email_auth, account, wallet_kit_config
API Gateway (HTTP→gRPC, stamp forwarding)Supportedstamp_login, create_read_write_session, create_read_only_session, whoami
Dashboard Gateway + Dashboard (Next.js)PartialSession / WebAuthn baseline and ~29 pages (orgs, users, wallets, policies, activities); full hosted-console narrative not yet complete
Enclave: SignerSupportedP-256 / secp256k1 / Ed25519 signing
Enclave: PolicyPartialCEL evaluation, consensus, ETH / Solana / EIP-712 contexts; per-chain *.tx.* parity for non-EVM chains Coming soon
Enclave: NotarizerSupportedOrganization aggregate notarization (genesis / sub-org / refresh / Merkle)
Enclave: TLS FetcherSupportedExternal HTTPS (OIDC JWKS, OAuth token endpoints) with FetchProof
Enclave: Transaction ParserPartialEVM (legacy + type 1/2/3/4), Solana (legacy + V0), EIP-712. BTC / Tron / Cosmos / Aptos / Sui / Sei / TON / XRP / Stellar / Doge Coming soon
Company Wallets (co-signing, institutional automation)Coming soonPhase 1 focuses on Embedded Wallets and public API compatibility
Verifiable Cloud / TEE product (external SKU)Coming soonArchitecture chapters are illustrative

Authentication

ComponentStatusNotes
Passkey / WebAuthn + stamp_loginSupportedValidated with demo-style frontends
Google OAuth (OIDC id_token)SupportedRequires a real IdP token
Email OTPSupportedotp_init V3, otp_verify V2, otp_login V2; Resend-backed for email
SMS OTPPartialAPI paths exist (OTP_TYPE_SMS); no real SMS provider wired in Phase 1
Email auth (magic link, email_auth)SupportedDepends on mail delivery configuration
OAuth2 code exchange (non-OIDC provider)PartialEnclave paths exist; not every provider is end-to-end validated
Apple / Facebook / Discord / X social loginPartial ~ Coming soonDepends on oauthProviders and deployment
Session: read-write / read-only, credential bundle (HPKE)Supported

Public HTTP API

CategoryExamplesStatus
Auth ProxyPOST /v1/account, /v1/otp_init, /v1/otp_verifySupported
Queryget_sub_org_ids, get_wallets, get_wallet_accounts, get_userSupported
Submitcreate_sub_organization, oauth_loginSupported
Submitstamp_loginSupported (requires browser WebAuthn)
Submiteth_send_raw_transactionPartial (executor wired; broadcast is a mock — endpoint: "mock", no real RPC)
Submiteth_send_transaction, sol_send_transaction (unsigned high-level)Coming soon (executor returns an error today; raw flow is the supported path)
Submitcreate_oauth_providersPartial (returns empty provider_ids list in Phase 1)
Submitcreate_webhook_endpoint, update_webhook_endpoint, delete_webhook_endpointComing soon (no webhook RPC in public_api.proto yet)
Submitcreate_fiat_on_ramp_credential, init_fiat_on_ramp (and CRUD)Coming soon (notarize-only executor, no real on-ramp wired)
Queryget_send_transaction_status, get_on_ramp_transaction_status, get_gas_usage, get_noncesComing soon (returns empty / zero-valued response)
Querylist_fiat_on_ramp_credentialsComing soon (returns empty list — not yet backed by storage)
Queryget_policy_evaluationsPartial (Coordinator persists evaluations best-effort after a Policy ruling; data appears once a parser-backed activity has been evaluated)
Queryget_boot_proof, get_latest_boot_proof, list_app_proofsComing soon (returns empty response in Phase 1)
Queryget_balances, get_app_status (a.k.a. TVC App status)N/A (no corresponding RPC in the current public_api.proto)
Queryget_attestation_documentComing soon (stub returns empty bytes; production wiring routes through the enclave NSM)
Other activities / queriesVarious create_*, sign_*, list_*Partial / Coming soon (depends on Coordinator enablement)

Chains and curves

TopicStatusNotes
Curve: secp256k1SupportedPrimary EVM signing; BIP32 HD derivation
Curve: Ed25519SupportedSolana / Sui / Aptos signing; SLIP-0010 HD (hardened-only)
Curve: P-256SupportedWebAuthn and session keys (no HD derivation)
EVM (Ethereum L1/L2)SupportedAddress derivation, in-enclave tx parsing, EIP-712, policy contexts
Solana (SVM)PartialAddress derivation + Ed25519 signing + in-enclave parsing complete; broadcast is Coming soon (sol_send_transaction executor errors today)
Address derivation: Cosmos, Sei, Tron, Sui, Aptos, BTC variants, Doge, Stellar, TON, XRPSupportedAddress-only; signing via raw payload
Transaction parsing & policy contexts: Bitcoin, Tron, Cosmos, Aptos, Sui, Sei, TON, XRP, Stellar, Doge, etc.Coming soonNetwork and policy-example pages are placeholders
Hyperliquid, Stacks, Movement, IOTA, Tempo, SparkComing soonNo parser or address derivation yet
Fiat on-rampComing soonCredential CRUD is a no-op compatibility layer
Import / export wallets and private keysPartialSigner-side HPKE bundle path (ExportWalletExecutor etc.) wired end-to-end; Dashboard product flows still in progress

Client libraries

ItemStatusNotes
TypeScript / React packages (@0xkey-io/*)Supported@0xkey-io/react-wallet-kit, @0xkey-io/core, @0xkey-io/sdk-server; see SDK reference
Mobile / native (React Native, Flutter, Swift, Kotlin)Partial / Coming soon
Server-side (Go, Ruby, Python, Rust)Coming soon
CLI (brew install …)Coming soonInstall paths are placeholders until release

Policies, webhooks, and observability

TopicStatusNotes
Policy CRUD, defaults, post-registration async deploymentSupported
Transaction parsing and fine-grained policy conditionsPartialEVM + Solana + EIP-712 today; other chains Coming soon
get_policy_evaluations (policy-evaluation history)PartialCoordinator writes evaluations best-effort after Policy returns a ruling; visible once a parser-backed activity has run
WebhooksComing soonNo webhook RPC in public_api.proto; both endpoint CRUD and event delivery are unimplemented
QuorumOS / remote attestationComing soonQOS lives in the enclave vendor tree and release pipeline; no customer-facing public attestation HTTP yet (get_attestation_document is a stub)
Public boot-proof / TVC / app-proof queriesComing soonReturns empty response in Phase 1

Coming soon features (planned)

The following capabilities are on the roadmap but not yet available in Phase 1:
  • Company Wallets — co-signing, institutional signing automation, multi-party approvals
  • Non-EVM transaction parsing & policy — Bitcoin, Tron, Cosmos, Aptos, Sui, Sei, TON, XRP, Stellar, Doge, plus Stacks / Movement / IOTA / Hyperliquid / Tempo / Spark
  • On-chain broadcast pipeline — real RPC for eth_send_raw_transaction (currently mock) and full executors for eth_send_transaction / sol_send_transaction (currently error)
  • Cookbook integrations — Morpho, Aave, Jupiter, LiFi, 0x, Polymarket, Relay, Breeze, Yield XYZ, Base builder codes
  • Fiat on-ramp — third-party on-ramp credential flows and status tracking
  • Wallet import / export end-to-end — productized Dashboard / SDK flows on top of the existing HPKE primitives
  • OAuth provider linking — full create_oauth_providers / oauth2_authenticate provider catalog beyond Google + Apple
  • Account abstraction — gas sponsorship, smart account wallets
  • Server-side SDKs — Go, Python, Ruby, Rust
  • CLI toolingoxkey CLI for key generation and signing automation
  • Verifiable Cloud — external TEE attestation SKU
  • Webhook API + delivery — both *_webhook_endpoint activities and event streaming from Coordinator
  • Public verifiable-data surfaces — boot proofs, app proofs, attestation documents, and balance / TVC queries (get_balances, get_app_status) currently absent from public_api.proto