NCIP 24

[Atralupus]

We are planning a rework of the Arena Service, which will be documented as an NCIP, though it hasn’t been published yet. Development will start in advance.
Updates will be made to the README on the ncip-24 branch as we work.
Once the NCIP is finalized and published, we’ll update the README with details on the process and progress.

[Atralupus]

Done

[Atralupus]

sequenceDiagram
    actor User
    participant Client
    participant ArenaService
    participant Blockchain
    participant DB

    Note over User,DB: Arena Registration
    User->>Client: Request Arena Registration (Previous season participants are auto-registered)
    Client->>ArenaService: Send Registration Request
    ArenaService->>DB: Check Registration Status
    DB-->>ArenaService: Return Registration Status
    ArenaService->>DB: Save New Registration (if needed)
    ArenaService-->>Client: Respond with Registration Complete
    Client-->>User: Display Registration Result

    Note over User,DB: Update Opponent List
    User->>Client: Request List Update
    Client->>ArenaService: Send Update Request
    ArenaService->>ArenaService: Verify Costs
    ArenaService->>DB: Fetch Current Ranking
    DB-->>ArenaService: Return Ranking Info
    ArenaService->>ArenaService: Generate New List
    ArenaService->>DB: Save New List
    ArenaService-->>Client: Provide Updated Opponent List
    Client-->>User: Display Updated UI

    Note over User,DB: Conduct Battle
    User->>Client: Start Battle
    Client->>ArenaService: Validate Battle Request
    ArenaService->>ArenaService: Check Conditions (Tickets/Opponent Availability)
    ArenaService->>ArenaService: Sign Battle Token
    ArenaService-->>Client: Provide Validation Result and Token
    Client->>Blockchain: Send Arena Battle TX (with Token)
    Blockchain-->>ArenaService: Battle Result Event (including TX ID)
    ArenaService->>ArenaService: Poll TX and Verify Result
    ArenaService->>ArenaService: Calculate Scores and Generate Result
    ArenaService->>DB: Save Battle Result/Scores
    ArenaService-->>Client: Provide Updated Information
    Client-->>User: Display Battle Result

Loading

[Atralupus]

I have organized the flow for each part separately.

[Atralupus]

How to work battle

sequenceDiagram
    participant User
    participant Client
    participant RestAPI
    participant Worker
    participant 9cChain
    participant Database

    User ->> Client: Requests battle
    Client ->> RestAPI: Requests battle token
    RestAPI ->> Client: Returns battle token
    Client ->> 9cChain: Sends Battle Action with token
    Client ->> RestAPI: Sends Transaction ID
    loop Polling
        Client ->> RestAPI: Checks battle status
        RestAPI -->> Client: In progress (retry after n seconds)
    end
    RestAPI ->> Worker: Sends Transaction ID
    Worker ->> 9cChain: Monitors transaction
    9cChain -->> Worker: Confirms block and provides result
    Worker ->> Database: Stores battle result
    Database -->> RestAPI: Battle result saved
    RestAPI ->> Client: Returns battle result
    Client ->> User: Displays battle result

Loading

[Atralupus]

How to work season

sequenceDiagram
    participant Worker
    participant Redis
    participant 9cChain

    loop Block Index Monitoring (Every 2 seconds)
        Worker ->> 9cChain: Fetch current block index
        9cChain -->> Worker: Return block index
        Worker ->> Redis: Update cached block index
    end

    loop Season Flow
        Redis -->> Worker: Retrieve cached block index
        Worker ->> Worker: Calculate current season and round
        Worker ->> Redis: Cache current season and round info
    end

    loop Battle and Opponent Initialization
        Worker ->> Redis: Fetch current season and round info
        Redis -->> Worker: Return season and round info
    end

Loading

Based on the cached season and round in Redis, tickets are used or battles are processed accordingly.
The key point is that time progresses based on the block index.
There is also a possibility that it could be based on actual time (UTC) instead of the block index. This may change depending on the final decision in the NCIP.

[Atralupus]

sequenceDiagram
    participant User
    participant Server
    participant Blockchain

    User->>Server: Use Basic Battle Ticket
    Server->>Server: Check Remaining Basic Tickets
    alt Basic Tickets Available
        Server->>User: Battle Token Issued
    else No Basic Tickets Remaining
        Server->>User: Error: No Basic Battle Tickets Remaining
    end

    User->>Server: Request to Purchase Battle Ticket
    Server->>Blockchain: Validate NCG Transaction
    Blockchain-->>Server: Transaction Success
    Server->>User: Battle Ticket Purchase Success

    User->>Server: Use Purchased Battle Ticket
    Server->>Server: Check Remaining Purchased Tickets
    alt Purchased Tickets Available
        Server->>User: Battle Token Issued
    else No Purchased Tickets Remaining
        Server->>User: Error: No Purchased Battle Tickets Remaining
    end

Loading

Battle Ticket

sequenceDiagram
    participant User
    participant Server
    participant Blockchain

    User->>Server: Use Basic Refresh Ticket
    Server->>Server: Check Remaining Basic Tickets
    alt Basic Tickets Available
        Server->>User: Opponent List Refreshed
    else No Basic Tickets Remaining
        Server->>User: Error: No Basic Refresh Tickets Remaining
    end

    User->>Server: Request to Purchase Refresh Ticket
    Server->>Blockchain: Validate NCG Transaction
    Blockchain-->>Server: Transaction Success
    Server->>User: Refresh Ticket Purchase Success

    User->>Server: Use Purchased Refresh Ticket
    Server->>Server: Check Remaining Purchased Tickets
    alt Purchased Tickets Available
        Server->>User: Opponent List Refreshed
    else No Purchased Tickets Remaining
        Server->>User: Error: No Purchased Refresh Tickets Remaining
    end

Loading

Refresh Ticket

Refresh (resetting available opponents) and Battle both require consuming tickets. Tickets reset each round and can be purchased additionally using NCG.

For Battles, consuming a ticket allows the ArenaService to issue a token that enables combat.

[Atralupus]

test infra planetarium/9c-infra#2262

[Atralupus]

we need an auth system, i'll talk about this discussion

[Atralupus]

and also need to some token for this part

#35

[Atralupus]

NCIP 24 published! https://github.com/planetarium/NCIPs/blob/ncip-24/NCIP/ncip-24.md

https://discord.com/channels/539405872346955788/1323178979984670821/1323179523138912317

[Atralupus]

After this conversation, I labeled all the issues I created with ncip-24