@wagmi/connectors 0.2.3 → 0.2.4

package/README.md

@@ -18,25 +18,11 @@ Configure your wagmi client with connectors!
 import { configureChains, createClient } from 'wagmi'
 
 import { InjectedConnector } from '@wagmi/connectors/injected'
-import { CoinbaseWalletConnector } from '@wagmi/connectors/coinbaseWallet'
-import { WalletConnectConnector } from '@wagmi/connectors/walletConnect'
 
 const { chains, provider } = configureChains(...)
 
 const client = createClient({
   connectors: [
-    new CoinbaseWalletConnector({
-      chains,
-      options: {
-        appName: 'wagmi',
-      },
-    }),
-    new WalletConnectConnector({
-      chains,
-      options: {
-        qrcode: true,
-      },
-    }),
     new InjectedConnector({ chains }),
   ],
   provider,
@@ -52,6 +38,7 @@ const client = createClient({
 - [`LedgerConnector`](/packages/connectors/src/ledger.ts)
 - [`MetaMaskConnector`](/packages/connectors/src/metaMask.ts)
 - [`MockConnector`](/packages/connectors/src/mock.ts)
+- [`SafeConnector`](/packages/connectors/src/safe.ts)
 - [`WalletConnectConnector`](/packages/connectors/src/walletConnect.ts)
 
 ## Contributing

package/dist/{chunk-LNIFBRWC.js → chunk-6IU3YKWQ.js}

@@ -98,7 +98,7 @@ var InjectedConnector = class extends Connector {
     __publicField(this, "ready");
     __privateAdd(this, _provider, void 0);
     __privateAdd(this, _switchingChains, void 0);
-    __publicField(this, "shimDisconnectKey", "injected.shimDisconnect");
+    __publicField(this, "shimDisconnectKey", `${this.id}.shimDisconnect`);
     __publicField(this, "onAccountsChanged", (accounts) => {
       if (accounts.length === 0)
         this.emit("disconnect");

package/dist/injected.js

@@ -1,6 +1,6 @@
 import {
   InjectedConnector
-} from "./chunk-LNIFBRWC.js";
+} from "./chunk-6IU3YKWQ.js";
 import "./chunk-5NCTPR6C.js";
 export {
   InjectedConnector

package/dist/metaMask.js

@@ -1,6 +1,6 @@
 import {
   InjectedConnector
-} from "./chunk-LNIFBRWC.js";
+} from "./chunk-6IU3YKWQ.js";
 import {
   __privateAdd,
   __privateGet,

package/dist/safe.d.ts

@@ -0,0 +1,53 @@
+import { SafeAppProvider } from '@safe-global/safe-apps-provider';
+import { Opts } from '@safe-global/safe-apps-sdk';
+import { Chain } from '@wagmi/core';
+import { providers } from 'ethers';
+import { C as Connector } from './base-84a689bb.js';
+import '@wagmi/core/chains';
+import 'eventemitter3';
+
+type SafeConnectorProvider = SafeAppProvider;
+type SafeConnectorOptions = Opts & {
+    /**
+     * Connector automatically connects when used as Safe App.
+     *
+     * This flag simulates the disconnect behavior by keeping track of connection status in storage
+     * and only autoconnecting when previously connected by user action (e.g. explicitly choosing to connect).
+     *
+     * @default false
+     */
+    shimDisconnect?: boolean;
+};
+/**
+ * Connector for [Safe Wallet](https://safe.global)
+ */
+declare class SafeConnector extends Connector<SafeConnectorProvider, SafeConnectorOptions> {
+    #private;
+    readonly id = "safe";
+    readonly name = "Safe";
+    ready: boolean;
+    protected shimDisconnectKey: string;
+    constructor({ chains, options: options_, }: {
+        chains?: Chain[];
+        options?: SafeConnectorOptions;
+    });
+    connect(): Promise<{
+        account: `0x${string}`;
+        provider: SafeAppProvider;
+        chain: {
+            id: number;
+            unsupported: boolean;
+        };
+    }>;
+    disconnect(): Promise<void>;
+    getAccount(): Promise<`0x${string}`>;
+    getChainId(): Promise<number>;
+    getProvider(): Promise<SafeAppProvider>;
+    getSigner(): Promise<providers.JsonRpcSigner>;
+    isAuthorized(): Promise<boolean>;
+    protected onAccountsChanged(_accounts: string[]): void;
+    protected onChainChanged(_chainId: string | number): void;
+    protected onDisconnect(): void;
+}
+
+export { SafeConnector, SafeConnectorOptions, SafeConnectorProvider };

package/dist/safe.js

@@ -0,0 +1,119 @@
+import {
+  Connector,
+  __privateAdd,
+  __privateGet,
+  __privateSet,
+  __publicField
+} from "./chunk-5NCTPR6C.js";
+
+// src/safe.ts
+import { SafeAppProvider } from "@safe-global/safe-apps-provider";
+import { default as SafeAppsSDK } from "@safe-global/safe-apps-sdk";
+import {
+  ConnectorNotFoundError,
+  getClient,
+  normalizeChainId
+} from "@wagmi/core";
+import { providers } from "ethers";
+import { getAddress } from "ethers/lib/utils.js";
+var _provider, _sdk;
+var SafeConnector = class extends Connector {
+  constructor({
+    chains,
+    options: options_
+  }) {
+    const options = {
+      shimDisconnect: false,
+      ...options_
+    };
+    super({ chains, options });
+    __publicField(this, "id", "safe");
+    __publicField(this, "name", "Safe");
+    __publicField(this, "ready", !(typeof window === "undefined") && window?.parent !== window);
+    __privateAdd(this, _provider, void 0);
+    __privateAdd(this, _sdk, void 0);
+    __publicField(this, "shimDisconnectKey", `${this.id}.shimDisconnect`);
+    __privateSet(this, _sdk, new SafeAppsSDK(options));
+  }
+  async connect() {
+    const provider = await this.getProvider();
+    if (!provider)
+      throw new ConnectorNotFoundError();
+    if (provider.on) {
+      provider.on("accountsChanged", this.onAccountsChanged);
+      provider.on("chainChanged", this.onChainChanged);
+      provider.on("disconnect", this.onDisconnect);
+    }
+    this.emit("message", { type: "connecting" });
+    const account = await this.getAccount();
+    const id = await this.getChainId();
+    if (this.options.shimDisconnect)
+      getClient().storage?.setItem(this.shimDisconnectKey, true);
+    return {
+      account,
+      provider,
+      chain: { id, unsupported: this.isChainUnsupported(id) }
+    };
+  }
+  async disconnect() {
+    const provider = await this.getProvider();
+    if (!provider?.removeListener)
+      return;
+    provider.removeListener("accountsChanged", this.onAccountsChanged);
+    provider.removeListener("chainChanged", this.onChainChanged);
+    provider.removeListener("disconnect", this.onDisconnect);
+    if (this.options.shimDisconnect)
+      getClient().storage?.removeItem(this.shimDisconnectKey);
+  }
+  async getAccount() {
+    const provider = await this.getProvider();
+    if (!provider)
+      throw new ConnectorNotFoundError();
+    const accounts = await provider.request({
+      method: "eth_accounts"
+    });
+    return getAddress(accounts[0]);
+  }
+  async getChainId() {
+    const provider = await this.getProvider();
+    if (!provider)
+      throw new ConnectorNotFoundError();
+    return normalizeChainId(provider.chainId);
+  }
+  async getProvider() {
+    if (!__privateGet(this, _provider)) {
+      const safe = await __privateGet(this, _sdk).safe.getInfo();
+      if (!safe)
+        throw new Error("Could not load Safe information");
+      __privateSet(this, _provider, new SafeAppProvider(safe, __privateGet(this, _sdk)));
+    }
+    return __privateGet(this, _provider);
+  }
+  async getSigner() {
+    const provider = await this.getProvider();
+    const account = await this.getAccount();
+    return new providers.Web3Provider(provider).getSigner(account);
+  }
+  async isAuthorized() {
+    try {
+      if (this.options.shimDisconnect && !getClient().storage?.getItem(this.shimDisconnectKey))
+        return false;
+      const account = await this.getAccount();
+      return !!account;
+    } catch {
+      return false;
+    }
+  }
+  onAccountsChanged(_accounts) {
+  }
+  onChainChanged(_chainId) {
+  }
+  onDisconnect() {
+    this.emit("disconnect");
+  }
+};
+_provider = new WeakMap();
+_sdk = new WeakMap();
+export {
+  SafeConnector
+};

package/package.json

@@ -2,10 +2,10 @@
   "name": "@wagmi/connectors",
   "description": "A collection of connectors for wagmi",
   "license": "MIT",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "peerDependencies": {
     "@wagmi/core": ">=0.9.x",
-    "ethers": ">=5.5.1",
+    "ethers": ">=5.5.1 <6",
     "typescript": ">=4.9.4"
   },
   "peerDependenciesMeta": {
@@ -21,6 +21,8 @@
     "@ledgerhq/connect-kit-loader": "^1.0.1",
     "@walletconnect/ethereum-provider": "^1.8.0",
     "@walletconnect/universal-provider": "^2.3.3",
+    "@safe-global/safe-apps-provider": "^0.15.2",
+    "@safe-global/safe-apps-sdk": "^7.9.0",
     "@web3modal/standalone": "^2.0.0",
     "abitype": "^0.3.0",
     "eventemitter3": "^4.0.7"
@@ -57,6 +59,10 @@
       "types": "./dist/mock/index.d.ts",
       "default": "./dist/mock/index.js"
     },
+    "./safe": {
+      "types": "./dist/safe.d.ts",
+      "default": "./dist/safe.js"
+    },
     "./walletConnect": {
       "types": "./dist/walletConnect.d.ts",
       "default": "./dist/walletConnect.js"
@@ -69,6 +75,7 @@
     "/ledger",
     "/metaMask",
     "/mock",
+    "/safe",
     "/walletConnect",
     "/dist"
   ],

package/safe/package.json

@@ -0,0 +1,4 @@
+{
+  "type": "module",
+  "main": "../dist/safe.js"
+}