Cere Games SDK

Cere Games SDK is an NPM package which allows a game developer to easily integrate with CERE infrastructure & DDC interaction. The SDK provides methods to fetch/update player score, display UI components based on game settings.

Installation

Using NPM:

npm install @cere/games-sdk --save

Using yarn:

yarn add @cere/games-sdk

API

• GamesSDK
  • wallet
  • init()
  • showPreloader()
  • showLeaderboard()
  • showConnectWallet()
  • saveScore()

GamesSDK

The constructor creates uninitialized SDK instance

import { GamesSdk } from '@cere/games-sdk';

const gamesSdk = new GamesSdk({
  env: 'dev',
  gameId: 'tower-game',
  gameInfo: {
    name: 'Tower Game',
    tags: ['towergame', 'web3', 'gamer'],
    url: window.location.href,
    logoUrl: 'http://...',
  },
  onReady: () => {
    console.log('The SDK is ready!');
  },

  onWalletDisconnect: () => {
    console.log('The Wallet has been disconnected');
  },
});

Parameters

• env - the SDK environment. Can be one of the following:
  • local - loads all its dependencies from local environment (localhost)
  • dev - loads all its dependencies from the development environment
  • stage - loads all its dependencies from the stage environment
  • prod - loads all its dependencies from the production environment
• gameId - unique game identifier
• gameInfo - additional information about the game
  • name - name of the game
  • tags - list of tags
  • url - public game URL
  • logoUrl - URL to the game's logo image
• onReady - a callback called when the SDK is initialized and ready for interactions
• onWalletDisconnect - a callback called when the Wallet is disconnected by player

wallet

Pre-configured Cere Wallet instance

// Get wallet accounts
const accounts = await gamesSdk.wallet.getAccounts();

console.log('Connected wallet accounts', accounts);

// Transfer tokens
const txHash = await gamesSdk.wallet.transfer({
  token: 'CERE',
  to: '...',
  amount: 10,
});

console.log('Connected wallet accounts', accounts);

init()

This method initializes the SDK. It also performs the following tasks:

• Registers UI elements (Web Components)
• Configures and initializes Cere Wallet
• Calls onReady callback

await gamesSdk.init();

showPreloader()

This method shows Preloader modal window which covers entire screen.

const preloader = gamesSdk.showPreloader({
  onStart: () => {
    // Start the game
  },
});

Parameters

• onStart - a callback which is called when player requests to start the game by clicking on Start button

The method returns a preloader modal instance of the following type:

type Preloader = {
  readonly isOpen: boolean;
  open: () => void;
  close: () => void;
  setReady: (isReady: boolean) => void;
};

When the game logic should call setReady method when its assets are fully loaded. It will enable Start button in the preloader modal.

function onGameAssetsLoaded() {
  preloader.setReady();
}

showLeaderboard()

This method shows Leaderboard modal which covers entire screen.

const modal = gamesSdk.showLeaderboard({
  onPlayAgain: () => {
    // Re-start the game
  },

  onBeforeLoad: () => {
    // Check if the wallet is connected or save unsaved player score
  },
});

Parameters

• onPlayAgain - a callback which is called when player requests to play the game again by clicking on Play Again button
• onBeforeLoad - a callback which is called right before the leaderboard data is requested

The method returns a modal instance with the following type:

type Modal = {
  readonly isOpen: boolean;
  open: () => void;
  close: () => void;
};

showConnectWallet()

This method shows Connect Wallet modal which covers entire screen. The modal asks the player to connect their Cere Wallet.

const modal = gamesSdk.showConnectWallet({
  score: 20,
  onConnect: () => {
    // The wallet is connected
  },
});

Parameters

• score - current player score to be shown on Wallet Connect UI
• onConnect - a callback which is called when player connects their wallet
• onComplete - a callback which is called wallet connect is completed and the modal is closed

The method returns a modal instance with the following type:

type Modal = {
  readonly isOpen: boolean;
  open: () => void;
  close: () => void;
};

saveScore()

This method shows saves the player score to DDC.

await gamesSdk.saveScore(500);

Parameters

• score - the player current score