wagmi 0.0.13 → 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -60,7 +60,7 @@ const App = () => (
60
60
  ```tsx
61
61
  import { useAccount } from 'wagmi'
62
62
 
63
- const App = () => {
63
+ const Page = () => {
64
64
  const [{ data, error, loading }, disconnect] = useAccount({
65
65
  fetchEns: true,
66
66
  })
@@ -1,8 +1,8 @@
1
1
  import { ethers } from 'ethers';
2
2
  import { Config as UseContractConfig } from './useContract';
3
3
  declare type Config = {
4
- /** Subscribe to changes */
5
- watch?: boolean;
4
+ /** Receive only a single event */
5
+ once?: boolean;
6
6
  };
7
- export declare const useContractEvent: <Contract extends ethers.Contract = ethers.Contract>(contractConfig: UseContractConfig, eventName: Parameters<Contract["on"]>[0], listener: Parameters<Contract["on"]>[1], { watch }?: Config) => void;
7
+ export declare const useContractEvent: <Contract extends ethers.Contract = ethers.Contract>(contractConfig: UseContractConfig, eventName: Parameters<Contract["on"]>[0], listener: Parameters<Contract["on"]>[1], { once }?: Config) => void;
8
8
  export {};
@@ -880,10 +880,8 @@ var useContract = _ref2 => {
880
880
 
881
881
  var useContractEvent = function useContractEvent(contractConfig, eventName, listener) {
882
882
  var {
883
- watch
884
- } = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {
885
- watch: true
886
- };
883
+ once
884
+ } = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
887
885
  var provider = useProvider();
888
886
  var webSocketProvider = useWebSocketProvider();
889
887
  var contract = useContract(_objectSpread2({
@@ -903,7 +901,7 @@ var useContractEvent = function useContractEvent(contractConfig, eventName, list
903
901
  };
904
902
 
905
903
  var contract_ = ethers.ethers.Contract;
906
- if (!watch) contract_.once(eventName, handler);else contract_.on(eventName, handler);
904
+ if (once) contract_.once(eventName, handler);else contract_.on(eventName, handler);
907
905
  return () => {
908
906
  contract_.off(eventName, handler);
909
907
  return;
@@ -880,10 +880,8 @@ var useContract = _ref2 => {
880
880
 
881
881
  var useContractEvent = function useContractEvent(contractConfig, eventName, listener) {
882
882
  var {
883
- watch
884
- } = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {
885
- watch: true
886
- };
883
+ once
884
+ } = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
887
885
  var provider = useProvider();
888
886
  var webSocketProvider = useWebSocketProvider();
889
887
  var contract = useContract(_objectSpread2({
@@ -903,7 +901,7 @@ var useContractEvent = function useContractEvent(contractConfig, eventName, list
903
901
  };
904
902
 
905
903
  var contract_ = ethers.ethers.Contract;
906
- if (!watch) contract_.once(eventName, handler);else contract_.on(eventName, handler);
904
+ if (once) contract_.once(eventName, handler);else contract_.on(eventName, handler);
907
905
  return () => {
908
906
  contract_.off(eventName, handler);
909
907
  return;
package/dist/wagmi.esm.js CHANGED
@@ -857,10 +857,8 @@ var useContract = _ref2 => {
857
857
 
858
858
  var useContractEvent = function useContractEvent(contractConfig, eventName, listener) {
859
859
  var {
860
- watch
861
- } = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {
862
- watch: true
863
- };
860
+ once
861
+ } = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
864
862
  var provider = useProvider();
865
863
  var webSocketProvider = useWebSocketProvider();
866
864
  var contract = useContract(_objectSpread2({
@@ -880,7 +878,7 @@ var useContractEvent = function useContractEvent(contractConfig, eventName, list
880
878
  };
881
879
 
882
880
  var contract_ = ethers.Contract;
883
- if (!watch) contract_.once(eventName, handler);else contract_.on(eventName, handler);
881
+ if (once) contract_.once(eventName, handler);else contract_.on(eventName, handler);
884
882
  return () => {
885
883
  contract_.off(eventName, handler);
886
884
  return;
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "wagmi",
3
3
  "description": "React Hooks library for Ethereum",
4
4
  "license": "MIT",
5
- "version": "0.0.13",
5
+ "version": "0.0.14",
6
6
  "ethereum": "awkweb.eth",
7
7
  "repository": "tmm/wagmi",
8
8
  "homepage": "https://wagmi-xyz.vercel.app",
@@ -31,7 +31,7 @@
31
31
  "dependencies": {
32
32
  "@walletconnect/ethereum-provider": "^1.6.6",
33
33
  "@ethersproject/providers": "^5.5.1",
34
- "wagmi-private": "0.0.13",
34
+ "wagmi-private": "0.0.14",
35
35
  "walletlink": "^2.2.8"
36
36
  },
37
37
  "devDependencies": {
@@ -41,7 +41,7 @@
41
41
  "ethers": "^5.5.1",
42
42
  "react": "^17.0.0",
43
43
  "walletlink": "^2.2.8",
44
- "wagmi-testing": "0.0.13"
44
+ "wagmi-testing": "0.0.14"
45
45
  },
46
- "readme": "<p>\n <a aria-label=\"NPM 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</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; Hooks for connecting wallets, signing messages, sending transactions, 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\npnpm 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 App = () => {\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## 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"
46
+ "readme": "<p>\n <a aria-label=\"NPM 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</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; Hooks for connecting wallets, signing messages, sending transactions, 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\npnpm 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## 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"
47
47
  }