# Oynk

> Oynk cross-border settlement architecture, product capabilities, blockchain indexing, and Stellar/Soroban roadmap.

## Docs

- [Oynk documentation](https://docs.oynk.io/index.md): Understand Oynk's cross-border settlement architecture, current platform, blockchain visibility plane, and planned Stellar/Soroban protocol.
- [Current implementation status](https://docs.oynk.io/get-started/current-status.md): A precise boundary between implemented Oynk capabilities, partial foundations, and proposed Stellar/Soroban work.
- [Quickstart](https://docs.oynk.io/get-started/quickstart.md): Run the Oynk monorepo and Mintlify documentation locally.
- [Glossary](https://docs.oynk.io/get-started/glossary.md): Terms used throughout the Oynk platform and settlement architecture.
- [How Oynk works](https://docs.oynk.io/concepts/overview.md): A holistic view of Oynk's coordination, execution, settlement, and visibility layers.
- [Participants and responsibilities](https://docs.oynk.io/concepts/participants.md): The actors in an Oynk route and the trust placed in each one.
- [Payment lifecycle](https://docs.oynk.io/concepts/payment-lifecycle.md): The proposed end-to-end cross-border payment lifecycle and exception paths.
- [Value and metric semantics](https://docs.oynk.io/concepts/value-and-metrics.md): How Oynk treats exact amounts and distinguishes movement from settlement.
- [System design](https://docs.oynk.io/architecture/system-design.md): Oynk's monorepo, runtime services, package ownership, and target settlement architecture.
- [Trust boundaries](https://docs.oynk.io/architecture/trust-boundaries.md): Credentials, evidence, policy, provider, chain, and reporting boundaries in Oynk.
- [Data model](https://docs.oynk.io/architecture/data-model.md): Implemented PostgreSQL records and the records required by the future payment and Soroban control plane.
- [Stellar and Soroban architecture](https://docs.oynk.io/stellar-soroban/overview.md): Why Oynk targets Stellar/Soroban and how it fits into the broader cross-border settlement system.
- [Settlement contract design](https://docs.oynk.io/stellar-soroban/settlement-contract.md): A proposed Soroban settlement state machine, records, transitions, and events.
- [Smart accounts and authorization](https://docs.oynk.io/stellar-soroban/smart-accounts.md): The planned Soroban smart-account boundary for passkeys, delegates, spending limits, nonces, and recovery.
- [Stellar asset and payment model](https://docs.oynk.io/stellar-soroban/asset-and-payment-model.md): How Stellar assets, trustlines, contract token interfaces, fees, and finality would enter an Oynk route.
- [Soroban security and operations](https://docs.oynk.io/stellar-soroban/security.md): Threats, controls, audit gates, upgrade policy, and monitoring required before Oynk uses Soroban with funds.
- [Accounts and access](https://docs.oynk.io/platform/accounts-and-access.md): Implemented identity, organizations, sessions, OTP, roles, and platform modes.
- [Compliance architecture](https://docs.oynk.io/platform/compliance.md): Current business verification support and future corridor-specific compliance gates.
- [Provider network](https://docs.oynk.io/platform/provider-network.md): How settlement and liquidity providers would be onboarded, assigned, measured, suspended, and replaced.
- [Operations console](https://docs.oynk.io/platform/operations-console.md): Connected console capabilities and intentionally unconnected product destinations.
- [Indexing pipeline](https://docs.oynk.io/infrastructure/indexing.md): How Oynk schedules, indexes, stores, pairs, and reports blockchain activity.
- [BNB Smart Chain indexing](https://docs.oynk.io/infrastructure/bsc.md): ERC-20 log ingestion, confirmation depth, adaptive ranges, replay, and supported BSC assets.
- [Solana indexing](https://docs.oynk.io/infrastructure/solana.md): Tracked owners and token sources, parsed balances, deterministic identity, and current Solana limitations.
- [Reliability and observability](https://docs.oynk.io/infrastructure/reliability.md): Replay safety, checkpoints, failure records, health endpoints, scaling, and disaster recovery.
- [Configuration](https://docs.oynk.io/operations/configuration.md): Environment variables for the API, applications, authentication, email, and indexers.
- [Operations runbook](https://docs.oynk.io/operations/runbook.md): Commands for migrations, synchronization, audits, targeted repairs, and validation.
- [Deployment](https://docs.oynk.io/operations/deployment.md): A production topology for web, console, API, workers, PostgreSQL, RPC providers, and Mintlify.
- [Production readiness](https://docs.oynk.io/operations/production-readiness.md): The minimum operational, security, payment, provider, and Soroban gates for production.
- [HTTP API overview](https://docs.oynk.io/reference/http-api.md): Current public, authenticated, and operational API boundaries.
- [Repository map](https://docs.oynk.io/reference/repository.md): Where Oynk's shared contracts, backend logic, frontends, documentation, tests, and migrations live.
- [Roadmap](https://docs.oynk.io/reference/roadmap.md): Phased work from the current visibility plane to a production Oynk payment and Soroban settlement system.
- [Get aggregate settlement metrics, timeline, and recent transactions](https://docs.oynk.io/api-reference/get-aggregate-settlement-metrics-timeline-and-recent-transactions.md)
- [Get in-process synchronization status](https://docs.oynk.io/api-reference/get-in-process-synchronization-status.md)
- [Start manual synchronization](https://docs.oynk.io/api-reference/start-manual-synchronization.md): Administrator-only and rate limited. Work continues asynchronously.
- [Get current synchronization status](https://docs.oynk.io/api-reference/get-current-synchronization-status.md)
- [List recent synchronization runs](https://docs.oynk.io/api-reference/list-recent-synchronization-runs.md): Operational endpoint; restrict at the deployment boundary.
- [Get synchronization run](https://docs.oynk.io/api-reference/get-synchronization-run.md): Operational endpoint; restrict at the deployment boundary.
- [List unresolved indexing failures](https://docs.oynk.io/api-reference/list-unresolved-indexing-failures.md): Operational endpoint; restrict at the deployment boundary.
- [Process liveness](https://docs.oynk.io/api-reference/process-liveness.md)
- [Configuration and database readiness](https://docs.oynk.io/api-reference/configuration-and-database-readiness.md)
- [Full technical architecture](https://docs.oynk.io/full-technical-architecture.md): A consolidated technical review of Oynk's implemented web platform, blockchain visibility plane, and proposed Stellar/Soroban settlement architecture.

## OpenAPI Specs

- [openapi](https://docs.oynk.io/reference/openapi.yaml)