@mocanetwork/airkit-connector 1.4.0-beta.2 → 1.4.2

package/README.md

@@ -1,85 +1,173 @@
-<p align="center">
- <img src="https://web3auth.io/images/w3a-L-Favicon-1.svg" align="center" alt="Ledger" />
- <h2 align="center">Web3Auth Mocaverse Embed Wagmi Connector</h2>
- <p align="center"><a href="https://github.com/tmm/wagmi">Wagmi</a> Connector for Web3Auth Mocaverse Embed</p>
-</p>
+# Air Kit Wagmi Connector
 
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-![npm](https://img.shields.io/npm/dw/@web3auth/mocaverse-wagmi-connector)
+This connector is part of the [Moca Network](https://moca.network/) offering and provides seamless integration between the Air Kit SDK and the popular [wagmi](https://wagmi.sh/) library for React applications.
 
-`@web3auth/mocaverse-wagmi-connector` is a connector for the popular [wagmi](https://github.com/tmm/wagmi) library and Web3Auth Wallet Ecosystems, Mocaverse Embed SDK. 
+## ⚡ Quick Start
 
-It can be used to initialize a [wagmi client](https://wagmi.sh/docs/client) that will seemlessly manage the interaction of your DApp with Torus Wallet.
+```shell
+npm install @mocanetwork/airkit-connector
+```
 
-## 📖 Documentation
+### Initialize & Connect
 
-Checkout the official [Web3Auth Documentation](https://web3auth.io/docs) and [SDK Reference](https://web3auth.io/docs/sdk/) to get started!
+```ts
+import { createConfig, http } from "wagmi";
+import { mainnet, polygon } from "wagmi/chains";
+import { airConnector } from "@mocanetwork/airkit-connector";
+import { BUILD_ENV } from "@mocanetwork/airkit";
 
-## 💡 Features
+const config = createConfig({
+  chains: [mainnet, polygon],
+  transports: {
+    [mainnet.id]: http(),
+    [polygon.id]: http(),
+  },
+  connectors: [
+    airConnector({
+      partnerId: YOUR_PARTNER_ID,
+      buildEnv: BUILD_ENV.SANDBOX,
+      enableLogging: true,
+    })
+  ],
+});
+```
 
-- Plug and Play, OAuth based Web3 Authentication Service
-- Fully decentralized, non-custodial key infrastructure
-- Multi Party Computation + Account Abstraction based key management
-- Multi Factor Authentication Setup & Recovery (Includes password, backup phrase, device factor editing/deletion etc)
-- Support for connecting to external wallets like Metamask
-- DApp Active Session Management
+The `airConnector` integrates the Air Kit SDK with wagmi, providing a familiar wagmi interface while leveraging the full power of Air Account Login, Air Id Minting, and Air Account Management.
 
-...and a lot more
+## 🔗 Installation
 
-## How to use
+### Dependencies
 
-Here is an example of a wagmi client using the `MocaverseConnector`.
+This connector requires the following peer dependencies:
 
-```js
-import { WagmiProvider, createConfig, http } from "wagmi";
-import { polygon, optimism, polygonMumbai } from "wagmi/chains";
-import { MocaverseConnector } from "@web3auth/mocaverse-wagmi-connector";
+```shell
+npm install @wagmi/core viem
+```
 
-import { CHAIN_NAMESPACES, WEB3AUTH_NETWORK } from "@web3auth/base";
+### Bundling
 
+This module is distributed in multiple formats:
 
-const web3AuthClientId =
-  "BANbxuTYFGeYi8HxUzaPQkvQlSAXiKRtUqb1vqsXbsZsZKrNr05PEPCM2J2PhUJZpIYl0XzQa6jxUjnYzSU9LXY";
+- `esm` build `dist/airkitConnector.esm.js` in es6 format
+- `commonjs` build `dist/airkitConnector.cjs.js` in es5 format  
+- `umd` build `dist/airkitConnector.umd.min.js` in es5 format minified
 
-const chainConfig = {
-  chainNamespace: CHAIN_NAMESPACES.EIP155,
-  chainId: `0x${polygon.id.toString(16)}`,
-  rpcTarget: polygon.rpcUrls.default.http[0], // This is the public RPC we have added, please pass on your own endpoint while creating an app
-  displayName: polygon.name,
-  tickerName: polygon.nativeCurrency?.name,
-  ticker: polygon.nativeCurrency?.symbol,
-  blockExplorerUrl: polygon.blockExplorers?.default.url[0] as string,
-  logo: "https://cryptologos.cc/logos/polygon-matic-logo.png",
-};
+By default, the appropriate format is used for your specified use case.
 
-// Set up client
-const config = createConfig({
-  chains: [polygon, optimism, polygonMumbai],
-  transports: {
-    [polygon.id]: http(),
-    [optimism.id]: http(),
-    [polygonMumbai.id]: http(),
-  },
-  connectors: [
-    MocaverseConnector({
-      web3AuthClientId,
-      web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET,
-      initParams: {
-        buildEnv: "testing",
-        chainConfig,
-        enableLogging: true,
-      }
-    })
-  ],
-});
+## Usage
+
+Once the connector is configured with your wagmi client, you can use all standard wagmi hooks and functions while the connector handles the Air Kit integration behind the scenes.
+
+### Basic Connection Example
+
+```ts
+import { useConnect, useAccount, useDisconnect } from "wagmi";
+import { airConnector } from "@mocanetwork/airkit-connector";
+
+function App() {
+  const { connect, connectors } = useConnect();
+  const { address, isConnected } = useAccount();
+  const { disconnect } = useDisconnect();
+
+  const handleConnect = () => {
+    connect({ connector: connectors[0] });
+  };
+
+  return (
+    <div>
+      {isConnected ? (
+        <div>
+          <p>Connected to {address}</p>
+          <button onClick={() => disconnect()}>Disconnect</button>
+        </div>
+      ) : (
+        <button onClick={handleConnect}>Connect with Air Kit</button>
+      )}
+    </div>
+  );
+}
+```
+
+### Advanced Connection with Auth Token
+
+```ts
+import { useConnect } from "wagmi";
+import { airConnector } from "@mocanetwork/airkit-connector";
+
+function App() {
+  const { connect, connectors } = useConnect();
+
+  const handleConnectWithAuth = () => {
+    // Connect with a pre-existing auth token
+    connect({ 
+      connector: connectors[0],
+      chainId: 1, // Optional: specify chain
+      authToken: "your-auth-token" // Optional: pass auth token
+    });
+  };
+
+  return (
+    <button onClick={handleConnectWithAuth}>
+      Connect with Auth Token
+    </button>
+  );
+}
+```
+
+### Chain Switching
+
+```ts
+import { useSwitchChain } from "wagmi";
+
+function ChainSwitcher() {
+  const { switchChain } = useSwitchChain();
+
+  const switchToPolygon = () => {
+    switchChain({ chainId: 137 }); // Polygon
+  };
+
+  return (
+    <button onClick={switchToPolygon}>
+      Switch to Polygon
+    </button>
+  );
+}
+```
+
+## 🔧 Configuration
+
+The `airConnector` accepts the following configuration parameters:
+
+```ts
+interface AirConnectorParams {
+  partnerId: string;           // Required: Your Moca Network partner ID
+  buildEnv: BUILD_ENV;         // Required: Environment (staging, production, etc.)
+  enableLogging: boolean;      // Required: Enable/disable logging
+  loginOptions?: {
+    authToken?: string;        // Optional: Pre-existing auth token
+  };
+}
 ```
 
-## 🩹 Examples
+## 🚀 Features
+
+- **Seamless Integration**: Works with all wagmi hooks and functions
+- **Air Kit Power**: Full access to Air Account Login, Air Id Minting, and Account Management
+- **Chain Support**: Automatic chain switching and network management
+- **Session Management**: Handles Air Kit session lifecycle within wagmi
+- **TypeScript Support**: Full TypeScript support with proper type definitions
+
+## 📚 Examples
+
+For complete examples and integration patterns, check out the [Air Kit documentation](https://docs.moca.network/) and the [wagmi documentation](https://wagmi.sh/).
+
+### Live Example
 
-Checkout the examples for your preferred blockchain and platform in our [examples repository](https://github.com/Web3Auth/wallet-ecosystems-examples/)
+- **[Deployed Example App](https://developers.sandbox.air3.com/example)** - See the Air Kit Connector in action
+- **[Source Code](https://github.com/MocaNetwork/airkit-example)** - Complete React + TypeScript example with wagmi integration
 
-## 💬 Troubleshooting and Support
+## 🔗 Related
 
-- 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.
-- Checkout our [Troubleshooting Documentation Page](https://web3auth.io/docs/troubleshooting) to know the common issues and solutions.
-- For Priority Support, please have a look at our [Pricing Page](https://web3auth.io/pricing.html) for the plan that suits your needs
+- [Air Kit SDK](https://github.com/mocanetwork/airkit) - The main Air Kit SDK
+- [wagmi](https://wagmi.sh/) - React Hooks for Ethereum
+- [Moca Network](https://moca.network/) - Learn more about Moca Network

package/dist/airkitConnector.cjs.js

@@ -94,7 +94,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
   var e = new Error(message);
   return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 };
-var version$2 = "1.4.0-beta.2";
+var version$2 = "1.4.0-beta.1";
 var airkitPackage = {
   version: version$2
 };

package/dist/airkitConnector.esm.js

@@ -92,7 +92,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
   var e = new Error(message);
   return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 };
-var version$2 = "1.4.0-beta.2";
+var version$2 = "1.4.0-beta.1";
 var airkitPackage = {
   version: version$2
 };

package/dist/airkitConnector.umd.js

@@ -98,7 +98,7 @@
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
   };
-  var version$2 = "1.4.0-beta.2";
+  var version$2 = "1.4.0-beta.1";
   var airkitPackage = {
     version: version$2
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mocanetwork/airkit-connector",
-  "version": "1.4.0-beta.2",
+  "version": "1.4.2",
   "description": "AirKit wagmi connector to connect with the AirService",
   "main": "dist/airkitConnector.cjs.js",
   "unpkg": "dist/airkitConnector.umd.min.js",
@@ -23,7 +23,7 @@
     "pre-commit": "lint-staged --cwd ."
   },
   "dependencies": {
-    "@mocanetwork/airkit": "^1.4.0-beta.2",
+    "@mocanetwork/airkit": "^1.4.2",
     "@wagmi/core": "^2.x",
     "loglevel": "^1.8.1",
     "viem": "^2.x"