-
Notifications
You must be signed in to change notification settings - Fork 523
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2247 from blocknative/release/2.26.2
Release 2.26.2 (docs)
- Loading branch information
Showing
46 changed files
with
3,408 additions
and
3,306 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
docs/src/routes/docs/[...4]wallets/[...37]bloom/+page.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| --- | ||
| title: Bloom | ||
| --- | ||
|
|
||
| # {$frontmatter.title} | ||
|
|
||
| Wallet module for connecting Bloom to web3-onboard. | ||
|
|
||
| ## Install | ||
|
|
||
| <Tabs values={['yarn', 'npm']}> | ||
| <TabPanel value="yarn"> | ||
|
|
||
| ```sh copy | ||
| yarn add @web3-onboard/bloom | ||
| ``` | ||
|
|
||
| </TabPanel> | ||
| <TabPanel value="npm"> | ||
|
|
||
| ```sh copy | ||
| npm install @web3-onboard/bloom | ||
| ``` | ||
|
|
||
| </TabPanel> | ||
| </Tabs> | ||
|
|
||
|
|
||
| ```typescript | ||
| type WalletConnectOptions = { | ||
| /** | ||
| * Project ID associated with [WalletConnect account](https://cloud.walletconnect.com) | ||
| */ | ||
| projectId: string | ||
| /** | ||
| * Defaults to `appMetadata.explore` that is supplied to the web3-onboard init | ||
| * Strongly recommended to provide atleast one URL as it is required by some wallets (i.e. MetaMask) | ||
| * To connect with walletconnect | ||
| */ | ||
| dappUrl?: string | ||
| /** | ||
| * List of Required Chain(s) ID for wallets to support in number format (integer or hex) | ||
| * Defaults to [1] - Ethereum | ||
| */ | ||
| requiredChains?: number[] | undefined | ||
| /** | ||
| * List of Optional Chain(s) ID for wallets to support in number format (integer or hex) | ||
| * Defaults to the chains provided within the web3-onboard init chain property | ||
| */ | ||
| optionalChains?: number[] | undefined | ||
| /** | ||
| * Additional required methods to be added to the default list of ['eth_sendTransaction', 'personal_sign'] | ||
| * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/advanced/providers/ethereum#required-and-optional-methods | ||
| */ | ||
| additionalRequiredMethods?: string[] | undefined | ||
| /** | ||
| * Additional methods to be added to the default list of ['eth_sendTransaction', 'eth_signTransaction', 'personal_sign', 'eth_sign', 'eth_signTypedData', 'eth_signTypedData_v4'] | ||
| * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/web/walletConnectModal/options | ||
| */ | ||
| additionalOptionalMethods?: string[] | undefined | ||
| ) | ||
| ``` | ||
| ## Usage | ||
| ```typescript | ||
| import Onboard from '@web3-onboard/core' | ||
| import bloomModule from '@web3-onboard/bloom' | ||
|
|
||
| const wcInitOptions = { | ||
| /** | ||
| * Project ID associated with [WalletConnect account](https://cloud.walletconnect.com) | ||
| */ | ||
| projectId: 'abc123...', | ||
| /** | ||
| * Chains required to be supported by all wallets connecting to your DApp | ||
| */ | ||
| requiredChains: [1], | ||
| /** | ||
| * Chains required to be supported by all wallets connecting to your DApp | ||
| */ | ||
| optionalChains: [42161, 8453, 10, 137, 56], | ||
| /** | ||
| * Defaults to `appMetadata.explore` that is supplied to the web3-onboard init | ||
| * Strongly recommended to provide atleast one URL as it is required by some wallets (i.e. MetaMask) | ||
| * To connect with WalletConnect | ||
| */ | ||
| dappUrl: 'http://YourAwesomeDapp.com' | ||
| } | ||
|
|
||
| // initialize the module with options | ||
| const bloom = bloomModule(wcInitOptions) | ||
|
|
||
| // can also initialize with no options... | ||
|
|
||
| const onboard = Onboard({ | ||
| // ... other Onboard options | ||
| wallets: [ | ||
| bloom | ||
| //... other wallets | ||
| ] | ||
| }) | ||
|
|
||
| const connectedWallets = await onboard.connectWallet() | ||
|
|
||
| // Assuming only wallet connect is connected, index 0 | ||
| // `instance` will give insight into the WalletConnect info | ||
| // such as namespaces, methods, chains, etc per wallet connected | ||
| const { instance } = connectedWallets[0] | ||
|
|
||
| console.log(connectedWallets) | ||
| ``` | ||
| ## Build Environments | ||
| For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: OKX Wallet | ||
| --- | ||
|
|
||
| # {$frontmatter.title} | ||
|
|
||
| Wallet module for connecting OKX wallet through Web3 Onboard | ||
|
|
||
| ### Install | ||
|
|
||
| <Tabs values={['yarn', 'npm']}> | ||
| <TabPanel value="yarn"> | ||
|
|
||
| ```sh copy | ||
| yarn add @web3-onboard/okx | ||
| ``` | ||
|
|
||
| </TabPanel> | ||
| <TabPanel value="npm"> | ||
|
|
||
| ```sh copy | ||
| npm install @web3-onboard/okx | ||
| ``` | ||
|
|
||
| </TabPanel> | ||
| </Tabs> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```typescript | ||
| import Onboard from '@web3-onboard/core' | ||
| import okxWallet from '@web3-onboard/okx' | ||
|
|
||
| const okx = okxWallet() | ||
|
|
||
| const onboard = Onboard({ | ||
| // ... other Onboard options | ||
| wallets: [ | ||
| okx | ||
| //... other wallets | ||
| ] | ||
| }) | ||
|
|
||
| const connectedWallets = await onboard.connectWallet() | ||
| console.log(connectedWallets) | ||
| ``` | ||
|
|
||
| ## Build Environments | ||
|
|
||
| For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) |
Oops, something went wrong.