Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 34fe164347 | |||
| cef6968766 |
@@ -8,7 +8,7 @@ from sqlalchemy.ext.asyncio import create_async_engine
|
|||||||
|
|
||||||
from app.config import settings
|
from app.config import settings
|
||||||
from app.database import Base
|
from app.database import Base
|
||||||
from app.models import user, session, world, asset # noqa: F401
|
from app.models import user, session, world, asset, wallet # noqa: F401
|
||||||
|
|
||||||
# this is the Alembic Config object, which provides
|
# this is the Alembic Config object, which provides
|
||||||
# access to the values within the .ini file in use.
|
# access to the values within the .ini file in use.
|
||||||
|
|||||||
@@ -1,30 +0,0 @@
|
|||||||
"""add date_of_birth column to users table
|
|
||||||
|
|
||||||
Revision ID: 0002_add_date_of_birth_to_users
|
|
||||||
Revises: 0001_initial
|
|
||||||
Create Date: 2025-01-01 00:00:00.000000
|
|
||||||
|
|
||||||
"""
|
|
||||||
from typing import Sequence, Union
|
|
||||||
|
|
||||||
from alembic import op
|
|
||||||
import sqlalchemy as sa
|
|
||||||
|
|
||||||
# revision identifiers, used by Alembic.
|
|
||||||
revision: str = "0002_add_date_of_birth_to_users"
|
|
||||||
down_revision: Union[str, None] = "0001_initial"
|
|
||||||
branch_labels: Union[str, Sequence[str], None] = None
|
|
||||||
depends_on: Union[str, Sequence[str], None] = None
|
|
||||||
|
|
||||||
|
|
||||||
def upgrade() -> None:
|
|
||||||
"""Add date_of_birth column to users table."""
|
|
||||||
op.add_column(
|
|
||||||
"users",
|
|
||||||
sa.Column("date_of_birth", sa.Date(), nullable=True),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def downgrade() -> None:
|
|
||||||
"""Remove date_of_birth column from users table."""
|
|
||||||
op.drop_column("users", "date_of_birth")
|
|
||||||
@@ -2,5 +2,14 @@ from app.models.user import User
|
|||||||
from app.models.session import Session
|
from app.models.session import Session
|
||||||
from app.models.world import World
|
from app.models.world import World
|
||||||
from app.models.asset import Asset
|
from app.models.asset import Asset
|
||||||
|
from app.models.wallet import Transaction, TransactionType, Wallet
|
||||||
|
|
||||||
__all__ = ["User", "Session", "World", "Asset"]
|
__all__ = [
|
||||||
|
"User",
|
||||||
|
"Session",
|
||||||
|
"World",
|
||||||
|
"Asset",
|
||||||
|
"Wallet",
|
||||||
|
"Transaction",
|
||||||
|
"TransactionType",
|
||||||
|
]
|
||||||
|
|||||||
@@ -1,7 +1,4 @@
|
|||||||
from datetime import date
|
from sqlalchemy import Column, Integer, String, Boolean, DateTime
|
||||||
from typing import Optional
|
|
||||||
|
|
||||||
from sqlalchemy import Column, Integer, String, Boolean, DateTime, Date
|
|
||||||
from sqlalchemy.orm import relationship
|
from sqlalchemy.orm import relationship
|
||||||
from sqlalchemy.sql import func
|
from sqlalchemy.sql import func
|
||||||
|
|
||||||
@@ -15,7 +12,6 @@ class User(Base):
|
|||||||
username = Column(String(50), unique=True, index=True, nullable=False)
|
username = Column(String(50), unique=True, index=True, nullable=False)
|
||||||
email = Column(String(120), unique=True, index=True, nullable=False)
|
email = Column(String(120), unique=True, index=True, nullable=False)
|
||||||
hashed_password = Column(String(255), nullable=False)
|
hashed_password = Column(String(255), nullable=False)
|
||||||
date_of_birth = Column(Date, nullable=True)
|
|
||||||
is_active = Column(Boolean, default=True)
|
is_active = Column(Boolean, default=True)
|
||||||
created_at = Column(DateTime(timezone=True), server_default=func.now())
|
created_at = Column(DateTime(timezone=True), server_default=func.now())
|
||||||
updated_at = Column(DateTime(timezone=True), onupdate=func.now())
|
updated_at = Column(DateTime(timezone=True), onupdate=func.now())
|
||||||
@@ -23,15 +19,3 @@ class User(Base):
|
|||||||
sessions = relationship("Session", back_populates="user", cascade="all, delete-orphan")
|
sessions = relationship("Session", back_populates="user", cascade="all, delete-orphan")
|
||||||
worlds = relationship("World", back_populates="owner")
|
worlds = relationship("World", back_populates="owner")
|
||||||
assets = relationship("Asset", back_populates="owner")
|
assets = relationship("Asset", back_populates="owner")
|
||||||
|
|
||||||
@property
|
|
||||||
def is_adult(self) -> bool:
|
|
||||||
"""Return True if the user is 18 or older based on date_of_birth."""
|
|
||||||
if self.date_of_birth is None:
|
|
||||||
return False
|
|
||||||
today = date.today()
|
|
||||||
age = today.year - self.date_of_birth.year
|
|
||||||
# Adjust if birthday hasn't occurred yet this year
|
|
||||||
if (today.month, today.day) < (self.date_of_birth.month, self.date_of_birth.day):
|
|
||||||
age -= 1
|
|
||||||
return age >= 18
|
|
||||||
|
|||||||
@@ -0,0 +1,73 @@
|
|||||||
|
"""Wallet and transaction ledger models."""
|
||||||
|
|
||||||
|
import enum
|
||||||
|
|
||||||
|
from sqlalchemy import (
|
||||||
|
BigInteger,
|
||||||
|
CheckConstraint,
|
||||||
|
Column,
|
||||||
|
DateTime,
|
||||||
|
ForeignKey,
|
||||||
|
Integer,
|
||||||
|
Text,
|
||||||
|
)
|
||||||
|
from sqlalchemy.dialects.postgresql import ENUM, JSONB
|
||||||
|
from sqlalchemy.sql import func
|
||||||
|
|
||||||
|
from app.database import Base
|
||||||
|
|
||||||
|
|
||||||
|
class TransactionType(str, enum.Enum):
|
||||||
|
CREDIT_PURCHASE = "credit_purchase"
|
||||||
|
MARKETPLACE_PURCHASE = "marketplace_purchase"
|
||||||
|
MARKETPLACE_SALE = "marketplace_sale"
|
||||||
|
ESCROW_RELEASE = "escrow_release"
|
||||||
|
PAYOUT = "payout"
|
||||||
|
REFUND = "refund"
|
||||||
|
ADMIN_ADJUSTMENT = "admin_adjustment"
|
||||||
|
|
||||||
|
|
||||||
|
class Wallet(Base):
|
||||||
|
__tablename__ = "wallets"
|
||||||
|
__table_args__ = (
|
||||||
|
CheckConstraint("balance >= 0", name="ck_wallets_balance_nonnegative"),
|
||||||
|
)
|
||||||
|
|
||||||
|
id = Column(BigInteger, primary_key=True, index=True)
|
||||||
|
user_id = Column(
|
||||||
|
Integer,
|
||||||
|
ForeignKey("users.id", ondelete="CASCADE"),
|
||||||
|
unique=True,
|
||||||
|
index=True,
|
||||||
|
nullable=False,
|
||||||
|
)
|
||||||
|
balance = Column(BigInteger, nullable=False, default=0, server_default="0")
|
||||||
|
created_at = Column(DateTime(timezone=True), server_default=func.now())
|
||||||
|
updated_at = Column(
|
||||||
|
DateTime(timezone=True), server_default=func.now(), onupdate=func.now()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class Transaction(Base):
|
||||||
|
__tablename__ = "transactions"
|
||||||
|
|
||||||
|
id = Column(BigInteger, primary_key=True, index=True)
|
||||||
|
wallet_id = Column(
|
||||||
|
BigInteger, ForeignKey("wallets.id"), nullable=False
|
||||||
|
)
|
||||||
|
type = Column(
|
||||||
|
ENUM(
|
||||||
|
TransactionType,
|
||||||
|
name="transaction_type",
|
||||||
|
create_type=False,
|
||||||
|
values_callable=lambda enum_cls: [member.value for member in enum_cls],
|
||||||
|
),
|
||||||
|
nullable=False,
|
||||||
|
)
|
||||||
|
amount = Column(BigInteger, nullable=False)
|
||||||
|
balance_after = Column(BigInteger, nullable=False)
|
||||||
|
reference_type = Column(Text, nullable=True)
|
||||||
|
reference_id = Column(Text, nullable=True)
|
||||||
|
idempotency_key = Column(Text, unique=True, index=True, nullable=True)
|
||||||
|
metadata_json = Column(JSONB, nullable=True)
|
||||||
|
created_at = Column(DateTime(timezone=True), server_default=func.now())
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
"""Authentication router - login, register, token refresh."""
|
"""Authentication router - login, register, token refresh."""
|
||||||
|
|
||||||
from datetime import date, datetime, timedelta, timezone
|
from datetime import datetime, timedelta, timezone
|
||||||
|
|
||||||
from fastapi import APIRouter, Depends, HTTPException, status
|
from fastapi import APIRouter, Depends, HTTPException, status
|
||||||
from fastapi.security import OAuth2PasswordRequestForm
|
from fastapi.security import OAuth2PasswordRequestForm
|
||||||
from pydantic import BaseModel, EmailStr, field_validator
|
from pydantic import BaseModel, EmailStr
|
||||||
|
|
||||||
from jose import jwt
|
from jose import jwt
|
||||||
from passlib.context import CryptContext
|
from passlib.context import CryptContext
|
||||||
@@ -32,24 +32,12 @@ class RegisterRequest(BaseModel):
|
|||||||
username: str
|
username: str
|
||||||
email: EmailStr
|
email: EmailStr
|
||||||
password: str
|
password: str
|
||||||
date_of_birth: str # ISO format date string (YYYY-MM-DD)
|
|
||||||
|
|
||||||
@field_validator("date_of_birth")
|
|
||||||
@classmethod
|
|
||||||
def validate_date_of_birth(cls, v: str) -> str:
|
|
||||||
"""Validate that the date string is a valid date in YYYY-MM-DD format."""
|
|
||||||
try:
|
|
||||||
datetime.strptime(v, "%Y-%m-%d")
|
|
||||||
except ValueError:
|
|
||||||
raise ValueError("date_of_birth must be in YYYY-MM-DD format")
|
|
||||||
return v
|
|
||||||
|
|
||||||
|
|
||||||
class UserResponse(BaseModel):
|
class UserResponse(BaseModel):
|
||||||
id: int
|
id: int
|
||||||
username: str
|
username: str
|
||||||
email: str
|
email: str
|
||||||
date_of_birth: str | None = None
|
|
||||||
is_active: bool
|
is_active: bool
|
||||||
created_at: datetime | None = None
|
created_at: datetime | None = None
|
||||||
|
|
||||||
@@ -77,44 +65,11 @@ def hash_password(password: str) -> str:
|
|||||||
return pwd_context.hash(password)
|
return pwd_context.hash(password)
|
||||||
|
|
||||||
|
|
||||||
def calculate_age(birth_date: date, today: date | None = None) -> int:
|
|
||||||
"""Calculate age in years from a birth date.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
birth_date: The person's date of birth.
|
|
||||||
today: The reference date. Defaults to today's date (UTC).
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Age in whole years as of the reference date.
|
|
||||||
"""
|
|
||||||
if today is None:
|
|
||||||
today = datetime.now(timezone.utc).date()
|
|
||||||
|
|
||||||
age = today.year - birth_date.year
|
|
||||||
# Adjust if birthday hasn't occurred yet this year
|
|
||||||
if (today.month, today.day) < (birth_date.month, birth_date.day):
|
|
||||||
age -= 1
|
|
||||||
return age
|
|
||||||
|
|
||||||
|
|
||||||
# --- Endpoints ---
|
# --- Endpoints ---
|
||||||
|
|
||||||
@router.post("/register", response_model=TokenResponse, status_code=status.HTTP_201_CREATED)
|
@router.post("/register", response_model=TokenResponse, status_code=status.HTTP_201_CREATED)
|
||||||
async def register(req: RegisterRequest, db: AsyncSession = Depends(get_db)):
|
async def register(req: RegisterRequest, db: AsyncSession = Depends(get_db)):
|
||||||
"""Register a new user and return an access token.
|
"""Register a new user and return an access token."""
|
||||||
|
|
||||||
Requires date_of_birth and rejects users under 18.
|
|
||||||
"""
|
|
||||||
# Parse and validate date_of_birth
|
|
||||||
dob = datetime.strptime(req.date_of_birth, "%Y-%m-%d").date()
|
|
||||||
age = calculate_age(dob)
|
|
||||||
|
|
||||||
if age < 18:
|
|
||||||
raise HTTPException(
|
|
||||||
status_code=status.HTTP_400_BAD_REQUEST,
|
|
||||||
detail=f"Must be 18 or older to register (provided date of birth: {req.date_of_birth})",
|
|
||||||
)
|
|
||||||
|
|
||||||
# Check if username already exists
|
# Check if username already exists
|
||||||
result = await db.execute(select(User).where(User.username == req.username))
|
result = await db.execute(select(User).where(User.username == req.username))
|
||||||
if result.scalar_one_or_none():
|
if result.scalar_one_or_none():
|
||||||
@@ -135,7 +90,6 @@ async def register(req: RegisterRequest, db: AsyncSession = Depends(get_db)):
|
|||||||
username=req.username,
|
username=req.username,
|
||||||
email=req.email,
|
email=req.email,
|
||||||
hashed_password=hash_password(req.password),
|
hashed_password=hash_password(req.password),
|
||||||
date_of_birth=dob,
|
|
||||||
)
|
)
|
||||||
db.add(user)
|
db.add(user)
|
||||||
await db.commit()
|
await db.commit()
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
[pytest]
|
|
||||||
asyncio_mode = auto
|
|
||||||
testpaths = tests
|
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
"""Tests for the 18+ age gate on user registration."""
|
|
||||||
|
|
||||||
from datetime import date, timedelta
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from app.routers.auth import calculate_age
|
|
||||||
|
|
||||||
|
|
||||||
class TestCalculateAge:
|
|
||||||
"""Unit tests for the calculate_age helper."""
|
|
||||||
|
|
||||||
def test_exactly_18(self):
|
|
||||||
"""A person born exactly 18 years ago today is 18."""
|
|
||||||
today = date(2025, 6, 15)
|
|
||||||
dob = today.replace(year=today.year - 18)
|
|
||||||
assert calculate_age(dob, today=today) == 18
|
|
||||||
|
|
||||||
def test_just_turned_18(self):
|
|
||||||
"""A person who turned 18 yesterday is 18."""
|
|
||||||
today = date(2025, 6, 15)
|
|
||||||
dob = today.replace(year=today.year - 18) - timedelta(days=1)
|
|
||||||
assert calculate_age(dob, today=today) == 18
|
|
||||||
|
|
||||||
def test_one_day_short_of_18(self):
|
|
||||||
"""A person born one day after their 18th birthday is 17."""
|
|
||||||
today = date(2025, 6, 15)
|
|
||||||
dob = today.replace(year=today.year - 18) + timedelta(days=1)
|
|
||||||
assert calculate_age(dob, today=today) == 17
|
|
||||||
|
|
||||||
def test_17_years_old(self):
|
|
||||||
"""A person who is 17 years old today is 17."""
|
|
||||||
today = date(2025, 6, 15)
|
|
||||||
dob = date(2008, 6, 15)
|
|
||||||
assert calculate_age(dob, today=today) == 17
|
|
||||||
|
|
||||||
def test_65_years_old(self):
|
|
||||||
"""A person who is 65 is correctly calculated."""
|
|
||||||
today = date(2025, 6, 15)
|
|
||||||
dob = today.replace(year=today.year - 65)
|
|
||||||
assert calculate_age(dob, today=today) == 65
|
|
||||||
|
|
||||||
def test_newborn(self):
|
|
||||||
"""A newborn is 0."""
|
|
||||||
today = date(2025, 6, 15)
|
|
||||||
dob = today
|
|
||||||
assert calculate_age(dob, today=today) == 0
|
|
||||||
|
|
||||||
def test_birthday_not_yet_this_year(self):
|
|
||||||
"""Person born Dec 31, 2000 — on Jan 1, 2025 they are still 24."""
|
|
||||||
dob = date(2000, 12, 31)
|
|
||||||
assert calculate_age(dob, today=date(2025, 1, 1)) == 24
|
|
||||||
|
|
||||||
def test_birthday_today(self):
|
|
||||||
"""Person born Dec 31, 2000 — on Dec 31, 2024 they turn 24."""
|
|
||||||
dob = date(2000, 12, 31)
|
|
||||||
assert calculate_age(dob, today=date(2024, 12, 31)) == 24
|
|
||||||
|
|
||||||
|
|
||||||
class TestRegisterRequestDateValidation:
|
|
||||||
"""Tests for the RegisterRequest date_of_birth field validator."""
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"dob",
|
|
||||||
[
|
|
||||||
"2000-01-01",
|
|
||||||
"1990-12-31",
|
|
||||||
"2004-02-29", # leap day
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_valid_dates(self, dob):
|
|
||||||
"""Valid YYYY-MM-DD dates pass validation."""
|
|
||||||
from app.routers.auth import RegisterRequest
|
|
||||||
|
|
||||||
req = RegisterRequest(username="u", email="u@example.com", password="p", date_of_birth=dob)
|
|
||||||
assert req.date_of_birth == dob
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"dob",
|
|
||||||
[
|
|
||||||
"01-01-2000",
|
|
||||||
"2000/01/01",
|
|
||||||
"2000-13-01",
|
|
||||||
"2000-00-10",
|
|
||||||
"not-a-date",
|
|
||||||
"",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_invalid_dates_rejected(self, dob):
|
|
||||||
"""Invalid dates are rejected by the validator."""
|
|
||||||
from app.routers.auth import RegisterRequest
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
RegisterRequest(username="u", email="u@example.com", password="p", date_of_birth=dob)
|
|
||||||
@@ -1,295 +0,0 @@
|
|||||||
# Economy — Currency, Marketplace & Creator Payouts — Plan
|
|
||||||
|
|
||||||
> **Status:** Planned
|
|
||||||
> **Owner:** Platform team
|
|
||||||
> **Feature ID:** `economy`
|
|
||||||
> **Godot version:** 4.6.2 stable
|
|
||||||
> **Backend:** FastAPI + SQLAlchemy (async) + PostgreSQL + Redis
|
|
||||||
|
|
||||||
## 1. Overview
|
|
||||||
|
|
||||||
This document breaks the **Economy** feature into user stories and right-sized
|
|
||||||
implementation tasks. The feature delivers:
|
|
||||||
|
|
||||||
- **Virtual currency ("Credits")** — a single, server-authoritative currency
|
|
||||||
with an immutable, append-only transaction ledger.
|
|
||||||
- **Premium purchase** — buying Credits with real money through a pluggable
|
|
||||||
payment-provider hook.
|
|
||||||
- **Marketplace** — user-generated content (UGC) listings where creators sell
|
|
||||||
items (assets, avatar items, experience passes) to players for Credits.
|
|
||||||
- **Creator payouts** — accumulating creator earnings and paying them out to
|
|
||||||
external accounts through a pluggable payout-provider hook.
|
|
||||||
- **Godot client** — wallet/transaction history, marketplace browse/buy/sell,
|
|
||||||
and creator payout screens.
|
|
||||||
|
|
||||||
The economy is the monetization backbone of the platform. Because it moves
|
|
||||||
virtual value between real people, correctness (no double-spend, no lost funds,
|
|
||||||
no balance drift) and safety (fraud prevention, moderation, audit) are treated
|
|
||||||
as **blocking requirements**, not add-ons.
|
|
||||||
|
|
||||||
## 2. Why correctness is the differentiator
|
|
||||||
|
|
||||||
The platform is a creator economy (players buy UGC from other players). The
|
|
||||||
economy is the highest-risk surface after chat: a single arithmetic or
|
|
||||||
concurrency bug can mint or destroy value and irreversibly erode trust.
|
|
||||||
Correctness is therefore designed in from the start:
|
|
||||||
|
|
||||||
- **One currency, integer units.** Credits are whole-number integers. There are
|
|
||||||
no floats, no rounding, and no client-computed totals.
|
|
||||||
- **Append-only ledger.** Every balance change is a row in a `transactions`
|
|
||||||
table with a signed amount, a `balance_after` snapshot, a reference to the
|
|
||||||
event that caused it, and an **idempotency key** so retries cannot double
|
|
||||||
credit or double debit.
|
|
||||||
- **Atomic, locked mutations.** Balance changes run in a single database
|
|
||||||
transaction with row locking (`SELECT ... FOR UPDATE`) so concurrent
|
|
||||||
purchases/payouts cannot race.
|
|
||||||
- **Escrow hold.** Marketplace proceeds are held in `pending_escrow` for a
|
|
||||||
configurable window before becoming available to the seller, so fraudulent
|
|
||||||
or moderated sales can be reversed without clawing back paid-out funds.
|
|
||||||
- **Server-authoritative fees.** The platform commission is computed
|
|
||||||
server-side from a configured rate; the client never supplies the fee or the
|
|
||||||
seller's net.
|
|
||||||
|
|
||||||
## 3. Existing constraints (do not re-build)
|
|
||||||
|
|
||||||
- **Auth:** JWT bearer tokens; `get_current_user` / `CurrentUser` dependency in
|
|
||||||
`app/dependencies.py`. All economy endpoints reuse this.
|
|
||||||
- **DB:** async SQLAlchemy + Alembic; migration `0001_initial` is the head.
|
|
||||||
Existing tables: `users`, `sessions`, `worlds`, `assets`.
|
|
||||||
- **Redis:** configured (`REDIS_URL`) but unused so far; adopted here for
|
|
||||||
idempotency short-caching and rate limiting.
|
|
||||||
- **Models:** `User` (owner_id), `Asset` (owner_id, is_public, asset_type).
|
|
||||||
Marketplace items reference existing `assets` rows and/or avatar items.
|
|
||||||
- **Content moderation:** `docs/architecture/content_moderation.md` defines
|
|
||||||
flag vocabulary, age gate, and moderation actions. Marketplace items and
|
|
||||||
listings must inherit and enforce these rules (see §7).
|
|
||||||
- **Client:** Godot 4.6.2, minimal `main_menu.gd`; no economy UI yet.
|
|
||||||
|
|
||||||
## 4. Key design decisions
|
|
||||||
|
|
||||||
| Concern | Decision |
|
|
||||||
|---|---|
|
|
||||||
| Currency model | Single virtual currency **"Credits" (CR)**, integer units. One wallet row per user; no fractional amounts. |
|
|
||||||
| Ledger | Append-only `transactions` table: signed `amount`, `balance_after`, `reference_type`/`reference_id`, unique `idempotency_key`. |
|
|
||||||
| Concurrency | `SELECT ... FOR UPDATE` on the wallet row inside the mutation transaction; never read-modify-write from stale data. |
|
|
||||||
| Payments | Pluggable `PaymentProvider` interface with a **no-op default** that simulates a confirmed payment for dev/testing (clearly flagged). Stripe/PayPal later. |
|
|
||||||
| Marketplace items | `catalog_items` (what is sold) + `marketplace_listings` (a seller's offer with a price/status). One item can have multiple listings over time. |
|
|
||||||
| Purchase flow | Atomic transaction: debit buyer → hold funds in escrow (`pending_escrow`) → grant item. Platform fee computed server-side. |
|
|
||||||
| Escrow | Configurable hold window (default 72h) before `pending_escrow` becomes available seller earnings. Refunds during the window reverse the sale. |
|
|
||||||
| Fees | Single configurable `MARKETPLACE_FEE_RATE` (default `0.30`). `seller_net = floor(price * (1 - fee_rate))`. |
|
|
||||||
| Creator balance | `creator_balances` table: `available` (earned, payable), `pending` (inside an open payout request), `lifetime_earned`. Updated in the same transaction as the sale completion. |
|
|
||||||
| Payouts | Pluggable `PayoutProvider.pay()` with a no-op default (simulated external ref). Minimum payout threshold, admin review for large payouts. |
|
|
||||||
| Idempotency | Every money-moving request carries a client-generated `Idempotency-Key`; duplicate keys return the original result. |
|
|
||||||
| Rate limiting | Redis token-bucket dependency reused from the social feature for purchase/listing/payout endpoints. |
|
|
||||||
| Moderation | Listings enforce content flags + age gate; moderators can `delist`/`remove`; fraud/chargeback reversal is an audited admin action. |
|
|
||||||
|
|
||||||
## 5. User stories
|
|
||||||
|
|
||||||
### US-1 Currency & wallet
|
|
||||||
As a player, I can see my Credit balance and transaction history, and the system
|
|
||||||
credits/debits my wallet only through server-authoritative events.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- Exactly one wallet per user, created lazily on first use.
|
|
||||||
- Balance is always a non-negative integer; no operation can make it negative.
|
|
||||||
- Every mutation appends an immutable ledger row with amount, resulting balance,
|
|
||||||
reference, and idempotency key.
|
|
||||||
- Retrying a request with the same idempotency key does not double-apply.
|
|
||||||
- `GET` endpoints expose current balance and paged transaction history.
|
|
||||||
|
|
||||||
### US-2 Premium purchase (buy Credits)
|
|
||||||
As a player, I can purchase Credits with real money and have them credited only
|
|
||||||
after the payment is confirmed.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- A purchase session is created through the payment provider (or the no-op
|
|
||||||
default) and is idempotent.
|
|
||||||
- Credits are granted exactly once, only after a verified provider confirmation
|
|
||||||
(webhook/confirm endpoint), never on client claim.
|
|
||||||
- Purchase amounts are bounded and server-defined; clients cannot pick arbitrary
|
|
||||||
prices.
|
|
||||||
- Confirmation is idempotent and audited (provider reference recorded).
|
|
||||||
|
|
||||||
### US-3 Marketplace listing (sell)
|
|
||||||
As a creator, I can list a catalog item for sale at a Credit price and
|
|
||||||
manage/remove my listings.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- A listing references a valid `catalog_item` owned by the seller (or an
|
|
||||||
authorized seller).
|
|
||||||
- Price is bounded (min/max) and set server-side; status transitions are
|
|
||||||
explicit (`active`, `sold`, `delisted`, `removed_by_moderation`).
|
|
||||||
- Only the seller (or a moderator) can update/remove a listing.
|
|
||||||
- Listings are searchable/filterable (item type, price range, owner).
|
|
||||||
|
|
||||||
### US-4 Marketplace purchase (buy)
|
|
||||||
As a player, I can buy a listed item. The purchase is atomic, holds funds in
|
|
||||||
escrow, grants the item, and splits the payment between platform and seller.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- A single transaction debits the buyer, holds funds in escrow, and grants the
|
|
||||||
item — no partial states on failure.
|
|
||||||
- Platform fee and seller net are computed server-side from the configured rate.
|
|
||||||
- After the escrow hold window, funds move from escrow to the seller's
|
|
||||||
available balance.
|
|
||||||
- Refunds during the hold window reverse the sale and return funds to the buyer.
|
|
||||||
- Concurrent purchases of a one-of-a-kind listing cannot both succeed.
|
|
||||||
|
|
||||||
### US-5 Creator payouts
|
|
||||||
As a creator, I can view my earned balance, request a payout, and track its
|
|
||||||
status; admins can review and approve/reject payouts.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- Available balance is derived only from completed (escrow-released) sales and
|
|
||||||
completed payouts; it never goes negative.
|
|
||||||
- Payout requests are bounded (min threshold, max per period) and rate-limited.
|
|
||||||
- Large payouts require admin review; all payout requests carry an audit trail
|
|
||||||
(requested by, reviewed by, provider reference, status).
|
|
||||||
- The payout provider is called exactly once; idempotent on retry.
|
|
||||||
|
|
||||||
### US-6 Godot client
|
|
||||||
As a player, I can manage Credits, browse/buy/sell marketplace items, and manage
|
|
||||||
payouts from the game UI.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- An API client handles JWT auth, HTTP, and idempotency keys for all economy
|
|
||||||
calls.
|
|
||||||
- Dedicated screens: wallet + transaction history, marketplace browse/buy,
|
|
||||||
sell-listing, and creator payout.
|
|
||||||
- The client never computes balances, fees, or seller nets — it only displays
|
|
||||||
server responses.
|
|
||||||
|
|
||||||
## 6. Task breakdown
|
|
||||||
|
|
||||||
Right-sized to 1–3 files / one coherent piece of functionality each. Task IDs
|
|
||||||
are sequential for dependency chaining.
|
|
||||||
|
|
||||||
| # | Task | Story | Depends on |
|
|
||||||
|---|------|-------|-----------|
|
|
||||||
| 1 | Wallet & ledger models + Alembic migration (`wallets`, `transactions`) | US-1 | — |
|
|
||||||
| 2 | Wallet service (atomic credit/debit, idempotency, locking) + wallet/transactions API | US-1 | 1 |
|
|
||||||
| 3 | Premium purchase: `PaymentProvider` interface + purchase/confirm endpoints | US-2 | 1 |
|
|
||||||
| 4 | Catalog item & listing models + migration (`catalog_items`, `marketplace_listings`, `creator_balances`) | US-3 | 1 |
|
|
||||||
| 5 | Marketplace listing API (create/list/search/update/remove) | US-3 | 4 |
|
|
||||||
| 6 | Marketplace purchase service + API (atomic escrow, fee split, item grant) | US-4 | 2, 4, 5 |
|
|
||||||
| 7 | Creator payout request models + API (`payout_requests`) | US-5 | 2, 6 |
|
|
||||||
| 8 | Payout admin review + `PayoutProvider` + audit | US-5 | 7 |
|
|
||||||
| 9 | Marketplace moderation + content-flag/age-gate enforcement | cross-cutting | 5, 6 |
|
|
||||||
| 10 | Godot economy API client (auth + HTTP + idempotency) | US-6 | 2 |
|
|
||||||
| 11 | Godot wallet & transaction history UI | US-6 | 10 |
|
|
||||||
| 12 | Godot marketplace browse/buy UI | US-6 | 6, 10 |
|
|
||||||
| 13 | Godot selling & payout UI | US-6 | 5, 7, 10 |
|
|
||||||
|
|
||||||
## 7. Phasing
|
|
||||||
|
|
||||||
- **Phase 1 (currency + payments):** tasks 1–3. The foundation — ledger and
|
|
||||||
money movement must be rock-solid before anything spends Credits.
|
|
||||||
- **Phase 2 (marketplace):** tasks 4–6. Listing and atomic purchase with escrow.
|
|
||||||
- **Phase 3 (payouts):** tasks 7–8. Turn released escrow into creator payouts.
|
|
||||||
- **Phase 4 (moderation):** task 9. Lock down the marketplace against mature
|
|
||||||
content and abuse.
|
|
||||||
- **Phase 5 (client):** tasks 10–13, each landing after its backend dependency.
|
|
||||||
|
|
||||||
## 8. Data model sketch
|
|
||||||
|
|
||||||
```text
|
|
||||||
wallets
|
|
||||||
id bigint PK
|
|
||||||
user_id int UNIQUE FK -> users.id
|
|
||||||
balance bigint NOT NULL DEFAULT 0 CHECK (balance >= 0)
|
|
||||||
created_at timestamptz
|
|
||||||
updated_at timestamptz
|
|
||||||
|
|
||||||
transactions (append-only ledger)
|
|
||||||
id bigint PK
|
|
||||||
wallet_id bigint FK -> wallets.id
|
|
||||||
type enum(credit_purchase, marketplace_purchase,
|
|
||||||
marketplace_sale, escrow_release, payout,
|
|
||||||
refund, admin_adjustment)
|
|
||||||
amount bigint NOT NULL (signed)
|
|
||||||
balance_after bigint NOT NULL
|
|
||||||
reference_type text (e.g. "purchase", "sale", "payout_request")
|
|
||||||
reference_id text
|
|
||||||
idempotency_key text UNIQUE
|
|
||||||
metadata_json jsonb
|
|
||||||
created_at timestamptz
|
|
||||||
|
|
||||||
catalog_items
|
|
||||||
id bigint PK
|
|
||||||
owner_id int FK -> users.id
|
|
||||||
asset_id int FK -> assets.id (nullable; null for non-asset virtual items)
|
|
||||||
item_type enum(asset, avatar_item, experience_pass)
|
|
||||||
name text
|
|
||||||
description text
|
|
||||||
metadata_json jsonb
|
|
||||||
created_at timestamptz
|
|
||||||
|
|
||||||
marketplace_listings
|
|
||||||
id bigint PK
|
|
||||||
catalog_item_id bigint FK -> catalog_items.id
|
|
||||||
seller_id int FK -> users.id
|
|
||||||
price bigint NOT NULL CHECK (price > 0)
|
|
||||||
status enum(active, sold, delisted, removed_by_moderation)
|
|
||||||
created_at timestamptz
|
|
||||||
updated_at timestamptz
|
|
||||||
|
|
||||||
purchases
|
|
||||||
id bigint PK
|
|
||||||
listing_id bigint FK -> marketplace_listings.id
|
|
||||||
buyer_id int FK -> users.id
|
|
||||||
seller_id int FK -> users.id
|
|
||||||
price bigint NOT NULL
|
|
||||||
platform_fee bigint NOT NULL
|
|
||||||
seller_net bigint NOT NULL
|
|
||||||
status enum(pending_escrow, completed, refunded, reversed)
|
|
||||||
escrow_hold_until timestamptz
|
|
||||||
created_at timestamptz
|
|
||||||
|
|
||||||
creator_balances
|
|
||||||
id bigint PK
|
|
||||||
user_id int UNIQUE FK -> users.id
|
|
||||||
available bigint NOT NULL DEFAULT 0
|
|
||||||
pending bigint NOT NULL DEFAULT 0
|
|
||||||
lifetime_earned bigint NOT NULL DEFAULT 0
|
|
||||||
updated_at timestamptz
|
|
||||||
|
|
||||||
payout_requests
|
|
||||||
id bigint PK
|
|
||||||
creator_id int FK -> users.id
|
|
||||||
amount bigint NOT NULL CHECK (amount > 0)
|
|
||||||
status enum(pending, approved, paid, rejected)
|
|
||||||
external_ref text
|
|
||||||
provider_ref text
|
|
||||||
requested_by int FK -> users.id
|
|
||||||
reviewed_by int FK -> users.id (nullable)
|
|
||||||
reviewed_at timestamptz
|
|
||||||
created_at timestamptz
|
|
||||||
```
|
|
||||||
|
|
||||||
## 9. Security, anti-fraud & audit
|
|
||||||
|
|
||||||
- **Server-authoritative balances/fees:** clients never compute totals; amounts
|
|
||||||
are validated server-side against bounds and the current listing.
|
|
||||||
- **Row locking:** wallet and creator-balance mutations use `SELECT ... FOR
|
|
||||||
UPDATE` within one transaction.
|
|
||||||
- **Idempotency:** every money-moving endpoint requires an `Idempotency-Key`;
|
|
||||||
duplicate keys return the stored original outcome.
|
|
||||||
- **Rate limiting:** purchase, listing, and payout endpoints are token-bucket
|
|
||||||
rate-limited per user.
|
|
||||||
- **Escrow & reversibility:** funds are not payable until the hold window
|
|
||||||
elapses; chargebacks/refunds reverse before release.
|
|
||||||
- **Moderation:** listings carry the item's effective content flags; mature
|
|
||||||
items require age verification (per `content_moderation.md`); moderators can
|
|
||||||
`delist`/`remove` and trigger audited reversals.
|
|
||||||
- **Audit:** the ledger plus `payout_requests` review fields form an append-only
|
|
||||||
audit trail for every movement of value.
|
|
||||||
|
|
||||||
## 10. Out of scope for this feature
|
|
||||||
|
|
||||||
- Real Stripe/PayPal/KYC integrations (provider interfaces leave the hooks; the
|
|
||||||
defaults are deterministic no-ops).
|
|
||||||
- Subscriptions, recurring billing, or premium memberships.
|
|
||||||
- Gift cards, promotional codes, or user-to-user Credit transfers.
|
|
||||||
- Partial refunds, chargeback disputes, and seller tax/VAT handling.
|
|
||||||
- In-world vending machines / scripted economy triggers (future, built on this
|
|
||||||
ledger via the scripting sandbox).
|
|
||||||
@@ -1,160 +0,0 @@
|
|||||||
# Trust & Safety Operations — Plan
|
|
||||||
|
|
||||||
> **Status:** Planned
|
|
||||||
> **Owner:** Platform team
|
|
||||||
> **Feature ID:** `trust_safety`
|
|
||||||
> **Godot version:** 4.6.2 stable
|
|
||||||
> **Backend:** FastAPI + SQLAlchemy (async) + PostgreSQL (+ Redis available, unused)
|
|
||||||
> **Related:** `content_moderation.md` (M5 — content rating/flagging at upload time),
|
|
||||||
> `social.md` (chat + report-message), `app/dependencies.py` (JWT auth)
|
|
||||||
|
|
||||||
## 1. Overview
|
|
||||||
|
|
||||||
This feature is the **enforcement workflow** for content/behavior that is
|
|
||||||
**already live** and has been reported by a real user. M5
|
|
||||||
(`content_moderation.md`) covers rating/flagging at authoring/upload time; this
|
|
||||||
feature covers what happens **after** something is live and someone reports it:
|
|
||||||
|
|
||||||
1. **Reporting** — report a user, an experience (world/asset), or a chat
|
|
||||||
message with a reason and optional detail.
|
|
||||||
2. **Moderation queue** — staff review incoming reports, see report + target
|
|
||||||
context, and resolve them.
|
|
||||||
3. **Ban / suspension** — apply a temporary suspension or permanent ban to a
|
|
||||||
user, with enforcement at the auth boundary.
|
|
||||||
4. **Appeals** — a sanctioned user can appeal; staff can uphold or overturn.
|
|
||||||
|
|
||||||
The userbase being 18+ does **not** shrink the moderation need — harassment,
|
|
||||||
hate speech, spam, griefing, and CSAM/policy violations still require real
|
|
||||||
enforcement. Safety is a **blocking requirement**, not an add-on.
|
|
||||||
|
|
||||||
## 2. Existing constraints (do not re-build)
|
|
||||||
|
|
||||||
- **Auth:** JWT bearer; `get_current_user` / `CurrentUser` in
|
|
||||||
`app/dependencies.py`. Every new endpoint reuses it.
|
|
||||||
- **DB:** async SQLAlchemy + Alembic. Current head is `0002_add_date_of_birth_to_users`.
|
|
||||||
- **Models:** `User`, `World` (owner_id), `Asset` (owner_id, is_public). There
|
|
||||||
is no `role` field yet, and no chat/message table yet (social.md is planned,
|
|
||||||
not built).
|
|
||||||
- **Redis:** configured (`REDIS_URL`) but unused; not required by this feature.
|
|
||||||
- **Client:** Godot 4.6.2, minimal `main_menu.gd`; no report/chat UI yet.
|
|
||||||
|
|
||||||
## 3. Key design decisions
|
|
||||||
|
|
||||||
| Concern | Decision |
|
|
||||||
|---|---|
|
|
||||||
| Report target addressing | Generic `target_type` + `target_id` (string) so user/world/asset/message all flow through one report path; router resolves target existence via a small registry |
|
|
||||||
| Report reasons | Fixed enum `reason_category` (harassment, hate_speech, sexual_content, violence, spam, self_harm, other) + free-text `details` |
|
|
||||||
| Staff roles | Add `role` enum on `User` (`user` / `moderator` / `admin`); `RequireStaff` dependency gates the queue/action/appeal-review endpoints |
|
|
||||||
| Enforcement | Denormalized `banned_until` / `suspended_until` timestamps on `User` (kept in sync by moderation actions); `get_current_user` rejects sanctioned users with `403` so enforcement applies to **all** existing endpoints |
|
|
||||||
| Ban vs. suspension | Suspension = temporary (`expires_at`); ban = permanent (`expires_at IS NULL`). Both are rows in `moderation_actions` for auditability |
|
|
||||||
| Appeals | Appeal references the specific `moderation_action`; approving an appeal revokes the action and clears the user's sanction |
|
|
||||||
| Audit | Every moderation action is an append-only row with `moderator_id`, `reason`, `created_at`, `revoked_at`; reports record `resolved_by` + `resolution` |
|
|
||||||
|
|
||||||
## 4. Data model (target shape)
|
|
||||||
|
|
||||||
```
|
|
||||||
users
|
|
||||||
+ role ENUM(user, moderator, admin) default 'user'
|
|
||||||
+ banned_until TIMESTAMPTZ NULL
|
|
||||||
+ suspended_until TIMESTAMPTZ NULL
|
|
||||||
|
|
||||||
reports
|
|
||||||
id, reporter_id FK users, target_type ENUM(user,world,asset,chat_message),
|
|
||||||
target_id VARCHAR(64), reason_category ENUM(...), details TEXT,
|
|
||||||
status ENUM(open,in_review,resolved,dismissed) default 'open',
|
|
||||||
resolved_by FK users NULL, resolution ENUM(...) NULL,
|
|
||||||
created_at, updated_at, resolved_at
|
|
||||||
|
|
||||||
moderation_actions
|
|
||||||
id, moderator_id FK users, target_user_id FK users,
|
|
||||||
target_type ENUM(user,world,asset,chat_message), target_id VARCHAR(64),
|
|
||||||
action ENUM(warn,suspend,ban,restrict,remove,restore),
|
|
||||||
reason TEXT, report_id FK reports NULL,
|
|
||||||
expires_at TIMESTAMPTZ NULL, revoked_at TIMESTAMPTZ NULL, created_at
|
|
||||||
|
|
||||||
appeals
|
|
||||||
id, moderation_action_id FK moderation_actions,
|
|
||||||
user_id FK users, reason TEXT,
|
|
||||||
status ENUM(pending,approved,rejected) default 'pending',
|
|
||||||
reviewed_by FK users NULL, reviewed_at TIMESTAMPTZ NULL, created_at
|
|
||||||
```
|
|
||||||
|
|
||||||
## 5. User stories
|
|
||||||
|
|
||||||
### US-1 Reporting
|
|
||||||
As a player, I can report a user, an experience (world/asset), or a chat
|
|
||||||
message, choosing a reason and adding optional detail.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- Report requires a valid target of the matching type (404 otherwise) and a
|
|
||||||
reason from the fixed category set.
|
|
||||||
- Duplicate reports from the same reporter for the same target are coalesced
|
|
||||||
(409) rather than creating unbounded duplicates.
|
|
||||||
- A report cannot be filed by a banned/suspended user (enforced by existing auth).
|
|
||||||
- Each report stores reporter, target, reason, and created_at; status starts `open`.
|
|
||||||
|
|
||||||
### US-2 Moderation queue & review
|
|
||||||
As a moderator, I can list open reports (filterable by type/status/reason),
|
|
||||||
view a report with its target, and resolve it with an action.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- Queue is staff-only (`RequireStaff`); non-staff get 403.
|
|
||||||
- List supports status/type/reason filters + pagination (offset/limit).
|
|
||||||
- Resolving sets `status`, `resolution`, `resolved_by`, `resolved_at` and
|
|
||||||
(where applicable) records a `moderation_actions` row.
|
|
||||||
|
|
||||||
### US-3 Ban / suspension enforcement
|
|
||||||
As a moderator, I can suspend a user temporarily or ban them permanently, and
|
|
||||||
the sanction blocks the user from authenticated endpoints immediately.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- Suspension sets `suspended_until`; ban sets `banned_until` (permanent). Warn
|
|
||||||
records an action without blocking.
|
|
||||||
- `get_current_user` returns `403` for any user past a live sanction.
|
|
||||||
- Expired suspensions no longer block (time-based, no cron required).
|
|
||||||
- Removing a ban/suspension is itself a recorded `restore` action.
|
|
||||||
|
|
||||||
### US-4 Appeals
|
|
||||||
As a sanctioned user, I can appeal an active ban/suspension; as a moderator I
|
|
||||||
can approve (overturn) or reject (uphold) it.
|
|
||||||
|
|
||||||
**Acceptance criteria**
|
|
||||||
- A user can submit exactly one open appeal per sanction.
|
|
||||||
- Appeal is tied to the specific `moderation_action`.
|
|
||||||
- Approving revokes the action and clears the user's sanction; rejecting
|
|
||||||
upholds it. Both record reviewer + timestamp.
|
|
||||||
|
|
||||||
## 6. Task breakdown
|
|
||||||
|
|
||||||
Right-sized to ~1–3 files / one coherent piece of functionality. Task IDs are
|
|
||||||
dependency order.
|
|
||||||
|
|
||||||
| # | Task | Story | Depends on |
|
|
||||||
|---|------|-------|-----------|
|
|
||||||
| 1 | Moderation data model + Alembic migration (reports, moderation_actions, appeals, user `role`/`banned_until`/`suspended_until`) | US-1..4 | — |
|
|
||||||
| 2 | Staff authorization + sanction enforcement dependency (`RequireStaff`; extend `get_current_user` to reject sanctioned users) | US-2, US-3 | 1 |
|
|
||||||
| 3 | Report submission endpoints (report user / experience / chat message) | US-1 | 1 |
|
|
||||||
| 4 | Moderation queue + review endpoints (list, detail, resolve→action) | US-2 | 1, 2 |
|
|
||||||
| 5 | Ban/suspend/restore action application + user-sanction sync | US-3 | 2, 4 |
|
|
||||||
| 6 | Appeals endpoints (submit, list, review → uphold/overturn) | US-4 | 1, 5 |
|
|
||||||
| 7 | Integration tests: report → review → ban → appeal → overturn | US-1..4 | 3, 4, 5, 6 |
|
|
||||||
|
|
||||||
## 7. Phasing
|
|
||||||
|
|
||||||
- **Phase 1 (data + enforcement core):** tasks 1–2. Land the schema and make
|
|
||||||
sanctioned users actually unable to act — highest value.
|
|
||||||
- **Phase 2 (report → review → action):** tasks 3–5. The moderation loop.
|
|
||||||
- **Phase 3 (appeals):** task 6.
|
|
||||||
- **Phase 4 (verification):** task 7 integration tests.
|
|
||||||
|
|
||||||
## 8. Out of scope for this feature
|
|
||||||
|
|
||||||
- **Client (Godot) report/appeal UI** — no chat/social UI exists yet; report
|
|
||||||
endpoints are consumed once `social.md` US-6 lands. Client is a follow-up.
|
|
||||||
- Automated content scanning / hash detection (covered by M5 /
|
|
||||||
`content_moderation.md`).
|
|
||||||
- Third-party moderation/CSAM-scanning vendors.
|
|
||||||
- Rate limiting of report submission (Redis is available; add a token-bucket
|
|
||||||
dependency later if abuse is observed).
|
|
||||||
- Voice chat moderation.
|
|
||||||
- Per-jurisdiction legal-takedown workflows (DMCA etc.).
|
|
||||||
Reference in New Issue
Block a user