https://github.com/aimensahnoun/near-dice

A small game where a user can create a room by putting Near tokens into it. A second user can then join the game and guess the dice result (1-6), if the guess is correct the total amount of tokens is transfered to the player, otherwise it is transfered to the creator.
https://github.com/aimensahnoun/near-dice

game near-protocol

Last synced: 7 days ago
JSON representation

A small game where a user can create a room by putting Near tokens into it. A second user can then join the game and guess the dice result (1-6), if the guess is correct the total amount of tokens is transfered to the player, otherwise it is transfered to the creator.

• Host: GitHub
• URL: https://github.com/aimensahnoun/near-dice
• Owner: aimensahnoun
• Created: 2022-01-24T18:21:46.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-29T17:43:19.000Z (almost 3 years ago)
• Last Synced: 2024-10-12T05:51:53.694Z (about 1 month ago)
• Topics: game, near-protocol
• Language: TypeScript
• Homepage:
• Size: 22.5 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Near Dice

A small game where a user can create a room by putting Near tokens into it. A second user can then join the game and guess the dice result (1-6), if the guess is correct the total amount of tokens is transfered to the player, otherwise it is transfered to the creator.

# Functions

## initGame 

 - Does not take any parameters.

 - Creator must attach a deposit > 0 in order to create a room

 - returns a **game id**

**Example call:**

`near call $CONTRACT initGame --amount 5 --account_id $NEAR_ACCOUNT`

## joinGame

 - Takes ***_gameId*** as a parameter

 - Player must attach a deposit > 0 in order to create a room

 - Returns a string confirming that the player has successfully joined the room

**Example call:**

`near call $CONTRACT joinGame '{"_gameId": '$GAMEID'}' --amount 3 --accountId $NEAR_ACCOUNT`

## playGame 

 - Takes ***_gameId*** and ***_guess*** as parameters

 - Guess must be between 1-6

 - The game's player and the person calling the function must be the same

 - A game has to be in the **JOINED** state in order to be played

 - returns the dice number as well as the winner's name

 

**Example call:**

`near call $CONTRACT playGame '{"_gameId":'$GAMEID' , "_guess":3 }' --accountId $NEAR_ACCOUNT`

## deleteGame 

 - Takes ***_gameId*** as  a parameters

 - The person calling this function must be the owner 

 - The game must be in the **FINISHED** in order to be deleted

 - returns a string confirming game deletion

 **Example call:**

`near call $CONTRACT deleteGame '{"_gameId":'$GAMEID' }' --accountId $NEAR_ACCOUNT`

 

## viewGame 

 - Takes ***_gameId*** as  a parameters

 - returns the game's details

 

 **Example call:**

`near call $CONTRACT viewGame '{"_gameId":'$GAMEID' }' --accountId $NEAR_ACCOUNT`

 

## viewAllGames 

 - Does not take anything as a parameter

 - returns an array of all games

**Example call:** 

`near view $CONTRACT viewAllGames --accountId $NEAR_ACCOUNT`

 

## reactivateGame 

 - Takes ***_gameId*** as  a parameters

 - The person calling this function must be the owner 

 - The game must be in the **FINISHED** in order to be reactivated

 - The creator must attach some tokens into the function

 - Returns a string confirming game reactivation

**Example call:**

`near call $CONTRACT reactivateGame '{"_gameId": '$GAMEID'}' --amount 3 --accountId $NEAR_ACCOUNT`