wagmi 0.0.9 → 0.0.13

package/README.md

@@ -13,51 +13,75 @@
   </a>
 </p>
 
+# wagmi
+
+**React Hooks library for Ethereum, built on [ethers.js](https://github.com/ethers-io/ethers.js).**
+
+🚀 &nbsp; Hooks for connecting wallets, signing messages, sending transactions, etc.
+
+💼 &nbsp; Built-in wallet connectors for MetaMask, WalletConnect, and Coinbase Wallet
+
+🌀 &nbsp; Auto-refresh data on wallet and network changes
+
+🦄 &nbsp; TypeScript ready
+
+💨 &nbsp; Zero-dependencies (besides ethers.js peer dependency)
+
+🌳 &nbsp; Test suite and documentation
+
+📖 &nbsp; MIT License
+
 ## Documentation
 
 Visit https://wagmi-xyz.vercel.app to view the full documentation.
 
 ## Usage
 
+1. Install the dependencies.
+
 ```bash
 pnpm add wagmi ethers
 ```
 
-## Development
-
-```bash
-pnpm i
-pnpm dev
-```
+2. Wrap your app with the `Provider` component.
 
-### Docs
+```tsx
+import { Provider } from 'wagmi'
 
-```bash
-pnpm dev:docs
+const App = () => (
+  <Provider>
+    <YourRoutes />
+  </Provider>
+)
 ```
 
-### Examples
+3. Use hooks.
 
-```bash
-pnpm dev:example:next
-pnpm dev:example:vite-react
-```
+```tsx
+import { useAccount } from 'wagmi'
 
-### Testing
+const App = () => {
+  const [{ data, error, loading }, disconnect] = useAccount({
+    fetchEns: true,
+  })
 
-```bash
-pnpm test
-pnpm test:watch
+  return ...
+}
 ```
 
-### CI
-
-[Add secrets](https://github.com/tmm/wagmi/settings/secrets/actions) to GitHub:
+Every 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.
 
-```
-NPM_TOKEN
-```
+Want 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).
 
 ## Thanks
 
 - [ricmoo.eth](https://twitter.com/ricmoo) for creating and continued work on [ethers.js](https://github.com/ethers-io/ethers.js)
+- [Mirror](https://mirror.xyz) for creating space to do good work
+
+## License
+
+MIT.
+
+<br />
+
+wagmi

package/dist/declarations/src/context.d.ts

@@ -29,13 +29,22 @@ export declare const Context: React.Context<ContextValue | null>;
 export declare type Props = {
     /** Enables reconnecting to last used connector on mount */
     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: {
         chainId?: number;
         connector?: Connector;
@@ -46,6 +55,6 @@ export declare type Props = {
         connector?: Connector;
     }) => WebSocketProvider);
 };
-export declare const Provider: ({ autoConnect, children, connectors: _connectors, connectorStorageKey, provider: _provider, webSocketProvider: _webSocketProvider, }: React.PropsWithChildren<Props>) => React.FunctionComponentElement<React.ProviderProps<ContextValue | null>>;
+export declare const Provider: ({ autoConnect, children, connectors: connectors_, connectorStorageKey, provider: provider_, webSocketProvider: webSocketProvider_, }: React.PropsWithChildren<Props>) => React.FunctionComponentElement<React.ProviderProps<ContextValue | null>>;
 export declare const useContext: () => ContextValue;
 export {};

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

@@ -1,4 +1,5 @@
 export declare type Config = {
+    /** Fetches ENS for connected account */
     fetchEns?: boolean;
 };
 export declare const useAccount: ({ fetchEns }?: Config) => readonly [{

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

@@ -1,13 +1,18 @@
 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, formatUnits, skip, token, watch, }?: Config) => readonly [{
     readonly data: {
         formatted: string;
         symbol: string;
@@ -16,7 +21,7 @@ export declare const useBalance: ({ address, formatUnits, skip, token, watch, }?
     readonly error: Error | undefined;
     readonly loading: boolean | undefined;
 }, (config?: {
-    address: string;
+    addressOrName: string;
     formatUnits?: Config['formatUnits'];
     token?: Config['token'];
 } | undefined) => Promise<Error | {

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

@@ -1,5 +1,6 @@
 import { Bytes } from 'ethers/lib/utils';
 export declare type Config = {
+    /** Message to sign with wallet */
     message?: Bytes | string;
 };
 export declare const useSignMessage: ({ message }?: Config) => readonly [{

package/dist/declarations/src/hooks/contracts/index.d.ts

@@ -1,3 +1,5 @@
 export { useContract } from './useContract';
 export { useContractEvent } from './useContractEvent';
+export { useContractRead } from './useContractRead';
+export { useContractWrite as useContractWrite } from './useContractWrite';
 export { useToken } from './useToken';

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

@@ -1,8 +1,11 @@
 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;

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

@@ -1,6 +1,7 @@
 import { ethers } from 'ethers';
 import { Config as UseContractConfig } from './useContract';
 declare type Config = {
+    /** Subscribe to changes */
     watch?: boolean;
 };
 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;

package/dist/declarations/src/hooks/contracts/useContractRead.d.ts

@@ -0,0 +1,17 @@
+import { Overrides, ethers } from 'ethers';
+import { Config as UseContractConfig } from './useContract';
+declare type Config = {
+    args?: any | any[];
+    overrides?: Overrides;
+    skip?: boolean;
+    watch?: boolean;
+};
+export declare const useContractRead: <Contract extends ethers.Contract = ethers.Contract>(contractConfig: UseContractConfig, functionName: string, { args, overrides, skip, watch }?: Config) => readonly [{
+    readonly data: ethers.utils.Result | undefined;
+    readonly error: Error | undefined;
+    readonly loading: boolean | undefined;
+}, (config?: {
+    args?: Config['args'];
+    overrides: Config['overrides'];
+} | undefined) => Promise<any>];
+export {};

package/dist/declarations/src/hooks/contracts/useContractWrite.d.ts

@@ -0,0 +1,15 @@
+import { Overrides, ethers } from 'ethers';
+import { Config as UseContractConfig } from './useContract';
+declare type Config = {
+    args?: any | any[];
+    overrides?: Overrides;
+};
+export declare const useContractWrite: <Contract extends ethers.Contract = ethers.Contract>(contractConfig: UseContractConfig, functionName: string, { args, overrides }?: Config) => readonly [{
+    readonly data: ethers.providers.TransactionResponse | undefined;
+    readonly error: Error | undefined;
+    readonly loading: boolean | undefined;
+}, (config?: {
+    args?: Config['args'];
+    overrides: Config['overrides'];
+} | undefined) => Promise<any>];
+export {};

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

@@ -1,5 +1,7 @@
 declare type Config = {
+    /** Address or ENS name */
     addressOrName?: string | null;
+    /** Disables fetching */
     skip?: boolean;
 };
 export declare const useEnsAvatar: ({ addressOrName, skip }?: Config) => readonly [{

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

@@ -1,5 +1,7 @@
 declare type Config = {
+    /** Address to look up */
     address?: string;
+    /** Disables fetching */
     skip?: boolean;
 };
 export declare const useEnsLookup: ({ address, skip }?: Config) => readonly [{

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

@@ -1,6 +1,8 @@
 import { EnsResolver } from '@ethersproject/providers';
 declare type Config = {
+    /** ENS name */
     name?: string | null;
+    /** Disables fetching */
     skip?: boolean;
 };
 export declare const useEnsResolver: ({ name, skip }?: Config) => readonly [{

package/dist/declarations/src/hooks/index.d.ts

@@ -1,5 +1,5 @@
 export { useAccount, useBalance, useConnect, useNetwork, useSignMessage, } from './accounts';
-export { useContract, useContractEvent, useToken } from './contracts';
+export { useContract, useContractEvent, useContractRead, useContractWrite, useToken, } from './contracts';
 export { useEnsAvatar, useEnsLookup, useEnsResolver } from './ens';
 export { useBlockNumber, useFeeData } from './network-status';
 export { useProvider, useWebSocketProvider } from './providers';

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

@@ -1,5 +1,7 @@
 declare type Config = {
+    /** Disables fetching */
     skip?: boolean;
+    /** Subscribe to changes */
     watch?: boolean;
 };
 export declare const useBlockNumber: ({ skip, watch }?: Config) => readonly [{

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

@@ -1,8 +1,11 @@
 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;
 };
 export declare const useFeeData: ({ formatUnits, skip, watch, }?: Config) => readonly [{

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

@@ -1,5 +1,6 @@
 import { TransactionRequest, TransactionResponse } from '@ethersproject/providers';
 export declare type Config = {
+    /** Object to use when creating transaction */
     request?: TransactionRequest;
 };
 export declare const useTransaction: ({ request }?: Config) => readonly [{

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

@@ -1,12 +1,19 @@
 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'];
 };
-export declare const useWaitForTransaction: ({ confirmations, hash, skip, timeout, wait: _wait, }?: Config) => readonly [{
+export declare const useWaitForTransaction: ({ confirmations, hash, skip, timeout, wait: wait_, }?: Config) => readonly [{
     readonly data: TransactionReceipt | undefined;
     readonly error: Error | undefined;
     readonly loading: boolean | undefined;

package/dist/declarations/src/index.d.ts

@@ -1,5 +1,5 @@
 export { Provider, useContext } from './context';
 export type { Props as ProviderProps } from './context';
-export { useAccount, useBalance, useBlockNumber, useConnect, useContract, useContractEvent, useEnsAvatar, useEnsLookup, useEnsResolver, useFeeData, useNetwork, useProvider, useSignMessage, useToken, useTransaction, useWaitForTransaction, useWebSocketProvider, } from './hooks';
+export { useAccount, useBalance, useBlockNumber, useConnect, useContract, useContractEvent, useContractRead, useContractWrite, useEnsAvatar, useEnsLookup, useEnsResolver, useFeeData, useNetwork, useProvider, useSignMessage, useToken, useTransaction, useWaitForTransaction, useWebSocketProvider, } from './hooks';
 export { Connector, InjectedConnector, WalletConnectConnector, WalletLinkConnector, chain, defaultChains, defaultL2Chains, developmentChains, erc1155ABI, erc20ABI, erc721ABI, normalizeChainId, } from 'wagmi-private';
 export type { Chain, Data } from 'wagmi-private';