FAQ

How to debug app?

Our sdk is using rpc to communicate between game and Arena. To debug it, you need to enable logs and check console output.

Enable logs

import * as ArkadiumApi from '@arkadiuminc/sdk';

const sdk = await ArkadiumApi.getInstance();
sdk.debugMode(true);

After that you will see all rpc calls in console output. We have two types of rpc services: RPC publisher and RPC subscriber. RPC publisher is used to send messages to Arena/Game. RPC subscriber is used to receive messages from Arena/Game.

Let's take a look at the example:

import * as ArkadiumApi from '@arkadiuminc/sdk';

const sdk = await ArkadiumApi.getInstance();
await sdk.lifecycle.onTestReady();

We have initialized sdk and called onTestReady method. This method is RPC publisher. It sends message to Arena/Game. It returns promise, which will be resolved when Arena/Game will send response.

Let's take a look at the console output:

(log_origin: http://localhost:8083, log_instance_id: 0ONM3STMHlHiEqIxoIeaA) (rpc publisher) sending message:  
 { module: "GameLifecycle", func: "OnTestReady", payload: [] } can send: {"isValidTarget":true,"isTargetSameAsOwnWindow":false}

We can see that game is sending message via sdk to Arena. The structure of log message is:

log_origin - the origin of window.location, where sdk instance is located.

log_instance_id - the id of rpc instance. It is used to identify which rpc instance is used to send message.

rpc publisher/subscrive - the type of rpc instance. In this case it is publisher.

sending message - custom message, which is sent to Arena/Game.

if the event in rpc is sending message, then we append info about target window, where message will be sent. The structure of target window is:

{
    isValidTarget: boolean, // is target window valid
    isTargetSameAsOwnWindow: boolean, // is target window the same as current window
}

This info must help you to identify, why message was not sent.

isValidTarget - Checks for target to be window like object. Generally, it is used to check if target supports postMessage method and it can be used to send message.

isTargetSameAsOwnWindow - Checks if target is the same as current window. If the game is inside iframe, it should be false. Probably the target was set incorrectly.

For each send message you must see the response message:

(log_origin: http://localhost:3511, log_instance_id: sarO0qvXgqPbNa0K9cwsY) (rpc subscriber) send a response for  GameLifecycle_OnTestReady_60_1703172714823_0.007 , can send:  {"isValidTarget":true,"isTargetSameAsOwnWindow":false}

(log_origin: http://localhost:8083, log_instance_id: 0ONM3STMHlHiEqIxoIeaA) (rpc publisher) got response:  
 { module: "GameLifecycle", func: "OnTestReady", payload: [] } from: http://localhost:8083

Here we can see that Arena has sent response to our message. It has different log_origin and log_instance_id, because it is Arena and it is different instance. Then we see that Game got a respsone from Arena.

You must see this log message at last.

(log_origin: http://localhost:8083, log_instance_id: 0ONM3STMHlHiEqIxoIeaA) (rpc publisher) got a response: GameLifecycle_OnTestReady_60_1703172714823_0.007  has a callback:  true

It means that sdk has received response from Arena and it has called callback function.

If it has callback function, it means that promise will be resolved, if not it will be stuck forever.

If function return undefined, promise also must be resolved.

So if your promise is stuck, you need to check console output, probably something wrong with target you have passed to sdk.

Summary:

If your game is inside iframe.

• Enable logs
  • check if target is valid and it is not the same as current window.
  • check if for each request there is a response.
  • check if there is only one log_instance_id got a response.
  • check your game in sandbox, it make some kind of self check and light indicators in UI with green if everything is ok. Both indicators must be green.