ChessNut

Chess over nostr where players can place bets using cashu tokens (Nuts)

Live demo Here

This is project isn't working yet, don't pay any lightning invoices (you will lose your hard earned sats)

Nostr Events

erDiagram
    METADATA {
        string name
        string picture
    }
    PLAYER {
        string pubkey
    }
    PLAYER ||--|| METADATA : pubkey

    MODERATOR {
        string pubkey
        string[] relay-list "10002 relay list"
        string[] games "keep track of active games"
    }
    MODERATOR ||--o{ GAME : games
    MODERATOR ||--|| METADATA : pubkey

    GAME {
        string id "event id"
        int kind "2500"
        string content "public message"
        string author "player starting game"
        string type "[type, enum] the type of game, chess/tictacktoe/checkers..."
        string playerA "[p, self, r, 'playerA']"
        string playerB "[p, playerB, r, 'playerB']"
        string moderator "[p, moderator, r, 'moderator']"
        string relay "[r, relay] the relay that should be used"
        string state "[state, fen] starting state"
        int expire "[expire, unix date] the expiration date (optional)"
        int timeout "[timeout, seconds] how long to wait for next state (optional)"
    }
    GAME ||--|| PLAYER : author
    GAME ||--|| PLAYER : playerA
    GAME ||--|| PLAYER : playerB
    GAME ||--|| MODERATOR : moderator

    STATE {
        string id "event id"
        int kind "2501"
        string author "player making the state change"
        string type "[type, type enum] (move, forfeit, draw)"
        string move "[move, move] chess move (optional)"
        string state "[state, fen] new state"
        string game "[e, game, r, 'game']"
        string previous "[e, state id, r, 'previous'] (optional)"
        string moderator "[p, moderator, r, 'moderator']"
    }
    STATE ||--|| PLAYER : author
    STATE ||--|| GAME : game
    STATE ||--o| STATE : previous
    STATE ||--|| MODERATOR : moderator

    PLACE-BET {
        string id "event id"
        int kind "25002 (Ephemeral Event)"
        string author "player creating the bet"
        string game "[e, game, r, 'game']"
        string moderator "[p, moderator, r, 'moderator']"
        string cashuToken "[cashu, tokens] encrypted for moderator"
    }
    PLACE-BET ||--|| PLAYER : author
    PLACE-BET ||--|| GAME : game
    PLACE-BET ||--|| MODERATOR : moderator

    BET {
        string id "event id"
        int kind "2502"
        string author "moderator"
        string player "[p, player] player who create the bet"
        int amount "[value, int] value in sats"
        string game "[e, game, r, 'game']"
        string mint "[mint, mint url] the url of the mint"
    }
    BET ||--|| MODERATOR : author
    BET ||--|| PLAYER : player
    BET ||--|| GAME : game

    FINISH {
        string id "event id"
        int kind "2503"
        string author "moderator"
        string content ""
        string reason "[reason, enum reason] (win, draw)"
        string game "[e, game, r, 'game']"
        string previous "[e, state id, r, 'previous'] (optional)"
        string players "[p, player, r, 'player'] multiple p tags for all players"
        string winner "[winner, player] (optional) the winning player"
        string cashu "[cashu, token, player] (encrypted for player) (can have multiple)"
    }
    FINISH ||--|| MODERATOR : author
    FINISH ||--|| PLAYER : winner
    FINISH ||--|| PLAYER : looser
    FINISH ||--|| STATE : lastState
    FINISH ||--|| GAME : game

Loading

Game Flow

flowchart TD
    subgraph Player A
    afindPlayer[Find player B]-->aCreateGame[Create game]
    aCreateGame-->aSendNuts[Send nuts]
    aCreateGame-.Start without nuts.->aWaitForTurn
    aSendNuts--> aWaitForNuts([Wait for reward])
    aSendNuts-.Start without nuts.->aWaitForTurn
    aWaitForNuts-->aWaitForTurn([Wait for turn])
    aWaitForTurn-->aGameMove[Game Move]
    aWaitForTurn-->aForfeit[Forfeit]
    aWaitForTurn-->aProposeDraw[Propose draw]
    aSendNuts-->aWatchTokens([Watch for tokens])
    aWatchTokens-->aClaimTokens[Claim tokens]
    end

    subgraph Moderator Bot
    modFindGame([Find game])-->modWatchForNuts([Watch for nuts])
    modWatchForNuts-->modConsumeNut[Melt nuts]
    modConsumeNut-->modCreateReward[Create reward]
    modFindGame-->modWatchMove([Watch moves])
    modFindGame-->modWatchForfeit([Watch Forfeit])
    modFindGame-->modWatchForDraw([Watch for draws])
    modFindGame-->modWatchForBranches([Watch for branches])
    modWatchMove--checkmate-->modSendTokens[Send Tokens to winner]
    modWatchForfeit-->modSendTokens
    modWatchForDraw-->modReturnTokens[Return tokens]
    modWatchForBranches--Penalize player-->modSendTokens
    end

    subgraph Blayer B
    bLookForGames([Find game])-->bWaitForNuts([Wait reward])
    bWaitForNuts-.start without nuts.->bFirstMove
    bWaitForNuts-->bSendNuts[Send nuts]
    bSendNuts-->bFirstMove[First move]
    bFirstMove-->bWaitForTurn([Wait for turn])
    bFirstMove-->bWatchTokens([Watch for tokens])
    bWaitForTurn --> bGameMove[Game Move]
    bWaitForTurn-->bForfeit[Forfeit]
    bWaitForTurn-->bProposeDraw[Propose draw]
    bWatchTokens-->bClaimTokens[Claim tokens]
    end

    aSendNuts-.->modWatchForNuts
    bSendNuts-.->modWatchForNuts
    bFirstMove-.->aWaitForTurn
    modCreateReward-.->bWaitForNuts
    modCreateReward-.->aWaitForNuts
    aCreateGame-.->bLookForGames
    aCreateGame-.->modFindGame
    aGameMove-.->bWaitForTurn
    bGameMove-.->aWaitForTurn
    aGameMove-.->modWatchMove
    bGameMove-.->modWatchMove
    aForfeit-.->modWatchForfeit
    bForfeit-.->modWatchForfeit
    modSendTokens-.->aWatchTokens
    modSendTokens-.->bWatchTokens
    aProposeDraw-.->modWatchForDraw
    bProposeDraw-.->modWatchForDraw
    modReturnTokens-.->aWatchTokens
    modReturnTokens-.->bWatchTokens
    bFirstMove-.->modWatchForBranches
    bGameMove-.->modWatchForBranches
    aGameMove-.->modWatchForBranches

Loading