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

add prd of WallectConnect general component #330

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions CKB-Explorer-PRDs/PRD.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
### General Components:



- Navbar in the header
- Navbar in the header
![navbar](https://user-images.githubusercontent.com/122437870/216756902-24f6e241-4bf6-4948-a269-8c5b204df7b3.png)
- Logo: link to the homepage
- Home: link to the homepage
Expand Down
43 changes: 43 additions & 0 deletions Neuron-PRDs/WalletConnect/GeneralComponent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# CKB General Component for WalletConnect

## General Component for Wallet Side

A general component is provided for WalletConnect on the side of third party wallet.

### Connecting flowchart

> Scanning QR code is the most used and also recommended for users to connect to dApp with your wallet. We also offer a way to connect by pasting the WalletConnect code which could be used for testing. [UI](https://www.figma.com/file/6XNoimRDbFTTNm016rbIdU/Magickbase?type=design&node-id=16072-38648&t=rF3mLzNYeaveGD6Q-0)

#### UI Sketch

![UI图](pic/2023-05-30-09-20-22.png)

#### Status1: Unconnected

While the dapp is unconnected with the wallet, users can click on the button below to scan QR code on the dapp side in order to connect the dapp.

![UnconnectStatus](pic/2023-05-30-08-19-27.png)

#### Status2: Connecting

After clicking the scan button, and if the QR code is correct then the dapp and wallet are trying to communicate following the protocol. If the QR code is not in correct format, corresponding messages will be popped up.

![ConnectingStatus](pic/2023-05-30-08-22-37.png)

#### Status3: Connect Request

Once the WalletConnection information fecthes back, the wallet shows the connection request information, including the dapp name, its url, network, Account and Auth.

- The network refers to the CKB network to which the dapp is going to connect.
- The Account refers to the CKB wallet account that the user is going to use.
- The Auth refers to the lock method for user addresses. Typically, a user's addresses can be divided into different adress sets based on the lock method they use, and here various classification methods are provided. Dapps can request the specific address sets they need, and users can choose to revoke authorization for certain address sets.

To cancel this request, just press the Reject button.

![ConnectRequest](pic/2023-05-30-08-42-31.png)

#### Status4: Connectting Information

After the connection is established, the dapp will maintain a persistent connection with the wallet. The relevant connection information, the confirmed information from the previous step, will still be displayed here. Users can disconnect from the dapp at any time.

![ConnecttingInformation](pic/2023-05-30-08-41-25.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 38 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,54 @@
# CKB Explorer Public Issues
# CKB Explorer & Neuron Public Issues

[![Discord](https://img.shields.io/discord/956765352514183188?label=Discord&logo=discord&style=default&color=grey&labelColor=5865F2&logoColor=white)](https://discord.gg/N9nZ3JE2Gg)

This repo is used to manage public issues of [CKB Explorer](https://github.com/nervosnetwork/ckb-explorer)
This repo is used to manage public issues of [CKB Explorer](https://github.com/nervosnetwork/ckb-explorer) and Neuron.

## User Story list

### CKB Explorer

| SN | User Story | Description | Dir | Issue | Axure |
|----|------------|-------------|-----|-----------|-------|
| 0 | General Components | Contain some common compoents | [open](CKB-Explorer-PRDs/GeneralComponents/GeneralComponents.md) | -| - |
|----|------------|-------------|-----|-------|-------|
| 0 | General Components | Contain some common compoents | [open](CKB-Explorer-PRDs/GeneralComponents/GeneralComponents.md) | - | - |
| 1 | Export to csv | The feature,Export to csv, provides a function on such as Block page, Transaction page and so on for user to download some transaction info from block explorer | - | [#325](https://github.com/Magickbase/ckb-explorer-public-issues/issues/325) | [open](https://app.axure.cloud/app/project/o093j5/preview/9ug42i) |
| 2 | Nervos DAO | The product requirements about Nervos DAO page | [open](CKB-Explorer-PRDs/NervosDAO/NervosDAO.md) | -| - |
| 3 | WalletConnect availability | Whole user story for the usage of WalletConnect, ranging from the dApp to Neuron CKB wallet | - | [#144](https://github.com/Magickbase/neuron-public-issues/issues/144)| [open](https://vs0cjf.axshare.com/#id=owrcmb&p=%E7%AE%80%E4%BB%8B&g=1) |
| 2 | Nervos DAO | The product requirements about Nervos DAO page | [open](CKB-Explorer-PRDs/NervosDAO/NervosDAO.md) | - | - |

### Neuron

| SN | User Story | Description | Dir | Issue | Axure |
|----|------------|-------------|-----|-------|-------|
| 1 | WalletConnect availability | Whole user story for the usage of WalletConnect, ranging from the dApp to Neuron CKB wallet | [open](Neuron-PRDs/WalletConnect/GeneralComponent.md) | [#144](https://github.com/Magickbase/neuron-public-issues/issues/144) [#153](https://github.com/Magickbase/neuron-public-issues/issues/153) [#148](https://github.com/Magickbase/neuron-public-issues/issues/148) | [open](https://vs0cjf.axshare.com/#id=owrcmb&p=%E7%AE%80%E4%BB%8B&g=1) |

## About project management

### Goals

- While reviewing the code, reviewers could quickly locate the issues then jump to the PRDs
- An overview of all product requirements, tech refactories, and so on.
- Keep PRD and related materials up to date and recording on github repo.

### Proposal 1: issue oriented and UserStory as an aspect

> Apart from the PRD.md file, Some SSD , API doc and other tech or any related files could also be attached to this repo or issue in corresponding directory.

1. PO or TO creates an _userstory issue_ on github with estimated _subissues_. Also the related material should be included in the issue.
2. After the issue is created, a new row is supposed to be appended to above table, that is User Story list, after the issue is reviewed by relevant partners.
3. Partners creates their own issues on github referring to the user story issue.
4. PO/TO updates the status of their userstory when subissues are newly attached.
5. If the modifications happen on some modules, then TO/PO can update the PRD.md file; if the modifications happen on tech side, then he/she could update the SDD.md file if necessary.

### Proposal 2: modules oriented with issues related to

1. PO or TO creates an PRD/SSD on local directory within module requrement file that is PRD.md in this case.
2. After the PRD is created and reviewed by relevant ppl , PO/TO splits the PRD.md into subtask and creates issues on github repo.
3. Optionally, a talbe could also be created like proposal 1 and be list on README.md, but the relationship between issue and PRD **must be made** whatever way the PO/TO takes.

## Commended plugins
## Recommended plugins

- [Markdown Image](https://marketplace.visualstudio.com/items?itemName=hancel.markdown-image)
- modify plugin setting: "markdown-image.local.path": "pic"
- [markdown all in one](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
- [Markdown Compact Table Formatter](https://marketplace.visualstudio.com/items?itemName=cipchk.vscode-markdown-compact-table-formatter)
- [Link Github Issues](https://marketplace.visualstudio.com/items?itemName=dt.ghlink)
- Search issue ```project:Magickbase/9```
- Search issue with ```project:Magickbase/9``` or ```project:Magickbase/9 label:"userstory"```