wagmi - npm Package Compare versions

Comparing version 0.0.10 to 0.0.11

dist/declarations/src/context.d.ts

@@ -32,9 +32,18 @@ import * as React from 'react';
     autoConnect?: boolean;
-    /** Key for saving connector preference to browser */
+    /**
+     * Key for saving connector preference to browser
+     * @default 'wagmi.wallet'
+     */
     connectorStorageKey?: string;
-    /** Connectors used for linking accounts */
+    /**
+     * Connectors used for linking accounts
+     * @default [new InjectedConnector()]
+     */
     connectors?: Connector[] | ((config: {
         chainId?: number;
     }) => Connector[]);
-    /** Interface for connecting to network */
+    /**
+     * Interface for connecting to network
+     * @default getDefaultProvider()
+     */
     provider?: BaseProvider | ((config: {
@@ -41,0 +50,0 @@ chainId?: number;

dist/declarations/src/hooks/accounts/useAccount.d.ts

 export declare type Config = {
+    /** Fetches ENS for connected account */
     fetchEns?: boolean;
@@ -3,0 +4,0 @@ };

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

 import { BigNumber } from 'ethers';
 import { Unit } from 'wagmi-private';
 export declare type Config = {
-    address?: string;
+    /** 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;
 };
-export declare const useBalance: ({ address, formatUnits, skip, token, watch, }?: Config) => readonly [{
+export declare const useBalance: ({ addressOrName: address, formatUnits, skip, token, watch, }?: Config) => readonly [{
     readonly data: {
@@ -12,0 +17,0 @@ formatted: string;

dist/declarations/src/hooks/accounts/useSignMessage.d.ts

 import { Bytes } from 'ethers/lib/utils';
 export declare type Config = {
+    /** Message to sign with wallet */
     message?: Bytes | string;
@@ -4,0 +5,0 @@ };

dist/declarations/src/hooks/contracts/useContract.d.ts

 import { ContractInterface, Signer } from 'ethers';
 import { Provider } from '@ethersproject/providers';
 export declare type Config = {
+    /** Contract address or ENS name */
     addressOrName: string;
+    /** Contract interface or ABI */
     contractInterface: ContractInterface;
+    /** Signer or provider to attach to contract */
     signerOrProvider?: Signer | Provider;
 };
 export declare const useContract: <Contract_1 = any>({ addressOrName, contractInterface, signerOrProvider, }: Config) => Contract_1;

dist/declarations/src/hooks/contracts/useContractEvent.d.ts

 import { ethers } from 'ethers';
 import { Config as UseContractConfig } from './useContract';
 declare type Config = {
+    /** Subscribe to changes */
     watch?: boolean;
@@ -5,0 +6,0 @@ };

dist/declarations/src/hooks/ens/useEnsAvatar.d.ts

 declare type Config = {
+    /** Address or ENS name */
     addressOrName?: string | null;
+    /** Disables fetching */
     skip?: boolean;
@@ -4,0 +6,0 @@ };

dist/declarations/src/hooks/ens/useEnsLookup.d.ts

 declare type Config = {
+    /** Address to look up */
     address?: string;
+    /** Disables fetching */
     skip?: boolean;
@@ -4,0 +6,0 @@ };

dist/declarations/src/hooks/ens/useEnsResolver.d.ts

 import { EnsResolver } from '@ethersproject/providers';
 declare type Config = {
+    /** ENS name */
     name?: string | null;
+    /** Disables fetching */
     skip?: boolean;
@@ -5,0 +7,0 @@ };

dist/declarations/src/hooks/network-status/useBlockNumber.d.ts

 declare type Config = {
+    /** Disables fetching */
     skip?: boolean;
+    /** Subscribe to changes */
     watch?: boolean;
@@ -4,0 +6,0 @@ };

dist/declarations/src/hooks/network-status/useFeeData.d.ts

 import { FeeData } from '@ethersproject/providers';
 import { Unit } from 'wagmi-private';
 declare type Config = {
+    /** Units for formatting output */
     formatUnits?: Unit | number;
+    /** Disables fetching */
     skip?: boolean;
+    /** Subscribe to changes */
     watch?: boolean;
@@ -7,0 +10,0 @@ };

dist/declarations/src/hooks/transactions/useTransaction.d.ts

 import { TransactionRequest, TransactionResponse } from '@ethersproject/providers';
 export declare type Config = {
+    /** Object to use when creating transaction */
     request?: TransactionRequest;
@@ -4,0 +5,0 @@ };

dist/declarations/src/hooks/transactions/useWaitForTransaction.d.ts

 import { TransactionReceipt, TransactionResponse } from '@ethersproject/providers';
 export declare type Config = {
+    /**
+     * Number of blocks to wait for after transaction is mined
+     * @default 1
+     */
     confirmations?: number;
+    /** Transaction hash to monitor */
     hash?: string;
+    /** Disables fetching */
     skip?: boolean;
     timeout?: number;
+    /** Function resolving to transaction receipt */
     wait?: TransactionResponse['wait'];
@@ -8,0 +15,0 @@ };

dist/wagmi.cjs.dev.js

@@ -555,3 +555,3 @@ 'use strict';
   var {
-    address,
+    addressOrName: address,
     formatUnits = 'ether',
@@ -558,0 +558,0 @@ skip,

dist/wagmi.cjs.prod.js

@@ -555,3 +555,3 @@ 'use strict';
   var {
-    address,
+    addressOrName: address,
     formatUnits = 'ether',
@@ -558,0 +558,0 @@ skip,

dist/wagmi.esm.js

@@ -532,3 +532,3 @@ import * as React from 'react';
   var {
-    address,
+    addressOrName: address,
     formatUnits = 'ether',
@@ -535,0 +535,0 @@ skip,

package.json

@@ -5,3 +5,3 @@ {
   "license": "MIT",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "ethereum": "awkweb.eth",
@@ -35,3 +35,3 @@ "repository": "tmm/wagmi",
     "@ethersproject/providers": "^5.5.1",
-    "wagmi-private": "0.0.10",
+    "wagmi-private": "0.0.11",
     "walletlink": "^2.2.8"
@@ -46,5 +46,5 @@ },
     "walletlink": "^2.2.8",
-    "wagmi-testing": "0.0.10"
+    "wagmi-testing": "0.0.11"
   },
-  "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: MetaMask, WalletConnect, 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\n```bash\npnpm add wagmi ethers\n```\n\n## Development\n\n```bash\npnpm i\npnpm dev\n```\n\n### Docs\n\n```bash\npnpm dev:docs\n```\n\n### Examples\n\n```bash\npnpm dev:example:next\npnpm dev:example:vite-react\n```\n\n### Testing\n\n```bash\npnpm test\npnpm test:watch\n```\n\n### CI\n\n[Add secrets](https://github.com/tmm/wagmi/settings/secrets/actions) to GitHub:\n\n```\nNPM_TOKEN\n```\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\n<br />\n\nwagmi\n"
+  "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\n```bash\npnpm add wagmi ethers\n```\n\n## Development\n\n```bash\npnpm i\npnpm dev\n```\n\n### Docs\n\n```bash\npnpm dev:docs\n```\n\n### Examples\n\n```bash\npnpm dev:example:next\npnpm dev:example:vite-react\n```\n\n### Testing\n\n```bash\npnpm test\npnpm test:watch\n```\n\n### CI\n\n[Add secrets](https://github.com/tmm/wagmi/settings/secrets/actions) to GitHub:\n\n```\nNPM_TOKEN\n```\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\n<br />\n\nwagmi\n"
 }

README.md

@@ -22,3 +22,3 @@ <p>
 
-💼 &nbsp; Built-in wallet connectors: MetaMask, WalletConnect, Coinbase Wallet
+💼 &nbsp; Built-in wallet connectors for MetaMask, WalletConnect, and Coinbase Wallet
 
@@ -25,0 +25,0 @@ 🌀 &nbsp; Auto-refresh data on wallet and network changes

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

148085

increased by0.83%

Lines of code

4423

increased by0.89%

Dependency changes

• + Addedwagmi-private@0.0.11(transitive)

• - Removedwagmi-private@0.0.10(transitive)

• Updatedwagmi-private@0.0.11