/**
- * Transaction Preview module
+ * @deprecated Transaction Preview support has ended and Transaction Preview
+ * is no longer supported as part of Web3-Onboard.
+ * Please remove from your onboard config to avoid
+ * console errors and un-expected behavior
*/
- transactionPreview?: TransactionPreviewAPI
+ transactionPreview?: unknown
/**
* Custom or predefined theme for Web3Onboard
* BuiltInThemes: ['default', 'dark', 'light', 'system']
@@ -204,7 +206,7 @@ export type Configuration = {
gas?: typeof gas
wagmi?: WagmiModuleAPI
containerElements?: ContainerElements
- transactionPreview?: TransactionPreviewAPI
+ transactionPreview?: unknown
unstoppableResolution?: typeof unstoppableResolution
}
diff --git a/packages/core/src/validation.ts b/packages/core/src/validation.ts
index da3882516..904a06620 100644
--- a/packages/core/src/validation.ts
+++ b/packages/core/src/validation.ts
@@ -249,11 +249,10 @@ const initOptions = Joi.object({
wagmi: Joi.function(),
connect: connectModalOptions,
containerElements: containerElements,
- transactionPreview: Joi.object({
- patchProvider: Joi.function().required(),
- init: Joi.function().required(),
- previewTransaction: Joi.function()
- }),
+ // transactionPreview is deprecated but is still allowed to
+ // avoid breaking dapps a console error is shown although
+ // transactionPreview functionality has been removed
+ transactionPreview: Joi.any(),
theme: theme,
disableFontDownload: Joi.boolean(),
unstoppableResolution: Joi.function()
diff --git a/packages/core/src/views/Index.svelte b/packages/core/src/views/Index.svelte
index ae1c81818..fa53a11aa 100644
--- a/packages/core/src/views/Index.svelte
+++ b/packages/core/src/views/Index.svelte
@@ -407,16 +407,6 @@
{/if}
-{#if !$accountCenter$.enabled && !$notify$.enabled}
-
-{/if}
-
{#if displayAccountCenterNotifySameContainer}
- {/if}
{#await accountCenterComponent then AccountCenter}
{#if AccountCenter}
@@ -450,9 +437,6 @@
{/if}
{/await}
- {#if $accountCenter$.position.includes('top')}
-
- {/if}
{#if $notify$.position.includes('top') && $accountCenter$.position.includes('top') && samePositionOrMobile}
{#await notifyComponent then Notify}
{#if Notify}
@@ -478,9 +462,6 @@
? 'padding-top:0;'
: ''} "
>
- {#if $accountCenter$.position.includes('bottom')}
-
- {/if}
{#if $accountCenter$.enabled && $wallets$.length}
{#await accountCenterComponent then AccountCenter}
@@ -490,9 +471,6 @@
{/await}
{/if}
- {#if $accountCenter$.position.includes('top')}
-
- {/if}
{/if}
{#if displayNotifySeparate}
@@ -506,9 +484,6 @@
? 'padding-top:0;'
: ''} "
>
- {#if $notify$.position.includes('top')}
-
- {/if}
{#await notifyComponent then Notify}
{#if Notify}
{/if}
{/await}
- {#if $notify$.position.includes('bottom')}
-
- {/if}
{/if}
diff --git a/packages/demo/package.json b/packages/demo/package.json
index cc564fd3a..bf7254b5f 100644
--- a/packages/demo/package.json
+++ b/packages/demo/package.json
@@ -32,23 +32,26 @@
"@web3-onboard/bitget": "2.1.1",
"@web3-onboard/blocto": "^2.1.1",
"@web3-onboard/bloom": "2.0.0",
+ "@web3-onboard/capsule": "^2.3.0",
"@web3-onboard/cede-store": "^2.3.1",
"@web3-onboard/core": "2.22.2",
"@web3-onboard/coinbase": "^2.4.1",
"@web3-onboard/dcent": "^2.2.7",
"@web3-onboard/enkrypt": "^2.1.1",
+ "@web3-onboard/finoaconnect": "2.0.0",
"@web3-onboard/fortmatic": "^2.1.1",
"@web3-onboard/frame": "^2.1.1",
"@web3-onboard/frontier": "^2.1.1",
"@web3-onboard/gas": "^2.2.1",
"@web3-onboard/gnosis": "^2.3.1",
"@web3-onboard/infinity-wallet": "^2.1.1",
- "@web3-onboard/injected-wallets": "^2.11.1",
+ "@web3-onboard/injected-wallets": "^2.11.2",
"@web3-onboard/keepkey": "^2.3.8",
+ "@web3-onboard/keplr": "2.0.0",
"@web3-onboard/keystone": "^2.3.8",
"@web3-onboard/ledger": "^2.7.1",
"@web3-onboard/magic": "^2.2.1",
- "@web3-onboard/metamask": "^2.1.2",
+ "@web3-onboard/metamask": "^2.1.3",
"@web3-onboard/mew-wallet": "^2.1.1",
"@web3-onboard/okx": "2.0.0",
"@web3-onboard/particle-network": "^2.1.1",
@@ -58,7 +61,7 @@
"@web3-onboard/sequence": "^2.1.1",
"@web3-onboard/taho": "^2.1.1",
"@web3-onboard/torus": "^2.3.1",
- "@web3-onboard/transaction-preview": "^2.1.1",
+ "@web3-onboard/transaction-preview": "^2.1.2",
"@web3-onboard/trezor": "^2.4.4",
"@web3-onboard/trust": "^2.1.1",
"@web3-onboard/uauth": "^2.2.1",
diff --git a/packages/demo/src/App.svelte b/packages/demo/src/App.svelte
index 39191c635..cfbc5de47 100644
--- a/packages/demo/src/App.svelte
+++ b/packages/demo/src/App.svelte
@@ -38,6 +38,8 @@
import bitgetModule from '@web3-onboard/bitget'
import bloomModule from '@web3-onboard/bloom'
import particleAuthModule from '@web3-onboard/particle-network'
+ import finoaConnectModule from '@web3-onboard/finoaconnect'
+ import keplrModule from '@web3-onboard/keplr'
import capsuleModule, {
Environment,
OAuthMethod
@@ -227,6 +229,7 @@
fallbackProvider: '' // insert your alchemy / infura url here
// encryptionSecret: '' // encryption secret is optional, but advised to securely store values in browser storage
})
+ const finoaConnect = finoaConnectModule()
const trezorOptions = {
email: 'test@test.com',
@@ -257,6 +260,7 @@
clientKey: 'cSTLqhvONB5j588Wz6E5WJLMPrHeUlGbymf1DFhO',
appId: 'b1f0239a-edb0-41f9-b0f5-ab780bb02a9e'
})
+ const keplr = keplrModule()
const dcent = dcentModule()
const bitget = bitgetModule()
@@ -275,7 +279,7 @@
environment: Environment.DEVELOPMENT,
apiKey: '992bbd9146d5de8ad0419f141d9a7ca7',
modalProps: {
- oAuthMethods: [OAuthMethod.GOOGLE, OAuthMethod.TWITTER]
+ oAuthMethods: [OAuthMethod.GOOGLE, OAuthMethod.TWITTER, OAuthMethod.APPLE,OAuthMethod.DISCORD]
},
constructorOpts: {
portalBackgroundColor: '#5e5656',
@@ -322,7 +326,9 @@
blocto,
venly,
particle,
- passport
+ passport,
+ finoaConnect,
+ keplr
],
transactionPreview,
gas,
diff --git a/packages/finoaconnect/README.md b/packages/finoaconnect/README.md
new file mode 100644
index 000000000..046db71ef
--- /dev/null
+++ b/packages/finoaconnect/README.md
@@ -0,0 +1,51 @@
+# @web3-onboard/finoaconnect
+
+## Wallet module for connecting FinoaConnect SDK to web3-onboard
+
+#### Install
+
+`npm i @web3-onboard/core @web3-onboard/finoaconnect`
+
+## Usage
+
+Optional initialization object
+```typescript
+/** Optional object provided to the initiation of the wallet connector.
+ * When not included, the wallet connector service connects to FinoaConnect production systems.
+ * @field {url} URL of the FinoaConnect backend systems to be used
+ * @field {labelSuffix} arbitrary string label to denote the context of the URL field */
+export interface FinoaWalletOption {
+ url?: string
+ labelSuffix?: string
+}
+```
+
+```typescript
+import Onboard from '@web3-onboard/core';
+import finoaConnectModule from '@web3-onboard/finoaconnect';
+
+const onboard = Onboard({
+ // ... other Onboard options
+ wallets: [
+ finoaConnectModule()
+ //... other wallets
+ ]
+})
+
+// alternatively to connect to a localised development environment
+const onboard = Onboard({
+ // ... other Onboard options
+ wallets: [
+ finoaConnectModule([
+ {
+ labelSuffix: 'localhost',
+ url: 'http://localhost:8080',
+ }
+ ])
+ //... other wallets
+ ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
diff --git a/packages/finoaconnect/package.json b/packages/finoaconnect/package.json
new file mode 100644
index 000000000..7e04ac695
--- /dev/null
+++ b/packages/finoaconnect/package.json
@@ -0,0 +1,66 @@
+{
+ "name": "@web3-onboard/finoaconnect",
+ "version": "2.0.0",
+ "description": "FinoaConnect enables DApp users to use Finoa's Institutional Custody services.",
+ "keywords": [
+ "Ethereum",
+ "Web3",
+ "EVM",
+ "dapp",
+ "Multichain",
+ "Wallet",
+ "Transaction",
+ "Provider",
+ "Hardware Wallet",
+ "Notifications",
+ "React",
+ "Svelte",
+ "Vue",
+ "Next",
+ "Nuxt",
+ "MetaMask",
+ "Coinbase",
+ "WalletConnect",
+ "Ledger",
+ "Trezor",
+ "Connect Wallet",
+ "Ethereum Hooks",
+ "Blocknative",
+ "Mempool",
+ "pending",
+ "confirmed",
+ "Injected Wallet",
+ "Crypto",
+ "Crypto Wallet",
+ "Tally Ho",
+ "FinoaConnect"
+ ],
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/blocknative/web3-onboard.git",
+ "directory": "packages/finoaconnect"
+ },
+ "homepage": "https://onboard.blocknative.com",
+ "bugs": "https://github.com/blocknative/web3-onboard/issues",
+ "module": "dist/index.js",
+ "browser": "dist/index.js",
+ "main": "dist/index.js",
+ "type": "module",
+ "typings": "dist/index.d.ts",
+ "files": [
+ "dist"
+ ],
+ "scripts": {
+ "build": "tsc",
+ "dev": "tsc -w",
+ "type-check": "tsc --noEmit"
+ },
+ "devDependencies": {
+ "typescript": "^5.4.5"
+ },
+ "dependencies": {
+ "@finoa/finoa-connect-sdk": "^1.0.4",
+ "@web3-onboard/core": "^2.20.4"
+ }
+
+ }
\ No newline at end of file
diff --git a/packages/finoaconnect/src/icon.ts b/packages/finoaconnect/src/icon.ts
new file mode 100644
index 000000000..2282313a8
--- /dev/null
+++ b/packages/finoaconnect/src/icon.ts
@@ -0,0 +1,6 @@
+export default `
+
+
+`
\ No newline at end of file
diff --git a/packages/finoaconnect/src/index.ts b/packages/finoaconnect/src/index.ts
new file mode 100644
index 000000000..f49015a3c
--- /dev/null
+++ b/packages/finoaconnect/src/index.ts
@@ -0,0 +1,72 @@
+import { FinoaEIP1193Provider } from '@finoa/finoa-connect-sdk'
+import { ProviderRpcError, ProviderRpcErrorCode, type WalletInit } from '@web3-onboard/common'
+
+/** Optional object provided to the initiation of the wallet connector.
+ * When not included, the wallet connector service connects to FinoaConnect production systems.
+ * @field {url} URL of the FinoaConnect backend systems to be used
+ * @field {labelSuffix} arbitrary string label to denote the context of the URL field */
+export interface FinoaWalletOption {
+ url?: string
+ labelSuffix?: string
+}
+
+function finoaConnect(option?: string | FinoaWalletOption): WalletInit {
+ const { url, labelSuffix }: FinoaWalletOption =
+ typeof option === 'string' ? { url: option } : !option ? {} : option
+
+ return () => {
+ return {
+ label: `FinoaConnect${labelSuffix == null ? '' : ' - ' + labelSuffix}`,
+ getIcon: async () => (await import('./icon')).default,
+ getInterface: async ({ chains }) => {
+ const {
+ FinoaEIP1193Provider,
+ FinoaBrowserClient,
+ UnsupportedRequestError
+ } = await import('@finoa/finoa-connect-sdk')
+
+ const client = new FinoaBrowserClient({
+ windowUrl: url
+ })
+ const provider = new FinoaEIP1193Provider({
+ client
+ })
+
+ const proxyProvider = new Proxy(provider, {
+ get(target, property: keyof FinoaEIP1193Provider) {
+ const source = target[property]
+ if (property === 'request') {
+ return async function (
+ this: FinoaEIP1193Provider,
+ ...args: Parameters
+ ) {
+
+ try {
+ return await (source as FinoaEIP1193Provider['request']).call(
+ this,
+ ...args
+ )
+ } catch (err) {
+ if (err instanceof UnsupportedRequestError) {
+ throw new ProviderRpcError({
+ code: ProviderRpcErrorCode.UNSUPPORTED_METHOD,
+ message: `FinoaConnect Provider does not support the requested method: ${args[0].method}`
+ })
+ }
+ throw err
+ }
+ }
+ }
+ return source
+ }
+ })
+
+ return {
+ provider: proxyProvider
+ }
+ }
+ }
+ }
+}
+
+export default finoaConnect
\ No newline at end of file
diff --git a/packages/finoaconnect/tsconfig.json b/packages/finoaconnect/tsconfig.json
new file mode 100644
index 000000000..ec0c86c1f
--- /dev/null
+++ b/packages/finoaconnect/tsconfig.json
@@ -0,0 +1,15 @@
+{
+ "extends": "../../tsconfig.json",
+ "include": ["src/**/*"],
+
+ "compilerOptions": {
+ "outDir": "dist",
+ "rootDir": "src",
+ "declaration": true,
+ "declarationDir": "dist",
+ "allowSyntheticDefaultImports": true,
+ "paths": {
+ "*": ["./src/*", "./node_modules/*"]
+ }
+ }
+ }
\ No newline at end of file
diff --git a/packages/gnosis/README.md b/packages/gnosis/README.md
index 435b7768f..3e4a79c16 100644
--- a/packages/gnosis/README.md
+++ b/packages/gnosis/README.md
@@ -57,3 +57,26 @@ 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.
+
+
+## Local testing within the Safe app
+
+Ensure the application is building and working properly within the browser and then add or enable your cors blocker extension or script of choice. An example is the `Allow CORS` browser extension.
+
+## 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']
+ }
+})
+```
\ No newline at end of file
diff --git a/packages/gnosis/package.json b/packages/gnosis/package.json
index 9fd40516e..b0a3ea0f6 100644
--- a/packages/gnosis/package.json
+++ b/packages/gnosis/package.json
@@ -1,6 +1,6 @@
{
"name": "@web3-onboard/gnosis",
- "version": "2.3.1",
+ "version": "2.3.2",
"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",
diff --git a/packages/injected/package.json b/packages/injected/package.json
index 9d9db5416..7c3c0ae91 100644
--- a/packages/injected/package.json
+++ b/packages/injected/package.json
@@ -1,6 +1,6 @@
{
"name": "@web3-onboard/injected-wallets",
- "version": "2.11.1",
+ "version": "2.11.2",
"description": "Injected wallet module for connecting browser extension and mobile wallets 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",
diff --git a/packages/injected/src/icons/keplr.ts b/packages/injected/src/icons/keplr.ts
new file mode 100644
index 000000000..e8d0943e6
--- /dev/null
+++ b/packages/injected/src/icons/keplr.ts
@@ -0,0 +1,33 @@
+export default `
+
+`
diff --git a/packages/injected/src/icons/trust.ts b/packages/injected/src/icons/trust.ts
index 28895808f..7a8650026 100644
--- a/packages/injected/src/icons/trust.ts
+++ b/packages/injected/src/icons/trust.ts
@@ -1,8 +1,19 @@
export default `
-
+
`
+
+
diff --git a/packages/injected/src/types.ts b/packages/injected/src/types.ts
index 42c750b2b..150e61e3a 100644
--- a/packages/injected/src/types.ts
+++ b/packages/injected/src/types.ts
@@ -71,7 +71,8 @@ export enum ProviderIdentityFlag {
Lif3Wallet = 'isLif3Wallet',
ZodiacPilot = 'isZodiacPilot',
StableWallet = 'isStableWallet',
- Echooo = 'isEchooo'
+ Echooo = 'isEchooo',
+ Keplr = 'keplr'
}
/**
@@ -101,7 +102,8 @@ export enum ProviderExternalUrl {
Lif3Wallet = 'https://lif3.com',
Rabby = 'https://rabby.io',
ZodiacPilot = 'https://pilot.gnosisguild.org/',
- Echooo = 'https://www.echooo.xyz'
+ Echooo = 'https://www.echooo.xyz',
+ Keplr = 'https://www.keplr.app/download'
}
export enum ProviderLabel {
@@ -164,7 +166,8 @@ export enum ProviderLabel {
Lif3Wallet = 'Lif3 Wallet',
ZodiacPilot = 'Zodiac Pilot',
StableWallet = 'StableWallet',
- Echooo = 'Echooo'
+ Echooo = 'Echooo',
+ Keplr = 'Keplr'
}
export interface MeetOneProvider extends ExternalProvider {
@@ -291,7 +294,7 @@ export interface InjectedWalletOptions {
walletUnavailableMessage?: (wallet: WalletModule) => string
/**Function that can be used to sort the order of wallets that are displayed */
sort?: (wallets: WalletModule[]) => WalletModule[]
- /** A boolean that can be passed to disable supporting 6963 (https://eips.ethereum.org/EIPS/eip-6963)
+ /** A boolean that can be passed to disable supporting 6963 (https://eips.ethereum.org/EIPS/eip-6963)
* which will display wallets available on the browser
*/
disable6963Support?: boolean
diff --git a/packages/injected/src/wallets.ts b/packages/injected/src/wallets.ts
index ee69450f3..77e7544dc 100644
--- a/packages/injected/src/wallets.ts
+++ b/packages/injected/src/wallets.ts
@@ -920,6 +920,17 @@ const echooo: InjectedWalletModule = {
externalUrl: ProviderExternalUrl.Echooo
}
+const keplr: InjectedWalletModule = {
+ label: ProviderLabel.Keplr,
+ injectedNamespace: InjectedNameSpace.Ethereum,
+ checkProviderIdentity: ({ provider }) =>
+ !!provider && !!provider[ProviderIdentityFlag.Keplr],
+ getIcon: async () => (await import('./icons/keplr.js')).default,
+ getInterface: getInjectedInterface(ProviderIdentityFlag.Keplr),
+ platforms: ['all'],
+ externalUrl: ProviderExternalUrl.Keplr
+}
+
const wallets = [
zeal,
exodus,
@@ -978,7 +989,8 @@ const wallets = [
Lif3Wallet,
zodiacPilot,
stablewallet,
- echooo
+ echooo,
+ keplr
]
export default wallets
diff --git a/packages/keplr/README.md b/packages/keplr/README.md
new file mode 100644
index 000000000..698ed01db
--- /dev/null
+++ b/packages/keplr/README.md
@@ -0,0 +1,33 @@
+# @web3-onboard/keplr
+
+## Wallet module for connecting keplr Wallet through web3-onboard
+
+Keplr Wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized 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.
+
+### Install
+
+**NPM**
+`npm i @web3-onboard/core @web3-onboard/keplr`
+
+**Yarn**
+`yarn add @web3-onboard/core @web3-onboard/keplr`
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import keplrModule from '@web3-onboard/keplr'
+
+const keplr = keplrModule()
+
+const onboard = Onboard({
+ // ... other Onboard options
+ wallets: [
+ keplr
+ //... other wallets
+ ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
diff --git a/packages/keplr/package.json b/packages/keplr/package.json
new file mode 100644
index 000000000..632f24616
--- /dev/null
+++ b/packages/keplr/package.json
@@ -0,0 +1,66 @@
+{
+ "name": "@web3-onboard/keplr",
+ "version": "2.0.0",
+ "description": "Keplr Wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized 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",
+ "Web3",
+ "EVM",
+ "dapp",
+ "Multichain",
+ "Wallet",
+ "Transaction",
+ "Provider",
+ "Hardware Wallet",
+ "Notifications",
+ "React",
+ "Svelte",
+ "Vue",
+ "Next",
+ "Nuxt",
+ "MetaMask",
+ "Coinbase",
+ "WalletConnect",
+ "Ledger",
+ "Trezor",
+ "Connect Wallet",
+ "Ethereum Hooks",
+ "Blocknative",
+ "Mempool",
+ "pending",
+ "confirmed",
+ "Injected Wallet",
+ "Crypto",
+ "Crypto Wallet",
+ "Enkrypt",
+ "Keplr"
+ ],
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/blocknative/web3-onboard.git",
+ "directory": "packages/keplr"
+ },
+ "homepage": "https://www.blocknative.com/onboard",
+ "bugs": "https://github.com/blocknative/web3-onboard/issues",
+ "module": "dist/index.js",
+ "browser": "dist/index.js",
+ "main": "dist/index.js",
+ "type": "module",
+ "typings": "dist/index.d.ts",
+ "files": [
+ "dist"
+ ],
+ "scripts": {
+ "build": "tsc",
+ "dev": "tsc -w",
+ "type-check": "tsc --noEmit"
+ },
+ "license": "MIT",
+ "devDependencies": {
+ "@types/node": "^17.0.21",
+ "typescript": "^5.4.5"
+ },
+ "dependencies": {
+ "@web3-onboard/common": "^2.4.1"
+ }
+}
diff --git a/packages/keplr/src/icon.ts b/packages/keplr/src/icon.ts
new file mode 100644
index 000000000..e8d0943e6
--- /dev/null
+++ b/packages/keplr/src/icon.ts
@@ -0,0 +1,33 @@
+export default `
+
+`
diff --git a/packages/keplr/src/index.ts b/packages/keplr/src/index.ts
new file mode 100644
index 000000000..f8e4182e0
--- /dev/null
+++ b/packages/keplr/src/index.ts
@@ -0,0 +1,38 @@
+import {
+ type WalletInit,
+ type EIP1193Provider,
+ createDownloadMessage
+} from '@web3-onboard/common'
+import { createEIP1193Provider } from '@web3-onboard/common'
+
+import { CustomWindow } from './types.js'
+
+declare const window: CustomWindow
+
+function keplr(): WalletInit {
+ if (typeof window === 'undefined') return () => null
+
+ return () => {
+ return {
+ label: 'Keplr Wallet',
+ getIcon: async () => (await import('./icon.js')).default,
+ getInterface: async () => {
+ const keplrwalletInjectionExists = window.hasOwnProperty('keplr')
+
+ let provider: EIP1193Provider
+
+ if (keplrwalletInjectionExists) {
+ provider = createEIP1193Provider(window['keplr'])
+ } else {
+ const downloadUrl = 'https://www.keplr.app/download'
+ throw new Error(createDownloadMessage('keplr Wallet', downloadUrl))
+ }
+ return {
+ provider
+ }
+ }
+ }
+ }
+}
+
+export default keplr
diff --git a/packages/keplr/src/types.ts b/packages/keplr/src/types.ts
new file mode 100644
index 000000000..40a88c5f8
--- /dev/null
+++ b/packages/keplr/src/types.ts
@@ -0,0 +1,5 @@
+import type { EIP1193Provider } from '@web3-onboard/common'
+
+export interface CustomWindow extends Window {
+ keplr?: EIP1193Provider
+}
diff --git a/packages/keplr/tsconfig.json b/packages/keplr/tsconfig.json
new file mode 100644
index 000000000..09ae989f9
--- /dev/null
+++ b/packages/keplr/tsconfig.json
@@ -0,0 +1,15 @@
+{
+ "extends": "../../tsconfig.json",
+ "include": ["src/**/*"],
+
+ "compilerOptions": {
+ "outDir": "dist",
+ "rootDir": "src",
+ "declaration": true,
+ "declarationDir": "dist",
+ "paths": {
+ "*": ["./src/*", "./node_modules/*"]
+ },
+ "typeRoots": ["node_modules/@types"]
+ }
+}
\ No newline at end of file
diff --git a/packages/metamask/package.json b/packages/metamask/package.json
index 6a87e1f72..702c45d25 100644
--- a/packages/metamask/package.json
+++ b/packages/metamask/package.json
@@ -1,6 +1,6 @@
{
"name": "@web3-onboard/metamask",
- "version": "2.1.2",
+ "version": "2.1.3",
"description": "MetaMask SDK wallet 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",
@@ -60,7 +60,7 @@
"typescript": "^5.2.2"
},
"dependencies": {
- "@metamask/sdk": "^0.26.1",
+ "@metamask/sdk": "^0.27.0",
"@web3-onboard/common": "^2.4.1"
},
"engines": {
diff --git a/packages/passport/package.json b/packages/passport/package.json
index d71be7fb5..6682a917a 100644
--- a/packages/passport/package.json
+++ b/packages/passport/package.json
@@ -1,6 +1,6 @@
{
"name": "@web3-onboard/passport",
- "version": "2.1.1",
+ "version": "2.1.2",
"description": "passport",
"module": "dist/index.js",
"browser": "dist/index.js",
diff --git a/packages/passport/src/index.ts b/packages/passport/src/index.ts
index 4ce260cbb..36827d15b 100644
--- a/packages/passport/src/index.ts
+++ b/packages/passport/src/index.ts
@@ -202,7 +202,7 @@ function passport(options: PassportOptions): WalletInit {
return {
label: 'Passport',
getIcon: async () => (await import('./icon')).default,
- getInterface: async () => {
+ getInterface: async ({ EventEmitter }) => {
const { Passport, Network } = await import('@0xpass/passport')
const { createPassportClient } = await import('@0xpass/passport-viem')
const { http } = await import('viem')
@@ -288,6 +288,9 @@ function passport(options: PassportOptions): WalletInit {
const provider = createEIP1193Provider(client)
+ const events = new EventEmitter()
+ provider.on = events.on.bind(events)
+
return {
instance: passport,
provider: provider
diff --git a/packages/transaction-preview/README.md b/packages/transaction-preview/README.md
index ef73578cd..f3a3ee3ff 100644
--- a/packages/transaction-preview/README.md
+++ b/packages/transaction-preview/README.md
@@ -1,368 +1,3 @@
# @web3-onboard/transaction-preview
-## (Deprecated) Transaction Preview support is going to be sunset on July 1st 2024 and will no longer work after that date
-
-## A modular UI for previewing a single or set of unsigned Ethereum transactions.
-
-
-
-#### Give Transaction Preview a test run by previewing Vitalik swapping tokens and find full package documentation [here](https://onboard.blocknative.com/docs/packages/transaction-preview)
-
-Full Simulation Platform API documentation can be found [here](https://docs.blocknative.com/transaction-preview-api)
-
-### Install
-
-**NPM**
-`npm i @web3-onboard/core @web3-onboard/injected-wallets @web3-onboard/transaction-preview`
-
-**Yarn**
-`yarn add @web3-onboard/core @web3-onboard/injected-wallets @web3-onboard/transaction-preview`
-
-### Usage with Web3-Onboard Core package
-
-
-
-To use the Transaction Preview package with web3-onboard all a developer needs to do is initialize web3-onboard with their [Blocknative API key](https://onboard.blocknative.com/docs/overview/introduction#optional-use-an-api-key-to-fetch-real-time-transaction-data-balances-gas) and pass in the module as shown below.
-
-```typescript
-import Onboard from '@web3-onboard/core'
-import injectedModule from '@web3-onboard/injected-wallets'
-import transactionPreviewModule from '@web3-onboard/transaction-preview'
-
-const injected = injectedModule()
-const transactionPreview = transactionPreviewModule({
- // Optional: Require balance change approval prior to sending transaction to wallet
- // Defaults to true
- // requireTransactionApproval?: false
-
- // i18n?: i18nOptions - Internationalization options
-})
-
-const onboard = Onboard({
- transactionPreview,
- apiKey: 'xxx387fb-bxx1-4xxc-a0x3-9d37e426xxxx'
- wallets: [injected],
- chains: [
- {
- id: '0x1',
- token: 'ETH',
- label: 'Ethereum',
- rpcUrl: 'https://mainnet.infura.io/v3/17c1e1500e384acfb6a72c5d2e67742e'
- }
- ]
- // ... other Onboard options
-})
-
-// Transaction code here using Ether.js or Web3.js or custom
-// The transaction will automatically be picked up and simulated with a UI displaying in the upper right corner
-```
-
-### Standalone Usage
-
-To use the Transaction Preview package without web3-onboard all a developer needs to do is:
-- Execute the entry function from the `@web3-onboard/transaction-preview` package and optional params
-- Run the returned `init` function with their [Blocknative API key](https://onboard.blocknative.com/docs/overview/introduction#optional-use-an-api-key-to-fetch-real-time-transaction-data-balances-gas), an initialized instance of their [Blocknative SDK](https://www.npmjs.com/package/bnc-sdk) and a containerElement string with the html ID of the target element to append the visualization to
-- Finally pass a transaction meant for a wallet provider (created using libraries like Ethers or Web3)
-
-With the above steps a UI will be rendered with the balance changes and gas used.
-
-```typescript
-import transactionPreviewModule from '@web3-onboard/transaction-preview'
-
-const {init, previewTransaction} = transactionPreviewModule({
- // Optional: Require balance change approval prior to sending transaction to wallet
- // Defaults to true
- // requireTransactionApproval?: false
-
- // i18n?: i18nOptions - Internationalization options
-})
-await init({
-/**
- * Blocknative API key (https://explorer.blocknative.com/account)
- */
-apiKey: string
-/**
- * Your Blocknative SDK instance
- * */
-sdk: SDK
-/**
- * Optional dom query string to mount UI to
- * */
-containerElement: string})
-
-// Transaction code here using Ether.js or Web3.js or construct your own transactions
-const simulate = async provider => {
- // if using ethers v6 this is:
- // ethersProvider = new ethers.BrowserProvider(wallet.provider, 'any')
- const ethersProvider = new ethers.providers.Web3Provider(provider, 'any')
-
- const signer = ethersProvider.getSigner()
- const addressFrom = '0xcxxxxxx11111999991111'
-
- // Uniswap V2
- const CONTRACT_ADDRESS = '0x7a250d5630b4cf539739df2c5dacb4c659f2488d'
- const erc20_interface = [
- 'function approve(address _spender, uint256 _value) public returns (bool success)',
- 'function transferFrom(address sender, address recipient, uint256 amount) external returns (bool)',
- 'function balanceOf(address owner) view returns (uint256)'
- ]
-
- const uniswapV2router_interface = [
- 'function swapExactTokensForETH(uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline) external returns (uint[] memory amounts)'
- ]
-
- const weth = '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'
- const oneInch = '0x111111111117dc0aa78b770fa6a738034120c302'
- let swapTxData
- let approveTxData
- const swapContract = new ethers.Contract(
- CONTRACT_ADDRESS,
- uniswapV2router_interface
- )
- const erc20_contract = new ethers.Contract(oneInch, erc20_interface)
- const oneEther = ethers.BigNumber.from('9000000000000000000')
- approveTxData = await erc20_contract.populateTransaction.approve(
- CONTRACT_ADDRESS,
- oneEther
- )
-
- const amountOutMin = 0
- const amountOutMinHex = ethers.BigNumber.from(amountOutMin).toHexString()
-
- const path = [oneInch, weth]
- const deadline = Math.floor(Date.now() / 1000) + 60 * 1 // 1 minutes from the current Unix time
-
- const inputAmountHex = oneEther.toHexString()
-
- swapTxData = await swapContract.populateTransaction.swapExactTokensForETH(
- inputAmountHex,
- amountOutMinHex,
- path,
- addressFrom,
- deadline
- )
- const uniswapV2Router = '0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D'
-
- const popApproveTransaction = await signer.populateTransaction(approveTxData)
- const popTransaction = await signer.populateTransaction(swapTxData)
- const transactions = [
- { ...popApprovedTransaction, value: 0 },
- {
- ...popTransaction,
- from: addressFrom,
- to: uniswapV2Router,
- value: 0
- }
- ]
- return await previewTransaction(transactions)
-}
-
-const simData = simulate(ethereumProvider)
-console.log(simData)
-```
-
-### Options & Types
-
-```typescript
-export type TransactionPreviewModule = (
- options: TransactionPreviewOptions
-) => TransactionPreviewAPI
-
-export type FullPreviewOptions = TransactionPreviewOptions &
- TransactionPreviewInitOptions
-
-export type TransactionPreviewAPI = {
- /**
- * This Method accepts a standard EIP1193 provider
- * (such as an injected wallet from window.ethereum)
- * and it will be patched to allow for transaction previewing
- */
- patchProvider: (provider: PatchedEIP1193Provider) => PatchedEIP1193Provider
-
- /**
- * This Method accepts:
- * apiKey: string - Blocknative API key (https://explorer.blocknative.com/)
- * sdk: instance of an initialized bnc-sdk (www.npmjs.com/package/bnc-sdk)
- * containerElement: string of an html id selector (e.g. "#my-html-el")
- */
- init: (initializationOptions: TransactionPreviewInitOptions) => void
-
- /**
- * This method accepts a transaction meant for a wallet provider
- * (created using libraries like Ethers or Web3),
- * simulates the transaction and generates a corresponding UI and
- * return a response from the Blocknative Transaction Preview API.
- * Note: the package will need to initialized with the `init`
- * function prior to usage
- */
- previewTransaction: (
- transaction: TransactionForSim[]
- ) => Promise
-}
-
-export type PatchedEIP1193Provider = EIP1193Provider & { simPatched: boolean }
-
-export interface ProviderReq {
- method: string
- params?: Array
-}
-
-export type RequestOptions = Pick
-
-export type TransactionPreviewInitOptions = {
- /**
- * Blocknative API key (https://explorer.blocknative.com/account)
- */
- apiKey: string
- /**
- * Your Blocknative SDK instance (https://www.npmjs.com/package/bnc-sdk)
- * */
- sdk: SDK
- /**
- * Optional dom query string to mount UI to
- * */
- containerElement: string
-}
-
-export type TransactionPreviewOptions = {
- /**
- * Optional requirement for user to accept transaction balance changes
- * prior to sending the transaction to the wallet
- * Defaults to true
- * */
- requireTransactionApproval?: boolean
- /**
- * An optional internationalization object that defines the display
- * text for different locales. Can also be used to override the default text.
- * To override the default text, pass in a object for the en locale
- */
- i18n?: i18nOptions
-}
-
-export type Locale = string
-export type i18nOptions = Record
-export type i18n = typeof en
-
-export type DeviceNotBrowser = {
- type: null
- os: null
- browser: null
-}
-
-export type TransactionForSim = SimulationTransaction & {
- data?: string
-}
-
-export interface SimulationTransaction {
- from: string
- to: string
- value: number
- gas: number
- input: string
- // Either Type 1 Gas (gasPrice) or Type 2 Gas (maxPriorityFeePerGas & maxFeePerGas)
- // must be included in the payload
- gasPrice?: number
- maxPriorityFeePerGas?: number
- maxFeePerGas?: number
-}
-
-export type MultiSimOutput = {
- id?: string
- contractCall: ContractCall[]
- error?: any
- gasUsed: number[]
- internalTransactions: InternalTransaction[][]
- netBalanceChanges: NetBalanceChange[][]
- network: Network
- simDetails: SimDetails
- serverVersion: string
- system: System
- status: Status
- simulatedBlockNumber: number
- transactions: InternalTransaction[]
-}
-
-export interface ContractCall {
- contractType?: string
- contractAddress?: string
- contractAlias?: string
- methodName: string
- params: Record
- contractName?: string
- contractDecimals?: number
- decimalValue?: string
-}
-
-export interface InternalTransaction {
- type: string
- from: string
- to: string
- input: string
- gas: number
- gasUsed: number
- value: string
- contractCall: ContractCall
- error?: string
- errorReason?: string
-}
-
-export interface NetBalanceChange {
- address: string
- balanceChanges: BalanceChange[]
-}
-
-export interface BalanceChange {
- delta: string
- asset: Asset
- breakdown: BreakDown[]
-}
-
-export interface Asset {
- type: string
- symbol: string
- contractAddress: string
-}
-
-export interface BreakDown {
- counterparty: string
- amount: string
-}
-
-export interface InternalTransaction {
- type: string
- from: string
- to: string
- input: string
- gas: number
- gasUsed: number
- value: string
- contractCall: ContractCall
-}
-
-export type System = 'bitcoin' | 'ethereum'
-export type Network =
- | 'main'
- | 'testnet'
- | 'sepolia'
- | 'xdai'
- | 'bsc-main'
- | 'matic-main'
- | 'fantom-main'
- | 'matic-mumbai'
- | 'local'
-
-export type Status =
- | 'pending'
- | 'confirmed'
- | 'speedup'
- | 'cancel'
- | 'failed'
- | 'dropped'
- | 'simulated'
-
-export interface SimDetails {
- blockNumber: number
- e2eMs: number
- performanceProfile: any
-}
-```
+## (Deprecated) Transaction Preview support has ended and is not longer supported within Web3-Onboard. Please remove Transaction Preview to avoid console errors and unexpected behavior.
diff --git a/packages/transaction-preview/package.json b/packages/transaction-preview/package.json
index aae27f489..b22fc958a 100644
--- a/packages/transaction-preview/package.json
+++ b/packages/transaction-preview/package.json
@@ -1,6 +1,6 @@
{
"name": "@web3-onboard/transaction-preview",
- "version": "2.1.1",
+ "version": "2.1.2",
"description": "In app preview of Ethereum transactions",
"keywords": [
"Ethereum",
diff --git a/packages/trust/package.json b/packages/trust/package.json
index 8855d3510..75436fd07 100644
--- a/packages/trust/package.json
+++ b/packages/trust/package.json
@@ -1,6 +1,6 @@
{
"name": "@web3-onboard/trust",
- "version": "2.1.1",
+ "version": "2.1.2",
"description": "Trust Wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized 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",
diff --git a/packages/trust/src/icon.ts b/packages/trust/src/icon.ts
index 64890a79d..8553daad6 100644
--- a/packages/trust/src/icon.ts
+++ b/packages/trust/src/icon.ts
@@ -1,8 +1,17 @@
export default `
-