Tamagotchi

The traditional, Japanese, handheld digital pet. Recreated using smart contracts. The point of the game is to keep the pet alive by feeding them. This is done using Food(snip20) tokens which the users sends to the Pet contract. Feeding can only be done after a certain time to avoid constant feeding. To purchase Food tokens, a BuyFood message must be sent over to the Market contract. This will mint tokens for the user based on the preset exchange ratio.

Contracts

Name	Description
Market	Used as a marketplace to buy FOOD tokens
Food	Snip-20 contract, used to create the token
Pet	Tamagotchi like interface through the contract

Per user instance

The main branch has a simple implementation of the Pet contract where the entire contract is a single pet. If the Pet dies, you need to create a new contract. For a better implementation checkout the instance branch.

Frontend

See Frontend folder

Building the contracts

To get started, there is a bash script included to build and optimize all contracts. Simply run:

chmod +x ./scripts/1_build_optimize_all.sh
./scripts/1_build_optimize_all.sh

This is done for compatability reasons. Namely, the optimizer container does not support workspaces and some crates fail to compile on ARM ased CPU's.

The optimized contracts are generated in the artifacts/ directory.

Using the contracts

Make sure to upload all contracts first You can use a local node or connect to a testnet. These contracts have been tested on the pulsar-1 network.

1. Create an instance of the Food contract using the following init message:

{
   "name":"Food",
   "symbol":"FDT",
   "decimals":2,
   "prng_seed":<random_string>,
   "config":{
      "enable_mint":true,
   }
}

2. Create an instance of the Market contract using the following init message:

{
   "token_contract_address":" <food contract address>",
   "token_contract_hash":"<food contract hash>",
   "token_exchange_rate": "100"
}

3. Create an instance of the Pet contract

{
   "accepted_token":
      {
         "address": "<food contract address>",
         "hash":"<food contract hash>",
      },
   "allowed_feed_timespan": <time in seconds>,
   "total_saturation_time": <time in secconds>,
   "viewing_key": "<some secret>"
}

4. Add the Market contract as a valid minter

   secretcli tx compute execute FOOD_ADDR '{"add_minters": {"minters":[MARKET_ADDR]}}' --from WALLET

total_saturation_time - total time a pet can last in seconds allowed_feed_timespan - time in seconds after which the pet can be fed.

Feeding timespan should be smaller than saturation time. For example, if saturation time is 4h and allowed feed timespan is 3h, the pet can be fed after 3h but before it dies at the 4h mark.

Messages

Food

This contract is a fork of the official SNIP-20 implementation. All the messages are the same.

Market

Message	Description
BuyFood	Takes the sent funds and mints food tokens according to the ratio
Config	Returns the constants set for the contract. (exchange rate, etc..)
TotalRaised	The amount of funds the contract currently holds

Pet

Message	Description
Receive	Callback message sent from the Food contract once someone sends tokens
LastFed	Returns the timestamp at which the pet was last fed. (Unix time)
AcceptedToken	Returns info about the token which the contracts accepts payments from