Skip to content

Commit

Permalink
Merge pull request #1878 from blocknative/release/2.24.8
Browse files Browse the repository at this point in the history
(docs) Release: 2.24.8
  • Loading branch information
taylorjdawson authored Aug 15, 2023
2 parents 401eba4 + aded7e9 commit 6954284
Show file tree
Hide file tree
Showing 31 changed files with 2,344 additions and 462 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ For full documentation, check out the README.md for each package or the [docs pa
- [Coinbase](packages/coinbase/README.md)
- [Trust](packages/trust/README.md)
- [WalletConnect](packages/walletconnect/README.md)
- [Gnosis](packages/gnosis/README.md)
- [Safe](packages/gnosis/README.md)
- [Magic](packages/magic/README.md)
- [Fortmatic](packages/fortmatic/README.md)
- [Portis](packages/portis/README.md)
Expand Down
14 changes: 8 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,17 @@
},
"type": "module",
"dependencies": {
"@web3-onboard/arcana-auth": "^2.0.0-alpha.1",
"@safe-global/safe-apps-provider": "^0.18.0",
"@safe-global/safe-apps-sdk": "^8.1.0",
"@web3-onboard/arcana-auth": "^2.0.0",
"@web3-onboard/blocto": "^2.0.0",
"@web3-onboard/cede-store": "^2.1.0-alpha.1",
"@web3-onboard/coinbase": "^2.2.5-alpha.1",
"@web3-onboard/core": "^2.21.0-alpha.1",
"@web3-onboard/cede-store": "^2.1.0",
"@web3-onboard/coinbase": "^2.2.5",
"@web3-onboard/core": "^2.21.0",
"@web3-onboard/dcent": "^2.2.7",
"@web3-onboard/enkrypt": "^2.0.4",
"@web3-onboard/fortmatic": "^2.0.19",
"@web3-onboard/frame": "^2.0.2-alpha.1",
"@web3-onboard/frame": "^2.0.2",
"@web3-onboard/frontier": "^2.0.4",
"@web3-onboard/gas": "^2.1.8",
"@web3-onboard/gnosis": "^2.1.10",
Expand All @@ -78,7 +80,7 @@
"@web3-onboard/trust": "^2.0.4",
"@web3-onboard/uauth": "^2.1.1",
"@web3-onboard/venly": "^2.0.0",
"@web3-onboard/walletconnect": "^2.4.2-alpha.1",
"@web3-onboard/walletconnect": "^2.4.2",
"@web3-onboard/web3auth": "^2.2.3",
"@web3-onboard/xdefi": "^2.0.4",
"@web3-onboard/zeal": "^2.0.4",
Expand Down
15 changes: 8 additions & 7 deletions docs/src/routes/docs/[...1]overview/[...1]introduction/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,18 @@ Web3-Onboard is the quickest and easiest way to add multi-wallet and multi-chain

- **Minimal Dependencies:** All wallet dependencies are included in separate packages, so you only include the ones you want to use in your app.

- **Multiple Wallets and Accounts Connection, Multichain Support:** Allow your users to connect multiple wallets and multiple accounts within each wallet at the same time to your app. Let users switch between chains/networks with ease. ALL EVM networks supported.
- **Multi Wallet and Multi Chain Support:** Allow your users to connect multiple wallets and multiple accounts within each wallet at the same time to your app. Let users switch between chains/networks with ease. ALL EVM networks supported.

- **Account Center:** An interface to manage wallet connections and networks, with a minimal version for mobile.

- **Themable:** Powerful customization options for all your needs. Style Web3 Onboard to fit into your existing designs, or pick from our pre-made themes.

- **Unified Provider Interface:** All wallet modules expose a provider that is patched to be compliant with the EIP-1193, EIP-1102, EIP-3085 and EIP-3326 specifications. Whether your user is using Ledger or Metamask the provider will operate identically.

- **Dynamic Imports:** Supporting multiple wallets in your app requires a lot of dependencies. Onboard dynamically imports a wallet
and its dependencies only when the user selects it, so that minimal bandwidth is used.
- **Dynamic Imports:** Supporting multiple wallets in your app requires a lot of dependencies. Onboard dynamically imports a wallet and its dependencies only when the user selects it, so that minimal bandwidth is used.

- **Framework Agnostic:** Avoid framework lock in -- Web3-Onboard works with any framework and includes helper packages for vue & react.

- **Account Center:** An interface to manage wallet connections and networks, with a minimal version for mobile

- **Notify:** Real-time transaction notifications for all transaction states for the connected wallet address(es). In-notification speedups & cancels for hardware wallet connections.

### Supported Networks
Expand Down Expand Up @@ -145,7 +146,7 @@ if (wallets[0]) {

## Wallet Modules

Add other wallet modules such as Wallet Connect or Ledger to increase the support and functionality of your web3-onboard implementation. All modules are listed below and can be accessed through the subpages of web3-onboard docs on the left.
Add other wallet modules such as Wallet Connect or Ledger to increase the support and functionality of your web3-onboard implementation. All modules can be accessed through the subpages of web3-onboard docs on the left.

We recommend you add the [Core Repo](../../modules/core.md#install) and consider adding the [Injected Wallets](../../wallets/injected.md#install) module to get connected with wallets like Metamask, Trust, Coinbase Wallet & more right away.

Expand All @@ -160,7 +161,7 @@ We recommend you add the [Core Repo](../../modules/core.md#install) and consider
- [Coinbase](../../wallets/coinbase.md#install)
- [Fortmatic](../../wallets/fortmatic.md#install)
- [Frame](../../wallets/frame.md#install)
- [Gnosis](../../wallets/gnosis.md#install)
- [Safe](../../wallets/gnosis.md#install)
- [Magic](../../wallets/magic.md#login-options)
- [MEW](../../wallets/mewwallet.md#install)
- [Portis](../../wallets/portis.md#install)
Expand Down
2 changes: 2 additions & 0 deletions docs/src/routes/docs/[...4]wallets/[...11]injected/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,8 @@ const injected = injectedModule({
- OneKey - _Desktop & Mobile_
- Fordefi - _Desktop_
- Ronin Wallet - _Desktop & Mobile_
- Coin98 Wallet - _Desktop & Mobile_
- SubWallet - _Desktop & Mobile_

## Build Environments

Expand Down
30 changes: 15 additions & 15 deletions docs/src/routes/docs/[...4]wallets/[...9]gnosis/+page.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: Gnosis
title: Safe
---

# {$frontmatter.title}

Wallet module for connecting Gnosis Safe to web3-onboard
Wallet module for connecting Safe to web3-onboard

## Install

<Tabs values={['yarn', 'npm']}>
<TabPanel value="yarn">

```sh copy
yarn add @web3-onboard/gnosis
yarn add @web3-onboard/gnosis @safe-global/safe-apps-provider @safe-global/safe-apps-sdk
```

</TabPanel>
<TabPanel value="npm">

```sh copy
npm install @web3-onboard/gnosis
npm install @web3-onboard/gnosis @safe-global/safe-apps-provider @safe-global/safe-apps-sdk
```

</TabPanel>
Expand All @@ -37,14 +37,14 @@ type GnosisOptions = {
```typescript
import Onboard from '@web3-onboard/core'
import gnosisModule from '@web3-onboard/gnosis'
import safeModule from '@web3-onboard/gnosis'

const gnosis = gnosisModule()
const safe = safeModule()

const onboard = Onboard({
// ... other Onboard options
wallets: [
gnosis
safe
//... other wallets
]
})
Expand All @@ -53,13 +53,13 @@ const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```

## Customizing Gnosis Transaction Gas
## Customizing Safe Transaction Gas

If you are looking to set the `gasLimit` of a transaction within Gnosis, the gas properties within the transaction WILL BE IGNORED.
Instead you will need to use the `safeTxGas` prop AND the web3-onboard Gnosis instance that is exposed through the provider to send along the transaction.
The Gnosis sdk instance exposed by the web3-onboard must be used to set the `safeTxGas` prop and send the transaction.
Check [Gnosis docs](https://github.com/safe-global/safe-contracts/blob/a6504a9afdeac186a8cdb29ad68b189523c80eda/docs/safe_tx_gas.md) for full detail as it can be a bit confusing.
An example of accessing the Gnosis SDK instance and sending a transaction can be found below.
If you are looking to set the `gasLimit` of a transaction within Safe, the gas properties within the transaction WILL BE IGNORED.
Instead you will need to use the `safeTxGas` prop AND the web3-onboard Safe instance that is exposed through the provider to send along the transaction.
The Safe sdk instance exposed by the web3-onboard must be used to set the `safeTxGas` prop and send the transaction.
Check [Safe docs](https://github.com/safe-global/safe-contracts/blob/a6504a9afdeac186a8cdb29ad68b189523c80eda/docs/safe_tx_gas.md) for full detail as it can be a bit confusing.
An example of accessing the Safe SDK instance and sending a transaction can be found below.

```typescript
const tx = {
Expand All @@ -71,11 +71,11 @@ const params = {
safeTxGas: 5000000
}

// wallet is the provider exposed by web3-onboard after the Gnosis wallet is connected
// wallet is the provider exposed by web3-onboard after the Safe wallet is connected
let trans = await wallet.instance.txs.send({ txs: [tx], params })
```

Note: With the `safeTxGas` you will see additional value on the `gasLimit` displayed in the Safe. Check [Gnosis docs](https://github.com/safe-global/safe-contracts/blob/a6504a9afdeac186a8cdb29ad68b189523c80eda/docs/safe_tx_gas.md) for full details on that computation.
Note: With the `safeTxGas` you will see additional value on the `gasLimit` displayed in the Safe. Check [Safe docs](https://github.com/safe-global/safe-contracts/blob/a6504a9afdeac186a8cdb29ad68b189523c80eda/docs/safe_tx_gas.md) for full details on that computation.

## Build Environments

Expand Down
12 changes: 6 additions & 6 deletions docs/src/routes/examples/[...1]connect-wallet/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ import { Web3OnboardProvider, init } from '@web3-onboard/react'
import injectedModule from '@web3-onboard/injected-wallets'
import infinityWalletModule from '@web3-onboard/infinity-wallet'
import fortmaticModule from '@web3-onboard/fortmatic'
import gnosisModule from '@web3-onboard/gnosis'
import safeModule from '@web3-onboard/gnosis'
import keepkeyModule from '@web3-onboard/keepkey'
import keystoneModule from '@web3-onboard/keystone'
import ledgerModule from '@web3-onboard/ledger'
Expand Down Expand Up @@ -83,7 +83,7 @@ const infinityWallet = infinityWalletModule()
const ledger = ledgerModule()
const keystone = keystoneModule()
const keepkey = keepkeyModule()
const gnosis = gnosisModule()
const safe = safeModule()
const sequence = sequenceModule()
const taho = tahoModule() // Previously named Tally Ho wallet
const trust = trustModule()
Expand Down Expand Up @@ -113,7 +113,7 @@ const wallets = [
dcent,
trezor,
walletConnect,
gnosis,
safe,
magic,
fortmatic,
keystone,
Expand Down Expand Up @@ -298,7 +298,7 @@ import Onboard from '@web3-onboard/core'
import injectedModule from '@web3-onboard/injected-wallets'
import infinityWalletModule from '@web3-onboard/infinity-wallet'
import fortmaticModule from '@web3-onboard/fortmatic'
import gnosisModule from '@web3-onboard/gnosis'
import safeModule from '@web3-onboard/gnosis'
import keepkeyModule from '@web3-onboard/keepkey'
import keystoneModule from '@web3-onboard/keystone'
import ledgerModule from '@web3-onboard/ledger'
Expand Down Expand Up @@ -334,7 +334,7 @@ const infinityWallet = infinityWalletModule()
const ledger = ledgerModule()
const keystone = keystoneModule()
const keepkey = keepkeyModule()
const gnosis = gnosisModule()
const safe = safeModule()
const sequence = sequenceModule()
const taho = tahoModule() // Previously named Tally Ho wallet
const trust = trustModule()
Expand Down Expand Up @@ -369,7 +369,7 @@ const wallets = [
walletConnect,
enkrypt,
mewWallet,
gnosis,
safe,
magic,
fortmatic,
keystone,
Expand Down
Loading

0 comments on commit 6954284

Please sign in to comment.