![\"Ledger\"](\"https://web3auth.io/images/w3a-L-Favicon-1.svg\")
\n \n \n
Wagmi Connector for Web3Auth
\n\n\n[](https://github.com/prettier/prettier)\n\n\nWeb3Auth is where passwordless auth meets non-custodial key infrastructure for Web3 apps and wallets. By aggregating OAuth (Google, Twitter, Discord) logins, different wallets and innovative Multi Party Computation (MPC) - Web3Auth provides a seamless login experience to every user on your application.\n\n`@web3auth/web3auth-wagmi-connector` is a connector for the popular [wagmi](https://github.com/tmm/wagmi) library and Web3Auth Web SDKs. \n\nYou can utilise this connector package alongside the Web3Auth Web SDKs to initialize a [wagmi client](https://wagmi.sh/docs/client) that will seemlessly manage the interaction of your DApp with Web3Auth.\n\n## 📖 Documentation\n\nCheckout the official [Web3Auth Documentation](https://web3auth.io/docs) and [SDK Reference](https://web3auth.io/docs/sdk/web/) to get started!\n\n## 💡 Features\n\n- Plug and Play, OAuth based Web3 Authentication Service\n- Fully decentralized, non-custodial key infrastructure\n- End to end Whitelabelable solution\n- Threshold Cryptography based Key Reconstruction\n- Multi Factor Authentication Setup & Recovery (Includes password, backup phrase, device factor editing/deletion etc)\n- Support for WebAuthn & Passwordless Login\n- Support for connecting to multiple wallets\n- DApp Active Session Management\n\n...and a lot more\n\n## 💭 Choosing Between SDKs\n\nFor using Web3Auth in the web, you have two choices of SDKs to get started with.\n\n[Web3Auth Plug and Play Modal SDK `@web3auth/modal`](https://web3auth.io/docs/sdk/web/modal/): A simple and easy to use SDK that will give you a simple modular way of implementing Web3Auth directly within your application. You can use the pre-configured Web3Auth Modal UI and whitelabel it according to your needs.\n\n[Web3Auth Plug and Play No Modal SDK `@web3auth/no-modal`](https://web3auth.io/docs/sdk/web/no-modal/): The core module implemeting all the Web3Auth features you need and giving you the flexibilty of using your own UI with the Web3Auth SDK working in the client side.\n\n## ⚡ Quick Start\n\n### Installation (Web3Auth Plug and Play Modal)\n\n```shell\nnpm install --save @web3auth/modal\nnpm install --save @web3auth/web3auth-wagmi-connector\n```\n\n### Get your Client ID from Web3Auth Dashboard\n\nHop on to the [Web3Auth Dashboard](https://dashboard.web3auth.io/) and create a new project. Use the Client ID of the project to start your integration.\n\n\n\n### Instantiate Web3Auth and pass it to the Connector\n\nHere is an example of a wagmi client using both the `Web3AuthConnector` and the default `InjectedConnector` respectively.\n\n```js\nimport { Web3AuthConnector } from \"@web3auth/web3auth-wagmi-connector\";\nimport { Web3Auth } from \"@web3auth/modal\";\nimport { createConfig, WagmiConfig, configureChains } from \"wagmi\";\nimport { InjectedConnector } from \"wagmi/connectors/injected\";\nimport { publicProvider } from \"wagmi/providers/public\";\n\n// Configure chains & providers with the Alchemy provider.\n// Popular providers are Alchemy (alchemy.com), Infura (infura.io), Quicknode (quicknode.com) etc.\nconst { chains, publicClient, webSocketPublicClient } = configureChains([mainnet, arbitrum, polygon], [publicProvider()]);\n\n// Instantiating Web3Auth\nconst web3AuthInstance = new Web3Auth({\n clientId: \"YOUR_CLIENT_ID\",\n chainConfig: {\n chainNamespace: CHAIN_NAMESPACES.EIP155,\n chainId: \"0x\" + chains[0].id.toString(16),\n rpcTarget: chains[0].rpcUrls.default, // This is the public RPC we have added, please pass on your own endpoint while creating an app\n displayName: chains[0].name,\n tickerName: chains[0].nativeCurrency?.name,\n ticker: chains[0].nativeCurrency?.symbol,\n blockExplorer: chains[0]?.blockExplorers.default?.url,\n },\n web3AuthNetwork: \"cyan\",\n});\n\nconst wagmiConfig = createConfig({\n autoConnect: true,\n connectors: [\n new Web3AuthConnector({\n chains,\n options: {\n web3AuthInstance,\n },\n }),\n new InjectedConnector({\n chains,\n options: {\n name: \"Injected\",\n shimDisconnect: true,\n },\n }),\n ],\n publicClient,\n webSocketPublicClient,\n});\n```\n\n## 🩹 Examples\n\nCheckout the examples for your preferred blockchain and platform in our [examples repository](https://github.com/Web3Auth/web3auth-pnp-examples/)\n\n## 🌐 Demo\n\nCheckout the [Web3Auth Demo](https://demo-app.web3auth.io/) to see how Web3Auth can be used in your application.\n\nFurther checkout the [demos folder](https://github.com/Web3Auth/web3auth-wagmi-connecto/tree/master/demos) within this repository, which contains other hosted demos for different usecases.\n\n## 💬 Troubleshooting and Support\n\n- Have a look at our [Community Portal](https://community.web3auth.io/) to see if anyone has any questions or issues you might be having. Feel free to reate new topics and we'll help you out as soon as possible.\n- Checkout our [Troubleshooting Documentation Page](https://web3auth.io/docs/troubleshooting) to know the common issues and solutions.\n- For Priority Support, please have a look at our [Pricing Page](https://web3auth.io/pricing.html) for the plan that suits your needs\n","readmeFilename":"README.md"}