Skip to main content

Get started with Ronin Waypoint

Overview​

This guide lists the initial setup steps for integrating the Ronin Waypoint account and keyless wallet service into your game or dApp.

Prerequisites​

Optionally, complete the user journey to understand the end user's experience.

Steps​

Step 1. Sign up for a Sky Mavis Account​

Your first step is to sign up for a Sky Mavis Account as a developer:

  1. Go to the Developer Console.
  2. Create an account using an email and password or social login.
  3. Optionally, complete a short survey.

Your Sky Mavis Account is ready to use.

Step 2. Create an app​

Next, create an app in the Developer Console to get your client ID and API key:

  1. In the Developer Console, click Create application.
  2. Enter your app's name, then click Create.
  3. Select the app you created, then click Edit, and then fill in the app details, including the app description, website, and logo.
  4. Click Save.

Step 3. Configure Ronin Waypoint settings​

Then, request access for your app to use Ronin Waypoint, and configure the initial settings:

  1. In the Developer Console, select your app, then App Permission > Sky Mavis Account (OAuth 2.0) > Request Access.

  2. When your request is approved, you see OAuth 2.0 and Waypoint Service under Products. Click Waypoint Service, then click Edit.

  3. Configure the general settings:

    • In Token Expire Duration, define the expiration duration for the access token.
    • In Redirect URI, define the URI to which Ronin Waypoint navigates back after an authorization or transaction operation is completed. The redirect URI can have the format of a deeplink, URI, or universal link. You can add as many URIs as needed. Responses are sent to the URI as query strings: uri?a=1&b=2.
    • In Origin URI, define your app's origin URI. This is the URI that's authorized to access the Ronin Waypoint service. The origin URI must have either the http or https scheme.
    • Click Save.

You have now configured the settings for your app, and are ready to integrate Ronin Waypoint.

  • Notice your client ID in the Client Credentials panel of the Ronin Waypoint settings. You will need this to initialize the SDK.
  • Your API key is available in your app's Information tab, under Key.

Step 4. Allowlist your smart contract​

To ensure security for your users, we require that developers using Ronin Waypoint register their game's smart contract address with Sky Mavis. This way, whenever a user sends a transaction in your game or dApp, we can verify that they interact with the correct smart contract associated with your app ID.

Follow these steps to have your smart contract allowlisted:

  1. Deploy your smart contract on Ronin. For more information, see Deploy smart contracts on Ronin.
  2. Share the smart contract address with your Sky Mavis point of contact for allowlisting.

Step 5. Apply for gas sponsorship​

If you want to sponsor gas fees for your users, follow the steps in the Sponsor gas fees guide.

Next steps​

Integrate Ronin Waypoint into your project using the SDK that best fits your platform: