54 lines
804 B
Markdown
54 lines
804 B
Markdown
|
# Invite Codes Protocol
|
||
|
|
|
||
|
|
> **NOTE**: This document is the single source of truth. All implementations must follow this specification.
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
Invite codes for referral system with reward configuration.
|
||
|
|
|
||
|
|
## Version
|
||
|
|
|
||
|
|
- **Current**: `1.0`
|
||
|
|
- **Status**: Active
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Reward Configuration
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
interface InviteCodeRewardConfig {
|
||
|
|
// Reserved for future use
|
||
|
|
// Currently unused, allowing custom extensions
|
||
|
|
[key: string]: any;
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Database Field
|
||
|
|
|
||
|
|
| Field | Type | Description |
|
||
|
|
|-------|------|-------------|
|
||
|
|
| reward_config | jsonb | Reward configuration for invite codes |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## JSON Examples
|
||
|
|
|
||
|
|
### Empty Config
|
||
|
|
|
||
|
|
```json
|
||
|
|
{}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Future Usage Example
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"reward_type": "credits",
|
||
|
|
"reward_amount": 100,
|
||
|
|
"currency": "USD",
|
||
|
|
"max_rewards_per_user": 5
|
||
|
|
}
|
||
|
|
```
|