DocumentationGlossary
DOCS

Glossary

Shared vocabulary: the roles, the platform and architecture terms, and the iGaming domain terms - each mapped to where it lives in the code.

Introduction

Shared vocabulary for the platform: the roles (who's who), the platform and architecture terms, and the iGaming domain terms.

The word user is ambiguous in iGaming

In most iGaming UIs, "user" means the gambler. Here we avoid the bare word. Operator or consumer is the developer or company that installs the packages and builds an iGaming. Player is the gambler who registers, deposits, and plays.

Roles

TermWho it is
Operator / consumerThe developer or company that installs @openora/core and runs their own iGaming. The end user of the package, not a gambler. Brings their own extensions.config.ts and vendor adapters.
PlayerThe person who registers on an operator's site, deposits funds, and plays. The operator's customer.
Admin / backoffice userOperator staff who manage players, approve withdrawals, configure games, and edit content. A role on the auth user, not a separate person type.
Maintainer / core contributorSomeone working on the framework itself - distinct from an operator who only consumes it.

Platform and architecture

TermMeaningMaps to
HeadlessThe platform ships backend only - modules, contracts, API, and an SDK consumption surface. The operator supplies the entire frontend.@openora/core/react
ModuleA business domain packaged as an independently loadable unit. Never imports another module's internals.packages/core/src/<domain>/<module>/
DomainA grouping of related modules sharing one subpath. Nine of them ship.@openora/core/<domain>
Plugin / overlayA drop-in unit that adds or overrides behavior via definePlugin({ id, register }). The only way new functionality enters the system.extensions/*
Adapter / portThe vendor-agnostic interface a module depends on, plus its per-vendor implementations. The swap seam: a module declares the interface and a DI token; an operator binds a concrete impl.@openora/core/contracts + <module>/adapters/<vendor>/
ContractThe composed oRPC router. Drives request validation, the typed client, and the emitted OpenAPI spec.@openora/core/contracts
Command portA synchronous, transactional interface one module exposes so another can mutate it atomically inside the caller's own tx.WALLET_COMMANDS
Sealed tokenA SealedToken<T> whose backing service an operator may never override - RG enforcement, KYC writes, AML/SAR, ledger writes, RNG. Structurally incompatible with Token<T>, and rejected at bind time by the plugin host.@openora/core/compliance
OutboxA table an event envelope is written to inside the emitting transaction, so a durable broker can publish it after commit, at least once.event_outbox
Platform configOperator-editable, Zod-validated YAML or JSON consumed at boot. Controls feature flags, brands, and responsible-gaming defaults per geo.loadPlatformConfig()
ScaffoldA deterministic code-mod that stamps a module, plugin, route or adapter skeleton.pnpm gen
MCP dev serverA stdio tool server agents connect to for read-only inspection and scaffolding.apps/mcp-server-dev
RGSRemote Gaming Server: the engine that runs rounds, applies RTP, and settles bets. Third-party, or your own.gaming module + GAME_ADAPTER

Identity and compliance

TermMeaningMaps to
KYCKnow Your Customer. Verifying a player's identity - ID, selfie, proof of address - usually via a third party, before withdrawals above a threshold.identity / KYC_ADAPTER
AMLAnti-Money Laundering. Controls and monitoring to detect laundering through play: limits, source-of-funds, suspicious-activity flags.compliance
2FATwo-factor authentication (TOTP) on a player or admin account.identity
Geo-blockingRefusing service from restricted jurisdictions based on IP or region.compliance / GEO_IP_ADAPTER
JurisdictionThe regulatory regime an operator runs under. Dictates allowed countries, game rules, RG requirements, and reporting.operator concern

Wallet and payments

TermMeaningMaps to
WalletA player's balance plus the append-only log of money movements.wallet module
BalanceSpendable funds, shown in real time. May differ from pending.wallet
Deposit / withdrawalMoney in, money out, in fiat or crypto.wallet
PSPPayment Service Provider - a fiat payment vendor integrated behind an adapter.wallet / PAYMENT_ADAPTER
Idempotency keyA key carried on a money-path write, unique per wallet, so a retried webhook applies once.wallet_transaction
ChargebackA reversed card payment a player disputes with their bank. A fraud and risk concern.operator concern

Games and fairness

TermMeaningMaps to
Game providerA studio or vendor supplying games, integrated behind an adapter.gaming / GAME_ADAPTER
AggregatorA single integration that fans out to many game providers' catalogues.AGGREGATOR_ADAPTER
Game roundOne play cycle: bet, result, settle.gaming
LobbyThe browsable surface of games: categories, featured slots, search.lobby
RTPReturn To Player - the long-run percentage of stakes a game pays back. The complement is the house edge.game config
Provably fairA scheme letting players verify a result wasn't tampered with: a server seed is committed before the round, combined with a client seed and a nonce, then revealed.gaming (foundation)

Responsible gaming

TermMeaningMaps to
Responsible gaming (RG)Player-protection features required by most regulators.compliance
Deposit / loss / wager limitsPlayer-set or mandated caps over a period.compliance
Cool-offA short, self-imposed break from play.compliance
Self-exclusionA player blocking themselves from play for a set period.compliance

Content, social and business

TermMeaningMaps to
CMSOperator-managed static pages and banners: terms, FAQ, promos.cms module
NotificationsIn-app and email events: deposit confirmed, withdrawal status.notifications
ChatGlobal and in-room messaging with user blocks, pushed over SSE.chat module
VIP tiersLoyalty levels granting perks based on activity. A consumer extension, not core.your overlay
AffiliateA partner who refers players for a revenue share. Not core.operator concern
GGR / NGRGross and Net Gaming Revenue - stakes minus wins; NGR also nets bonuses and fees. The core operator KPI.analytics
Updated 1 month ago