viem 0.0.0-main.20240110T155739 → 0.0.0-main.20240110T222121
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -7
- package/README.md +1 -1
- package/_cjs/errors/base.js +1 -1
- package/_cjs/errors/base.js.map +1 -1
- package/_cjs/errors/version.js +1 -1
- package/_esm/actions/ens/getEnsAddress.js +2 -2
- package/_esm/actions/ens/getEnsAvatar.js +3 -3
- package/_esm/actions/ens/getEnsName.js +1 -1
- package/_esm/actions/ens/getEnsResolver.js +2 -2
- package/_esm/actions/ens/getEnsText.js +2 -2
- package/_esm/actions/getContract.js +2 -2
- package/_esm/actions/public/call.js +1 -1
- package/_esm/actions/public/createBlockFilter.js +3 -3
- package/_esm/actions/public/createContractEventFilter.js +3 -3
- package/_esm/actions/public/createEventFilter.js +3 -3
- package/_esm/actions/public/createPendingTransactionFilter.js +3 -3
- package/_esm/actions/public/estimateContractGas.js +2 -2
- package/_esm/actions/public/estimateFeesPerGas.js +2 -2
- package/_esm/actions/public/estimateGas.js +1 -1
- package/_esm/actions/public/estimateMaxPriorityFeePerGas.js +2 -2
- package/_esm/actions/public/getBalance.js +2 -2
- package/_esm/actions/public/getBlock.js +1 -1
- package/_esm/actions/public/getBlockNumber.js +1 -1
- package/_esm/actions/public/getBlockTransactionCount.js +1 -1
- package/_esm/actions/public/getBytecode.js +1 -1
- package/_esm/actions/public/getChainId.js +1 -1
- package/_esm/actions/public/getContractEvents.js +1 -1
- package/_esm/actions/public/getFeeHistory.js +1 -1
- package/_esm/actions/public/getFilterChanges.js +5 -5
- package/_esm/actions/public/getFilterLogs.js +1 -1
- package/_esm/actions/public/getGasPrice.js +1 -1
- package/_esm/actions/public/getLogs.js +1 -1
- package/_esm/actions/public/getProof.js +1 -1
- package/_esm/actions/public/getStorageAt.js +1 -1
- package/_esm/actions/public/getTransaction.js +2 -2
- package/_esm/actions/public/getTransactionConfirmations.js +1 -1
- package/_esm/actions/public/getTransactionCount.js +2 -2
- package/_esm/actions/public/getTransactionReceipt.js +2 -2
- package/_esm/actions/public/multicall.js +2 -2
- package/_esm/actions/public/readContract.js +2 -2
- package/_esm/actions/public/simulateContract.js +3 -3
- package/_esm/actions/public/uninstallFilter.js +5 -5
- package/_esm/actions/public/verifyMessage.js +1 -1
- package/_esm/actions/public/verifyTypedData.js +1 -1
- package/_esm/actions/public/waitForTransactionReceipt.js +2 -2
- package/_esm/actions/public/watchBlockNumber.js +1 -1
- package/_esm/actions/public/watchBlocks.js +1 -1
- package/_esm/actions/public/watchContractEvent.js +3 -3
- package/_esm/actions/public/watchEvent.js +4 -4
- package/_esm/actions/public/watchPendingTransactions.js +2 -2
- package/_esm/actions/test/dropTransaction.js +1 -1
- package/_esm/actions/test/dumpState.js +1 -1
- package/_esm/actions/test/getAutomine.js +1 -1
- package/_esm/actions/test/getTxpoolContent.js +1 -1
- package/_esm/actions/test/getTxpoolStatus.js +1 -1
- package/_esm/actions/test/impersonateAccount.js +1 -1
- package/_esm/actions/test/increaseTime.js +1 -1
- package/_esm/actions/test/inspectTxpool.js +1 -1
- package/_esm/actions/test/loadState.js +1 -1
- package/_esm/actions/test/mine.js +1 -1
- package/_esm/actions/test/removeBlockTimestampInterval.js +2 -2
- package/_esm/actions/test/reset.js +1 -1
- package/_esm/actions/test/revert.js +1 -1
- package/_esm/actions/test/sendUnsignedTransaction.js +1 -1
- package/_esm/actions/test/setAutomine.js +1 -1
- package/_esm/actions/test/setBalance.js +1 -1
- package/_esm/actions/test/setBlockGasLimit.js +1 -1
- package/_esm/actions/test/setBlockTimestampInterval.js +2 -2
- package/_esm/actions/test/setCode.js +1 -1
- package/_esm/actions/test/setCoinbase.js +1 -1
- package/_esm/actions/test/setIntervalMining.js +1 -1
- package/_esm/actions/test/setLoggingEnabled.js +1 -1
- package/_esm/actions/test/setMinGasPrice.js +1 -1
- package/_esm/actions/test/setNextBlockBaseFeePerGas.js +1 -1
- package/_esm/actions/test/setNextBlockTimestamp.js +1 -1
- package/_esm/actions/test/setNonce.js +1 -1
- package/_esm/actions/test/setRpcUrl.js +1 -1
- package/_esm/actions/test/setStorageAt.js +1 -1
- package/_esm/actions/test/snapshot.js +1 -1
- package/_esm/actions/test/stopImpersonatingAccount.js +2 -2
- package/_esm/actions/wallet/addChain.js +1 -1
- package/_esm/actions/wallet/deployContract.js +2 -2
- package/_esm/actions/wallet/getAddresses.js +1 -1
- package/_esm/actions/wallet/getPermissions.js +1 -1
- package/_esm/actions/wallet/prepareTransactionRequest.js +1 -1
- package/_esm/actions/wallet/requestAddresses.js +1 -1
- package/_esm/actions/wallet/requestPermissions.js +1 -1
- package/_esm/actions/wallet/sendRawTransaction.js +1 -1
- package/_esm/actions/wallet/sendTransaction.js +2 -2
- package/_esm/actions/wallet/signMessage.js +4 -4
- package/_esm/actions/wallet/signTransaction.js +1 -1
- package/_esm/actions/wallet/signTypedData.js +2 -2
- package/_esm/actions/wallet/switchChain.js +1 -1
- package/_esm/actions/wallet/watchAsset.js +1 -1
- package/_esm/actions/wallet/writeContract.js +5 -5
- package/_esm/chains/opStack/actions/buildDepositTransaction.js +1 -1
- package/_esm/chains/opStack/actions/buildInitiateWithdrawal.js +1 -1
- package/_esm/chains/opStack/actions/buildProveWithdrawal.js +1 -1
- package/_esm/chains/opStack/actions/depositTransaction.js +1 -1
- package/_esm/chains/opStack/actions/estimateDepositTransactionGas.js +1 -1
- package/_esm/chains/opStack/actions/estimateFinalizeWithdrawalGas.js +1 -1
- package/_esm/chains/opStack/actions/estimateInitiateWithdrawalGas.js +1 -1
- package/_esm/chains/opStack/actions/estimateProveWithdrawalGas.js +1 -1
- package/_esm/chains/opStack/actions/finalizeWithdrawal.js +1 -1
- package/_esm/chains/opStack/actions/getL2Output.js +1 -1
- package/_esm/chains/opStack/actions/getTimeToFinalize.js +2 -2
- package/_esm/chains/opStack/actions/getTimeToNextL2Output.js +2 -2
- package/_esm/chains/opStack/actions/getTimeToProve.js +2 -2
- package/_esm/chains/opStack/actions/getWithdrawalStatus.js +2 -2
- package/_esm/chains/opStack/actions/initiateWithdrawal.js +1 -1
- package/_esm/chains/opStack/actions/proveWithdrawal.js +1 -1
- package/_esm/chains/opStack/actions/waitForNextL2Output.js +1 -1
- package/_esm/chains/opStack/actions/waitToFinalize.js +2 -2
- package/_esm/chains/opStack/actions/waitToProve.js +2 -2
- package/_esm/chains/opStack/decorators/publicL1.js +1 -1
- package/_esm/chains/opStack/decorators/publicL2.js +1 -1
- package/_esm/chains/opStack/decorators/walletL1.js +1 -1
- package/_esm/chains/opStack/decorators/walletL2.js +1 -1
- package/_esm/errors/base.js +1 -1
- package/_esm/errors/base.js.map +1 -1
- package/_esm/errors/version.js +1 -1
- package/_esm/utils/encoding/fromBytes.js +6 -6
- package/_esm/utils/encoding/fromHex.js +6 -6
- package/_esm/utils/encoding/toBytes.js +6 -6
- package/_esm/utils/encoding/toHex.js +6 -6
- package/_esm/utils/ens/labelhash.js +1 -1
- package/_esm/utils/ens/namehash.js +1 -1
- package/_esm/utils/signature/verifyMessage.js +1 -1
- package/_esm/utils/signature/verifyTypedData.js +1 -1
- package/_esm/utils/unit/formatEther.js +1 -1
- package/_esm/utils/unit/formatGwei.js +1 -1
- package/_esm/utils/unit/formatUnits.js +1 -1
- package/_esm/utils/unit/parseEther.js +1 -1
- package/_esm/utils/unit/parseGwei.js +1 -1
- package/_esm/utils/unit/parseUnits.js +1 -1
- package/_types/actions/ens/getEnsAddress.d.ts +2 -2
- package/_types/actions/ens/getEnsAvatar.d.ts +3 -3
- package/_types/actions/ens/getEnsName.d.ts +1 -1
- package/_types/actions/ens/getEnsResolver.d.ts +2 -2
- package/_types/actions/ens/getEnsText.d.ts +2 -2
- package/_types/actions/getContract.d.ts +22 -22
- package/_types/actions/public/call.d.ts +1 -1
- package/_types/actions/public/createBlockFilter.d.ts +3 -3
- package/_types/actions/public/createContractEventFilter.d.ts +3 -3
- package/_types/actions/public/createEventFilter.d.ts +3 -3
- package/_types/actions/public/createPendingTransactionFilter.d.ts +3 -3
- package/_types/actions/public/estimateContractGas.d.ts +2 -2
- package/_types/actions/public/estimateFeesPerGas.d.ts +2 -2
- package/_types/actions/public/estimateGas.d.ts +1 -1
- package/_types/actions/public/estimateMaxPriorityFeePerGas.d.ts +2 -2
- package/_types/actions/public/getBalance.d.ts +2 -2
- package/_types/actions/public/getBlock.d.ts +1 -1
- package/_types/actions/public/getBlockNumber.d.ts +1 -1
- package/_types/actions/public/getBlockTransactionCount.d.ts +1 -1
- package/_types/actions/public/getBytecode.d.ts +1 -1
- package/_types/actions/public/getChainId.d.ts +1 -1
- package/_types/actions/public/getContractEvents.d.ts +1 -1
- package/_types/actions/public/getFeeHistory.d.ts +1 -1
- package/_types/actions/public/getFilterChanges.d.ts +5 -5
- package/_types/actions/public/getFilterLogs.d.ts +1 -1
- package/_types/actions/public/getGasPrice.d.ts +1 -1
- package/_types/actions/public/getLogs.d.ts +1 -1
- package/_types/actions/public/getProof.d.ts +1 -1
- package/_types/actions/public/getStorageAt.d.ts +1 -1
- package/_types/actions/public/getTransaction.d.ts +2 -2
- package/_types/actions/public/getTransactionConfirmations.d.ts +1 -1
- package/_types/actions/public/getTransactionCount.d.ts +2 -2
- package/_types/actions/public/getTransactionReceipt.d.ts +2 -2
- package/_types/actions/public/multicall.d.ts +2 -2
- package/_types/actions/public/readContract.d.ts +2 -2
- package/_types/actions/public/simulateContract.d.ts +3 -3
- package/_types/actions/public/uninstallFilter.d.ts +5 -5
- package/_types/actions/public/verifyMessage.d.ts +1 -1
- package/_types/actions/public/verifyTypedData.d.ts +1 -1
- package/_types/actions/public/waitForTransactionReceipt.d.ts +2 -2
- package/_types/actions/public/watchBlockNumber.d.ts +1 -1
- package/_types/actions/public/watchBlocks.d.ts +1 -1
- package/_types/actions/public/watchContractEvent.d.ts +3 -3
- package/_types/actions/public/watchEvent.d.ts +4 -4
- package/_types/actions/public/watchPendingTransactions.d.ts +2 -2
- package/_types/actions/test/dropTransaction.d.ts +1 -1
- package/_types/actions/test/dumpState.d.ts +1 -1
- package/_types/actions/test/getAutomine.d.ts +1 -1
- package/_types/actions/test/getTxpoolContent.d.ts +1 -1
- package/_types/actions/test/getTxpoolStatus.d.ts +1 -1
- package/_types/actions/test/impersonateAccount.d.ts +1 -1
- package/_types/actions/test/increaseTime.d.ts +1 -1
- package/_types/actions/test/inspectTxpool.d.ts +1 -1
- package/_types/actions/test/loadState.d.ts +1 -1
- package/_types/actions/test/mine.d.ts +1 -1
- package/_types/actions/test/removeBlockTimestampInterval.d.ts +2 -2
- package/_types/actions/test/reset.d.ts +1 -1
- package/_types/actions/test/revert.d.ts +1 -1
- package/_types/actions/test/sendUnsignedTransaction.d.ts +1 -1
- package/_types/actions/test/setAutomine.d.ts +1 -1
- package/_types/actions/test/setBalance.d.ts +1 -1
- package/_types/actions/test/setBlockGasLimit.d.ts +1 -1
- package/_types/actions/test/setBlockTimestampInterval.d.ts +2 -2
- package/_types/actions/test/setCode.d.ts +1 -1
- package/_types/actions/test/setCoinbase.d.ts +1 -1
- package/_types/actions/test/setIntervalMining.d.ts +1 -1
- package/_types/actions/test/setLoggingEnabled.d.ts +1 -1
- package/_types/actions/test/setMinGasPrice.d.ts +1 -1
- package/_types/actions/test/setNextBlockBaseFeePerGas.d.ts +1 -1
- package/_types/actions/test/setNextBlockTimestamp.d.ts +1 -1
- package/_types/actions/test/setNonce.d.ts +1 -1
- package/_types/actions/test/setRpcUrl.d.ts +1 -1
- package/_types/actions/test/setStorageAt.d.ts +1 -1
- package/_types/actions/test/snapshot.d.ts +1 -1
- package/_types/actions/test/stopImpersonatingAccount.d.ts +2 -2
- package/_types/actions/wallet/addChain.d.ts +1 -1
- package/_types/actions/wallet/deployContract.d.ts +2 -2
- package/_types/actions/wallet/getAddresses.d.ts +1 -1
- package/_types/actions/wallet/getPermissions.d.ts +1 -1
- package/_types/actions/wallet/prepareTransactionRequest.d.ts +1 -1
- package/_types/actions/wallet/requestAddresses.d.ts +1 -1
- package/_types/actions/wallet/requestPermissions.d.ts +1 -1
- package/_types/actions/wallet/sendRawTransaction.d.ts +1 -1
- package/_types/actions/wallet/sendTransaction.d.ts +2 -2
- package/_types/actions/wallet/signMessage.d.ts +4 -4
- package/_types/actions/wallet/signTransaction.d.ts +1 -1
- package/_types/actions/wallet/signTypedData.d.ts +2 -2
- package/_types/actions/wallet/switchChain.d.ts +1 -1
- package/_types/actions/wallet/watchAsset.d.ts +1 -1
- package/_types/actions/wallet/writeContract.d.ts +5 -5
- package/_types/chains/opStack/actions/buildDepositTransaction.d.ts +1 -1
- package/_types/chains/opStack/actions/buildInitiateWithdrawal.d.ts +1 -1
- package/_types/chains/opStack/actions/buildProveWithdrawal.d.ts +1 -1
- package/_types/chains/opStack/actions/depositTransaction.d.ts +1 -1
- package/_types/chains/opStack/actions/estimateDepositTransactionGas.d.ts +1 -1
- package/_types/chains/opStack/actions/estimateFinalizeWithdrawalGas.d.ts +1 -1
- package/_types/chains/opStack/actions/estimateInitiateWithdrawalGas.d.ts +1 -1
- package/_types/chains/opStack/actions/estimateProveWithdrawalGas.d.ts +1 -1
- package/_types/chains/opStack/actions/finalizeWithdrawal.d.ts +1 -1
- package/_types/chains/opStack/actions/getL2Output.d.ts +1 -1
- package/_types/chains/opStack/actions/getTimeToFinalize.d.ts +2 -2
- package/_types/chains/opStack/actions/getTimeToNextL2Output.d.ts +2 -2
- package/_types/chains/opStack/actions/getTimeToProve.d.ts +2 -2
- package/_types/chains/opStack/actions/getWithdrawalStatus.d.ts +2 -2
- package/_types/chains/opStack/actions/initiateWithdrawal.d.ts +1 -1
- package/_types/chains/opStack/actions/proveWithdrawal.d.ts +1 -1
- package/_types/chains/opStack/actions/waitForNextL2Output.d.ts +1 -1
- package/_types/chains/opStack/actions/waitToFinalize.d.ts +2 -2
- package/_types/chains/opStack/actions/waitToProve.d.ts +2 -2
- package/_types/chains/opStack/decorators/publicL1.d.ts +20 -20
- package/_types/chains/opStack/decorators/publicL2.d.ts +4 -4
- package/_types/chains/opStack/decorators/walletL1.d.ts +4 -4
- package/_types/chains/opStack/decorators/walletL2.d.ts +2 -2
- package/_types/clients/createPublicClient.d.ts +2 -2
- package/_types/clients/createTestClient.d.ts +3 -3
- package/_types/clients/createWalletClient.d.ts +5 -5
- package/_types/clients/decorators/public.d.ts +79 -79
- package/_types/clients/decorators/test.d.ts +33 -33
- package/_types/clients/decorators/wallet.d.ts +26 -26
- package/_types/errors/version.d.ts +1 -1
- package/_types/utils/encoding/fromBytes.d.ts +6 -6
- package/_types/utils/encoding/fromHex.d.ts +6 -6
- package/_types/utils/encoding/toBytes.d.ts +6 -6
- package/_types/utils/encoding/toHex.d.ts +6 -6
- package/_types/utils/ens/labelhash.d.ts +1 -1
- package/_types/utils/ens/namehash.d.ts +1 -1
- package/_types/utils/signature/verifyMessage.d.ts +1 -1
- package/_types/utils/signature/verifyTypedData.d.ts +1 -1
- package/_types/utils/unit/formatEther.d.ts +1 -1
- package/_types/utils/unit/formatGwei.d.ts +1 -1
- package/_types/utils/unit/formatUnits.d.ts +1 -1
- package/_types/utils/unit/parseEther.d.ts +1 -1
- package/_types/utils/unit/parseGwei.d.ts +1 -1
- package/_types/utils/unit/parseUnits.d.ts +1 -1
- package/actions/ens/getEnsAddress.ts +2 -2
- package/actions/ens/getEnsAvatar.ts +3 -3
- package/actions/ens/getEnsName.ts +1 -1
- package/actions/ens/getEnsResolver.ts +2 -2
- package/actions/ens/getEnsText.ts +2 -2
- package/actions/getContract.ts +22 -22
- package/actions/public/call.ts +1 -1
- package/actions/public/createBlockFilter.ts +3 -3
- package/actions/public/createContractEventFilter.ts +3 -3
- package/actions/public/createEventFilter.ts +3 -3
- package/actions/public/createPendingTransactionFilter.ts +3 -3
- package/actions/public/estimateContractGas.ts +2 -2
- package/actions/public/estimateFeesPerGas.ts +2 -2
- package/actions/public/estimateGas.ts +1 -1
- package/actions/public/estimateMaxPriorityFeePerGas.ts +2 -2
- package/actions/public/getBalance.ts +2 -2
- package/actions/public/getBlock.ts +1 -1
- package/actions/public/getBlockNumber.ts +1 -1
- package/actions/public/getBlockTransactionCount.ts +1 -1
- package/actions/public/getBytecode.ts +1 -1
- package/actions/public/getChainId.ts +1 -1
- package/actions/public/getContractEvents.ts +1 -1
- package/actions/public/getFeeHistory.ts +1 -1
- package/actions/public/getFilterChanges.ts +5 -5
- package/actions/public/getFilterLogs.ts +1 -1
- package/actions/public/getGasPrice.ts +1 -1
- package/actions/public/getLogs.ts +1 -1
- package/actions/public/getProof.ts +1 -1
- package/actions/public/getStorageAt.ts +1 -1
- package/actions/public/getTransaction.ts +2 -2
- package/actions/public/getTransactionConfirmations.ts +1 -1
- package/actions/public/getTransactionCount.ts +2 -2
- package/actions/public/getTransactionReceipt.ts +2 -2
- package/actions/public/multicall.ts +2 -2
- package/actions/public/readContract.ts +2 -2
- package/actions/public/simulateContract.ts +3 -3
- package/actions/public/uninstallFilter.ts +5 -5
- package/actions/public/verifyMessage.ts +1 -1
- package/actions/public/verifyTypedData.ts +1 -1
- package/actions/public/waitForTransactionReceipt.ts +2 -2
- package/actions/public/watchBlockNumber.ts +1 -1
- package/actions/public/watchBlocks.ts +1 -1
- package/actions/public/watchContractEvent.ts +3 -3
- package/actions/public/watchEvent.ts +4 -4
- package/actions/public/watchPendingTransactions.ts +2 -2
- package/actions/test/dropTransaction.ts +1 -1
- package/actions/test/dumpState.ts +1 -1
- package/actions/test/getAutomine.ts +1 -1
- package/actions/test/getTxpoolContent.ts +1 -1
- package/actions/test/getTxpoolStatus.ts +1 -1
- package/actions/test/impersonateAccount.ts +1 -1
- package/actions/test/increaseTime.ts +1 -1
- package/actions/test/inspectTxpool.ts +1 -1
- package/actions/test/loadState.ts +1 -1
- package/actions/test/mine.ts +1 -1
- package/actions/test/removeBlockTimestampInterval.ts +2 -2
- package/actions/test/reset.ts +1 -1
- package/actions/test/revert.ts +1 -1
- package/actions/test/sendUnsignedTransaction.ts +1 -1
- package/actions/test/setAutomine.ts +1 -1
- package/actions/test/setBalance.ts +1 -1
- package/actions/test/setBlockGasLimit.ts +1 -1
- package/actions/test/setBlockTimestampInterval.ts +2 -2
- package/actions/test/setCode.ts +1 -1
- package/actions/test/setCoinbase.ts +1 -1
- package/actions/test/setIntervalMining.ts +1 -1
- package/actions/test/setLoggingEnabled.ts +1 -1
- package/actions/test/setMinGasPrice.ts +1 -1
- package/actions/test/setNextBlockBaseFeePerGas.ts +1 -1
- package/actions/test/setNextBlockTimestamp.ts +1 -1
- package/actions/test/setNonce.ts +1 -1
- package/actions/test/setRpcUrl.ts +1 -1
- package/actions/test/setStorageAt.ts +1 -1
- package/actions/test/snapshot.ts +1 -1
- package/actions/test/stopImpersonatingAccount.ts +2 -2
- package/actions/wallet/addChain.ts +1 -1
- package/actions/wallet/deployContract.ts +2 -2
- package/actions/wallet/getAddresses.ts +1 -1
- package/actions/wallet/getPermissions.ts +1 -1
- package/actions/wallet/prepareTransactionRequest.ts +1 -1
- package/actions/wallet/requestAddresses.ts +1 -1
- package/actions/wallet/requestPermissions.ts +1 -1
- package/actions/wallet/sendRawTransaction.ts +1 -1
- package/actions/wallet/sendTransaction.ts +2 -2
- package/actions/wallet/signMessage.ts +4 -4
- package/actions/wallet/signTransaction.ts +1 -1
- package/actions/wallet/signTypedData.ts +2 -2
- package/actions/wallet/switchChain.ts +1 -1
- package/actions/wallet/watchAsset.ts +1 -1
- package/actions/wallet/writeContract.ts +5 -5
- package/chains/opStack/actions/buildDepositTransaction.ts +1 -1
- package/chains/opStack/actions/buildInitiateWithdrawal.ts +1 -1
- package/chains/opStack/actions/buildProveWithdrawal.ts +1 -1
- package/chains/opStack/actions/depositTransaction.ts +1 -1
- package/chains/opStack/actions/estimateDepositTransactionGas.ts +1 -1
- package/chains/opStack/actions/estimateFinalizeWithdrawalGas.ts +1 -1
- package/chains/opStack/actions/estimateInitiateWithdrawalGas.ts +1 -1
- package/chains/opStack/actions/estimateProveWithdrawalGas.ts +1 -1
- package/chains/opStack/actions/finalizeWithdrawal.ts +1 -1
- package/chains/opStack/actions/getL2Output.ts +1 -1
- package/chains/opStack/actions/getTimeToFinalize.ts +2 -2
- package/chains/opStack/actions/getTimeToNextL2Output.ts +2 -2
- package/chains/opStack/actions/getTimeToProve.ts +2 -2
- package/chains/opStack/actions/getWithdrawalStatus.ts +2 -2
- package/chains/opStack/actions/initiateWithdrawal.ts +1 -1
- package/chains/opStack/actions/proveWithdrawal.ts +1 -1
- package/chains/opStack/actions/waitForNextL2Output.ts +1 -1
- package/chains/opStack/actions/waitToFinalize.ts +2 -2
- package/chains/opStack/actions/waitToProve.ts +2 -2
- package/chains/opStack/decorators/publicL1.ts +20 -20
- package/chains/opStack/decorators/publicL2.ts +4 -4
- package/chains/opStack/decorators/walletL1.ts +4 -4
- package/chains/opStack/decorators/walletL2.ts +2 -2
- package/chains/zksync/types.ts +6 -6
- package/clients/createPublicClient.ts +2 -2
- package/clients/createTestClient.ts +3 -3
- package/clients/createWalletClient.ts +5 -5
- package/clients/decorators/public.ts +79 -79
- package/clients/decorators/test.ts +33 -33
- package/clients/decorators/wallet.ts +26 -26
- package/errors/base.ts +1 -1
- package/errors/version.ts +1 -1
- package/package.json +1 -1
- package/utils/encoding/fromBytes.ts +6 -6
- package/utils/encoding/fromHex.ts +6 -6
- package/utils/encoding/toBytes.ts +6 -6
- package/utils/encoding/toHex.ts +6 -6
- package/utils/ens/labelhash.ts +1 -1
- package/utils/ens/namehash.ts +1 -1
- package/utils/signature/verifyMessage.ts +1 -1
- package/utils/signature/verifyTypedData.ts +1 -1
- package/utils/unit/formatEther.ts +1 -1
- package/utils/unit/formatGwei.ts +1 -1
- package/utils/unit/formatUnits.ts +1 -1
- package/utils/unit/parseEther.ts +1 -1
- package/utils/unit/parseGwei.ts +1 -1
- package/utils/unit/parseUnits.ts +1 -1
@@ -8,7 +8,7 @@ export type NamehashErrorType = BytesToHexErrorType | EncodedLabelToLabelhashErr
|
|
8
8
|
/**
|
9
9
|
* @description Hashes ENS name
|
10
10
|
*
|
11
|
-
* - 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 `namehash`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize
|
11
|
+
* - 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 `namehash`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
|
12
12
|
*
|
13
13
|
* @example
|
14
14
|
* namehash('wevm.eth')
|
@@ -21,7 +21,7 @@ export type VerifyMessageErrorType = IsAddressEqualErrorType | GetAddressErrorTy
|
|
21
21
|
* It is highly recommended to use `publicClient.verifyMessage` instead to ensure
|
22
22
|
* wallet interoperability.
|
23
23
|
*
|
24
|
-
* - Docs {@link https://viem.sh/docs/utilities/verifyMessage
|
24
|
+
* - Docs {@link https://viem.sh/docs/utilities/verifyMessage}
|
25
25
|
*
|
26
26
|
* @param parameters - {@link VerifyMessageParameters}
|
27
27
|
* @returns Whether or not the signature is valid. {@link VerifyMessageReturnType}
|
@@ -20,7 +20,7 @@ export type VerifyTypedDataErrorType = IsAddressEqualErrorType | GetAddressError
|
|
20
20
|
* It is highly recommended to use `publicClient.verifyTypedData` instead to ensure
|
21
21
|
* wallet interoperability.
|
22
22
|
*
|
23
|
-
* - Docs {@link https://viem.sh/docs/utilities/verifyTypedData
|
23
|
+
* - Docs {@link https://viem.sh/docs/utilities/verifyTypedData}
|
24
24
|
*
|
25
25
|
* @param parameters - {@link VerifyTypedDataParameters}
|
26
26
|
* @returns Whether or not the signature is valid. {@link VerifyTypedDataReturnType}
|
@@ -3,7 +3,7 @@ export type FormatEtherErrorType = FormatUnitsErrorType;
|
|
3
3
|
/**
|
4
4
|
* Converts numerical wei to a string representation of ether.
|
5
5
|
*
|
6
|
-
* - Docs: https://viem.sh/docs/utilities/formatEther
|
6
|
+
* - Docs: https://viem.sh/docs/utilities/formatEther
|
7
7
|
*
|
8
8
|
* @example
|
9
9
|
* import { formatEther } from 'viem'
|
@@ -3,7 +3,7 @@ export type FormatGweiErrorType = FormatUnitsErrorType;
|
|
3
3
|
/**
|
4
4
|
* Converts numerical wei to a string representation of gwei.
|
5
5
|
*
|
6
|
-
* - Docs: https://viem.sh/docs/utilities/formatGwei
|
6
|
+
* - Docs: https://viem.sh/docs/utilities/formatGwei
|
7
7
|
*
|
8
8
|
* @example
|
9
9
|
* import { formatGwei } from 'viem'
|
@@ -3,7 +3,7 @@ export type FormatUnitsErrorType = ErrorType;
|
|
3
3
|
/**
|
4
4
|
* Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number..
|
5
5
|
*
|
6
|
-
* - Docs: https://viem.sh/docs/utilities/formatUnits
|
6
|
+
* - Docs: https://viem.sh/docs/utilities/formatUnits
|
7
7
|
*
|
8
8
|
* @example
|
9
9
|
* import { formatUnits } from 'viem'
|
@@ -4,7 +4,7 @@ export type ParseEtherErrorType = ParseUnitsErrorType | ErrorType;
|
|
4
4
|
/**
|
5
5
|
* Converts a string representation of ether to numerical wei.
|
6
6
|
*
|
7
|
-
* - Docs: https://viem.sh/docs/utilities/parseEther
|
7
|
+
* - Docs: https://viem.sh/docs/utilities/parseEther
|
8
8
|
*
|
9
9
|
* @example
|
10
10
|
* import { parseEther } from 'viem'
|
@@ -4,7 +4,7 @@ export type ParseGweiErrorType = ParseUnitsErrorType | ErrorType;
|
|
4
4
|
/**
|
5
5
|
* Converts a string representation of gwei to numerical wei.
|
6
6
|
*
|
7
|
-
* - Docs: https://viem.sh/docs/utilities/parseGwei
|
7
|
+
* - Docs: https://viem.sh/docs/utilities/parseGwei
|
8
8
|
*
|
9
9
|
* @example
|
10
10
|
* import { parseGwei } from 'viem'
|
@@ -3,7 +3,7 @@ export type ParseUnitsErrorType = ErrorType;
|
|
3
3
|
/**
|
4
4
|
* Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
|
5
5
|
*
|
6
|
-
* - Docs: https://viem.sh/docs/utilities/parseUnits
|
6
|
+
* - Docs: https://viem.sh/docs/utilities/parseUnits
|
7
7
|
*
|
8
8
|
* @example
|
9
9
|
* import { parseUnits } from 'viem'
|
@@ -61,12 +61,12 @@ export type GetEnsAddressErrorType =
|
|
61
61
|
/**
|
62
62
|
* Gets address for ENS name.
|
63
63
|
*
|
64
|
-
* - Docs: https://viem.sh/docs/ens/actions/getEnsAddress
|
64
|
+
* - Docs: https://viem.sh/docs/ens/actions/getEnsAddress
|
65
65
|
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
|
66
66
|
*
|
67
67
|
* Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
|
68
68
|
*
|
69
|
-
* 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
|
69
|
+
* 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) function for this.
|
70
70
|
*
|
71
71
|
* @param client - Client to use
|
72
72
|
* @param parameters - {@link GetEnsAddressParameters}
|
@@ -33,12 +33,12 @@ export type GetEnsAvatarErrorType =
|
|
33
33
|
/**
|
34
34
|
* Gets the avatar of an ENS name.
|
35
35
|
*
|
36
|
-
* - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar
|
36
|
+
* - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar
|
37
37
|
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
|
38
38
|
*
|
39
|
-
* Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText
|
39
|
+
* Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText) with `key` set to `'avatar'`.
|
40
40
|
*
|
41
|
-
* 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
|
41
|
+
* 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) function for this.
|
42
42
|
*
|
43
43
|
* @param client - Client to use
|
44
44
|
* @param parameters - {@link GetEnsAvatarParameters}
|
@@ -44,7 +44,7 @@ export type GetEnsNameErrorType =
|
|
44
44
|
/**
|
45
45
|
* Gets primary name for specified address.
|
46
46
|
*
|
47
|
-
* - Docs: https://viem.sh/docs/ens/actions/getEnsName
|
47
|
+
* - Docs: https://viem.sh/docs/ens/actions/getEnsName
|
48
48
|
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
|
49
49
|
*
|
50
50
|
* Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
|
@@ -40,12 +40,12 @@ export type GetEnsResolverErrorType =
|
|
40
40
|
/**
|
41
41
|
* Gets resolver for ENS name.
|
42
42
|
*
|
43
|
-
* - Docs: https://viem.sh/docs/ens/actions/getEnsResolver
|
43
|
+
* - Docs: https://viem.sh/docs/ens/actions/getEnsResolver
|
44
44
|
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
|
45
45
|
*
|
46
46
|
* Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.
|
47
47
|
*
|
48
|
-
* 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
|
48
|
+
* 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) function for this.
|
49
49
|
*
|
50
50
|
* @param client - Client to use
|
51
51
|
* @param parameters - {@link GetEnsResolverParameters}
|
@@ -59,12 +59,12 @@ export type GetEnsTextErrorType =
|
|
59
59
|
/**
|
60
60
|
* Gets a text record for specified ENS name.
|
61
61
|
*
|
62
|
-
* - Docs: https://viem.sh/docs/ens/actions/getEnsResolver
|
62
|
+
* - Docs: https://viem.sh/docs/ens/actions/getEnsResolver
|
63
63
|
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens
|
64
64
|
*
|
65
65
|
* Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
|
66
66
|
*
|
67
|
-
* 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
|
67
|
+
* 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) function for this.
|
68
68
|
*
|
69
69
|
* @param client - Client to use
|
70
70
|
* @param parameters - {@link GetEnsTextParameters}
|
package/actions/getContract.ts
CHANGED
@@ -100,19 +100,19 @@ export type GetContractParameters<
|
|
100
100
|
address: TAddress
|
101
101
|
/** The Client.
|
102
102
|
*
|
103
|
-
* If you pass in a [`publicClient`](https://viem.sh/docs/clients/public
|
103
|
+
* If you pass in a [`publicClient`](https://viem.sh/docs/clients/public), the following methods are available:
|
104
104
|
*
|
105
|
-
* - [`createEventFilter`](https://viem.sh/docs/contract/createContractEventFilter
|
106
|
-
* - [`estimateGas`](https://viem.sh/docs/contract/estimateContractGas
|
107
|
-
* - [`getEvents`](https://viem.sh/docs/contract/getContractEvents
|
108
|
-
* - [`read`](https://viem.sh/docs/contract/readContract
|
109
|
-
* - [`simulate`](https://viem.sh/docs/contract/simulateContract
|
110
|
-
* - [`watchEvent`](https://viem.sh/docs/contract/watchContractEvent
|
105
|
+
* - [`createEventFilter`](https://viem.sh/docs/contract/createContractEventFilter)
|
106
|
+
* - [`estimateGas`](https://viem.sh/docs/contract/estimateContractGas)
|
107
|
+
* - [`getEvents`](https://viem.sh/docs/contract/getContractEvents)
|
108
|
+
* - [`read`](https://viem.sh/docs/contract/readContract)
|
109
|
+
* - [`simulate`](https://viem.sh/docs/contract/simulateContract)
|
110
|
+
* - [`watchEvent`](https://viem.sh/docs/contract/watchContractEvent)
|
111
111
|
*
|
112
|
-
* If you pass in a [`walletClient`](https://viem.sh/docs/clients/wallet
|
112
|
+
* If you pass in a [`walletClient`](https://viem.sh/docs/clients/wallet), the following methods are available:
|
113
113
|
*
|
114
|
-
* - [`estimateGas`](https://viem.sh/docs/contract/estimateContractGas
|
115
|
-
* - [`write`](https://viem.sh/docs/contract/writeContract
|
114
|
+
* - [`estimateGas`](https://viem.sh/docs/contract/estimateContractGas)
|
115
|
+
* - [`write`](https://viem.sh/docs/contract/writeContract)
|
116
116
|
*/
|
117
117
|
client: TClient
|
118
118
|
}
|
@@ -158,7 +158,7 @@ export type GetContractReturnType<
|
|
158
158
|
*
|
159
159
|
* 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.
|
160
160
|
*
|
161
|
-
* Internally, `read` uses a [Public Client](https://viem.sh/docs/clients/public
|
161
|
+
* Internally, `read` uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
|
162
162
|
*
|
163
163
|
* @example
|
164
164
|
* import { createPublicClient, getContract, http, parseAbi } from 'viem'
|
@@ -231,9 +231,9 @@ export type GetContractReturnType<
|
|
231
231
|
/**
|
232
232
|
* Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions.
|
233
233
|
*
|
234
|
-
* 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
|
234
|
+
* 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), but also supports contract write functions.
|
235
235
|
*
|
236
|
-
* Internally, `simulate` uses a [Public Client](https://viem.sh/docs/clients/public
|
236
|
+
* Internally, `simulate` uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
|
237
237
|
*
|
238
238
|
* @example
|
239
239
|
* import { createPublicClient, getContract, http, parseAbi } from 'viem'
|
@@ -273,7 +273,7 @@ export type GetContractReturnType<
|
|
273
273
|
? unknown
|
274
274
|
: {
|
275
275
|
/**
|
276
|
-
* Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges
|
276
|
+
* Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs).
|
277
277
|
*
|
278
278
|
* @example
|
279
279
|
* import { createPublicClient, getContract, http, parseAbi } from 'viem'
|
@@ -300,7 +300,7 @@ export type GetContractReturnType<
|
|
300
300
|
>
|
301
301
|
}
|
302
302
|
/**
|
303
|
-
* Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges
|
303
|
+
* Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs).
|
304
304
|
*
|
305
305
|
* @example
|
306
306
|
* import { createPublicClient, getContract, http, parseAbi } from 'viem'
|
@@ -329,9 +329,9 @@ export type GetContractReturnType<
|
|
329
329
|
/**
|
330
330
|
* Watches and returns emitted contract event logs.
|
331
331
|
*
|
332
|
-
* This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent
|
332
|
+
* This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent#onLogs).
|
333
333
|
*
|
334
|
-
* `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter
|
334
|
+
* `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) 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) instead.
|
335
335
|
*
|
336
336
|
* @example
|
337
337
|
* import { createPublicClient, getContract, http, parseAbi } from 'viem'
|
@@ -404,11 +404,11 @@ export type GetContractReturnType<
|
|
404
404
|
/**
|
405
405
|
* Executes a write function on a contract.
|
406
406
|
*
|
407
|
-
* 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
|
407
|
+
* 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.
|
408
408
|
*
|
409
|
-
* Internally, `write` uses a [Wallet Client](https://viem.sh/docs/clients/wallet
|
409
|
+
* Internally, `write` 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).
|
410
410
|
*
|
411
|
-
* __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
|
411
|
+
* __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#usage) before you execute it.__
|
412
412
|
*
|
413
413
|
* @example
|
414
414
|
* import { createWalletClient, getContract, http, parseAbi } from 'viem'
|
@@ -451,9 +451,9 @@ export type GetContractErrorType = ErrorType
|
|
451
451
|
/**
|
452
452
|
* Gets type-safe interface for performing contract-related actions with a specific `abi` and `address`.
|
453
453
|
*
|
454
|
-
* - Docs https://viem.sh/docs/contract/getContract
|
454
|
+
* - Docs https://viem.sh/docs/contract/getContract
|
455
455
|
*
|
456
|
-
* 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
|
456
|
+
* 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), [`writeContract`](https://viem.sh/docs/contract/writeContract), [`estimateContractGas`](https://viem.sh/docs/contract/estimateContractGas), etc.
|
457
457
|
*
|
458
458
|
* @example
|
459
459
|
* import { createPublicClient, getContract, http, parseAbi } from 'viem'
|
package/actions/public/call.ts
CHANGED
@@ -101,7 +101,7 @@ export type CallErrorType = GetCallErrorReturnType<
|
|
101
101
|
/**
|
102
102
|
* Executes a new message call immediately without submitting a transaction to the network.
|
103
103
|
*
|
104
|
-
* - Docs: https://viem.sh/docs/actions/public/call
|
104
|
+
* - Docs: https://viem.sh/docs/actions/public/call
|
105
105
|
* - JSON-RPC Methods: [`eth_call`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call)
|
106
106
|
*
|
107
107
|
* @param client - Client to use
|
@@ -11,13 +11,13 @@ export type CreateBlockFilterReturnType = Filter<'block'>
|
|
11
11
|
export type CreateBlockFilterErrorType = RequestErrorType | ErrorType
|
12
12
|
|
13
13
|
/**
|
14
|
-
* Creates a [`Filter`](https://viem.sh/docs/glossary/types
|
14
|
+
* Creates a [`Filter`](https://viem.sh/docs/glossary/types#filter) to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges).
|
15
15
|
*
|
16
|
-
* - Docs: https://viem.sh/docs/actions/public/createBlockFilter
|
16
|
+
* - Docs: https://viem.sh/docs/actions/public/createBlockFilter
|
17
17
|
* - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter)
|
18
18
|
*
|
19
19
|
* @param client - Client to use
|
20
|
-
* @returns [`Filter`](https://viem.sh/docs/glossary/types
|
20
|
+
* @returns [`Filter`](https://viem.sh/docs/glossary/types#filter). {@link CreateBlockFilterReturnType}
|
21
21
|
*
|
22
22
|
* @example
|
23
23
|
* import { createPublicClient, http } from 'viem'
|
@@ -73,13 +73,13 @@ export type CreateContractEventFilterErrorType =
|
|
73
73
|
| ErrorType
|
74
74
|
|
75
75
|
/**
|
76
|
-
* Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges
|
76
|
+
* Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs).
|
77
77
|
*
|
78
|
-
* - Docs: https://viem.sh/docs/contract/createContractEventFilter
|
78
|
+
* - Docs: https://viem.sh/docs/contract/createContractEventFilter
|
79
79
|
*
|
80
80
|
* @param client - Client to use
|
81
81
|
* @param parameters - {@link CreateContractEventFilterParameters}
|
82
|
-
* @returns [`Filter`](https://viem.sh/docs/glossary/types
|
82
|
+
* @returns [`Filter`](https://viem.sh/docs/glossary/types#filter). {@link CreateContractEventFilterReturnType}
|
83
83
|
*
|
84
84
|
* @example
|
85
85
|
* import { createPublicClient, http, parseAbi } from 'viem'
|
@@ -115,14 +115,14 @@ export type CreateEventFilterErrorType =
|
|
115
115
|
| ErrorType
|
116
116
|
|
117
117
|
/**
|
118
|
-
* Creates a [`Filter`](https://viem.sh/docs/glossary/types
|
118
|
+
* Creates a [`Filter`](https://viem.sh/docs/glossary/types#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges).
|
119
119
|
*
|
120
|
-
* - Docs: https://viem.sh/docs/actions/public/createEventFilter
|
120
|
+
* - Docs: https://viem.sh/docs/actions/public/createEventFilter
|
121
121
|
* - JSON-RPC Methods: [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter)
|
122
122
|
*
|
123
123
|
* @param client - Client to use
|
124
124
|
* @param parameters - {@link CreateEventFilterParameters}
|
125
|
-
* @returns [`Filter`](https://viem.sh/docs/glossary/types
|
125
|
+
* @returns [`Filter`](https://viem.sh/docs/glossary/types#filter). {@link CreateEventFilterReturnType}
|
126
126
|
*
|
127
127
|
* @example
|
128
128
|
* import { createPublicClient, http } from 'viem'
|
@@ -13,13 +13,13 @@ export type CreatePendingTransactionFilterErrorType =
|
|
13
13
|
| ErrorType
|
14
14
|
|
15
15
|
/**
|
16
|
-
* Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges
|
16
|
+
* Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges).
|
17
17
|
*
|
18
|
-
* - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter
|
18
|
+
* - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter
|
19
19
|
* - JSON-RPC Methods: [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter)
|
20
20
|
*
|
21
21
|
* @param client - Client to use
|
22
|
-
* @returns [`Filter`](https://viem.sh/docs/glossary/types
|
22
|
+
* @returns [`Filter`](https://viem.sh/docs/glossary/types#filter). {@link CreateBlockFilterReturnType}
|
23
23
|
*
|
24
24
|
* @example
|
25
25
|
* import { createPublicClient, http } from 'viem'
|
@@ -68,9 +68,9 @@ export type EstimateContractGasErrorType = GetContractErrorReturnType<
|
|
68
68
|
/**
|
69
69
|
* Estimates the gas required to successfully execute a contract write function call.
|
70
70
|
*
|
71
|
-
* - Docs: https://viem.sh/docs/contract/estimateContractGas
|
71
|
+
* - Docs: https://viem.sh/docs/contract/estimateContractGas
|
72
72
|
*
|
73
|
-
* Internally, uses a [Public Client](https://viem.sh/docs/clients/public
|
73
|
+
* Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
|
74
74
|
*
|
75
75
|
* @param client - Client to use
|
76
76
|
* @param parameters - {@link EstimateContractGasParameters}
|
@@ -60,9 +60,9 @@ export type EstimateFeesPerGasErrorType =
|
|
60
60
|
/**
|
61
61
|
* Returns an estimate for the fees per gas (in wei) for a
|
62
62
|
* transaction to be likely included in the next block.
|
63
|
-
* Defaults to [`chain.fees.estimateFeesPerGas`](/docs/clients/chains
|
63
|
+
* Defaults to [`chain.fees.estimateFeesPerGas`](/docs/clients/chains#fees-estimatefeespergas) if set.
|
64
64
|
*
|
65
|
-
* - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas
|
65
|
+
* - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas
|
66
66
|
*
|
67
67
|
* @param client - Client to use
|
68
68
|
* @param parameters - {@link EstimateFeesPerGasParameters}
|
@@ -71,7 +71,7 @@ export type EstimateGasErrorType = GetEstimateGasErrorReturnType<
|
|
71
71
|
/**
|
72
72
|
* Estimates the gas necessary to complete a transaction without submitting it to the network.
|
73
73
|
*
|
74
|
-
* - Docs: https://viem.sh/docs/actions/public/estimateGas
|
74
|
+
* - Docs: https://viem.sh/docs/actions/public/estimateGas
|
75
75
|
* - JSON-RPC Methods: [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas)
|
76
76
|
*
|
77
77
|
* @param client - Client to use
|
@@ -38,9 +38,9 @@ export type EstimateMaxPriorityFeePerGasErrorType =
|
|
38
38
|
/**
|
39
39
|
* Returns an estimate for the max priority fee per gas (in wei) for a
|
40
40
|
* transaction to be likely included in the next block.
|
41
|
-
* Defaults to [`chain.fees.defaultPriorityFee`](/docs/clients/chains
|
41
|
+
* Defaults to [`chain.fees.defaultPriorityFee`](/docs/clients/chains#fees-defaultpriorityfee) if set.
|
42
42
|
*
|
43
|
-
* - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas
|
43
|
+
* - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas
|
44
44
|
*
|
45
45
|
* @param client - Client to use
|
46
46
|
* @returns An estimate (in wei) for the max priority fee per gas. {@link EstimateMaxPriorityFeePerGasReturnType}
|
@@ -37,10 +37,10 @@ export type GetBalanceErrorType =
|
|
37
37
|
/**
|
38
38
|
* Returns the balance of an address in wei.
|
39
39
|
*
|
40
|
-
* - Docs: https://viem.sh/docs/actions/public/getBalance
|
40
|
+
* - Docs: https://viem.sh/docs/actions/public/getBalance
|
41
41
|
* - JSON-RPC Methods: [`eth_getBalance`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance)
|
42
42
|
*
|
43
|
-
* You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther
|
43
|
+
* You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther).
|
44
44
|
*
|
45
45
|
* ```ts
|
46
46
|
* const balance = await getBalance(client, {
|
@@ -65,7 +65,7 @@ export type GetBlockErrorType =
|
|
65
65
|
/**
|
66
66
|
* Returns information about a block at a block number, hash, or tag.
|
67
67
|
*
|
68
|
-
* - Docs: https://viem.sh/docs/actions/public/getBlock
|
68
|
+
* - Docs: https://viem.sh/docs/actions/public/getBlock
|
69
69
|
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks
|
70
70
|
* - JSON-RPC Methods:
|
71
71
|
* - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) for `blockNumber` & `blockTag`.
|
@@ -23,7 +23,7 @@ export function getBlockNumberCache(id: string) {
|
|
23
23
|
/**
|
24
24
|
* Returns the number of the most recent block seen.
|
25
25
|
*
|
26
|
-
* - Docs: https://viem.sh/docs/actions/public/getBlockNumber
|
26
|
+
* - Docs: https://viem.sh/docs/actions/public/getBlockNumber
|
27
27
|
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks
|
28
28
|
* - JSON-RPC Methods: [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber)
|
29
29
|
*
|
@@ -46,7 +46,7 @@ export type GetBlockTransactionCountErrorType =
|
|
46
46
|
/**
|
47
47
|
* Returns the number of Transactions at a block number, hash, or tag.
|
48
48
|
*
|
49
|
-
* - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount
|
49
|
+
* - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount
|
50
50
|
* - JSON-RPC Methods:
|
51
51
|
* - Calls [`eth_getBlockTransactionCountByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbynumber) for `blockNumber` & `blockTag`.
|
52
52
|
* - Calls [`eth_getBlockTransactionCountByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbyhash) for `blockHash`.
|
@@ -35,7 +35,7 @@ export type GetBytecodeErrorType =
|
|
35
35
|
/**
|
36
36
|
* Retrieves the bytecode at an address.
|
37
37
|
*
|
38
|
-
* - Docs: https://viem.sh/docs/contract/getBytecode
|
38
|
+
* - Docs: https://viem.sh/docs/contract/getBytecode
|
39
39
|
* - JSON-RPC Methods: [`eth_getCode`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode)
|
40
40
|
*
|
41
41
|
* @param client - Client to use
|
@@ -19,7 +19,7 @@ export type GetChainIdErrorType =
|
|
19
19
|
/**
|
20
20
|
* Returns the chain ID associated with the current network.
|
21
21
|
*
|
22
|
-
* - Docs: https://viem.sh/docs/actions/public/getChainId
|
22
|
+
* - Docs: https://viem.sh/docs/actions/public/getChainId
|
23
23
|
* - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid)
|
24
24
|
*
|
25
25
|
* @param client - Client to use
|
@@ -89,7 +89,7 @@ export type GetContractEventsErrorType =
|
|
89
89
|
/**
|
90
90
|
* Returns a list of event logs emitted by a contract.
|
91
91
|
*
|
92
|
-
* - Docs: https://viem.sh/docs/actions/public/getContractEvents
|
92
|
+
* - Docs: https://viem.sh/docs/actions/public/getContractEvents
|
93
93
|
* - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs)
|
94
94
|
*
|
95
95
|
* @param client - Client to use
|
@@ -47,7 +47,7 @@ export type GetFeeHistoryErrorType =
|
|
47
47
|
/**
|
48
48
|
* Returns a collection of historical gas information.
|
49
49
|
*
|
50
|
-
* - Docs: https://viem.sh/docs/actions/public/getFeeHistory
|
50
|
+
* - Docs: https://viem.sh/docs/actions/public/getFeeHistory
|
51
51
|
* - JSON-RPC Methods: [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory)
|
52
52
|
*
|
53
53
|
* @param client - Client to use
|
@@ -64,15 +64,15 @@ export type GetFilterChangesErrorType =
|
|
64
64
|
/**
|
65
65
|
* Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#filter) since the last time it was called.
|
66
66
|
*
|
67
|
-
* - Docs: https://viem.sh/docs/actions/public/getFilterChanges
|
67
|
+
* - Docs: https://viem.sh/docs/actions/public/getFilterChanges
|
68
68
|
* - JSON-RPC Methods: [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges)
|
69
69
|
*
|
70
70
|
* A Filter can be created from the following actions:
|
71
71
|
*
|
72
|
-
* - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter
|
73
|
-
* - [`createContractEventFilter`](https://viem.sh/docs/contract/createContractEventFilter
|
74
|
-
* - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter
|
75
|
-
* - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter
|
72
|
+
* - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter)
|
73
|
+
* - [`createContractEventFilter`](https://viem.sh/docs/contract/createContractEventFilter)
|
74
|
+
* - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter)
|
75
|
+
* - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter)
|
76
76
|
*
|
77
77
|
* Depending on the type of filter, the return value will be different:
|
78
78
|
*
|
@@ -50,7 +50,7 @@ export type GetFilterLogsErrorType =
|
|
50
50
|
/**
|
51
51
|
* Returns a list of event logs since the filter was created.
|
52
52
|
*
|
53
|
-
* - Docs: https://viem.sh/docs/actions/public/getFilterLogs
|
53
|
+
* - Docs: https://viem.sh/docs/actions/public/getFilterLogs
|
54
54
|
* - JSON-RPC Methods: [`eth_getFilterLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs)
|
55
55
|
*
|
56
56
|
* `getFilterLogs` is only compatible with **event filters**.
|
@@ -12,7 +12,7 @@ export type GetGasPriceErrorType = RequestErrorType | ErrorType
|
|
12
12
|
/**
|
13
13
|
* Returns the current price of gas (in wei).
|
14
14
|
*
|
15
|
-
* - Docs: https://viem.sh/docs/actions/public/getGasPrice
|
15
|
+
* - Docs: https://viem.sh/docs/actions/public/getGasPrice
|
16
16
|
* - JSON-RPC Methods: [`eth_gasPrice`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gasprice)
|
17
17
|
*
|
18
18
|
* @param client - Client to use
|
@@ -112,7 +112,7 @@ export type GetLogsErrorType =
|
|
112
112
|
/**
|
113
113
|
* Returns a list of event logs matching the provided parameters.
|
114
114
|
*
|
115
|
-
* - Docs: https://viem.sh/docs/actions/public/getLogs
|
115
|
+
* - Docs: https://viem.sh/docs/actions/public/getLogs
|
116
116
|
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs
|
117
117
|
* - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs)
|
118
118
|
*
|
@@ -48,7 +48,7 @@ export type GetProofErrorType =
|
|
48
48
|
/**
|
49
49
|
* Returns the account and storage values of the specified account including the Merkle-proof.
|
50
50
|
*
|
51
|
-
* - Docs: https://viem.sh/docs/actions/public/getProof
|
51
|
+
* - Docs: https://viem.sh/docs/actions/public/getProof
|
52
52
|
* - JSON-RPC Methods:
|
53
53
|
* - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186)
|
54
54
|
*
|
@@ -36,7 +36,7 @@ export type GetStorageAtErrorType =
|
|
36
36
|
/**
|
37
37
|
* Returns the value from a storage slot at a given address.
|
38
38
|
*
|
39
|
-
* - Docs: https://viem.sh/docs/contract/getStorageAt
|
39
|
+
* - Docs: https://viem.sh/docs/contract/getStorageAt
|
40
40
|
* - JSON-RPC Methods: [`eth_getStorageAt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getstorageat)
|
41
41
|
*
|
42
42
|
* @param client - Client to use
|
@@ -64,9 +64,9 @@ export type GetTransactionErrorType =
|
|
64
64
|
| ErrorType
|
65
65
|
|
66
66
|
/**
|
67
|
-
* Returns information about a [Transaction](https://viem.sh/docs/glossary/terms
|
67
|
+
* Returns information about a [Transaction](https://viem.sh/docs/glossary/terms#transaction) given a hash or block identifier.
|
68
68
|
*
|
69
|
-
* - Docs: https://viem.sh/docs/actions/public/getTransaction
|
69
|
+
* - Docs: https://viem.sh/docs/actions/public/getTransaction
|
70
70
|
* - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
|
71
71
|
* - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash)
|
72
72
|
*
|
@@ -39,7 +39,7 @@ export type GetTransactionConfirmationsErrorType =
|
|
39
39
|
/**
|
40
40
|
* Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
|
41
41
|
*
|
42
|
-
* - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations
|
42
|
+
* - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations
|
43
43
|
* - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
|
44
44
|
* - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations)
|
45
45
|
*
|