Welcome to Mavis Docs - the hub for Sky Mavis developer documentation! Here you'll find tutorials, integration guides, and API reference for integrating with Sky Mavis's services and products, from deploying smart contracts to Ronin to integrating with Ronin Waypoint, Ronin Wallet, Mavis Market, Mavis Store, and more.
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 deploy to Ronin?
To deploy your project on the Ronin mainnet, you need to apply for our allowlist.
Before diving deeper into Ronin's building parts, there are a few things you need to know about deployment on Ronin.
Anyone can start building and testing on Saigon, a public Ronin testnet. Everything from Ronin Wallet integration to smart contract deployment is open on Saigon. Most Sky Mavis dApps support the Saigon testnet.
The Ronin mainnet, however, is a permissioned blockchain, which means only certain parties can deploy to the mainnet.
If you've worked with other EVM blockchains, like Ethereum, you're ready to build on Ronin. All your Ethereum tools will work on Ronin.
Get testnet RON
To get started building on Ronin, you need testnet RON tokens. You can get them from the Ronin Faucet.
Apply to deploy
Fill out the form. If your app is a good match, Sky Mavis will contact you for more information.
This documentation is organized into two main sections:
- Guides: step-by-step tutorials and integration guides for Sky Mavis's products and services. The guides are structured according to the different products and services you can integrate with. If an integration includes multiple products, you'll find it under the product that's most relevant, with cross-references to other related products.
- API reference: detailed reference documentation for integrating with Sky Mavis's services programmatically. Some APIs require access permissions, which you can request in the Developer Console. The how-to guides in the Guides section provide more information on how to request access.
Guides
| 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 |
| Lockbox | Lockbox is a client-side SDK designed for integrating Web3 features into web apps or Unity games. Powered by the MPC (multi-party computation) technology, the solution lets your players securely create Web3 wallets, send transactions, trade items—all without explicit interaction with the blockchain. | Lockbox |
| 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 Pay | Mavis Pay lets you receive payments directly on the Ronin blockchain, without intermediaries or complexities. | Mavis Pay |
| Mavis Store | Mavis Store (store.skymavis.com) 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 Name Service | The 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 |
| Sky Mavis Account | Sky Mavis Account is an OAuth 2.0 service that you can use to access Sky Mavis users' identities and information, and implement features like sign-in with a Sky Mavis Account. | Sky Mavis Account |
| 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
| API | Description | Documentation |
|---|---|---|
| Axie Experience Points 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, leaderboards, 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 REST API | Query blocks, transactions, balances, smart contracts, and NFT collections on Ronin. | Skynet REST API reference |
| Skynet Web3 API | Query accounts, NFTs, blocks, collections, contracts, and transactions on Ronin. | Skynet Web3 API reference |
Feedback
This documentation relies on your feedback. If you have any suggestions or ideas for improvement, reach out to your Sky Mavis point of contact or use the feedback widget at the bottom of the page. In the widget, choose No > Let me describe it, then enter your feedback in the text field, and then click Submit.
To start building, create an app in the Developer Console. You'll get an API key to access our services and products. For more information, see Get started.
