Skip to content

Commit

Permalink
Release 2.24.0 (docs) (#1749)
Browse files Browse the repository at this point in the history
  • Loading branch information
leightkt committed Jun 2, 2023
1 parent 84359c3 commit ec3b162
Show file tree
Hide file tree
Showing 35 changed files with 2,799 additions and 1,958 deletions.
18 changes: 18 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,12 @@ jobs:
working_directory: ~/web3-onboard-monorepo/packages/cede-store
steps:
- node-build-steps
build-venly:
docker:
- image: cimg/node:16.13.1
working_directory: ~/web3-onboard-monorepo/packages/venly
steps:
- node-build-steps

# Build staging/Alpha releases
build-staging-core:
Expand Down Expand Up @@ -625,6 +631,12 @@ jobs:
working_directory: ~/web3-onboard-monorepo/packages/cede-store
steps:
- node-staging-build-steps
build-staging-venly:
docker:
- image: cimg/node:16.13.1
working_directory: ~/web3-onboard-monorepo/packages/venly
steps:
- node-staging-build-steps

workflows:
version: 2
Expand Down Expand Up @@ -857,3 +869,9 @@ workflows:
<<: *deploy_production_filters
- build-staging-cede-store:
<<: *deploy_staging_filters
venly:
jobs:
- build-venly:
<<: *deploy_production_filters
- build-staging-venly:
<<: *deploy_staging_filters
63 changes: 33 additions & 30 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"@types/react": "^18.0.37",
"assert": "^2.0.0",
"autoprefixer": "^10.4.14",
"browserify-zlib": "^0.2.0",
"clsx": "^1.0.0",
"crypto-browserify": "^3.12.0",
"prettier": "^2.8.0",
Expand All @@ -37,6 +38,7 @@
"rollup-plugin-polyfill-node": "^0.12.0",
"shiki": "^0.12.0",
"stream-browserify": "^3.0.0",
"stream-http": "^3.2.0",
"svelte": "^3.54.0",
"svelte-check": "^3.0.1",
"svelte-preprocess": "^5.0.3",
Expand All @@ -47,36 +49,37 @@
},
"type": "module",
"dependencies": {
"@web3-onboard/cede-store": "^2.0.2-alpha.2",
"@web3-onboard/coinbase": "^2.2.4-alpha.1",
"@web3-onboard/core": "^2.19.1-alpha.1",
"@web3-onboard/dcent": "^2.2.7-alpha.2",
"@web3-onboard/enkrypt": "^2.0.4-alpha.1",
"@web3-onboard/fortmatic": "^2.0.19-alpha.1",
"@web3-onboard/frame": "^2.0.1-alpha.1",
"@web3-onboard/frontier": "^2.0.4-alpha.1",
"@web3-onboard/gas": "^2.1.8-alpha.1",
"@web3-onboard/gnosis": "^2.1.10-alpha.1",
"@web3-onboard/infinity-wallet": "^2.0.4-alpha.1",
"@web3-onboard/injected-wallets": "^2.9.0-alpha.2",
"@web3-onboard/keepkey": "^2.3.7-alpha.2",
"@web3-onboard/keystone": "^2.3.7-alpha.2",
"@web3-onboard/ledger": "^2.4.6-alpha.1",
"@web3-onboard/magic": "^2.1.7-alpha.1",
"@web3-onboard/mew-wallet": "^2.0.4-alpha.1",
"@web3-onboard/phantom": "^2.0.2-alpha.1",
"@web3-onboard/portis": "^2.1.7-alpha.1",
"@web3-onboard/sequence": "^2.0.8-alpha.1",
"@web3-onboard/taho": "^2.0.4-alpha.1",
"@web3-onboard/torus": "^2.2.5-alpha.1",
"@web3-onboard/transaction-preview": "^2.0.8-alpha.1",
"@web3-onboard/trezor": "^2.4.2-alpha.3",
"@web3-onboard/trust": "^2.0.4-alpha.1",
"@web3-onboard/uauth": "^2.0.5-alpha.1",
"@web3-onboard/walletconnect": "^2.3.8-alpha.2",
"@web3-onboard/web3auth": "^2.2.3-alpha.1",
"@web3-onboard/xdefi": "^2.0.4-alpha.1",
"@web3-onboard/zeal": "^2.0.4-alpha.1",
"@web3-onboard/cede-store": "^2.0.2",
"@web3-onboard/coinbase": "^2.2.4",
"@web3-onboard/core": "^2.20.0-alpha.1",
"@web3-onboard/dcent": "^2.2.7",
"@web3-onboard/enkrypt": "^2.0.4",
"@web3-onboard/fortmatic": "^2.0.19",
"@web3-onboard/frame": "^2.0.1",
"@web3-onboard/frontier": "^2.0.4",
"@web3-onboard/gas": "^2.1.8",
"@web3-onboard/gnosis": "^2.1.10",
"@web3-onboard/infinity-wallet": "^2.0.4",
"@web3-onboard/injected-wallets": "^2.9.0",
"@web3-onboard/keepkey": "^2.3.7",
"@web3-onboard/keystone": "^2.3.7",
"@web3-onboard/ledger": "^2.4.6",
"@web3-onboard/magic": "^2.1.7",
"@web3-onboard/mew-wallet": "^2.0.4",
"@web3-onboard/phantom": "^2.0.2",
"@web3-onboard/portis": "^2.1.7",
"@web3-onboard/sequence": "^2.0.8",
"@web3-onboard/taho": "^2.0.4",
"@web3-onboard/torus": "^2.2.5",
"@web3-onboard/transaction-preview": "^2.0.8",
"@web3-onboard/trezor": "^2.4.2",
"@web3-onboard/trust": "^2.0.4",
"@web3-onboard/uauth": "^2.0.5",
"@web3-onboard/venly": "^2.0.0-alpha.1",
"@web3-onboard/walletconnect": "^2.3.8",
"@web3-onboard/web3auth": "^2.2.3",
"@web3-onboard/xdefi": "^2.0.4",
"@web3-onboard/zeal": "^2.0.4",
"animejs": "^3.2.1",
"bnc-sdk": "^4.6.6",
"ethers": "^5.7.0",
Expand Down
9 changes: 8 additions & 1 deletion docs/src/lib/services/onboard.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ const intiOnboard = async (theme) => {
const { default: xdefiModule } = await import('@web3-onboard/xdefi')
const { default: cedeModule } = await import('@web3-onboard/cede-store')
const { default: frameModule } = await import('@web3-onboard/frame')
const { default: venlyModule } = await import('@web3-onboard/venly')
const INFURA_ID = '8b60d52405694345a99bcb82e722e0af'

const injected = injectedModule()
Expand Down Expand Up @@ -107,6 +108,11 @@ const intiOnboard = async (theme) => {

const frame = frameModule()

const venly = venlyModule({
clientId: 'blocknative',
environment: 'staging'
})

return Onboard({
wallets: [
injected,
Expand All @@ -131,7 +137,8 @@ const intiOnboard = async (theme) => {
keepkey,
portis,
frame,
infinityWallet
infinityWallet,
// venly
],
chains: [
{
Expand Down
37 changes: 29 additions & 8 deletions docs/src/routes/docs/[...3]modules/[...1]core/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,22 @@ title: Core

This is the core package that contains all of the UI and logic to be able to seamlessly connect user's wallets to your app and track the state of those wallets. Onboard no longer contains any wallet specific code, so wallets need to be passed in upon initialization.

:::admonition type="tip"
_note: Release 2.24.0 moves the default position of the account center from topRight to bottomRight. To reset your application to topRight, include the following when initializing onboard:_
```typescript
accountCenter: {
desktop: {
enabled: true,
position: 'topRight'
},
mobile: {
enabled: true,
position: 'topRight'
}
}
```
:::

## Install

Install the core module:
Expand Down Expand Up @@ -1460,7 +1476,8 @@ module.exports = {
os: 'os-browserify/browser',
process: 'process/browser',
stream: 'stream-browserify',
util: 'util'
util: 'util',
zlib: 'browserify-zlib'
}
},
experiments: {
Expand Down Expand Up @@ -1509,7 +1526,8 @@ module.exports = function override(config) {
process: require.resolve('process/browser'),
stream: require.resolve('stream-browserify'),
url: require.resolve('url'),
util: require.resolve('util')
util: require.resolve('util'),
zlib: require.resolve('browserify-zlib')
})
config.resolve.fallback = fallback
config.resolve.alias = {
Expand Down Expand Up @@ -1548,7 +1566,7 @@ module.exports = function override(config) {

Add the following dev dependencies:

`yarn add rollup-plugin-polyfill-node crypto-browserify stream-browserify assert -D`
`yarn add rollup-plugin-polyfill-node crypto-browserify stream-browserify assert browserify-zlib -D`

Then add the following to your `svelte.config.js` file:

Expand Down Expand Up @@ -1578,7 +1596,8 @@ const config = {
alias: {
crypto: 'crypto-browserify',
stream: 'stream-browserify',
assert: 'assert'
assert: 'assert',
zlib: 'browserify-zlib'
}
},
build: {
Expand Down Expand Up @@ -1613,7 +1632,7 @@ Checkout a boilerplate example [here](https://github.com/blocknative/web3-onboar

Add the following dev dependencies:

`yarn add rollup-plugin-polyfill-node crypto-browserify stream-browserify assert -D`
`yarn add rollup-plugin-polyfill-node crypto-browserify stream-browserify assert browserify-zlib -D`

Then add the following to your `svelte.config.js` file:

Expand Down Expand Up @@ -1661,7 +1680,8 @@ const config: UserConfig = {
alias: {
crypto: 'crypto-browserify',
stream: 'stream-browserify',
assert: 'assert'
assert: 'assert',
zlib: 'browserify-zlib'
}
},
build: {
Expand Down Expand Up @@ -1726,7 +1746,7 @@ Checkout a boilerplate example for Vite-React [here](https://github.com/blocknat

Add the following dev dependencies:

`npm i --save-dev rollup-plugin-polyfill-node crypto-browserify stream-browserify assert`
`npm i --save-dev rollup-plugin-polyfill-node crypto-browserify stream-browserify assert browserify-zlib`

Then add the following to your `vite.config.js` file:

Expand All @@ -1748,7 +1768,8 @@ export default {
alias: {
crypto: 'crypto-browserify',
stream: 'stream-browserify',
assert: 'assert'
assert: 'assert',
zlib: 'browserify-zlib'
}
},
build: {
Expand Down
61 changes: 61 additions & 0 deletions docs/src/routes/docs/[...4]wallets/[...23]venly/+page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Venly

Wallet module for connecting Venly Wallet SDK to web3-onboard. Check out the [Venly Docs](https://docs.venly.io/) for more information.
## Install

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

```sh copy
yarn add @web3-onboard/venly
```

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

```sh copy
npm install @web3-onboard/venly
```

</TabPanel>
</Tabs>

## Options

```typescript
type VenlyOptions = {
clientId: string
environment?: string
}
```
`clientId` - The Client ID used to connect with Venly. More information can be found [here](https://docs.venly.io/widget/deep-dive/authentication#client-id).
`environment` - The environment to which you want to connect, possible values are 'staging' and 'production'. Defaults to 'production'.
**NOTE**: Production environment handles main networks while Staging handles test networks. List of supported networks can be found [here](https://docs.venly.io/api/deep-dive-1/environments-and-networks#blockchain-networks).
## Usage
```typescript
import Onboard from '@web3-onboard/core'
import venlyModule from '@web3-onboard/venly'

// initialize the module with options
const venly = venlyModule({
clientId: 'YOUR_CLIENT_ID',
})

const onboard = Onboard({
// ... other Onboard options
wallets: [
venly
//... 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)
2 changes: 1 addition & 1 deletion docs/src/routes/docs/[...4]wallets/[...9]injected/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,11 +275,11 @@ const injected = injectedModule({
- Binance - _Desktop_
- Coinbase - _Desktop & Mobile_
- Phantom - _Desktop & Mobile_
- Trust - _Desktop & Mobile_
- SafePal - _Desktop & Mobile_
- Zerion - _Desktop & Mobile_
- OKX Wallet - _Desktop_
- Taho (Previously named Tally Ho wallet) - _Desktop_
- Trust - _Mobile_
- Opera - _Desktop & Mobile_
- Status - _Mobile_
- Alphawallet - _Mobile_
Expand Down
4 changes: 3 additions & 1 deletion docs/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ const config = {
alias: {
crypto: 'crypto-browserify',
stream: 'stream-browserify',
assert: 'assert'
assert: 'assert',
zlib: 'browserify-zlib',
http: 'stream-http'
}
},
build: {
Expand Down
Loading

1 comment on commit ec3b162

@vercel
Copy link

@vercel vercel bot commented on ec3b162 Jun 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.