Skip to content

Commit

Permalink
Merge pull request #1728 from blocknative/release/2.23.0
Browse files Browse the repository at this point in the history
Release 2.23.0 (docs)
  • Loading branch information
Adamj1232 authored May 19, 2023
2 parents 9e18b16 + 08d058a commit 84359c3
Show file tree
Hide file tree
Showing 80 changed files with 1,043 additions and 647 deletions.
61 changes: 32 additions & 29 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"format": "prettier --plugin-search-dir . --write .",
"prepare": "svelte-kit sync",
"test": "playwright test",
"w3o-latest-prod": "yarn add '@web3-onboard/coinbase' '@web3-onboard/core' '@web3-onboard/dcent' '@web3-onboard/enkrypt' '@web3-onboard/fortmatic' '@web3-onboard/gas' '@web3-onboard/gnosis' '@web3-onboard/infinity-wallet' '@web3-onboard/injected-wallets' '@web3-onboard/keepkey' '@web3-onboard/keystone' '@web3-onboard/ledger' '@web3-onboard/magic' '@web3-onboard/mew-wallet' '@web3-onboard/portis' '@web3-onboard/sequence' '@web3-onboard/taho' '@web3-onboard/torus' '@web3-onboard/transaction-preview' '@web3-onboard/trezor' '@web3-onboard/trust' '@web3-onboard/uauth' '@web3-onboard/walletconnect' '@web3-onboard/web3auth' '@web3-onboard/xdefi' '@web3-onboard/frame'",
"w3o-latest-alpha": "yarn add '@web3-onboard/coinbase@next' '@web3-onboard/core@next' '@web3-onboard/dcent@next' '@web3-onboard/enkrypt@next' '@web3-onboard/fortmatic@next' '@web3-onboard/gas@next' '@web3-onboard/gnosis@next' '@web3-onboard/infinity-wallet@next' '@web3-onboard/injected-wallets@next' '@web3-onboard/keepkey@next' '@web3-onboard/keystone@next' '@web3-onboard/ledger@next' '@web3-onboard/magic@next' '@web3-onboard/mew-wallet@next' '@web3-onboard/portis@next' '@web3-onboard/sequence@next' '@web3-onboard/taho@next' '@web3-onboard/torus@next' '@web3-onboard/transaction-preview@next' '@web3-onboard/trezor@next' '@web3-onboard/trust@next' '@web3-onboard/uauth@next' '@web3-onboard/walletconnect@next' '@web3-onboard/web3auth@next' '@web3-onboard/xdefi@next' '@web3-onboard/frame'"
"w3o-latest-prod": "yarn add '@web3-onboard/core' '@web3-onboard/coinbase' '@web3-onboard/transaction-preview' '@web3-onboard/dcent' '@web3-onboard/frontier' '@web3-onboard/fortmatic' '@web3-onboard/frame' '@web3-onboard/gas' '@web3-onboard/gnosis' '@web3-onboard/keepkey' '@web3-onboard/keystone' '@web3-onboard/ledger' '@web3-onboard/infinity-wallet' '@web3-onboard/injected-wallets' '@web3-onboard/magic' '@web3-onboard/phantom' '@web3-onboard/portis' '@web3-onboard/sequence' '@web3-onboard/trezor' '@web3-onboard/trust' '@web3-onboard/torus' '@web3-onboard/taho' '@web3-onboard/web3auth' '@web3-onboard/walletconnect' '@web3-onboard/enkrypt' '@web3-onboard/mew-wallet' '@web3-onboard/xdefi' '@web3-onboard/uauth' '@web3-onboard/zeal' '@web3-onboard/cede-store'",
"w3o-latest-alpha": "yarn add '@web3-onboard/core@next' '@web3-onboard/coinbase@next' '@web3-onboard/transaction-preview@next' '@web3-onboard/dcent@next' '@web3-onboard/frontier@next' '@web3-onboard/fortmatic@next' '@web3-onboard/frame@next' '@web3-onboard/gas@next' '@web3-onboard/gnosis@next' '@web3-onboard/keepkey@next' '@web3-onboard/keystone@next' '@web3-onboard/ledger@next' '@web3-onboard/infinity-wallet@next' '@web3-onboard/injected-wallets@next' '@web3-onboard/magic@next' '@web3-onboard/phantom@next' '@web3-onboard/portis@next' '@web3-onboard/sequence@next' '@web3-onboard/trezor@next' '@web3-onboard/trust@next' '@web3-onboard/torus@next' '@web3-onboard/taho@next' '@web3-onboard/web3auth@next' '@web3-onboard/walletconnect@next' '@web3-onboard/enkrypt@next' '@web3-onboard/mew-wallet@next' '@web3-onboard/xdefi@next' '@web3-onboard/uauth@next' '@web3-onboard/zeal@next' '@web3-onboard/cede-store@next'"
},
"devDependencies": {
"@algolia/client-search": "^4.17.0",
Expand Down Expand Up @@ -47,33 +47,36 @@
},
"type": "module",
"dependencies": {
"@web3-onboard/cede-store": "^2.0.1",
"@web3-onboard/coinbase": "^2.2.3",
"@web3-onboard/core": "^2.18.0",
"@web3-onboard/dcent": "^2.2.6",
"@web3-onboard/enkrypt": "^2.0.3",
"@web3-onboard/fortmatic": "^2.0.18",
"@web3-onboard/frame": "^2.0.0",
"@web3-onboard/gas": "^2.1.7",
"@web3-onboard/gnosis": "^2.1.9",
"@web3-onboard/infinity-wallet": "^2.0.3",
"@web3-onboard/injected-wallets": "^2.8.6",
"@web3-onboard/keepkey": "^2.3.6",
"@web3-onboard/keystone": "^2.3.6",
"@web3-onboard/ledger": "^2.4.5",
"@web3-onboard/magic": "^2.1.6",
"@web3-onboard/mew-wallet": "^2.0.3",
"@web3-onboard/portis": "^2.1.6",
"@web3-onboard/sequence": "^2.0.7",
"@web3-onboard/taho": "^2.0.3",
"@web3-onboard/torus": "^2.2.4",
"@web3-onboard/transaction-preview": "^2.0.7",
"@web3-onboard/trezor": "^2.4.1",
"@web3-onboard/trust": "^2.0.3",
"@web3-onboard/uauth": "^2.0.4",
"@web3-onboard/walletconnect": "^2.3.7",
"@web3-onboard/web3auth": "^2.2.1",
"@web3-onboard/xdefi": "^2.0.3",
"@web3-onboard/cede-store": "^2.0.2-alpha.2",
"@web3-onboard/coinbase": "^2.2.4-alpha.1",
"@web3-onboard/core": "^2.19.1-alpha.1",
"@web3-onboard/dcent": "^2.2.7-alpha.2",
"@web3-onboard/enkrypt": "^2.0.4-alpha.1",
"@web3-onboard/fortmatic": "^2.0.19-alpha.1",
"@web3-onboard/frame": "^2.0.1-alpha.1",
"@web3-onboard/frontier": "^2.0.4-alpha.1",
"@web3-onboard/gas": "^2.1.8-alpha.1",
"@web3-onboard/gnosis": "^2.1.10-alpha.1",
"@web3-onboard/infinity-wallet": "^2.0.4-alpha.1",
"@web3-onboard/injected-wallets": "^2.9.0-alpha.2",
"@web3-onboard/keepkey": "^2.3.7-alpha.2",
"@web3-onboard/keystone": "^2.3.7-alpha.2",
"@web3-onboard/ledger": "^2.4.6-alpha.1",
"@web3-onboard/magic": "^2.1.7-alpha.1",
"@web3-onboard/mew-wallet": "^2.0.4-alpha.1",
"@web3-onboard/phantom": "^2.0.2-alpha.1",
"@web3-onboard/portis": "^2.1.7-alpha.1",
"@web3-onboard/sequence": "^2.0.8-alpha.1",
"@web3-onboard/taho": "^2.0.4-alpha.1",
"@web3-onboard/torus": "^2.2.5-alpha.1",
"@web3-onboard/transaction-preview": "^2.0.8-alpha.1",
"@web3-onboard/trezor": "^2.4.2-alpha.3",
"@web3-onboard/trust": "^2.0.4-alpha.1",
"@web3-onboard/uauth": "^2.0.5-alpha.1",
"@web3-onboard/walletconnect": "^2.3.8-alpha.2",
"@web3-onboard/web3auth": "^2.2.3-alpha.1",
"@web3-onboard/xdefi": "^2.0.4-alpha.1",
"@web3-onboard/zeal": "^2.0.4-alpha.1",
"animejs": "^3.2.1",
"bnc-sdk": "^4.6.6",
"ethers": "^5.7.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ web3-onboard supports all EVM networks. Supporting a new network is simply a mat
- Moonriver
- All other EVM network

### [Optional] Use an API key to fetch real time transaction data, balances & gas
### Optional - Use an API key to fetch real time transaction data, balances & gas

Using a Blocknative API key with web3-onboard on the free plan will allow you to gain the benefits of Blocknative balance & transaction services. Blocknative has a free forever plan you can always use.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If an issue does not already exist, follow the template instructions to create a

Once an issue is created, a Web3 Onboard maintainer will review and respond typically within a few days to share next steps.

## [Pull Requests 🗂️]
## Pull Requests 🗂️

To create a new feature or change in Web3 Onboard, fork the repo and make a pull request on the [develop branch](https://github.com/blocknative/web3-onboard/tree/develop) to have your changes merged in and released as part of the official packages.

Expand All @@ -39,7 +39,7 @@ Example : Adding a new injected wallet to the `injected` package -
Example 2 : Bug fix within the `core` package -
[Core package.json](https://github.com/blocknative/web3-onboard/blob/8531a73d69365f7d584320f1c4b97a5d90f1c34e/packages/core/package.json#L3) changes: `"version": "2.9.1-alpha.1",` --> `"version": "2.9.1-alpha.2",`

## [How can I add a new wallet? 💳]
## How can I add a new wallet? 💳

To add a new wallet to the official Web3 Onboard packages and repo, create a [pull request](#pull-requests-🗂️). Web3 Onboard does not require a wallet to be a part of the main code, so a separate wallet module can be created without any changes to the Web3Onboard codebase. Your PR must include a detailed README for the package, keeping in mind that this README is the the first point of contact for dapp devs looking to implement your wallet.

Expand All @@ -57,7 +57,7 @@ Otherwise, if the wallet you are adding requires dependencies and initialization

If you cannot write the code yourself to add a new wallet, create a new feature request issue to be considered by the maintainers and other contributors in the community.

## [Documentation Contributions 📄]
## Documentation Contributions 📄

If you contribute to the code, you should definitely document appropriately.

Expand All @@ -71,11 +71,11 @@ PRs for adding/updating a wallet should include a README (new or updated) for th

We highly encourage the community to help us improve the web3-onboard docs! If you have any questions don't hesitate to reach out.

## [Feedback 💬]
## Feedback 💬

Did you have trouble integrating? Could the docs be improved? Have a new Feature request?
Jump in our [Discord](https://discord.com/invite/KZaBVME) and share your feedback.

## [Support 🤓]
## Support 🤓

For general questions about how to use Web3 Onboard please first check out our [docs](../../overview/introduction.md#features), then head to our [Discord](https://discord.com/invite/KZaBVME) for support from the Blocknative team.
15 changes: 14 additions & 1 deletion docs/src/routes/docs/[...3]modules/[...1]core/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,13 @@ type AccountCenter = {
position?: AccountCenterPosition // default: 'bottomRight'
expanded?: boolean // default: true
minimal?: boolean // enabled by default for mobile

/**
* false by default - This allows removal of the
* Enable Transaction Protection' button within the Account Center
* expanded when set to true
* Can be set as a global for Account Center or per interface (desktop/mobile)
*/
hideTransactionProtectionBtn?: boolean
/**
* @deprecated Use top level containerElements property
* with the accountCenter prop set to the desired container El. See documentation below
Expand All @@ -379,6 +385,13 @@ type AccountCenter = {
type AccountCenterOptions = {
desktop: Omit<AccountCenter, 'expanded'>
mobile: Omit<AccountCenter, 'expanded'>
/**
* false by default - This allows removal of the
* Enable Transaction Protection' button within the Account Center
* expanded when set to true
* Can be set as a global for Account Center or per interface (desktop/mobile)
*/
hideTransactionProtectionBtn?: boolean
}

type AccountCenterPosition = 'topRight' | 'bottomRight' | 'bottomLeft' | 'topLeft'
Expand Down
1 change: 1 addition & 0 deletions docs/src/routes/docs/[...4]wallets/[...9]injected/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@ const injected = injectedModule({
- ApexWallet - _Desktop_
- BifrostWallet - _Desktop & Mobile_
- Safeheron - _Desktop_
- Talisman - _Desktop_

## Build Environments

Expand Down
Loading

1 comment on commit 84359c3

@vercel
Copy link

@vercel vercel bot commented on 84359c3 May 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.