wagmi 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Tom Meagher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+<p>
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/wagmi">
+    <img
+      alt=""
+      src="https://img.shields.io/npm/v/wagmi.svg?style=for-the-badge&labelColor=161c22"
+    />
+  </a>
+  <a aria-label="License" href="/LICENSE">
+    <img
+      alt=""
+      src="https://img.shields.io/npm/l/degen.svg?style=for-the-badge&labelColor=161c22"
+    />
+  </a>
+</p>
+
+## Documentation
+
+Visit https://wagmi-xyz.vercel.app to view the full documentation.
+
+## Usage
+
+```bash
+pnpm add wagmi ethers
+```
+
+## Development
+
+```bash
+pnpm i
+pnpm dev
+```
+
+### Docs
+
+```bash
+pnpm dev:docs
+```
+
+### Examples
+
+```bash
+pnpm dev:example:vite-react
+pnpm dev:example:next
+```
+
+### Testing
+
+```bash
+pnpm test
+pnpm test:watch
+```
+
+### CI
+
+[Add secrets](https://github.com/tmm/wagmi/settings/secrets/actions) to GitHub:
+
+```
+NPM_TOKEN
+```

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

@@ -0,0 +1,51 @@
+import * as React from 'react';
+import { BaseProvider, WebSocketProvider } from '@ethersproject/providers';
+import { Connector, Data } from 'wagmi-private';
+declare type State = {
+    cacheBuster: number;
+    connector?: Connector;
+    data?: Data;
+    error?: Error;
+};
+declare type ContextValue = {
+    state: {
+        /** Flag for triggering refetch */
+        cacheBuster: State['cacheBuster'];
+        /** Active connector */
+        connector?: State['connector'];
+        /** Connectors used for linking accounts */
+        connectors: Connector[];
+        /** Active data */
+        data?: State['data'];
+        /** Interface for connecting to network */
+        provider: BaseProvider;
+        /** Interface for connecting to network */
+        webSocketProvider?: WebSocketProvider;
+    };
+    setState: React.Dispatch<React.SetStateAction<State>>;
+    setLastUsedConnector: (newValue: string | null) => void;
+};
+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 */
+    connectorStorageKey?: string;
+    /** Connectors used for linking accounts */
+    connectors?: Connector[] | ((config: {
+        chainId?: number;
+    }) => Connector[]);
+    /** Interface for connecting to network */
+    provider?: BaseProvider | ((config: {
+        chainId?: number;
+        connector?: Connector;
+    }) => BaseProvider);
+    /** WebSocket interface for connecting to network */
+    webSocketProvider?: WebSocketProvider | ((config: {
+        chainId?: number;
+        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 useContext: () => ContextValue;
+export {};

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

@@ -0,0 +1,4 @@
+export { useAccount } from './useAccount';
+export { useBalance } from './useBalance';
+export { useConnect } from './useConnect';
+export { useNetwork } from './useNetwork';

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

@@ -0,0 +1,22 @@
+declare type Config = {
+    fetchBalance?: boolean;
+    fetchEns?: boolean;
+};
+export declare const useAccount: ({ fetchBalance, fetchEns }?: Config) => readonly [{
+    readonly data: {
+        address: string;
+        balance: {
+            formatted: string;
+            symbol: string;
+            value: import("ethers").BigNumber;
+        } | undefined;
+        connector: import("wagmi-private").Connector<any, any> | undefined;
+        ens: {
+            avatar: string | null | undefined;
+            name: string;
+        } | undefined;
+    } | undefined;
+    readonly error: Error | undefined;
+    readonly loading: boolean | undefined;
+}, () => void];
+export {};

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

@@ -0,0 +1,27 @@
+import { BigNumber } from 'ethers';
+import { Unit } from 'wagmi-private';
+declare type Config = {
+    address?: string;
+    formatUnits?: Unit | number;
+    skip?: boolean;
+    token?: string;
+    watch?: boolean;
+};
+export declare const useBalance: ({ address, formatUnits, skip, token, watch, }: Config) => readonly [{
+    readonly data: {
+        formatted: string;
+        symbol: string;
+        value: BigNumber;
+    } | undefined;
+    readonly error: Error | undefined;
+    readonly loading: boolean | undefined;
+}, ({ address, formatUnits, token, }: {
+    address: string;
+    formatUnits: Config['formatUnits'];
+    token: Config['token'];
+}) => Promise<Error | {
+    formatted: string;
+    symbol: string;
+    value: BigNumber;
+}>];
+export {};

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

@@ -0,0 +1,13 @@
+import { Connector } from 'wagmi-private';
+export declare const useConnect: () => readonly [{
+    readonly data: {
+        readonly connected: boolean;
+        readonly connector: Connector<any, any> | undefined;
+        readonly connectors: Connector<any, any>[];
+    };
+    readonly error: Error | undefined;
+    readonly loading: boolean;
+}, (connector: Connector) => Promise<Error | {
+    connector: Connector<any, any>;
+    data: import("wagmi-private").Data<any>;
+} | undefined>];

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

@@ -0,0 +1,24 @@
+import { Chain } from 'wagmi-private';
+export declare const useNetwork: () => readonly [{
+    readonly data: {
+        readonly chain: {
+            id: number;
+            unsupported: boolean;
+            name?: string | undefined;
+            nativeCurrency?: {
+                name: string;
+                symbol: string;
+                decimals: 18;
+            } | undefined;
+            rpcUrls?: string[] | undefined;
+            blockExplorers?: {
+                name: string;
+                url: string;
+            }[] | undefined;
+            testnet?: boolean | undefined;
+        } | undefined;
+        readonly chains: Chain[];
+    };
+    readonly error: Error | undefined;
+    readonly loading: boolean | undefined;
+}, ((chainId: number) => Promise<boolean | Error>) | undefined];

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

@@ -0,0 +1,3 @@
+export { useContract } from './useContract';
+export { useContractEvent } from './useContractEvent';
+export { useToken } from './useToken';

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

@@ -0,0 +1,8 @@
+import { ContractInterface, Signer } from 'ethers';
+import { Provider } from '@ethersproject/providers';
+export declare type Config = {
+    addressOrName: string;
+    contractInterface: ContractInterface;
+    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

@@ -0,0 +1,7 @@
+import { ethers } from 'ethers';
+import { Config as UseContractConfig } from './useContract';
+declare type Config = {
+    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;
+export {};

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

@@ -0,0 +1,37 @@
+import { BigNumber } from 'ethers';
+import { Unit } from 'wagmi-private';
+declare type Config = {
+    address?: string;
+    formatUnits?: Unit | number;
+    skip?: boolean;
+};
+export declare const useToken: ({ address, formatUnits, skip }: Config) => readonly [{
+    readonly data: {
+        address: string | undefined;
+        decimals: number;
+        symbol: string;
+        totalSupply: {
+            formatted: string;
+            value: BigNumber;
+        };
+    } | undefined;
+    readonly error: Error | undefined;
+    readonly loading: boolean | undefined;
+}, (token: {
+    address: string;
+    decimals?: number | undefined;
+    image?: string | undefined;
+    symbol: string;
+}) => Promise<boolean | Error>, ({ address, formatUnits, }: {
+    address: string;
+    formatUnits?: Config['formatUnits'];
+}) => Promise<Error | {
+    address: string;
+    decimals: any;
+    symbol: any;
+    totalSupply: {
+        formatted: string;
+        value: any;
+    };
+}>];
+export {};

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

@@ -0,0 +1,3 @@
+export { useEnsAvatar } from './useEnsAvatar';
+export { useEnsLookup } from './useEnsLookup';
+export { useEnsResolver } from './useEnsResolver';

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

@@ -0,0 +1,12 @@
+declare type Config = {
+    addressOrName?: string | null;
+    skip?: boolean;
+};
+export declare const useEnsAvatar: ({ addressOrName, skip }?: Config) => readonly [{
+    readonly data: string | null | undefined;
+    readonly loading: boolean;
+    readonly error: Error | undefined;
+}, (config: {
+    addressOrName: string;
+}) => Promise<string | Error | null>];
+export {};

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

@@ -0,0 +1,12 @@
+declare type Config = {
+    address?: string;
+    skip?: boolean;
+};
+export declare const useEnsLookup: ({ address, skip }?: Config) => readonly [{
+    readonly data: string | null | undefined;
+    readonly loading: boolean;
+    readonly error: Error | undefined;
+}, (config: {
+    address: string;
+}) => Promise<string | Error | null>];
+export {};

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

@@ -0,0 +1,11 @@
+import { EnsResolver } from '@ethersproject/providers';
+declare type Config = {
+    name?: string | null;
+    skip?: boolean;
+};
+export declare const useEnsResolver: ({ name, skip }?: Config) => readonly [{
+    readonly data: EnsResolver | null | undefined;
+    readonly loading: boolean;
+    readonly error: Error | undefined;
+}, (config: Pick<Config, 'name'>) => Promise<import("@ethersproject/providers").Resolver | null | undefined>];
+export {};

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

@@ -0,0 +1,6 @@
+export { useAccount, useBalance, useConnect, useNetwork } from './accounts';
+export { useContract, useContractEvent, useToken } from './contracts';
+export { useEnsAvatar, useEnsLookup, useEnsResolver } from './ens';
+export { useBlockNumber, useFeeData } from './network-status';
+export { useProvider, useWebSocketProvider } from './providers';
+export { useCacheBuster, useLocalStorage } from './utils';

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

@@ -0,0 +1,2 @@
+export { useBlockNumber } from './useBlockNumber';
+export { useFeeData } from './useFeeData';

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

@@ -0,0 +1,10 @@
+declare type Config = {
+    skip?: boolean;
+    watch?: boolean;
+};
+export declare const useBlockNumber: ({ skip, watch }?: Config) => readonly [{
+    readonly data: number | undefined;
+    readonly error: Error | undefined;
+    readonly loading: boolean | undefined;
+}, () => Promise<number | Error>];
+export {};

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

@@ -0,0 +1,22 @@
+import { FeeData } from '@ethersproject/providers';
+import { Unit } from 'wagmi-private';
+declare type Config = {
+    formatUnits?: Unit | number;
+    skip?: boolean;
+    watch?: boolean;
+};
+export declare const useFeeData: ({ formatUnits, skip, watch, }?: Config) => readonly [{
+    readonly data: {
+        formatted: {
+            gasPrice: string;
+            maxFeePerGas: string;
+            maxPriorityFeePerGas: string;
+        } | undefined;
+        maxFeePerGas: import("ethers").BigNumber | null;
+        maxPriorityFeePerGas: import("ethers").BigNumber | null;
+        gasPrice: import("ethers").BigNumber | null;
+    } | undefined;
+    readonly loading: boolean | undefined;
+    readonly error: Error | undefined;
+}, () => Promise<Error | FeeData>];
+export {};

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

@@ -0,0 +1,2 @@
+export { useProvider } from './useProvider';
+export { useWebSocketProvider } from './useWebSocketProvider';

package/dist/declarations/src/hooks/providers/useProvider.d.ts

@@ -0,0 +1 @@
+export declare const useProvider: () => import("@ethersproject/providers").BaseProvider;

package/dist/declarations/src/hooks/providers/useWebSocketProvider.d.ts

@@ -0,0 +1 @@
+export declare const useWebSocketProvider: () => import("@ethersproject/providers").WebSocketProvider | undefined;

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

@@ -0,0 +1,2 @@
+export { useCacheBuster } from './useCacheBuster';
+export { useLocalStorage } from './useLocalStorage';

package/dist/declarations/src/hooks/utils/useCacheBuster.d.ts

@@ -0,0 +1 @@
+export declare const useCacheBuster: () => number;

package/dist/declarations/src/hooks/utils/useLocalStorage.d.ts

@@ -0,0 +1 @@
+export declare const useLocalStorage: <T>(key: string, defaultState?: T | null) => readonly [T | null, (newValue: T | null) => void];

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

@@ -0,0 +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, useToken, useWebSocketProvider, } from './hooks';
+export { Connector, InjectedConnector, WalletConnectConnector, WalletLinkConnector, chain, defaultChains, defaultL2Chains, developmentChains, erc1155ABI, erc20ABI, erc721ABI, isAddress, } from 'wagmi-private';
+export type { Chain, Data } from 'wagmi-private';

package/dist/wagmi.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./declarations/src/index";