open-index/open-npm huggingface dataset:
npm package: @subwallet-connect/keystone
Description: Keystone hardware 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 
Latest version: 1.0.8

# @subwallet-connect/keystone

## Wallet module for connecting Keystone hardware wallets to web3-onboard

### Install

`npm i @subwallet-connect/keystone`

### Options

```typescript
type KeystoneOptions = {
  customNetwork?: CustomNetwork
  filter?: Platform[]
  containerElement?: string
  /**
   * A number that defines the amount of consecutive empty addresses displayed
   * within the Account Select modal. Default is 5
   */
  consecutiveEmptyAccountThreshold?: number
}

interface CustomNetwork {
  networkId: number
  genesis: GenesisBlock
  hardforks: Hardfork[]
  bootstrapNodes: BootstrapNode[]
}

interface GenesisBlock {
  hash: string
  timestamp: string | null
  gasLimit: number
  difficulty: number
  nonce: string
  extraData: string
  stateRoot: string
}

interface Hardfork {
  name: string
  block: number | null
}

interface BootstrapNode {
  ip: string
  port: number | string
  network?: string
  chainId?: number
  id: string
  location: string
  comment: string
}
```

### Usage

```typescript
import Onboard from '@subwallet-connect/core'
import keystoneModule from '@subwallet-connect/keystone'

const keystone = keystoneModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    keystone
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```

### Filtering Platforms

You may decide that on certain platforms you do not want to display this wallet as a selectable option. To do that you can use the `filter` init option which is an array of platforms that you would like this wallet to **not** be displayed to the end user:

```typescript
import Onboard from '@subwallet-connect/core'
import keystoneModule from '@subwallet-connect/keystone'

const keystone = keystoneModule({ filter: ['Safari'] })

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    keystone
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```

The following is a list of the platforms that can be filtered:

```typescript
type Platform =
  | 'Windows Phone'
  | 'Windows'
  | 'macOS'
  | 'iOS'
  | 'Android'
  | 'Linux'
  | 'Chrome OS'
  | 'Android Browser'
  | 'Chrome'
  | 'Chromium'
  | 'Firefox'
  | 'Microsoft Edge'
  | 'Opera'
  | 'Safari'
  | 'desktop'
  | 'mobile'
  | 'tablet'
```
npm package: @subwallet-connect/metamask
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 moder
Latest version: 1.0.8

# @subwallet-connect/metamask

## Wallet module for connecting MetaMask Wallet SDK to web3-onboard
The MetaMask Web3-Onboard module provides a reliable, secure, and seamless connection from your dapp to the MetaMask browser extension and MetaMask Mobile.
See [MetaMask SDK Developer Docs](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/)

![MetaMask SDK ConnectionFlow](https://github.com/blocknative/web3-onboard/blob/develop/assets/metaMaskSDK-connect.gif?raw=true 'MetaMask SDK ConnectionFlow')

### Install

`npm i @subwallet-connect/metamask`

### If using this package with the `@subwallet-connect/injected-wallets` module
_When utilizing this package alongside the `@subwallet-connect/injected-wallets` module, ensure to list this package prior to the initialized injected-wallets module within the wallets list of the Web3-Onboard init._ 
_This order prioritizes the SDK when a MetaMask browser wallet is detected, allowing the SDK to take precedence._

## Options

```typescript
// For a complete list of options check https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/
interface MetaMaskSDKOptions {
  dappMetadata: {
    url?: string;
    name?: string;
    base64Icon?: string;
  },
  /**
   * If MetaMask browser extension is detected, directly use it without prompting the user.
   */
  extensionOnly?: boolean;
}
```

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import metamaskSDK from '@subwallet-connect/metamask'

// initialize the module with options
const metamaskSDKWallet = metamaskSDK({options: {
  extensionOnly: false,
  dappMetadata: {
    name: 'Demo Web3Onboard'
  }
}})

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    metamaskSDKWallet,
    //... other wallets
    // Make sure to pass in before or above the injected-wallets module
    injectedWalletModule
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/mew
Description: (DEPRECATED. Use @subwallet-connect/mew-wallet instead) MEW (My Ether 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 standardised spec complia
Latest version: 1.0.8

# @subwallet-connect/mew

## (Deprecated) Wallet module for connecting WalletLink to web3-onboard
_Use [@subwallet-connect/mew-wallet](../mew-wallet/README.md)_

## Wallet module for connecting Mew wallet to web3-onboard

### Install

`npm i @subwallet-connect/mew`

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import mewModule from '@subwallet-connect/mew'

const mew = mewModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    mew
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```

_NOTE: Currently not building on M1 Macs_
npm package: @subwallet-connect/mew-wallet
Description: MEW (MyEtherWallet) 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 standardised spec compliant web3 providers for all supported wallets, framew
Latest version: 1.0.8

# @subwallet-connect/mew-wallet

## Wallet module for connecting Mew wallet through web3-onboard

### Install

**NPM**
`npm i @subwallet-connect/core @subwallet-connect/mew-wallet`

**Yarn**
`yarn add @subwallet-connect/core @subwallet-connect/mew-wallet`

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import mewWallet from '@subwallet-connect/mew-wallet'

const mewWalletModule = mewWallet()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    mewWalletModule
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/phantom
Description: Phantom 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 jav
Latest version: 1.0.8

# @subwallet-connect/phantom

## Wallet module for connecting Phantom to Web3-Onboard

[Web3-Onboard](https://onboard.blocknative.com/) is an open-source, framework-agnostic JavaScript library to onboard users to web3 apps. This package can be used to integrate [Phantom Wallet](https://phantom.app/) support into Web3-Onboard's "Connect Wallet" modal. With this module the Phantom option will be shown even if the extension is not installed on the users browser or used within the Phantom app. If selected the user will be taken to a download screen and prompted to create a Phantom wallet. For more information on Phantom, please refer to the [Phantom developer docs](https://docs.phantom.app/).

### Install

`npm i @subwallet-connect/core @subwallet-connect/phantom`

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import phantomModule from '@subwallet-connect/phantom'

// initialize the module
const phantom = phantomModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    phantom
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/polkadot-js
Description: Polkadot{.js} 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 ag
Latest version: 1.0.8

ERROR: No README data found!
npm package: @subwallet-connect/portis
Description: Portis 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 
Latest version: 1.0.8

# @subwallet-connect/portis

## Wallet module for connecting Portis wallet to web3-onboard

### Install

`npm i @subwallet-connect/portis`

## Options

```typescript
type PortisOptions {
  apiKey: string // required
}
```

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import portisModule from '@subwallet-connect/portis'

const portis = portisModule({ apiKey: 'API_KEY' })

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    portis
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/sequence
Description: Sequence is the smartest Web3 wallet. Easy, fun and secure.
Latest version: 1.0.8

# @subwallet-connect/sequence

## Wallet module for connecting Sequence wallet to web3-onboard

### Install

`npm i @subwallet-connect/sequence 0xsequence ethers`  
or  
`yarn add @subwallet-connect/sequence 0xsequence ethers`

## Options

```typescript
type SequenceOptions {
  appName?: string
  network?: number | string
}
```

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import sequenceModule from '@subwallet-connect/sequence'

const sequence = sequenceModule({
  appName: 'My app'
})

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    sequence
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/subwallet_bitkeep
Description: Bitkeep 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
Latest version: 1.0.8

# @subwallet-connect/bitkeep

## (Deprecated) Wallet module for connecting Bitkeep to web3-onboard
_Use [@subwallet-connect/bitget](https://www.npmjs.com/package/@subwallet-connect/bitget)_

## Wallet module for connecting Bitkeep Wallet through web3-onboard

Bitkeep 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 @subwallet-connect/core @subwallet-connect/bitkeep`

**Yarn**
`yarn add @subwallet-connect/core @subwallet-connect/bitkeep`

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import bitkeepModule from '@subwallet-connect/bitkeep'

const bitKeep = bitkeepModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    bitKeep()
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/taho
Description: Taho 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 ja
Latest version: 1.0.8

# @subwallet-connect/taho (Taho previously named Tally Ho wallet)

## Wallet module for connecting Taho (Previously named Tally Ho wallet) Wallet to web3-onboard
See [Taho Developer Docs](https://docs.tally.cash/tally/developers/integrating-dapps)

### Install

`npm i @subwallet-connect/taho`


## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import tahoWalletModule from '@subwallet-connect/taho'

// initialize the module with options
const tahoWalletSdk = tahoWalletModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    tahoWalletModule()
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/tallyho
Description: (DEPRECATED. Use @subwallet-connect/taho instead) Tally Ho (now named Taho 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 standardised spec co
Latest version: 1.0.8

# @subwallet-connect/tallyho (now named Taho wallet)

## (Deprecated) Wallet module for connecting Tally Ho Wallet to web3-onboard
_Use [@subwallet-connect/taho](../taho/README.md)_

See [Taho Developer Docs](https://docs.tally.cash/tally/developers/integrating-dapps)

### Install

`npm i @subwallet-connect/tallyho`

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import tallyHoWalletModule from '@subwallet-connect/tallyho'

// initialize the module with options
const tallyHoWalletSdk = tallyHoWalletModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    tallyHoWalletModule()
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/torus
Description: Torus 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 j
Latest version: 1.0.8

# @subwallet-connect/torus

## Wallet module for connecting Torus wallet to web3-onboard

### Install

`npm i @subwallet-connect/torus`

## Options

See the [Torus Docs](https://docs.tor.us/wallet/api-reference/class) for the extensive list of options

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import torusModule from '@subwallet-connect/torus'

const torus = torusModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    torus
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/trezor
Description: Trezor hardware 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 mo
Latest version: 1.0.8

# @subwallet-connect/trezor

## Wallet module for connecting Trezor hardware wallets to web3-onboard

### Install

`npm i @subwallet-connect/trezor`

### Options

```typescript
type TrezorOptions = {
  email: string
  appUrl: string
  customNetwork?: CustomNetwork
  filter?: Platform[]
  containerElement?: string
  /**
   * A number that defines the amount of consecutive empty addresses displayed
   * within the Account Select modal. Default is 5
   */
  consecutiveEmptyAccountThreshold?: number
}

interface CustomNetwork {
  networkId: number
  genesis: GenesisBlock
  hardforks: Hardfork[]
  bootstrapNodes: BootstrapNode[]
}

interface GenesisBlock {
  hash: string
  timestamp: string | null
  gasLimit: number
  difficulty: number
  nonce: string
  extraData: string
  stateRoot: string
}

interface Hardfork {
  name: string
  block: number | null
}

interface BootstrapNode {
  ip: string
  port: number | string
  network?: string
  chainId?: number
  id: string
  location: string
  comment: string
}

type Platform = DeviceOSName | DeviceBrowserName | DeviceType | 'all'
```

### Usage

```typescript
import Onboard from '@subwallet-connect/core'
import trezorModule from '@subwallet-connect/trezor'

const trezor = trezorModule({
  email: '<EMAIL_CONTACT>',
  appUrl: '<APP_URL>'
})

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    trezor
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```

### Filtering Platforms

You may decide that on certain platforms you do not want to display this wallet as a selectable option. To do that you can use the `filter` init option which is an array of platforms that you would like this wallet to **not** be displayed to the end user:

```typescript
import Onboard from '@subwallet-connect/core'
import trezorModule from '@subwallet-connect/trezor'

const trezor = trezorModule({
  email: '<EMAIL_CONTACT>',
  appUrl: '<APP_URL>',
  filter: ['Safari'] // do not display on Safari
})

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    trezor
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```

The following is a list of the platforms that can be filtered:

```typescript
type Platform =
  | 'Windows Phone'
  | 'Windows'
  | 'macOS'
  | 'iOS'
  | 'Android'
  | 'Linux'
  | 'Chrome OS'
  | 'Android Browser'
  | 'Chrome'
  | 'Chromium'
  | 'Firefox'
  | 'Microsoft Edge'
  | 'Opera'
  | 'Safari'
  | 'desktop'
  | 'mobile'
  | 'tablet'
```
npm package: @subwallet-connect/trust
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 m
Latest version: 1.0.8

# @subwallet-connect/trust

## Wallet module for connecting Trust Wallet through web3-onboard

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.

### Install

**NPM**
`npm i @subwallet-connect/core @subwallet-connect/trust`

**Yarn**
`yarn add @subwallet-connect/core @subwallet-connect/trust`

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import trustModule from '@subwallet-connect/trust'

const trust = trustModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    trust
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/unstoppable-resolution
Description: Adds Unstoppable Domain resolution for a wallet address, similar to ENS resolution
Latest version: 1.0.8

# @subwallet-connect/unstoppable-resolution

## A module to add Unstoppable Domain resolution to web3-onboard.

### Install

**NPM**
`npm i @subwallet-connect/unstoppable-resolution`

**Yarn**
`yarn add @subwallet-connect/unstoppable-resolution`

### Standalone Setup

```typescript
import Onboard from '@subwallet-connect/core'
import unstoppableResolution from '@subwallet-connect/unstoppable-resolution'

const onboard = Onboard({
  // ... other Onboard options
  unstoppableResolution
})
```
npm package: @subwallet-connect/venly
Description: Venly 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 javas
Latest version: 1.0.8

# @subwallet-connect/venly

## Wallet module for connecting Venly SDK to web3-onboard
See [Venly SDK Docs](https://docs.venly.io/widget/) for complete documentation of Venly usage

### Install

`npm install @subwallet-connect/venly`

## 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 '@subwallet-connect/core'
import venlyModule from '@subwallet-connect/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)
```
npm package: @subwallet-connect/walletlink
Description: (DEPRECATED. Use @subwallet-connect/coinbase instead) WalletLink 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 provi
Latest version: 1.0.8

# @subwallet-connect/walletlink

## (Deprecated) Wallet module for connecting WalletLink to web3-onboard
_Use [@subwallet-connect/coinbase](../coinbase/README.md)_

### Install

`npm i @subwallet-connect/walletlink`

## Options

```typescript
type WalletLinkOptions = {
  darkMode: boolean // default = false
}
```

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import walletLinkModule from '@subwallet-connect/walletlink'

// initialize the module with options
const walletLink = walletLinkModule({ darkMode: true })

// can also initialize with no options...
// const walletLink = walletLinkModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    walletLink
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/xdefi
Description: XDEFI 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 javas
Latest version: 1.0.8

# @subwallet-connect/xdefi

## Wallet module for connecting XDEFI Wallet to web3-onboard

See [XDEFI Wallet Developer Docs](https://docs.xdefi.io/docs/technical-documentation/xdefi-extension-integration/)

### Install

`npm i @subwallet-connect/xdefi`

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import xdefiWalletModule from '@subwallet-connect/xdefi'

// initialize the module with options
const xdefiSdk = xdefiWalletModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    xdefiSdk
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```
npm package: @subwallet-connect/zeal
Description: Zeal SDK wallet module for connecting to Web3-Onboard.
Latest version: 1.0.8

# @subwallet-connect/zeal

## Wallet module for connecting Zeal to web3-onboard

See [Zeal](https://www.zeal.app/) for details.

For any questions or issues related to integration with Zeal wallet do not hesitate to contact our builders via [hi@zeal.app](mailto:hi@zeal.app) OR ping us on twitter [@withzeal](https://twitter.com/withzeal)

### Install

`npm i @subwallet-connect/core @subwallet-connect/zeal`

## Usage

```typescript
import Onboard from '@subwallet-connect/core'
import zealWalletModule from '@subwallet-connect/zeal'

// initialize the module with options
const zealWalletSdk = zealWalletModule()

const onboard = Onboard({
  // ... other Onboard options
  wallets: [
    zealWalletModule()
    //... other wallets
  ]
})

const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
```