SPECIFICATION.md

Table of Contents

• Overview
• Use Cases
  • Core Functionality
    • new_game()
    • make_move()
    • get_board()
    • get_game_state()
    • get_current_player()
    • get_players()
  • Diagrams
    • Sequence Diagram

Overview

This document provides an overview of the application.

It outlines the use cases, i.e. desirable functionality, in addition to requirements for the smart contract and the user interface.

Use Cases

This section contains general information about the functionality of the application and thus does not touch upon any technical aspects.

If you are interested in a functional overview then this is the section for you.

Core Functionality

new_game()

1. Initializes a new game with 2 players and resets the previous state.
2. Reverts when:
   1. A game has not finished.

make_move()

1. Allows a player to place a marker on the game board.
2. Checks if the move ends the game with either one player winning or a draw.
3. Reverts:
   1. When the game has already ended.
   2. If the incorrect player tries to make a move.
   3. If a player tries to make a move out of bounds.
   4. If a player tries to make a move to an occupied cell.

get_board()

View function to return the player positions in the current game.

get_game_state()

View function to return the current state of the game.

get_current_player()

View function to return the player who's turn it is to make a move.

get_players()

View function to return the players of the current game.

Diagrams

Sequence Diagram