wagmi 0.2.15 → 0.2.16

package/README.md

@@ -29,19 +29,15 @@
 
 **React Hooks library for Ethereum, built on [ethers.js](https://github.com/ethers-io/ethers.js).**
 
-🚀   20+ hooks for working with wallets, ENS, contracts, transactions, signing, etc.
+## Features
 
-💼   Built-in wallet connectors for MetaMask, WalletConnect, and Coinbase Wallet
-
-🌀   Auto-refresh data on wallet and network changes
-
-🦄   TypeScript ready
-
-💨   Zero-dependencies (besides ethers.js peer dependency)
-
-🌳   Test suite and documentation
-
-📖   MIT License
+- 🚀 20+ hooks for working with wallets, ENS, contracts, transactions, signing, etc.
+- 💼 Built-in wallet connectors for MetaMask, WalletConnect, and Coinbase Wallet
+- 🌀 Auto-refresh data on wallet and network changes
+- 🦄 TypeScript ready
+- 💨 Zero-dependencies (besides ethers.js peer dependency)
+- 🌳 Test suite and documentation
+- 📖 MIT License
 
 ## Documentation
 
@@ -87,13 +83,16 @@ Want to learn more? Check out the [guides](https://wagmi-xyz.vercel.app/guides/c
 
 ## Community
 
-Feel free to join the [discussions on GitHub](https://github.com/tmm/wagmi/discussions) or reach out [on Twitter](https://twitter.com/awkweb)!
+- Join the [discussions on GitHub](https://github.com/tmm/wagmi/discussions)
+- Follow [@awkweb](https://twitter.com/awkweb) on Twitter for project updates
+- Sign the [guestbook](https://github.com/tmm/wagmi/discussions/2)
+- Share [your project/organization](https://github.com/tmm/wagmi/discussions/201) that uses wagmi
 
 ## Support
 
 - awkweb.eth
 - [GitHub Sponsors](https://github.com/sponsors/tmm)
-- Sign the [guestbook](https://github.com/tmm/wagmi/discussions/2)
+- [Gitcoin Grant](https://gitcoin.co/grants/4493/wagmi-react-hooks-library-for-ethereum)
 
 ## Thanks
 

package/dist/declarations/src/hooks/accounts/useBalance.d.ts

@@ -1,17 +1,11 @@
 import { BigNumber } from 'ethers';
-import { Unit } from 'wagmi-core';
+import { BalanceActionArgs } from 'wagmi-core';
 export declare type Config = {
-    /** Address or ENS name */
-    addressOrName?: string;
-    /** Units for formatting output */
-    formatUnits?: Unit | number;
     /** Disables fetching */
     skip?: boolean;
-    /** ERC-20 address */
-    token?: string;
     /** Subscribe to changes */
     watch?: boolean;
-};
+} & Partial<BalanceActionArgs['config']>;
 export declare const useBalance: ({ addressOrName, formatUnits, skip, token, watch, }?: Config) => readonly [{
     readonly data: {
         decimals: number;
@@ -26,12 +20,7 @@ export declare const useBalance: ({ addressOrName, formatUnits, skip, token, wat
     formatUnits?: Config['formatUnits'];
     token?: Config['token'];
 } | undefined) => Promise<{
-    data: {
-        decimals: number;
-        formatted: string;
-        symbol: string;
-        value: BigNumber;
-    };
+    data: import("wagmi-core").Balance;
     error: undefined;
 } | {
     data: undefined;

package/dist/wagmi.cjs.dev.js

@@ -755,7 +755,7 @@ var useBalance = function useBalance() {
       });
 
       try {
-        var _config_$formatUnits;
+        var _connector$chains;
 
         var config_ = config !== null && config !== void 0 ? config : {
           addressOrName,
@@ -763,57 +763,29 @@ var useBalance = function useBalance() {
           token
         };
         if (!config_.addressOrName) throw new Error('address is required');
-        var formatUnits_ = (_config_$formatUnits = config_.formatUnits) !== null && _config_$formatUnits !== void 0 ? _config_$formatUnits : 'ether';
         setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
           error: undefined,
           loading: true
         }));
-        var balance;
-
-        if (config_.token) {
-          var contract = new ethers.ethers.Contract(config_.token, wagmiCore.erc20ABI, provider);
-          var [value, decimals, symbol] = yield Promise.all([contract.balanceOf(config_.addressOrName), contract.decimals(), contract.symbol()]);
-          balance = {
-            decimals,
-            formatted: ethers.utils.formatUnits(value, formatUnits_),
-            symbol,
-            value
-          };
-        } else {
-          var _connector$chains, _chain$nativeCurrency, _chain$nativeCurrency2, _chain$nativeCurrency3, _chain$nativeCurrency4;
-
-          var _value = yield provider.getBalance(config_.addressOrName);
-
-          var chain = [...((_connector$chains = connector === null || connector === void 0 ? void 0 : connector.chains) !== null && _connector$chains !== void 0 ? _connector$chains : []), ...wagmiCore.defaultChains, ...wagmiCore.defaultL2Chains].find(x => x.id === provider.network.chainId);
-          balance = {
-            decimals: (_chain$nativeCurrency = chain === null || chain === void 0 ? void 0 : (_chain$nativeCurrency2 = chain.nativeCurrency) === null || _chain$nativeCurrency2 === void 0 ? void 0 : _chain$nativeCurrency2.decimals) !== null && _chain$nativeCurrency !== void 0 ? _chain$nativeCurrency : 18,
-            formatted: ethers.utils.formatUnits(_value, formatUnits_),
-            symbol: (_chain$nativeCurrency3 = chain === null || chain === void 0 ? void 0 : (_chain$nativeCurrency4 = chain.nativeCurrency) === null || _chain$nativeCurrency4 === void 0 ? void 0 : _chain$nativeCurrency4.symbol) !== null && _chain$nativeCurrency3 !== void 0 ? _chain$nativeCurrency3 : 'ETH',
-            value: _value
-          };
-        }
-
-        if (!didCancel) {
-          setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
-            balance,
-            loading: false
-          }));
-        }
-
+        var balance = yield wagmiCore.balanceAction({
+          chains: [...((_connector$chains = connector === null || connector === void 0 ? void 0 : connector.chains) !== null && _connector$chains !== void 0 ? _connector$chains : []), ...wagmiCore.defaultChains, ...wagmiCore.defaultL2Chains],
+          config: config_,
+          provider
+        });
+        if (!didCancel) setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
+          balance,
+          loading: false
+        }));
         return {
           data: balance,
           error: undefined
         };
       } catch (error_) {
         var error = error_;
-
-        if (!didCancel) {
-          setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
-            error,
-            loading: false
-          }));
-        }
-
+        if (!didCancel) setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
+          error,
+          loading: false
+        }));
         return {
           data: undefined,
           error

package/dist/wagmi.cjs.prod.js

@@ -755,7 +755,7 @@ var useBalance = function useBalance() {
       });
 
       try {
-        var _config_$formatUnits;
+        var _connector$chains;
 
         var config_ = config !== null && config !== void 0 ? config : {
           addressOrName,
@@ -763,57 +763,29 @@ var useBalance = function useBalance() {
           token
         };
         if (!config_.addressOrName) throw new Error('address is required');
-        var formatUnits_ = (_config_$formatUnits = config_.formatUnits) !== null && _config_$formatUnits !== void 0 ? _config_$formatUnits : 'ether';
         setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
           error: undefined,
           loading: true
         }));
-        var balance;
-
-        if (config_.token) {
-          var contract = new ethers.ethers.Contract(config_.token, wagmiCore.erc20ABI, provider);
-          var [value, decimals, symbol] = yield Promise.all([contract.balanceOf(config_.addressOrName), contract.decimals(), contract.symbol()]);
-          balance = {
-            decimals,
-            formatted: ethers.utils.formatUnits(value, formatUnits_),
-            symbol,
-            value
-          };
-        } else {
-          var _connector$chains, _chain$nativeCurrency, _chain$nativeCurrency2, _chain$nativeCurrency3, _chain$nativeCurrency4;
-
-          var _value = yield provider.getBalance(config_.addressOrName);
-
-          var chain = [...((_connector$chains = connector === null || connector === void 0 ? void 0 : connector.chains) !== null && _connector$chains !== void 0 ? _connector$chains : []), ...wagmiCore.defaultChains, ...wagmiCore.defaultL2Chains].find(x => x.id === provider.network.chainId);
-          balance = {
-            decimals: (_chain$nativeCurrency = chain === null || chain === void 0 ? void 0 : (_chain$nativeCurrency2 = chain.nativeCurrency) === null || _chain$nativeCurrency2 === void 0 ? void 0 : _chain$nativeCurrency2.decimals) !== null && _chain$nativeCurrency !== void 0 ? _chain$nativeCurrency : 18,
-            formatted: ethers.utils.formatUnits(_value, formatUnits_),
-            symbol: (_chain$nativeCurrency3 = chain === null || chain === void 0 ? void 0 : (_chain$nativeCurrency4 = chain.nativeCurrency) === null || _chain$nativeCurrency4 === void 0 ? void 0 : _chain$nativeCurrency4.symbol) !== null && _chain$nativeCurrency3 !== void 0 ? _chain$nativeCurrency3 : 'ETH',
-            value: _value
-          };
-        }
-
-        if (!didCancel) {
-          setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
-            balance,
-            loading: false
-          }));
-        }
-
+        var balance = yield wagmiCore.balanceAction({
+          chains: [...((_connector$chains = connector === null || connector === void 0 ? void 0 : connector.chains) !== null && _connector$chains !== void 0 ? _connector$chains : []), ...wagmiCore.defaultChains, ...wagmiCore.defaultL2Chains],
+          config: config_,
+          provider
+        });
+        if (!didCancel) setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
+          balance,
+          loading: false
+        }));
         return {
           data: balance,
           error: undefined
         };
       } catch (error_) {
         var error = error_;
-
-        if (!didCancel) {
-          setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
-            error,
-            loading: false
-          }));
-        }
-
+        if (!didCancel) setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
+          error,
+          loading: false
+        }));
         return {
           data: undefined,
           error

package/dist/wagmi.esm.js

@@ -1,8 +1,8 @@
 import * as React from 'react';
 import { getDefaultProvider } from '@ethersproject/providers';
-import { erc20ABI, defaultChains, defaultL2Chains, ConnectorAlreadyConnectedError, allChains, SwitchChainError, ConnectorNotFoundError, UserRejectedRequestError, InjectedConnector } from 'wagmi-core';
+import { balanceAction, defaultChains, defaultL2Chains, ConnectorAlreadyConnectedError, allChains, SwitchChainError, ConnectorNotFoundError, UserRejectedRequestError, erc20ABI, InjectedConnector } from 'wagmi-core';
 export { AddChainError, ChainNotConfiguredError, Connector, ConnectorAlreadyConnectedError, ConnectorNotFoundError, InjectedConnector, SwitchChainError, UserRejectedRequestError, allChains, chain, defaultChains, defaultL2Chains, developmentChains, erc1155ABI, erc20ABI, erc721ABI, normalizeChainId } from 'wagmi-core';
-import { utils, ethers, Contract } from 'ethers';
+import { utils, Contract, ethers } from 'ethers';
 
 function _defineProperty(obj, key, value) {
   if (key in obj) {
@@ -732,7 +732,7 @@ var useBalance = function useBalance() {
       });
 
       try {
-        var _config_$formatUnits;
+        var _connector$chains;
 
         var config_ = config !== null && config !== void 0 ? config : {
           addressOrName,
@@ -740,57 +740,29 @@ var useBalance = function useBalance() {
           token
         };
         if (!config_.addressOrName) throw new Error('address is required');
-        var formatUnits_ = (_config_$formatUnits = config_.formatUnits) !== null && _config_$formatUnits !== void 0 ? _config_$formatUnits : 'ether';
         setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
           error: undefined,
           loading: true
         }));
-        var balance;
-
-        if (config_.token) {
-          var contract = new ethers.Contract(config_.token, erc20ABI, provider);
-          var [value, decimals, symbol] = yield Promise.all([contract.balanceOf(config_.addressOrName), contract.decimals(), contract.symbol()]);
-          balance = {
-            decimals,
-            formatted: utils.formatUnits(value, formatUnits_),
-            symbol,
-            value
-          };
-        } else {
-          var _connector$chains, _chain$nativeCurrency, _chain$nativeCurrency2, _chain$nativeCurrency3, _chain$nativeCurrency4;
-
-          var _value = yield provider.getBalance(config_.addressOrName);
-
-          var chain = [...((_connector$chains = connector === null || connector === void 0 ? void 0 : connector.chains) !== null && _connector$chains !== void 0 ? _connector$chains : []), ...defaultChains, ...defaultL2Chains].find(x => x.id === provider.network.chainId);
-          balance = {
-            decimals: (_chain$nativeCurrency = chain === null || chain === void 0 ? void 0 : (_chain$nativeCurrency2 = chain.nativeCurrency) === null || _chain$nativeCurrency2 === void 0 ? void 0 : _chain$nativeCurrency2.decimals) !== null && _chain$nativeCurrency !== void 0 ? _chain$nativeCurrency : 18,
-            formatted: utils.formatUnits(_value, formatUnits_),
-            symbol: (_chain$nativeCurrency3 = chain === null || chain === void 0 ? void 0 : (_chain$nativeCurrency4 = chain.nativeCurrency) === null || _chain$nativeCurrency4 === void 0 ? void 0 : _chain$nativeCurrency4.symbol) !== null && _chain$nativeCurrency3 !== void 0 ? _chain$nativeCurrency3 : 'ETH',
-            value: _value
-          };
-        }
-
-        if (!didCancel) {
-          setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
-            balance,
-            loading: false
-          }));
-        }
-
+        var balance = yield balanceAction({
+          chains: [...((_connector$chains = connector === null || connector === void 0 ? void 0 : connector.chains) !== null && _connector$chains !== void 0 ? _connector$chains : []), ...defaultChains, ...defaultL2Chains],
+          config: config_,
+          provider
+        });
+        if (!didCancel) setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
+          balance,
+          loading: false
+        }));
         return {
           data: balance,
           error: undefined
         };
       } catch (error_) {
         var error = error_;
-
-        if (!didCancel) {
-          setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
-            error,
-            loading: false
-          }));
-        }
-
+        if (!didCancel) setState(x => _objectSpread2(_objectSpread2({}, x), {}, {
+          error,
+          loading: false
+        }));
         return {
           data: undefined,
           error

package/package.json

@@ -2,7 +2,7 @@
   "name": "wagmi",
   "description": "React Hooks library for Ethereum",
   "license": "MIT",
-  "version": "0.2.15",
+  "version": "0.2.16",
   "ethereum": "awkweb.eth",
   "repository": "tmm/wagmi",
   "homepage": "https://wagmi-xyz.vercel.app",
@@ -47,17 +47,17 @@
   "dependencies": {
     "@ethersproject/providers": "^5.5.1",
     "@walletconnect/ethereum-provider": "1.7.1",
-    "wagmi-core": "0.1.11",
+    "wagmi-core": "0.1.12",
     "walletlink": "^2.2.8"
   },
   "devDependencies": {
     "@testing-library/react-hooks": "^7.0.2",
     "@types/react": "^17.0.0",
-    "wagmi-testing": "0.1.11",
+    "wagmi-testing": "0.1.12",
     "@walletconnect/ethereum-provider": "1.7.1",
     "ethers": "^5.5.1",
     "react": "^17.0.0",
     "walletlink": "^2.2.8"
   },
-  "readme": "<p>\n  <a aria-label=\"Version\" href=\"https://www.npmjs.com/package/wagmi\">\n    <img\n      alt=\"\"\n      src=\"https://img.shields.io/npm/v/wagmi.svg?style=for-the-badge&labelColor=161c22\"\n    />\n  </a>\n  <a aria-label=\"License\" href=\"/LICENSE\">\n    <img\n      alt=\"\"\n      src=\"https://img.shields.io/npm/l/wagmi.svg?style=for-the-badge&labelColor=161c22\"\n    />\n  </a>\n  <a aria-label=\"Sponsors\" href=\"https://github.com/sponsors/tmm\">\n    <img\n      alt=\"\"\n      src=\"https://img.shields.io/github/sponsors/tmm.svg?style=for-the-badge&labelColor=161c22\"\n    />\n  </a>\n  <a aria-label=\"Downloads\" href=\"https://www.npmjs.com/package/wagmi\">\n    <img\n      alt=\"\"\n      src=\"https://img.shields.io/npm/dm/wagmi.svg?style=for-the-badge&labelColor=161c22\"\n    />\n  </a>\n</p>\n\n# wagmi\n\n**React Hooks library for Ethereum, built on [ethers.js](https://github.com/ethers-io/ethers.js).**\n\n🚀 &nbsp; 20+ hooks for working with wallets, ENS, contracts, transactions, signing, etc.\n\n💼 &nbsp; Built-in wallet connectors for MetaMask, WalletConnect, and Coinbase Wallet\n\n🌀 &nbsp; Auto-refresh data on wallet and network changes\n\n🦄 &nbsp; TypeScript ready\n\n💨 &nbsp; Zero-dependencies (besides ethers.js peer dependency)\n\n🌳 &nbsp; Test suite and documentation\n\n📖 &nbsp; MIT License\n\n## Documentation\n\nVisit https://wagmi-xyz.vercel.app to view the full documentation.\n\n## Usage\n\n1. Install the dependencies.\n\n```bash\nnpm add wagmi ethers\n```\n\n2. Wrap your app with the `Provider` component.\n\n```tsx\nimport { Provider } from 'wagmi'\n\nconst App = () => (\n  <Provider>\n    <YourRoutes />\n  </Provider>\n)\n```\n\n3. Use hooks.\n\n```tsx\nimport { useAccount } from 'wagmi'\n\nconst Page = () => {\n  const [{ data, error, loading }, disconnect] = useAccount({\n    fetchEns: true,\n  })\n\n  return ...\n}\n```\n\nEvery component inside the `Provider` is set up with the default `InjectedConnector` for connecting wallets and ethers.js [Default Provider](https://docs.ethers.io/v5/api/providers/#providers-getDefaultProvider) for fetching data.\n\nWant to learn more? Check out the [guides](https://wagmi-xyz.vercel.app/guides/connect-wallet) or browse the [API docs](https://wagmi-xyz.vercel.app/docs/provider).\n\n## Community\n\nFeel free to join the [discussions on GitHub](https://github.com/tmm/wagmi/discussions) or reach out [on Twitter](https://twitter.com/awkweb)!\n\n## Support\n\n- awkweb.eth\n- [GitHub Sponsors](https://github.com/sponsors/tmm)\n- Sign the [guestbook](https://github.com/tmm/wagmi/discussions/2)\n\n## Thanks\n\n- [ricmoo.eth](https://twitter.com/ricmoo) for creating and continued work on [ethers.js](https://github.com/ethers-io/ethers.js)\n- [Mirror](https://mirror.xyz) for creating space to do good work\n\n## License\n\nMIT.\n\n<br />\n\nwagmi\n"
+  "readme": "<p>\n  <a aria-label=\"Version\" href=\"https://www.npmjs.com/package/wagmi\">\n    <img\n      alt=\"\"\n      src=\"https://img.shields.io/npm/v/wagmi.svg?style=for-the-badge&labelColor=161c22\"\n    />\n  </a>\n  <a aria-label=\"License\" href=\"/LICENSE\">\n    <img\n      alt=\"\"\n      src=\"https://img.shields.io/npm/l/wagmi.svg?style=for-the-badge&labelColor=161c22\"\n    />\n  </a>\n  <a aria-label=\"Sponsors\" href=\"https://github.com/sponsors/tmm\">\n    <img\n      alt=\"\"\n      src=\"https://img.shields.io/github/sponsors/tmm.svg?style=for-the-badge&labelColor=161c22\"\n    />\n  </a>\n  <a aria-label=\"Downloads\" href=\"https://www.npmjs.com/package/wagmi\">\n    <img\n      alt=\"\"\n      src=\"https://img.shields.io/npm/dm/wagmi.svg?style=for-the-badge&labelColor=161c22\"\n    />\n  </a>\n</p>\n\n# wagmi\n\n**React Hooks library for Ethereum, built on [ethers.js](https://github.com/ethers-io/ethers.js).**\n\n## Features\n\n- 🚀 20+ hooks for working with wallets, ENS, contracts, transactions, signing, etc.\n- 💼 Built-in wallet connectors for MetaMask, WalletConnect, and Coinbase Wallet\n- 🌀 Auto-refresh data on wallet and network changes\n- 🦄 TypeScript ready\n- 💨 Zero-dependencies (besides ethers.js peer dependency)\n- 🌳 Test suite and documentation\n- 📖 MIT License\n\n## Documentation\n\nVisit https://wagmi-xyz.vercel.app to view the full documentation.\n\n## Usage\n\n1. Install the dependencies.\n\n```bash\nnpm add wagmi ethers\n```\n\n2. Wrap your app with the `Provider` component.\n\n```tsx\nimport { Provider } from 'wagmi'\n\nconst App = () => (\n  <Provider>\n    <YourRoutes />\n  </Provider>\n)\n```\n\n3. Use hooks.\n\n```tsx\nimport { useAccount } from 'wagmi'\n\nconst Page = () => {\n  const [{ data, error, loading }, disconnect] = useAccount({\n    fetchEns: true,\n  })\n\n  return ...\n}\n```\n\nEvery component inside the `Provider` is set up with the default `InjectedConnector` for connecting wallets and ethers.js [Default Provider](https://docs.ethers.io/v5/api/providers/#providers-getDefaultProvider) for fetching data.\n\nWant to learn more? Check out the [guides](https://wagmi-xyz.vercel.app/guides/connect-wallet) or browse the [API docs](https://wagmi-xyz.vercel.app/docs/provider).\n\n## Community\n\n- Join the [discussions on GitHub](https://github.com/tmm/wagmi/discussions)\n- Follow [@awkweb](https://twitter.com/awkweb) on Twitter for project updates\n- Sign the [guestbook](https://github.com/tmm/wagmi/discussions/2)\n- Share [your project/organization](https://github.com/tmm/wagmi/discussions/201) that uses wagmi\n\n## Support\n\n- awkweb.eth\n- [GitHub Sponsors](https://github.com/sponsors/tmm)\n- [Gitcoin Grant](https://gitcoin.co/grants/4493/wagmi-react-hooks-library-for-ethereum)\n\n## Thanks\n\n- [ricmoo.eth](https://twitter.com/ricmoo) for creating and continued work on [ethers.js](https://github.com/ethers-io/ethers.js)\n- [Mirror](https://mirror.xyz) for creating space to do good work\n\n## License\n\nMIT.\n\n<br />\n\nwagmi\n"
 }