Skip to main content

Set up and configure Ronin Waypoint

Overview​

This guide walks you through the setup and configuration steps for integrating Ronin Waypoint into your game. You'll set up your app in the Developer Console, configure the Waypoint service settings, and register smart contracts for transaction policy.

Prerequisites​

Steps​

Step 1. Sign up for Sky Mavis Account​

Register for a Sky Mavis Account to access our Developer Console:

  1. Go to the Developer Console.
  2. Create an account using an email and password or social login.

Your Sky Mavis Account is ready to use.

Step 2. Create an app in Developer Console​

Next, create an app in the Developer Console:

  1. Log in to the Developer Console with your Sky Mavis Account.

  2. Click Create application.

  3. Enter your app's name, then click Create.

  4. Select the app you created, then click Edit, and then on the Information tab, fill in the Website URL, Project Type and App Logo fields.

  5. Click Save.

Step 3. Configure Ronin Waypoint settings​

Required parameters

Redirect URI, Origin URI, and Client ID are required to initialize the Ronin Waypoint SDK. Failure to provide these parameters will result in errors during the integration process.

Complete the setup steps to configure Ronin Waypoint for your app:

  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. Ignore OAuth 2.0.

  3. Click Waypoint Service, then click Edit.

  4. Configure your app for Ronin Waypoint:

    • In Token Expire Duration, define the expiration period for the ID token that is returned after user authorization with Ronin Waypoint. The recommended duration is 1 hour and at least 5 minutes. After expiration, you need to re-authorize Ronin Waypoint to issue a new ID token with the set duration.

    • In Redirect URI (required), define the URIs to which Ronin Waypoint navigates back after an authorization or transaction operation is completed. For mobile platforms, the redirect URI is your mobile app's deep link (for example, mydapp://callback).

      Make sure to allowlist your redirect URIs

      Share your redirect URIs with your Sky Mavis point of contact to allowlist them for your app.

    • In Origin URI (required), 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.

  5. Copy the value from the CLIENT ID (APPLICATION ID) field. You will need this value for the next step.

Step 4. Register smart contracts​

For security reasons, we require you to register your smart contracts with Ronin Waypoint to enable users to interact with them. This process ensures that only authorized smart contracts can be accessed by users.

  1. Construct your game's smart contracts and deploy them to Ronin, or migrate your existing smart contracts from another chain.
  2. Give the contract addresses to your Sky Mavis point of contact.
  3. We will map the contracts to your app's client ID.

Step 5. (Optional) Apply for gas sponsorship​

You can apply for gas sponsorship to cover the transaction fees for your users. For more information, Use gas sponsorship.

Next steps​

After the setup is complete, you can integrate Ronin Waypoint into your game using the SDK that best fits your platform: