Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Technical breakdown of sudt demo #434

Open
Keith-CY opened this issue Aug 15, 2023 · 11 comments
Open

Technical breakdown of sudt demo #434

Keith-CY opened this issue Aug 15, 2023 · 11 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Keith-CY
Copy link
Member

Keith-CY commented Aug 15, 2023

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
Copy link
Member Author

Keith-CY commented Aug 15, 2023

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
Copy link
Member Author

Keith-CY commented Aug 15, 2023

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
Copy link
Member Author

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

@Keith-CY Keith-CY added the documentation Improvements or additions to documentation label Aug 16, 2023
@yanguoyu
Copy link
Contributor

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
Copy link
Member Author

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
Copy link
Member Author

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

@Sven-TBD
Copy link
Collaborator

Sven-TBD commented Aug 21, 2023

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

@Keith-CY
Copy link
Member Author

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

I have a question about the account id

image

So we can have a talk on the next meeting

@Keith-CY
Copy link
Member Author

Design draft has been updated at Magickbase/visual-style-guide#33
please have a review @Sven-TBD @PainterPuppets @Daryl-L @yanguoyu

@Daryl-L
Copy link
Contributor

Daryl-L commented Aug 30, 2023

image
What are the differences between Asset and Token, I could still not get it after thinking for a while.

@Keith-CY
Copy link
Member Author

image What are the differences between Asset and Token, I could still not get it after thinking for a while.

Assets is what I own.
Tokens is the list of tokens issued by this service.

@Keith-CY Keith-CY moved this from 🏗 In progress to ✅ Done in CKB JS Backlog Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

5 participants