<!--
Sitemap:
- [Why Viem](/docs/introduction): A brief preamble on why we built Viem
- [Installation](/docs/installation)
- [Getting Started](/docs/getting-started): Get started with viem in just a few lines of code.
- [Platform Compatibility](/docs/compatibility): Platforms compatible with Viem
- [Frequently Asked Questions](/docs/faq)
- [Migration Guide](/docs/migration-guide)
- [Ethers v5 → viem Migration Guide](/docs/ethers-migration): Migrate from Ethers v5 to viem
- [TypeScript](/docs/typescript): TypeScript support for Viem
- [Error Handling](/docs/error-handling)
- [EIP-7702 Overview](/docs/eip7702): An Overview of EIP-7702
- [Contract Writes with EIP-7702](/docs/eip7702/contract-writes)
- [Sending Transactions with EIP-7702](/docs/eip7702/sending-transactions)
- [Blob Transactions](/docs/guides/blob-transactions): Sending your first Blob Transaction with Viem.
- [Introduction to Clients & Transports](/docs/clients/intro): A brief introduction to Clients & Transports.
- [Public Client](/docs/clients/public): A function to create a Public Client
- [Wallet Client](/docs/clients/wallet): A function to create a Wallet Client.
- [Test Client](/docs/clients/test): A function to create a Test Client
- [Build your own Client](/docs/clients/custom)
- [HTTP Transport](/docs/clients/transports/http): A function to create a HTTP Transport for a Client
- [WebSocket Transport](/docs/clients/transports/websocket): A function to create a WebSocket Transport for a Client
- [Custom Transport](/docs/clients/transports/custom): A function to create a Custom Transport for a Client
- [IPC Transport](/docs/clients/transports/ipc): A function to create an IPC Transport for a Client
- [Fallback Transport](/docs/clients/transports/fallback): A function to create a Fallback Transport for a Client
- [Introduction to Public Actions](/docs/actions/public/introduction): A brief introduction on what Public Actions are in viem.
- [createAccessList](/docs/actions/public/createAccessList)
- [getBalance](/docs/actions/public/getBalance): Returns the balance of an address in wei.
- [getTransactionCount](/docs/actions/public/getTransactionCount): Returns the number of Transactions an Account has sent.
- [getBlock](/docs/actions/public/getBlock): Returns information about a block at a block number, hash or tag.
- [getBlockReceipts](/docs/actions/public/getBlockReceipts): Returns the transaction receipts of a block at a block number, hash or tag.
- [getBlockNumber](/docs/actions/public/getBlockNumber): Returns the number of the most recent block seen.
- [getBlockTransactionCount](/docs/actions/public/getBlockTransactionCount): Returns the number of Transactions at a block number, hash or tag.
- [simulateBlocks](/docs/actions/public/simulateBlocks): Simulates a set of calls on block(s).
- [watchBlockNumber](/docs/actions/public/watchBlockNumber): Watches and returns incoming block numbers.
- [watchBlocks](/docs/actions/public/watchBlocks): Watches and returns information for incoming blocks.
- [call](/docs/actions/public/call): An Action for executing a new message call.
- [simulateCalls](/docs/actions/public/simulateCalls): Simulates a set of calls on block(s).
- [getChainId](/docs/actions/public/getChainId): Returns the chain ID associated with the current network
- [getEip712Domain](/docs/actions/public/getEip712Domain): Reads the EIP-712 domain from a contract.
- [estimateFeesPerGas](/docs/actions/public/estimateFeesPerGas): Returns an estimate for the fees per gas (in wei) for a transaction to be likely included in the next block.
- [estimateGas](/docs/actions/public/estimateGas): An Action for estimating gas for a transaction.
- [estimateMaxPriorityFeePerGas](/docs/actions/public/estimateMaxPriorityFeePerGas): Returns an estimate for the max priority fee per gas (in wei) for a transaction to be likely included in the next block.
- [getBlobBaseFee](/docs/actions/public/getBlobBaseFee): Returns the current blob base fee (in wei).
- [getFeeHistory](/docs/actions/public/getFeeHistory): Returns a collection of historical gas information.
- [getGasPrice](/docs/actions/public/getGasPrice): Returns the current price of gas (in wei).
- [createBlockFilter](/docs/actions/public/createBlockFilter): An Action for creating a new Block Filter.
- [createEventFilter](/docs/actions/public/createEventFilter): An Action for creating a new Event Filter.
- [createPendingTransactionFilter](/docs/actions/public/createPendingTransactionFilter): An Action for creating a new pending transaction filter.
- [getFilterChanges](/docs/actions/public/getFilterChanges): Returns a list of logs or hashes based on a Filter.
- [getFilterLogs](/docs/actions/public/getFilterLogs): Returns a list of event logs since the filter was created.
- [getLogs](/docs/actions/public/getLogs): Returns a list of event logs matching the provided parameters.
- [watchEvent](/docs/actions/public/watchEvent): Watches and returns emitted Event Logs.
- [uninstallFilter](/docs/actions/public/uninstallFilter): Destroys a Filter.
- [getProof](/docs/actions/public/getProof): Returns the account and storage values of the specified account including the Merkle-proof.
- [verifyMessage](/docs/actions/public/verifyMessage): Verifies if a signed message was generated by the provided address.
- [verifyTypedData](/docs/actions/public/verifyTypedData): Verifies a typed data signature
- [prepareTransactionRequest](/docs/actions/wallet/prepareTransactionRequest): Prepares a transaction request for signing.
- [getTransaction](/docs/actions/public/getTransaction): Returns information about a transaction given a hash or block identifier.
- [getTransactionConfirmations](/docs/actions/public/getTransactionConfirmations): Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
- [getTransactionReceipt](/docs/actions/public/getTransactionReceipt): Returns the transaction receipt given a transaction hash.
- [sendRawTransaction](/docs/actions/wallet/sendRawTransaction): Sends a signed transaction to the network
- [waitForTransactionReceipt](/docs/actions/public/waitForTransactionReceipt): Retrieves a Transaction Receipt for a given Transaction hash.
- [watchPendingTransactions](/docs/actions/public/watchPendingTransactions): Watches and returns pending transaction hashes.
- [Introduction to Wallet Actions](/docs/actions/wallet/introduction): A brief introduction to Wallet Actions in viem.
- [getAddresses](/docs/actions/wallet/getAddresses): Returns a list of addresses owned by the wallet or client.
- [requestAddresses](/docs/actions/wallet/requestAddresses): Requests a list of accounts managed by a wallet.
- [watchAsset](/docs/actions/wallet/watchAsset): Requests that the user tracks the token in their wallet.
- [getCallsStatus](/docs/actions/wallet/getCallsStatus): Returns the status of a call batch.
- [getCapabilities](/docs/actions/wallet/getCapabilities): Extract capabilities that a connected wallet supports.
- [sendCalls](/docs/actions/wallet/sendCalls): Sign and broadcast a batch of calls to the network.
- [sendCallsSync](/docs/actions/wallet/sendCallsSync): Sign and broadcast a batch of calls to the network, and waits for the calls to be included in a block.
- [showCallsStatus](/docs/actions/wallet/showCallsStatus): Requests for the wallet to show information about a call batch.
- [waitForCallsStatus](/docs/actions/wallet/waitForCallsStatus): Waits for a call batch to be confirmed & included on a Block.
- [addChain](/docs/actions/wallet/addChain): Adds an EVM chain to the wallet.
- [switchChain](/docs/actions/wallet/switchChain): Switch the target chain in a wallet.
- [signMessage](/docs/actions/wallet/signMessage): Signs a message with the Account's private key.
- [signTypedData](/docs/actions/wallet/signTypedData): Signs typed data with the Account's private key.
- [getPermissions](/docs/actions/wallet/getPermissions): Gets the wallets current permissions.
- [requestPermissions](/docs/actions/wallet/requestPermissions): Requests permissions for a wallet.
- [sendRawTransactionSync](/docs/actions/wallet/sendRawTransactionSync): Sends a signed transaction to the network synchronously
- [sendTransaction](/docs/actions/wallet/sendTransaction): Creates, signs, and sends a new transaction to the network.
- [sendTransactionSync](/docs/actions/wallet/sendTransactionSync): Creates, signs, and sends a new transaction to the network synchronously.
- [signTransaction](/docs/actions/wallet/signTransaction): Signs a transaction.
- [Introduction to Test Actions](/docs/actions/test/introduction): A brief introduction on what Test Actions are in viem.
- [impersonateAccount](/docs/actions/test/impersonateAccount): Impersonate an account or contract address.
- [setBalance](/docs/actions/test/setBalance): Modifies the balance of an account.
- [setCode](/docs/actions/test/setCode): Modifies the bytecode stored at an account's address.
- [setNonce](/docs/actions/test/setNonce): Modifies (overrides) the nonce of an account.
- [setStorageAt](/docs/actions/test/setStorageAt): Writes to a slot of an account's storage.
- [stopImpersonatingAccount](/docs/actions/test/stopImpersonatingAccount): Stop impersonating an account after having previously used impersonateAccount.
- [getAutomine](/docs/actions/test/getAutomine): Returns the automatic mining status of the node.
- [increaseTime](/docs/actions/test/increaseTime): Jump forward in time by the given amount of time, in seconds.
- [mine](/docs/actions/test/mine): Mine a specified number of blocks.
- [removeBlockTimestampInterval](/docs/actions/test/removeBlockTimestampInterval): Removes setBlockTimestampInterval if it exists.
- [setAutomine](/docs/actions/test/setAutomine): Enables or disables the automatic mining of new blocks with each new transaction submitted to the network.
- [setIntervalMining](/docs/actions/test/setIntervalMining): Sets the automatic mining interval (in seconds) of blocks.
- [setBlockTimestampInterval](/docs/actions/test/setBlockTimestampInterval): Sets the block's timestamp interval.
- [setBlockGasLimit](/docs/actions/test/setBlockGasLimit): Sets the block's gas limit.
- [setNextBlockBaseFeePerGas](/docs/actions/test/setNextBlockBaseFeePerGas): Sets the next block's base fee per gas.
- [setNextBlockTimestamp](/docs/actions/test/setNextBlockTimestamp): Sets the next block's timestamp.
- [setCoinbase](/docs/actions/test/setCoinbase): Sets the coinbase address to be used in new blocks.
- [setMinGasPrice](/docs/actions/test/setMinGasPrice): Change the minimum gas price accepted by the network (in wei).
- [reset](/docs/actions/test/reset): Resets the fork back to its original state.
- [setLoggingEnabled](/docs/actions/test/setLoggingEnabled): Enable or disable logging on the test node network.
- [setRpcUrl](/docs/actions/test/setRpcUrl): Sets the backend RPC URL.
- [dumpState](/docs/actions/test/dumpState): Serializes the current state into a savable data blob.
- [loadState](/docs/actions/test/loadState): Adds state previously dumped to the current chain.
- [revert](/docs/actions/test/revert): Revert the state of the blockchain at the current block.
- [snapshot](/docs/actions/test/snapshot): Snapshot the state of the blockchain at the current block.
- [dropTransaction](/docs/actions/test/dropTransaction): Removes a transaction from the mempool.
- [getTxpoolContent](/docs/actions/test/getTxpoolContent): Returns the details of all transactions currently pending for inclusion in the next block(s).
- [getTxpoolStatus](/docs/actions/test/getTxpoolStatus): Returns a summary of all the transactions currently pending for inclusion in the next block(s).
- [inspectTxpool](/docs/actions/test/inspectTxpool): Returns a summary of all the transactions currently pending for inclusion in the next block(s).
- [sendUnsignedTransaction](/docs/actions/test/sendUnsignedTransaction): Executes a transaction regardless of the signature.
- [JSON-RPC Account](/docs/accounts/jsonRpc): A function to create a JSON-RPC Account.
- [Local Accounts (Private Key, Mnemonic, etc)](/docs/accounts/local)
- [privateKeyToAccount](/docs/accounts/local/privateKeyToAccount): A function to create a Private Key Account.
- [mnemonicToAccount](/docs/accounts/local/mnemonicToAccount): A function to create a Mnemonic Account.
- [hdKeyToAccount](/docs/accounts/local/hdKeyToAccount): A function to create a Hierarchical Deterministic (HD) Account.
- [toAccount](/docs/accounts/local/toAccount): A function to create a Custom Account.
- [createNonceManager](/docs/accounts/local/createNonceManager): Creates a Nonce Manager for automatic nonce generation
- [signMessage (Local Account)](/docs/accounts/local/signMessage): Signs a message with the Account's private key.
- [signTransaction (Local Account)](/docs/accounts/local/signTransaction): Signs a transaction with the Account's private key.
- [signTypedData (Local Account)](/docs/accounts/local/signTypedData): Signs typed data with the Account's private key.
- [Chains](/docs/chains/introduction)
- [Fees](/docs/chains/fees): Configure chain-based fee data in Viem
- [Formatters](/docs/chains/formatters): Configure chain-based formatters in Viem
- [Serializers](/docs/chains/serializers): Configure chain-based serializers in Viem
- [Celo](/docs/chains/celo): Integrating with Celo in Viem
- [Getting Started with OP Stack](/op-stack): Getting started with the OP Stack in Viem
- [Getting Started with ZKsync](/zksync): Getting started with the ZKsync in Viem
- [Contract Instances](/docs/contract/getContract): A Contract Instance is a type-safe interface for performing contract-related actions with a specific ABI and address, created by the getContract function.
- [createContractEventFilter](/docs/contract/createContractEventFilter): Creates a Filter to retrieve contract event logs.
- [deployContract](/docs/contract/deployContract): Deploys a contract to the network, given bytecode & constructor arguments.
- [estimateContractGas](/docs/contract/estimateContractGas): Estimates the gas required to successfully execute a contract write function call.
- [getCode](/docs/contract/getCode): Retrieves the bytecode at an address.
- [getContractEvents](/docs/contract/getContractEvents): Returns a list of event logs matching the provided parameters.
- [getStorageAt](/docs/contract/getStorageAt): Returns the value from a storage slot at a given address.
- [multicall](/docs/contract/multicall): Batches up multiple functions on a contract in a single call.
- [readContract](/docs/contract/readContract): Calls a read-only function on a contract, and returns the response.
- [simulateContract](/docs/contract/simulateContract): Simulates & validates a contract interaction.
- [writeContract](/docs/contract/writeContract): Executes a write function on a contract.
- [writeContractSync](/docs/contract/writeContractSync): Executes a write function on a contract synchronously.
- [watchContractEvent](/docs/contract/watchContractEvent): Watches and returns emitted contract event logs.
- [decodeDeployData](/docs/contract/decodeDeployData): Decodes ABI encoded deploy data (bytecode & arguments).
- [decodeErrorResult](/docs/contract/decodeErrorResult): Decodes reverted error from a contract function call.
- [decodeEventLog](/docs/contract/decodeEventLog): Decodes ABI encoded event topics & data.
- [decodeFunctionData](/docs/contract/decodeFunctionData): Decodes ABI encoded data (4 byte selector & arguments) into a function name and arguments.
- [decodeFunctionResult](/docs/contract/decodeFunctionResult): Decodes the result of a function call on a contract.
- [encodeDeployData](/docs/contract/encodeDeployData): Encodes deploy data (bytecode & constructor args) into an ABI encoded value.
- [encodeErrorResult](/docs/contract/encodeErrorResult): Encodes a reverted error from a function call.
- [encodeEventTopics](/docs/contract/encodeEventTopics): Encodes an event (with optional arguments) into filter topics.
- [encodeFunctionData](/docs/contract/encodeFunctionData): Encodes the function name and parameters into an ABI encoded value (4 byte selector & arguments).
- [encodeFunctionResult](/docs/contract/encodeFunctionResult): Encodes structured return data into ABI encoded data.
- [parseEventLogs](/docs/contract/parseEventLogs): Extracts & decodes logs from a set of opaque logs.
- [getEnsAddress](/docs/ens/actions/getEnsAddress): Gets address for ENS name.
- [getEnsAvatar](/docs/ens/actions/getEnsAvatar): Gets the avatar of an ENS name.
- [getEnsName](/docs/ens/actions/getEnsName): Gets primary name for specified address.
- [getEnsResolver](/docs/ens/actions/getEnsResolver): Gets resolver for ENS name.
- [getEnsText](/docs/ens/actions/getEnsText): Gets a text record for specified ENS name.
- [labelhash](/docs/ens/utilities/labelhash): Hashes ENS label.
- [namehash](/docs/ens/utilities/namehash): Hashes ENS name.
- [normalize](/docs/ens/utilities/normalize): Normalizes ENS name to UTS46.
- [verifySiweMessage](/docs/siwe/actions/verifySiweMessage): Verifies EIP-4361 formatted message was signed.
- [createSiweMessage](/docs/siwe/utilities/createSiweMessage): Creates EIP-4361 formatted message.
- [generateSiweNonce](/docs/siwe/utilities/generateSiweNonce): Generates random EIP-4361 nonce.
- [parseSiweMessage](/docs/siwe/utilities/parseSiweMessage): Parses EIP-4361 formatted message into message fields object.
- [validateSiweMessage](/docs/siwe/utilities/validateSiweMessage): Validates EIP-4361 message.
- [decodeAbiParameters](/docs/abi/decodeAbiParameters): Decodes ABI encoded data.
- [encodeAbiParameters](/docs/abi/encodeAbiParameters): Generates ABI encoded data.
- [encodePacked](/docs/abi/encodePacked): Generates ABI encoded data.
- [getAbiItem](/docs/abi/getAbiItem): Retrieves an item from the ABI array.
- [parseAbi](/docs/abi/parseAbi): Parses human-readable ABI into JSON.
- [parseAbiItem](/docs/abi/parseAbiItem): Parses human-readable ABI item (e.g. error, event, function) into ABI item.
- [parseAbiParameter](/docs/abi/parseAbiParameter): Parses human-readable ABI parameter into ABI parameter.
- [parseAbiParameters](/docs/abi/parseAbiParameters): Parses human-readable ABI parameters into ABI parameters.
- [getDelegation](/docs/eip7702/getDelegation): Returns the address an account has delegated to via EIP-7702.
- [prepareAuthorization](/docs/eip7702/prepareAuthorization): Prepares an EIP-7702 Authorization for signing.
- [signAuthorization](/docs/eip7702/signAuthorization): Signs an EIP-7702 Authorization object.
- [hashAuthorization](/docs/eip7702/hashAuthorization): Calculates an Authorization object hash in EIP-7702 format.
- [recoverAuthorizationAddress](/docs/eip7702/recoverAuthorizationAddress): Recovers the original signing address from a signed Authorization object.
- [verifyAuthorization](/docs/eip7702/verifyAuthorization): Verifies that an Authorization object was signed by the provided address.
- [getAddress](/docs/utilities/getAddress): Converts an address into an address that is checksum encoded.
- [getContractAddress](/docs/utilities/getContractAddress): Retrieves a contract address.
- [isAddress](/docs/utilities/isAddress): Checks if the address is valid.
- [isAddressEqual](/docs/utilities/isAddressEqual): Checks if the given addresses (checksummed) are equal.
- [blobsToProofs](/docs/utilities/blobsToProofs): Compute the proofs for a list of blobs and their commitments.
- [blobsToCommitments](/docs/utilities/blobsToCommitments): Compute commitments from a list of blobs.
- [commitmentsToVersionedHashes](/docs/utilities/commitmentsToVersionedHashes): Transform a list of commitments to their versioned hashes.
- [commitmentToVersionedHash](/docs/utilities/commitmentToVersionedHash): Transform a commitment to it's versioned hash.
- [fromBlobs](/docs/utilities/fromBlobs): Transforms blobs into the originating data.
- [sidecarsToVersionedHashes](/docs/utilities/sidecarsToVersionedHashes): Transforms a list of sidecars to their versioned hashes.
- [toBlobs](/docs/utilities/toBlobs): Transforms arbitrary data into blobs.
- [toBlobSidecars](/docs/utilities/toBlobSidecars): Transforms arbitrary data into blob sidecars.
- [extractChain](/docs/utilities/extractChain)
- [concat](/docs/utilities/concat): Concatenates a set of hex values or byte arrays.
- [isBytes](/docs/utilities/isBytes): Checks whether the value is a byte array or not.
- [isHex](/docs/utilities/isHex): Checks whether the value is a hex value or not.
- [pad](/docs/utilities/pad): Pads a hex value or byte array with leading or trailing zeros.
- [slice](/docs/utilities/slice): Returns a section of the hex or byte array given a start/end bytes offset.
- [size](/docs/utilities/size): Retrieves the size of the value (in bytes).
- [trim](/docs/utilities/trim): Trims the leading or trailing zero byte data from a hex value or byte array.
- [fromBytes](/docs/utilities/fromBytes): Decodes a byte array to a string, hex value, boolean or number.
- [fromHex](/docs/utilities/fromHex): Decodes a hex value to a string, number or byte array.
- [fromRlp](/docs/utilities/fromRlp): Decodes a RLP value into a decoded hex value or byte array.
- [toBytes](/docs/utilities/toBytes): Encodes a string, hex value, number or boolean to a byte array.
- [toHex](/docs/utilities/toHex): Encodes a string, number, boolean or byte array to a hex value.
- [toRlp](/docs/utilities/toRlp): Encodes a hex value or byte array into a RLP encoded value.
- [isHash](/docs/utilities/isHash): Checks if a string is a valid 32-byte hex hash.
- [keccak256](/docs/utilities/keccak256): Calculates the Keccak256 hash of a byte array.
- [ripemd160](/docs/utilities/ripemd160): Calculates the Ripemd160 hash of a byte array.
- [sha256](/docs/utilities/sha256): Calculates the Sha256 hash of a byte array.
- [toEventHash](/docs/utilities/toEventHash): Returns the hash (of the event signature) for a given event definition.
- [toEventSelector](/docs/utilities/toEventSelector): Returns the event selector for a given event definition.
- [toEventSignature](/docs/utilities/toEventSignature): Returns the signature for a given event or event definition.
- [toFunctionHash](/docs/utilities/toFunctionHash): Returns the hash (of the function signature) for a given function definition.
- [toFunctionSelector](/docs/utilities/toFunctionSelector): Returns the function selector (4 byte encoding) for a given function definition.
- [toFunctionSignature](/docs/utilities/toFunctionSignature): Returns the signature for a given function definition.
- [setupKzg](/docs/utilities/setupKzg): Sets up and returns a KZG interface.
- [compactSignatureToSignature](/docs/utilities/compactSignatureToSignature): Parses a compact signature into signature format.
- [hashMessage](/docs/utilities/hashMessage): Hashes a message in EIP-191 format.
- [hashTypedData](/docs/utilities/hashTypedData): Hashes EIP-712 typed data.
- [isErc6492Signature](/docs/utilities/isErc6492Signature): Checks whether the signature is in ERC-6492 format.
- [parseCompactSignature](/docs/utilities/parseCompactSignature): Parses a hex formatted compact signature into a structured compact signature.
- [parseErc6492Signature](/docs/utilities/parseErc6492Signature): Parses a hex-formatted ERC-6492 flavoured signature.
- [parseSignature](/docs/utilities/parseSignature): Parses a hex formatted signature into a structured signature.
- [recoverAddress](/docs/utilities/recoverAddress): Recovers the signing address from a hash & signature.
- [recoverMessageAddress](/docs/utilities/recoverMessageAddress): Recovers the signing address from a message & signature.
- [recoverPublicKey](/docs/utilities/recoverPublicKey): Recovers the signing public key from a hash & signature.
- [recoverTransactionAddress](/docs/utilities/recoverTransactionAddress): Recovers the signing address from a transaction & signature.
- [recoverTypedDataAddress](/docs/utilities/recoverTypedDataAddress): Recovers the signing address from EIP-712 typed data & signature.
- [serializeCompactSignature](/docs/utilities/serializeCompactSignature): Serializes a compact signature into hex format.
- [serializeErc6492Signature](/docs/utilities/serializeErc6492Signature): Serializes a ERC-6492 flavoured signature into hex format.
- [serializeSignature](/docs/utilities/serializeSignature): Serializes a structured signature into hex format.
- [signatureToCompactSignature](/docs/utilities/signatureToCompactSignature): Parses a signature into a compact signature.
- [verifyMessage](/docs/utilities/verifyMessage): Verifies if a signed message was generated by the provided address.
- [verifyTypedData](/docs/utilities/verifyTypedData): Verifies a typed data signature
- [parseTransaction](/docs/utilities/parseTransaction): Converts a serialized transaction to a structured transaction.
- [serializeTransaction](/docs/utilities/serializeTransaction): Serializes a transaction object.
- [formatEther](/docs/utilities/formatEther): Converts numerical wei to a string representation of ether.
- [formatGwei](/docs/utilities/formatGwei): Converts numerical wei to a string representation of gwei.
- [formatUnits](/docs/utilities/formatUnits): Divides a number by a given exponent of base 10, and formats it into a string representation of the number.
- [parseEther](/docs/utilities/parseEther): Converts a string representation of ether to numerical wei.
- [parseGwei](/docs/utilities/parseGwei): Converts a string representation of gwei to numerical wei.
- [parseUnits](/docs/utilities/parseUnits): Multiplies a string representation of a number by a given exponent of base 10.
- [Terms](/docs/glossary/terms): Glossary of Terms in viem.
- [Types](/docs/glossary/types): Glossary of Types in viem.
- [Errors](/docs/glossary/errors): Glossary of Errors in viem.
- [Getting Started with Account Abstraction](/account-abstraction): Getting Started with Account Abstraction in Viem
- [Sending User Operations](/account-abstraction/guides/sending-user-operations)
- [Bundler Client](/account-abstraction/clients/bundler): A function to create a Bundler Client.
- [Paymaster Client](/account-abstraction/clients/paymaster): A function to create a Paymaster Client.
- [Smart Accounts](/account-abstraction/accounts/smart)
- [Coinbase Smart Wallet](/account-abstraction/accounts/smart/toCoinbaseSmartAccount)
- [MetaMask Smart Account](/account-abstraction/accounts/smart/toMetaMaskSmartAccount)
- [Thirdweb Smart Account](/account-abstraction/accounts/smart/toThirdwebSmartAccount)
- [Nexus Smart Account](/account-abstraction/accounts/smart/toNexusSmartAccount)
- [Light Smart Account](/account-abstraction/accounts/smart/toLightSmartAccount)
- [Kernel (ZeroDev) Smart Account](/account-abstraction/accounts/smart/toEcdsaKernelSmartAccount)
- [Safe Smart Account](/account-abstraction/accounts/smart/toSafeSmartAccount)
- [Simple Smart Account](/account-abstraction/accounts/smart/toSimpleSmartAccount)
- [Solady Smart Account](/account-abstraction/accounts/smart/toSoladySmartAccount)
- [Trust Smart Account](/account-abstraction/accounts/smart/toTrustSmartAccount)
- [toSmartAccount](/account-abstraction/accounts/smart/toSmartAccount): Creates a Smart Account with a provided Account Implementation.
- [signMessage (Smart Account)](/account-abstraction/accounts/smart/signMessage)
- [signTypedData (Smart Account)](/account-abstraction/accounts/smart/signTypedData)
- [signUserOperation (Smart Account)](/account-abstraction/accounts/smart/signUserOperation)
- [WebAuthn Account](/account-abstraction/accounts/webauthn)
- [toWebAuthnAccount](/account-abstraction/accounts/webauthn/toWebAuthnAccount)
- [createWebAuthnCredential](/account-abstraction/accounts/webauthn/createWebAuthnCredential)
- [estimateUserOperationGas](/account-abstraction/actions/bundler/estimateUserOperationGas): Estimates the gas values for a User Operation to be executed successfully.
- [getChainId](/account-abstraction/actions/bundler/getChainId): Returns the chain ID associated with the bundler
- [getSupportedEntryPoints](/account-abstraction/actions/bundler/getSupportedEntryPoints): Returns the EntryPoints that the bundler supports.
- [getUserOperation](/account-abstraction/actions/bundler/getUserOperation): Retrieves information about a User Operation given a hash.
- [getUserOperationReceipt](/account-abstraction/actions/bundler/getUserOperationReceipt): Returns the User Operation receipt given a User Operation hash.
- [prepareUserOperation](/account-abstraction/actions/bundler/prepareUserOperation): Prepares a User Operation for execution and fills in missing properties.
- [sendUserOperation](/account-abstraction/actions/bundler/sendUserOperation): Broadcasts a User Operation to the Bundler.
- [waitForUserOperationReceipt](/account-abstraction/actions/bundler/waitForUserOperationReceipt): Waits for the User Operation to be included on a Block, and then returns the User Operation receipt.
- [getPaymasterData](/account-abstraction/actions/paymaster/getPaymasterData): Retrieves paymaster-related properties to be used for the User Operation.
- [getPaymasterStubData](/account-abstraction/actions/paymaster/getPaymasterStubData): Retrieves paymaster-related properties to be used for the User Operation.
- [Getting Started](/experimental): Getting started with experimental features in Viem
- [Extending Client with ERC-7715](/experimental/erc7715/client): Setting up your Viem Client
- [grantPermissions](/experimental/erc7715/grantPermissions): Request permissions from a wallet to perform actions on behalf of a user.
- [Extending Client with ERC-7739 Actions](/experimental/erc7739/client): Setting up your Viem Client
- [signMessage](/experimental/erc7739/signMessage): Signs a personal sign message via Solady's ERC-1271 format.
- [signTypedData](/experimental/erc7739/signTypedData): Signs typed data via Solady's ERC-1271 format.
- [hashMessage](/experimental/erc7739/hashMessage): Hashes an EIP-191 message via ERC-7739 format.
- [hashTypedData](/experimental/erc7739/hashTypedData): Hashes EIP-712 typed data via Solady's ERC-1271 format.
- [wrapTypedDataSignature](/experimental/erc7739/wrapTypedDataSignature)
- [Extending Client with ERC-7811 Actions](/experimental/erc7811/client): Setting up your Viem Client
- [getAssets](/experimental/erc7811/getAssets): Requests to get assets for an account from a Wallet.
- [Extending Client with ERC-7821 Actions](/experimental/erc7821/client): Setting up your Viem Client
- [execute](/experimental/erc7821/execute): Executes call(s) using the `execute` function on an ERC-7821-compatible contract.
- [executeBatches](/experimental/erc7821/executeBatches): Executes batches of call(s) on an ERC-7821-compatible contract.
- [supportsExecutionMode](/experimental/erc7821/supportsExecutionMode): Checks if the contract supports the ERC-7821 execution mode.
- [Extending Client with ERC-7846 Actions](/experimental/erc7846/client): Setting up your Viem Client
- [connect](/experimental/erc7846/connect): Requests to connect Account(s).
- [disconnect](/experimental/erc7846/disconnect): Requests to disconnect account(s).
- [Extending Client with ERC-7895 Actions](/experimental/erc7895/client): Setting up your Viem Client
- [addSubAccount](/experimental/erc7895/addSubAccount): Requests to add a Sub Account.
- [Client](/op-stack/client): Setting up your Viem Client with the OP Stack
- [Chains](/op-stack/chains)
- [Deposits](/op-stack/guides/deposits)
- [Withdrawals](/op-stack/guides/withdrawals)
- [buildDepositTransaction](/op-stack/actions/buildDepositTransaction): Builds & prepares parameters for a deposit transaction to be initiated on an L1 and executed on the L2.
- [buildProveWithdrawal](/op-stack/actions/buildProveWithdrawal): Builds the transaction that proves a withdrawal was initiated on an L2.
- [estimateContractL1Fee](/op-stack/actions/estimateContractL1Fee): Estimates the L1 fee to execute an L2 contract write.
- [estimateContractL1Gas](/op-stack/actions/estimateContractL1Gas): Estimates the L1 gas to execute an L2 contract write.
- [estimateContractTotalFee](/op-stack/actions/estimateContractTotalFee): Estimates the total (L1 + L2) fee to execute an L2 contract write.
- [estimateContractTotalGas](/op-stack/actions/estimateContractTotalGas): Estimates the total (L1 + L2) gas to execute an L2 contract write.
- [estimateInitiateWithdrawalGas](/op-stack/actions/estimateInitiateWithdrawalGas): Estimates gas required to initiate a withdrawal on an L2 to the L1.
- [estimateL1Fee](/op-stack/actions/estimateL1Fee): Estimates the L1 fee to execute an L2 transaction.
- [estimateL1Gas](/op-stack/actions/estimateL1Gas): Estimates the amount of L1 gas required to execute an L2 transaction
- [estimateOperatorFee](/op-stack/actions/estimateOperatorFee): Estimates the operator fee to execute an L2 transaction.
- [estimateTotalFee](/op-stack/actions/estimateTotalFee): Estimates the L1 + L2 + operator fee to execute an L2 transaction.
- [estimateTotalGas](/op-stack/actions/estimateTotalGas): Estimates the amount of L1 + L2 gas required to execute an L2 transaction
- [initiateWithdrawal](/op-stack/actions/initiateWithdrawal): Initiates a withdrawal on an L2 to the L1.
- [buildInitiateWithdrawal](/op-stack/actions/buildInitiateWithdrawal): Builds & prepares parameters for a withdrawal to be initiated on an L2.
- [estimateDepositTransactionGas](/op-stack/actions/estimateDepositTransactionGas): Estimates gas to initiate a deposit transaction on an L1, which executes a transaction on an L2.
- [estimateFinalizeWithdrawalGas](/op-stack/actions/estimateFinalizeWithdrawalGas): Estimates gas required to finalize a withdrawal that occurred on an L2.
- [estimateProveWithdrawalGas](/op-stack/actions/estimateProveWithdrawalGas): Estimates gas required to prove a withdrawal that occurred on an L2.
- [getGame](/op-stack/actions/getGame): Retrieves a valid dispute game on an L2 that occurred after a provided L2 block number.
- [getGames](/op-stack/actions/getGames): Retrieves dispute games for an L2.
- [getL2Output](/op-stack/actions/getL2Output): Retrieves the first L2 output proposal that occurred after a provided block number.
- [getTimeToFinalize](/op-stack/actions/getTimeToFinalize): Returns the time until the withdrawal transaction can be finalized.
- [getTimeToNextGame](/op-stack/actions/getTimeToNextGame): Returns the time until the next L2 dispute game is submitted.
- [getTimeToNextL2Output](/op-stack/actions/getTimeToNextL2Output): Builds & prepares parameters for a withdrawal to be initiated on an L2.
- [getTimeToProve](/op-stack/actions/getTimeToProve): Gets time until the L2 withdrawal transaction is ready to be proved.
- [getWithdrawalStatus](/op-stack/actions/getWithdrawalStatus): Returns the current status of a withdrawal.
- [waitForNextGame](/op-stack/actions/waitForNextGame): Waits for the next dispute game to be submitted.
- [waitForNextL2Output](/op-stack/actions/waitForNextL2Output): Waits for the next L2 output (after the provided block number) to be submitted.
- [waitToFinalize](/op-stack/actions/waitToFinalize): Waits until the withdrawal transaction can be finalized.
- [waitToProve](/op-stack/actions/waitToProve): Waits until the L2 withdrawal transaction is ready to be proved.
- [depositTransaction](/op-stack/actions/depositTransaction): Initiates a deposit transaction on an L1, which executes a transaction on an L2.
- [finalizeWithdrawal](/op-stack/actions/finalizeWithdrawal): Finalizes a withdrawal that occurred on an L2.
- [proveWithdrawal](/op-stack/actions/proveWithdrawal): Proves a withdrawal that occurred on an L2.
- [extractTransactionDepositedLogs](/op-stack/utilities/extractTransactionDepositedLogs): Extracts "TransactionDeposited" logs from an opaque array of logs.
- [extractWithdrawalMessageLogs](/op-stack/utilities/extractWithdrawalMessageLogs): Extracts "MessagePassed" logs from a withdrawal initialization from an opaque array of logs.
- [getL2TransactionHash](/op-stack/utilities/getL2TransactionHash): Computes the L2 transaction hash from an L1 "TransactionDeposited" log.
- [getL2TransactionHashes](/op-stack/utilities/getL2TransactionHashes): Computes the L2 transaction hashes from an array of L1 "TransactionDeposited" logs.
- [getWithdrawals](/op-stack/utilities/getWithdrawals): Gets the messages from a withdrawal initialization.
- [getSourceHash](/op-stack/utilities/getSourceHash): Computes source hash of a deposit transaction.
- [opaqueDataToDepositData](/op-stack/utilities/opaqueDataToDepositData): Converts opaque data into a structured deposit data format.
- [getWithdrawalHashStorageSlot](/op-stack/utilities/getWithdrawalHashStorageSlot): Computes the withdrawal hash storage slot to be used when proving a withdrawal.
- [parseTransaction (OP Stack)](/op-stack/utilities/parseTransaction): Converts a serialized transaction to a structured transaction, with support for OP Stack.
- [serializeTransaction (OP Stack)](/op-stack/utilities/serializeTransaction): Serializes a transaction object, with support for OP Stack.
- [USDC (Circle)](/circle-usdc)
- [Integrating USDC into Your Application](/circle-usdc/guides/integrating)
- [Cross-Chain USDC Transfers](/circle-usdc/guides/cross-chain)
- [Cross Chain USDC Transfers with Bridge Kit](/circle-usdc/guides/bridge-kit)
- [Cross Chain USDC Transfers (CCTP Integration)](/circle-usdc/guides/manual-cctp)
- [Gasless USDC Transfers with Circle Paymaster](/circle-usdc/guides/paymaster)
- [Circle Smart Account](/circle-usdc/guides/smart-account)
- [Getting Started](/tempo/)
- [Chains](/tempo/chains)
- [Guides](/tempo/guides/): Task-oriented guides for building common Tempo features with Viem.
- [Create an Account](/tempo/guides/accounts/create): Create a Tempo Account from a private key, passkey, or device-bound key, and use it with a Viem client.
- [Sign In with a Passkey](/tempo/guides/accounts/passkeys): Create and restore WebAuthn passkey accounts for non-custodial browser sign-in on Tempo.
- [Use the Tempo Accounts SDK](/tempo/guides/accounts/accounts-sdk): Connect a Tempo account with the Tempo Accounts SDK and drive it with Viem and Tempo Actions.
- [Tempo Transactions](/tempo/transactions): Send your first Tempo Transaction with Viem, and discover the payment-native features they unlock.
- [Batch Calls](/tempo/guides/batch-calls): Bundle multiple operations into a single atomic Tempo Transaction.
- [Concurrent Transactions](/tempo/guides/concurrent-transactions): Send multiple Tempo Transactions in parallel using concurrent nonces.
- [Scheduled Transactions](/tempo/guides/scheduled-transactions): Sign a Tempo Transaction now and define when it can execute onchain.
- [Pay Fees in a Stablecoin](/tempo/guides/pay-fees): Pay Tempo transaction fees in any USD-denominated TIP-20 stablecoin.
- [Sponsor User Fees](/tempo/guides/sponsor-fees): Sponsor transaction fees on behalf of your users for a gasless experience on Tempo.
- [Multisig Transactions](/tempo/guides/multisig-transactions): Send a Tempo Transaction from a native multisig account by collecting owner approvals.
- [Create a TIP-20 Token](/tempo/guides/create-token): Deploy a TIP-20 stablecoin on Tempo and read its onchain metadata.
- [Mint & Burn Tokens](/tempo/guides/manage-token-balances): Mint and burn TIP-20 token supply on Tempo.
- [Transfer Tokens](/tempo/guides/transfer-tokens): Transfer TIP-20 tokens, authorize spenders, and read balances on Tempo.
- [Manage Token Roles & Supply](/tempo/guides/manage-token-roles): Grant and revoke TIP-20 roles, cap supply, and pause transfers on Tempo.
- [Configure Transfer Policies](/tempo/guides/transfer-policies): Restrict which accounts can send or receive a TIP-20 token with a transfer policy.
- [Distribute Token Rewards](/tempo/guides/token-rewards): Distribute rewards to TIP-20 holders and let them claim their share on Tempo.
- [Access Keys](/tempo/guides/access-keys/): Delegate signing to a secondary key with access keys, with spending limits, scopes, admin keys, and signature verification.
- [Authorize Access Keys](/tempo/guides/access-keys/authorize): Authorize an access key to sign transactions on behalf of an account, and defer authorization to a transaction.
- [Set Permissions & Limits](/tempo/guides/access-keys/permissions): Restrict an access key with an expiry, per-token spending limits, recurring limits, and call scopes.
- [Manage Access Keys](/tempo/guides/access-keys/manage): Update spending limits, revoke access keys, and inspect their onchain metadata and remaining limits.
- [Admin Access Keys](/tempo/guides/access-keys/admin): Authorize unrestricted admin access keys that can manage an account's other keys, and check admin status.
- [Witnesses](/tempo/guides/access-keys/witnesses): Bind a witness to a key authorization and burn it to revoke signed-but-not-yet-submitted authorizations.
- [Verify Signatures](/tempo/guides/access-keys/verify): Verify that a keychain signature was produced by an active access key for the expected account.
- [Stablecoin Exchange](/tempo/guides/stablecoin-exchange/): Trade stablecoins on Tempo's enshrined DEX, manage orders and balances, create trading pairs, and provide Fee AMM liquidity.
- [Swap Stablecoins](/tempo/guides/stablecoin-exchange/swap): Quote and swap one USD-denominated TIP-20 stablecoin for another on Tempo's enshrined DEX.
- [Place & Manage Orders](/tempo/guides/stablecoin-exchange/orders): Place limit and flip orders on Tempo's Stablecoin DEX, then read, inspect, and cancel them.
- [Manage Exchange Balances](/tempo/guides/stablecoin-exchange/balances): Read your internal Stablecoin DEX balances and withdraw them back to your Tempo wallet.
- [Create a Trading Pair](/tempo/guides/stablecoin-exchange/create-pair): Create a new trading pair on Tempo's Stablecoin DEX and configure a token's quote token.
- [Provide Fee AMM Liquidity](/tempo/guides/stablecoin-exchange/fee-amm-liquidity): Add and remove liquidity in Tempo's Fee AMM so stablecoin fee conversions can settle.
- [Virtual Addresses](/tempo/guides/virtual-addresses/): Register a master address and accept TIP-20 deposits at unlimited virtual addresses that forward to you without sweeps.
- [Register a Master Address](/tempo/guides/virtual-addresses/register): Mine a TIP-1022 proof-of-work salt and register a master address for virtual-address deposit forwarding.
- [Resolve & Accept Payments](/tempo/guides/virtual-addresses/resolve): Derive per-customer virtual deposit addresses offchain and resolve them to your master wallet.
- [Receive Policies](/tempo/guides/receive-policies/): Control who can pay you on Tempo with receive policies, validate inbound transfers, and recover blocked funds.
- [Set a Receive Policy](/tempo/guides/receive-policies/set): Set and read an account's receive policy to control which senders and tokens it accepts.
- [Validate Transfers](/tempo/guides/receive-policies/validate): Check whether a TIP-20 transfer would be accepted by a recipient's receive policy before sending it.
- [Handle Blocked Funds](/tempo/guides/receive-policies/blocked): Read, claim, and burn TIP-20 funds that a receive policy blocked from being credited.
- [Payment Channels](/tempo/guides/payment-channels/): Open funded TIP-20 channels on Tempo, stream off-chain vouchers, and settle or close to move funds onchain.
- [Open & Fund a Channel](/tempo/guides/payment-channels/open): Open and fund a TIP-20 payment channel on Tempo, top it up, and read its onchain state.
- [Send & Settle Vouchers](/tempo/guides/payment-channels/vouchers): Sign off-chain TIP-20 channel vouchers as the payer and settle them onchain as the payee.
- [Close & Withdraw](/tempo/guides/payment-channels/close): Close a TIP-20 payment channel from either side and withdraw the remaining deposit on Tempo.
- [Private Zones](/tempo/guides/zones/): Connect to private Tempo Zones, deposit funds into them, and withdraw back to Tempo Mainnet.
- [Connect to a Zone](/tempo/guides/zones/connect): Connect a Viem client to a private Tempo Zone and authenticate with an authorization token.
- [Deposit to a Zone](/tempo/guides/zones/deposit): Deposit TIP-20 stablecoins from Tempo Mainnet into a private Tempo Zone.
- [Withdraw from a Zone](/tempo/guides/zones/withdraw): Withdraw TIP-20 stablecoins from a private Tempo Zone back to Tempo Mainnet.
- [Accounts](/tempo/accounts/)
- [Account.fromSecp256k1](/tempo/accounts/account.fromSecp256k1)
- [Account.fromP256](/tempo/accounts/account.fromP256)
- [Account.fromWebAuthnP256](/tempo/accounts/account.fromWebAuthnP256)
- [Account.fromWebCryptoP256](/tempo/accounts/account.fromWebCryptoP256)
- [Account.fromMultisig](/tempo/accounts/account.fromMultisig)
- [Overview](/tempo/actions/)
- [accessKey.authorize](/tempo/actions/accessKey.authorize)
- [accessKey.burnWitness](/tempo/actions/accessKey.burnWitness)
- [accessKey.getMetadata](/tempo/actions/accessKey.getMetadata)
- [accessKey.getRemainingLimit](/tempo/actions/accessKey.getRemainingLimit)
- [accessKey.isAdmin](/tempo/actions/accessKey.isAdmin)
- [accessKey.isWitnessBurned](/tempo/actions/accessKey.isWitnessBurned)
- [accessKey.revoke](/tempo/actions/accessKey.revoke)
- [accessKey.signAuthorization](/tempo/actions/accessKey.signAuthorization)
- [accessKey.updateLimit](/tempo/actions/accessKey.updateLimit)
- [accessKey.verifyHash](/tempo/actions/accessKey.verifyHash)
- [accessKey.watchAdminAuthorized](/tempo/actions/accessKey.watchAdminAuthorized)
- [accessKey.watchWitness](/tempo/actions/accessKey.watchWitness)
- [accessKey.watchWitnessBurned](/tempo/actions/accessKey.watchWitnessBurned)
- [amm.burn](/tempo/actions/amm.burn)
- [amm.getLiquidityBalance](/tempo/actions/amm.getLiquidityBalance)
- [amm.getPool](/tempo/actions/amm.getPool)
- [amm.mint](/tempo/actions/amm.mint)
- [amm.rebalanceSwap](/tempo/actions/amm.rebalanceSwap)
- [amm.watchBurn](/tempo/actions/amm.watchBurn)
- [amm.watchMint](/tempo/actions/amm.watchMint)
- [amm.watchRebalanceSwap](/tempo/actions/amm.watchRebalanceSwap)
- [channel.close](/tempo/actions/channel.close)
- [channel.getStates](/tempo/actions/channel.getStates)
- [channel.open](/tempo/actions/channel.open)
- [channel.requestClose](/tempo/actions/channel.requestClose)
- [channel.settle](/tempo/actions/channel.settle)
- [channel.signVoucher](/tempo/actions/channel.signVoucher)
- [channel.topUp](/tempo/actions/channel.topUp)
- [channel.withdraw](/tempo/actions/channel.withdraw)
- [fee.getUserToken](/tempo/actions/fee.getUserToken)
- [fee.setUserToken](/tempo/actions/fee.setUserToken)
- [fee.watchSetUserToken](/tempo/actions/fee.watchSetUserToken)
- [nonce.getNonce](/tempo/actions/nonce.getNonce)
- [nonce.watchNonceIncremented](/tempo/actions/nonce.watchNonceIncremented)
- [policy.create](/tempo/actions/policy.create)
- [policy.getData](/tempo/actions/policy.getData)
- [policy.isAuthorized](/tempo/actions/policy.isAuthorized)
- [policy.modifyBlacklist](/tempo/actions/policy.modifyBlacklist)
- [policy.modifyWhitelist](/tempo/actions/policy.modifyWhitelist)
- [policy.setAdmin](/tempo/actions/policy.setAdmin)
- [policy.watchAdminUpdated](/tempo/actions/policy.watchAdminUpdated)
- [policy.watchBlacklistUpdated](/tempo/actions/policy.watchBlacklistUpdated)
- [policy.watchCreate](/tempo/actions/policy.watchCreate)
- [policy.watchWhitelistUpdated](/tempo/actions/policy.watchWhitelistUpdated)
- [receivePolicy.burn](/tempo/actions/receivePolicy.burn)
- [receivePolicy.claim](/tempo/actions/receivePolicy.claim)
- [receivePolicy.get](/tempo/actions/receivePolicy.get)
- [receivePolicy.getBlockedBalance](/tempo/actions/receivePolicy.getBlockedBalance)
- [receivePolicy.set](/tempo/actions/receivePolicy.set)
- [receivePolicy.validate](/tempo/actions/receivePolicy.validate)
- [receivePolicy.watchBlocked](/tempo/actions/receivePolicy.watchBlocked)
- [receivePolicy.watchBurned](/tempo/actions/receivePolicy.watchBurned)
- [receivePolicy.watchClaimed](/tempo/actions/receivePolicy.watchClaimed)
- [receivePolicy.watchUpdated](/tempo/actions/receivePolicy.watchUpdated)
- [faucet.fund](/tempo/actions/faucet.fund)
- [reward.claim](/tempo/actions/reward.claim)
- [reward.distribute](/tempo/actions/reward.distribute)
- [reward.getGlobalRewardPerToken](/tempo/actions/reward.getGlobalRewardPerToken)
- [reward.getPendingRewards](/tempo/actions/reward.getPendingRewards)
- [reward.getUserRewardInfo](/tempo/actions/reward.getUserRewardInfo)
- [reward.setRecipient](/tempo/actions/reward.setRecipient)
- [reward.watchRewardDistributed](/tempo/actions/reward.watchRewardDistributed)
- [reward.watchRewardRecipientSet](/tempo/actions/reward.watchRewardRecipientSet)
- [simulate.simulateBlocks](/tempo/actions/simulate.simulateBlocks)
- [simulate.simulateCalls](/tempo/actions/simulate.simulateCalls)
- [dex.buy](/tempo/actions/dex.buy)
- [dex.cancel](/tempo/actions/dex.cancel)
- [dex.cancelStale](/tempo/actions/dex.cancelStale)
- [dex.createPair](/tempo/actions/dex.createPair)
- [dex.getBalance](/tempo/actions/dex.getBalance)
- [dex.getBuyQuote](/tempo/actions/dex.getBuyQuote)
- [dex.getOrder](/tempo/actions/dex.getOrder)
- [dex.getTickLevel](/tempo/actions/dex.getTickLevel)
- [dex.getSellQuote](/tempo/actions/dex.getSellQuote)
- [dex.place](/tempo/actions/dex.place)
- [dex.placeFlip](/tempo/actions/dex.placeFlip)
- [dex.sell](/tempo/actions/dex.sell)
- [dex.watchFlipOrderPlaced](/tempo/actions/dex.watchFlipOrderPlaced)
- [dex.watchOrderCancelled](/tempo/actions/dex.watchOrderCancelled)
- [dex.watchOrderFilled](/tempo/actions/dex.watchOrderFilled)
- [dex.watchOrderPlaced](/tempo/actions/dex.watchOrderPlaced)
- [dex.withdraw](/tempo/actions/dex.withdraw)
- [token.approve](/tempo/actions/token.approve)
- [token.burn](/tempo/actions/token.burn)
- [token.burnBlocked](/tempo/actions/token.burnBlocked)
- [token.changeTransferPolicy](/tempo/actions/token.changeTransferPolicy)
- [token.create](/tempo/actions/token.create)
- [token.getAllowance](/tempo/actions/token.getAllowance)
- [token.getBalance](/tempo/actions/token.getBalance)
- [token.getMetadata](/tempo/actions/token.getMetadata)
- [token.grantRoles](/tempo/actions/token.grantRoles)
- [token.hasRole](/tempo/actions/token.hasRole)
- [token.mint](/tempo/actions/token.mint)
- [token.pause](/tempo/actions/token.pause)
- [token.renounceRoles](/tempo/actions/token.renounceRoles)
- [token.revokeRoles](/tempo/actions/token.revokeRoles)
- [token.setRoleAdmin](/tempo/actions/token.setRoleAdmin)
- [token.setSupplyCap](/tempo/actions/token.setSupplyCap)
- [token.transfer](/tempo/actions/token.transfer)
- [token.unpause](/tempo/actions/token.unpause)
- [token.watchAdminRole](/tempo/actions/token.watchAdminRole)
- [token.watchApprove](/tempo/actions/token.watchApprove)
- [token.watchBurn](/tempo/actions/token.watchBurn)
- [token.watchCreate](/tempo/actions/token.watchCreate)
- [token.watchMint](/tempo/actions/token.watchMint)
- [token.watchRole](/tempo/actions/token.watchRole)
- [token.watchTransfer](/tempo/actions/token.watchTransfer)
- [validator.add](/tempo/actions/validator.add)
- [validator.changeOwner](/tempo/actions/validator.changeOwner)
- [validator.changeStatus](/tempo/actions/validator.changeStatus)
- [validator.get](/tempo/actions/validator.get)
- [validator.getByIndex](/tempo/actions/validator.getByIndex)
- [validator.getCount](/tempo/actions/validator.getCount)
- [validator.getNextFullDkgCeremony](/tempo/actions/validator.getNextFullDkgCeremony)
- [validator.getOwner](/tempo/actions/validator.getOwner)
- [validator.list](/tempo/actions/validator.list)
- [validator.setNextFullDkgCeremony](/tempo/actions/validator.setNextFullDkgCeremony)
- [validator.update](/tempo/actions/validator.update)
- [virtualAddress.getMasterAddress](/tempo/actions/virtualAddress.getMasterAddress)
- [virtualAddress.registerMaster](/tempo/actions/virtualAddress.registerMaster)
- [virtualAddress.resolve](/tempo/actions/virtualAddress.resolve)
- [wallet.deposit](/tempo/actions/wallet.deposit)
- [wallet.transfer](/tempo/actions/wallet.transfer)
- [wallet.swap](/tempo/actions/wallet.swap)
- [zone.deposit](/tempo/actions/zone.deposit)
- [zone.encryptedDeposit](/tempo/actions/zone.encryptedDeposit)
- [zone.getAuthorizationTokenInfo](/tempo/actions/zone.getAuthorizationTokenInfo)
- [zone.getDepositStatus](/tempo/actions/zone.getDepositStatus)
- [zone.getWithdrawalFee](/tempo/actions/zone.getWithdrawalFee)
- [zone.getZoneInfo](/tempo/actions/zone.getZoneInfo)
- [zone.requestVerifiableWithdrawal](/tempo/actions/zone.requestVerifiableWithdrawal)
- [zone.requestWithdrawal](/tempo/actions/zone.requestWithdrawal)
- [zone.signAuthorizationToken](/tempo/actions/zone.signAuthorizationToken)
- [withRelay](/tempo/transports/withRelay)
- [TempoAddress.format](/tempo/utilities/TempoAddress.format)
- [TempoAddress.parse](/tempo/utilities/TempoAddress.parse)
- [TempoAddress.validate](/tempo/utilities/TempoAddress.validate)
- [Storage.defaultStorage](/tempo/utilities/Storage.defaultStorage)
- [Storage.from](/tempo/utilities/Storage.from)
- [Storage.memory](/tempo/utilities/Storage.memory)
- [Storage.session](/tempo/utilities/Storage.session)
- [Client](/zksync/client): Setting up your ZKsync Viem Client
- [Chains](/zksync/chains)
- [toSinglesigSmartAccount (ZKsync)](/zksync/accounts/toSinglesigSmartAccount): Creates a single-signature ZKsync Smart Account
- [toMultisigSmartAccount (ZKsync)](/zksync/accounts/toMultisigSmartAccount): Creates a multi-signature ZKsync Smart Account
- [toSmartAccount (ZKsync)](/zksync/accounts/toSmartAccount): Creates a ZKsync Smart Account
- [deployContract](/zksync/actions/deployContract): Deploys a contract to the network, given bytecode & constructor arguments by using EIP712 transaction.
- [sendTransaction](/zksync/actions/sendTransaction): Creates, signs, and sends a new transaction to the network, with EIP712 transaction support.
- [signTransaction](/zksync/actions/signTransaction): Signs a transaction, with EIP712 transaction support.
- [writeContract](/zksync/actions/writeContract): Executes a write function on a contract, with EIP712 transaction support.
- [estimateGasL1ToL2](/zksync/actions/estimateGasL1ToL2): Returns an estimated gas for L1 to L2 execution.
- [getBlockDetails](/zksync/actions/getBlockDetails): Returns additional ZKsync-specific information about the L2 block.
- [getBridgehubContractAddress](/zksync/actions/getBridgehubContractAddress): Returns the Bridgehub smart contract address.
- [getDefaultBridgeAddresses](/zksync/actions/getDefaultBridgeAddress): Returns the addresses of the default ZKsync Era bridge contracts on both L1 and L2.
- [getGasPerPubData](/zksync/actions/getGasPerPubData): Returns the scaled gas per pubdata limit for the currently open batch.
- [getL1BatchDetails](/zksync/actions/getL1BatchDetails): Returns data pertaining to a given batch.
- [getL1BatchBlockRange](/zksync/actions/getL1BatchBlockRange): Returns the range of blocks contained within a batch given by batch number.
- [getL1BatchNumber](/zksync/actions/getL1BatchNumber): Returns the latest L1 batch number.
- [getL1TokenAddress](/zksync/actions/getL1TokenAddress): Returns the L1 token address equivalent for a L2 token address as they are not equal.
- [getL2TokenAddress](/zksync/actions/getL2TokenAddress): Returns the L2 token address equivalent for a L1 token address as they are not equal.
- [getLogProof](/zksync/actions/getLogProof): Given a transaction hash, and an index of the L2 to L1 log produced within the transaction, it returns the proof for the corresponding L2 to L1 log.
- [getTransactionDetails](/zksync/actions/getTransactionDetails): Returns data from a specific transaction given by the transaction hash.
- [estimateFee](/zksync/actions/estimateFee): Returns an estimated Fee for requested transaction.
- [getAllBalances](/zksync/actions/getAllBalances): Returns all known balances for a given account.
- [getBaseTokenL1Address](/zksync/actions/getBaseTokenL1Address): Returns the base token L1 address.
- [getL1ChainId](/zksync/actions/getL1ChainId): Returns the Chain Id of underlying L1 network.
- [getMainContractAddress](/zksync/actions/getMainContractAddress): Returns the address of a Main ZKsync Contract.
- [getRawBlockTransaction](/zksync/actions/getRawBlockTransactions): Returns data of transactions in a block.
- [getTestnetPaymasterAddress (depreated)](/zksync/actions/getTestnetPaymasterAddress): Returns the address of a Paymaster on a Testnet.
- [getL1Allowance](/zksync/actions/getL1Allowance): Determines the amount of approved tokens for a specific L1 bridge.
- [getL1Balance](/zksync/actions/getL1Balance): Returns the amount of the token held by the account on the L1 network.
- [getL1TokenBalance](/zksync/actions/getL1TokenBalance): Retrieve the token balance held by the contract on L1.
- [isWithdrawalFinalized](/zksync/actions/isWithdrawalFinalized): Returns whether the withdrawal transaction is finalized on the L1 network.
- [withdraw](/zksync/actions/withdraw): Initiates the withdrawal process which withdraws ETH or any ERC20 token from the associated account on L2 network to the target account on L1 network.
- [requestExecute](/zksync/actions/requestExecute): Requests execution of a L2 transaction from L1.
- [finalizeWithdrawal](/zksync/actions/finalizeWithdrawal): Proves the inclusion of the `L2->L1` withdrawal message.
- [deposit](/zksync/actions/deposit): Transfers the specified token from the associated account on the L1 network to the target account on the L2 network.
- [claimFailedDeposit](/zksync/actions/claimFailedDeposit): Withdraws funds from the initiated deposit, which failed when finalizing on L2.
- [getApprovalBasedPaymasterInput](/zksync/utilities/paymaster/getApprovalBasedPaymasterInput): Returns encoded formatted approval-based paymaster params.
- [getGeneralPaymasterInput](/zksync/utilities/paymaster/getGeneralPaymasterInput): Returns encoded formatted general-based paymaster params.
- [getL2HashFromPriorityOp](/zksync/utilities/bridge/getL2HashFromPriorityOp): Returns the hash of the L2 priority operation from a given L1 transaction receipt.
- [parseEip712Transaction](/zksync/utilities/parseEip712Transaction): Parse EIP712 transaction.
- [Viem · TypeScript Interface for Ethereum](/index)
- [Client](/experimental/client): Setting up your Viem Client
- [ZKsync](/docs/chains/zksync): Integrating with ZKsync in Viem
- [defineKzg](/docs/utilities/defineKzg): Defines a KZG interface.
- [fromBase58](/docs/utilities/fromBase58)
- [fromBase64](/docs/utilities/fromBase64)
- [toBase58](/docs/utilities/toBase58)
- [toBase64](/docs/utilities/toBase64)
- [opaqueDataToDepositData](/op-stack/utilities/fromOpaqueData): Decodes opaque deposit data found in the "TransactionDeposited" event log.
- [fee.validateToken](/tempo/actions/fee.validateToken)
- [Setup](/tempo/actions/setup)
- [withFeePayer](/tempo/transports/withFeePayer)
- [TODO](/account-abstraction/actions/bundler/introduction)
- [verifyHash](/docs/actions/public/verifyHash): Verifies if a signed hash was generated by the provided address.
-->

# `channel.withdraw`

Withdraws payer funds after the close grace period elapses.

## Usage

:::code-group

```ts twoslash [example.ts]
// @twoslash-cache: {"v":2,"hash":"c8560575f6adb5da1c18332da694d40e6acd6131d7975062be960ed33b48fc85","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIBjCGDhoBHGGDSJeAYXGSAPAAk0aLABVSzYVgik0CgK5hYAM3ZgYUCr1Ns4MAHw3gAHTC9PvAEasI/AGsAUVosP1IyOGk3Dy84iOYoIVYMXjNmQ1YpXhi4vK8EpLAU3jBmAFsYaVcQdRhy3V4QsL0yGoBud3z8wuTUw1JWaoJVLCiAenG6FoiAOhoRSzR5+t1Z2gwALw6u7oBfTtjPA93PX38A9XZK6QBGAAZHw7jBSS1+NDgAfmjTvORaNIRKQLABzAC60hk+GYFhkQjQ71EAB8cn9urxkHAIAN+DAAJJQaRgQzlbxkSGyGFwhFI3io4xmCxWZ77em8RkwcyWKCs/ISOAAJRgoPYwIwPypsLA8LezA+7M53JZ6K8AoAqmB2CRSHA2MLsawdZLodLZYj5SiOSYuczearPOVMmh2Pw2KwAMwm6ky2mWxU25X2o55Mj8ABsABYAJwAJgAamR2OYyN6zX6FQzA3a+bw9gGmTzc7MS7xbgBWXjlVq8EuzXN0GgmaQKV4iXiNiSwKAd+hduBokNxOu5vaORidm1E3tN7t8AC8jl4AEE4HB2KCwAo645DnsbIKIBA0Mv+IJjGgbEq7S4/iP3PmAGS10u3Ks1uu8Z+5Lz3sBj9xrl0fQxHYCQGCoERmH0JBoyoVgJFBNB8CQcMqDQaDQRgBhEBAfh5AgkAOEsJB7iofgYSRMhYP3dBsFwXDCB1ShqEbJg2E4HgBCEdsKO0Swhl4A0ICNKxAIaPRRD4sABJYqCYMQW4AHZ4MQ5CkBU6hMOwvBpNk+DmVI8jKMtajFKU2jqHovAmOo9C2NwttRAiPF2CwbJNG0PUPnYIRhVc9yWKSfgEFwzzhEtXyPBcmA3OWOSMIU8tNIQsAkJQxBNMSrCcJAGK4pY4iGNjYzoNM8hEAADkszAcBs4g7NY+hdJ45yuU5KB1AgAAFZgMDIaRvA3CxCPknDwzQoi1Iyit0O03KIlMDqut6/ryAMkjEBKvCTI+MzlJq6zGIa9amtypzeAcVQEM6nq+pgKofGGyQEugnDKo9VS0vUxTIzm0gcrwK60Bulb7twDbitKqiKo9SNDrq47mPs5rcJYDguD4C78LAyQoQI5RRnCuBgIMa8eRsOxWAcZxBzic5AmacJIl+IcChgRI+jSLkMiyVmMXiDmihKMobl4Go6gkppQmZ0gdjZnoha5gZBJqfBRgmKYZdaFZFmwlYJPWLZ5YxE4QzN+m/ECK4xYeJ4/leC0Pm+fnugBIFETBSlTRpOVMzpgXPCxHFSDxQliVJclSG9n1zTpLNCxVBW8wLW0iwdDthGFUVxTTX2natcmk4xDUtR1PVWGE0TSDz30/cL7N0+Tp0sldd0vShWOMwbxPgxL0OozjRMQRTGvO/TevU6DUcp5zO9X0rasIhfes/knadW1amcuysbeTAHH98j/OIxwnPsp2kderAXJdV3XTdtxLXcHwPI8TzPHFJCvRurFvEM/yfCvMs75l6fm/PPVe/5HDiVJqBcCr0FK3AeF9dKqF/qA0cgRQqhlECfR2mVPaFVqoUDoojAgJ0WI0FRiARgWBSAQBwPoDAWMYQyRgIJQ+YgIAOGkLQsqlQaC6mkPhbhMBZi9S0AIyIChOGWwuEzVoQiA6B16MUVI6RnSu0DoLTmajSgVEehLVYEBpYzDaCAXM2jeCqJKCrYY6s1Ca2mMzXWaAlgGzWBsbYFiM4n0sV4C23QGaXGuI9O29x/GeEdkiF2yiBbu0up7NKMcJ4F3ZLI7RwdcQEmnCSMkFJx753jtaXukS8j5gTmnYu2iBTZzFIiCUhS65pMqdPXxaphCam1JEfU8ARLGiaXHf0rS57JziC3F0bpWCelrkM/2Rc+41IHjGBMSZR6zO7rPJupstnVKPgvEBMAV5lPXi2C6V8ezrwPu0zwx99jjguZfc+c5eCLhXGuDcW4dyjlfseU855JCOBvrwbq9DyhihgK2PwDhZjCjQAMMA8Y2CGCcMWV8sZDnHL+AAd3YMhKAWhsUAGUMBgH4LwrA/DsIs14Li/FhKSVkvEVSwRcBH6zCBa8pcoKIDgocOy5+/4EE4SQSlaaGl0E6Ucqw/SREcF4L4jDJAFYEYMXIcjM6TA6EMLIJgPgdL8AEuYMS0l5LeB8MkdSpRBqjUmqZRIgxrKZF/GCQoiISiMmeBseonmmi4kYm9fosWRipZuvMWUnRwt+iDHsRrRAkxnE6wWG4/WNBDZeJNvsUcuZgk2zCY8CJDtu6xM9ZiQEiSQTJMGZs1Epa4hZNDjkiO+To7VsniM7ZbIO17NDFnEU9TSCNKlEU4ZJSqmLP5J0suPTK59Orhs9tY62nN2dG3aZHdh3NOKQsk5yyh5rLAmPTdcye7jpnt2idmc4DqFYFAWJgbgRgmQOCXZl7Py3EjJiu5nhTm8AUBch5zyrBPNnNfLl7z75fKfnuX578AVoE5W8nlfLIU7iCv4UKIAADqeLDWEoHJStathGQDm0D2bFsJPi2D0LwZCRyLQRR8kIaxMAArxTmqCUKyBkAgDoBUMIEMQAAAMROfHcBdCIcBnSvN4MayjcDJCzD0uw2YNqGWmsYD+ZTrAKAPm4O4ETQmQDggoDxylkiWLmcdZEXgABaEFLLIizGM6ZvK2EEUICoOofA9GtCMZdMx/K7lZMmA7CQSQaRmAYWc+CEzIAxrKtjOWFBP1bjbWylKkAanjWMv4NgzaCrdqCKQLGD0qr6oaqoblWh9DGF6oEDK9h0hTBgtmEi1gKL0MhTwOofE3VbOxnuA1/iKnhXKsjH9Ka30MpZXmrpRrrB8sMUm4q8qSB4YkKsmQ2yp0qt4FFvASleJuLCBEjAdwRBoIncNI9WUN2uuYe80coTbYztCffFATIRztVEHYLAUjl0gIIW5t4QwoJRRpWu2d2jMJRBikB+C1gV20AmLo+4AAUswS7RL+AgmC694HlRpJinKLwH7f3d7eFSNimA3gfD0OxQ4XUsx3DuCex9r7vZSYDjQNikxJNWPJldNxCSlhJBRFZ2AAAVCuXgQm7tvbEFwAcBqqzYUIHey6hgKKyYHC9niZ3Zh+FBIwbgQmbD69OwhWYZB6GkFN+9sjcuCdiIo6QMADuYdRYENoHwRzDAOB7Cj2lIIaC0ZMdoVIAA5aAYiABWA5gQc3KCz6XsvQR+G8GwZ3BuELvYsFBMlRzXjmFBAMXewfsWh/oyY5AQntV4jXLMEQSRDBoCE+CRgDixjxvGJAWACfZh6FBOMYKcBxhI+TbZogsZIzrHGMwLA7BxgN/gHAWY6tyisAAMSr7XC3nEaA+BkfcHXvf6+W+24713uNkx+8wEH8P0fGGJ9RfgGgafs/5+L+X+fjfaAt9d96FG81w0BYBSBSBuBZheB2cM8IAs9WAc8rcYB3s3QPByQORA9aVcND9eAgJJIwQYdnt79EAXd3tqxPtrdJcAB9KXKXLDaCLUNKOg6g6QWAzPbPF3XgeAuPVjNAAAcgHAEQ11I2XksFwzIGu3qXAhSHcDgFNXwHoUgAD14A4ACHox83pwgEZ0kOXG6nxB5x81SEk3qF8BgBsEgFIFk2Xjo1SDbGkMkFkLKHkLJUUKEBxAHDUKOXdG4LoysJj1gFmATwrWT3X14CJQeiIMxCE0gDD2Y3P14HxHGAAHlr9u9NZ79H8AZn8QpX8p8Z859aAF8l8V9gC19/9ADmBbNYiYBbMhBbNz9bNfI+BTA9B3Al4jkLBWjSBygosopU93AQh+NgcA9CC6NeA4CECkCbshNEBJdDME9xNc8xFjdGB+CfNpkTE+dBgoB+DuBDhJgQVK1PhpANi/BaU9Bb0bBg8D828ljkCjcIATd1j2FziABSOAfgmwfg7Y29PYg48YI4kaKIXgM4rYy46wcPRJVvNAe4m7G3CAvQRgSwbFJoRE+3fgrDQgBhOAGwbEYQwgrPHsGELAHAHkPY/Y9wQ40FYEjsdEtXNcZgLCELHsKCQIWjd4GvaE23OYsAQ4zwIIdE6QLEo8MYPE3ldXQkxIUExfMksSPkwEuIb3ZAGAS7VgSEcsRScsKkxUrwb3HHPHZYUgYwfEMAbzMUc0Rsc1EgogcoRSD0WMRSSqfTBUvIb3ZI7wXgj4WYY0sAU080uAS0+ga02PRAW03Be4aMXBZ0nUt00QEgkaMgMoVgUo/wNfLWVjNvKKTKJSRSaMWMpU0QFUtU8EWzKvWUgacMLaWMAsvU0QVUtgA0uKEM2ARARM93NgVMkAjM/gLMoQTKKs8Me4F0/kus0oUM9s5M8YXoiwKYNU6gx9NKLaD0XBSXC6A7GTTE9gaZISeAgvIQfgw4F3VTRgxgITAAEW0CwisIABJgADs9gABCXgS8tKMgR8oTSk10mk8XaQV8683gHDHcw8IaU7MAZ8/89864/nMA23AzETSXIYhoEY9cSHcY+XZY1ApHNcXk+CoTRYslLeXA+cCY7CIlREZPIlCUwgbFU3I8reW3GTHKcihIcoKiyoGiuiuE0QcoDABXYHEilEqHa3fimARgQ/GwW3L89ovi5Yx454sEi4nY/42Mn8k40E148EnY6C7gu4sAXi0S+StYxSj4r43gH4iElS7844kExS34yE4PQ/GSwy23JEoSwUu3NYkUnE8UgkyHIkmU0kiQKwCkgEoE38zEDyvQYU7EsUy6CU5CKU4kisnkEzKEuCsAbioNI5Eirc4CvcsCw85yuSt3D3C8q8yQu8h8iCiq0gD8r86kmyv82qwC7cxAkC/c8Cl82qx8nSjKwzShJkrjHjBwQTBtPETvdI3vUUZCQwbwJTXlPvWPBPJa2AcYc4bwcYAo+fDgTa48hPbgYzOLBLLUuCKbVBTKSVc6ZYpbCVfBJVRAe4crJGRqPbNGYQ6APgQy1YyoRkrCSUSPGwOsBhALZMh1coEEyPZ9bgaQIgCAP7c1AAajfBOj8ESEOqoDHzwDUp5xMSE1uPb2wOQlKBgGxSKmgIAFlV0BNrCy9Khxcfd0Dvtldf4ib8AiD3BzBdRRAA9d4uAoi6FrhoJUhfq9RmSncfDEgoA8Uops9eaex+apNvARA8U+zMqwA1SUVE9rhtzkda969jjTBGAPQzdJrRhe9eiwAlIh9sjiJDAijLaGimT4BpztAPRSiRpTBZgPQKjWAXTGBxjMJSRwJRDvCdzKU1wK99aszWBZhujei0AHczbHFe9Mj18n8x88j39P9Cjijl8Y7fbt8Y746osS6P9MIeAoD5iRMCLsZP5RASLyx6KHjVj+D4NpA3jdibB4MGrAScbhF67pBksoSCa4TDdW726zKe6wr+7uILwh6dLR6wBDNJcIijk68C6y6k6b8U679lr07sjM7J9s7tqiif9xgC7N8d9i69AE6y7bMK6WiaMOi8CwAy7+jBrOMkBuN4sLA8QWIiB7hZhbhgHHgjrIJEoRVwwxVpskA8EMtcpjdbrLr7q1sqpnr1VXqHI8It5gZQY7p+pHohoIdRpIHlUPoUsZpJsEGgZsIQYrAwZCHkHNJVtCESsNtSE1UdtKFsGDsSZ5Ri9liLsrsXcoQbrMaMMetNDLcZiOdgdyd/tZMEcabYBQdwdCCuDkJvd4d1xEc9aOawBMdsdcdmyuCidWEScyd6FftuwfBqdactCdDmdJd2cKDOdphJIec+dLocB+Ahd+ARddAxcTjJcZdlw5dRKsLlc2a1dkJoBE9td2b+aZHx6niHcLdjzXL7czcWTpjDdSrPctGpJfcMD5aoSq88UuTI9eAAj49E8KKKhU8wmJiODECUm89X7C9jsS8Nxy8g8tjq8oSz8yim8Ca0jb9VqH8D6R8j638RAc7v8Si/8r6gC0z98wDD9j8TBT8Da1mL9YKIDxnd7JmsiZmX9j75nT686uzyiVnz9L8ICoCYDNDJjs92mUDGa/dMDd4DVcD8D9AxjpGSCyC5GxEaC6CGD3cwQWC2CXnWnhKjkeC+DBDYmRDrCjlxC/CpCRAZCMA5CFClCPDVD2B1CojvAGcmcVx9DDCYBjD4BTCEILCaNoINDaXsWmwQY8XnCCX3CVCvDZMdzjwfN/DY8gj6nWKwi16oi68ajuCPAEikjUjk6e896B9pmcjx8LmP8rnz7lmACd8qiai6iwAGiRm4AmiIAn65Z9Kawujb6+ihABiwAkKabRi0K4X4C3myDcLl6a64Ax7rdW67LLLe7wr1Lg3tKR6Nm9Ljyg3NLeBTLvj7KrLGrgTTj437LF7o3YTCKHisnkTSa0TPLMTYrcT4q/LQQfBpSSS5TdjuBQ2ca6S7cGSxbvDQs2SAgOSBGo3wDSBeTRyoq+3ALS3fLJT/Lq2Ur5TRzPBlSGz1TEBNSKxayZ3RAmz3IfSTSzT8ALSEQrTkTQzwzbgHSnSRzdSV3eAPSvSjTN2AygzRB93WzwyPRIzozT24zxzWzJzOzz8ey1acy8zl3ZMiy53Szyygq+2qzYwazXTCywtGyTHgsH2qgv2Uyf26BMzQaBzEAhy33YOEzJAkzOyZy+S52FyklQRlzVz1b1yDFNygL2qCrsQwAirc34SCnyq3zbz7yDEnzurOP6qZ6mq+OAL6PdzQKmOar+Os3e28LELaBhj/dULK30LImlccLq78L/XWPRBiLSK0AWLKLqLtCuLtOm2mKyKGm2KjPaKvyLoDLliZMhLjzRLxK29JLHnDhiqW60mXjNilK/iG2hOI2rioSnL9LZLvOFL43E3zLk3Au02NK/PM3Qu9L7O830SC3UTB2vKR3y2x3K2Aqa3gq634uIrkBB2YrRSy38T8uq3kqgrUq+qIC1yt4NzcrROOrCrDg0u2PTyOOAKqqePJPryBPVKhPIKrCOvGOhBhuoL0rmvfWjMONhr4sHoWJxqYBlXNYZr8A5qFrygTnx9791rM8tqv8ijdrxh9qeBwH4syG8yzrUoLrZsAZMsXdkHKpoY0GnrNtaouGKEUZqsPqoAvq5Kfq19naAawAMAgaSwQbZbWBwbIbofobYb4aexGBkbuCdQ0aQeHtsabKoT8bs33tVcUTybeAqbW4aag76aqM0CvmI7A8bBVc0c372BubvmFaaWrGhbB0W3nbcnJaoBpbQa5asDFa5qVb4VQbhGOt4AEddarDg9hnPbjbTad6sALbtBran87aHbtAnasJx9Lb3bBbJAvafar7/bA6AZg6GaWWBXECmeo7ojN77XE6NeprVWpmbazncitWFmz6SjL79Wi6XRWAy777H6q71aFitO66LwZMm6A2VifP26E2u657JBSv1KM/h6bjs3U+jK27B6p767c+QT8/pOwuV71apWN6I+46Pft7vfDu/eNWs7LnzvrnQ/ACb6ejS6PeH6AYuJujMU7XB/QbnNlvv6Rq/7BNAHgHQH7hbuTrBsYGLr4G5tcIkHIYkBPvUG2H0HfujpMHdtsGJN2opxGGBonoSGxtqzJsnvUtkstJXuFpr/uxb/ToioD+vvj+SWDBtw0B77YDE/DbpkIw1oiNliYjZAvjzCjSMQWbjeRtYwpwA5dGKjWnGDghyVtNGsOPAtrT0bK9UcPmDHFjmYBrspIDncxtoEsYKNKc9jOnOS20JM518LjTQigKOQeN9AXjfnL438aBMhAIdH1s0wwrIEoma4GJsDwSY65kmsbNJmbgyZyV82OTJ3O8xPLu5CmBAhnqUywKV5BmweaprUzFYhFGm7gZpq8zaYgsC8GEIvCdlLx9Nymhg/Wn/jGZbdU6+9DvrM3yI99dWZrQuvc2zZbMoAOzNwQc1IBHMVW7fDOuczmbas/BSzAIXczNYPNIC0Bdgp62sGYVPmegn5jgTbx4EJIALd1sQVDLIDoAX2J1rQXoKMFoWUuVgs8yORWCEW3BT0siyELq54m6LEmhISsL2EcWjhLli4QoiEs+WJLVlo40pZ6EDCRBOlg4DJCMtxyVhR3rYXZa4t3AXAHlsoU8ITCnevhYVjU1FbBEk8FQSVpEXGIytjwiLeVma0SIpEohGRLwbEID7xCg+1zPVpUWqLXDjWprPZhaytbtFbWb9D3v0Tk4KdMCgLZofC3eazENOtdMHj52C51tBOCXZETXxjaIioufnGLhZWUqV902SXCEhiJzaZMMu7lDLiWyq6jtEq47errW1CpjdaSWTAXuLXbYYR2STsLkmkP7a6kKuw7akXl1pEFcJ2DXKdmeyA6YgQOC7LUoB31IIdr2fpLdjuwI7BkkOYZO0ke0dK3AYyMHMcpez4IbslRt7XdmqJtJ2ln2UZD0LqOnaSj8OgiKcmh1oAYdsySkXMrcHzJ6jz2xZNgKBy0DgdsO1ZOUfWTVJUCWyyHAjh2VQ5mtf2mHJSIOWHLBiP2EYh0UR2lBzk2AZHStBR1KxUcsqbXcylN3E4Hlm6vXLQf10qrcdKgvHCbqN2soJcJurVfKsWK6q1jpO/VBCurRdYoUoRETHIfhGVw+t4+WVXTsxUs7sUYAnFWzgxQgLmd9O446ziZzs4RcbsjnQts52WKudLwTbaSuF2+pIiM2IbVERFXREpcc2PXVJtiPeKfEk2R4pkSeMPGRtHKqXFcYbnzYUji23lOKjV2FF1dAqDI+tsePUrlchSAonykKO3Z0j/xxXNKsHgyr5jaO7XNqmJ06oscLx1udjo2MG7VjZudVT8kBJBKNiixnVXCb1Xm7WsBqs/FACNTW5UANuHgyYDtz26CADuadSZid3gJndc6l3a7odViwQM3o7DW4JQzuo0NHI4jOVJtDOqsNisj1YAQD01TvUuhIPWQFiMYCi1Ie0gQGivHh5CA2ASPLSSj3BAw1eAcNBGpjxRo48IA6NBASAEbbB5ieMJUnrhhJpk1mQlNamsDlp4h1chzNSOpCVZ5kD2enPMpvzXGKC1ei/PDSWyIVo7kpaMtPSYgVCkJNlaLoGXlFDl5a1FeSOEgdEXN5oAjaJtKIdrytod99ertE1pSmN4VSzehtb2r7Rt6aFvJDvZeD4Rd79M3eTfLel7wmZp1vBcQ3wbnXPp99r6EfKPsPxj5OthxpneDMn1LGXi1iGfTuuXwvAEjs+2QAvjBRhLF8J6ZfbuhXwIkD156vATadCVr6dj3ADfITO7yn6t9epzww+gNJPqJD86TfFZgPzvoTTR+VrCfiCKn4f0qJP9VCv/SoBL8QGdsNfvd1nyPdxUuCK6ngD36SSGI0korGZGIScMKsWDahFfzYxsE/M3kUGv5FiiBQJG3WMKPjMiiBZWMxM9jHd0ElbQlIz/WGS9wwRuY2MyDFGQQlkkegysp/bbApLeo0JtUdWZhF238xRQlAXAfANICEz3BaAd5RcqCD2BLcQAWNXCJLLgDs0IApgGHPDgYwEyooj/WMJVG2gv8Zob/MSdQAplMYwAGslCPv0QCcyHqkYW4HsDiyCBYAeAf5qIGAAKZtx2mFOC1l5TmVZgW1MCCnh6agh+CLXYQD7JYxsYbAi0ZaAQzIB4k6G+DVaJEXzDzhdgcmPFH7KUwLZVMuGW1Llk0wOwFsumWIHsBdI7SfOERa6MBjMp4MGGKcmAC6QUHPFhQS0C+GZSTk38U5kBOuc8WJiUyPAMITWYgD7nUy4o8wa2aDTtkY0QAAiZgEgFACTh1wQgPAJ8BAB7A9gQAA=="}
import { client, channel } from './viem.config'

const { receipt, refundedToPayer, settledToPayee } =
  await client.channel.withdrawSync({
    channel,
  })

console.log('Settled:', settledToPayee)
console.log('Refunded:', refundedToPayer)
console.log('Transaction hash:', receipt.transactionHash)
```

```ts twoslash [viem.config.ts] filename="viem.config.ts"
// @twoslash-cache: {"v":2,"hash":"5b99b294a58d9aeca640e4b68c65a78c783204a4cef43c730efccc9f3e8dc602","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvEaRjMaAYQ4wwaADxpSzMHCwRSaXnRpgocXgBUtOvQYrT8zdlOMqzvBY+e8APr2Gw/M4wULwAvP6mMEFgIfbMIiIQwmgA8qQAglBQsnDmrqbmGYnJqr68WTnw5n4B0cGhEXUxcbykWCIAyiL4MAC2zEb0buYASh3dvQPlzQ3hkYENAHyMWMxafTA0pHCIHsqqCpJBAOYa1rr6aPY9TmDxJSnplblw9u1dPf3MS9x7AAqyNDifgYNRKdgqdSabSXOwOO4PJJPTLZV5DEzuF7VXgAfl4gK2ILBACk4JJxiJisjVGoEjS0qiqnklkteHt6aVGdi8u8Jl8BqyADpgdh9WyGGRyRQHBhUOBodYMRAATiorBUJzQ+CQAEYAExURWkE5bPBS+QwCFQyggDixJAABioty0YjISBVAF8KOhsLhEARiB6jcYmGxODwBMIxBIpPhgVg1B9Jt8MSNeJTU9NalEWo0FvVYlB3swAO7pwq8ABGEAgGu0834bDgMBWglIrFxewVpGcJxmeYaN2O7BO3d4AAlE1ZYRKjmBTsn+VNmKWy789tO0FhZzYrsvPqv10sRWKJbwEzvbYqTggUMgQLA4DJ2FhxJJbQpZJbzINJxYFj/LwML7gYIGOJKkixGI5hoBAvCDCSnSpAAcgAtKM/wKBU/wAJIAHQgAAusR8rGsq+oAMzqpq2pIAALEa6ymsqBCJra9oBs6ICugk2xINRPp+jgeCECQ5ChvQ4YcFwfBCKIH5SFggjVhwVKxpIcDnHOVyVu4e5woYESGRKNxeC4wxVp4dyDosxbzDZ3i5vZrScik+lFI8ZQuUWITzNSXJ2X5UArCIsp7NatKgUZ5mIoh3loJuBKqepxRKdpMVmQizhIlyp6iuKekqWp7AaRltoKkqglqnadE6oguo0dQLFmoGJVpZpOiccETouo4boCYg+rer61D+mJwaSdQYaBiwslRgpXW8GWbAamg6VxplFwXgUBk7VccXeHt5hOVIvn5o5FnBfmeUeSdFSJTdcwRIFHkXcsjDhZCqiRbKOlgdcOX3AlDLJQA6mtWybVpai3LloP5WeRXgatrDrTD3XkdViAMUxdVgFqDVNcxJptSAaMY11CDqr1iA8Xx7rkLjDHCeNomBuJIYzdJgbnnpb2qJVFFIAAHLqtGE/RiAAOyk6xeCC3Kdp0xLvEDfxHqqmzmAc0GEk3rNID8+BZ3CzjKo8RqUsNQArPL5Nm7TDqNf16ya8zuqizrE2c1Nhu8yA82RvJMZKSB/R6JjcCMH8vAA0ZnmWAd8Lw5ZmKnddH3FndZQPUrz3FmFEX7D90Ip0Dae50lfBhGyAAiMBJFo8GkHDFnVwVJuGDQRXR+bBienLBNE3qhotWTbG91H1M9S7auM0N+q2z7etc9NNCB0kOiSiXUXqNuu4V2osw5wILZtvYwAirwt81qwEAiAA1gAorQWAP7IOx7NfUh3//P4oCSFYBgXggRmCCFYGgH+N9/5wNvoA4BoCwDME2HsIUIALCRwQm/D++gyAYIANywPgQAuQQCwAgP8J2dB7Edy7AAPQMLoHg2QBEaAKliGgdh2CCK0AwAALyISQuBXpiF/1vmIkRalH5PwsGKGAexdSOhUeI/+28YSwQnL/UhvBkC0B7JofsxFIoWQXJowwfgdG6LvsgckHYRAwDwlAPYYBBB9GrGQExHgzGSAsYXEIajSFegCVAIJ8CVBwFGDAE47BewYAnGdcxg1QnhLgZEgAqqKCScA2DRPJKwCSiTfGqBSdnQJIj/59EgeIEQa0qLFLuMk/iqTKl3zICIAAbAxFU+oABqZB2BBDII05wzSxCtIkbwEJ5SwkiIIgs3gupba8D6Pg3gCyCJpL2nsOGWlDB7X8g9ax8DNlpK9CsQ5Lj9IhFrmyDIeQxxgDUJspY4ifSPQZARUYdYNqJXsKfVoJyNkLPebwAAZCCgiSzVnrM2RC3gwKzkiguQPZUuo8aS1HogTpDs2LfRtM7AMzVF5ayaqvAM+tuabzYsHOS0gfwyjLmoQ+pkDyApLOfVgrYlhX2kQ/Z+uDP5kF2IitpCDyFILAdECBUCYFTN0YgyhyDUGKN4BgrBRVeBCvwaQYRCrSFKqoR2VgtCrxYEYcw9+wqeGcK2DwoqfDBH6t0VIqZbr/4yOfvItBSyVGOjSRowacBtHir0QY3gvZjGmKaX4spYqDXwLsckUgjjnGuPcZ40g3iklxpabMtJ/8ZmFnzIW9pOhomxPiaMsA4zLEloaGW2+mTskiryfAesRSY1jLzRMgtYbqlQLKvUmtdbJm6I6d03pAy+zDNIKO3t9aOXnPHXfeFyzYWyChdsqy1y1BXMubukIewrl3IqI8k4zzXnvPsErb5vylYAqHEXVY7tNjbFFfvBcS5XlxyRaClFyMLwWiZYSkAVVB6NVts1a22KDR4vNIyq0so57ErdoNLW+p9QUsmgbKStKsCkAgDgAwGA+DuVUBOAABo6WgAASYAUbCZeio+UAufg70/IgH8hkoTbRAJEPeTBvRPlBXgv4VsAh9AQRgKXKE0KLD4DiStdg6MayycEK2UI/BpPRwgvINoMAACOgh2BbsbBRwwXBEJSBYu4+TaK9QyytvVJAw9jQK0DJZ1DjF0Me0Ejhv2eGeZsW7qJlIjnGoy1qrB6W7nWpsSVj53GfmmZ6l1IFqlG8jZLXDvwIjfROhNywMvTpT9dRqDvfliAhXiulfKwRVI74torEI+wIgloADSMAMBbjoPYYjGUJxVYK0VkQJXbZld1I15rWk46cYfYlEUKDNi6ASLJ6rtXxv1d1Pxx+Qm8I720OIX8NnwtlE24hXgY2JtTd4G1jrNBeBPx60RZid4kDIEfHQVBH9cBUCo4DtAcAgN6WAOdwwITLsAHIiCQj6Aw6eEBocihFNvBUiMPKvUSgRTbN2duMGh7RzZ0PuAikB1RkiFBHxrA2LaB7XWevXbq5N8r92+yPdky9jAREyKPiBB2LGIA70kTIuBkWjVRbD1i8TZqHnyZ45Z1N5L+NSWe1GiJSl68A4EaIyRzAfA041vKMCr1r9rW6tFcCshzAKFUPATU+VNi75GpVb6jV2DtUW6/i653hnbdSpNWaxMlqWE2o4WgLhDq9BOqESAJt0zzlpLNz6tVyjVEiKDfxENTvSH6MMX2QmOaSn+KsWG/+yaHFOOuW4jxXju21sXau+Bxbl1hsiZWuJmgEkN7Hf2xNRgdBZPa221g+TO0jN703/vujB21JHVP0p+aG3FgT5Onp/TBlzoXUvvtK+Knuub1CpZKy1lbuRVMnZ8d0cHKPaEY5YaL9FsPZiY9NyoBnoeXAJ5LyFlvJRXxlQAJkJmdFJqQDJtILKG9uLjjPqCTCPNLPbBPJ5urHcMlkgWrgFmNLrFrv7PhngGFk7DAZBlhi5jbEgEgfLmxEQVxBQalkNBruzLgcFjSjJCHNIPshHHatAgmp6gKubqwiKrnvAq7tKs2I7rwX7qIStmqh7lqjqj7vHuXi7pKsqtQqauqnQhaogEwmHvgrapHvakjrHr7i3knvyrIqnkov6oGoujnpIUmhGkxicMXrGrvvWtbnnvYqmtXhmnXtmovqXvvnMgPq3s+gfhOhWjEl3qQD3j4m4UEW3gPi2iPjsO2gUl2vET2u4UflUjUsOujA0oEfGkkROqmlOpvrOpCPOsUcvqUXfGEa5CEf/OuqfnCgBpfrursjfu/knJ4bfE/g0S/m4G/qeuEPchelen/u8iKCwnpBHlwpFlhriggQ1PFpPHgAsWaESnQagRhp7CvNgb7FljrkwIRsRmQAbiBBXFuDOMfByvYM2Nym2HtoJngIprJlhDhFlFcEsVRNLq5qqAhoGD8YPDsTivQZhpltrvgXNBGPSuaifOEZyk8TyowCahOM4aEiOIuGOBOKyhXN+mOEiU0Y8RfMlASbpAYCSSFGSc8V3CjIYOajeMwB9g+E+PAK+LNmAF+Ehn+FOIBMBKCT3JBBwWADBMDiBAhEhChBhF8bhIRKLtjCQQxKLFitLPjFQWJBxOCSsZgY1FRNCXgSFmcXrpcWRvpLsv8KlGVNHCyncVSeoA8VyjynylMmbgoUIQ4XAqIQ7nKt6YqqoVQjIbQpqnoF7oIXqkoQPjbnbqAkHpoeaqHt7jAAYVHsYfwnHgnh6g0cnvwVYX6hnlMlnlosIXAvnpGkYkXrUXvv0eWd4WmjXpmvXlkY3jkTPsErkeWlEtEdWjWUusiWvkPq2mkWPh2oUpPq2X3sEQnnPgUawEUVOdPjOe3uURvjOkMtUTvokYOSIo0SFGkq0ZurJoMc2l0fHAeowFcienfp/pMb/gRP/mAB8gttxkrKyIwPwGAHsF9HvP9L+uMSlKVOVFtA+b8IBfvGBUsZ0uPDLkgCsVqYGHtMlmqXsf5ogIaUcWvMaawXCQtKHIpHGPdjaSBbDMKUnGyuBCZBXEdOnBmKAbMldLZLMtXEnOxsEQFE9LMsXGXH9MysKbRZ3HHNacBXaQJcDJ3KDuBB1LabPMqZRJ0jFoCfAYhSADJaRULrQYgKhfqcokaSwUbKsGaaRnwFfmoJDOjNDNTGoKbvwZ6d/AGSoQHmoX6TwXWbGVKiGZoWGTgimVGQnh5WoQmRgkmToVaoIWmUYbwpmaYaIuYe6fmQotYUWeonYaGgPhWc4a4dkUEe5bYg2b4bwLXlmtlW2TuU0dmV2c2lEVWt3tuSUbuckcOakbkmORkZObmu2SuQPnOXUoUfVXUY1WUV0uuVvluf2UfvuaWiIpEhYKwGYBOKIc4cgMREfuugxMedujNeefunfsMVENcmMXXOet/pemBTehDvem+YlB+V+T+QSr9HJrSABcdRZVTBlGBWepBa8ksVLuqQ1AhQlngMheCbVPqZhZrrhtSoZfCYtGHERZTFZR9eRQ9JRZXNdA9AxRxREFjc6ZZmxVxdjRDqEjxVCHxVCAnNlFXJjqoBDFDH8h9dTZZgyReIjQzVtEsSqPjHBQacCRTPTf3KDZCZ7I6PpdDYHEZRcSZZafHI3M3PIPoDZRYYKn5VbmGr6TKhIXlRKs5cGaqqGZ7vZbFYGbrfGTQomSHmFXoWwlsdwhmc6tGa6vFXwZYUlYWQGpnmlWWRXk4VWS4RNWXjGflSmo2X4SVQHd1a6lVYPj2bVbEQNXvvUREs1TkukRPjUUuV1UnXAr1QvpneVQeauSNdOmNR1SXg1RVXuUfrNfNfYUtX7StWtYshiptaeTLbta/qFFeXfjeZ3XeadVMY+Rda+TxvlCsHdbwL+bxU9eoC9Q3E3PoArW3HPTPVBfJUgFRPBqsfBXzSDSrPPAzBrGlhhWLdlhLbDXwEjtHLHLsijbuuYGjbRUnLjciaxfnITRyqTY9ZBeJUzTdWenLYva3O3PFMzVJT3NgoLcQcqJvUpeQY1OPKpVfXJfvQGMosLXqKLVhcweLaFoyfEeKTAKwJFlRAxEgTzesSgTZIQ8Q+CVvfqYwTgVDWffipwbcDQzGjQ98uOSQFACQ39dvbLHzew7ELQ6g3qKrkfUNOStg8w6cXzPg9Q6IyQyqACfA5Q47I4DQ8lhihg8NBDUwXI7CSALlkRZtowB1qwIIGqko0Q7jgVgRH0mwNY3HLY6wPYzVtw2gILhYP6Mtqqmto4gIAVq8QdkdqoJwBwldhYHhP8OhPqI6AiDQ4Zq2KQCQNKi+H2O+PoARKjmANSDAO+PyTE3Ewk1KS9lIHhPXLwNJrbsyG8DZqEK5eYFRlLUvaxtoFAOThAtqPoOwAIiEJ0E8mQKxuJtqLJgM0RohGiNUNAbePeF9iAD9uKBqLaBTpKWgGWBAHAKwFwPgOA4igQ6I9MsEzVrwNDhALQIjtgijmAGjmw1o8czjY83Y+Y9YiwmZv2KhJII4pOHs3sETrQP6sCyC6C2C+CxC5C1C/qNDhQLAmsBgDAGqoC1hqi2i+ixi5i1i+i7C/C8wIi6QAC7RrqCS6S2S+SxS5S1S2S7i3/K1TwYC1C0y8yyy8y7qLS7fPBBU0ovcCimTmABTlTjTm+raJY9Y7wOhJYCJiI0Qxk1ya3LwM4CpNwkKyAALqQELh8UVfoAMBwAM6EDK6wHK1k63LzmLhBsqAxI6OQ4CZqUDYGJtjo5I+7MfZvaffI0HOcfrhaR84XicN86IDAH83APgHsDRvRoxn7SxqE+8RcPxHGOhLABzv5I4CG4hJMf5GWL0FIOM0k8c6tOYBccWNARa4xLo4I7qBo2xL618z80G3szoxgVI1CbI0Frg6aVLVcQi0i2G7Rgxs4dG0AftorE9NqAZrII4iPuYK2MCBqKEEQMkF8OAQi5sKoHACWxLrbI6HA9ipQfa2pfi0izo8PPqdhq2yccY5Ld63wN24S7wOG/21G5TkO28YGAXGO4YApLAKELm4a404ZpOyQOYLIF++u5FpNtzYCXuxse1Ie9NFpV7Ho2e5DW2yw+aGw3+cypSYDDSbdC6ZfN6R6ard7U5XGWIbKm5coTrWR15XIeGUbY7VIUGWbRoSFZbboSmZFXbdFQ7dmc7XfCnm7enh7cWV7Y5bfJlX7aVdOdrXogVemkVc2QEfnRXYXaEdHR3r2XVRHdnf/CkanW1enQnQOZXT1fkX1QucZxp2uSXVUWXQkap9NYfh2QMc3W0efh0XpztT0Vcn0Y/p50Md3Z3b3SMR/oBV/j/teiirejjlxqPSkE+qSd6RfiEpCuuq3YspCv+lsiiksOBzLGrDzYDTB7xChnQzpc28zIw8cTCSaXNF6+aeRolHsCPUli+0JlqwXBAPwBAfvBuzjLbDLKhRQ3zd5uV3o7qJ0u65ew19LXU68L2xGwO8+9AxQaLCsSN8geTPN9UDoxVy60vKzOe7V7hZ68ZVcfS4t4+364O0+MO4GBkqk+hHAIIFgB/JCKEPS1KWAl3v2KZmm9xr0KQGWHErJuwLABE31Xm0Q2B+vYgLbKo/9b5lt2xPSzo2DZV1gShxe3V2d52xaVyyoHsBYBABU84s8DM3kGoA+5Gzd1Rnl+1+8bE/E4k4T7ZpT4W+AVU5eEQ6ENWKAr+y8+45Fp0jLDa/A9BygWz8lgk0h16GLkkLAAQfg+DiBshmXPYOavYOpdHPYGzXplDgVuc3Dv0Lc2FuDo+q2fYMgxlCczDibwjkjrc7Me/HpD0Q9cZAytKOr1CIwNYpZi1zjorttqzrqITsTgsqTnC3/GnA3lx9H5yzcZeImLHNH16PywMXtKsCRdHBnxsln/r9THnwRFnzb1tLHPywc+Dm43b0b7DvDtc0VM77EK7+BO70L0xVw287AjW4TAG78/8yIoy6yyP6P6yxy/doe8i7RjLAxPqFAFRLbAoF0p0qQwoNa1RCNMvMwFRNWKLHjAAEIiAqgwBi8qi2z8COjVgvzVjVgT+3t7Ae8ESWbP8c8J+RpsAMu0Zj8/+/9gsT9s8iWtABJiID/6st2WafbgLaHfTMAkAoAAoN/k/AgkEAXoL0EAA="}
// [!include ~/snippets/tempo/viem.config.ts:setup]
// [!include ~/snippets/tempo/viem.config.ts:channel]
```

:::

Call `channel.requestClose` first, then wait for the close grace period before calling `channel.withdraw`.

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `channel.withdraw` action and wait for inclusion manually:

```ts twoslash
// @twoslash-cache: {"v":2,"hash":"9ec05dbab49dee3718971fa040975cf8d7de00af36ddb4a12257220782dcd6c3","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcvOaKaIicAMIJYGgAPAASaGhYACqk4sJsHJkArmCwAGYWMFAUnDWhcDAAfE3AADpgnP2cAEZyELwA1gCitFgjpGRwyT19Aytz4lBCchicteIVckmcSysnA2sbYFucYOLMMMndIAUwrBCcUzPsZI8A3L2np3Om22FVIcgeBDyWAWAHoYXRPnMAHQ0MSWNAol5sJG0DAAL1+/wBrj+y36JKJ/WGozGBRY904AEZrCzSSsYhlivw4AB+RaUk7IWjJMSkCxKAC6yRSDgsKSEaC5XAAPkcBQDOMg4BBQbwYABJKDJMAVZiDMhS1KysDyzlOFWcKq1epQNnEziqp0wOqWV3qgaKOAAJRgSkYoowfKt4jlCqVHsd1W9Lrdp0DAFUwIwSKQ4KEQ9q5DmozKYza4/aE16fQ1UydmPsBLxQnIAMwl622xWVz1Jmt+sknMi8ABsABZpAAmABqZEYdTIHbLXfjvedvrrrirfZTAqR+6ZAFZOMwvpx90i6wFFEbOJkOWJONek1An/Qb3A1YOVhfN+0gs+sC3oBDRRAAvO0PBwHAjBKGAmQXu0pLuJwQYQBAaB8DEVRoE01Yul0e77shnAAGTngejInmeF5kV+P7Eb0rjtL0LBlHE6QMKI2j6GOI7yIoKhqIg/HUJIuiBPEjCJJQZj1EgjJ2A4SouIg0juJ4OB4IQOayTQ9B4CEYSRNEsTRA4YCWOCqHwBARYNKxrwcOZJRWbJYiSPoh5jgJyiqBoWjiXoeD2K5MByLJ5iWApSmOM45CIIy6gadQXjab45D+AZBgPlwDhwPgyQAAbWLQAAkwCiuKrhFe5PEyJOvlCUgPliTowUGPlajyPJiCtrFKkJSOKWYFpnUZXpASGaEjDhFEuXRJx0qcTkUJFCUcDsZUO6+k0LRyG0nT0QM1LjB8szzPy35nDA6zAjs3p7AcV0aqst0XFcNx3BCzyvO80wXaQhLXYC733aC1mPPgUKwvCANfJiaJ6Jirw4viwMahSg5Yysp20vSyTMqyAoct23JRscAJCiKiripapaxna/AJpTr2atquoGreJpmha0qdhWzNrsmG7+uS27rrWYtPsIIZhhGS6M2TDr4aLIMy3AmbZvM+a2fZpCK+WTMqztUvqw2ByMM2chtobK49omksDhqw7jlOs5iguBv88ugsm07m4SyLZsMUiR7UXMFGXgKgHJPeZkga+gGfqzJy/gKzEAe+L7JIn4GQdw0GwfBiHIU0aEYVhOoZHhpuNMd/Tp2AW7kbRVGnpHtHkanTfMY57GLdJGR1Z5CnWIeTX+SJgXtZJnGRb1/UgKFg0KepHipWNPi6VlgRBFgpAQDgHAYPNFlWS9AzxBAbTJPvjh3DQubJEYgjCEioWWeFH8jG0SIAAoPz0PMTIqdcYjDOvDOYz8G6vSBJcbYuxGyXzZm9O6CDri3AZI8X6bB/qIm+CAOsqDODwKuBDCE0N8iwwRBdRGaB0Qo2xLiAkRDpYrBxsSYhJ0IH42+kyFk1huH9FJkqXkKDXrU04FVZQ9MBbGxZuwqmHNSB6kNMaU05pSByN9go4W/ZhEnC3Po3c6sViBjluGRUkYfZK1XI7YOztUEZizDmPMcgCx2WLLYo2ysg4GKUf0C2TYWzth8fbIWDiAlmIDKot2M45xeztn7fxpjMapLVhqNux4O4wCjoY2Od4FqJzfDQaoKdAn5OlpnROuds5AXzlBGCcEEL7iQhncu6FMK8GwhkdojT/6H2YOGGAmRX4mA/ufb+18/4hjQKCMA05QgVA6HWNuk4I55KbisAA7owVQUBig7IAMoYDALwO+WAgFPwWDwfgb84CTLCnIJEeyDlHNOecgB1yQGIQGUMkZrSkTtObiPKQiVGSNTMIJKemg2oSRClMiKPVop9QGvaVSk5hob1Gt4HSfhqBTQMPvQ+x9MBRDefgQ54gdmXJ+TA8Z79P5WVefsqlRzvnFEfiA1OeNzpfBgWAm66CrhIOerAjUZDthfWwU8LEbx+XQIxqgqVjowSUJhogOEtCEaogYcjGgqMWHKtOJw8kdY8Z0n4UTIRJM/biIlQMKRMjJThJSaqIVpwtQ6lUVzDRvNtFur0VEtJ7oTGZIBBY0MVjSA2OjHYh2qsQ6RuEFrNxutCzePjb4+xSanGnGCVbUJyTg15oKXEicCTPbSW9tmiJ/tHGB3Dcm/ogYChyCgA61VLrkASgyS2qOTIxybKqYOQpmRE7/lqaUm8oFOAQSacXIFIKUIV26b0tA/T52QUGRAYZbQxn3Imcy7+lLqU7KRHMhZSy5ArPaLJDYvAEAGAAOpsvPZ+K5GAyDNCdJ+cQNQn6cFUHkmZeSlBcjycfQQSc5DiGhPAJEelxBKGfcgZAIA6C3BmLgKgRV8NoDgL0BaXV52cBpTGDiQ8MQnpeWeo5QRKa0YoExCIvR8O1QlBQDDVyuWyV41gm5nAAC0nBAFcuAbmJDXGMNzHmaQYQskCj4Dyd2YQ9o36cC6tJrjIAPLgshbYaFflhIAA4Z4IoMPRmlC9UVLxXhihKrYxwjTSuNHehLsrBAPkfMg5KXJf2sjUIZSIb0rIfaMZ9Tx9T/2E5OawAWWVgv0IyVsS8FAmYCvCjqy8kW2asK1Bz8UkCTlc1vfFmVPOSTMnMPUjAsCHF5SMQYABxcIgyrYwCjIMWCFgG3RPARAVr4R0xtCgN13rGR+35qGLw7I4RCqcHmwVC1vCABymiyDJB62GDIq2aRWvgBIVgE3dv9dDSIv23AoCHPgLc67t3oIJhNDbabdZeCmn2OIAQJA2uazG9tybaArw1BqDAe5v32tij1IDs7dZgt7pfjduY0E6xKBGwDoYQO6wjFQ8kAAMhAJQmQdt9aaDzLRe1WgdF7TjoncAABCIxEdLboHWQ+GEowlXKpVWmygapvYFB5eZtzHhwAqD0u7jwEyPDmDmGgUATXAYgEjx7n5VQvbkHWNTeYj1gGW4tg32vijqb1/qJMwpribdINrrwyR1qm+MGAAoXh4cwBgIA79tbucVRdQL5tM2wcwAKBAMYiguelV93zpQ/uQ1qxbkcVwyWFKHkUsZ5qiA4XaEsyAWrMB6tcTkqi0SRWn5IGxZpPFE1d7TWMvNMyUlEjLWo6tfIDvNrsCyHmqnB0OiEUHHyqBl1HX9FVWKxrlTVUyp+vK/BgMleSrBhgihnAoaau1UP+hjDDXMPRmw9WZrOCH8tQTARxNByiPtA6z1mpLcup0QmyJN+Vjes5uoq3AaH85sTXXQxxi48DrmKyzRoKxBp+IB4FKpquI6weJ6xZoMzf6RJlrSyFrWy2xgG5q/7SyuyVoezzg1olrgEAEzb/7IGDjZIjrbIBj1JxzFL1INAzrlIj6jocJTr0HATsGNKFzNIlxtJlyoRdJVw4S1xOz96hwkStyUSUEHjdxETRzNwsRZhORUYyTcSjyJQjhwoZYZ6iTZ45aN7DwopWAl7KSOYlalY4pubbwEr6R7w+ZkqnycA7KUYABi7A7eGmQgIYdWDWd84ktyL6rh7hJuuuTu3h+eDW4mgmPKAog+BCgq0sY+j0yCzBaCH00qWCM+f0iqhChiaR4M6qq+kI1CWqcMBCW+Bq8qaMrCf+m4+24wh2hMgi729qFM0szq0eX+9aiiMS/Qr+vq7+FOfMda7qxBf+gu6sUa8s1ihBmBAc2BUB2suYGaXii4GBP+8x5sjYRaNsYSIxpaWBkxFa7siSBB6xSBhxHCExQBcA7anaUY3a0eva1xAwbcw6uSLB1BZSt4E67BbB3xDQdSAJUAXBRcLSpcTEW6C6u6+6oyiEEWT6eAgR+yn4NQ7AwGKmmoHheuEoQQVC0IpRRA0kzASIBUMIj6cAMISgv8eYsaMIT8zAcAAAxDrp4WAFEGgG8OaJwBYPEBUEBJwEIORpqEzjSLifibDESS8KSfgOSZFlSTSZIBgPSWQIyUyXjFEEEEIKBkIHUKQMwN9m/BEE0CUK+CBn0HJgsp+CBliSEWyTZD4WgOKevjCFKSSWSRSQqTfLScqQycyayXrsJnngXhEGHPqDUBiXktiU7qQjAPLnAE0OaZGeRnrk4YwK9qoIfDsuRn0GQIfKQEiL0L0KJgACKRbJASmEnEkylylPowhsmUlYAVDDBWwwjOH7JuGkDRlvzhEF7Fn/TYYKAVkukeTjAtloB4gfx7pUlsrNltlxnMCunEn0lzAwAwgGkWBwyDnwArkbQNkAD6bQ1Q4owmAZTuRGYAomAAUscgAPJrbCZBj/wpCcAACyeghAnaiARIom/8dkB0moRUH5+5Ek3ZXh4OERaARUzpJR2qIGcwpoSI7ASg8IYA5JcZ4UvmuYtZlJ8G4YMIAAVtqJeaQFgLwDCEycBaBXaXrr2Q1lEEKbdPYLNjSImAIHIDyXlOEEMO7n0D5nqNBA0IWcsKJuGcKWBX0PlDxYoLGTME4ICQKKJikC2J+MgEBaoCBXoKKeMAzhgBtgGtBXiS6R+WQDAIhchahehSQCMMfJSZ6XhZSURUIEGWRRRVRXoHjIMGctblEKaaUmIsmWeQ8opVaODmMJ+POIKZYIKRGTaRJRFf+rJXBnqHcBkCFWJdqE0GgapepfgJpWgBJXRVBTBQSXBSpghSSRZYoFZZhbZThfWVgPhU5SRa5ZRRpdRXubRRBSGUhoFKhkgOhrni8JIOFUppiUVO2WgJ2YVd1Q1kVCmTGesFAPsm/C2NsOLlgOxJ+CGHJSlYkA9DQKmQBEiEoGHJtAwRUFgJwPFaGUWc7jReedECUDxUlfJa+Dsipn0OII6G0KQNRMtQuNaSpowH9UFUKRYJGSDU4S2HoJwEEJydIjgBdVdeic2OcuFKGddQ9Q8uRpHHMLtQwR9TJSBtsJIHkkeVwAjswMmXmHcNcEIHqMJb0MpqZbjXkq2MBl4J+BABGRJTZATalVwGsMRQsHdaJkVPjdDg0EVPbpiejp+lLVptxeaDJaeADdJK+MdadTsPOGDnMFNkVAabQC4e7v/GQH9kVGxpeZwEVGjXqDbNLbLVGdjUKVJSrX0HbeFAoJrTACdWHEVEQMsnkmBCHZwNYGAJbf2RLTAATVADLddZiXzW7bxa9XqD7X7TraDqZQbYHbejAPNeiUVFAN9uIJbSADJiAAJswLJP4SJkcAAAJRRjCcDIlTXBGdVhGzVoBRHcq5hJ4V2WkKamAs3AYu0Wld1hzACN0WDN2t3TVj1FVXoKYu44D93caYa0DbmyRsSd5HDRBrA0D/zNnmC8BpDUZND4lH7NBDKcAADkbpt9/cu9wAJ4ZY6IV9VNd9bpMIoUFgcAj9YAxGDenEZGvAB9Hux9VsZ9iQjGRIv9YAyQG5X8uERIOu7Ew5+QQQxprGQDwgXAYNYARVZGFG+yg8iQryQRXZC9XdsDywXUyQt9pUY4zY6g7uI4h4k4UAh46gmhpmNQWKMApmpm6gvAjIE44ggw1g6grYh4NQY4jIsArY6ggwzYXDpmvA0gNQI4UArYDQh4pmk4Y4NQjIh4gw6gY4UAt9LGzcEQ5dum+mKW5jk8wkk4E82WgQk189HdPZXd+W5e6KxWiAk468le6UHmthhk9hfmjh9DNtkevOYo/OtUVAFJeAI9pGPNgVY9vVem9UQT1gUK2hU8rUehgQXUfj08uWcUZeiA3DZWVe4TRKy8Zk/hEitG7+PuCT1URUdYX6W2cTPOfuPTAofTDInTQzdYbQeQ3tIenu7usOfW7O3oXoUAsz4gXuCze2TEyeQTjIsg6exTFmOW/hFT5mVTq8iApm9TYTNhTTO9zkjKpgDj5hZzRTwkWeQUgQjzpzATNTSU1z7mtzXm9zcQeWah4Kk4rYokbzWWpTiKzyPz5zZhQTh4AL1hlWETBgMqm08laZ7yNKvQNQVQqZ1mOy941ojBna2a02JpPS1cXAycdyG602/4Bhhw0DGQmQ7e7EWV1otLG6R0Vdkm92eujytGrK+LF6Pdwr5LZY/L9L/SyQMJgKjzTygWEr7KNKl6eg16Qd96KTkWSJ76Ryn66zP6RLTBAGQGNpYGnAEGuL0G0AT4cGCGjyyG/VKAGGWGrACgskHGhGT9zkL9jzH9N999y5O+EAADuDj4pGYE5Gk1dy55arLKpLQQbLYhiW4U1jrgVtHG5d69VdskbLddHLGIBbPGD8/G9Kn4v5Nb0m69g9imVAI9BDStBUOm4L+ghjrUMLlzRzHjxrNmRhSAZzpeqkaWaLFWk0XmFrJLQ7F6AQSoEwJAGQQQuOtyhOSgvaEQBOROJOQO5O1uPebQIhjiiZpAKyTQqqqAAoU+mRRRKQ+Ot5xyEw+5LWQY3AKQb7/8EwQY+ot5JZSuqquKEIc7TuwHS+VwwuMAr5FQEgPW5gmAEIUpOykHIq2wFgTZhGyQN7EoSzGHgp8H2HtyN7N+IHduRRFQfW44Surg+HTEmbo+UHGR/Cjw04t56YKQ2Qf7+5BQAAmr+9kNwMctkOh+kZzTgGB8SxB/vvkRgjB3Bwh+mfshgCh9JGh3J8KhJ1h/B6Ryx5qAx4OKqjqPkHp7hwZ7e+rBR1J0UV5aiK2JOHR0ZyhKnPe2xyAL5oA1p8x4R6B0UeB2/OJ/dIp/BxIyp8h0UZAGAF+hIwoMFxgrpzh7GYR1Z4vn55R48EtSjkRj5ycO57KqM3R00LRO8TRPuEx2nIxNjEZ/J1cKZyRxZ6lxeC5yVweME9IUiJV73Fxo+0imkDfA5CAPqyAKkwYFMMrEDXkkVKWIFgN2NvNRhVNp/RuzkxIB64NUW/IPTnXSPatxW0NfJs208ONbN1ZPN9LU+Ku+WxKPY3k64+ljCsJJCgO3gEu/aCu6oUXlYGO6YYE2OBYaE4Cxi00wtMGb4bAtSMNnAB1nqKdn1i8VSM1n9qNg0PD1NhAbEXNgtskEbljzSPpVops8Dvjw0fSB5CdsT4j6ZMbA9jl6rjl89vsBxZjxfp9nBj9jACj5jqTls2OlnRDlz1Dp1sT/DkMgz3dmjhjoCVjnDgKBu3u8Trz7hB/pTs0NTu0LTvL/TqKSztkGzne10hHoM9HrHmQSsMLhUKLnphLgJblzLkNfLkN9rirjwMjndkzzbMbt40IAbrjwtt747m/ObrAJbkMTbgKP5xJSvTAG7h7ma97vE0M9T0HiHmHmAMb1HokzHvNazwnsAEnl2yViONC097C583gOD4XlFD9786pIeKi5YeVtXlVpE6StE1EAr5wFuwe2dkewGiezThKAiVFvjlYjFZwLjoKYMAReDoRna4oGQN9gwV5RieGKPT72ADs5OE4wc8JCUxXwYBu4i+O0NK2PR3YNAN4CC3vSG1uJ/eGy8Cqa8AAzfy/Rm1mxxff2G0iEudKRyHUCUDRtzkZkONgm0oxkMMgKbU9Au1oYiIkUObK2mDy7rENE2bLChh2XbpB9wKjpRjO23wBH4raMbLgC/Vrpbh42qrcVqSyRDvd+An3NdlXyRAbtbGVAR+OICQCgBnwMEIQHgEIwgBXArgIAA==="}
import { Actions } from 'viem/tempo'
import { client, channel } from './viem.config'

const hash = await client.channel.withdraw({
  channel,
})
const receipt = await client.waitForTransactionReceipt({ hash })

const { args } = Actions.channel.withdraw.extractEvent(receipt.logs)
```

## Return Type

```ts
type ReturnType = {
  /** Channel ID */
  channelId: Hex
  /** Account that receives settled voucher payments */
  payee: Address
  /** Account that funded the channel and receives refunds */
  payer: Address
  /** Amount refunded to the payer */
  refundedToPayer: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Amount settled to the payee */
  settledToPayee: bigint
}
```

## Parameters

### channel

* **Type:** `Channel.from.Value`

Channel containing the payer, payee, operator, token, salt, authorized signer, and expiring nonce hash.

<WriteParameters />