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

Update docs for gnosis/safe package for building within vue env #2257

Merged
merged 2 commits into from
Jul 15, 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
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 @@ -441,6 +441,7 @@ const sendTransaction = async () => {
console.log(result)
}
```

---

#### disableFontDownload
Expand Down Expand Up @@ -1902,7 +1903,9 @@ export default {
'@web3-onboard/gas',
'@web3-onboard/sequence',
'js-sha3',
'@ethersproject/bignumber'
'@ethersproject/bignumber',
'@safe-global/safe-apps-sdk',
'@safe-global/safe-apps-provider'
],
esbuildOptions: {
// Node.js global to browser globalThis
Expand Down
3 changes: 3 additions & 0 deletions docs/src/routes/docs/[...3]modules/[...7]vue/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,9 @@ export default {
commonjsOptions: {
transformMixedEsModules: true
}
},
optimizeDeps: {
include: ['@safe-global/safe-apps-sdk', '@safe-global/safe-apps-provider']
}
}
```
Expand Down
18 changes: 18 additions & 0 deletions docs/src/routes/docs/[...4]wallets/[...12]gnosis/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,21 @@ Note: With the `safeTxGas` you will see additional value on the `gasLimit` displ
## Build Environments

For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments)

## Vue Build Configuration

If using Vue be sure to include the necessary peerDeps in the `vite.config.ts` specifically within the `optimizeDeps.include` list and install the necessary peer deps `npm i @safe-global/safe-apps-provider @safe-global/safe-apps-sdk`.

```typescript
export default defineConfig({
plugins: [vue(), vueJsx(), VueDevTools()],
resolve: {
alias: {
'@': fileURLToPath(new URL('./src', import.meta.url))
}
},
optimizeDeps: {
include: ['@safe-global/safe-apps-sdk', '@safe-global/safe-apps-provider']
}
})
```
4 changes: 3 additions & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1670,7 +1670,9 @@ const config: UserConfig = {
'@web3-onboard/gas',
'@web3-onboard/sequence',
'js-sha3',
'@ethersproject/bignumber'
'@ethersproject/bignumber',
'@safe-global/safe-apps-sdk',
'@safe-global/safe-apps-provider'
],
esbuildOptions: {
// Node.js global to browser globalThis
Expand Down
19 changes: 19 additions & 0 deletions packages/gnosis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,22 @@ 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 [Safe docs](https://github.com/safe-global/safe-contracts/blob/a6504a9afdeac186a8cdb29ad68b189523c80eda/docs/safe_tx_gas.md) for full details on that computation.


## Vue Build Configuration

If using Vue be sure to include the necessary peerDeps in the `vite.config.ts` specifically within the `optimizeDeps.include` list and install the necessary peer deps `npm i @safe-global/safe-apps-provider @safe-global/safe-apps-sdk`.

```typescript
export default defineConfig({
plugins: [vue(), vueJsx(), VueDevTools()],
resolve: {
alias: {
'@': fileURLToPath(new URL('./src', import.meta.url))
}
},
optimizeDeps: {
include: ['@safe-global/safe-apps-sdk', '@safe-global/safe-apps-provider']
}
})
```
2 changes: 1 addition & 1 deletion packages/gnosis/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@web3-onboard/gnosis",
"version": "2.3.1",
"version": "2.3.2-alpha.1",
"description": "Safe module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardised spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
"keywords": [
"Ethereum",
Expand Down
Loading