Technical breakdown of sudt demo

[Keith-CY]

This issue is a complement to the sudt demo, user stories can be found at https://github.com/ckb-js/kuai/blob/52925123c49dd45de682a5291a9ae2c0637a8221/docs/PRD/user_story.md

Flowchat of service end and client end: #250 (comment)

[Keith-CY]

Server

Platform

• Railway

Services

• Redis
  • used as message queue
  • for cache
• PG
  • save minted token list
  • save token distribution
• Testnet node(community)

APIs

• get token list: get all token minted by the service
• get token metadata: get metadata of a specific token
• get token distribution: get distribution of a specific token
• get assets list: get all token held by a specific address
• get minted token: get minted token of a specific address
• mint token: construct a transaction to mint a token
• update token info: submit metadata of a token to ckb explorer
• transfer token: send X amount token to a specific address
• transfer history: transfer list of a specific address

[appended]

• get network type: get the network type the service is connected to
• get balance: get balance of a set of addresses

[Keith-CY]

Frontend

Platform

• vercel
• railway

Pages

• Connect to wallet
• Overview
  • Disconnect button: with wallet
  • CKB Balance: from CKB Explorer
  • Address
  • Network type
    • Mainnet(disabled)
    • Testnet
  • Menu
    • Send
    • Receive
    • Create/Manage
  • Tabs
    • Assets
      • List of token: from demo service, to fetch tokens held by a specific address
        • Token name
        • Balance
    • Tokens
      • List of token: from demo service, to fetch tokens minted by the service
        • Token name
        • Menu
          • View
          • Modify
          • Mint
      • Auto-detect switch: turn on to fetch token metadata from CKB Explorer
    • History
      • List of transfer: from demo service, to fetch transfers of a specific address
        • Tx hash
        • Tx status
        • From address
        • Changed token amount
        • Changed CKB
  • Claim testnet token
• Token detail
  • Metadata: from CKB Explorer
    • Symbol
    • Name
    • Amount
    • Decimal
    • Description
    • Website
    • Icon
  • Distribution?
• Token management
  • Similar to the metadata of token detail
• Token mint
  • Token metadata
  • Mint amount
  • Recipient
• Send page
  • Token Selector: from demo service, to fetch tokens held by a specific address
  • Amount
  • Recipient
• Receive page
  • QR Code

[Keith-CY]

I've done a technical breakdown roughly, please have a review and add more details if possible. @Daryl-L @PainterPuppets @yanguoyu

And we may need support from designer cc @Sven-TBD

[yanguoyu]

Server

Add a api to get network type.

Frontend

CKB Balance: from CKB Explorer

Does this means the CKB Balance will get from explorer API, but not from get assets list or demo's server?

[Keith-CY]

Server

Add a api to get network type.

A api to get network type can be added for api users/frontend developers to check if their projects are connected to the correct service. I'll append it to the list

Frontend

CKB Balance: from CKB Explorer

Does this means the CKB Balance will get from explorer API, but not from get assets list or demo's server?

I thought it could be fetched from the CKB Explorer, but after a double thought I found it's infeasible because the CKB Explorer doesn't support getting balance of a set of addresses. So a batch of requests will be made. We may have to add an API for getting the balance

[Keith-CY]

I've done a technical breakdown roughly, please have a review and add more details if possible. @Daryl-L @PainterPuppets @yanguoyu

And we may need support from designer cc @Sven-TBD

We will push the work if no more feedback to the technical breakdown

And how is the design going @Sven-TBD

[poor-defined]

api to get network type can be added for api users/frontend developers to check if their projects are connected to the correct service. I'll append it to the list

The UI design will be done this week. Last week I did some adjustment to prototype to make Kuai support WalletConnect and multiple addresses within the History function and so on. The PRD link is here , should we include this to the UI as well , or discuss it on next meeting first? @Keith-CY