Guides
NEXUS
Guides

1. Introduce

1. Getting Started

This guide covers integrating ONE RAMP into your game or service.


1.1 What ONE RAMP Does

It converts in-game assets into blockchain tokens, and converts those tokens back into in-game assets.

  • Mint — consume in-game assets → issue tokens
  • Burn — burn tokens → grant in-game assets

What you get from integrating

  • Deploy an ERC-20 game token contract without complex setup or deep blockchain knowledge
  • Complete deployment and configuration in the console, without writing smart contract code
  • Fixed API specifications for asset lookup, order validation, and result handling, which reduces trial and error

1.2 Glossary

TermDescription
StudioWorkspace for a team or organization. Manages members, contracts, and API Keys together
ProjectA service (dApp) unit inside a Studio. A Project ID is issued on creation
Token ContractThe game token contract (ERC-20)
RAMP ContractHandles internal Mint/Burn logic. Deployed per project; only works once a token contract is linked
Validator KeyKey used to verify that a request is a legitimate transaction created by your backend
HMAC KeyKey for verifying request integrity between RAMP and your server. Issued when the RAMP Contract is deployed
RAMP F/EThe screen where users perform Mint/Burn (provided by NEXUS)
RAMP B/EThe RAMP backend that processes requests, validates them, and requests signatures (provided by NEXUS)
IntentThe request specification describing which in-game asset is exchanged for which token, and how much

1.3 What You Must Implement

EndpointPurposeConsole field
Game asset lookupReturns the user's asset balances for display in RAMP F/EGet Assets
Signature validationValidates request integrity, then returns the Validator signatureValidate Order
Result handlingProcesses the blockchain transaction resultHandle Order Result

Specification → 5. Endpoint Specification


1.4 How to Use This Guide

#DocumentContents
1Getting StartedOverview · glossary · scope of your implementation · links
22. ArchitectureComponents · Mint/Burn sequences · absolute rules
33. PrerequisitesWallet · Validator Key · network info · firewall · asset IDs
4-14-1. Account and ProjectSign-up · 2FA · Studio · Project · operational checks · Blacklist
4-24-2. ContractsToken and RAMP contract deployment · project linking · known limitations
4-34-3. Ramp SettingsEndpoints · fees · display labels · authentication
55. Endpoint SpecificationHMAC · API spec · Validator signature · constants · errors · testing · Mainnet switchover

Scope

  • This guide is written for ERC-20 game token (FT) integration.
  • Other token types require additional API integration and will be documented separately. Contact NEXUS if you need them.

1.5 Links


This document is based on the ONE RAMP console and API specification as of 2026-08-07. Screens and specifications may change with service updates.

© 2025 NEXUS Co., Ltd.