Glossary

A

Abstract Chain

Abstract Chain is a blockchain network integrated with the YGG ecosystem, used to track wallet addresses and perform secure, transparent token redemptions. It is the primary chain used for user identity and transaction tracking within the YGG Redeem system.

🔗 Learn more about Abstract (opens in a new tab)

B

Bonus Rate

The Bonus Rate is an additional percentage applied to large redemptions to reward users. For example, users redeeming more than a certain number of points may receive an extra percentage of $YGG tokens as a bonus.

Example: 2% bonus for redemptions ≥ 5,000 points

C

Chain

The blockchain network where the user's wallet resides, such as abstract, ronin, or ethereum. This helps route redemptions to the correct chain.

Supported chains: abstract, ronin, ethereum, and custom identifiers

Conversion Rate

The Conversion Rate defines how much 1 game point is worth in USD. This value is agreed upon between the Partner and YGG, and stored in the YGG Redeem database. It is used to calculate the redemption value of points in USD.

Example: 1 point = 0.01 USD (conversion rate = 0.01)

H

HMAC Signature

HMAC Signature is a cryptographic method used to sign API requests. It ensures the integrity and authenticity of requests between YGG Redeem and Partner APIs using a shared secret key.

Algorithm: HMAC-SHA256

I

initialAt / pendingAt / claimedAt / revertedAt

Timestamps used to track each stage in the redemption lifecycle:

• initialAt: When the redemption request was created
• pendingAt: When processing began
• claimedAt: When user successfully claimed tokens (or null)
• revertedAt: When redemption was reverted (or null)

These are useful for audits, tracing, and debugging.

P

Partner Transaction ID

The Partner Transaction ID is a unique identifier generated by the Partner system when points are deducted or reverted in the user's game account. It is used to track internal actions taken by the Partner system.

Format: Any string format you choose (e.g., txn_1234567890)

Price<YGG/USD>

The Price<YGG/USD> is the real-time price of the $YGG token in USD. It is refreshed every hour using data from CoinMarketCap to ensure accurate conversions.

Source: CoinMarketCap YGG (opens in a new tab)

R

Revert Reason

A Revert Reason is a message describing why a redemption was reverted. Common reasons include:

• "Timeout: User has not claimed redemption in time"
• "Transaction failed: Insufficient gas"
• "User cancelled redemption"

S

SHARED_SECRET_KEY

A confidential key provided by YGG Redeem to the Partner. It is used to generate and verify HMAC signatures on both sides of the integration.

Status: claimed | reverted

The status field in the confirmation API indicating whether a redemption was:

• "claimed": Successfully completed
• "reverted": Failed and reversed

T

txnConfirmed

A boolean flag indicating whether the $YGG token redemption transaction has been confirmed on-chain.

• true: Transaction is confirmed on blockchain
• false: Transaction failed or was reverted

txnHash

The txnHash (Transaction Hash) is the unique on-chain identifier for a token transfer. It proves the actual on-chain redemption of $YGG tokens to the user's wallet.

Format: Hexadecimal string starting with 0x (e.g., 0x123456789abcdef...)

U

UUIDv7

UUIDv7 is a time-ordered unique identifier that includes a millisecond timestamp. It is used in API requests to ensure freshness, traceability, and prevent duplicate transactions.

Format: xxxxxxxx-xxxx-7xxx-xxxx-xxxxxxxxxxxx

🔗 Generate UUIDv7 (opens in a new tab) | Convert to timestamp (opens in a new tab)

W

Wallet Address

A Wallet Address is a unique identifier on a blockchain that belongs to a user. It is used to store digital assets, such as $YGG tokens. In the YGG Redeem system, the wallet address is the key identifier for users when checking point balances, performing redemptions, and confirming transactions.

Format: Hexadecimal string starting with 0x (case-insensitive)

X

X-API-KEY

A public API credential generated by the Partner and securely shared with YGG Redeem. It is used to authenticate and identify the API caller.

Usage: Include in all API request headers

X-API-REQUEST

A unique UUIDv7 string generated by YGG for every API call to ensure the request is unique and time-bound. Partners must reject duplicate or expired requests based on this value.

Purpose: Prevents duplicate transactions

X-API-SIGNATURE

A HMAC SHA-256 signature created using the SHARED_SECRET_KEY and canonical payload (method, path, UUIDv7, and body). Used to verify the authenticity and integrity of the request.

Algorithm: HMAC-SHA256(SHARED_SECRET_KEY, method + path + uuid + body)

Y

YGG Redeem

YGG Redeem is the official payout and redemption platform of the YGG Play gaming ecosystem. It allows players from partner games to convert their in-game points into $YGG tokens. YGG Redeem manages conversion calculations, bonus allocations, and redemption transactions securely and reliably.

YGG Redemption ID

A YGG Redemption ID is a unique UUID (version 7) generated by YGG to track and identify each redemption request. It ensures traceability and is used in communication between YGG Redeem and Partner APIs.

Format: UUIDv7 string (e.g., 01987d64-6519-747b-9200-beba98700464)

Redemption Formula Reference

The complete formula for calculating $YGG token amounts:

$YGG = GamePoints × ConversionRate × Price<USD/YGG> × (1 + BonusRate)

Where:

• GamePoints: User's point balance
• ConversionRate: Points to USD conversion (e.g., 0.01)
• Price<USD/YGG>: 1 / Price<YGG/USD> from CoinMarketCap
• BonusRate: Bonus percentage (e.g., 0.02 for 2%)