@venly/wagmi-connector

Default Branch

Main Branch

Venly connector for wagmi

Setup (wagmi v3)

Install version 3.x of @venly/wagmi-connector

npm i @venly/wagmi-connector@latest

Requires @wagmi/core@^3.4.0 and viem@^2.9.25 as peer dependencies.

import { createConfig } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'
import { http } from 'viem'
import { venly } from '@venly/wagmi-connector'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
  connectors: [
    venly({
      clientId: 'YOUR_CLIENT_ID', // https://docs.venly.io/widget/deep-dive/authentication#client-id
      environment: 'sandbox', // optional, defaults to production
    }),
  ],
})

Migrating from v2 to v3

1. Upgrade your app to @wagmi/core@^3.4.0 and wagmi@^2.14.0 (see wagmi v2 changelog for any wagmi-level changes)
2. Ensure viem@^2.9.25 is installed
3. Upgrade @venly/wagmi-connector to v3

The venly() connector API is unchanged — no code changes are needed beyond the wagmi/viem upgrades.

Setup (wagmi v2)

Install version 2.x of @venly/wagmi-connector

npm i @venly/wagmi-connector@2

Requires @wagmi/core@^2.6.17 and viem@^2.9.25.

import { createConfig } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'
import { venly } from '@venly/wagmi-connector'

const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    venly({
      clientId: 'YOUR_CLIENT_ID', // https://docs.venly.io/widget/deep-dive/authentication#client-id
      environment: 'sandbox', // optional, defaults to production
    }),
  ],
  // other options...
})

Setup (wagmi v1)

Install version 1.x of @venly/wagmi-connector

npm i @venly/wagmi-connector@1

Configure your desired chains and VenlyConnector options

import { createConfig, configureChains, mainnet } from 'wagmi'
import { publicProvider } from 'wagmi/providers/public'
import { VenlyConnector } from '@venly/wagmi-connector'

const { chains, publicClient } = configureChains(
  [mainnet],
  [publicProvider()],
)

const config = createConfig({
  connectors: [
    new VenlyConnector({
      chains,
      options: {
        clientId: 'YOUR_CLIENT_ID', // https://docs.venly.io/widget/deep-dive/authentication#client-id
        environment: 'sandbox', // optional, defaults to production
      },
    }),
  ],
  publicClient,
  autoConnect: true,
})

Setup (wagmi v0)

Install version 0.x of @venly/wagmi-connector

npm i @venly/[email protected]

Configure your desired chains and VenlyConnector options

import { configureChains, createClient } from 'wagmi'
import { goerli, mainnet } from 'wagmi/chains'
import { publicProvider } from 'wagmi/providers/public'
import { VenlyConnector } from '@venly/wagmi-connector'

const { chains, provider } = configureChains(
  [goerli, mainnet],
  [publicProvider()],
)

export const client = createClient({
  connectors: [
    new VenlyConnector({
      chains,
      options: {
        clientId: 'YOUR_CLIENT_ID', // https://docs.venly.io/widget/deep-dive/authentication#client-id
        environment: 'sandbox', // optional, defaults to production
      },
    }),
  ],
  provider,
  autoConnect: true,
})

What is Venly Wallet

Not sure yet what Venly is all about? Be sure to check out our website: https://www.venly.io/