viem 0.4.0-main.20230412T220621 → 0.4.0-main.20230413T040554

package/dist/types/clients/decorators/wallet.d.ts

@@ -4,6 +4,23 @@ import type { Account, Chain } from '../../types/index.js';
 import type { WalletClient } from '../createWalletClient.js';
 import type { Transport } from '../transports/index.js';
 export type WalletActions<TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined> = {
+    /**
+     * Adds an EVM chain to the wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/addChain.html
+     * - JSON-RPC Methods: [`eth_addEthereumChain`](https://eips.ethereum.org/EIPS/eip-3085)
+     *
+     * @param args - {@link AddChainParameters}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { optimism } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   transport: custom(window.ethereum),
+     * })
+     * await client.addChain({ chain: optimism })
+     */
     addChain: (args: AddChainParameters) => Promise<void>;
     /**
      * Deploys a contract to the network, given bytecode and constructor arguments.
@@ -11,7 +28,7 @@ export type WalletActions<TChain extends Chain | undefined = Chain | undefined,
      * - Docs: https://viem.sh/docs/contract/deployContract.html
      * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/deploying-contracts
      *
-     * @param parameters - {@link DeployContractParameters}
+     * @param args - {@link DeployContractParameters}
      * @returns The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link DeployContractReturnType}
      *
      * @example
@@ -20,7 +37,7 @@ export type WalletActions<TChain extends Chain | undefined = Chain | undefined,
      * import { mainnet } from 'viem/chains'
      *
      * const client = createWalletClient({
-     *   account = privateKeyToAccount('0x…'),
+     *   account: privateKeyToAccount('0x…'),
      *   chain: mainnet,
      *   transport: http(),
      * })
@@ -31,18 +48,388 @@ export type WalletActions<TChain extends Chain | undefined = Chain | undefined,
      * })
      */
     deployContract: <TAbi extends Abi | readonly unknown[], TChainOverride extends Chain | undefined>(args: DeployContractParameters<TAbi, TChain, TAccount, TChainOverride>) => Promise<DeployContractReturnType>;
+    /**
+     * Returns a list of account addresses owned by the wallet or client.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/getAddresses.html
+     * - JSON-RPC Methods: [`eth_accounts`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_accounts)
+     *
+     * @returns List of account addresses owned by the wallet or client. {@link GetAddressesReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const accounts = await client.getAddresses()
+     */
     getAddresses: () => Promise<GetAddressesReturnType>;
+    /**
+     * Returns the chain ID associated with the current network.
+     *
+     * - Docs: https://viem.sh/docs/actions/public/getChainId.html
+     * - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid)
+     *
+     * @returns The current chain ID. {@link GetChainIdReturnType}
+     *
+     * @example
+     * import { createWalletClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const chainId = await client.getChainId()
+     * // 1
+     */
     getChainId: () => Promise<GetChainIdReturnType>;
+    /**
+     * Gets the wallets current permissions.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/getPermissions.html
+     * - JSON-RPC Methods: [`wallet_getPermissions`](https://eips.ethereum.org/EIPS/eip-2255)
+     *
+     * @returns The wallet permissions. {@link GetPermissionsReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const permissions = await client.getPermissions()
+     */
     getPermissions: () => Promise<GetPermissionsReturnType>;
+    /**
+     * Requests a list of accounts managed by a wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/requestAddresses.html
+     * - JSON-RPC Methods: [`eth_requestAccounts`](https://eips.ethereum.org/EIPS/eip-1102)
+     *
+     * Sends a request to the wallet, asking for permission to access the user's accounts. After the user accepts the request, it will return a list of accounts (addresses).
+     *
+     * This API can be useful for dapps that need to access the user's accounts in order to execute transactions or interact with smart contracts.
+     *
+     * @returns List of accounts managed by a wallet {@link RequestAddressesReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const accounts = await client.requestAddresses()
+     */
     requestAddresses: () => Promise<RequestAddressesReturnType>;
+    /**
+     * Requests permissions for a wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/requestPermissions.html
+     * - JSON-RPC Methods: [`wallet_requestPermissions`](https://eips.ethereum.org/EIPS/eip-2255)
+     *
+     * @param args - {@link RequestPermissionsParameters}
+     * @returns The wallet permissions. {@link RequestPermissionsReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const permissions = await client.requestPermissions({
+     *   eth_accounts: {}
+     * })
+     */
     requestPermissions: (args: RequestPermissionsParameters) => Promise<RequestPermissionsReturnType>;
+    /**
+     * Creates, signs, and sends a new transaction to the network.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/sendTransaction.html
+     * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/sending-transactions
+     * - JSON-RPC Methods:
+     *   - JSON-RPC Accounts: [`eth_sendTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendtransaction)
+     *   - Local Accounts: [`eth_sendRawTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendrawtransaction)
+     *
+     * @param args - {@link SendTransactionParameters}
+     * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link SendTransactionReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const hash = await client.sendTransaction({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: 1000000000000000000n,
+     * })
+     *
+     * @example
+     * // Account Hoisting
+     * import { createWalletClient, http } from 'viem'
+     * import { privateKeyToAccount } from 'viem/accounts'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * })
+     * const hash = await client.sendTransaction({
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: 1000000000000000000n,
+     * })
+     */
     sendTransaction: <TChainOverride extends Chain | undefined>(args: SendTransactionParameters<TChain, TAccount, TChainOverride>) => Promise<SendTransactionReturnType>;
+    /**
+     * Calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/signMessage.html
+     * - JSON-RPC Methods:
+     *   - JSON-RPC Accounts: [`personal_sign`](https://docs.metamask.io/guide/signing-data.html#personal-sign)
+     *   - Local Accounts: Signs locally. No JSON-RPC request.
+     *
+     * With the calculated signature, you can:
+     * - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage) to verify the signature,
+     * - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress) to recover the signing address from a signature.
+     *
+     * @param args - {@link SignMessageParameters}
+     * @returns The signed message. {@link SignMessageReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const signature = await client.signMessage({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   message: 'hello world',
+     * })
+     *
+     * @example
+     * // Account Hoisting
+     * import { createWalletClient, http } from 'viem'
+     * import { privateKeyToAccount } from 'viem/accounts'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * })
+     * const signature = await client.signMessage({
+     *   message: 'hello world',
+     * })
+     */
     signMessage: (args: SignMessageParameters<TAccount>) => Promise<SignMessageReturnType>;
+    /**
+     * Signs typed data and calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/signTypedData.html
+     * - JSON-RPC Methods:
+     *   - JSON-RPC Accounts: [`eth_signTypedData_v4`](https://docs.metamask.io/guide/signing-data.html#signtypeddata-v4)
+     *   - Local Accounts: Signs locally. No JSON-RPC request.
+     *
+     * @param client - Client to use
+     * @param args - {@link SignTypedDataParameters}
+     * @returns The signed data. {@link SignTypedDataReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const signature = await client.signTypedData({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   domain: {
+     *     name: 'Ether Mail',
+     *     version: '1',
+     *     chainId: 1,
+     *     verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
+     *   },
+     *   types: {
+     *     Person: [
+     *       { name: 'name', type: 'string' },
+     *       { name: 'wallet', type: 'address' },
+     *     ],
+     *     Mail: [
+     *       { name: 'from', type: 'Person' },
+     *       { name: 'to', type: 'Person' },
+     *       { name: 'contents', type: 'string' },
+     *     ],
+     *   },
+     *   primaryType: 'Mail',
+     *   message: {
+     *     from: {
+     *       name: 'Cow',
+     *       wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
+     *     },
+     *     to: {
+     *       name: 'Bob',
+     *       wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
+     *     },
+     *     contents: 'Hello, Bob!',
+     *   },
+     * })
+     *
+     * @example
+     * // Account Hoisting
+     * import { createWalletClient, http } from 'viem'
+     * import { privateKeyToAccount } from 'viem/accounts'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * })
+     * const signature = await client.signTypedData({
+     *   domain: {
+     *     name: 'Ether Mail',
+     *     version: '1',
+     *     chainId: 1,
+     *     verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
+     *   },
+     *   types: {
+     *     Person: [
+     *       { name: 'name', type: 'string' },
+     *       { name: 'wallet', type: 'address' },
+     *     ],
+     *     Mail: [
+     *       { name: 'from', type: 'Person' },
+     *       { name: 'to', type: 'Person' },
+     *       { name: 'contents', type: 'string' },
+     *     ],
+     *   },
+     *   primaryType: 'Mail',
+     *   message: {
+     *     from: {
+     *       name: 'Cow',
+     *       wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
+     *     },
+     *     to: {
+     *       name: 'Bob',
+     *       wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
+     *     },
+     *     contents: 'Hello, Bob!',
+     *   },
+     * })
+     */
     signTypedData: <TTypedData extends TypedData | {
         [key: string]: unknown;
     }, TPrimaryType extends string>(args: SignTypedDataParameters<TTypedData, TPrimaryType, TAccount>) => Promise<SignTypedDataReturnType>;
+    /**
+     * Switch the target chain in a wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/switchChain.html
+     * - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326)
+     *
+     * @param args - {@link SwitchChainParameters}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet, optimism } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * await client.switchChain({ id: optimism.id })
+     */
     switchChain: (args: SwitchChainParameters) => Promise<void>;
+    /**
+     * Adds an EVM chain to the wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/watchAsset.html
+     * - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-747)
+     *
+     * @param args - {@link WatchAssetParameters}
+     * @returns Boolean indicating if the token was successfully added. {@link WatchAssetReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const success = await client.watchAsset({
+     *   type: 'ERC20',
+     *   options: {
+     *     address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+     *     decimals: 18,
+     *     symbol: 'WETH',
+     *   },
+     * })
+     */
     watchAsset: (args: WatchAssetParameters) => Promise<WatchAssetReturnType>;
+    /**
+     * Executes a write function on a contract.
+     *
+     * - Docs: https://viem.sh/docs/contract/writeContract.html
+     * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/writing-to-contracts
+     *
+     * A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a [Transaction](https://viem.sh/docs/glossary/terms) is needed to be broadcast in order to change the state.
+     *
+     * Internally, uses a [Wallet Client](https://viem.sh/docs/clients/wallet) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
+     *
+     * __Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract.html#usage) before you execute it.__
+     *
+     * @param args - {@link WriteContractParameters}
+     * @returns A [Transaction Hash](https://viem.sh/docs/glossary/terms#hash). {@link WriteContractReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom, parseAbi } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const hash = await client.writeContract({
+     *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+     *   abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
+     *   functionName: 'mint',
+     *   args: [69420],
+     * })
+     *
+     * @example
+     * // With Validation
+     * import { createWalletClient, custom, parseAbi } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const { request } = await client.simulateContract({
+     *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+     *   abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
+     *   functionName: 'mint',
+     *   args: [69420],
+     * }
+     * const hash = await client.writeContract(request)
+     */
     writeContract: <TAbi extends Abi | readonly unknown[], TFunctionName extends string, TChainOverride extends Chain | undefined>(args: WriteContractParameters<TAbi, TFunctionName, TChain, TAccount, TChainOverride>) => Promise<WriteContractReturnType>;
 };
 export declare const walletActions: <TTransport extends Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined>(client: WalletClient<TTransport, TChain, TAccount>) => WalletActions<TChain, TAccount>;

package/dist/types/clients/decorators/wallet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../../src/clients/decorators/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAC7C,OAAO,KAAK,EACV,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,0BAA0B,EAC1B,4BAA4B,EAC5B,4BAA4B,EAC5B,yBAAyB,EACzB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,EACxB,MAAM,+BAA+B,CAAA;AAgBtC,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAEvD,MAAM,MAAM,aAAa,CACvB,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACxD;IACF,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,EAAE,CACd,IAAI,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EACrC,cAAc,SAAS,KAAK,GAAG,SAAS,EAExC,IAAI,EAAE,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,KACnE,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACtC,YAAY,EAAE,MAAM,OAAO,CAAC,sBAAsB,CAAC,CAAA;IACnD,UAAU,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC/C,cAAc,EAAE,MAAM,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACvD,gBAAgB,EAAE,MAAM,OAAO,CAAC,0BAA0B,CAAC,CAAA;IAC3D,kBAAkB,EAAE,CAClB,IAAI,EAAE,4BAA4B,KAC/B,OAAO,CAAC,4BAA4B,CAAC,CAAA;IAC1C,eAAe,EAAE,CAAC,cAAc,SAAS,KAAK,GAAG,SAAS,EACxD,IAAI,EAAE,yBAAyB,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,KAC9D,OAAO,CAAC,yBAAyB,CAAC,CAAA;IACvC,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAClC,OAAO,CAAC,qBAAqB,CAAC,CAAA;IACnC,aAAa,EAAE,CACb,UAAU,SAAS,SAAS,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,EACzD,YAAY,SAAS,MAAM,EAE3B,IAAI,EAAE,uBAAuB,CAAC,UAAU,EAAE,YAAY,EAAE,QAAQ,CAAC,KAC9D,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC,WAAW,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3D,UAAU,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACzE,aAAa,EAAE,CACb,IAAI,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EACrC,aAAa,SAAS,MAAM,EAC5B,cAAc,SAAS,KAAK,GAAG,SAAS,EAExC,IAAI,EAAE,uBAAuB,CAC3B,IAAI,EACJ,aAAa,EACb,MAAM,EACN,QAAQ,EACR,cAAc,CACf,KACE,OAAO,CAAC,uBAAuB,CAAC,CAAA;CACtC,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,CAC1B,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAE1D,MAAM,EAAE,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,KAC/C,aAAa,CAAC,MAAM,EAAE,QAAQ,CAoBjC,CAAA"}
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../../src/clients/decorators/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAC7C,OAAO,KAAK,EACV,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,0BAA0B,EAC1B,4BAA4B,EAC5B,4BAA4B,EAC5B,yBAAyB,EACzB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,EACxB,MAAM,+BAA+B,CAAA;AAgBtC,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAEvD,MAAM,MAAM,aAAa,CACvB,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACxD;IACF;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,EAAE,CACd,IAAI,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EACrC,cAAc,SAAS,KAAK,GAAG,SAAS,EAExC,IAAI,EAAE,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,KACnE,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EAAE,MAAM,OAAO,CAAC,sBAAsB,CAAC,CAAA;IACnD;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACvD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,gBAAgB,EAAE,MAAM,OAAO,CAAC,0BAA0B,CAAC,CAAA;IAC3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,kBAAkB,EAAE,CAClB,IAAI,EAAE,4BAA4B,KAC/B,OAAO,CAAC,4BAA4B,CAAC,CAAA;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,eAAe,EAAE,CAAC,cAAc,SAAS,KAAK,GAAG,SAAS,EACxD,IAAI,EAAE,yBAAyB,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,KAC9D,OAAO,CAAC,yBAAyB,CAAC,CAAA;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAClC,OAAO,CAAC,qBAAqB,CAAC,CAAA;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+FG;IACH,aAAa,EAAE,CACb,UAAU,SAAS,SAAS,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,EACzD,YAAY,SAAS,MAAM,EAE3B,IAAI,EAAE,uBAAuB,CAAC,UAAU,EAAE,YAAY,EAAE,QAAQ,CAAC,KAC9D,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,aAAa,EAAE,CACb,IAAI,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EACrC,aAAa,SAAS,MAAM,EAC5B,cAAc,SAAS,KAAK,GAAG,SAAS,EAExC,IAAI,EAAE,uBAAuB,CAC3B,IAAI,EACJ,aAAa,EACb,MAAM,EACN,QAAQ,EACR,cAAc,CACf,KACE,OAAO,CAAC,uBAAuB,CAAC,CAAA;CACtC,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,CAC1B,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAE1D,MAAM,EAAE,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,KAC/C,aAAa,CAAC,MAAM,EAAE,QAAQ,CAoBjC,CAAA"}

package/dist/types/errors/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.4.0-main.20230412T220621";
+export declare const version = "0.4.0-main.20230413T040554";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -12,7 +12,7 @@
     "isomorphic-ws": "5.0.0",
     "ws": "8.12.0"
   },
-  "version": "0.4.0-main.20230412T220621",
+  "version": "0.4.0-main.20230413T040554",
   "files": [
     "dist",
     "!dist/**/*.tsbuildinfo",

package/src/actions/ens/getEnsAddress.ts

@@ -32,7 +32,6 @@ export type GetEnsAddressReturnType = Address | null
  * - Docs: https://viem.sh/docs/ens/actions/getEnsAddress.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
  *
  * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.

package/src/actions/ens/getEnsAvatar.ts

@@ -19,7 +19,6 @@ export type GetEnsAvatarReturnType = string | null
  * - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText.html) with `key` set to `'avatar'`.
  *
  * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.

package/src/actions/ens/getEnsName.ts

@@ -25,7 +25,6 @@ export type GetEnsNameReturnType = string | null
  * - Docs: https://viem.sh/docs/ens/actions/getEnsName.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
  *
  * @param client - Client to use

package/src/actions/ens/getEnsResolver.ts

@@ -22,7 +22,6 @@ export type GetEnsResolverReturnType = Address
  * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.
  *
  * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.

package/src/actions/ens/getEnsText.ts

@@ -30,7 +30,6 @@ export type GetEnsTextReturnType = string | null
  * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
  *
  * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.

package/src/actions/getContract.ts

@@ -114,6 +114,24 @@ export type GetContractReturnType<
              * A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.
              *
              * Internally, `read` uses a [Public Client](https://viem.sh/docs/clients/public.html) to call the [`call` action](https://viem.sh/docs/actions/public/call.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
+             *
+             * @example
+             * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+             * import { mainnet } from 'viem/chains'
+             *
+             * const publicClient = createPublicClient({
+             *   chain: mainnet,
+             *   transport: http(),
+             * })
+             * const contract = getContract({
+             *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+             *   abi: parseAbi([
+             *     'function balanceOf(address owner) view returns (uint256)',
+             *   ]),
+             *   publicClient,
+             * })
+             * const result = await contract.read.balanceOf(['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'])
+             * // 424122n
              */
             read: {
               [FunctionName in _ReadFunctionNames]: GetReadFunction<
@@ -128,6 +146,23 @@ export type GetContractReturnType<
           : {
               /**
                * Estimates the gas necessary to complete a transaction without submitting it to the network.
+               *
+               * @example
+               * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+               * import { mainnet } from 'viem/chains'
+               *
+               * const client = createPublicClient({
+               *   chain: mainnet,
+               *   transport: http(),
+               * })
+               * const contract = getContract({
+               *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+               *   abi: parseAbi(['function mint() public']),
+               *   publicClient,
+               * })
+               * const gas = await contract.estimateGas.mint({
+               *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+               * })
                */
               estimateGas: {
                 [FunctionName in _WriteFunctionNames]: GetEstimateFunction<
@@ -145,6 +180,23 @@ export type GetContractReturnType<
                * This function does not require gas to execute and does not change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract.html), but also supports contract write functions.
                *
                * Internally, `simulate` uses a [Public Client](https://viem.sh/docs/clients/public.html) to call the [`call` action](https://viem.sh/docs/actions/public/call.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
+               *
+               * @example
+               * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+               * import { mainnet } from 'viem/chains'
+               *
+               * const client = createPublicClient({
+               *   chain: mainnet,
+               *   transport: http(),
+               * })
+               * const contract = getContract({
+               *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+               *   abi: parseAbi(['function mint() public']),
+               *   publicClient,
+               * })
+               * const result = await contract.simulate.mint({
+               *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+               * })
                */
               simulate: {
                 [FunctionName in _WriteFunctionNames]: GetSimulateFunction<
@@ -162,6 +214,21 @@ export type GetContractReturnType<
           : {
               /**
                * Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs.html).
+               *
+               * @example
+               * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+               * import { mainnet } from 'viem/chains'
+               *
+               * const client = createPublicClient({
+               *   chain: mainnet,
+               *   transport: http(),
+               * })
+               * const contract = getContract({
+               *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+               *   abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
+               *   publicClient,
+               * })
+               * const filter = await contract.createEventFilter.Transfer()
                */
               createEventFilter: {
                 [EventName in _EventNames]: GetEventFilter<
@@ -176,6 +243,25 @@ export type GetContractReturnType<
                * This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent.html#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent.html#onLogs).
                *
                * `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter.html) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs.html) instead.
+               *
+               * @example
+               * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+               * import { mainnet } from 'viem/chains'
+               *
+               * const client = createPublicClient({
+               *   chain: mainnet,
+               *   transport: http(),
+               * })
+               * const contract = getContract({
+               *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+               *   abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
+               *   publicClient,
+               * })
+               * const filter = await contract.createEventFilter.Transfer()
+               * const unwatch = contract.watchEvent.Transfer(
+               *   { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' },
+               *   { onLogs: (logs) => console.log(logs) },
+               * )
                */
               watchEvent: {
                 [EventName in _EventNames]: GetWatchEvent<
@@ -197,7 +283,24 @@ export type GetContractReturnType<
              *
              * Internally, `write` uses a [Wallet Client](https://viem.sh/docs/clients/wallet.html) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
              *
-             * Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract.html#usage) before you execute it.
+             * __Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract.html#usage) before you execute it.__
+             *
+             * @example
+             * import { createWalletClient, getContract, http, parseAbi } from 'viem'
+             * import { mainnet } from 'viem/chains'
+             *
+             * const client = createWalletClient({
+             *   chain: mainnet,
+             *   transport: http(),
+             * })
+             * const contract = getContract({
+             *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+             *   abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
+             *   publicClient,
+             * })
+             * const hash = await contract.write.min([69420], {
+             *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+             * })
              */
             write: {
               [FunctionName in _WriteFunctionNames]: GetWriteFunction<
@@ -221,7 +324,6 @@ export type GetContractReturnType<
  *
  * - Docs https://viem.sh/docs/contract/getContract.html
  *
- * @remarks
  * Using Contract Instances can make it easier to work with contracts if you don't want to pass the `abi` and `address` properites every time you perform contract actions, e.g. [`readContract`](https://viem.sh/docs/contract/readContract.html), [`writeContract`](https://viem.sh/docs/contract/writeContract.html), [`estimateContractGas`](https://viem.sh/docs/contract/estimateContractGas.html), etc.
  *
  * @example