Mavis Docs
For Ronin builders, Mavis Docs is the go-to developer documentation resource for integrating with Sky Mavis's services and products. Here you'll find developer guides, tutorials, and API reference to help you build, test, and deploy your next game or dApp on Ronin.
What is Ronin?
Developed by Sky Mavis, the creator of Axie Infinity, Ronin is a blockchain built specifically for games. By supporting EVM-compatible smart contracts and protocols, Ronin enables developers to create feature-rich, high-performance blockchain projects.
How to build on Ronin?
If you've worked with other EVM blockchains, like Ethereum, you're ready to build on Ronin. All your Ethereum tools work on Ronin. You can use the same libraries, frameworks, and development environments you're already familiar with.
Fill out the application form. If your project is a good match, Sky Mavis will contact you for more information.
Want to know how Sky Mavis identifies breakout projects? Check out Unlocking Web3 Publishing on Ronin on the Ronin blog.
How to deploy to Ronin?
There are two versions of the Ronin blockchain that you can deploy to:
- Testnet: our public testnet, Saigon, is a simulated version of the Ronin mainnet. Experiment with features, deploy smart contracts, and build apps on Saigon without spending real money or assets. To fund your development and testing on Ronin, you need testnet RON tokens. You can get them from the Ronin Faucet.
- Mainnet: our mainnet is a permissioned blockchain. Only approved projects can deploy to the Ronin mainnet. If you're ready to deploy your project to the mainnet, get it reviewed and approved by Sky Mavis.
How to use this documentation?
The Mavis Docs website structures the documentation into two main sections:
- Guides: step-by-step tutorials and integration guides for all our products and services.
- API reference: detailed reference documentation for all APIs we offer.
Guides
The following table lists the guides available in Mavis Docs:
| Product | Description | Documentation |
|---|---|---|
| App Tracking | App Tracking is an API that enables you to measure your app's data, such as traffic, user information, and events. You can then view the data, already processed and analyzed, using pre-built visualization dashboards in the Developer Console. | App Tracking |
| Mavis Market | Mavis Market is an NFT marketplace where anyone can buy, sell, and showcase their digital assets. With smart contracts deployed on the Ronin network, the marketplace is a powerful tool for game developers looking to feature their NFT projects to reach a broader audience and generate revenue. | Mavis Market |
| Mavis Store | Mavis Store is an online marketplace where game developers can sell their in-game items to players, including both on-chain or off-chain items. Mavis Store offers competitive pricing and familiar payment options to make buying items easy for players. | Mavis Store |
| Reward Distribution | The Reward Distribution Service enables you to distribute rewards in the form of ERC-20 tokens on Ronin. With this service, you can offload the complexities of managing your own payout system, focusing instead on creating engaging gaming experiences. | Reward Distribution |
| Ronin JSON-RPC | Guides on how to connect to Ronin nodes over JSON-RPC to get real-time or archive data for your game or dApp. | JSON-RPC |
| Ronin Skynet | Providing seamless, scalable blockchain infrastructure for developers to build dApps and manage NFT platforms efficiently. | Ronin Skynet |
| Ronin Name Service | Ronin Name Service (RNS) is a decentralized domain name service that maps human-readable .ron names to blockchain addresses on Ronin. Use the integration documentation to support RNS in your games or dApps. | Ronin Name Service |
| Ronin Wallet | Let users connect their Ronin Wallet to your game or dApp to access their assets and interact with the blockchain. | Ronin Wallet |
| Ronin Waypoint | Ronin Waypoint is an account service and an keyless wallet in one, designed to provide a unified gaming experience. It helps game developers reduce friction with instant onboarding, boost transactions, data tracking, and enhanced security. | Ronin Waypoint |
| Smart contracts | Deploy and verify smart contracts on Ronin. | Smart contracts |
| Webhooks | Set up webhooks to receive real-time notifications when specific events occur on Ronin. | Webhooks |
API reference
The following table lists the APIs available in Mavis Docs:
| API | Description | Documentation |
|---|---|---|
| Axie Experience Points (AXP) API | Issue AXP to Axies in your game or dApp, get AXP balances, and more, using AXP API. | AXP API reference |
| Axie Infinity Origins API | Get data about items, leader boards, battle logs, seasons, and more from Axie Infinity Origins. | Axie Infinity Origins API reference |
| GraphQL | Query Sky Mavis GraphQL schemas and explore them using the GraphQL playground. | GraphQL playground |
| Mavis Market Partner API | For creators listing their NFTs on Mavis Market, this API provides an endpoint to refresh the metadata of their NFTs. | Mavis Market Partner API reference |
| Mavis Store API | Documentation for server-side endpoints to integrate with Mavis Store for user verification and item delivery. | Mavis Store API reference |
| Ronin Injected Provider API | JavaScript API that injects the Ronin Wallet provider into your app, enabling users to interact with the blockchain. | Ronin Injected Provider API reference |
| JSON-RPC API | Connect to Ronin nodes over JSON-RPC to get real-time or archive data for your game or dApp. | Ronin JSON-RPC API reference |
| Skynet Web3 API | Query accounts, NFTs, blocks, collections, contracts, and transactions on Ronin. | Skynet Web3 API reference |
Next steps
Express your interest in building on Ronin
Fill out the application form. If your project is a good match, Sky Mavis will contact you for more information.
Once your project is approved, follow the steps in the Get started guide to create a Sky Mavis account in the Developer Console, and then create an app to get an API key and request access to the products you need to build your integrations.
Deploy your smart contract to Saigon testnet
While you're waiting for your project to be approved for the Ronin mainnet, you can start developing and testing your smart contracts on the Saigon testnet. For more information, see the Deploy a smart contract using Hardhat.