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

Release 2.28.2 #2327

Merged
merged 14 commits into from
Dec 27, 2024
Merged
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ For full documentation, check out the README.md for each package or the [docs pa
- [Frame](packages/frame/README.md)
- [Frontier](packages/frontier/README.md)
- [Infinity Wallet](packages/infinity-wallet/README.md)
- [Keplr](packages/keplr/README.md)
- [Magic](packages/magic/README.md)
- [MetaMask](packages/metamask/README.md)
- [MEW-Wallet](packages/mew-wallet/README.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@
"@safe-global/safe-apps-sdk": "^8.1.0",
"@web3-onboard/bitget": "^2.1.1",
"@web3-onboard/blocto": "^2.1.1",
"@web3-onboard/capsule": "^2.3.0",
"@web3-onboard/capsule": "^2.4.0",
"@web3-onboard/cede-store": "^2.3.1",
"@web3-onboard/coinbase": "^2.3.1",
"@web3-onboard/core": "^2.23.0",
"@web3-onboard/core": "^2.23.1-alpha.1",
"@web3-onboard/dcent": "^2.2.8",
"@web3-onboard/enkrypt": "^2.1.1",
"@web3-onboard/finoaconnect": "^2.0.0",
Expand All @@ -67,7 +67,7 @@
"@web3-onboard/gas": "^2.2.1",
"@web3-onboard/gnosis": "^2.3.1",
"@web3-onboard/infinity-wallet": "^2.1.1",
"@web3-onboard/injected-wallets": "^2.11.1",
"@web3-onboard/injected-wallets": "^2.11.3",
"@web3-onboard/keepkey": "^2.3.8",
"@web3-onboard/keystone": "^2.3.8",
"@web3-onboard/ledger": "^2.7.1",
Expand All @@ -86,7 +86,7 @@
"@web3-onboard/trust": "^2.1.1",
"@web3-onboard/uauth": "^2.2.1",
"@web3-onboard/venly": "^2.1.1",
"@web3-onboard/walletconnect": "^2.6.1",
"@web3-onboard/walletconnect": "^2.6.2",
"@web3-onboard/web3auth": "^2.3.1",
"@web3-onboard/xdefi": "^2.1.1",
"@web3-onboard/zeal": "^2.1.1",
Expand Down
4 changes: 2 additions & 2 deletions docs/src/lib/services/onboard.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ const intiOnboard = async theme => {
const finoaconnect = finoaConnectModule(finoaConnectOptions)

const uauthOptions = {
clientID: 'a25c3a65-a1f2-46cc-a515-a46fe7acb78c',
redirectUri: 'http://localhost:8080/',
clientID: "a7371c4a-a61e-4fac-af48-4471c2e69e93",
redirectUri: "https://onboard.blocknative.com",
scope: 'openid wallet email:optional humanity_check:optional profile:optional social:optional',
walletConnectProjectId: 'f6bd6e2911b56f5ac3bc8b2d0e2d7ad5'
}
Expand Down
12 changes: 0 additions & 12 deletions docs/src/routes/docs/[...1]overview/[...1]introduction/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,6 @@ Web3 Onboard supports all EVM networks. Supporting a new network is simply a mat
- Degen
- All other EVM networks

### 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.

This step is not required to use Web3 Onboard. You can skip to the [**Quickstart**](/docs/overview/introduction#quickstart) step below if you want to use Web3 Onboard without API services or if you already have a Blocknative account & API key.

**Setup your Account**
Go to the Account Dashboard at [https://explorer.blocknative.com/account](https://explorer.blocknative.com/account) and setup an account with an email address. You will receive an email to confirm your account.

**Create your API Key**
On the Account Dashboard at [https://explorer.blocknative.com/account](https://explorer.blocknative.com/account), create an API key with your choice of name or use/rename the Default Key. Consider using different API keys for development, staging, and production releases.

## Quickstart

Install the core web3-onboard library, the injected wallets module, and optionally ethers.js to support browser extension and mobile wallets:
Expand Down
5 changes: 4 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 @@ -317,9 +317,12 @@ type ConnectModalOptions = {
#### i18n

An object that defines the display text for different locales. Can also be used to override the default text. To override the default text, pass in an object for the `en` locale.
Currently there is built-in support for:
- English (`en`) - Default
- Simplified Chinese (`zh`)

```typescript
type Locale = string // eg 'en', 'es'
type Locale = string // eg 'en', 'zh', 'es'
type i18nOptions = Record<Locale, i18n>
```

Expand Down
2 changes: 0 additions & 2 deletions docs/src/routes/docs/[...3]modules/[...2]gas/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,8 @@ npm install @web3-onboard/gas
import gas from '@web3-onboard/gas'

// subscribe to a single chain for estimates using the default poll rate of 5 secs
// API key is optional and if provided allows for faster poll rates
const ethMainnetGasBlockPrices = gas.stream({
chains: ['0x1'],
apiKey: '<OPTIONAL_API_KEY>',
endpoint: 'blockPrices'
})

Expand Down
2 changes: 1 addition & 1 deletion docs/src/routes/docs/[...3]modules/[...3]react/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ type Notify = {
/**
* Position of notifications that defaults to the same position as the
* Account Center (if enabled) of the top right if AC is disabled
* and notifications are enabled (enabled by default with API key)
* and notifications are enabled
*/
position?: NotificationPosition
}
Expand Down
12 changes: 4 additions & 8 deletions docs/src/routes/faq/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,18 @@ Join our [discord](https://discord.com/invite/KZaBVME) if you want to chat with

Yes it’s free to use forever.

3. Do I need an API key?

No you don’t need an API key to use Web3 Onboard. The optional addition of an API key allows access to transaction notifications and more frequent gas estimates from Blocknative. You can [get one here](https://explorer.blocknative.com/account)

4. Which frameworks does Web3 Onboard support?
3. Which frameworks does Web3 Onboard support?

Web3 Onboard is framework agnostic and is usable with your favorite framework.

5. Is Web3 Onboard customizable?
4. Is Web3 Onboard customizable?

Yes, we’ve made a [theming interface](https://onboard.blocknative.com/theming-tool) to show how you can theme Web3 Onboard for your dapp.

6. Are there any code examples?
5. Are there any code examples?

Yes, we’ve made a connect wallet example available [here](https://onboard.blocknative.com/examples/connect-wallet#main-sidebar).

7. Does Web3 Onboard support my favorite network?
6. Does Web3 Onboard support my favorite network?

Web3 Onboard is compatible with all EVM networks, which can be specified on initialization. You can add your chain to [this list in the docs](/docs/overview/introduction#supported-networks) to call out its support.
Loading
Loading