Skip to content

Commit

Permalink
chore(dapp) update SDK interface and the generated code
Browse files Browse the repository at this point in the history
Updates: #14615
  • Loading branch information
stefandunca committed May 28, 2024
1 parent 0fca77b commit e186efa
Showing 1 changed file with 4 additions and 25 deletions.
29 changes: 4 additions & 25 deletions ui/app/AppLayouts/Wallet/services/dapps/sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
# Wallet Connect Integration

## Questions

- [ ] Do we report **disabled chains**? **Update session** in case of enabled/disabled chains?
- [ ] User error workflow: retry?
- [ ] Check the `Auth` request for verifyContext <https://docs.walletconnect.com/web3wallet/verify>
- [ ] What `description` and `icons` to use for the app? See `metadata` parameter in `Web3Wallet.init` call

## WalletConnect SDK management

Install dependencies steps by executing commands in this directory:
To install/updates dependencies follow these steps by running the following commands in this directory:

- update the [`package.json`](./package.json) versions and run `npm install`
- Step 1: update the [`package.json`](./package.json) versions and run `npm install`
- alternatively
- use the command `npm install <package-name>@<version/latest> --save` for individual packages
- or to update to the latest run `ncu -u; npm install` in here
- run `npm install -g npm-check-updates` for `ncu` command
- these commands will also create or update a `package-lock.json` file and populate the `node_modules` directory
- update the [`bundle.js`](./generated/bundle.js) file by running `npm run build`
- Step 2: update the [`bundle.js`](./generated/bundle.js) file by running `npm run build`
- the result will be embedded with the app and loaded by [`WalletConnectSDK.qml`](../WalletConnectSDK.qml) component
- add the newly generated files to index `git add --update .` to include in the commit
- Step 3: add the newly generated files to index `git add --update .` to include in the commit

## Testing

Expand All @@ -36,17 +29,3 @@ npm install --save @walletconnect/web3wallet
npm run build
# npm run build:dev # for development
```

- [x] Do we report all chains and all accounts combination or let user select?
- Wallet Connect require to report all chainIDs that were requested
- Answer: We only report the available chains for the current account. We will look into adding others to he same session instead of requiring a new link
- [x] Can't respond to sign messages if the wallet-connect dialog/view is closed (app is minimized)
- Only apps that use deep links are expected to work seamlessly
- Also the main workflow will be driven by user
- [x] Allow user to **disconnect session**? Manage sessions?
- Yes, in settings
- [x] Support update session if one account is added/removed?
- Not at first
- [X] User awareness of session expiration?
- Support extend session?
- Yes

0 comments on commit e186efa

Please sign in to comment.