Skip to content

Commit

Permalink
Remove more references to bn api keys
Browse files Browse the repository at this point in the history
  • Loading branch information
Adamj1232 committed Oct 21, 2024
1 parent b2d3be0 commit 00caaac
Show file tree
Hide file tree
Showing 7 changed files with 5 additions and 29 deletions.
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
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.
1 change: 0 additions & 1 deletion packages/core/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,6 @@ export 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)
*/
position?: NotificationPosition
replacement?: {
Expand Down
3 changes: 0 additions & 3 deletions packages/demo/src/App.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -476,8 +476,6 @@
// connectModal: '#sample-container-el',
// accountCenter: '#sample-container-el2'
// },
// Sign up for your free api key at www.Blocknative.com
// apiKey,
theme: 'default'
})
Expand Down Expand Up @@ -778,7 +776,6 @@
<button
class="updateBalanceBtn"
on:click={() => {
// Only necessary if a Blocknative API key is not provided and notify is disabled
onboard.state.actions.updateBalances()
}}>Update Wallet Balance</button
>
Expand Down
2 changes: 0 additions & 2 deletions packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,6 @@ const [
## `useNotifications`

This hook allows the dev to access all notifications if enabled, send custom notifications and update notify <enable/disable & update transactionHandler function>
**note** requires an API key be added to the initialization, enabled by default if API key exists
For full Notification documentation please see [Notify section within the `@web3-onboard/core` docs](../core/README.md#options)

```typescript
Expand Down Expand Up @@ -287,7 +286,6 @@ 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)
*/
position?: NotificationPosition
}
Expand Down

0 comments on commit 00caaac

Please sign in to comment.