Sui Checkers

A fully on-chain checkers game. Built on Sui by Ethos.

Sui Checkers consists of a smart contract that allows the player to mint a game that is playable on chain.

You can play Sui Checkers at https://ethoswallet.github.io/checkers.

Sui Checkers consists of a smart contract that allows the player to mint a game that is playable on chain.

Sui

This project is built on the Sui blockchain, which provides the performance necessary for a great game experience. Every move is a transaction that is recorded on-chain, making the gameplay verifiable, shareable, and transferable. Each game is an NFT that can be sent to anyone and will display in a web3 wallet (such as the Ethos Wallet).

Ethos

This project uses the Ethos APIs to make the Ethos Checkers game accessible to people who do not yet have a web3 wallet. It allows them to start playing the game right away without having to figure out a wallet first.

As far as the game is concerned every player has a wallet because the Ethos APIs provide a unified interface for both players with and without wallets.

The primary methods that this game uses to do this are:

<EthosWrapper>, SignInButton, and ethos.transact()

Each of these can be found by searching in js/game.js

• The Ethos APIs currently require react and react-dom which is why they are included.

The Smart Contract

The Ethos Checkers smart contract is written Sui Move for deployment on the Sui blockchain. It consists of three parts:

1. Game: Primarily entry functions for making moves and recording the overall game state.

2. Game Board: Most of the game logic.

The code for the smart contract is in the "move" folder.

Working With The Smart Contract

From the move folder:

Build

sui move build

Test

sui move test

or

sui move test --filter SUBSTRING

Deploy

sui client publish --gas-budget 10000

The Front-End

The front end is written in plain javascript, html, and css. It has minimal dependencies and is statically hosted on GitHub, using the blockchain for all persistent state.

It has react as a dependency to work properly with the Ethos apis which provide wallet connecting capabilities as well as an easy pathway for people who do not yet have a wallet to play the game via email or social authentication.

Working With The Front-End

Running

yarn start

This will install all necessary dependencies, build the project, launch a server, and open a browser to the correct url.