EnakGame phases 1-8 of docs/tasks-enakgame.md (EG-101 to EG-803), built on the existing EnakPoint/EnakCoin wallet (docs/rfc-enakgame.md). Foundation (phase 1) - Migrations 000103-000106: games extended with organization, slug, status, entry cost and result rules, old games archived (not deleted); budgets, versioned reward configs, sessions and session rewards; the ledger types GAME_SPEND_REFUND, GAME_REWARD and REWARD_REDEEM_REFUND; audit_logs. - AuditLogger writes in the caller's transaction only. - enakgame.limit.user_daily and global_daily organization settings. Games and sessions (phases 2-4) - Admin /marketing/enakgame: games, reward config versions (immutable but for status, one ACTIVE per game), budgets with non-overlapping global periods and a daily job opening the next month. - Customer /customer/enakgame: start (Idempotency-Key, entry cost and config frozen on the session), complete (result validation, reward engine, max_reward cap, daily limits via game_reward_counters, one GAME_REWARD per budget), automatic refunds for system errors and deactivated games, and a session job. - Reward engine: FIXED, SCORE_BASED, OUTCOME_BASED, PROBABILITY (crypto/rand), rounded down. Vouchers and budgets (phases 5-6) - Migration 000108 and 000107: vouchers, codes, redemptions, cost attribution; Economy Guard counters. - STATIC and CODE_POOL redemption in one transaction with the REDEEM PIN action; realized cost traced through the lots to the budget that paid the reward. - Budget metrics: realized cost, forecast, exposure and status. Migrations 000109-000110 add the wallet_lots indexes they need, built CONCURRENTLY. Events (phase 7) - Migration 000111: game events, each with its own EVENT budget. Event extras stack per PRD §16 defaults, with event and per-customer limits. External vouchers (phase 8) - VoucherProvider contract, two-step PENDING redemption and a recovery job, tested with a fake provider. No provider adapter is registered yet, so EXTERNAL vouchers stay out of the catalog. Not yet decided before release: reward rounding, event stacking, budget exhaustion policy and thresholds (RFC §19.2). Migrations 000103-000111 have not been run on any shared database. Also fixes a leftover PAYMENT filter in a wallet test and a data race in a test PIN fake. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
101 lines
3.9 KiB
Go
101 lines
3.9 KiB
Go
package constants
|
|
|
|
// Loyalty setting keys (docs/prd-point-coin.md F1, F2, F12). Outlet keys live in
|
|
// outlet_settings and organization keys in organization_settings. A key that was
|
|
// never set takes the default in the PRD.
|
|
|
|
// Per outlet (F1): what an order earns.
|
|
const (
|
|
LoyaltyPointEnabledKey = "loyalty.point.enabled"
|
|
LoyaltyPointEarnModeKey = "loyalty.point.earn_mode"
|
|
LoyaltyPointEarnPercentKey = "loyalty.point.earn_percent"
|
|
LoyaltyPointEarnPerAmountKey = "loyalty.point.earn_per_amount"
|
|
LoyaltyPointEarnValueKey = "loyalty.point.earn_value"
|
|
LoyaltyPointMinOrderAmountKey = "loyalty.point.min_order_amount"
|
|
LoyaltyPointMaxPerOrderKey = "loyalty.point.max_per_order"
|
|
|
|
LoyaltyCoinEnabledKey = "loyalty.coin.enabled"
|
|
LoyaltyCoinEarnModeKey = "loyalty.coin.earn_mode"
|
|
LoyaltyCoinEarnPercentKey = "loyalty.coin.earn_percent"
|
|
LoyaltyCoinEarnPerAmountKey = "loyalty.coin.earn_per_amount"
|
|
LoyaltyCoinEarnValueKey = "loyalty.coin.earn_value"
|
|
LoyaltyCoinMinOrderAmountKey = "loyalty.coin.min_order_amount"
|
|
LoyaltyCoinMaxPerOrderKey = "loyalty.coin.max_per_order"
|
|
)
|
|
|
|
// Per organization (F2, F12): the value of EnakPoint, the exchange rate, transfers and
|
|
// expiry, which must be the same in every outlet.
|
|
const (
|
|
LoyaltyPointValueKey = "loyalty.point.value"
|
|
|
|
LoyaltyExchangeCoinAmountKey = "loyalty.exchange.coin_amount"
|
|
LoyaltyExchangePointAmountKey = "loyalty.exchange.point_amount"
|
|
|
|
LoyaltyTransferEnabledKey = "loyalty.transfer.enabled"
|
|
LoyaltyTransferMinAmountKey = "loyalty.transfer.min_amount"
|
|
LoyaltyTransferMaxPerTransactionKey = "loyalty.transfer.max_per_transaction"
|
|
LoyaltyTransferDailyLimitKey = "loyalty.transfer.daily_limit"
|
|
|
|
// Suffixes after "loyalty.point." or "loyalty.coin.".
|
|
LoyaltyExpiryEnabledSuffix = "expiry_enabled"
|
|
LoyaltyExpiryPeriodSuffix = "expiry_period"
|
|
LoyaltyExpiryUnitSuffix = "expiry_unit"
|
|
LoyaltyExpiryEndOfMonthSuffix = "expiry_end_of_month"
|
|
LoyaltyExpiryReminderDaysSuffix = "expiry_reminder_days"
|
|
LoyaltyExpiryModeSuffix = "expiry_mode"
|
|
LoyaltyExpiryFixedDatesSuffix = "expiry_fixed_dates"
|
|
LoyaltyExpiryGraceMonthsSuffix = "expiry_grace_months"
|
|
)
|
|
|
|
// Per organization: EnakGame reward limits (docs/rfc-enakgame.md §5.10). 0 means no
|
|
// limit. A reward over a limit is cut to what is left of it (§9).
|
|
const (
|
|
EnakGameLimitUserDailyKey = "enakgame.limit.user_daily"
|
|
EnakGameLimitGlobalDailyKey = "enakgame.limit.global_daily"
|
|
)
|
|
|
|
// Modes of loyalty.{point,coin}.earn_mode.
|
|
const (
|
|
// earn_value for every earn_per_amount rupiah of the basis.
|
|
LoyaltyEarnModePerAmount = "PER_AMOUNT"
|
|
// earn_percent percent of the basis.
|
|
LoyaltyEarnModePercentage = "PERCENTAGE"
|
|
)
|
|
|
|
// Units of loyalty.{point,coin}.expiry_unit.
|
|
const (
|
|
LoyaltyExpiryUnitDay = "DAY"
|
|
LoyaltyExpiryUnitMonth = "MONTH"
|
|
)
|
|
|
|
// Modes of loyalty.{point,coin}.expiry_mode (note N4, decided: both are supported).
|
|
const (
|
|
// Every balance expires on the same fixed dates of the year, such as 31 Dec.
|
|
LoyaltyExpiryModeFixedDate = "FIXED_DATE"
|
|
// Every balance lasts a period from when it was received.
|
|
LoyaltyExpiryModeRolling = "ROLLING"
|
|
)
|
|
|
|
// Defaults from the PRD.
|
|
const (
|
|
LoyaltyPointEarnPerAmountDefault = int64(100)
|
|
LoyaltyCoinEarnPerAmountDefault = int64(25000)
|
|
LoyaltyEarnValueDefault = int64(1)
|
|
LoyaltyEarnModeDefault = LoyaltyEarnModePerAmount
|
|
LoyaltyEarnPercentDefault = float64(1)
|
|
|
|
LoyaltyPointValueDefault = int64(1)
|
|
LoyaltyExchangeAmountDefault = int64(1)
|
|
|
|
LoyaltyTransferEnabledDefault = true
|
|
LoyaltyTransferMinAmountDefault = int64(1)
|
|
|
|
LoyaltyExpiryPeriodDefault = int64(12)
|
|
LoyaltyExpiryUnitDefault = LoyaltyExpiryUnitMonth
|
|
LoyaltyExpiryReminderDaysDefault = int64(7)
|
|
LoyaltyExpiryModeDefault = LoyaltyExpiryModeFixedDate
|
|
// Once a year on 31 December, as MM-DD.
|
|
LoyaltyExpiryFixedDatesDefault = "12-31"
|
|
LoyaltyExpiryGraceMonthsDefault = int64(3)
|
|
)
|