Merge pull request 'feat(payments): chip wallet, store-compliance gate and benefit application' (#217) from feature/payments-currency-benefit-core into development
CI / changes (push) Successful in 2s
CI / unit (push) Successful in 10s
CI / integration (push) Successful in 21s
CI / ui (push) Successful in 1m7s
CI / conformance (push) Successful in 9s
CI / gate (push) Successful in 0s
CI / deploy (push) Successful in 1m45s

This commit was merged in pull request #217.
This commit is contained in:
2026-07-08 05:53:24 +00:00
39 changed files with 2947 additions and 151 deletions
+60 -34
View File
@@ -2,9 +2,12 @@
Technical, step-by-step implementation of the monetization domain. Business mechanics and
the rationale for every rule live in [`docs/PAYMENTS.md`](docs/PAYMENTS.md) (RU mirror
[`docs/PAYMENTS_ru.md`](docs/PAYMENTS_ru.md)); this file is the *how*. Each stage is written
to be self-sufficient: returning to it gives full context — goal, exact touch-points,
tests, done-criteria, and current status — without re-deriving decisions.
[`docs/PAYMENTS_ru.md`](docs/PAYMENTS_ru.md)); the frozen owner agreements they both derive
from (the `D1``D41` decisions log) live in
[`docs/PAYMENTS_DECISIONS_ru.md`](docs/PAYMENTS_DECISIONS_ru.md) — the authority when a rule
is disputed. This file is the *how*. Each stage is written to be self-sufficient: returning
to it gives full context — goal, exact touch-points, tests, done-criteria, and current
status — without re-deriving decisions.
## How to use this file
@@ -28,7 +31,7 @@ tests, done-criteria, and current status — without re-deriving decisions.
|-------|-------|---------|--------|
| E0 | Payments data foundation | 1 | DONE |
| E1 | Trusted platform signal | 1 | DONE |
| E2 | Currency + benefit core | 1 | TODO |
| E2 | Currency + benefit core | 1 | DONE |
| E3 | Wallet UI | 1 | TODO |
| E4 | Durability (PITR) | 2 | TODO |
| E5 | Payment intake | 2 | TODO |
@@ -82,9 +85,21 @@ Read once; individual stages assume it.
`registerRoutes` gated `if s.payments != nil`, admin section in `registerConsole` gated
`if s.payments != nil`.
- Game/other domains depend on payments only through a **narrow interface** (e.g.
`AdFree(ctx, account, platform) bool`, `SpendHint(ctx, account, platform) error`,
`Balances(ctx, account, platform) …`). Keep the surface small; this is the seam that lets
payments become a separate process later without touching callers.
`AdFree(ctx, account, platform, present) bool`, `SpendHint(ctx, account, platform, present)
error`, `Balances(ctx, account, platform, present) …`), where `present` is the set of
identity sources the account currently holds (`vk`→vk, `telegram`→telegram, `email`→direct;
`robot` ignored), computed by the caller from `account.Identities` — payments carries no
cross-schema identity knowledge, so unlink/re-link availability (D14) falls out live. Keep
the surface small; this is the seam that lets payments become a separate process later
without touching callers.
- **Read model.** Hot reads (`AdFree`/`HintsAvailable`/`Balances` and the gate) are served
from an in-process, account-keyed, write-through cache inside the payments package
(mirroring `account/suspension.go`), invalidated on every payments mutation
(spend/grant/fund/refund/merge); the payments DB is touched only on a cache miss, so the
steady-state hot path issues no query to the `payments` schema. The D39 materialized
`balances`/`benefits` tables stay the in-transaction write target the cache fronts.
Single-instance, matching the deployment (a multi-instance backend would need a shared
cache).
### Migrations & codegen
@@ -283,33 +298,40 @@ Release 2). TG/direct subtype is not cryptographically trusted — E2 must keep
## E2 — Currency + benefit core
**Status:** TODO · **Release 1** · depends on: E0, E1 · mechanics: PAYMENTS §2–§6, §11.
**Status:** DONE · **Release 1** · depends on: E0, E1 · mechanics: PAYMENTS §2–§6, §11.
**Goal.** The full internal money mechanic, exercisable end-to-end **without real money**
via `admin_grant`: chip balances, spend→benefit atomically, the compliance gate by context,
benefit application (no-ads stacking, hints per-origin), the legacy migration, and the
`SpendHint` rewrite. This is the heart.
**Payments service (Go).**
**Payments service (Go).** Every read/gate method also takes `present` (the account's live
identity sources, see *Domain boundary*) and is served from the read cache.
- `Balances(ctx, account, platform)`the segments spendable in the platform's context
(VK→vk; TG→tg; direct→direct+vk+tg; VK-iOS→frozen/view; untrusted→none).
- `Spend(ctx, account, platform, productID)` → gate-checked purchase of a value with chips:
resolve spendable segments by context, draw by priority (direct→vk→tg on web), write a
`spend` ledger row + decrement balance + apply benefit (extend `ads_paid_until[origin]`
from `max(now,end)` / set `ads_forever` / add hints) **in one tx**, stamping `origin` =
platform context. Refuse if untrusted (fail-closed) or funds insufficient.
- `Grant(ctx, account, origin, atoms)``admin_grant` ledger row (price 0, concrete values
only, never chips), same benefit application; origin chosen by the admin (E7 UI; here the
service method + an internal/admin entrypoint).
- `AdFree(ctx, account, platform)` / `HintsAvailable(ctx, account, platform)` /
`SpendHint(ctx, account, platform)` → apply the one-directional origin rule: in context P,
usable origins = {P} plus, when P is web/native, {vk,tg} (relaxation outward); in VK only
vk; in TG only tg.
- `Merge` / `Unlink` hooks: extend `accountmerge` to merge segments+benefits by origin
(same-origin add, different coexist), and make segment availability follow identity
presence (unlink → sleep, re-link → wake). Warn-before-unlink is a UI concern (surface the
balance via the interface).
- `Balances(ctx, account, platform, present)`per-segment `{source, chips, spendable}` for
the context (VK→vk spendable, direct/tg hidden; TG→tg; direct→direct+vk+tg by priority;
VK-iOS→vk shown as a **frozen** number, none spendable; untrusted→view-only, none spendable).
- `Spend(ctx, account, platform, present, productID)` → gate-checked purchase of a **value**
(CHIP price, `method=NULL`; never a chip pack) with chips: resolve spendable segments by
context, draw by priority direct→vk→tg, write a `spend` ledger row (+ a catalog **snapshot**
of atoms+price) + decrement balance + apply benefit (extend `ads_paid_until[origin]` from
`max(now,end)` / set `ads_forever` / add hints) **in one tx**, stamping `origin` = platform
context. Refuse if untrusted (fail-closed) or funds insufficient.
- `Grant(ctx, account, origin, atoms)` → a **0-price sale of a value**: an `admin_grant`
ledger row (`chips_delta=0`, + snapshot), same benefit application; concrete values only,
never chips (no chips move — it neither requires nor touches a balance). Origin chosen by
the admin. In E2 this is the Go service method only, exercised by tests; the admin grant UI
+ catalog editor are E7.
- `AdFree(ctx, account, platform, present)` / `HintsAvailable(…)` / `SpendHint(…)` → apply
the one-directional origin rule: in context P, usable origins = {P} plus, when P is
web/native, {vk,tg} (relaxation outward); in VK only vk; in TG only tg. Hint consumption
draws by the same priority direct→vk→tg.
- `Merge` / `Unlink` hooks: extend `accountmerge` to merge segments **and** benefits by origin
(same-origin add — chips sum, terms extend per origin; different origins coexist) in the
caller's tx (`MergeTx`), and make **both** segment *and* benefit availability follow
identity presence — unlink sleeps the balance *and* the benefit, re-link wakes them (D14),
resolved live from `present`. Warn-before-unlink surfaces the balance via the interface; the
warning UI itself is not E2.
**Backend wiring & migration.**
@@ -328,18 +350,22 @@ methods, Connect methods + transcode + FBS. Admin grant is internal/admin (E7 UI
**Tests.**
- unit (Go): gate-by-context matrix (every row of PAYMENTS §4); priority draw; no-ads
stacking (`+=` from max(now,end)) + forever override; per-origin hint applicability;
merge/unlink segment math.
- unit (Go): gate-by-context matrix (every row of PAYMENTS §4, incl. VK-iOS frozen +
untrusted); priority draw; no-ads stacking (`+=` from max(now,end)) + forever override;
per-origin hint applicability + direct→vk→tg draw; merge/unlink segment+benefit math;
catalog snapshotting; read-cache invalidation on each mutation.
- integration: atomic spend (ledger+balance+benefit in one tx; failure rolls all back);
admin_grant credits values not chips; legacy migration zeroes and flips reads; merge/
unlink over Postgres.
- UI: none new (E3 builds the screen); wallet DTO covered by codec unit tests.
**Done-criteria.** With chips seeded via `admin_grant`, a user can buy no-ads/hints; the gate
blocks cross-context spend and cross-origin application; ads gate reads the new benefit;
`SpendHint` uses segments; all layers green; **compliance regression** (a `direct` benefit
never activates inside VK/TG) is a named test.
**Done-criteria.** `admin_grant` applies no-ads/hints directly (a 0-price sale of a value —
no chips involved); the player chip-spend path (`Spend`) is proven by unit/integration tests
(balance seeded in-test, since a legitimate chip source arrives only with Release 2); the gate
blocks cross-context spend and cross-origin application; the ads gate reads the new benefit;
`SpendHint` uses segments; the hot read paths hit the read cache, not the `payments` schema;
all layers green; **compliance regression** (a `direct` benefit never activates inside VK/TG)
is a named test.
**Notes/risks.** This is the high-blast-radius core (money semantics + a live path
`SpendHint`/`ads.Eligible`). Minimize surface, keep the interface narrow, no mixed-in
+8 -1
View File
@@ -195,7 +195,8 @@ func run(ctx context.Context, cfg config.Config, logger *zap.Logger) error {
emails.SetSendLimiter(account.NewSendLimiter(time.Minute, 5))
// Account linking & merge: the orchestrator over the account, merge and
// session layers. Wired to the /api/v1/user/link REST surface below.
links := link.NewService(emails, accounts, accountmerge.NewMerger(db), sessions)
merger := accountmerge.NewMerger(db)
links := link.NewService(emails, accounts, merger, sessions)
socialSvc := social.NewService(social.NewStore(db), accounts, games)
socialSvc.SetNotifier(hub)
socialSvc.SetMetrics(tel.MeterProvider().Meter("scrabble/backend/social"))
@@ -270,6 +271,12 @@ func run(ctx context.Context, cfg config.Config, logger *zap.Logger) error {
}
logger.Info("payments domain ready")
// Wire the payments surface into the domains that consume it: the online-game hint wallet
// and the account-merge wallet fold. Done after the reachability check so a broken payments
// schema fails boot before anything depends on it.
games.SetHintWallet(paymentsSvc)
merger.SetPayments(paymentsSvc)
// The image-render sidecar client for the PNG export artifact; nil (PNG
// download answers 404) when BACKEND_RENDERER_URL is unset.
var renderer *render.Client
+40 -20
View File
@@ -51,8 +51,24 @@ var ErrSameAccount = errors.New("accountmerge: primary and secondary are the sam
type Merger struct {
db *sql.DB
now func() time.Time
// payments, when set, merges the two accounts' chip segments and benefits by origin inside
// the merge transaction (SetPayments). Nil leaves payments untouched (tests that do not
// exercise the wallet).
payments PaymentsMerger
}
// PaymentsMerger is the payments surface the account merge enlists: fold the secondary's
// segments and benefits into the primary within the merge transaction, then invalidate the
// affected read caches after the commit. *payments.Service satisfies it.
type PaymentsMerger interface {
MergeTx(ctx context.Context, tx *sql.Tx, primary, secondary uuid.UUID) error
Invalidate(ids ...uuid.UUID)
}
// SetPayments installs the payments merge hook. It must be called during startup wiring; the
// default (nil) merges no wallet state.
func (m *Merger) SetPayments(p PaymentsMerger) { m.payments = p }
// NewMerger constructs a Merger over db.
func NewMerger(db *sql.DB) *Merger {
return &Merger{db: db, now: func() time.Time { return time.Now().UTC() }}
@@ -67,7 +83,7 @@ func (m *Merger) Merge(ctx context.Context, primary, secondary uuid.UUID) error
return ErrSameAccount
}
now := m.now()
return withTx(ctx, m.db, func(tx *sql.Tx) error {
if err := withTx(ctx, m.db, func(tx *sql.Tx) error {
if err := guardActiveSharedGame(ctx, tx, primary, secondary); err != nil {
return err
}
@@ -107,8 +123,21 @@ func (m *Merger) Merge(ctx context.Context, primary, secondary uuid.UUID) error
if err := deleteEphemerals(ctx, tx, secondary); err != nil {
return err
}
if m.payments != nil {
if err := m.payments.MergeTx(ctx, tx, primary, secondary); err != nil {
return fmt.Errorf("accountmerge: payments: %w", err)
}
}
return tombstone(ctx, tx, primary, secondary, now)
})
}); err != nil {
return err
}
// The payments read cache is invalidated only after the merge commits, so a read racing the
// transaction cannot re-cache pre-merge state (both accounts' rows are moved or dropped).
if m.payments != nil {
m.payments.Invalidate(primary, secondary)
}
return nil
}
// guardActiveSharedGame returns ErrActiveGameConflict when primary and secondary
@@ -248,25 +277,16 @@ func mergeBestMoves(ctx context.Context, tx *sql.Tx, primary, secondary uuid.UUI
return nil
}
// mergeAccountFields adds secondary's hint wallet to primary and ORs the paid flag;
// all other profile fields stay the primary's.
func mergeAccountFields(ctx context.Context, tx *sql.Tx, primary, secondary uuid.UUID, now time.Time) error {
var sec model.Accounts
if err := postgres.SELECT(table.Accounts.AllColumns).
FROM(table.Accounts).
WHERE(table.Accounts.AccountID.EQ(postgres.UUID(secondary))).
QueryContext(ctx, tx, &sec); err != nil {
return fmt.Errorf("accountmerge: load secondary account: %w", err)
}
upd := table.Accounts.UPDATE(
table.Accounts.HintBalance, table.Accounts.PaidAccount, table.Accounts.UpdatedAt,
).SET(
table.Accounts.HintBalance.ADD(postgres.Int(int64(sec.HintBalance))),
table.Accounts.PaidAccount.OR(postgres.Bool(sec.PaidAccount)),
postgres.TimestampzT(now),
).WHERE(table.Accounts.AccountID.EQ(postgres.UUID(primary)))
// mergeAccountFields bumps the primary account's updated_at to reflect the merge. The former
// hint-wallet and paid-flag merge moved to the payments domain, where segments and benefits
// merge by origin (see the payments MergeTx step and docs/PAYMENTS.md §6); the legacy
// accounts.hint_balance / paid_account columns are deprecated and no longer read or written.
func mergeAccountFields(ctx context.Context, tx *sql.Tx, primary, _ uuid.UUID, now time.Time) error {
upd := table.Accounts.UPDATE(table.Accounts.UpdatedAt).
SET(postgres.TimestampzT(now)).
WHERE(table.Accounts.AccountID.EQ(postgres.UUID(primary)))
if _, err := upd.ExecContext(ctx, tx); err != nil {
return fmt.Errorf("accountmerge: update primary account: %w", err)
return fmt.Errorf("accountmerge: touch primary account: %w", err)
}
return nil
}
-8
View File
@@ -100,14 +100,6 @@ type ActiveCampaign struct {
OverrideDark *ColorSet
}
// Eligible reports whether an account should be shown the advertising banner: a
// free account (not paid) with an empty hint wallet and without the no_banner
// role. The no_banner role suppresses the banner unconditionally; buying a paid
// account or any hints also removes it.
func Eligible(paidAccount bool, hintBalance int, hasNoBanner bool) bool {
return !paidAccount && hintBalance <= 0 && !hasNoBanner
}
// computeActiveSet builds the resolved rotation feed from the enabled campaigns
// at time now, in language lang, and reports whether the feed is an urgent one.
// Campaigns outside their validity window, and campaigns with no messages, are
-24
View File
@@ -6,30 +6,6 @@ import (
"time"
)
func TestEligible(t *testing.T) {
tests := []struct {
name string
paidAccount bool
hintBalance int
hasNoBanner bool
want bool
}{
{name: "free, empty wallet, no role", want: true},
{name: "paid", paidAccount: true, want: false},
{name: "has hints", hintBalance: 3, want: false},
{name: "no_banner role", hasNoBanner: true, want: false},
{name: "paid and has hints", paidAccount: true, hintBalance: 5, want: false},
{name: "no_banner overrides everything", hasNoBanner: true, want: false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := Eligible(tt.paidAccount, tt.hintBalance, tt.hasNoBanner); got != tt.want {
t.Errorf("Eligible(%v,%d,%v) = %v, want %v", tt.paidAccount, tt.hintBalance, tt.hasNoBanner, got, tt.want)
}
})
}
}
func TestComputeActiveSet(t *testing.T) {
now := time.Date(2026, 6, 15, 12, 0, 0, 0, time.UTC)
past := now.Add(-24 * time.Hour)
+51 -4
View File
@@ -18,6 +18,8 @@ import (
"scrabble/backend/internal/account"
"scrabble/backend/internal/engine"
"scrabble/backend/internal/notify"
"scrabble/backend/internal/payments"
"scrabble/backend/internal/session"
)
// Service is the game domain: it drives the engine over a single match, persists
@@ -50,6 +52,11 @@ type Service struct {
// its asynchronous TriggerMove); nil disables the fast path (the scan still covers
// these games). Kept as a func so the game package never imports the robot package.
aiTrigger func(gameID uuid.UUID)
// hintWallet is the payments surface the online-game hint path spends against (the
// segmented, context-aware hint balance). It is set by SetHintWallet during wiring; when
// nil, only the free per-game allowance is served (no purchased hints). vs_ai hints are
// wallet-free and never touch it.
hintWallet HintWallet
// clearNudges, when set, marks the actor's pending nudges in a game read once they
// have committed a move (a nudge answered by moving stops counting as unread). It is
// best-effort and kept as a func so the game package never imports the social package.
@@ -105,6 +112,39 @@ func (svc *Service) SetAITrigger(trigger func(gameID uuid.UUID)) {
svc.aiTrigger = trigger
}
// HintWallet is the payments surface the online-game hint path uses: the context-aware hint
// balance (HintsAvailable) and a one-hint spend (SpendHint), both keyed by the trusted execution
// context and the account's present identity sources. *payments.Service satisfies it.
type HintWallet interface {
HintsAvailable(ctx context.Context, accountID uuid.UUID, cxt payments.Context, present []payments.Source) (int, error)
SpendHint(ctx context.Context, accountID uuid.UUID, cxt payments.Context, present []payments.Source) (bool, error)
}
// SetHintWallet installs the payments hint wallet the online-game hint path spends against. It
// must be called during startup wiring; the default (nil) serves only the free per-game allowance.
func (svc *Service) SetHintWallet(w HintWallet) {
svc.hintWallet = w
}
// walletContext resolves the payments gate inputs for an account on the current request: the
// trusted execution context (from the session platform carried on ctx; absent ⇒ untrusted) and
// the account's present identity sources (which chip/benefit segments are awake, §6).
func (svc *Service) walletContext(ctx context.Context, accountID uuid.UUID) (payments.Context, []payments.Source, error) {
var cxt payments.Context
if p, ok := session.PlatformFromContext(ctx); ok {
cxt = payments.NewContext(p.Kind, p.Subtype)
}
ids, err := svc.accounts.Identities(ctx, accountID)
if err != nil {
return payments.Context{}, nil, err
}
kinds := make([]string, len(ids))
for i, id := range ids {
kinds[i] = id.Kind
}
return cxt, payments.PresentSources(kinds), nil
}
// SetNudgeClearer installs the hook that marks a mover's pending nudges read after
// their move commits. It must be called during startup wiring; the default (nil)
// leaves nudges to be cleared only when the recipient opens the move history or chat.
@@ -1121,13 +1161,20 @@ func (svc *Service) Hint(ctx context.Context, gameID, accountID uuid.UUID) (Hint
}
return HintResult{Move: move}, nil
}
acc, err := svc.accounts.GetByID(ctx, accountID)
cxt, present, err := svc.walletContext(ctx, accountID)
if err != nil {
return HintResult{}, err
}
wallet := 0
if svc.hintWallet != nil {
wallet, err = svc.hintWallet.HintsAvailable(ctx, accountID, cxt, present)
if err != nil {
return HintResult{}, err
}
}
used := pre.Seats[seat].HintsUsed
fromAllowance := used < pre.HintsPerPlayer
if !fromAllowance && acc.HintBalance <= 0 {
if !fromAllowance && wallet <= 0 {
return HintResult{}, ErrNoHintsLeft
}
@@ -1142,9 +1189,9 @@ func (svc *Service) Hint(ctx context.Context, gameID, accountID uuid.UUID) (Hint
return HintResult{}, ErrNoHintAvailable
}
walletAfter := acc.HintBalance
walletAfter := wallet
if !fromAllowance {
spent, err := svc.accounts.SpendHint(ctx, accountID)
spent, err := svc.hintWallet.SpendHint(ctx, accountID, cxt, present)
if err != nil {
return HintResult{}, err
}
+48 -15
View File
@@ -15,13 +15,15 @@ import (
"scrabble/backend/internal/account"
"scrabble/backend/internal/ads"
"scrabble/backend/internal/payments"
"scrabble/backend/internal/server"
)
// bannerServer assembles a console-capable server with the ads domain wired.
func bannerServer(t *testing.T) (*server.Server, *ads.Service) {
func bannerServer(t *testing.T) (*server.Server, *ads.Service, *payments.Service) {
t.Helper()
adsSvc := ads.NewService(ads.NewStore(testDB))
paySvc := newPaymentsService()
srv := server.New(":0", server.Deps{
Logger: zap.NewNop(),
Accounts: account.NewStore(testDB),
@@ -29,8 +31,9 @@ func bannerServer(t *testing.T) (*server.Server, *ads.Service) {
Registry: testRegistry,
DictDir: dictDir(),
Ads: adsSvc,
Payments: paySvc,
})
return srv, adsSvc
return srv, adsSvc, paySvc
}
// findCampaign returns the id of the campaign with the given name, or fails.
@@ -71,7 +74,7 @@ func defaultCampaign(t *testing.T, svc *ads.Service) ads.Campaign {
// reorder/delete.
func TestBannerConsoleCRUD(t *testing.T) {
ctx := context.Background()
srv, adsSvc := bannerServer(t)
srv, adsSvc, _ := bannerServer(t)
h := srv.Handler()
base := "http://admin.test/_gm"
const origin = "http://admin.test"
@@ -151,7 +154,7 @@ func TestBannerConsoleCRUD(t *testing.T) {
// unrelated campaign's URL must be refused.
func TestBannerMessageOwnership(t *testing.T) {
ctx := context.Background()
srv, adsSvc := bannerServer(t)
srv, adsSvc, _ := bannerServer(t)
h := srv.Handler()
base := "http://admin.test/_gm"
const origin = "http://admin.test"
@@ -207,10 +210,11 @@ type profileBanner struct {
// wallet each suppress it.
func TestBannerProfileEligibility(t *testing.T) {
ctx := context.Background()
srv, _ := bannerServer(t)
srv, _, pay := bannerServer(t)
accounts := account.NewStore(testDB)
id := provisionAccount(t)
// getBanner fetches the profile banner with no platform header (an untrusted context).
getBanner := func() profileBanner {
t.Helper()
rec := userGet(t, srv, "/api/v1/user/profile", id)
@@ -223,10 +227,27 @@ func TestBannerProfileEligibility(t *testing.T) {
}
return p
}
// getBannerTG fetches the profile banner in a trusted Telegram context — the account's
// telegram identity makes telegram the applicable origin for its benefits.
getBannerTG := func() profileBanner {
t.Helper()
rec := httptest.NewRecorder()
req := httptest.NewRequest(http.MethodGet, "/api/v1/user/profile", nil)
req.Header.Set("X-User-ID", id.String())
req.Header.Set("X-Platform", "telegram/android")
srv.Handler().ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("profile = %d, want 200", rec.Code)
}
var p profileBanner
if err := json.Unmarshal(rec.Body.Bytes(), &p); err != nil {
t.Fatalf("decode profile: %v", err)
}
return p
}
// A free account with an empty hint wallet and no role is eligible.
p := getBanner()
if p.Banner == nil || len(p.Banner.Campaigns) == 0 || p.Banner.Timings.HoldMs <= 0 {
// A free account with no role and no benefit is eligible.
if p := getBanner(); p.Banner == nil || len(p.Banner.Campaigns) == 0 || p.Banner.Timings.HoldMs <= 0 {
t.Fatalf("eligible account: banner=%v", p.Banner)
}
@@ -241,19 +262,31 @@ func TestBannerProfileEligibility(t *testing.T) {
t.Fatalf("revoke role: %v", err)
}
// A non-empty hint wallet suppresses it.
if _, err := accounts.GrantHints(ctx, id, 5); err != nil {
// A hint wallet no longer suppresses the banner — hints and no-ads are distinct benefits now.
if err := pay.Grant(ctx, id, payments.SourceTelegram, 5, 0, false); err != nil {
t.Fatalf("grant hints: %v", err)
}
if p := getBanner(); p.Banner != nil {
t.Fatal("a non-empty hint wallet still shows the banner")
if p := getBannerTG(); p.Banner == nil {
t.Fatal("a hint wallet must NOT suppress the banner")
}
// An active no-ads benefit applicable in the context suppresses the banner.
if err := pay.Grant(ctx, id, payments.SourceTelegram, 0, 30, false); err != nil {
t.Fatalf("grant no-ads: %v", err)
}
if p := getBannerTG(); p.Banner != nil {
t.Fatal("an active no-ads benefit must suppress the banner")
}
// Fail-closed: without a trusted platform the same benefit does not apply, so the banner shows.
if p := getBanner(); p.Banner == nil {
t.Fatal("an untrusted context must not apply the no-ads benefit (banner should show)")
}
}
// TestBannerSurvivesProfileUpdate guards that a profile update (e.g. a language switch) returns the
// banner block too, so the client's profile keeps the banner instead of losing it until reload.
func TestBannerSurvivesProfileUpdate(t *testing.T) {
srv, _ := bannerServer(t)
srv, _, _ := bannerServer(t)
id := provisionAccount(t)
body := `{"display_name":"Tester","preferred_language":"ru","time_zone":"UTC","away_start":"00:00",` +
@@ -283,7 +316,7 @@ func TestBannerSurvivesProfileUpdate(t *testing.T) {
// default campaign stays plain (colours + urgent are ignored for it).
func TestBannerConsoleColorsAndUrgent(t *testing.T) {
ctx := context.Background()
srv, adsSvc := bannerServer(t)
srv, adsSvc, _ := bannerServer(t)
h := srv.Handler()
base := "http://admin.test/_gm"
const origin = "http://admin.test"
@@ -351,7 +384,7 @@ func TestBannerConsoleColorsAndUrgent(t *testing.T) {
// otherwise suppress the banner.
func TestBannerUrgentBypassesEligibility(t *testing.T) {
ctx := context.Background()
srv, adsSvc := bannerServer(t)
srv, adsSvc, _ := bannerServer(t)
accounts := account.NewStore(testDB)
id := provisionAccount(t)
+13 -10
View File
@@ -14,6 +14,8 @@ import (
"scrabble/backend/internal/account"
"scrabble/backend/internal/engine"
"scrabble/backend/internal/game"
"scrabble/backend/internal/payments"
"scrabble/backend/internal/session"
)
// TestListForAccount checks the lobby "my games" query: it returns exactly the
@@ -401,8 +403,13 @@ func gameStatus(t *testing.T, svc *game.Service, id uuid.UUID) (status, endReaso
// TestHintPolicy exercises the per-game allowance, the profile wallet and the
// disabled switch.
func TestHintPolicy(t *testing.T) {
ctx := context.Background()
// A trusted platform context so the online hint wallet (payments) is reachable; a provisioned
// account carries a telegram identity, so the telegram origin is the applicable one here.
ctx := session.WithPlatform(context.Background(),
session.Platform{Kind: session.PlatformKindTelegram, Subtype: session.SubtypeAndroid})
svc := newGameService()
pay := newPaymentsService()
svc.SetHintWallet(pay) // share the handle so a grant invalidates the wallet the game reads
seats := []uuid.UUID{provisionAccount(t), provisionAccount(t)}
seed := openingSeed(t)
g, err := svc.Create(ctx, game.CreateParams{
@@ -428,7 +435,11 @@ func TestHintPolicy(t *testing.T) {
if _, err := svc.Hint(ctx, g.ID, seats[0]); !errors.Is(err, game.ErrNoHintsLeft) {
t.Fatalf("second hint = %v, want ErrNoHintsLeft", err)
}
setHintBalance(t, seats[0], 2)
// Grant 2 hints on the telegram origin through the service so its read cache is invalidated
// (a raw insert would leave the cache warmed at zero by the allowance hint above).
if err := pay.Grant(ctx, seats[0], payments.SourceTelegram, 2, 0, false); err != nil {
t.Fatalf("grant hints: %v", err)
}
res, err := svc.Hint(ctx, g.ID, seats[0]) // spends the wallet
if err != nil {
t.Fatalf("wallet hint: %v", err)
@@ -603,14 +614,6 @@ func setAway(t *testing.T, id uuid.UUID, tz, start, end string) {
}
}
func setHintBalance(t *testing.T, id uuid.UUID, n int) {
t.Helper()
if _, err := testDB.ExecContext(context.Background(),
`UPDATE backend.accounts SET hint_balance = $1 WHERE account_id = $2`, n, id); err != nil {
t.Fatalf("set hint balance: %v", err)
}
}
func equalStrings(a, b []string) bool {
if len(a) != len(b) {
return false
+34
View File
@@ -17,6 +17,7 @@ import (
"scrabble/backend/internal/engine"
"scrabble/backend/internal/game"
"scrabble/backend/internal/lobby"
"scrabble/backend/internal/payments"
"scrabble/backend/internal/robot"
"scrabble/backend/internal/social"
)
@@ -42,9 +43,42 @@ func newGameService() *game.Service {
zap.NewNop(),
)
svc.SetFirstMoveEntropy(seatZeroFirstMove)
svc.SetHintWallet(newPaymentsService())
return svc
}
// newPaymentsService builds a payments service over the shared pool (its own in-process read
// cache), for wiring the game hint wallet and the account-merge fold in the integration suite.
func newPaymentsService() *payments.Service {
return payments.NewService(payments.NewStore(testDB))
}
// seedBenefit writes a payments benefit row for an account+origin directly (bypassing the
// service), used to stand up wallet state a test then spends or merges. A non-zero hints count
// and/or the forever flag are set; a caller wanting a no-ads term sets it via seedBenefitUntil.
func seedBenefit(t *testing.T, id uuid.UUID, origin string, hints int, forever bool) {
t.Helper()
if _, err := testDB.ExecContext(context.Background(),
`INSERT INTO payments.benefits (account_id, origin, hints, ads_forever) VALUES ($1,$2,$3,$4)
ON CONFLICT (account_id, origin) DO UPDATE SET hints = EXCLUDED.hints, ads_forever = EXCLUDED.ads_forever`,
id, origin, hints, forever); err != nil {
t.Fatalf("seed benefit: %v", err)
}
}
// readBenefit reads an account's benefit row for an origin: the hint count and the forever flag
// (both zero/false when the row is absent).
func readBenefit(t *testing.T, id uuid.UUID, origin string) (hints int, forever bool) {
t.Helper()
err := testDB.QueryRowContext(context.Background(),
`SELECT hints, ads_forever FROM payments.benefits WHERE account_id=$1 AND origin=$2`, id, origin).
Scan(&hints, &forever)
if err != nil && !errors.Is(err, sql.ErrNoRows) {
t.Fatalf("read benefit: %v", err)
}
return hints, forever
}
// seatZeroFirstMove is a first-move-draw entropy factory that always elects the first
// listed account as the leader, keeping the integration suite's turn order stable
// despite the real draw's randomness: the first contender draws a blank — the best
+9 -18
View File
@@ -58,14 +58,6 @@ func bestMoveCount(t *testing.T, id uuid.UUID) int {
return n
}
func setWallet(t *testing.T, id uuid.UUID, hints int, paid bool) {
t.Helper()
if _, err := testDB.ExecContext(context.Background(),
`UPDATE backend.accounts SET hint_balance=$2, paid_account=$3 WHERE account_id=$1`, id, hints, paid); err != nil {
t.Fatalf("set wallet: %v", err)
}
}
func bindEmailIdentity(t *testing.T, acc uuid.UUID, email string) {
t.Helper()
if _, err := testDB.ExecContext(context.Background(),
@@ -131,6 +123,7 @@ func TestAccountMergeCore(t *testing.T) {
ctx := context.Background()
store := account.NewStore(testDB)
merger := accountmerge.NewMerger(testDB)
merger.SetPayments(newPaymentsService())
primary := provisionAccount(t)
secondary := provisionAccount(t)
@@ -140,8 +133,8 @@ func TestAccountMergeCore(t *testing.T) {
setStats(t, secondary, 3, 1, 2, 400, 80)
setStatsCounts(t, primary, 100, 5)
setStatsCounts(t, secondary, 50, 8)
setWallet(t, primary, 2, false)
setWallet(t, secondary, 5, true)
seedBenefit(t, primary, "telegram", 2, false)
seedBenefit(t, secondary, "telegram", 5, true) // hints sum, forever OR-s on merge
// Best moves: secondary's scrabble_en (80) beats primary's (50) and is kept; secondary's
// scrabble_ru (30) is new to primary and carried over.
setBestMove(t, primary, "scrabble_en", 50)
@@ -165,15 +158,13 @@ func TestAccountMergeCore(t *testing.T) {
t.Error("secondary stats row should be deleted after merge")
}
acc, err := store.GetByID(ctx, primary)
if err != nil {
t.Fatalf("get primary: %v", err)
// The payments wallet merged by origin: hints sum (2+5) and the forever flag OR-s; the
// deprecated accounts.hint_balance / paid_account columns are no longer touched by a merge.
if hints, forever := readBenefit(t, primary, "telegram"); hints != 7 || !forever {
t.Errorf("merged telegram benefit = hints %d forever %v, want 7/true", hints, forever)
}
if acc.HintBalance != 7 {
t.Errorf("hint balance = %d, want 7", acc.HintBalance)
}
if !acc.PaidAccount {
t.Error("paid_account should be true (ORed from secondary)")
if hints, _ := readBenefit(t, secondary, "telegram"); hints != 0 {
t.Errorf("secondary benefit should be cleared after merge, got hints %d", hints)
}
if owner, ok, _ := store.AccountIDByIdentity(ctx, account.KindEmail, email); !ok || owner != primary {
@@ -0,0 +1,279 @@
//go:build integration
package inttest
import (
"context"
"database/sql"
"errors"
"testing"
"time"
"github.com/google/uuid"
"scrabble/backend/internal/payments"
)
// seedBalance writes a chip balance for an account+source directly (payments has no FK to
// accounts, so a bare uuid is a valid account id here).
func seedBalance(t *testing.T, id uuid.UUID, source string, chips int) {
t.Helper()
if _, err := testDB.ExecContext(context.Background(),
`INSERT INTO payments.balances (account_id, source, chips) VALUES ($1,$2,$3)
ON CONFLICT (account_id, source) DO UPDATE SET chips = EXCLUDED.chips`,
id, source, chips); err != nil {
t.Fatalf("seed balance: %v", err)
}
}
// readBalance reads an account's chip balance for a source (0 when the row is absent).
func readBalance(t *testing.T, id uuid.UUID, source string) int {
t.Helper()
var chips int
err := testDB.QueryRowContext(context.Background(),
`SELECT chips FROM payments.balances WHERE account_id=$1 AND source=$2`, id, source).Scan(&chips)
if err != nil && !errors.Is(err, sql.ErrNoRows) {
t.Fatalf("read balance: %v", err)
}
return chips
}
// benefitUntil reads an account's no-ads term end for an origin (nil when none).
func benefitUntil(t *testing.T, id uuid.UUID, origin string) *time.Time {
t.Helper()
var until *time.Time
err := testDB.QueryRowContext(context.Background(),
`SELECT ads_paid_until FROM payments.benefits WHERE account_id=$1 AND origin=$2`, id, origin).Scan(&until)
if err != nil && !errors.Is(err, sql.ErrNoRows) {
t.Fatalf("read benefit until: %v", err)
}
return until
}
// ledgerRows counts an account's ledger rows of a given kind.
func ledgerRows(t *testing.T, id uuid.UUID, kind string) int {
t.Helper()
var n int
if err := testDB.QueryRowContext(context.Background(),
`SELECT count(*) FROM payments.ledger WHERE account_id=$1 AND kind=$2`, id, kind).Scan(&n); err != nil {
t.Fatalf("ledger count: %v", err)
}
return n
}
// seedValueProduct creates an active chip-priced value: a product with a CHIP price (method
// NULL) and the given hint / no-ads-day atoms. It returns the product id.
func seedValueProduct(t *testing.T, priceChips, hints, noAdsDays int) uuid.UUID {
t.Helper()
ctx := context.Background()
prod := uuid.New()
if _, err := testDB.ExecContext(ctx,
`INSERT INTO payments.product (product_id, title, active) VALUES ($1,'test value',true)`, prod); err != nil {
t.Fatalf("seed product: %v", err)
}
if _, err := testDB.ExecContext(ctx,
`INSERT INTO payments.product_price (product_id, method, currency, amount) VALUES ($1, NULL, 'CHIP', $2)`,
prod, priceChips); err != nil {
t.Fatalf("seed price: %v", err)
}
if hints > 0 {
if _, err := testDB.ExecContext(ctx,
`INSERT INTO payments.product_item (product_id, atom_type, quantity) VALUES ($1,'hints',$2)`, prod, hints); err != nil {
t.Fatalf("seed hints item: %v", err)
}
}
if noAdsDays > 0 {
if _, err := testDB.ExecContext(ctx,
`INSERT INTO payments.product_item (product_id, atom_type, quantity) VALUES ($1,'noads_days',$2)`, prod, noAdsDays); err != nil {
t.Fatalf("seed noads item: %v", err)
}
}
return prod
}
// TestPaymentsSpendAppliesAtomically verifies a chip spend writes the ledger row, decrements the
// balance and applies the benefit together over Postgres.
func TestPaymentsSpendAppliesAtomically(t *testing.T) {
ctx := context.Background()
svc := newPaymentsService()
acc := uuid.New()
seedBalance(t, acc, "direct", 100)
prod := seedValueProduct(t, 60, 3, 30)
if err := svc.Spend(ctx, acc, payments.NewContext("direct", "web"), []payments.Source{payments.SourceDirect}, prod); err != nil {
t.Fatalf("spend: %v", err)
}
if got := readBalance(t, acc, "direct"); got != 40 {
t.Errorf("balance after spend = %d, want 40", got)
}
if hints, _ := readBenefit(t, acc, "direct"); hints != 3 {
t.Errorf("hints after spend = %d, want 3", hints)
}
if benefitUntil(t, acc, "direct") == nil {
t.Error("no-ads term not applied by the spend")
}
if n := ledgerRows(t, acc, "spend"); n != 1 {
t.Errorf("spend ledger rows = %d, want 1", n)
}
}
// TestPaymentsSpendInsufficientNoWrite verifies an under-funded spend is refused and writes
// nothing (the balance, benefit and ledger are untouched).
func TestPaymentsSpendInsufficientNoWrite(t *testing.T) {
ctx := context.Background()
svc := newPaymentsService()
acc := uuid.New()
seedBalance(t, acc, "direct", 10)
prod := seedValueProduct(t, 60, 3, 0)
if err := svc.Spend(ctx, acc, payments.NewContext("direct", "web"), []payments.Source{payments.SourceDirect}, prod); !errors.Is(err, payments.ErrInsufficientChips) {
t.Fatalf("spend = %v, want ErrInsufficientChips", err)
}
if got := readBalance(t, acc, "direct"); got != 10 {
t.Errorf("balance changed to %d, want 10 (no write)", got)
}
if h, _ := readBenefit(t, acc, "direct"); h != 0 {
t.Errorf("benefit applied on a refused spend: hints %d", h)
}
if ledgerRows(t, acc, "spend") != 0 {
t.Error("spend ledger row written on a refused spend")
}
}
// TestPaymentsSpendGuardRollsBack forces the in-transaction guard to bite: with a stale read
// cache the draw plan looks affordable, but the guarded decrement matches no row and the whole
// transaction rolls back — no ledger row, no benefit, balance unchanged.
func TestPaymentsSpendGuardRollsBack(t *testing.T) {
ctx := context.Background()
svc := newPaymentsService()
acc := uuid.New()
seedBalance(t, acc, "direct", 100)
present := []payments.Source{payments.SourceDirect}
cxt := payments.NewContext("direct", "web")
if _, err := svc.Wallet(ctx, acc, cxt, present); err != nil { // warm the cache at 100
t.Fatalf("warm: %v", err)
}
// Drain the real balance behind the cache's back (no invalidation), so the plan over-commits.
if _, err := testDB.ExecContext(ctx, `UPDATE payments.balances SET chips = 10 WHERE account_id=$1 AND source='direct'`, acc); err != nil {
t.Fatalf("drain: %v", err)
}
prod := seedValueProduct(t, 60, 3, 0)
if err := svc.Spend(ctx, acc, cxt, present, prod); !errors.Is(err, payments.ErrInsufficientChips) {
t.Fatalf("spend = %v, want ErrInsufficientChips", err)
}
if got := readBalance(t, acc, "direct"); got != 10 {
t.Errorf("balance = %d, want 10 (rolled back)", got)
}
if ledgerRows(t, acc, "spend") != 0 {
t.Error("spend ledger row written despite the rollback")
}
if h, _ := readBenefit(t, acc, "direct"); h != 0 {
t.Error("benefit applied despite the rollback")
}
}
// TestPaymentsGrantCreditsValuesNotChips verifies admin_grant applies a benefit at price 0
// without ever crediting chips (D16).
func TestPaymentsGrantCreditsValuesNotChips(t *testing.T) {
ctx := context.Background()
svc := newPaymentsService()
acc := uuid.New()
if err := svc.Grant(ctx, acc, payments.SourceDirect, 5, 0, true); err != nil {
t.Fatalf("grant: %v", err)
}
if hints, forever := readBenefit(t, acc, "direct"); hints != 5 || !forever {
t.Errorf("granted benefit = hints %d forever %v, want 5/true", hints, forever)
}
if readBalance(t, acc, "direct") != 0 {
t.Error("a grant must not credit chips")
}
if ledgerRows(t, acc, "admin_grant") != 1 {
t.Error("admin_grant ledger row missing")
}
if ledgerRows(t, acc, "spend") != 0 || ledgerRows(t, acc, "fund") != 0 {
t.Error("a grant wrote a non-grant ledger row")
}
}
// TestPaymentsSpendHintByContext verifies a hint is drawn from an applicable origin, and that a
// direct-origin hint is not usable inside a VK context (the compliance wall for hints).
func TestPaymentsSpendHintByContext(t *testing.T) {
ctx := context.Background()
svc := newPaymentsService()
acc := uuid.New()
seedBenefit(t, acc, "direct", 2, false)
present := []payments.Source{payments.SourceDirect, payments.SourceVK}
if spent, err := svc.SpendHint(ctx, acc, payments.NewContext("direct", "web"), present); err != nil || !spent {
t.Fatalf("web spend hint = %v (err %v), want true", spent, err)
}
if h, _ := readBenefit(t, acc, "direct"); h != 1 {
t.Errorf("hints after spend = %d, want 1", h)
}
// Inside VK the applicable origins are {vk} only, so the direct-origin hint is untouched.
if spent, _ := svc.SpendHint(ctx, acc, payments.NewContext("vk", "android"), present); spent {
t.Error("direct-origin hint spent inside VK — compliance wall breached")
}
if h, _ := readBenefit(t, acc, "direct"); h != 1 {
t.Errorf("direct hints changed inside VK = %d, want 1 (untouched)", h)
}
}
// TestPaymentsComplianceGateOverPostgres is the named compliance regression at the integration
// layer: a direct-origin no-ads benefit applies on the web but never inside a store wrapper.
func TestPaymentsComplianceGateOverPostgres(t *testing.T) {
ctx := context.Background()
svc := newPaymentsService()
acc := uuid.New()
if err := svc.Grant(ctx, acc, payments.SourceDirect, 0, 30, false); err != nil {
t.Fatalf("grant: %v", err)
}
present := []payments.Source{payments.SourceDirect, payments.SourceVK}
if adFree, _ := svc.AdFree(ctx, acc, payments.NewContext("direct", "web"), present); !adFree {
t.Error("direct no-ads should apply on web")
}
if adFree, _ := svc.AdFree(ctx, acc, payments.NewContext("vk", "android"), present); adFree {
t.Error("direct no-ads must NOT apply inside VK (compliance wall)")
}
if adFree, _ := svc.AdFree(ctx, acc, payments.NewContext("telegram", "web"), present); adFree {
t.Error("direct no-ads must NOT apply inside Telegram (compliance wall)")
}
}
// TestPaymentsMergeFoldsSegmentsAndBenefits verifies the merge folds chip segments (sum) and
// benefits (hints sum, forever OR) by origin, and clears the secondary's rows, over Postgres.
func TestPaymentsMergeFoldsSegmentsAndBenefits(t *testing.T) {
ctx := context.Background()
svc := newPaymentsService()
primary, secondary := uuid.New(), uuid.New()
seedBalance(t, primary, "vk", 10)
seedBalance(t, secondary, "vk", 25)
seedBenefit(t, primary, "vk", 1, false)
seedBenefit(t, secondary, "vk", 4, true)
tx, err := testDB.BeginTx(ctx, nil)
if err != nil {
t.Fatalf("begin: %v", err)
}
if err := svc.MergeTx(ctx, tx, primary, secondary); err != nil {
_ = tx.Rollback()
t.Fatalf("merge: %v", err)
}
if err := tx.Commit(); err != nil {
t.Fatalf("commit: %v", err)
}
svc.Invalidate(primary, secondary)
if got := readBalance(t, primary, "vk"); got != 35 {
t.Errorf("merged chips = %d, want 35", got)
}
if h, forever := readBenefit(t, primary, "vk"); h != 5 || !forever {
t.Errorf("merged benefit = hints %d forever %v, want 5/true", h, forever)
}
if readBalance(t, secondary, "vk") != 0 {
t.Error("secondary balance not cleared after merge")
}
}
+72
View File
@@ -0,0 +1,72 @@
package payments
import (
"sync"
"time"
"github.com/google/uuid"
)
// benefitState is an account's benefit row for one origin: the no-ads term end (nil = none),
// the perpetual forever flag, and the hint count. It is the context-independent stored form;
// the read paths aggregate it over the origins applicable in a context.
type benefitState struct {
adsPaidUntil *time.Time
adsForever bool
hints int
}
// walletState is an account's full payments state: chip balances by source and benefits by
// origin. It is the raw, context-independent data every read path filters per execution
// context — the value the cache holds and the store recomputes from the materialized tables.
type walletState struct {
chips map[Source]int
benefits map[Source]benefitState
}
// chipsOf returns the chip balance for a source, zero when the segment has no row (an absent
// segment reads as zero, §2).
func (w walletState) chipsOf(s Source) int { return w.chips[s] }
// benefitOf returns the benefit for an origin, the zero benefit when the origin has no row.
func (w walletState) benefitOf(o Source) benefitState { return w.benefits[o] }
// walletCache is the payments read model: each account's chip/benefit state, keyed by account
// id, read on every ad-eligibility / hint / wallet / gate request and invalidated on every
// payments mutation (spend, grant, fund, refund, merge). It is a write-through cache in front
// of the materialized balances/benefits tables — the same pattern the account-suspension gate
// uses (backend/internal/account/suspension.go) — so the steady-state hot path issues no query
// to the payments schema. It is single-instance, matching the deployment (one shared Store); a
// multi-instance backend would need a shared cache.
type walletCache struct {
mu sync.RWMutex
m map[uuid.UUID]walletState
}
// newWalletCache constructs an empty cache.
func newWalletCache() *walletCache {
return &walletCache{m: make(map[uuid.UUID]walletState)}
}
// get returns the cached state for an account and whether it was present.
func (c *walletCache) get(id uuid.UUID) (walletState, bool) {
c.mu.RLock()
defer c.mu.RUnlock()
s, ok := c.m[id]
return s, ok
}
// put stores an account's state.
func (c *walletCache) put(id uuid.UUID, s walletState) {
c.mu.Lock()
defer c.mu.Unlock()
c.m[id] = s
}
// invalidate drops an account's entry so the next read reloads it from the materialized tables.
// Called after every mutation once its transaction has committed.
func (c *walletCache) invalidate(id uuid.UUID) {
c.mu.Lock()
defer c.mu.Unlock()
delete(c.m, id)
}
+202
View File
@@ -0,0 +1,202 @@
package payments
import (
"slices"
"time"
)
// Source is the platform axis a chip balance is segmented by (where it was funded) and a
// benefit is stamped with (where it was bought — its origin). The two roles share this value
// set but mean different things (see docs/PAYMENTS.md §3); Source names the axis for both.
type Source string
const (
// SourceVK is the VK platform: Votes purchases and VK rewarded ads fund here.
SourceVK Source = "vk"
// SourceTelegram is the Telegram platform: Stars purchases fund here.
SourceTelegram Source = "telegram"
// SourceDirect is the open web / native context: Robokassa purchases fund here.
SourceDirect Source = "direct"
)
// Valid reports whether s is one of the three known platform sources.
func (s Source) Valid() bool {
switch s {
case SourceVK, SourceTelegram, SourceDirect:
return true
default:
return false
}
}
// SubtypeIOS is the one device subtype the gate keys on: VK on iOS is frozen for spending
// (Apple forbids spending virtual currency on digital goods outside IAP). It is trusted only
// for VK, where it rides inside the signed launch parameters.
const SubtypeIOS = "ios"
// SourceForIdentityKind maps a backend identity kind to the payments source whose segment that
// identity makes available: a vk/telegram identity to its own source, a durable email identity
// to the direct source (the web/native recovery anchor). A robot identity — or any unknown
// kind — maps to no source (second return false). Callers use it to build the present set the
// payments interface takes, since payments cannot read the account schema.
func SourceForIdentityKind(kind string) (Source, bool) {
switch kind {
case "vk":
return SourceVK, true
case "telegram":
return SourceTelegram, true
case "email":
return SourceDirect, true
default:
return "", false
}
}
// PresentSources maps an account's identity kinds to the payments sources they make available
// (§6), de-duplicated: vk→vk, telegram→telegram, email→direct; a robot or unknown kind maps to
// nothing. Callers pass the kinds from account.Identities so the gate — which holds no
// cross-schema identity knowledge — can resolve which segments are awake.
func PresentSources(kinds []string) []Source {
var out []Source
for _, k := range kinds {
if s, ok := SourceForIdentityKind(k); ok && !has(out, s) {
out = append(out, s)
}
}
return out
}
// Context is the trusted execution context the store-compliance gate keys on: the platform
// Kind (the source the wrapper enforces) plus, for VK, the trusted Subtype (only the VK-iOS
// freeze depends on it). The zero Context (empty Kind) is an untrusted platform — the gate is
// fail-closed there: no spend, no purchase, no foreign-origin benefit, view only.
type Context struct {
Kind Source
Subtype string
}
// NewContext builds a Context from the session platform's kind and subtype strings (as carried
// on the trusted X-Platform signal). An unrecognised or empty kind yields an untrusted Context.
func NewContext(kind, subtype string) Context {
k := Source(kind)
if !k.Valid() {
return Context{}
}
return Context{Kind: k, Subtype: subtype}
}
// Trusted reports whether the platform is trusted (a known kind). An untrusted context denies
// every spend/purchase and the application of any foreign origin.
func (c Context) Trusted() bool { return c.Kind.Valid() }
// vkFrozen reports whether this is the VK-iOS spend freeze: VK context on the trusted iOS
// subtype. A previously bought benefit still applies there, but no spend or purchase is possible.
func (c Context) vkFrozen() bool { return c.Kind == SourceVK && c.Subtype == SubtypeIOS }
// spendPriority is the fixed draw order when several segments are spendable in one context
// (D7): the "home" direct segment first, the store-funded segments after.
var spendPriority = []Source{SourceDirect, SourceVK, SourceTelegram}
// has reports whether present contains s.
func has(present []Source, s Source) bool {
return slices.Contains(present, s)
}
// spendableSources returns the chip segments that may be SPENT in the context, in draw-priority
// order, restricted to the sources the account actually has (present). It is empty when the
// platform is untrusted (fail-closed) or VK-iOS (frozen): inside VK/TG only the same-named
// segment is spendable; on web/native all attached segments are, drained direct→vk→tg.
func spendableSources(c Context, present []Source) []Source {
if !c.Trusted() || c.vkFrozen() {
return nil
}
switch c.Kind {
case SourceVK, SourceTelegram:
if has(present, c.Kind) {
return []Source{c.Kind}
}
return nil
default: // direct (web/native)
var out []Source
for _, s := range spendPriority {
if has(present, s) {
out = append(out, s)
}
}
return out
}
}
// applicableOrigins returns the benefit origins that APPLY in the context, in draw-priority
// order, restricted to present sources. It differs from spendableSources in one way: VK-iOS is
// NOT excluded — a benefit bought earlier still applies while spending is frozen. Inside VK/TG
// only the same-named origin applies (a foreign, e.g. direct, origin never activates inside a
// store — the compliance wall); on web/native direct+vk+tg all apply, drained direct→vk→tg.
func applicableOrigins(c Context, present []Source) []Source {
if !c.Trusted() {
return nil
}
switch c.Kind {
case SourceVK, SourceTelegram:
if has(present, c.Kind) {
return []Source{c.Kind}
}
return nil
default: // direct (web/native)
var out []Source
for _, s := range spendPriority {
if has(present, s) {
out = append(out, s)
}
}
return out
}
}
// visibleSources returns the segments the wallet shows in the context, regardless of whether
// they are spendable: inside a store only the same-named segment (the others are invisible
// there); on web/native or an untrusted context all three (untrusted shows them view-only).
func visibleSources(c Context) []Source {
switch c.Kind {
case SourceVK, SourceTelegram:
return []Source{c.Kind}
default:
return spendPriority
}
}
// Segment is one chip balance the wallet shows: the source, its chip count, and whether it can
// be spent in the current context (false for a frozen VK-iOS balance or an untrusted platform).
type Segment struct {
Source Source
Chips int
Spendable bool
}
// BenefitView is the benefit state applicable in the current context: whether ads are off (and
// until when, or forever) and how many hints are available. It aggregates over the origins
// applicable in the context (§5).
type BenefitView struct {
AdsForever bool
AdsPaidUntil *time.Time
Hints int
}
// WalletView is the read model returned to the wallet: the visible segments plus the
// context-applicable benefits.
type WalletView struct {
Segments []Segment
Benefits BenefitView
}
// benefitDelta is the benefit change a spend or grant applies to one origin: hints added, a
// no-ads term in whole days (stacked from max(now, current end)), and the perpetual forever
// flag (which overrides terms).
type benefitDelta struct {
hintsAdd int
noAdsDays int
forever bool
}
// zero reports whether the delta changes nothing.
func (d benefitDelta) zero() bool { return d.hintsAdd == 0 && d.noAdsDays == 0 && !d.forever }
+132
View File
@@ -0,0 +1,132 @@
package payments
import (
"slices"
"testing"
)
// allPresent is an account attached to every source (the maximal present set).
var allPresent = []Source{SourceDirect, SourceVK, SourceTelegram}
func TestSpendableSources(t *testing.T) {
tests := []struct {
name string
ctx Context
present []Source
want []Source
}{
{"vk android, vk present", Context{Kind: SourceVK, Subtype: "android"}, allPresent, []Source{SourceVK}},
{"vk ios frozen", Context{Kind: SourceVK, Subtype: SubtypeIOS}, allPresent, nil},
{"vk android, vk absent", Context{Kind: SourceVK, Subtype: "android"}, []Source{SourceDirect}, nil},
{"telegram", Context{Kind: SourceTelegram, Subtype: "web"}, allPresent, []Source{SourceTelegram}},
{"telegram, tg absent", Context{Kind: SourceTelegram}, []Source{SourceVK}, nil},
{"direct all present, priority", Context{Kind: SourceDirect, Subtype: "web"}, allPresent, []Source{SourceDirect, SourceVK, SourceTelegram}},
{"direct, only vk+tg attached", Context{Kind: SourceDirect}, []Source{SourceTelegram, SourceVK}, []Source{SourceVK, SourceTelegram}},
{"direct, nothing attached", Context{Kind: SourceDirect}, nil, nil},
{"untrusted fail-closed", Context{}, allPresent, nil},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
if got := spendableSources(tc.ctx, tc.present); !slices.Equal(got, tc.want) {
t.Errorf("spendableSources(%+v, %v) = %v, want %v", tc.ctx, tc.present, got, tc.want)
}
})
}
}
func TestApplicableOrigins(t *testing.T) {
tests := []struct {
name string
ctx Context
present []Source
want []Source
}{
// A benefit still APPLIES on VK-iOS while spending is frozen.
{"vk ios still applies", Context{Kind: SourceVK, Subtype: SubtypeIOS}, allPresent, []Source{SourceVK}},
{"vk android", Context{Kind: SourceVK, Subtype: "android"}, allPresent, []Source{SourceVK}},
{"telegram", Context{Kind: SourceTelegram}, allPresent, []Source{SourceTelegram}},
{"direct all, priority", Context{Kind: SourceDirect}, allPresent, []Source{SourceDirect, SourceVK, SourceTelegram}},
{"untrusted fail-closed", Context{}, allPresent, nil},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
if got := applicableOrigins(tc.ctx, tc.present); !slices.Equal(got, tc.want) {
t.Errorf("applicableOrigins(%+v, %v) = %v, want %v", tc.ctx, tc.present, got, tc.want)
}
})
}
}
// TestComplianceWall is the named unit-level compliance regression: a direct origin (externally
// paid, outside any store cash desk) must NEVER be applicable inside a VK or TG wrapper, and no
// segment is ever spendable there beyond the same-named one. The dangerous direction stays shut.
func TestComplianceWall(t *testing.T) {
for _, kind := range []Source{SourceVK, SourceTelegram} {
for _, sub := range []string{"android", "ios", "web"} {
ctx := Context{Kind: kind, Subtype: sub}
if slices.Contains(applicableOrigins(ctx, allPresent), SourceDirect) {
t.Errorf("direct origin applies inside %s/%s — compliance wall breached", kind, sub)
}
for _, s := range spendableSources(ctx, allPresent) {
if s != kind {
t.Errorf("foreign segment %s spendable inside %s/%s", s, kind, sub)
}
}
// The opposite store's origin must not leak in either (vk⊥tg).
other := SourceVK
if kind == SourceVK {
other = SourceTelegram
}
if slices.Contains(applicableOrigins(ctx, allPresent), other) {
t.Errorf("%s origin applies inside %s — cross-store leak", other, kind)
}
}
}
}
func TestVisibleSources(t *testing.T) {
if got := visibleSources(Context{Kind: SourceVK, Subtype: SubtypeIOS}); !slices.Equal(got, []Source{SourceVK}) {
t.Errorf("VK visible = %v, want [vk] (direct/tg hidden in a store)", got)
}
if got := visibleSources(Context{Kind: SourceDirect}); !slices.Equal(got, allPresent) {
t.Errorf("direct visible = %v, want all three", got)
}
if got := visibleSources(Context{}); !slices.Equal(got, allPresent) {
t.Errorf("untrusted visible = %v, want all three (view-only)", got)
}
}
func TestSourceForIdentityKind(t *testing.T) {
tests := []struct {
kind string
want Source
ok bool
}{
{"vk", SourceVK, true},
{"telegram", SourceTelegram, true},
{"email", SourceDirect, true},
{"robot", "", false},
{"unknown", "", false},
}
for _, tc := range tests {
got, ok := SourceForIdentityKind(tc.kind)
if got != tc.want || ok != tc.ok {
t.Errorf("SourceForIdentityKind(%q) = %q,%v want %q,%v", tc.kind, got, ok, tc.want, tc.ok)
}
}
}
func TestNewContextTrusted(t *testing.T) {
if c := NewContext("vk", "ios"); !c.Trusted() || !c.vkFrozen() {
t.Errorf("vk/ios: trusted=%v frozen=%v, want true/true", c.Trusted(), c.vkFrozen())
}
if c := NewContext("bogus", "web"); c.Trusted() {
t.Errorf("bogus kind should be untrusted")
}
if c := NewContext("", ""); c.Trusted() {
t.Errorf("empty kind should be untrusted")
}
if c := NewContext("direct", "web"); c.vkFrozen() {
t.Errorf("direct is never frozen")
}
}
+224 -7
View File
@@ -1,17 +1,234 @@
package payments
import "context"
import (
"context"
"database/sql"
"encoding/json"
"fmt"
"time"
// Service is the payments domain's application layer — the narrow surface other
// domains depend on, keeping the schema reachable through one seam. The
// data-foundation layer exposes only a health check; the wallet, benefit and
// store-compliance operations arrive with the currency mechanics.
"github.com/google/uuid"
)
// Service is the payments domain's application layer — the narrow surface other domains depend
// on, keeping the schema reachable through one seam. Every read/gate method takes the trusted
// execution Context and the account's present identity sources (which segments are awake, §6);
// payments holds no cross-schema identity knowledge, so the caller supplies present. Reads are
// served from the store's in-process cache, so the steady-state hot path issues no query to the
// payments schema.
type Service struct {
store *Store
clock func() time.Time
}
// NewService constructs a Service over store.
func NewService(store *Store) *Service { return &Service{store: store} }
// NewService constructs a Service over store with a wall-clock time source.
func NewService(store *Store) *Service {
return &Service{store: store, clock: func() time.Time { return time.Now().UTC() }}
}
// Ping reports whether the payments schema is reachable.
func (s *Service) Ping(ctx context.Context) error { return s.store.Ping(ctx) }
// Wallet returns the read model for the account in the execution context: the segments visible
// there (each with its chip count and whether it is spendable) plus the context-applicable
// benefits. In a store context only the same-named segment is shown; on web/native or an
// untrusted platform all attached segments are shown, spendable only when the gate allows.
func (s *Service) Wallet(ctx context.Context, accountID uuid.UUID, cxt Context, present []Source) (WalletView, error) {
st, err := s.store.state(ctx, accountID)
if err != nil {
return WalletView{}, err
}
now := s.clock()
view := WalletView{Benefits: benefitView(st, cxt, present, now)}
spendable := spendableSources(cxt, present)
for _, src := range visibleSources(cxt) {
if !has(present, src) {
continue // only the account's own (attached) segments are shown
}
view.Segments = append(view.Segments, Segment{
Source: src,
Chips: st.chipsOf(src),
Spendable: has(spendable, src),
})
}
return view, nil
}
// AdFree reports whether ads are suppressed for the account in the context: some origin
// applicable there has an active no-ads term or the forever flag. Fail-closed on an untrusted
// platform (no origin applies).
func (s *Service) AdFree(ctx context.Context, accountID uuid.UUID, cxt Context, present []Source) (bool, error) {
st, err := s.store.state(ctx, accountID)
if err != nil {
return false, err
}
now := s.clock()
for _, o := range applicableOrigins(cxt, present) {
b := st.benefitOf(o)
if b.adsForever || (b.adsPaidUntil != nil && b.adsPaidUntil.After(now)) {
return true, nil
}
}
return false, nil
}
// HintsAvailable returns how many hints the account can use in the context — the sum over the
// applicable origins. Zero on an untrusted platform.
func (s *Service) HintsAvailable(ctx context.Context, accountID uuid.UUID, cxt Context, present []Source) (int, error) {
st, err := s.store.state(ctx, accountID)
if err != nil {
return 0, err
}
total := 0
for _, o := range applicableOrigins(cxt, present) {
total += st.benefitOf(o).hints
}
return total, nil
}
// SpendHint consumes one hint from the first applicable origin that has one (priority
// direct→vk→tg), returning whether a hint was spent. It spends nothing when no origin is
// applicable (untrusted platform or no attached segment).
func (s *Service) SpendHint(ctx context.Context, accountID uuid.UUID, cxt Context, present []Source) (bool, error) {
origins := applicableOrigins(cxt, present)
if len(origins) == 0 {
return false, nil
}
return s.store.consumeHint(ctx, accountID, origins, s.clock())
}
// Spend buys a chip-priced value: it gate-checks the context, draws the price across the
// spendable segments by priority direct→vk→tg, and applies the benefit — atomically. The
// benefit's origin is the purchase context. It fails closed on an untrusted or frozen platform
// (ErrUntrusted) and on insufficient chips (ErrInsufficientChips).
func (s *Service) Spend(ctx context.Context, accountID uuid.UUID, cxt Context, present []Source, productID uuid.UUID) error {
spendable := spendableSources(cxt, present)
if len(spendable) == 0 {
return ErrUntrusted // untrusted, frozen, or no attached segment — no spend
}
prod, err := s.store.loadProduct(ctx, productID)
if err != nil {
return err
}
st, err := s.store.state(ctx, accountID)
if err != nil {
return err
}
draws, ok := planDraws(st, spendable, prod.priceChips)
if !ok {
return ErrInsufficientChips
}
snapshot, err := marshalSnapshot(prod)
if err != nil {
return err
}
return s.store.spend(ctx, accountID, draws, cxt.Kind, productID, prod.delta, snapshot, s.clock())
}
// Grant applies a benefit to an origin as a zero-price sale — an admin_grant ledger row and the
// benefit (hints, a no-ads term in whole days, or the forever flag). It never grants chips (no
// balance is touched — D16), so its signature has no chip amount. The origin is the admin's
// compliance choice.
func (s *Service) Grant(ctx context.Context, accountID uuid.UUID, origin Source, hints, noAdsDays int, forever bool) error {
if !origin.Valid() {
return fmt.Errorf("payments: invalid grant origin %q", origin)
}
d := benefitDelta{hintsAdd: hints, noAdsDays: noAdsDays, forever: forever}
if d.zero() {
return fmt.Errorf("payments: empty grant")
}
snapshot, err := marshalGrant(d)
if err != nil {
return err
}
return s.store.grant(ctx, accountID, origin, d, snapshot, s.clock())
}
// MergeTx merges the secondary account's segments and benefits into the primary inside the
// caller's transaction (the account-merge flow). The caller invalidates the affected caches
// after committing (Invalidate).
func (s *Service) MergeTx(ctx context.Context, tx *sql.Tx, primary, secondary uuid.UUID) error {
return s.store.MergeTx(ctx, tx, primary, secondary, s.clock())
}
// Invalidate drops the cached state of the listed accounts (called after a merge commit).
func (s *Service) Invalidate(ids ...uuid.UUID) { s.store.Invalidate(ids...) }
// benefitView aggregates the benefits applicable in the context into the wallet view: ads-off
// forever if any applicable origin is perpetual, else the latest active term end, plus the total
// available hints.
func benefitView(st walletState, cxt Context, present []Source, now time.Time) BenefitView {
var v BenefitView
for _, o := range applicableOrigins(cxt, present) {
b := st.benefitOf(o)
if b.adsForever {
v.AdsForever = true
}
if b.adsPaidUntil != nil && b.adsPaidUntil.After(now) {
if v.AdsPaidUntil == nil || b.adsPaidUntil.After(*v.AdsPaidUntil) {
v.AdsPaidUntil = b.adsPaidUntil
}
}
v.Hints += b.hints
}
return v
}
// planDraws greedily allocates price across the spendable segments in priority order, draining
// each before moving on. It returns the per-segment draws and whether the segments together held
// enough.
func planDraws(st walletState, spendable []Source, price int) ([]sourceAmount, bool) {
remaining := price
var draws []sourceAmount
for _, src := range spendable {
if remaining <= 0 {
break
}
avail := st.chipsOf(src)
if avail <= 0 {
continue
}
take := min(avail, remaining)
draws = append(draws, sourceAmount{source: src, amount: take})
remaining -= take
}
if remaining > 0 {
return nil, false
}
return draws, true
}
// purchaseSnapshot is the catalog snapshot stored on a spend/grant ledger row, so history and
// receipts stay independent of later catalog edits (§7/D34).
type purchaseSnapshot struct {
ProductID string `json:"product_id,omitempty"`
Title string `json:"title,omitempty"`
Atoms map[string]int `json:"atoms,omitempty"`
PriceChips int `json:"price_chips"`
Forever bool `json:"forever,omitempty"`
}
// marshalSnapshot builds the snapshot for a chip spend.
func marshalSnapshot(p catalogProduct) ([]byte, error) {
b, err := json.Marshal(purchaseSnapshot{ProductID: p.id.String(), Title: p.title, Atoms: p.atoms, PriceChips: p.priceChips})
if err != nil {
return nil, fmt.Errorf("payments: marshal snapshot: %w", err)
}
return b, nil
}
// marshalGrant builds the snapshot for an admin grant (price 0).
func marshalGrant(d benefitDelta) ([]byte, error) {
atoms := map[string]int{}
if d.hintsAdd > 0 {
atoms["hints"] = d.hintsAdd
}
if d.noAdsDays > 0 {
atoms["noads_days"] = d.noAdsDays
}
b, err := json.Marshal(purchaseSnapshot{Atoms: atoms, PriceChips: 0, Forever: d.forever})
if err != nil {
return nil, fmt.Errorf("payments: marshal grant snapshot: %w", err)
}
return b, nil
}
+7 -4
View File
@@ -14,13 +14,16 @@ import (
// Store is the Postgres-backed query surface for the payments schema. It is the
// only place in the backend that issues SQL against payments.* (an
// import-boundary test enforces it), so the domain stays extractable into its
// own database.
// own database. It fronts the materialized balances/benefits tables with an
// in-process write-through cache (see cache.go) so hot reads issue no query on
// the steady-state path.
type Store struct {
db *sql.DB
db *sql.DB
cache *walletCache
}
// NewStore constructs a Store wrapping db.
func NewStore(db *sql.DB) *Store { return &Store{db: db} }
// NewStore constructs a Store wrapping db, with an empty read cache.
func NewStore(db *sql.DB) *Store { return &Store{db: db, cache: newWalletCache()} }
// Ping verifies the payments schema is reachable by reading the singleton config
// row. It is the data-foundation health check; the wallet query surface arrives
+421
View File
@@ -0,0 +1,421 @@
package payments
import (
"context"
"database/sql"
"errors"
"fmt"
"time"
"github.com/go-jet/jet/v2/postgres"
"github.com/go-jet/jet/v2/qrm"
"github.com/google/uuid"
"scrabble/backend/internal/postgres/jet/payments/model"
"scrabble/backend/internal/postgres/jet/payments/table"
)
// Domain errors surfaced by the payments store and service.
var (
// ErrInsufficientChips means the spendable segments held fewer chips than the price.
ErrInsufficientChips = errors.New("payments: insufficient chips")
// ErrUntrusted means the platform context is untrusted, so the gate is fail-closed.
ErrUntrusted = errors.New("payments: untrusted platform")
// ErrProductNotFound means the product is absent or deactivated.
ErrProductNotFound = errors.New("payments: product not found")
// ErrNotAValue means the product has no chip price (it is a chip pack or unpriced), so it
// cannot be bought with chips.
ErrNotAValue = errors.New("payments: product is not a chip-priced value")
)
// withTx runs fn inside a transaction on db, rolling back on error or panic.
func withTx(ctx context.Context, db *sql.DB, fn func(*sql.Tx) error) (err error) {
tx, err := db.BeginTx(ctx, nil)
if err != nil {
return fmt.Errorf("payments: begin tx: %w", err)
}
defer func() {
if p := recover(); p != nil {
_ = tx.Rollback()
panic(p)
}
}()
if err := fn(tx); err != nil {
_ = tx.Rollback()
return err
}
if err := tx.Commit(); err != nil {
return fmt.Errorf("payments: commit tx: %w", err)
}
return nil
}
// sourceAmount is one chip draw from a single segment during a spend.
type sourceAmount struct {
source Source
amount int
}
// catalogProduct is a product resolved for a chip spend: its chip price, the benefit its atoms
// fold into, and the raw atom composition for the purchase snapshot.
type catalogProduct struct {
id uuid.UUID
title string
priceChips int
delta benefitDelta
atoms map[string]int
}
// loadState reads an account's balances and benefits straight from the materialized tables.
func (s *Store) loadState(ctx context.Context, accountID uuid.UUID) (walletState, error) {
st := walletState{chips: map[Source]int{}, benefits: map[Source]benefitState{}}
var brows []model.Balances
if err := postgres.SELECT(table.Balances.AllColumns).
FROM(table.Balances).
WHERE(table.Balances.AccountID.EQ(postgres.UUID(accountID))).
QueryContext(ctx, s.db, &brows); err != nil {
return walletState{}, fmt.Errorf("payments: load balances %s: %w", accountID, err)
}
for _, r := range brows {
st.chips[Source(r.Source)] = int(r.Chips)
}
var frows []model.Benefits
if err := postgres.SELECT(table.Benefits.AllColumns).
FROM(table.Benefits).
WHERE(table.Benefits.AccountID.EQ(postgres.UUID(accountID))).
QueryContext(ctx, s.db, &frows); err != nil {
return walletState{}, fmt.Errorf("payments: load benefits %s: %w", accountID, err)
}
for _, r := range frows {
st.benefits[Source(r.Origin)] = benefitState{adsPaidUntil: r.AdsPaidUntil, adsForever: r.AdsForever, hints: int(r.Hints)}
}
return st, nil
}
// state returns an account's payments state, served from the read cache when warm, otherwise
// loaded from the materialized tables and cached. The returned maps are read-only.
func (s *Store) state(ctx context.Context, accountID uuid.UUID) (walletState, error) {
if st, ok := s.cache.get(accountID); ok {
return st, nil
}
st, err := s.loadState(ctx, accountID)
if err != nil {
return walletState{}, err
}
s.cache.put(accountID, st)
return st, nil
}
// Invalidate drops the cached state of every listed account so the next read reloads it. It is
// called after a committed mutation whose transaction the payments package does not own — the
// account-merge flow (after its own commit) and, later, external fund/refund intake.
func (s *Store) Invalidate(ids ...uuid.UUID) {
for _, id := range ids {
s.cache.invalidate(id)
}
}
// loadProduct resolves a chip-priced value: an active product with a CHIP price row
// (method NULL) whose atoms are benefits (hints / no-ads days). It rejects a missing or
// deactivated product (ErrProductNotFound), a product with no chip price (ErrNotAValue), and a
// product carrying the chips atom (a chip pack is funded, never bought with chips — ErrNotAValue).
func (s *Store) loadProduct(ctx context.Context, productID uuid.UUID) (catalogProduct, error) {
var p model.Product
err := postgres.SELECT(table.Product.AllColumns).
FROM(table.Product).
WHERE(table.Product.ProductID.EQ(postgres.UUID(productID))).
LIMIT(1).
QueryContext(ctx, s.db, &p)
if errors.Is(err, qrm.ErrNoRows) || (err == nil && !p.Active) {
return catalogProduct{}, ErrProductNotFound
}
if err != nil {
return catalogProduct{}, fmt.Errorf("payments: load product %s: %w", productID, err)
}
var price model.ProductPrice
err = postgres.SELECT(table.ProductPrice.AllColumns).
FROM(table.ProductPrice).
WHERE(table.ProductPrice.ProductID.EQ(postgres.UUID(productID)).
AND(table.ProductPrice.Method.IS_NULL()).
AND(table.ProductPrice.Currency.EQ(postgres.String(string(CurrencyChip))))).
LIMIT(1).
QueryContext(ctx, s.db, &price)
if errors.Is(err, qrm.ErrNoRows) {
return catalogProduct{}, ErrNotAValue
}
if err != nil {
return catalogProduct{}, fmt.Errorf("payments: load price %s: %w", productID, err)
}
var items []model.ProductItem
if err := postgres.SELECT(table.ProductItem.AllColumns).
FROM(table.ProductItem).
WHERE(table.ProductItem.ProductID.EQ(postgres.UUID(productID))).
QueryContext(ctx, s.db, &items); err != nil {
return catalogProduct{}, fmt.Errorf("payments: load items %s: %w", productID, err)
}
cp := catalogProduct{id: productID, title: p.Title, priceChips: int(price.Amount), atoms: map[string]int{}}
for _, it := range items {
cp.atoms[it.AtomType] = int(it.Quantity)
switch it.AtomType {
case "hints":
cp.delta.hintsAdd += int(it.Quantity)
case "noads_days":
cp.delta.noAdsDays += int(it.Quantity)
case "chips":
return catalogProduct{}, ErrNotAValue // a value never grants chips
}
}
return cp, nil
}
// stackNoAds returns the new no-ads term end after adding addDays whole days from
// max(now, current end) — terms add up, the remainder is never lost (§5/D33). A non-positive
// addDays leaves the term unchanged; a nil current means no term yet.
func stackNoAds(current *time.Time, addDays int, now time.Time) *time.Time {
if addDays <= 0 {
return current
}
base := now
if current != nil && current.After(now) {
base = *current
}
end := base.Add(time.Duration(addDays) * 24 * time.Hour)
return &end
}
// combineNoAds folds secondary's remaining no-ads term onto primary's during a merge: the
// remaining duration of each is preserved (§6/D15 "terms extend per origin").
func combineNoAds(primary, secondary *time.Time, now time.Time) *time.Time {
if secondary == nil || !secondary.After(now) {
return primary
}
base := now
if primary != nil && primary.After(now) {
base = *primary
}
end := base.Add(secondary.Sub(now))
return &end
}
// applyBenefitTx applies a benefit delta to one origin inside tx, stacking the no-ads term,
// OR-ing the forever flag and adding hints. It ensures the (account, origin) row exists, locks
// it, then writes the recomputed values — so concurrent applies serialise on the row lock.
func applyBenefitTx(ctx context.Context, tx *sql.Tx, accountID uuid.UUID, origin Source, d benefitDelta, now time.Time) error {
if d.zero() {
return nil
}
if _, err := tx.ExecContext(ctx,
`INSERT INTO payments.benefits (account_id, origin) VALUES ($1, $2) ON CONFLICT DO NOTHING`,
accountID, string(origin)); err != nil {
return fmt.Errorf("payments: ensure benefit row %s: %w", origin, err)
}
var untilCur *time.Time
var foreverCur bool
var hintsCur int32
if err := tx.QueryRowContext(ctx,
`SELECT ads_paid_until, ads_forever, hints FROM payments.benefits
WHERE account_id = $1 AND origin = $2 FOR UPDATE`, accountID, string(origin)).
Scan(&untilCur, &foreverCur, &hintsCur); err != nil {
return fmt.Errorf("payments: lock benefit %s: %w", origin, err)
}
if _, err := tx.ExecContext(ctx,
`UPDATE payments.benefits SET ads_paid_until = $3, ads_forever = $4, hints = $5, updated_at = now()
WHERE account_id = $1 AND origin = $2`,
accountID, string(origin), stackNoAds(untilCur, d.noAdsDays, now), foreverCur || d.forever, int(hintsCur)+d.hintsAdd); err != nil {
return fmt.Errorf("payments: apply benefit %s: %w", origin, err)
}
return nil
}
// insertLedgerTx appends one append-only ledger row inside tx.
func insertLedgerTx(ctx context.Context, tx *sql.Tx, accountID uuid.UUID, kind string, source, origin *Source, chipsDelta int, productID *uuid.UUID, snapshot []byte, now time.Time) error {
id, err := uuid.NewV7()
if err != nil {
return fmt.Errorf("payments: ledger id: %w", err)
}
// The snapshot is a bare value, not a postgres.String literal: a jsonb column infers its
// type from an untyped parameter (the game-moves payload idiom), whereas a text-typed
// literal is rejected against jsonb.
var snap any = postgres.NULL
if snapshot != nil {
snap = string(snapshot)
}
stmt := table.Ledger.INSERT(
table.Ledger.LedgerID, table.Ledger.AccountID, table.Ledger.Kind,
table.Ledger.Source, table.Ledger.Origin, table.Ledger.ChipsDelta,
table.Ledger.ProductID, table.Ledger.Snapshot, table.Ledger.CreatedAt,
).VALUES(
id, accountID, kind,
sourceOrNull(source), sourceOrNull(origin), int32(chipsDelta),
uuidOrNull(productID), snap, now,
)
if _, err := stmt.ExecContext(ctx, tx); err != nil {
return fmt.Errorf("payments: insert %s ledger: %w", kind, err)
}
return nil
}
// spend draws the chips across the given segments, appends a spend ledger row per draw (carrying
// the purchase snapshot), and applies the benefit — all in one transaction. It fails closed on
// an insufficient balance (a guarded decrement), rolling everything back.
func (s *Store) spend(ctx context.Context, accountID uuid.UUID, draws []sourceAmount, origin Source, productID uuid.UUID, d benefitDelta, snapshot []byte, now time.Time) error {
err := withTx(ctx, s.db, func(tx *sql.Tx) error {
for _, dr := range draws {
res, err := table.Balances.
UPDATE(table.Balances.Chips, table.Balances.UpdatedAt).
SET(table.Balances.Chips.SUB(postgres.Int(int64(dr.amount))), postgres.TimestampzT(now)).
WHERE(table.Balances.AccountID.EQ(postgres.UUID(accountID)).
AND(table.Balances.Source.EQ(postgres.String(string(dr.source)))).
AND(table.Balances.Chips.GT_EQ(postgres.Int(int64(dr.amount))))).
ExecContext(ctx, tx)
if err != nil {
return fmt.Errorf("payments: decrement %s: %w", dr.source, err)
}
if n, _ := res.RowsAffected(); n == 0 {
return ErrInsufficientChips
}
src := dr.source
if err := insertLedgerTx(ctx, tx, accountID, "spend", &src, &origin, -dr.amount, &productID, snapshot, now); err != nil {
return err
}
}
return applyBenefitTx(ctx, tx, accountID, origin, d, now)
})
if err != nil {
return err
}
s.cache.invalidate(accountID)
return nil
}
// grant records an admin_grant ledger row (price 0, no chips) and applies the granted benefit to
// the chosen origin, in one transaction — a zero-price sale of a value.
func (s *Store) grant(ctx context.Context, accountID uuid.UUID, origin Source, d benefitDelta, snapshot []byte, now time.Time) error {
err := withTx(ctx, s.db, func(tx *sql.Tx) error {
if err := insertLedgerTx(ctx, tx, accountID, "admin_grant", nil, &origin, 0, nil, snapshot, now); err != nil {
return err
}
return applyBenefitTx(ctx, tx, accountID, origin, d, now)
})
if err != nil {
return err
}
s.cache.invalidate(accountID)
return nil
}
// consumeHint decrements one hint from the first applicable origin (in the given priority order)
// that has one, with a guarded update. It returns whether a hint was spent.
func (s *Store) consumeHint(ctx context.Context, accountID uuid.UUID, origins []Source, now time.Time) (bool, error) {
for _, o := range origins {
res, err := table.Benefits.
UPDATE(table.Benefits.Hints, table.Benefits.UpdatedAt).
SET(table.Benefits.Hints.SUB(postgres.Int(1)), postgres.TimestampzT(now)).
WHERE(table.Benefits.AccountID.EQ(postgres.UUID(accountID)).
AND(table.Benefits.Origin.EQ(postgres.String(string(o)))).
AND(table.Benefits.Hints.GT(postgres.Int(0)))).
ExecContext(ctx, s.db)
if err != nil {
return false, fmt.Errorf("payments: consume hint %s: %w", o, err)
}
if n, _ := res.RowsAffected(); n > 0 {
s.cache.invalidate(accountID)
return true, nil
}
}
return false, nil
}
// MergeTx folds the secondary account's segments and benefits into the primary, by source and by
// origin, inside the caller's transaction (the account-merge flow): chips sum, no-ads terms
// extend per origin, forever OR-s, hints add. The secondary's payments rows are removed. The
// caller invalidates the primary's cache after its own commit (Invalidate). It does not touch
// the account schema — the JET import boundary stays intact, only the shared connection is used.
func (s *Store) MergeTx(ctx context.Context, tx *sql.Tx, primary, secondary uuid.UUID, now time.Time) error {
if _, err := tx.ExecContext(ctx,
`INSERT INTO payments.balances (account_id, source, chips, updated_at)
SELECT $1, source, chips, now() FROM payments.balances WHERE account_id = $2
ON CONFLICT (account_id, source) DO UPDATE
SET chips = payments.balances.chips + EXCLUDED.chips, updated_at = now()`,
primary, secondary); err != nil {
return fmt.Errorf("payments: merge balances: %w", err)
}
if _, err := tx.ExecContext(ctx, `DELETE FROM payments.balances WHERE account_id = $1`, secondary); err != nil {
return fmt.Errorf("payments: clear secondary balances: %w", err)
}
rows, err := tx.QueryContext(ctx,
`SELECT origin, ads_paid_until, ads_forever, hints FROM payments.benefits WHERE account_id = $1`, secondary)
if err != nil {
return fmt.Errorf("payments: read secondary benefits: %w", err)
}
type secBenefit struct {
origin Source
until *time.Time
forever bool
hints int
}
var secs []secBenefit
for rows.Next() {
var b secBenefit
var o string
var h int32
if err := rows.Scan(&o, &b.until, &b.forever, &h); err != nil {
rows.Close()
return fmt.Errorf("payments: scan secondary benefit: %w", err)
}
b.origin, b.hints = Source(o), int(h)
secs = append(secs, b)
}
if err := rows.Err(); err != nil {
rows.Close()
return fmt.Errorf("payments: iterate secondary benefits: %w", err)
}
rows.Close()
for _, b := range secs {
if _, err := tx.ExecContext(ctx,
`INSERT INTO payments.benefits (account_id, origin) VALUES ($1, $2) ON CONFLICT DO NOTHING`,
primary, string(b.origin)); err != nil {
return fmt.Errorf("payments: ensure primary benefit %s: %w", b.origin, err)
}
var untilCur *time.Time
var foreverCur bool
var hintsCur int32
if err := tx.QueryRowContext(ctx,
`SELECT ads_paid_until, ads_forever, hints FROM payments.benefits
WHERE account_id = $1 AND origin = $2 FOR UPDATE`, primary, string(b.origin)).
Scan(&untilCur, &foreverCur, &hintsCur); err != nil {
return fmt.Errorf("payments: lock primary benefit %s: %w", b.origin, err)
}
if _, err := tx.ExecContext(ctx,
`UPDATE payments.benefits SET ads_paid_until = $3, ads_forever = $4, hints = $5, updated_at = now()
WHERE account_id = $1 AND origin = $2`,
primary, string(b.origin), combineNoAds(untilCur, b.until, now), foreverCur || b.forever, int(hintsCur)+b.hints); err != nil {
return fmt.Errorf("payments: merge benefit %s: %w", b.origin, err)
}
}
if _, err := tx.ExecContext(ctx, `DELETE FROM payments.benefits WHERE account_id = $1`, secondary); err != nil {
return fmt.Errorf("payments: clear secondary benefits: %w", err)
}
return nil
}
// sourceOrNull renders an optional source as a SQL string or NULL.
func sourceOrNull(s *Source) postgres.Expression {
if s == nil {
return postgres.NULL
}
return postgres.String(string(*s))
}
// uuidOrNull renders an optional id as a SQL uuid or NULL.
func uuidOrNull(id *uuid.UUID) postgres.Expression {
if id == nil {
return postgres.NULL
}
return postgres.UUID(*id)
}
+182
View File
@@ -0,0 +1,182 @@
package payments
import (
"context"
"testing"
"time"
"github.com/google/uuid"
)
// base is a fixed clock instant for the deterministic tests.
var base = time.Date(2026, 7, 8, 12, 0, 0, 0, time.UTC)
// seededService builds a Service whose read cache already holds st for id, so the read methods
// resolve without a database (the store's db is nil). The clock is pinned to base.
func seededService(id uuid.UUID, st walletState) *Service {
store := NewStore(nil)
store.cache.put(id, st)
return &Service{store: store, clock: func() time.Time { return base }}
}
func TestStackNoAds(t *testing.T) {
future := base.Add(48 * time.Hour)
past := base.Add(-time.Hour)
tests := []struct {
name string
current *time.Time
addDays int
want *time.Time
}{
{"fresh term", nil, 3, new(base.Add(72 * time.Hour))},
{"stack onto future", new(future), 2, new(future.Add(48 * time.Hour))},
{"lapsed term restarts from now", new(past), 1, new(base.Add(24 * time.Hour))},
{"zero days unchanged", new(future), 0, new(future)},
{"zero days, nil stays nil", nil, 0, nil},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
got := stackNoAds(tc.current, tc.addDays, base)
if (got == nil) != (tc.want == nil) || (got != nil && !got.Equal(*tc.want)) {
t.Errorf("stackNoAds = %v, want %v", got, tc.want)
}
})
}
}
func TestCombineNoAds(t *testing.T) {
pFuture := base.Add(24 * time.Hour)
sFuture := base.Add(72 * time.Hour) // 3 days remaining
// primary future + secondary future: primary end + secondary's remaining (72h).
if got := combineNoAds(new(pFuture), new(sFuture), base); !got.Equal(pFuture.Add(72 * time.Hour)) {
t.Errorf("combine both future = %v, want %v", got, pFuture.Add(72*time.Hour))
}
// primary nil + secondary future: now + secondary's remaining.
if got := combineNoAds(nil, new(sFuture), base); !got.Equal(base.Add(72 * time.Hour)) {
t.Errorf("combine nil primary = %v, want %v", got, base.Add(72*time.Hour))
}
// secondary lapsed: primary unchanged.
if got := combineNoAds(new(pFuture), new(base.Add(-time.Hour)), base); !got.Equal(pFuture) {
t.Errorf("combine lapsed secondary = %v, want %v", got, pFuture)
}
// secondary nil: primary unchanged.
if got := combineNoAds(new(pFuture), nil, base); !got.Equal(pFuture) {
t.Errorf("combine nil secondary = %v, want %v", got, pFuture)
}
}
func TestPlanDraws(t *testing.T) {
st := walletState{chips: map[Source]int{SourceDirect: 30, SourceVK: 50, SourceTelegram: 5}}
// price met entirely by the first (direct) segment.
if draws, ok := planDraws(st, []Source{SourceDirect, SourceVK}, 20); !ok || len(draws) != 1 || draws[0] != (sourceAmount{SourceDirect, 20}) {
t.Errorf("single-segment draw = %v ok=%v", draws, ok)
}
// price spills from direct into vk by priority.
draws, ok := planDraws(st, []Source{SourceDirect, SourceVK, SourceTelegram}, 60)
want := []sourceAmount{{SourceDirect, 30}, {SourceVK, 30}}
if !ok || len(draws) != 2 || draws[0] != want[0] || draws[1] != want[1] {
t.Errorf("priority spill draw = %v ok=%v, want %v", draws, ok, want)
}
// insufficient total.
if _, ok := planDraws(st, []Source{SourceDirect, SourceVK, SourceTelegram}, 200); ok {
t.Error("expected insufficient")
}
}
func TestWalletSegments(t *testing.T) {
id := uuid.New()
st := walletState{chips: map[Source]int{SourceDirect: 100, SourceVK: 50}}
svc := seededService(id, st)
present := []Source{SourceDirect, SourceVK}
// Web/native: both attached segments shown, both spendable.
got, err := svc.Wallet(context.Background(), id, NewContext("direct", "web"), present)
if err != nil {
t.Fatal(err)
}
if len(got.Segments) != 2 || !got.Segments[0].Spendable || got.Segments[0].Source != SourceDirect {
t.Errorf("direct wallet segments = %+v", got.Segments)
}
// VK Android: only vk shown, spendable.
got, _ = svc.Wallet(context.Background(), id, NewContext("vk", "android"), present)
if len(got.Segments) != 1 || got.Segments[0].Source != SourceVK || !got.Segments[0].Spendable {
t.Errorf("vk-android wallet = %+v", got.Segments)
}
// VK iOS: only vk shown, frozen (not spendable) but the balance is visible.
got, _ = svc.Wallet(context.Background(), id, NewContext("vk", "ios"), present)
if len(got.Segments) != 1 || got.Segments[0].Chips != 50 || got.Segments[0].Spendable {
t.Errorf("vk-ios wallet = %+v (want vk 50 frozen)", got.Segments)
}
}
func TestAdFreeByContext(t *testing.T) {
id := uuid.New()
future := base.Add(48 * time.Hour)
ctx := context.Background()
// A vk-origin no-ads term applies inside VK and out on web, but a direct-origin term never
// applies inside VK (the compliance wall).
svc := seededService(id, walletState{benefits: map[Source]benefitState{
SourceVK: {adsPaidUntil: new(future)},
SourceDirect: {adsPaidUntil: new(future)},
}})
present := []Source{SourceDirect, SourceVK}
cases := []struct {
name string
cxt Context
want bool
}{
{"vk term inside vk", NewContext("vk", "android"), true},
{"vk term inside vk-ios (applies while frozen)", NewContext("vk", "ios"), true},
{"terms on web", NewContext("direct", "web"), true},
{"untrusted fail-closed", NewContext("", ""), false},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
got, err := svc.AdFree(ctx, id, tc.cxt, present)
if err != nil || got != tc.want {
t.Errorf("AdFree = %v (err %v), want %v", got, err, tc.want)
}
})
}
// Compliance: ONLY a direct-origin term, checked inside VK, must not suppress ads.
svc2 := seededService(id, walletState{benefits: map[Source]benefitState{SourceDirect: {adsPaidUntil: new(future)}}})
if got, _ := svc2.AdFree(ctx, id, NewContext("vk", "android"), present); got {
t.Error("direct-origin no-ads must NOT apply inside VK (compliance wall)")
}
}
func TestHintsAvailableByContext(t *testing.T) {
id := uuid.New()
svc := seededService(id, walletState{benefits: map[Source]benefitState{
SourceDirect: {hints: 3},
SourceVK: {hints: 2},
}})
present := []Source{SourceDirect, SourceVK}
ctx := context.Background()
// Web: both applicable origins summed.
if n, _ := svc.HintsAvailable(ctx, id, NewContext("direct", "web"), present); n != 5 {
t.Errorf("web hints = %d, want 5", n)
}
// VK: only vk-origin hints.
if n, _ := svc.HintsAvailable(ctx, id, NewContext("vk", "android"), present); n != 2 {
t.Errorf("vk hints = %d, want 2", n)
}
// Untrusted: none.
if n, _ := svc.HintsAvailable(ctx, id, NewContext("", ""), present); n != 0 {
t.Errorf("untrusted hints = %d, want 0", n)
}
}
func TestSpendHintUntrustedNoOp(t *testing.T) {
id := uuid.New()
svc := seededService(id, walletState{benefits: map[Source]benefitState{SourceDirect: {hints: 3}}})
// Untrusted context: no applicable origin, so nothing is spent and the DB (nil) is never hit.
spent, err := svc.SpendHint(context.Background(), id, NewContext("", ""), []Source{SourceDirect})
if err != nil || spent {
t.Errorf("untrusted SpendHint = %v (err %v), want false", spent, err)
}
}
+29 -6
View File
@@ -10,6 +10,7 @@ import (
"scrabble/backend/internal/ads"
"scrabble/backend/internal/engine"
"scrabble/backend/internal/notify"
"scrabble/backend/internal/payments"
)
// bannerDTO is the advertising-banner block attached to an eligible viewer's
@@ -55,7 +56,21 @@ type bannerTimingsDTO struct {
// a language switch).
func (s *Server) profileResponse(ctx context.Context, acc account.Account) profileResponse {
r := profileResponseFor(acc)
r.Banner = s.bannerFor(ctx, acc)
// Resolve the payments gate once (execution context + present sources) and feed it to both
// the hint count and the banner. The profile hint balance now comes from the payments benefit
// (context-aware), not the deprecated accounts.hint_balance column; on any failure the legacy
// value from profileResponseFor (zeroed in production) stands.
cxt, present, err := s.walletGate(ctx, acc.ID)
if err != nil {
s.log.Warn("profile: wallet gate failed", zap.String("account", acc.ID.String()), zap.Error(err))
} else if s.payments != nil {
if hints, herr := s.payments.HintsAvailable(ctx, acc.ID, cxt, present); herr == nil {
r.HintBalance = hints
} else {
s.log.Warn("profile: hint balance read failed", zap.String("account", acc.ID.String()), zap.Error(herr))
}
}
r.Banner = s.bannerFor(ctx, acc, cxt, present)
s.fillLinkedIdentities(ctx, &r, acc.ID)
r.DictVersions = s.currentDictVersions()
return r
@@ -115,7 +130,7 @@ func (s *Server) fillLinkedIdentities(ctx context.Context, r *profileResponse, a
// language, falling back to its interface language and then English. A failure
// reading roles or campaigns is logged and treated as "no banner" so the profile
// response still succeeds.
func (s *Server) bannerFor(ctx context.Context, acc account.Account) *bannerDTO {
func (s *Server) bannerFor(ctx context.Context, acc account.Account, cxt payments.Context, present []payments.Source) *bannerDTO {
if s.ads == nil {
return nil
}
@@ -124,16 +139,24 @@ func (s *Server) bannerFor(ctx context.Context, acc account.Account) *bannerDTO
s.log.Warn("banner: active set failed", zap.String("account", acc.ID.String()), zap.Error(err))
return nil
}
// An urgent campaign is shown to every viewer; otherwise the normal eligibility
// gate applies (a paid account, a non-empty hint wallet or the no_banner role
// hides the banner).
// An urgent campaign is shown to every viewer; otherwise the banner is suppressed by the
// no_banner role or by an active no-ads benefit applicable in the viewer's context (the
// payments gate — a hint balance no longer suppresses the banner). An untrusted platform is
// fail-closed by the gate, so it does not suppress the banner.
if !urgent {
hasNoBanner, err := s.accounts.HasRole(ctx, acc.ID, account.RoleNoBanner)
if err != nil {
s.log.Warn("banner: role check failed", zap.String("account", acc.ID.String()), zap.Error(err))
return nil
}
if !ads.Eligible(acc.PaidAccount, acc.HintBalance, hasNoBanner) {
adFree := false
if s.payments != nil {
if adFree, err = s.payments.AdFree(ctx, acc.ID, cxt, present); err != nil {
s.log.Warn("banner: ad-free check failed", zap.String("account", acc.ID.String()), zap.Error(err))
return nil
}
}
if hasNoBanner || adFree {
return nil
}
}
+14
View File
@@ -15,6 +15,7 @@ import (
"scrabble/backend/internal/feedback"
"scrabble/backend/internal/game"
"scrabble/backend/internal/lobby"
"scrabble/backend/internal/payments"
"scrabble/backend/internal/session"
"scrabble/backend/internal/social"
)
@@ -65,6 +66,11 @@ func (s *Server) registerRoutes() {
// client may still reach, to fetch the block's expiry and reason for the blocked screen.
u.GET("/block-status", s.handleBlockStatus)
}
if s.payments != nil {
// The wallet: the context-visible chip segments + benefits, and a chip spend on a value.
u.GET("/wallet", s.handleWallet)
u.POST("/wallet/buy", s.handleWalletBuy)
}
if s.links != nil {
// Account linking & merge. The request step always mails a code;
// a required merge is revealed only after the code is verified, and the
@@ -250,6 +256,14 @@ func statusForError(err error) (int, string) {
return http.StatusConflict, "last_identity"
case errors.Is(err, accountmerge.ErrActiveGameConflict):
return http.StatusConflict, "merge_active_game_conflict"
case errors.Is(err, payments.ErrUntrusted):
return http.StatusForbidden, "payments_untrusted"
case errors.Is(err, payments.ErrInsufficientChips):
return http.StatusConflict, "insufficient_chips"
case errors.Is(err, payments.ErrProductNotFound):
return http.StatusNotFound, "product_not_found"
case errors.Is(err, payments.ErrNotAValue):
return http.StatusBadRequest, "not_a_value"
case errors.Is(err, account.ErrInvalidEmail):
return http.StatusBadRequest, "invalid_email"
case errors.Is(err, account.ErrCodeMismatch), errors.Is(err, account.ErrCodeExpired),
+102
View File
@@ -0,0 +1,102 @@
package server
import (
"net/http"
"github.com/gin-gonic/gin"
"github.com/google/uuid"
"scrabble/backend/internal/payments"
)
// walletSegmentDTO is one chip balance in the wallet view: the funding source, the chip count,
// and whether it can be spent in the current execution context (false for a frozen VK-iOS
// balance or an untrusted platform).
type walletSegmentDTO struct {
Source string `json:"source"`
Chips int `json:"chips"`
Spendable bool `json:"spendable"`
}
// walletDTO is the user-facing wallet: the context-visible chip segments and the
// context-applicable benefits (the no-ads term or forever flag, and the available hints).
type walletDTO struct {
Segments []walletSegmentDTO `json:"segments"`
AdsForever bool `json:"ads_forever"`
AdsPaidUntil int64 `json:"ads_paid_until_ms"` // unix millis; 0 = no active term
Hints int `json:"hints"`
}
// walletBuyRequest is the POST body of a chip spend: the product to buy with chips.
type walletBuyRequest struct {
ProductID string `json:"product_id"`
}
// walletDTOFrom projects a payments wallet view into the wire DTO.
func walletDTOFrom(v payments.WalletView) walletDTO {
out := walletDTO{AdsForever: v.Benefits.AdsForever, Hints: v.Benefits.Hints}
if v.Benefits.AdsPaidUntil != nil {
out.AdsPaidUntil = v.Benefits.AdsPaidUntil.UnixMilli()
}
out.Segments = make([]walletSegmentDTO, 0, len(v.Segments))
for _, seg := range v.Segments {
out.Segments = append(out.Segments, walletSegmentDTO{Source: string(seg.Source), Chips: seg.Chips, Spendable: seg.Spendable})
}
return out
}
// handleWallet returns the caller's wallet — the segments and benefits visible in the current
// trusted execution context.
func (s *Server) handleWallet(c *gin.Context) {
uid, ok := userID(c)
if !ok {
return
}
ctx := c.Request.Context()
cxt, present, err := s.walletGate(ctx, uid)
if err != nil {
s.abortErr(c, err)
return
}
view, err := s.payments.Wallet(ctx, uid, cxt, present)
if err != nil {
s.abortErr(c, err)
return
}
c.JSON(http.StatusOK, walletDTOFrom(view))
}
// handleWalletBuy spends chips on a chip-priced value and returns the updated wallet. It is
// fail-closed: an untrusted or frozen context, or an insufficient balance, is refused.
func (s *Server) handleWalletBuy(c *gin.Context) {
uid, ok := userID(c)
if !ok {
return
}
var req walletBuyRequest
if err := c.ShouldBindJSON(&req); err != nil {
c.AbortWithStatusJSON(http.StatusBadRequest, errorResponse{Error: errorBody{Code: "invalid_request", Message: "invalid request body"}})
return
}
productID, err := uuid.Parse(req.ProductID)
if err != nil {
c.AbortWithStatusJSON(http.StatusBadRequest, errorResponse{Error: errorBody{Code: "invalid_request", Message: "invalid product id"}})
return
}
ctx := c.Request.Context()
cxt, present, err := s.walletGate(ctx, uid)
if err != nil {
s.abortErr(c, err)
return
}
if err := s.payments.Spend(ctx, uid, cxt, present, productID); err != nil {
s.abortErr(c, err)
return
}
view, err := s.payments.Wallet(ctx, uid, cxt, present)
if err != nil {
s.abortErr(c, err)
return
}
c.JSON(http.StatusOK, walletDTOFrom(view))
}
+31
View File
@@ -0,0 +1,31 @@
package server
import (
"context"
"github.com/google/uuid"
"scrabble/backend/internal/payments"
"scrabble/backend/internal/session"
)
// walletGate resolves the payments gate inputs for an account on the current request: the
// trusted execution context (the session platform carried on ctx by the platformContext
// middleware; absent ⇒ untrusted, fail-closed) and the account's present identity sources
// (which chip/benefit segments are awake, §6). The payments domain holds no cross-schema
// identity knowledge, so the server supplies present from account.Identities.
func (s *Server) walletGate(ctx context.Context, accountID uuid.UUID) (payments.Context, []payments.Source, error) {
var cxt payments.Context
if p, ok := session.PlatformFromContext(ctx); ok {
cxt = payments.NewContext(p.Kind, p.Subtype)
}
ids, err := s.accounts.Identities(ctx, accountID)
if err != nil {
return payments.Context{}, nil, err
}
kinds := make([]string, len(ids))
for i, id := range ids {
kinds[i] = id.Kind
}
return cxt, payments.PresentSources(kinds), nil
}
+10
View File
@@ -273,6 +273,16 @@ the **origin benefit applicable in the current context** rather than one global
`(account, origin)` are a fast **materialized** cache, updated **in the same transaction** as
the ledger write, and recomputable from the ledger for reconciliation.
**In-process read cache.** On top of the materialized tables, the payments package keeps an
in-process, account-keyed, write-through cache of each account's segments and benefits, so the
hot read paths — the ad-eligibility check, hint availability, the wallet view, the spend gate
— issue **no** query to the `payments` schema on the steady-state path. It is invalidated on
every payments mutation (spend / grant / fund / refund / merge) and re-read from the
materialized tables on a miss (the same write-through pattern the account-suspension gate
uses). Single-instance, matching the deployment; a multi-instance backend would need a shared
cache. Identity-presence (which segments are awake, §6) is supplied by the caller, not cached
here, so unlink/re-link takes effect immediately.
**Admin rewards.** An admin grants **concrete values only** (no-ads / hints) — **never
chips** (a gifted currency balance = a store cash-desk bypass). The admin **picks the
origin** at grant time (compliance is on them: `origin=vk` point-wise/low-volume = low risk,
+293
View File
@@ -0,0 +1,293 @@
# Монетизация scrabble-game — проектирование и внедрение
## Context
Игра в проде (`erudit-game.ru`), мультиплатформенная (VK / Telegram Mini App /
web+PWA / native Android+iOS через Capacitor). Владелец (самозанятый, НПД) хочет
ввести монетизацию: игровая валюта «Фишка», раздельные кошельки по платформам,
покупка бенефитов (без рекламы, подсказки, будущий турнирный взнос), rewarded-реклама
как канал пополнения, строгий транзакционный лог и админ-отчёты.
Отправная точка — `monetization-prerequisites.md` (пожелания владельца). Цель этого
процесса: (1) через интервью выстроить чёткую модель, (2) оформить и поддерживать
`PAYMENTS.md` (механики + договорённости), (3) составить `PLAN.md` (поэтапное
внедрение от основ к интеграциям).
### Что уже есть в коде (переиспользуем)
- `accounts.hint_balance int` (`CHECK >= 0`) + атомарный `SpendHint` / `GrantHints`
(`backend/internal/account/account.go:551-595`) — существующий «кошелёк подсказок»,
но пополняется только админом, покупки нет.
- `accounts.paid_account bool` — пожизненный флаг «без рекламы», уже читается в
`ads.Eligible(...)` (`backend/internal/ads/ads.go:107`); «no purchase flow yet».
- Реклама сейчас = внутренний server-driven **текст-баннер** (`ads` домен + UI
`AdBanner.svelte`), гасится `paid_account` / `hint_balance>0` / роль `no_banner`.
Rewarded-видео нет нигде.
- Подсказки — фича готова end-to-end (кнопка, 30-мин gate, vs_ai безлимит).
- Settings — таб-хаб (`ui/src/screens/SettingsHub.svelte`), вставка «Кошелёк» между
«Друзья» и «Инфо» чистая.
- Админка `/_gm` — per-user карточка уже показывает `PaidAccount`+`HintBalance`;
прецедент денежного действия — `POST /_gm/users/:id/grant-hints`.
- Один аккаунт держит VK+TG+email identity **разом** (kind∈telegram/vk/email/robot);
мерж сейчас **складывает** `hint_balance` и OR-ит `paid_account`.
- Прецедент изолированного сервиса: connector (gRPC), renderer (HTTP-sidecar),
platform/telegram. Прецедент public HMAC-подписанного роута (экспорт партии) —
образец для приёмника вебхуков.
### Greenfield
Валюта «Фишка», реальные рельсы (Stars / Голоса / Robokassa), rewarded-видео,
раздельные кошельки, транзакционный леджер, PITR/репликация, серверное знание
платформы.
## Зафиксированные решения (Decisions Log)
- **D1. Модель валюты — двухуровневая.** Деньги (Голоса/Stars/руб) и rewarded-реклама
пополняют баланс «Фишек»; за Фишки покупаются ценности (без рекламы, подсказки,
турнир). Витрина ценностей — в Фишках.
- **D2. Фишка единая (1 = 1 везде).** Разница по методам оплаты сидит **в курсе
покупки Фишек** (пакет стоит X Голосов / Y Stars / Z руб, курс учитывает комиссии
сторов). Цена ценностей — фиксирована в Фишках, одинакова для всех методов.
- **D3. Изоляция — схема `payments` в общем инстансе Postgres** + доменная граница
(свой store/service/интерфейс) + отдельный DB-роль (права только на `payments`).
Атомарность «Фишки↔бенефит» с `backend.accounts` сохраняется (cross-schema tx в
одном инстансе). Отдельный процесс/БД отвергнуты: ломают атомарность выдачи бенефита
(бенефиты живут на `accounts`), цена распределённых транзакций не окупается. Вынос в
отдельный сервис оставлен как возможность на потом (граница уже чистая).
- **D4. Сохранность — PITR** (непрерывный WAL-архив, pgBackRest/WAL-G на 2-й хост или
объектное хранилище). Тёплая реплика — опция на потом. Durability решается этим, а не
топологией БД.
- **D5. Сегмент кошелька — по source (vk / telegram / direct) на аккаунте.** Баланс =
(account_id, source), ровно 3 сегмента. Не per-identity.
- **D6. Комплаенс-гейт — логический, аккаунт единый.** email/direct физически привязан
(мерж, единый профиль/друзья/статистика), но в VK/TG-контексте сервер активирует
только одноимённый сегмент; чужое (в первую очередь direct) внутри VK/TG невидимо и
не тратится. Гейт держится на **доверенном сигнале платформы** (проставляет гейтвей
из подписанного контекста, не тело запроса — клиенту не верим).
- **D7. Три операции разведены:** (1) пополнение Фишек по контексту; (2) трата Фишек =
покупка бенефита, по контексту с гейтом (в VK только vk; в вебе direct+vk+tg по
приоритету direct→vk→tg); (3) применение бенефита во времени.
- **D8. origin бенефита = контекст ПОКУПКИ** (не «чем оплачено»). Правило послабления:
origin∈{vk,tg} → действует **везде** (в сторе и наружу в web/native);
origin=direct → **только** web/native (внутрь VK/TG нельзя = бан). Срок «без рекламы»
хранится **per-origin** (`paid_until` на origin, покупки одного origin складываются/
сдвигают дату); «реклама выключена в контексте P» = есть применимый в P origin с
`paid_until > now` (в вебе берём максимум direct/vk/tg, в VK — только vk, в TG — tg).
- **D9. «Без рекламы» гасит** верхний баннер + fullscreen-ролик после хода. Добровольный
**rewarded** (за Фишки) не трогаем.
- **D10. UX-требование:** при трате tg/vk-Фишек **в вебе** — предупредить юзера ДО
покупки, что купленная механика будет доступна только здесь (web/native), т.к.
ограничения VK/TG.
- **D11. Три сущности разведены:** Фишки (валюта, сегмент по **source** = где
пополнено), Подсказки (расходник, сегмент по **origin** = где куплено), «Без рекламы»
(срок, сегмент по **origin**). source и origin — одна ось значений {vk,tg,direct},
но разная семантика; в вебе source и origin расходятся (vk-Фишки → direct-покупка).
- **D12. Подсказки — по origin с обратным послаблением** (vk/tg→везде, direct→только
web/native), как «без рекламы». Списание в онлайн-игре = из origin, применимого в
контексте; переписать `SpendHint` (`game/service.go:1147`) на контекст-аварное
списание. vs_ai подсказки остаются бесплатными/безлимитными (не в счёт).
- **D13. `accounts.hint_balance` выводим** expand-contract (сначала игнор, потом DROP);
legacy-баланс **обнуляем** (в проде даров не было).
- **D14. Unlink vk/tg — разрешён, сегмент усыпляется.** Сегмент доступен ⟺ на аккаунте
есть identity этого source (direct ⟺ есть устойчивый identity/email). Отвязка не
сжигает баланс/бенефит — усыпляет; re-link будит. Перед отвязкой — предупреждение
«N Фишек станут недоступны до повторной привязки». Последнюю identity отвязать нельзя
(существующий `ErrLastIdentity`).
- **D15. Мерж — слияние по origin:** одноимённые сегменты складываются (Фишки sum,
сроки бенефита продлеваются per-origin), разные сосуществуют. Прямое расширение
текущего `hint_balance +=` / `paid_account OR=`; origin сохраняется, ничего не
протекает между платформами.
- **D16. Админ-награждение:** админ начисляет **только конкретные ценности** (без
рекламы / подсказки), **никогда не Фишки** (подаренный баланс валюты = обход кассы
стора). Админ **выбирает origin** при выдаче (ответственность за комплаенс на нём:
origin=vk точечно/малый объём = низкий риск, origin=direct = безопасно). Грант =
транзакция типа `admin_grant` в едином леджере, цена 0 Фишек — полный аудит наград.
- **D17. Доверенная платформа = свойство сессии,** переподтверждается свежей подписью
(VK sign / TG `initData`) при **каждом холодном старте** (не однократно при входе —
обёртка всё равно шлёт подпись каждое открытие). `direct` фиксируется фактом создания
веб/native-сессии (внешней подписи нет и не нужно — доступ к vk/tg-сегментам в direct
всё равно требует реальной привязки, D14). Backend получает `platform` при резолве
сессии. Платформа несёт **kind** (vk/tg/direct) **+ подтип** (ios/android/web) —
подтип обязателен (VK iOS заморожен). TG `initData`-валидатор уже есть
(`platform/telegram/internal/initdata`).
- **D18. Fail-closed:** недоверенная/неподтверждённая платформа (VK/TG-сессия без
валидной подписи на старте; старая сессия без записанной платформы) → запрет
трат/покупок/применения чужого origin, только просмотр.
- **D19. Дистрибуция native Android:** RuStore (Robokassa разрешён, чистый direct) +
Google Play (**direct-покупки скрыты** — на «Кошельке» заглушка «установите версию из
RuStore для покупок»; rewarded-реклама и трата уже накопленных Фишек работают). Перед
GP-релизом свериться с актуальными правилами Google по внутренней валюте.
- **D20. Приём оплаты — только серверный колбэк провайдера.** Фишки начисляются лишь по
проверенному (подпись/HMAC) серверному уведомлению: Robokassa webhook / TG
`successful_payment` / VK callback. Клиентское «я оплатил» игнорируется.
- **D21. Единый payments-домен — единственный писатель леджера.** Публичные вебхуки
(Robokassa/VK) терминируются на edge (Caddy/gateway) и проксируются в payments;
TG `successful_payment` → бот → payments. Один источник начисления/идемпотентности.
- **D22. Order-flow с предзаказом.** Сервер создаёт `order(pending)` с account/
платформой/пакетом/ожидаемой суммой/origin; `order_id` прокидывается провайдеру
(Robokassa `InvId` / TG `invoice_payload` / VK `item` — точную форму VK уточнить при
интеграции). Колбэк матчится по `order_id` (не по сумме → коллизия сумм невозможна),
сверяет сумму, начисляет, помечает `paid`. **Идемпотентность** — дедуп по (провайдер,
`provider_payment_id`).
- **D23. Pending невидим юзеру;** авто-expiry по таймауту (~30 мин — гигиена БД). Но
**валидный колбэк исполняется ВСЕГДА**, даже на истёкшем order (`expired` ≠ отмена —
деньги реальны, обязаны выдать). Юзер видит только успешные покупки.
- **D24. Экран «Кошелёк» — минимальный:** балансы Фишек (доступные в контексте) +
активные бенефиты (без рекламы до даты, счётчик подсказок). **Без ленты истории**
(шумит, отвлекает от игры). Полная история — только в админке.
- **D25. TG-бот outbox — SQLite на диске бота.** Store-and-forward: получил
`successful_payment` → сохранил в SQLite → подтвердил апдейт Telegram → форвардит в
payments (идемпотентно, дедуп по `telegram_payment_charge_id`) → ack → `forwarded`.
Ретраи с backoff, дореталивание при рестарте. At-least-once доставка + идемпотентный
приём = начисление ровно один раз.
- **D26. Событийный слой `payment_events`** (succeeded/failed/refunded) + диспетчер по
каналам: live gRPC-стрим (если юзер в аппе), иначе `botlink`/email-relay
(существующие). «Оплата не прошла» = **активный отказ провайдера** (не брошенный
pending) — доводится до юзера. «Оплата прошла» — хук (письмо/сообщение в бота).
- **D27. Возвраты.** ToS «невозвратно» — юзеру возврат не предлагаем. **Админ может
сделать ручной возврат** (исключение: юзер требует вскоре после оплаты / закрывает
аккаунт — связать с `accountdelete`, где уже правило «сообщения не трогаем»).
**Внешние возвраты** (чарджбек / решение стора / TG / VK) — система принимает событие
`refunded`, **по возможности** отзывает бенефит (в минус НЕ уходим; если Фишки
потрачены — фиксируем убыток + флаг защиты от злоупотреблений), пишет в журнал.
Журнал операций **проектируем экспортопригодным** (будущая налоговая отчётность +
авто-сверка с Robokassa) — реализацию сверки пока не делаем, схему закладываем
совместимой.
- **D28. Стартовый охват видео-рекламы — только VK** (рублёвый доход, ОРД автоматом,
API готов). web/native/TG — существующий текст-баннер. Рекламный провайдер
закладываем **абстракцией** (будущая крутилка для других платформ встроится без
переделки). Крипто-провайдеры (AdsGram/AdMob) отвергнуты — нет легального рублёвого
дохода самозанятому (санкции + НПД не учитывает крипту).
- **D29. Rewarded (добровольный ролик за Фишки)** начисляет Фишки через payments по
**серверному verify-колбэку** рекламной сети (клиенту не верим, как платёж). Не
гасится «без рекламы». Сколько Фишек за просмотр — в блоке экономики.
- **D30. Частота навязанного interstitial** (конфигурируемые серверные значения):
глобальный кулдаун **на юзера сквозь все партии**, дефолт **5 мин**; **vs_ai — 30 мин**
(соосно кулдауну подсказок). Применение **подсказки** триггерит ролик после хода
**независимо** от основного кулдауна, со своим кулдауном **1 мин**. Оффлайн — только
баннер. Уважать собственные лимиты частоты VK.
- **D31. `paid_account` тоже deprecated** → удаление из схемы (как `hint_balance`), в
пользу per-origin бенефитов «без рекламы». Существующий `ads.Eligible`
(`backend/internal/ads/ads.go:107`) расширяется: баннер гасится по origin-бенефиту,
**применимому в текущем контексте**, а не по одному глобальному флагу. Legacy
`paid_account`/`hint_balance` в проде никем не выставлены (потока покупки не было) →
обнуляем/игнорируем, после релиза платежей дропаем.
- **D32. Каталог — конфигурируемый (БД + админка).** Базовые ценности (атомы
начисления): Фишки, подсказки, дни-без-рекламы, участие-в-турнире. **Продукт = набор
атомов + цена** (по одной ценности или комбо). «Пакет Фишек» — цена **per-метод**
(мультивалютная: Голоса/Stars/руб — один продукт, D2). «Ценность за Фишки» — цена в
Фишках (единая). Курсы покупки Фишек и Фишки за rewarded — тоже в каталоге.
- **D33. Стекинг «без рекламы»:** `paid_until[origin] += срок` от `max(now, текущий
конец)` (остаток не теряется, «плюсуются» как в документе). «Навсегда» — отдельный
вечный флаг (перекрывает сроки). Бонусы «(+50)» — маркетинговая пометка владельца;
юзеру показываем финальную цифру, в модели просто количество.
- **D34. Деактивация, не удаление.** Продукты soft-delete (деактивация). Покупка хранит
**снимок проданного** (состав атомов + цена на момент) → архив. Для истории, чеков,
налоговой — покупка не зависит от дальнейших правок/деактивации каталога.
- **D35. Антифрод rewarded — только серверный verify провайдера** на старте (без своего
дневного потолка). Провайдер-абстракция позволит добавить лимиты позже.
- **D36. Email/direct.** У гостей раздел «Кошелёк» **скрыт полностью**; баланс и
покупки — **только у durable-аккаунтов**. В direct email обязателен **перед первой
покупкой** (якорь восстановления доступа; в VK/TG якорь — сама vk/tg-привязка). Флоу
email уже есть (запрос кода → подтверждение → `ClearGuest` → durable).
- **D37. Reaper — гостей чистит свободно:** у гостя баланса нет by design (Кошелёк
скрыт, покупок нет, direct-rewarded нет). Спец-защита не нужна.
- **D38. Гостевые ограничения — ОТДЕЛЬНЫЙ этап монетизации** (воронка к регистрации).
Набор: макс **1 активная игра со случайным + 1 vs_ai**; **серверный** guest-гейт на
friend-request / redeem-code / invitation-create. Находка: сейчас гейт **только в UI**
— `social/friends.go:50` (`SendFriendRequest`), `robotfriends.go:41` (`RequestInGame`),
`friendcodes.go:67` (`RedeemFriendCode`), `lobby/invitations.go:208`
(`CreateInvitation`) **не проверяют `is_guest`**. Это изменение поведения игры → свой
этап со своими тестами.
- **D39. Хранение — неизменяемый журнал + материализованный баланс.** Журнал операций
**append-only** (только INSERT, никогда UPDATE/DELETE — полный аудит, №3). Баланс
сегмента `(account, source)` и бенефиты `(account, origin)` — быстрый материализованный
кэш, обновляется **в той же транзакции**, что и запись журнала; пересчитывается из
журнала для сверки.
- **D40. Финансовый отчёт per-user в `/_gm`** — балансы сегментов, платежи, траты,
гранты, возвраты, полная история — расширение существующей карточки
(`UserDetailView`, `handlers_admin_console.go:343`). Плюс экспорт журнала (D27).
- **D41. Налоги/чеки — авто через провайдера.** **Robokassa** (direct) — авточек НПД
(режим самозанятого). **VK** — сам процессит Голоса через налоговую (владельцу делать
нечего). **TG Stars** — налоговой стороны нет (для РФ-самозанятого невыводимы легально
= не доход по НПД; принимаем, чек не формируем). ОРД по VK-рекламе — на стороне VK.
*(Не юридическая консультация — точную схему НПД владелец сверяет с налоговой стороной.)*
## Заметки к оформлению документов
- **Язык документов (решено).** `PAYMENTS.md` — **на английском**, терминами как в коде
и общепринятыми (`ledger`, `refund`, `idempotency`, `order`, …). Рядом
`PAYMENTS_ru.md` — перевод на простой русский владельца. Паттерн `FUNCTIONAL.md` +
`FUNCTIONAL_ru.md`, уже принятый в репозитории; мирроринг правок — в том же PR.
- **Язык диалога** с владельцем — по-русски, без калек-англицизмов
(«леджер»→«журнал операций»). Сохранить как feedback-память после выхода из plan mode.
- **Формат интервью (владелец флагнул дважды).** ВСЕ вопросы владельцу — только через
интерактивное интервью (AskUserQuestion). НИКОГДА не выносить вопросы в текст ответа,
даже «мелкие» или «да/нет»: смешение текстовых и интерактивных вопросов раздражает и
ведёт к пропускам. Текст — только для фиксации решённого и пояснений. Усилить
feedback-память `prefer-interview-mode` после plan mode.
## Все развилки закрыты (D1-D41)
Интервью завершено. Дальше — оформление документов и реализация по релизам.
## План внедрения (черновик PLAN.md — «слоями»)
Владелец выбрал слоёную стратегию: сначала вся механика без реальных денег (обкатка
через `admin_grant`), затем монетизация (все рельсы + реклама вместе).
### Релиз 1 — механика без денег (обкатка через `admin_grant`)
- **E0. Фундамент данных `payments`.** Схема + DB-роль + jetgen-таргет + миграции.
Таблицы: журнал операций (append-only, D39), балансы сегментов `(account, source)`,
бенефиты `(account, origin)` (paid_until/forever + подсказки count), каталог продуктов
(D32, soft-delete D34), заказы `orders` (D22), `payment_events` (D26). Доменный пакет с
жёсткой границей (D3). Старт deprecate `hint_balance`/`paid_account` (expand).
- **E1. Доверенный сигнал платформы.** Platform в сессии (kind+подтип), переподтверждение
на холодном старте (VK sign / TG `initData`), fail-closed (D17-D18); gateway прокидывает
`platform` в backend.
- **E2. Ядро валюты + бенефитов.** Баланс Фишек; трата Фишек → бенефит атомарно (D7);
гейт по контексту (D6-D8); применение per-origin (без рекламы стекинг D33, подсказки
D12); переписать `SpendHint` на контекст-аварное списание; миграция/обнуление legacy
(D13, D31). Обкатка начислений через `admin_grant` (D16).
- **E3. Кошелёк UI.** Раздел в `SettingsHub` (между Друзья/Инфо), балансы + бенефиты
(минимальный, D24), витрина каталога, скрыт у гостей (D36), GP-заглушка (D19),
предупреждение при трате vk/tg в вебе (D10).
### Релиз 2 — монетизация (рельсы + реклама вместе)
- **E4. Durability (PITR).** WAL-архив (pgBackRest/WAL-G, D4) — ДО первого реального
приёма денег.
- **E5. Приём платежей.** Order-flow (D22); единый payments-домен принимает колбэки
(D21); Robokassa + VK + TG (бот-outbox на SQLite, D25); идемпотентность; `payment_events`
+ диспетчер уведомлений (D26); чеки НПД (D41); внешние + ручные возвраты (D27).
- **E6. Реклама.** VK interstitial (частота-конфиг D30) + VK rewarded (verify→Фишки D29,
D35); `ads.Eligible` расширение per-origin (D31). Провайдер-абстракция (D28).
- **E7. Админка / отчёты.** Финансовый отчёт per-user в `/_gm` (D40); UI ручного
возврата; экспорт журнала (D27).
### Отдельный этап (изменение поведения игры)
- **E8. Гостевые ограничения.** Серверный guest-гейт друзей/приглашений + лимиты игр
(1 случайная + 1 vs_ai, D38). Свои тесты; можно вести параллельно.
### Будущее
- **E9. Турнирный взнос.** Тип-ценность заложен в E0; механика позже.
## Финальные артефакты
1. `PAYMENTS.md` (англ) + `PAYMENTS_ru.md` (рус) — **первыми**, из Decisions Log D1-D41;
поддерживать далее (мирроринг в том же PR, как FUNCTIONAL).
2. `PLAN.md` — из раздела «План внедрения» выше, с критериями готовности на этап.
3. Реализация по релизам, начиная с E0.
## Verification
Каждый этап — своим слоем (`docs/TESTING.md`): **unit** (гейт по контексту, стекинг
сроков, курсы, идемпотентность-ключи); **integration** (Postgres-backed атомарные
транзакции «Фишки↔бенефит», идемпотентность колбэков, бот-outbox доставка); **UI**
(Кошелёк, предупреждения, гость-скрыт, GP-заглушка); контурный прогон на `development`
перед промоушеном. Локальная полная проверка перед пушем (интеграция + UI + codegen).
Прод: expand-contract миграции (rollback-safe), PITR армирован до первого приёма денег.
Комплаенс-гейт — обязательная регрессия (direct-бенефит не активируется в VK/TG).
+10
View File
@@ -275,6 +275,16 @@ INSERT** (никогда UPDATE/DELETE — полный аудит). Балан
бенефиты `(account, origin)` — быстрый **материализованный** кэш, обновляется **в той же
транзакции**, что и запись журнала, и пересчитывается из журнала для сверки.
**In-process кэш чтения.** Поверх материализованных таблиц пакет payments держит
in-process кэш сегментов и бенефитов по ключу-аккаунту (write-through), чтобы горячие пути
чтения — проверка показа рекламы, доступность подсказок, экран кошелька, гейт траты — на
устоявшемся пути **не** делали ни одного запроса к схеме `payments`. Кэш инвалидируется на
каждой изменяющей операции payments (трата / грант / пополнение / возврат / мерж) и
перечитывается из материализованных таблиц при промахе (тот же write-through-паттерн, что и у
гейта блокировок аккаунта). Один инстанс — под текущий деплой; многоинстансный backend
потребовал бы общего кэша. Присутствие identity (какие сегменты «не спят», §6) передаёт
вызывающий, здесь не кэшируется, поэтому отвязка/повторная привязка действует сразу.
**Награждение админом.** Админ начисляет **только конкретные ценности** (без рекламы /
подсказки) — **никогда не Фишки** (подаренный баланс валюты = обход кассы стора). Админ
**выбирает origin** при выдаче (ответственность за комплаенс на нём: `origin=vk`
+36
View File
@@ -360,6 +360,42 @@ func (c *Client) Profile(ctx context.Context, userID string) (ProfileResp, error
return out, err
}
// WalletSegmentResp is one chip balance in the wallet: the funding source, the chip count, and
// whether it is spendable in the caller's current context.
type WalletSegmentResp struct {
Source string `json:"source"`
Chips int `json:"chips"`
Spendable bool `json:"spendable"`
}
// WalletResp is the caller's wallet: the context-visible chip segments and the context-applicable
// benefits (no-ads term end as unix millis / forever flag, and the available hints).
type WalletResp struct {
Segments []WalletSegmentResp `json:"segments"`
AdsForever bool `json:"ads_forever"`
AdsPaidUntil int64 `json:"ads_paid_until_ms"`
Hints int `json:"hints"`
}
// walletBuyBody is the chip-spend request body.
type walletBuyBody struct {
ProductID string `json:"product_id"`
}
// Wallet fetches the caller's wallet in their current execution context.
func (c *Client) Wallet(ctx context.Context, userID string) (WalletResp, error) {
var out WalletResp
err := c.do(ctx, http.MethodGet, "/api/v1/user/wallet", userID, "", nil, &out)
return out, err
}
// WalletBuy spends chips on a chip-priced value and returns the updated wallet.
func (c *Client) WalletBuy(ctx context.Context, userID, productID string) (WalletResp, error) {
var out WalletResp
err := c.do(ctx, http.MethodPost, "/api/v1/user/wallet/buy", userID, "", walletBuyBody{ProductID: productID}, &out)
return out, err
}
// BlockStatusResp is the caller's current manual-block state. Until is an RFC3339 UTC instant for
// a temporary block, empty for a permanent one or when not blocked; Reason is resolved to the
// account's language, empty when none was cited.
+28
View File
@@ -79,6 +79,34 @@ func encodeConfirmLinkResult(r backendclient.ConfirmLinkResp) []byte {
// encodeProfile builds a Profile payload, including the advertising-banner block
// when the backend marked the viewer eligible.
// encodeWallet builds the Wallet payload: the visible chip segments and the context-applicable
// benefits. Each WalletSegment table (and its source string) is built before the segments vector
// is opened, per FlatBuffers' rule against a nested table while another is under construction.
func encodeWallet(w backendclient.WalletResp) []byte {
b := flatbuffers.NewBuilder(128)
segs := make([]flatbuffers.UOffsetT, len(w.Segments))
for i, seg := range w.Segments {
src := b.CreateString(seg.Source)
fb.WalletSegmentStart(b)
fb.WalletSegmentAddSource(b, src)
fb.WalletSegmentAddChips(b, int32(seg.Chips))
fb.WalletSegmentAddSpendable(b, seg.Spendable)
segs[i] = fb.WalletSegmentEnd(b)
}
fb.WalletStartSegmentsVector(b, len(segs))
for i := len(segs) - 1; i >= 0; i-- {
b.PrependUOffsetT(segs[i])
}
segVec := b.EndVector(len(segs))
fb.WalletStart(b)
fb.WalletAddSegments(b, segVec)
fb.WalletAddAdsForever(b, w.AdsForever)
fb.WalletAddAdsPaidUntilMs(b, w.AdsPaidUntil)
fb.WalletAddHints(b, int32(w.Hints))
b.Finish(fb.WalletEnd(b))
return b.FinishedBytes()
}
func encodeProfile(p backendclient.ProfileResp) []byte {
b := flatbuffers.NewBuilder(192)
uid := b.CreateString(p.UserID)
+25
View File
@@ -52,6 +52,8 @@ const (
MsgFeedbackSubmit = "feedback.submit"
MsgFeedbackGet = "feedback.get"
MsgFeedbackUnread = "feedback.unread"
MsgWalletGet = "wallet.get"
MsgWalletBuy = "wallet.buy"
)
// Request is one decoded Execute call.
@@ -105,6 +107,8 @@ func NewRegistry(backend *backendclient.Client, tg TelegramValidator, opts ...Op
r.ops[MsgAuthEmailLogin] = Op{Handler: authEmailLoginHandler(backend), Email: true}
r.ops[MsgAuthEmailConfirmLink] = Op{Handler: authEmailConfirmLinkHandler(backend)}
r.ops[MsgProfileGet] = Op{Handler: profileHandler(backend), Auth: true}
r.ops[MsgWalletGet] = Op{Handler: walletHandler(backend), Auth: true}
r.ops[MsgWalletBuy] = Op{Handler: walletBuyHandler(backend), Auth: true}
r.ops[MsgBlockStatus] = Op{Handler: blockStatusHandler(backend), Auth: true}
r.ops[MsgGameSubmitPlay] = Op{Handler: submitPlayHandler(backend), Auth: true}
r.ops[MsgGameState] = Op{Handler: gameStateHandler(backend), Auth: true}
@@ -294,6 +298,27 @@ func profileHandler(backend *backendclient.Client) Handler {
}
}
func walletHandler(backend *backendclient.Client) Handler {
return func(ctx context.Context, req Request) ([]byte, error) {
w, err := backend.Wallet(ctx, req.UserID)
if err != nil {
return nil, err
}
return encodeWallet(w), nil
}
}
func walletBuyHandler(backend *backendclient.Client) Handler {
return func(ctx context.Context, req Request) ([]byte, error) {
in := fb.GetRootAsWalletBuyRequest(req.Payload, 0)
w, err := backend.WalletBuy(ctx, req.UserID, string(in.ProductId()))
if err != nil {
return nil, err
}
return encodeWallet(w), nil
}
}
func blockStatusHandler(backend *backendclient.Client) Handler {
return func(ctx context.Context, req Request) ([]byte, error) {
bs, err := backend.BlockStatus(ctx, req.UserID)
+24
View File
@@ -848,3 +848,27 @@ table NotificationEvent {
invitation:Invitation;
state:StateView;
}
// WalletSegment is one chip balance in the wallet view: the funding source
// ("vk"/"telegram"/"direct"), the chip count, and whether it is spendable in the current
// execution context (false for a frozen VK-iOS balance or an untrusted platform).
table WalletSegment {
source:string;
chips:int;
spendable:bool;
}
// Wallet is the user-facing wallet: the context-visible chip segments and the context-applicable
// benefits — the no-ads term end as unix milliseconds (0 = no active term) or the perpetual
// forever flag, and the available hint count.
table Wallet {
segments:[WalletSegment];
ads_forever:bool;
ads_paid_until_ms:long;
hints:int;
}
// WalletBuyRequest buys a chip-priced value with chips: the product to buy.
table WalletBuyRequest {
product_id:string;
}
+120
View File
@@ -0,0 +1,120 @@
// Code generated by the FlatBuffers compiler. DO NOT EDIT.
package scrabblefb
import (
flatbuffers "github.com/google/flatbuffers/go"
)
type Wallet struct {
_tab flatbuffers.Table
}
func GetRootAsWallet(buf []byte, offset flatbuffers.UOffsetT) *Wallet {
n := flatbuffers.GetUOffsetT(buf[offset:])
x := &Wallet{}
x.Init(buf, n+offset)
return x
}
func FinishWalletBuffer(builder *flatbuffers.Builder, offset flatbuffers.UOffsetT) {
builder.Finish(offset)
}
func GetSizePrefixedRootAsWallet(buf []byte, offset flatbuffers.UOffsetT) *Wallet {
n := flatbuffers.GetUOffsetT(buf[offset+flatbuffers.SizeUint32:])
x := &Wallet{}
x.Init(buf, n+offset+flatbuffers.SizeUint32)
return x
}
func FinishSizePrefixedWalletBuffer(builder *flatbuffers.Builder, offset flatbuffers.UOffsetT) {
builder.FinishSizePrefixed(offset)
}
func (rcv *Wallet) Init(buf []byte, i flatbuffers.UOffsetT) {
rcv._tab.Bytes = buf
rcv._tab.Pos = i
}
func (rcv *Wallet) Table() flatbuffers.Table {
return rcv._tab
}
func (rcv *Wallet) Segments(obj *WalletSegment, j int) bool {
o := flatbuffers.UOffsetT(rcv._tab.Offset(4))
if o != 0 {
x := rcv._tab.Vector(o)
x += flatbuffers.UOffsetT(j) * 4
x = rcv._tab.Indirect(x)
obj.Init(rcv._tab.Bytes, x)
return true
}
return false
}
func (rcv *Wallet) SegmentsLength() int {
o := flatbuffers.UOffsetT(rcv._tab.Offset(4))
if o != 0 {
return rcv._tab.VectorLen(o)
}
return 0
}
func (rcv *Wallet) AdsForever() bool {
o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
if o != 0 {
return rcv._tab.GetBool(o + rcv._tab.Pos)
}
return false
}
func (rcv *Wallet) MutateAdsForever(n bool) bool {
return rcv._tab.MutateBoolSlot(6, n)
}
func (rcv *Wallet) AdsPaidUntilMs() int64 {
o := flatbuffers.UOffsetT(rcv._tab.Offset(8))
if o != 0 {
return rcv._tab.GetInt64(o + rcv._tab.Pos)
}
return 0
}
func (rcv *Wallet) MutateAdsPaidUntilMs(n int64) bool {
return rcv._tab.MutateInt64Slot(8, n)
}
func (rcv *Wallet) Hints() int32 {
o := flatbuffers.UOffsetT(rcv._tab.Offset(10))
if o != 0 {
return rcv._tab.GetInt32(o + rcv._tab.Pos)
}
return 0
}
func (rcv *Wallet) MutateHints(n int32) bool {
return rcv._tab.MutateInt32Slot(10, n)
}
func WalletStart(builder *flatbuffers.Builder) {
builder.StartObject(4)
}
func WalletAddSegments(builder *flatbuffers.Builder, segments flatbuffers.UOffsetT) {
builder.PrependUOffsetTSlot(0, flatbuffers.UOffsetT(segments), 0)
}
func WalletStartSegmentsVector(builder *flatbuffers.Builder, numElems int) flatbuffers.UOffsetT {
return builder.StartVector(4, numElems, 4)
}
func WalletAddAdsForever(builder *flatbuffers.Builder, adsForever bool) {
builder.PrependBoolSlot(1, adsForever, false)
}
func WalletAddAdsPaidUntilMs(builder *flatbuffers.Builder, adsPaidUntilMs int64) {
builder.PrependInt64Slot(2, adsPaidUntilMs, 0)
}
func WalletAddHints(builder *flatbuffers.Builder, hints int32) {
builder.PrependInt32Slot(3, hints, 0)
}
func WalletEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT {
return builder.EndObject()
}
+60
View File
@@ -0,0 +1,60 @@
// Code generated by the FlatBuffers compiler. DO NOT EDIT.
package scrabblefb
import (
flatbuffers "github.com/google/flatbuffers/go"
)
type WalletBuyRequest struct {
_tab flatbuffers.Table
}
func GetRootAsWalletBuyRequest(buf []byte, offset flatbuffers.UOffsetT) *WalletBuyRequest {
n := flatbuffers.GetUOffsetT(buf[offset:])
x := &WalletBuyRequest{}
x.Init(buf, n+offset)
return x
}
func FinishWalletBuyRequestBuffer(builder *flatbuffers.Builder, offset flatbuffers.UOffsetT) {
builder.Finish(offset)
}
func GetSizePrefixedRootAsWalletBuyRequest(buf []byte, offset flatbuffers.UOffsetT) *WalletBuyRequest {
n := flatbuffers.GetUOffsetT(buf[offset+flatbuffers.SizeUint32:])
x := &WalletBuyRequest{}
x.Init(buf, n+offset+flatbuffers.SizeUint32)
return x
}
func FinishSizePrefixedWalletBuyRequestBuffer(builder *flatbuffers.Builder, offset flatbuffers.UOffsetT) {
builder.FinishSizePrefixed(offset)
}
func (rcv *WalletBuyRequest) Init(buf []byte, i flatbuffers.UOffsetT) {
rcv._tab.Bytes = buf
rcv._tab.Pos = i
}
func (rcv *WalletBuyRequest) Table() flatbuffers.Table {
return rcv._tab
}
func (rcv *WalletBuyRequest) ProductId() []byte {
o := flatbuffers.UOffsetT(rcv._tab.Offset(4))
if o != 0 {
return rcv._tab.ByteVector(o + rcv._tab.Pos)
}
return nil
}
func WalletBuyRequestStart(builder *flatbuffers.Builder) {
builder.StartObject(1)
}
func WalletBuyRequestAddProductId(builder *flatbuffers.Builder, productId flatbuffers.UOffsetT) {
builder.PrependUOffsetTSlot(0, flatbuffers.UOffsetT(productId), 0)
}
func WalletBuyRequestEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT {
return builder.EndObject()
}
+90
View File
@@ -0,0 +1,90 @@
// Code generated by the FlatBuffers compiler. DO NOT EDIT.
package scrabblefb
import (
flatbuffers "github.com/google/flatbuffers/go"
)
type WalletSegment struct {
_tab flatbuffers.Table
}
func GetRootAsWalletSegment(buf []byte, offset flatbuffers.UOffsetT) *WalletSegment {
n := flatbuffers.GetUOffsetT(buf[offset:])
x := &WalletSegment{}
x.Init(buf, n+offset)
return x
}
func FinishWalletSegmentBuffer(builder *flatbuffers.Builder, offset flatbuffers.UOffsetT) {
builder.Finish(offset)
}
func GetSizePrefixedRootAsWalletSegment(buf []byte, offset flatbuffers.UOffsetT) *WalletSegment {
n := flatbuffers.GetUOffsetT(buf[offset+flatbuffers.SizeUint32:])
x := &WalletSegment{}
x.Init(buf, n+offset+flatbuffers.SizeUint32)
return x
}
func FinishSizePrefixedWalletSegmentBuffer(builder *flatbuffers.Builder, offset flatbuffers.UOffsetT) {
builder.FinishSizePrefixed(offset)
}
func (rcv *WalletSegment) Init(buf []byte, i flatbuffers.UOffsetT) {
rcv._tab.Bytes = buf
rcv._tab.Pos = i
}
func (rcv *WalletSegment) Table() flatbuffers.Table {
return rcv._tab
}
func (rcv *WalletSegment) Source() []byte {
o := flatbuffers.UOffsetT(rcv._tab.Offset(4))
if o != 0 {
return rcv._tab.ByteVector(o + rcv._tab.Pos)
}
return nil
}
func (rcv *WalletSegment) Chips() int32 {
o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
if o != 0 {
return rcv._tab.GetInt32(o + rcv._tab.Pos)
}
return 0
}
func (rcv *WalletSegment) MutateChips(n int32) bool {
return rcv._tab.MutateInt32Slot(6, n)
}
func (rcv *WalletSegment) Spendable() bool {
o := flatbuffers.UOffsetT(rcv._tab.Offset(8))
if o != 0 {
return rcv._tab.GetBool(o + rcv._tab.Pos)
}
return false
}
func (rcv *WalletSegment) MutateSpendable(n bool) bool {
return rcv._tab.MutateBoolSlot(8, n)
}
func WalletSegmentStart(builder *flatbuffers.Builder) {
builder.StartObject(3)
}
func WalletSegmentAddSource(builder *flatbuffers.Builder, source flatbuffers.UOffsetT) {
builder.PrependUOffsetTSlot(0, flatbuffers.UOffsetT(source), 0)
}
func WalletSegmentAddChips(builder *flatbuffers.Builder, chips int32) {
builder.PrependInt32Slot(1, chips, 0)
}
func WalletSegmentAddSpendable(builder *flatbuffers.Builder, spendable bool) {
builder.PrependBoolSlot(2, spendable, false)
}
func WalletSegmentEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT {
return builder.EndObject()
}
+3
View File
@@ -81,5 +81,8 @@ export { TelegramLoginRequest } from './scrabblefb/telegram-login-request.js';
export { TileRecord } from './scrabblefb/tile-record.js';
export { UpdateProfileRequest } from './scrabblefb/update-profile-request.js';
export { VKLoginRequest } from './scrabblefb/vklogin-request.js';
export { Wallet } from './scrabblefb/wallet.js';
export { WalletBuyRequest } from './scrabblefb/wallet-buy-request.js';
export { WalletSegment } from './scrabblefb/wallet-segment.js';
export { WordCheckResult } from './scrabblefb/word-check-result.js';
export { YourTurnEvent } from './scrabblefb/your-turn-event.js';
@@ -0,0 +1,48 @@
// automatically generated by the FlatBuffers compiler, do not modify
import * as flatbuffers from 'flatbuffers';
export class WalletBuyRequest {
bb: flatbuffers.ByteBuffer|null = null;
bb_pos = 0;
__init(i:number, bb:flatbuffers.ByteBuffer):WalletBuyRequest {
this.bb_pos = i;
this.bb = bb;
return this;
}
static getRootAsWalletBuyRequest(bb:flatbuffers.ByteBuffer, obj?:WalletBuyRequest):WalletBuyRequest {
return (obj || new WalletBuyRequest()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
}
static getSizePrefixedRootAsWalletBuyRequest(bb:flatbuffers.ByteBuffer, obj?:WalletBuyRequest):WalletBuyRequest {
bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
return (obj || new WalletBuyRequest()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
}
productId():string|null
productId(optionalEncoding:flatbuffers.Encoding):string|Uint8Array|null
productId(optionalEncoding?:any):string|Uint8Array|null {
const offset = this.bb!.__offset(this.bb_pos, 4);
return offset ? this.bb!.__string(this.bb_pos + offset, optionalEncoding) : null;
}
static startWalletBuyRequest(builder:flatbuffers.Builder) {
builder.startObject(1);
}
static addProductId(builder:flatbuffers.Builder, productIdOffset:flatbuffers.Offset) {
builder.addFieldOffset(0, productIdOffset, 0);
}
static endWalletBuyRequest(builder:flatbuffers.Builder):flatbuffers.Offset {
const offset = builder.endObject();
return offset;
}
static createWalletBuyRequest(builder:flatbuffers.Builder, productIdOffset:flatbuffers.Offset):flatbuffers.Offset {
WalletBuyRequest.startWalletBuyRequest(builder);
WalletBuyRequest.addProductId(builder, productIdOffset);
return WalletBuyRequest.endWalletBuyRequest(builder);
}
}
@@ -0,0 +1,68 @@
// automatically generated by the FlatBuffers compiler, do not modify
import * as flatbuffers from 'flatbuffers';
export class WalletSegment {
bb: flatbuffers.ByteBuffer|null = null;
bb_pos = 0;
__init(i:number, bb:flatbuffers.ByteBuffer):WalletSegment {
this.bb_pos = i;
this.bb = bb;
return this;
}
static getRootAsWalletSegment(bb:flatbuffers.ByteBuffer, obj?:WalletSegment):WalletSegment {
return (obj || new WalletSegment()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
}
static getSizePrefixedRootAsWalletSegment(bb:flatbuffers.ByteBuffer, obj?:WalletSegment):WalletSegment {
bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
return (obj || new WalletSegment()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
}
source():string|null
source(optionalEncoding:flatbuffers.Encoding):string|Uint8Array|null
source(optionalEncoding?:any):string|Uint8Array|null {
const offset = this.bb!.__offset(this.bb_pos, 4);
return offset ? this.bb!.__string(this.bb_pos + offset, optionalEncoding) : null;
}
chips():number {
const offset = this.bb!.__offset(this.bb_pos, 6);
return offset ? this.bb!.readInt32(this.bb_pos + offset) : 0;
}
spendable():boolean {
const offset = this.bb!.__offset(this.bb_pos, 8);
return offset ? !!this.bb!.readInt8(this.bb_pos + offset) : false;
}
static startWalletSegment(builder:flatbuffers.Builder) {
builder.startObject(3);
}
static addSource(builder:flatbuffers.Builder, sourceOffset:flatbuffers.Offset) {
builder.addFieldOffset(0, sourceOffset, 0);
}
static addChips(builder:flatbuffers.Builder, chips:number) {
builder.addFieldInt32(1, chips, 0);
}
static addSpendable(builder:flatbuffers.Builder, spendable:boolean) {
builder.addFieldInt8(2, +spendable, +false);
}
static endWalletSegment(builder:flatbuffers.Builder):flatbuffers.Offset {
const offset = builder.endObject();
return offset;
}
static createWalletSegment(builder:flatbuffers.Builder, sourceOffset:flatbuffers.Offset, chips:number, spendable:boolean):flatbuffers.Offset {
WalletSegment.startWalletSegment(builder);
WalletSegment.addSource(builder, sourceOffset);
WalletSegment.addChips(builder, chips);
WalletSegment.addSpendable(builder, spendable);
return WalletSegment.endWalletSegment(builder);
}
}
+96
View File
@@ -0,0 +1,96 @@
// automatically generated by the FlatBuffers compiler, do not modify
import * as flatbuffers from 'flatbuffers';
import { WalletSegment } from '../scrabblefb/wallet-segment.js';
export class Wallet {
bb: flatbuffers.ByteBuffer|null = null;
bb_pos = 0;
__init(i:number, bb:flatbuffers.ByteBuffer):Wallet {
this.bb_pos = i;
this.bb = bb;
return this;
}
static getRootAsWallet(bb:flatbuffers.ByteBuffer, obj?:Wallet):Wallet {
return (obj || new Wallet()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
}
static getSizePrefixedRootAsWallet(bb:flatbuffers.ByteBuffer, obj?:Wallet):Wallet {
bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
return (obj || new Wallet()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
}
segments(index: number, obj?:WalletSegment):WalletSegment|null {
const offset = this.bb!.__offset(this.bb_pos, 4);
return offset ? (obj || new WalletSegment()).__init(this.bb!.__indirect(this.bb!.__vector(this.bb_pos + offset) + index * 4), this.bb!) : null;
}
segmentsLength():number {
const offset = this.bb!.__offset(this.bb_pos, 4);
return offset ? this.bb!.__vector_len(this.bb_pos + offset) : 0;
}
adsForever():boolean {
const offset = this.bb!.__offset(this.bb_pos, 6);
return offset ? !!this.bb!.readInt8(this.bb_pos + offset) : false;
}
adsPaidUntilMs():bigint {
const offset = this.bb!.__offset(this.bb_pos, 8);
return offset ? this.bb!.readInt64(this.bb_pos + offset) : BigInt('0');
}
hints():number {
const offset = this.bb!.__offset(this.bb_pos, 10);
return offset ? this.bb!.readInt32(this.bb_pos + offset) : 0;
}
static startWallet(builder:flatbuffers.Builder) {
builder.startObject(4);
}
static addSegments(builder:flatbuffers.Builder, segmentsOffset:flatbuffers.Offset) {
builder.addFieldOffset(0, segmentsOffset, 0);
}
static createSegmentsVector(builder:flatbuffers.Builder, data:flatbuffers.Offset[]):flatbuffers.Offset {
builder.startVector(4, data.length, 4);
for (let i = data.length - 1; i >= 0; i--) {
builder.addOffset(data[i]!);
}
return builder.endVector();
}
static startSegmentsVector(builder:flatbuffers.Builder, numElems:number) {
builder.startVector(4, numElems, 4);
}
static addAdsForever(builder:flatbuffers.Builder, adsForever:boolean) {
builder.addFieldInt8(1, +adsForever, +false);
}
static addAdsPaidUntilMs(builder:flatbuffers.Builder, adsPaidUntilMs:bigint) {
builder.addFieldInt64(2, adsPaidUntilMs, BigInt('0'));
}
static addHints(builder:flatbuffers.Builder, hints:number) {
builder.addFieldInt32(3, hints, 0);
}
static endWallet(builder:flatbuffers.Builder):flatbuffers.Offset {
const offset = builder.endObject();
return offset;
}
static createWallet(builder:flatbuffers.Builder, segmentsOffset:flatbuffers.Offset, adsForever:boolean, adsPaidUntilMs:bigint, hints:number):flatbuffers.Offset {
Wallet.startWallet(builder);
Wallet.addSegments(builder, segmentsOffset);
Wallet.addAdsForever(builder, adsForever);
Wallet.addAdsPaidUntilMs(builder, adsPaidUntilMs);
Wallet.addHints(builder, hints);
return Wallet.endWallet(builder);
}
}
+31
View File
@@ -14,6 +14,8 @@ import {
decodeMatchResult,
decodeOutgoingList,
decodeProfile,
decodeWallet,
encodeWalletBuy,
decodeSession,
decodeFeedbackState,
decodeFeedbackUnread,
@@ -41,6 +43,35 @@ import {
} from './codec';
describe('codec', () => {
it('round-trips the wallet buy request and the wallet view', () => {
// buy request: product id survives the wire
const req = fb.WalletBuyRequest.getRootAsWalletBuyRequest(new ByteBuffer(encodeWalletBuy('prod-42')));
expect(req.productId()).toBe('prod-42');
// wallet response: build a Wallet payload and decode it, checking the segment vector,
// the spendable flag and the benefit fields (the long ms field decodes to a number).
const b = new Builder(128);
const src = b.createString('direct');
fb.WalletSegment.startWalletSegment(b);
fb.WalletSegment.addSource(b, src);
fb.WalletSegment.addChips(b, 120);
fb.WalletSegment.addSpendable(b, true);
const seg = fb.WalletSegment.endWalletSegment(b);
const segs = fb.Wallet.createSegmentsVector(b, [seg]);
fb.Wallet.startWallet(b);
fb.Wallet.addSegments(b, segs);
fb.Wallet.addAdsForever(b, false);
fb.Wallet.addAdsPaidUntilMs(b, BigInt(1_700_000_000_000));
fb.Wallet.addHints(b, 5);
b.finish(fb.Wallet.endWallet(b));
const w = decodeWallet(b.asUint8Array());
expect(w.segments).toEqual([{ source: 'direct', chips: 120, spendable: true }]);
expect(w.adsForever).toBe(false);
expect(w.adsPaidUntilMs).toBe(1_700_000_000_000);
expect(w.hints).toBe(5);
});
it('round-trips the export-url request and response', () => {
const req = fb.ExportUrlRequest.getRootAsExportUrlRequest(
new ByteBuffer(
+29
View File
@@ -38,6 +38,8 @@ import type {
MoveRecord,
MoveResult,
Profile,
Wallet,
WalletSegment,
ProfileUpdate,
PushEvent,
Seat,
@@ -359,6 +361,33 @@ export function decodeSession(buf: Uint8Array): Session {
return sessionFromTable(fb.Session.getRootAsSession(new ByteBuffer(buf)));
}
// encodeWalletBuy wraps the product id for a chip spend (POST /user/wallet/buy).
export function encodeWalletBuy(productId: string): Uint8Array {
const b = new Builder(64);
const pid = b.createString(productId);
fb.WalletBuyRequest.startWalletBuyRequest(b);
fb.WalletBuyRequest.addProductId(b, pid);
return finish(b, fb.WalletBuyRequest.endWalletBuyRequest(b));
}
// decodeWallet reads the wallet payload: the context-visible chip segments and the
// context-applicable benefits.
export function decodeWallet(buf: Uint8Array): Wallet {
const w = fb.Wallet.getRootAsWallet(new ByteBuffer(buf));
const segments: WalletSegment[] = [];
for (let i = 0; i < w.segmentsLength(); i++) {
const seg = w.segments(i);
if (!seg) continue;
segments.push({ source: s(seg.source()), chips: seg.chips(), spendable: seg.spendable() });
}
return {
segments,
adsForever: w.adsForever(),
adsPaidUntilMs: Number(w.adsPaidUntilMs()),
hints: w.hints(),
};
}
export function decodeProfile(buf: Uint8Array): Profile {
const p = fb.Profile.getRootAsProfile(new ByteBuffer(buf));
return {
+18
View File
@@ -152,6 +152,24 @@ export interface FeedbackState {
reply: FeedbackReply | null;
}
/** One chip balance in the wallet: the funding source, the chip count, and whether it is
* spendable in the current execution context (false for a frozen VK-iOS balance or untrusted). */
export interface WalletSegment {
source: string;
chips: number;
spendable: boolean;
}
/** The user-facing wallet: the context-visible chip segments and the context-applicable
* benefits (the no-ads term end as unix millis / forever flag, and the available hints). */
export interface Wallet {
segments: WalletSegment[];
adsForever: boolean;
/** No-ads term end as unix milliseconds; 0 = no active term. */
adsPaidUntilMs: number;
hints: number;
}
export interface Profile {
userId: string;
displayName: string;