ckb-js / nexus Goto Github PK

#146

Create an Account Or Import Mnemonics

Motivation

As a Nexus wallet user, the first thing I want to do is to create/import an account, so that I can get access to other wallet functionalities.

Description

If I was a new ckb user, I would like to create a new account, so I need a "Create Account" button, and the wallet should prompt a list of randomly generated mnemonics.

After the user had created an account, the root address should be generated by the key derivation rule.

Or if the user had imported an account, the root address should be generated, and the used addresses should be discovered by a similar rule in bip-44.

Privacy

The mnemonics should be encrypted and stored with web3 secret storage.

Test vectors

//tbd

connect url:https://playwright.dev/
nexus wallet ico link:"https://playwright.dev/favicon.ico"

playwright ico link:https://playwright.dev/img/playwright-logo.svg

ccommit:abadb89

step

const ckb = await window.ckb.enable()
ckb.fullOwnership.signData({data:"0x1212"})

Nexus supports switching networks, but there is no particular way to get a network in a dApp.

We discussed using the chain in get_blockchain_info as a way to get the network, but we need to check if this is a reliable way to do it, or if there is a more reliable way

Resolve #154

Show password should on import wallet page

All "Select User name" typing should replace to "Create Username"

In Confirm Seed Page, replace the text to "Please select words in correct order to form your seed"

Change the validate password time

Password field should validate on blur

Confirm password field should validate on change

empty whitelist list should have min height and placeholder

Address on sign transaction is not correspond to DApp's

username should less than 12 characters

To reduce the risk of null pointer exceptions in runtime

avoid any.someProperty

nexus version : f9f18a7
url: http://192.168.31.66:3000/

url: http://info.cern.ch/

Is your feature request related to a problem? Please describe.

The injected CKB Provider will communicate with the Nexus, so a message bridge (wrapper) is required for Nexus. This bridge should

• webpage <-> content script
• content script <-> background script
• background script <-> extension UI, e.g. chrome.window created window, popup.

For the CKB Provider, it may act as an RPC client, so we also need to make the bridge simply adaptable to server-client mode

// perhaps the CKB provider will be like this
await window.ckb.nexus.getUnusedLocks()
await window.ckb.nexus.getCells()

// or act as RPC client
await window.ckb.nexus.request({
  method: 'wallet_getUnusedLocks',
  params: []
})
await window.ckb.nexus.request({
  method: 'wallet_getCells',
  params: []
})

Additional context

webext-bridge looks good, but webext-bridge seems not supported for injected script, maybe we can enhance it

chomex offers server-client functionality, we can also have a look to check if we can implement it based on

Validators for wallet_* methods

- addMethod('wallet_enable', (params, context) => {
+ addMethod('wallet_enable', pipe(
+   validateWalletEnable,
+   (params, context) => {
+ ))

Review the features of https://github.com/zhangyouxin/demo-nexus

• Address book
• Transferring CKB
• Receiving CKB

https://github.com/gpBlockchain/nexus-e2e/blob/main/packages/e2e/README.md

• option 1 - git submodule, import nexus-e2e as a git submodule
• option 2 - workspace, import it as a sub package

• for end-user
  • how to initialize the Nexus
    • create a wallet
    • import a wallet
• for developer
  • intro full ownership
  • how to communicate with Nexus via the global injected window.ckb
  • how to send a transferring transaction via Nexus
    • off-chain lock
    • live cells
    • sepc256k1.transfer method to createTransactionSkeleton via Lumos
    • signTransaction
    • link to nexus-demo to preview how to work with Nexus

For better development and testing, we need to split the Nexusinto several services, such as WalletService, OwnershipService, ConfigServices, etc. which will be described in TypeScript interface.

Services need to call each other, so we need a good practice to organize these services, maybe a dependency injection is required

https://github.com/zhb666/Nervos-DAO

• tested locally, according to the documentation
• code
• testnet

Agenda

• review and update the progress in #77
• demonstrating E2E for wallet pages
• demonstrating Nervos Dapp demo dApp

Discussion

Actions

• [code] unit test for wallet_* RPC scaffolding
• [code] unit test for wallet_enable RPC
• [code] implement whitelist & network pages
• [code] mock a signData & signTransaction RPC for e2e
• [e2e] signData
• [e2e] signTransaction
• [code] implement signData notification service
• [code] implement signData notification page
• [code] implement signTransaction notification service
• [code] implement signTransaction notification page
• [code] review rule-based ownership service ##76

Other Notes

The wallet has been installed but no relevant data is returned ，suspected to be caused by watchtower

Reproduce

1. open this link
2. run await ckb.request({ method: 'wallet_enable' })

• nexus version:ba59235
  The parameter change can be classified as internal or external, but the test results are consistent.

To demonstrate how Nexus works with a dApp, we had plans to create a Nervos DAO dApp demo, however, we found this demo may still be a bit complicated for newcomers, as it requires some knowledge about Nervos DAO, so we're planning to make another demo for CKB wallet.

This demo should have the following features

• UTxO style wallet - an address is only used once
• Show the total capacity owned by the current wallet
• Transfer CKB
• Receive CKB

Agenda

• review and update the progress in #65
• present the basic UI implementation

Discussion

Actions

• [code] refine UI implementation
• [code] implement Create a new wallet and Import a wallet
• [code] implement KeystoreService.initKeystore for New wallet
• [code] implement wallet_enable to work with New wallet and initKeystore
• [code] review and merge #75
• [code] review and merge #73
• [code] provide test-data-id in UI for e2e testing
• [e2e] a list of user stories of ownership
• [code] Nervos DAO dApp with unlock feature
• [code] Nervos DAO dApp nickname / connect to wallet / network switch

Continuing

• [code] implement rule-based ownership service

Other Notes

Since not all cells can be fully controlled by a single party, a case in point is the name service, which generally has an expiration date and the owner only has control over it for a given duration, we need a document that describes how Nexus works with this scenario

Is your feature request related to a problem? Please describe.

Nexus will be a browser extension, we need to setup a development environment for Nexus

Describe the solution you'd like

• webpack
• HMR supported for popup, content script, background script
• a dead simple example with
  • inject a fake ckb provider API into page
  • call ckb.enable() to show the popup

Agenda

• Introduce the wireframe, thanks to Yan Niu
• Introduce the E2E page, thanks to @gpBlockchain
• Progress update from #28

Discussion

Customizable Nickname

Since the cell model is not bound to a specific address, but to make the UX better, the dApp or Nexus still needs to have an identifier to indicate the user's identity. Therefore, Nexus can provide a way for users to customize their nickname to present user information in a more friendly way

Element Locator for E2E

Actions

• [UI/UX] remove address from homepage in wireframe
• [UI/UX] customizable nickname from wireframe
• [UI/UX] determine width/height for popup and extension page
• #55
• [code] support customize nickname
• [code] review #39
• [code] review #44
• #59
• [e2e] mock unimplemented module, allowing e2e to better start

Other Notes

• Wireframe: https://www.figma.com/file/x49RWTMPXmN5UgbaCAkraN/wallet?node-id=0%3A1&t=5XbjViLPQIjVAM2F-1
• Nexus E2E: https://gpblockchain.github.io/nexus-e2e/

wireframe: https://www.figma.com/file/x49RWTMPXmN5UgbaCAkraN/wallet

Agenda

• review actions in #80 and #90

Discussion

Actions

• [code] make dependencies more clear
• [code] refactor interfaces to make docs can be generated automatically #101
• [code] make RPC error more friendly
• [code] make network edtiable
• #116
• #117

Continue

• [code] implement whitelist & network pages - wait for merge
• [e2e] signTransaction
• [code] implement signTransaction notification service - wait for merge
• [code] implement signTransaction notification page - wait for merge
• [code] continue and finish #89, exposed as RPC methods - wait for merge
• [code] make the #83 works with testnet
• [code] make the Nervos DAO dApp works with testnet - wait for review
  • show deposited/withdrawed cells
  • deposit/withdraw/unlock
  • works with Nexus, wallet_enable, getOffChainLocks, getLiveCells, signTransaction
• [UI/UX] make network edtiable
• [code] ckb-js/lumos#487
• [UI/UX] design system for Nexus

Other Notes

• nexus version:ba59235

example

What does 22 mean

Agenda

• review and update the progress in #28 #45

Discussion

• design system is not

Actions

• [UI/UX] design for initiating wallet base on the wireframe
• [UI/UX] design popup page base on the wireframe
• [UI/UX] design notification page for base on the wireframe
• [review] review #44
• [review] #56
• [code] implement a FullOwnershipService
• [code] NervosDAO dApp with deposit feature on GitHub Page

Other Notes

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency @types/chrome to v0.0.235
• chore(deps): update dependency lerna to v6.6.2
• chore(deps): update dependency lint-staged to v13.2.2
• fix(deps): update dependency eventemitter3 to v5.0.1
• fix(deps): update dependency zustand to v4.3.8
• chore(deps): update dependency @auto-it/released to v10.46.0
• chore(deps): update dependency @auto-it/upload-assets to v10.46.0
• chore(deps): update dependency eslint to v8.39.0
• chore(deps): update dependency semver to v7.5.0
• chore(deps): update dependency ts-jest to v29.1.0
• chore(deps): update dependency typedoc to v0.24.6
• chore(deps): update dependency typedoc-plugin-markdown to v3.15.3
• chore(deps): update dependency webpack to v5.82.0
• chore(deps): update dependency webpack-dev-server to v4.13.3
• chore(deps): update typescript-eslint monorepo to v5.59.2 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• fix(deps): update dependency joi to v17.9.2
• fix(deps): update dependency json-rpc-2.0 to v1.5.1
• fix(deps): update dependency react-router-dom to v6.11.1
• fix(deps): update dependency zod-validation-error to v1.3.0
• chore(deps): update dependency @svgr/webpack to v7
• chore(deps): update dependency fork-ts-checker-webpack-plugin to v8
• chore(deps): update dependency rimraf to v5
• chore(deps): update dependency typescript to v5
• fix(deps): update dependency immer to v10
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update babel monorepo to v7.21.5 (@babel/preset-env, @babel/preset-typescript)
• chore(deps): update dependency webpack-cli to v5.0.2
• fix(deps): update chakra-ui monorepo (@chakra-ui/icons, @chakra-ui/react)
• fix(deps): update dependency @tanstack/react-query to v4.29.5
• fix(deps): update dependency react-hook-form to v7.43.9
• chore(deps): update dependency @auto-it/core to v10.46.0
• chore(deps): update dependency @auto-it/magic-zero to v10.46.0
• chore(deps): update dependency @auto-it/npm to v10.46.0
• chore(deps): update dependency @auto-it/protected-branch to v10.46.0
• chore(deps): update react monorepo (@types/react, @types/react-dom)
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• fix(deps): update dependency nanoid to v4

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Nexus needs a continuous release system. Since Nexus has just developed an MVP, it is foreseeable that we will be collecting feedback from various parties and making modifications.

This continuous release system should be able to meet the following requirements

• sufficiently automated
• generate formatted changelogs

• #126
• #127
• #139

Agenda

• Discuss MVP target
• Discuss the Nexus prototype
• Discuss how to test InjectedCkb

Discussion

• Chakra UI as UI library

Actions

• #29
• #34
• #35
• lumos/hd replace crypto.scrypt with scrypt-js ckb-js/lumos#483
• #36
• #37

Other Notes

• MVP tasks
  • Scaffolding
    • Messaging
      • content script <-> injected script
      • content script <-> background
      • background <-> popup
      • background <-> chrome.windows.create
    • Service Interface
      • WalletService - for ckb.enable
      • KeyingService - managing encrypted mnemonic
      • ConfigService - managing Nexus configuration
      • OwnershipService - support for CkbProvider
      • OwnershipRecoverService - recovering imported exists mnemonic
    • Storage
    • RPC
    • Pages
      • popup - for managing Nexus configuration
      • confirm
        • ckb.enable
        • ownership.signData
        • ownership.signTx
  • UI/UX
    • prototype
    • design
  • Implement
    • messaging
    • storage
    • services
    • RPC
    • pages
  • E2E
    • e2e - like MetaMask's
  • Demo dApp
    • Minimal CKB wallet
      • total CKB (total + occupied)
      • transfer CKB
    • Nervos DAO dApp
      • show deposited CKB
      • deposit
      • withdraw
      • unlock
    • Vote app
      • create/sign proposal (options)
      • create/sign vote
• Chakra UI Figma Kit
• chrome.storage.local.get(null, console.log) to fetch all stored data

Is your feature request related to a problem? Please describe.

As a CKB layer 1 wallet, Nexus needs to be UTxO-friendly, while allowing the dApp to interact with it. This design may require some thought

• rules for key derivation
• how dApps interact with the derivation keys
• trade-off between decentralization, recoverability, flexibility, etc

Nexus needs a design or description for this

Additional context

#4

TODO

• pop-up pages
• notification pages

Notes

We can use the Nexus demo to check the notification page

• download

prototype: https://www.figma.com/file/6il5bkgZDrfJhCBs2c7er4/Nexus-Wallet

Agenda

• review and update the progress in #80

Discussion

Actions

• [code] continue and finish #89, exposed as RPC methods
• [code] make the #83 works with testnet
• [code] design and implement an event pubsub module to handle events, e.g. networkChanged
• [code] make the Nervos DAO dApp works with testnet
  • show deposited/withdrawed cells
  • deposit/withdraw/unlock
  • works with Nexus, wallet_enable, getOffChainLocks, getLiveCells, signTransaction
• [UI/UX] design system for Nexus
• [UI/UX] make network edtiable
• [code] review and merge #84
• [code] ckb-js/lumos#487

Other Notes

          I find the release is failed in release, but it is as expected. To avoid PR check failed, we should skip the canary release from a forked repo

Originally posted by @homura in #142 (comment)

Agenda

• review and update the progress in #58
• Nexus does not seem to be a wallet, a different description is needed
• Demonstrate the Nervos DAO dApp

Discussion

Should we change the description of Nexus?

No, although Nexus in its MVP stage is only acting as a signer, Nexus's positioning is as a wallet, and we will make Nexus a user-friendly wallet, with signer just being its current state

Actions

• [UI/UX] review design sign transaction notification page
• [code] review and merge #64
• [code] implement rule-based ownership service
• [code] implement UI in pages (no business logic)
• [code] define internal_X internal methods for extension pages
  • internal_getRequesterAppInfo
  • internal_approvedEnableWallet
  • internal_approvedSignData
  • internal_approvedSignTransaction
• implement a mock RPC for InjectedCkb
• [code] Nervos DAO dApp with list/withdraw feature and make it enable to preview online

Other Notes

Reproduce

1. open this link
2. run ckb.request({method: "wallet_enable"})
3. run await ckb.request({method:'wallet_fullOwnership_signData', params: { data:'0x68656c6c6f20e4bda0e5a5bd20e38193e38293e381abe381a1e381af20f09f918b' }})