viem 1.0.2 → 1.0.5

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.
Files changed (365) hide show
  1. package/dist/cjs/actions/test/sendUnsignedTransaction.js +21 -3
  2. package/dist/cjs/actions/test/sendUnsignedTransaction.js.map +1 -1
  3. package/dist/cjs/chains.js.map +1 -1
  4. package/dist/cjs/clients/decorators/test.js.map +1 -1
  5. package/dist/cjs/errors/base.js +4 -11
  6. package/dist/cjs/errors/base.js.map +1 -1
  7. package/dist/cjs/errors/version.js +1 -1
  8. package/dist/cjs/utils/encoding/toBytes.js.map +1 -1
  9. package/dist/cjs/utils/encoding/toHex.js.map +1 -1
  10. package/dist/cjs/utils/formatters/block.js +3 -1
  11. package/dist/cjs/utils/formatters/block.js.map +1 -1
  12. package/dist/cjs/utils/formatters/transaction.js +3 -1
  13. package/dist/cjs/utils/formatters/transaction.js.map +1 -1
  14. package/dist/cjs/utils/formatters/transactionReceipt.js.map +1 -1
  15. package/dist/cjs/utils/formatters/transactionRequest.js.map +1 -1
  16. package/dist/cjs/utils/observe.js.map +1 -1
  17. package/dist/cjs/utils/promise/createBatchScheduler.js.map +1 -1
  18. package/dist/cjs/utils/promise/withCache.js.map +1 -1
  19. package/dist/cjs/utils/rpc.js.map +1 -1
  20. package/dist/cjs/utils/unit/parseUnits.js +1 -2
  21. package/dist/cjs/utils/unit/parseUnits.js.map +1 -1
  22. package/dist/esm/accounts/generateMnemonic.js +7 -0
  23. package/dist/esm/accounts/generateMnemonic.js.map +1 -1
  24. package/dist/esm/accounts/generatePrivateKey.js +5 -0
  25. package/dist/esm/accounts/generatePrivateKey.js.map +1 -1
  26. package/dist/esm/accounts/hdKeyToAccount.js +5 -0
  27. package/dist/esm/accounts/hdKeyToAccount.js.map +1 -1
  28. package/dist/esm/accounts/mnemonicToAccount.js +5 -0
  29. package/dist/esm/accounts/mnemonicToAccount.js.map +1 -1
  30. package/dist/esm/accounts/privateKeyToAccount.js +5 -0
  31. package/dist/esm/accounts/privateKeyToAccount.js.map +1 -1
  32. package/dist/esm/accounts/toAccount.js +5 -0
  33. package/dist/esm/accounts/toAccount.js.map +1 -1
  34. package/dist/esm/accounts/utils/publicKeyToAddress.js +7 -0
  35. package/dist/esm/accounts/utils/publicKeyToAddress.js.map +1 -1
  36. package/dist/esm/accounts/utils/sign.js +8 -0
  37. package/dist/esm/accounts/utils/sign.js.map +1 -1
  38. package/dist/esm/accounts/utils/signMessage.js +6 -0
  39. package/dist/esm/accounts/utils/signMessage.js.map +1 -1
  40. package/dist/esm/accounts/utils/signTypedData.js +6 -0
  41. package/dist/esm/accounts/utils/signTypedData.js.map +1 -1
  42. package/dist/esm/actions/ens/getEnsAddress.js +28 -0
  43. package/dist/esm/actions/ens/getEnsAddress.js.map +1 -1
  44. package/dist/esm/actions/ens/getEnsAvatar.js +28 -0
  45. package/dist/esm/actions/ens/getEnsAvatar.js.map +1 -1
  46. package/dist/esm/actions/ens/getEnsName.js +27 -0
  47. package/dist/esm/actions/ens/getEnsName.js.map +1 -1
  48. package/dist/esm/actions/ens/getEnsResolver.js +28 -0
  49. package/dist/esm/actions/ens/getEnsResolver.js.map +1 -1
  50. package/dist/esm/actions/ens/getEnsText.js +29 -0
  51. package/dist/esm/actions/ens/getEnsText.js.map +1 -1
  52. package/dist/esm/actions/getContract.js +36 -0
  53. package/dist/esm/actions/getContract.js.map +1 -1
  54. package/dist/esm/actions/public/call.js +31 -0
  55. package/dist/esm/actions/public/call.js.map +1 -1
  56. package/dist/esm/actions/public/createBlockFilter.js +21 -0
  57. package/dist/esm/actions/public/createBlockFilter.js.map +1 -1
  58. package/dist/esm/actions/public/createContractEventFilter.js +22 -0
  59. package/dist/esm/actions/public/createContractEventFilter.js.map +1 -1
  60. package/dist/esm/actions/public/createEventFilter.js +23 -0
  61. package/dist/esm/actions/public/createEventFilter.js.map +1 -1
  62. package/dist/esm/actions/public/createPendingTransactionFilter.js +21 -0
  63. package/dist/esm/actions/public/createPendingTransactionFilter.js.map +1 -1
  64. package/dist/esm/actions/public/estimateContractGas.js +27 -0
  65. package/dist/esm/actions/public/estimateContractGas.js.map +1 -1
  66. package/dist/esm/actions/public/estimateGas.js +26 -0
  67. package/dist/esm/actions/public/estimateGas.js.map +1 -1
  68. package/dist/esm/actions/public/getBalance.js +35 -0
  69. package/dist/esm/actions/public/getBalance.js.map +1 -1
  70. package/dist/esm/actions/public/getBlock.js +24 -0
  71. package/dist/esm/actions/public/getBlock.js.map +1 -1
  72. package/dist/esm/actions/public/getBlockNumber.js +23 -0
  73. package/dist/esm/actions/public/getBlockNumber.js.map +1 -1
  74. package/dist/esm/actions/public/getBlockTransactionCount.js +23 -0
  75. package/dist/esm/actions/public/getBlockTransactionCount.js.map +1 -1
  76. package/dist/esm/actions/public/getBytecode.js +23 -0
  77. package/dist/esm/actions/public/getBytecode.js.map +1 -1
  78. package/dist/esm/actions/public/getChainId.js +21 -0
  79. package/dist/esm/actions/public/getChainId.js.map +1 -1
  80. package/dist/esm/actions/public/getFeeHistory.js +24 -0
  81. package/dist/esm/actions/public/getFeeHistory.js.map +1 -1
  82. package/dist/esm/actions/public/getFilterChanges.js +84 -0
  83. package/dist/esm/actions/public/getFilterChanges.js.map +1 -1
  84. package/dist/esm/actions/public/getFilterLogs.js +29 -0
  85. package/dist/esm/actions/public/getFilterLogs.js.map +1 -1
  86. package/dist/esm/actions/public/getGasPrice.js +20 -0
  87. package/dist/esm/actions/public/getGasPrice.js.map +1 -1
  88. package/dist/esm/actions/public/getLogs.js +24 -0
  89. package/dist/esm/actions/public/getLogs.js.map +1 -1
  90. package/dist/esm/actions/public/getStorageAt.js +24 -0
  91. package/dist/esm/actions/public/getStorageAt.js.map +1 -1
  92. package/dist/esm/actions/public/getTransaction.js +24 -0
  93. package/dist/esm/actions/public/getTransaction.js.map +1 -1
  94. package/dist/esm/actions/public/getTransactionConfirmations.js +24 -0
  95. package/dist/esm/actions/public/getTransactionConfirmations.js.map +1 -1
  96. package/dist/esm/actions/public/getTransactionCount.js +23 -0
  97. package/dist/esm/actions/public/getTransactionCount.js.map +1 -1
  98. package/dist/esm/actions/public/getTransactionReceipt.js +24 -0
  99. package/dist/esm/actions/public/getTransactionReceipt.js.map +1 -1
  100. package/dist/esm/actions/public/multicall.js +40 -0
  101. package/dist/esm/actions/public/multicall.js.map +1 -1
  102. package/dist/esm/actions/public/readContract.js +31 -0
  103. package/dist/esm/actions/public/readContract.js.map +1 -1
  104. package/dist/esm/actions/public/simulateContract.js +31 -0
  105. package/dist/esm/actions/public/simulateContract.js.map +1 -1
  106. package/dist/esm/actions/public/uninstallFilter.js +24 -0
  107. package/dist/esm/actions/public/uninstallFilter.js.map +1 -1
  108. package/dist/esm/actions/public/verifyHash.js +10 -0
  109. package/dist/esm/actions/public/verifyHash.js.map +1 -1
  110. package/dist/esm/actions/public/verifyMessage.js +11 -0
  111. package/dist/esm/actions/public/verifyMessage.js.map +1 -1
  112. package/dist/esm/actions/public/verifyTypedData.js +9 -0
  113. package/dist/esm/actions/public/verifyTypedData.js.map +1 -1
  114. package/dist/esm/actions/public/waitForTransactionReceipt.js +52 -0
  115. package/dist/esm/actions/public/waitForTransactionReceipt.js.map +1 -1
  116. package/dist/esm/actions/public/watchBlockNumber.js +31 -0
  117. package/dist/esm/actions/public/watchBlockNumber.js.map +1 -1
  118. package/dist/esm/actions/public/watchBlocks.js +35 -1
  119. package/dist/esm/actions/public/watchBlocks.js.map +1 -1
  120. package/dist/esm/actions/public/watchContractEvent.js +36 -0
  121. package/dist/esm/actions/public/watchContractEvent.js.map +1 -1
  122. package/dist/esm/actions/public/watchEvent.js +38 -0
  123. package/dist/esm/actions/public/watchEvent.js.map +1 -1
  124. package/dist/esm/actions/public/watchPendingTransactions.js +29 -0
  125. package/dist/esm/actions/public/watchPendingTransactions.js.map +1 -1
  126. package/dist/esm/actions/test/dropTransaction.js +22 -0
  127. package/dist/esm/actions/test/dropTransaction.js.map +1 -1
  128. package/dist/esm/actions/test/getAutomine.js +20 -0
  129. package/dist/esm/actions/test/getAutomine.js.map +1 -1
  130. package/dist/esm/actions/test/getTxpoolContent.js +20 -0
  131. package/dist/esm/actions/test/getTxpoolContent.js.map +1 -1
  132. package/dist/esm/actions/test/getTxpoolStatus.js +20 -0
  133. package/dist/esm/actions/test/getTxpoolStatus.js.map +1 -1
  134. package/dist/esm/actions/test/impersonateAccount.js +22 -0
  135. package/dist/esm/actions/test/impersonateAccount.js.map +1 -1
  136. package/dist/esm/actions/test/increaseTime.js +22 -0
  137. package/dist/esm/actions/test/increaseTime.js.map +1 -1
  138. package/dist/esm/actions/test/inspectTxpool.js +20 -0
  139. package/dist/esm/actions/test/inspectTxpool.js.map +1 -1
  140. package/dist/esm/actions/test/mine.js +20 -0
  141. package/dist/esm/actions/test/mine.js.map +1 -1
  142. package/dist/esm/actions/test/removeBlockTimestampInterval.js +19 -0
  143. package/dist/esm/actions/test/removeBlockTimestampInterval.js.map +1 -1
  144. package/dist/esm/actions/test/reset.js +20 -0
  145. package/dist/esm/actions/test/reset.js.map +1 -1
  146. package/dist/esm/actions/test/revert.js +20 -0
  147. package/dist/esm/actions/test/revert.js.map +1 -1
  148. package/dist/esm/actions/test/sendUnsignedTransaction.js +48 -4
  149. package/dist/esm/actions/test/sendUnsignedTransaction.js.map +1 -1
  150. package/dist/esm/actions/test/setAutomine.js +19 -0
  151. package/dist/esm/actions/test/setAutomine.js.map +1 -1
  152. package/dist/esm/actions/test/setBalance.js +23 -0
  153. package/dist/esm/actions/test/setBalance.js.map +1 -1
  154. package/dist/esm/actions/test/setBlockGasLimit.js +20 -0
  155. package/dist/esm/actions/test/setBlockGasLimit.js.map +1 -1
  156. package/dist/esm/actions/test/setBlockTimestampInterval.js +20 -0
  157. package/dist/esm/actions/test/setBlockTimestampInterval.js.map +1 -1
  158. package/dist/esm/actions/test/setCode.js +23 -0
  159. package/dist/esm/actions/test/setCode.js.map +1 -1
  160. package/dist/esm/actions/test/setCoinbase.js +22 -0
  161. package/dist/esm/actions/test/setCoinbase.js.map +1 -1
  162. package/dist/esm/actions/test/setIntervalMining.js +20 -0
  163. package/dist/esm/actions/test/setIntervalMining.js.map +1 -1
  164. package/dist/esm/actions/test/setLoggingEnabled.js +19 -0
  165. package/dist/esm/actions/test/setLoggingEnabled.js.map +1 -1
  166. package/dist/esm/actions/test/setMinGasPrice.js +24 -0
  167. package/dist/esm/actions/test/setMinGasPrice.js.map +1 -1
  168. package/dist/esm/actions/test/setNextBlockBaseFeePerGas.js +22 -0
  169. package/dist/esm/actions/test/setNextBlockBaseFeePerGas.js.map +1 -1
  170. package/dist/esm/actions/test/setNextBlockTimestamp.js +20 -0
  171. package/dist/esm/actions/test/setNextBlockTimestamp.js.map +1 -1
  172. package/dist/esm/actions/test/setNonce.js +23 -0
  173. package/dist/esm/actions/test/setNonce.js.map +1 -1
  174. package/dist/esm/actions/test/setRpcUrl.js +20 -0
  175. package/dist/esm/actions/test/setRpcUrl.js.map +1 -1
  176. package/dist/esm/actions/test/setStorageAt.js +24 -0
  177. package/dist/esm/actions/test/setStorageAt.js.map +1 -1
  178. package/dist/esm/actions/test/snapshot.js +19 -0
  179. package/dist/esm/actions/test/snapshot.js.map +1 -1
  180. package/dist/esm/actions/test/stopImpersonatingAccount.js +22 -0
  181. package/dist/esm/actions/test/stopImpersonatingAccount.js.map +1 -1
  182. package/dist/esm/actions/wallet/addChain.js +19 -0
  183. package/dist/esm/actions/wallet/addChain.js.map +1 -1
  184. package/dist/esm/actions/wallet/deployContract.js +27 -0
  185. package/dist/esm/actions/wallet/deployContract.js.map +1 -1
  186. package/dist/esm/actions/wallet/getAddresses.js +20 -0
  187. package/dist/esm/actions/wallet/getAddresses.js.map +1 -1
  188. package/dist/esm/actions/wallet/getPermissions.js +20 -0
  189. package/dist/esm/actions/wallet/getPermissions.js.map +1 -1
  190. package/dist/esm/actions/wallet/requestAddresses.js +24 -0
  191. package/dist/esm/actions/wallet/requestAddresses.js.map +1 -1
  192. package/dist/esm/actions/wallet/requestPermissions.js +23 -0
  193. package/dist/esm/actions/wallet/requestPermissions.js.map +1 -1
  194. package/dist/esm/actions/wallet/sendTransaction.js +47 -0
  195. package/dist/esm/actions/wallet/sendTransaction.js.map +1 -1
  196. package/dist/esm/actions/wallet/signMessage.js +46 -0
  197. package/dist/esm/actions/wallet/signMessage.js.map +1 -1
  198. package/dist/esm/actions/wallet/signTypedData.js +100 -0
  199. package/dist/esm/actions/wallet/signTypedData.js.map +1 -1
  200. package/dist/esm/actions/wallet/switchChain.js +20 -0
  201. package/dist/esm/actions/wallet/switchChain.js.map +1 -1
  202. package/dist/esm/actions/wallet/watchAsset.js +28 -0
  203. package/dist/esm/actions/wallet/watchAsset.js.map +1 -1
  204. package/dist/esm/actions/wallet/writeContract.js +50 -0
  205. package/dist/esm/actions/wallet/writeContract.js.map +1 -1
  206. package/dist/esm/chains.js +96 -96
  207. package/dist/esm/chains.js.map +1 -1
  208. package/dist/esm/clients/createClient.js +3 -0
  209. package/dist/esm/clients/createClient.js.map +1 -1
  210. package/dist/esm/clients/createPublicClient.js +19 -0
  211. package/dist/esm/clients/createPublicClient.js.map +1 -1
  212. package/dist/esm/clients/createTestClient.js +23 -0
  213. package/dist/esm/clients/createTestClient.js.map +1 -1
  214. package/dist/esm/clients/createWalletClient.js +36 -0
  215. package/dist/esm/clients/createWalletClient.js.map +1 -1
  216. package/dist/esm/clients/decorators/test.js.map +1 -1
  217. package/dist/esm/clients/transports/createTransport.js +3 -0
  218. package/dist/esm/clients/transports/createTransport.js.map +1 -1
  219. package/dist/esm/clients/transports/custom.js +3 -0
  220. package/dist/esm/clients/transports/custom.js.map +1 -1
  221. package/dist/esm/clients/transports/fallback.js +11 -0
  222. package/dist/esm/clients/transports/fallback.js.map +1 -1
  223. package/dist/esm/clients/transports/http.js +6 -1
  224. package/dist/esm/clients/transports/http.js.map +1 -1
  225. package/dist/esm/clients/transports/webSocket.js +6 -1
  226. package/dist/esm/clients/transports/webSocket.js.map +1 -1
  227. package/dist/esm/constants/abis.js +6 -0
  228. package/dist/esm/constants/abis.js.map +1 -1
  229. package/dist/esm/constants/solidity.js +1 -0
  230. package/dist/esm/constants/solidity.js.map +1 -1
  231. package/dist/esm/contract.js +0 -1
  232. package/dist/esm/contract.js.map +1 -1
  233. package/dist/esm/errors/base.js +4 -11
  234. package/dist/esm/errors/base.js.map +1 -1
  235. package/dist/esm/errors/node.js +9 -0
  236. package/dist/esm/errors/node.js.map +1 -1
  237. package/dist/esm/errors/rpc.js +103 -0
  238. package/dist/esm/errors/rpc.js.map +1 -1
  239. package/dist/esm/errors/version.js +1 -1
  240. package/dist/esm/index.js +0 -52
  241. package/dist/esm/index.js.map +1 -1
  242. package/dist/esm/package.json +1 -1
  243. package/dist/esm/types/account.js +1 -1
  244. package/dist/esm/types/account.js.map +1 -1
  245. package/dist/esm/types/eip1193.js +2 -0
  246. package/dist/esm/types/eip1193.js.map +1 -1
  247. package/dist/esm/utils/abi/decodeAbiParameters.js +29 -0
  248. package/dist/esm/utils/abi/decodeAbiParameters.js.map +1 -1
  249. package/dist/esm/utils/abi/decodeEventLog.js +2 -0
  250. package/dist/esm/utils/abi/decodeEventLog.js.map +1 -1
  251. package/dist/esm/utils/abi/encodeAbiParameters.js +10 -1
  252. package/dist/esm/utils/abi/encodeAbiParameters.js.map +1 -1
  253. package/dist/esm/utils/abi/getAbiItem.js +7 -0
  254. package/dist/esm/utils/abi/getAbiItem.js.map +1 -1
  255. package/dist/esm/utils/accounts.js +3 -0
  256. package/dist/esm/utils/accounts.js.map +1 -1
  257. package/dist/esm/utils/buildRequest.js +2 -0
  258. package/dist/esm/utils/buildRequest.js.map +1 -1
  259. package/dist/esm/utils/data/size.js +6 -0
  260. package/dist/esm/utils/data/size.js.map +1 -1
  261. package/dist/esm/utils/data/slice.js +21 -0
  262. package/dist/esm/utils/data/slice.js.map +1 -1
  263. package/dist/esm/utils/encoding/fromBytes.js +79 -0
  264. package/dist/esm/utils/encoding/fromBytes.js.map +1 -1
  265. package/dist/esm/utils/encoding/fromHex.js +106 -0
  266. package/dist/esm/utils/encoding/fromHex.js.map +1 -1
  267. package/dist/esm/utils/encoding/toBytes.js +102 -1
  268. package/dist/esm/utils/encoding/toBytes.js.map +1 -1
  269. package/dist/esm/utils/encoding/toHex.js +108 -2
  270. package/dist/esm/utils/encoding/toHex.js.map +1 -1
  271. package/dist/esm/utils/ens/avatar/parseAvatarRecord.js +6 -2
  272. package/dist/esm/utils/ens/avatar/parseAvatarRecord.js.map +1 -1
  273. package/dist/esm/utils/ens/avatar/utils.js +10 -0
  274. package/dist/esm/utils/ens/avatar/utils.js.map +1 -1
  275. package/dist/esm/utils/ens/labelhash.js +9 -0
  276. package/dist/esm/utils/ens/labelhash.js.map +1 -1
  277. package/dist/esm/utils/ens/namehash.js +12 -0
  278. package/dist/esm/utils/ens/namehash.js.map +1 -1
  279. package/dist/esm/utils/ens/normalize.js +10 -0
  280. package/dist/esm/utils/ens/normalize.js.map +1 -1
  281. package/dist/esm/utils/ens/packetToBytes.js +6 -0
  282. package/dist/esm/utils/ens/packetToBytes.js.map +1 -1
  283. package/dist/esm/utils/filters/createFilterRequestScope.js +5 -0
  284. package/dist/esm/utils/filters/createFilterRequestScope.js.map +1 -1
  285. package/dist/esm/utils/formatters/block.js +4 -1
  286. package/dist/esm/utils/formatters/block.js.map +1 -1
  287. package/dist/esm/utils/formatters/extract.js +3 -0
  288. package/dist/esm/utils/formatters/extract.js.map +1 -1
  289. package/dist/esm/utils/formatters/format.js +3 -0
  290. package/dist/esm/utils/formatters/format.js.map +1 -1
  291. package/dist/esm/utils/formatters/transaction.js +3 -1
  292. package/dist/esm/utils/formatters/transaction.js.map +1 -1
  293. package/dist/esm/utils/formatters/transactionReceipt.js +1 -1
  294. package/dist/esm/utils/formatters/transactionReceipt.js.map +1 -1
  295. package/dist/esm/utils/formatters/transactionRequest.js +1 -1
  296. package/dist/esm/utils/formatters/transactionRequest.js.map +1 -1
  297. package/dist/esm/utils/observe.js +7 -2
  298. package/dist/esm/utils/observe.js.map +1 -1
  299. package/dist/esm/utils/poll.js +3 -0
  300. package/dist/esm/utils/poll.js.map +1 -1
  301. package/dist/esm/utils/promise/createBatchScheduler.js +1 -1
  302. package/dist/esm/utils/promise/createBatchScheduler.js.map +1 -1
  303. package/dist/esm/utils/promise/withCache.js +15 -2
  304. package/dist/esm/utils/promise/withCache.js.map +1 -1
  305. package/dist/esm/utils/regex.js +4 -0
  306. package/dist/esm/utils/regex.js.map +1 -1
  307. package/dist/esm/utils/rpc.js +14 -1
  308. package/dist/esm/utils/rpc.js.map +1 -1
  309. package/dist/esm/utils/signature/hashTypedData.js +3 -0
  310. package/dist/esm/utils/signature/hashTypedData.js.map +1 -1
  311. package/dist/esm/utils/signature/recoverPublicKey.js +2 -0
  312. package/dist/esm/utils/signature/recoverPublicKey.js.map +1 -1
  313. package/dist/esm/utils/signature/verifyMessage.js +12 -0
  314. package/dist/esm/utils/signature/verifyMessage.js.map +1 -1
  315. package/dist/esm/utils/signature/verifyTypedData.js +12 -0
  316. package/dist/esm/utils/signature/verifyTypedData.js.map +1 -1
  317. package/dist/esm/utils/transaction/prepareRequest.js +5 -1
  318. package/dist/esm/utils/transaction/prepareRequest.js.map +1 -1
  319. package/dist/esm/utils/transaction/serializeTransaction.js +4 -2
  320. package/dist/esm/utils/transaction/serializeTransaction.js.map +1 -1
  321. package/dist/esm/utils/typedData.js +4 -0
  322. package/dist/esm/utils/typedData.js.map +1 -1
  323. package/dist/esm/utils/unit/parseUnits.js +3 -2
  324. package/dist/esm/utils/unit/parseUnits.js.map +1 -1
  325. package/dist/types/actions/public/getBlockNumber.d.ts +2 -2
  326. package/dist/types/actions/public/getBlockNumber.d.ts.map +1 -1
  327. package/dist/types/actions/test/sendUnsignedTransaction.d.ts +8 -2
  328. package/dist/types/actions/test/sendUnsignedTransaction.d.ts.map +1 -1
  329. package/dist/types/chains.d.ts.map +1 -1
  330. package/dist/types/clients/decorators/test.d.ts +1 -1
  331. package/dist/types/clients/decorators/test.d.ts.map +1 -1
  332. package/dist/types/contract.d.ts +1 -1
  333. package/dist/types/contract.d.ts.map +1 -1
  334. package/dist/types/errors/base.d.ts +0 -1
  335. package/dist/types/errors/base.d.ts.map +1 -1
  336. package/dist/types/errors/version.d.ts +1 -1
  337. package/dist/types/index.d.ts +52 -52
  338. package/dist/types/index.d.ts.map +1 -1
  339. package/dist/types/types/account.d.ts +1 -1
  340. package/dist/types/types/account.d.ts.map +1 -1
  341. package/dist/types/utils/formatters/block.d.ts.map +1 -1
  342. package/dist/types/utils/formatters/transaction.d.ts.map +1 -1
  343. package/dist/types/utils/observe.d.ts.map +1 -1
  344. package/dist/types/utils/promise/withCache.d.ts.map +1 -1
  345. package/dist/types/utils/unit/parseUnits.d.ts.map +1 -1
  346. package/package.json +1 -1
  347. package/src/actions/test/sendUnsignedTransaction.ts +54 -5
  348. package/src/chains.ts +120 -97
  349. package/src/clients/decorators/test.ts +4 -3
  350. package/src/contract.ts +3 -3
  351. package/src/errors/base.ts +6 -6
  352. package/src/errors/version.ts +1 -1
  353. package/src/index.ts +221 -221
  354. package/src/types/account.ts +9 -9
  355. package/src/utils/encoding/toBytes.ts +1 -1
  356. package/src/utils/encoding/toHex.ts +2 -2
  357. package/src/utils/formatters/block.ts +3 -1
  358. package/src/utils/formatters/transaction.ts +3 -1
  359. package/src/utils/formatters/transactionReceipt.ts +1 -1
  360. package/src/utils/formatters/transactionRequest.ts +1 -1
  361. package/src/utils/observe.ts +2 -2
  362. package/src/utils/promise/createBatchScheduler.ts +1 -1
  363. package/src/utils/promise/withCache.ts +2 -2
  364. package/src/utils/rpc.ts +1 -1
  365. package/src/utils/unit/parseUnits.ts +1 -5
@@ -1 +1 @@
1
- {"version":3,"file":"getPermissions.js","sourceRoot":"","sources":["../../../../src/actions/wallet/getPermissions.ts"],"names":[],"mappings":"AA4BA,MAAM,CAAC,KAAK,UAAU,cAAc,CAGlC,MAAiD;IACjD,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAA;IAC7E,OAAO,WAAW,CAAA;AACpB,CAAC"}
1
+ {"version":3,"file":"getPermissions.js","sourceRoot":"","sources":["../../../../src/actions/wallet/getPermissions.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAGlC,MAAiD;IACjD,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAA;IAC7E,OAAO,WAAW,CAAA;AACpB,CAAC"}
@@ -1,4 +1,28 @@
1
1
  import { getAddress } from '../../utils/address/getAddress.js';
2
+ /**
3
+ * Requests a list of accounts managed by a wallet.
4
+ *
5
+ * - Docs: https://viem.sh/docs/actions/wallet/requestAddresses.html
6
+ * - JSON-RPC Methods: [`eth_requestAccounts`](https://eips.ethereum.org/EIPS/eip-1102)
7
+ *
8
+ * Sends a request to the wallet, asking for permission to access the user's accounts. After the user accepts the request, it will return a list of accounts (addresses).
9
+ *
10
+ * This API can be useful for dapps that need to access the user's accounts in order to execute transactions or interact with smart contracts.
11
+ *
12
+ * @param client - Client to use
13
+ * @returns List of accounts managed by a wallet {@link RequestAddressesReturnType}
14
+ *
15
+ * @example
16
+ * import { createWalletClient, custom } from 'viem'
17
+ * import { mainnet } from 'viem/chains'
18
+ * import { requestAddresses } from 'viem/wallet'
19
+ *
20
+ * const client = createWalletClient({
21
+ * chain: mainnet,
22
+ * transport: custom(window.ethereum),
23
+ * })
24
+ * const accounts = await requestAddresses(client)
25
+ */
2
26
  export async function requestAddresses(client) {
3
27
  const addresses = await client.request({ method: 'eth_requestAccounts' });
4
28
  return addresses.map((address) => getAddress(address));
@@ -1 +1 @@
1
- {"version":3,"file":"requestAddresses.js","sourceRoot":"","sources":["../../../../src/actions/wallet/requestAddresses.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AA4B9D,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAIpC,MAAiD;IAEjD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,qBAAqB,EAAE,CAAC,CAAA;IACzE,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAA;AACxD,CAAC"}
1
+ {"version":3,"file":"requestAddresses.js","sourceRoot":"","sources":["../../../../src/actions/wallet/requestAddresses.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAI9D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAIpC,MAAiD;IAEjD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,qBAAqB,EAAE,CAAC,CAAA;IACzE,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAA;AACxD,CAAC"}
@@ -1,3 +1,26 @@
1
+ /**
2
+ * Requests permissions for a wallet.
3
+ *
4
+ * - Docs: https://viem.sh/docs/actions/wallet/requestPermissions.html
5
+ * - JSON-RPC Methods: [`wallet_requestPermissions`](https://eips.ethereum.org/EIPS/eip-2255)
6
+ *
7
+ * @param client - Client to use
8
+ * @param parameters - {@link RequestPermissionsParameters}
9
+ * @returns The wallet permissions. {@link RequestPermissionsReturnType}
10
+ *
11
+ * @example
12
+ * import { createWalletClient, custom } from 'viem'
13
+ * import { mainnet } from 'viem/chains'
14
+ * import { requestPermissions } from 'viem/wallet'
15
+ *
16
+ * const client = createWalletClient({
17
+ * chain: mainnet,
18
+ * transport: custom(window.ethereum),
19
+ * })
20
+ * const permissions = await requestPermissions(client, {
21
+ * eth_accounts: {}
22
+ * })
23
+ */
1
24
  export async function requestPermissions(client, permissions) {
2
25
  return client.request({
3
26
  method: 'wallet_requestPermissions',
@@ -1 +1 @@
1
- {"version":3,"file":"requestPermissions.js","sourceRoot":"","sources":["../../../../src/actions/wallet/requestPermissions.ts"],"names":[],"mappings":"AAuCA,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAItC,MAAiD,EACjD,WAAyC;IAEzC,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,2BAA2B;QACnC,MAAM,EAAE,CAAC,WAAW,CAAC;KACtB,CAAC,CAAA;AACJ,CAAC"}
1
+ {"version":3,"file":"requestPermissions.js","sourceRoot":"","sources":["../../../../src/actions/wallet/requestPermissions.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAItC,MAAiD,EACjD,WAAyC;IAEzC,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,2BAA2B;QACnC,MAAM,EAAE,CAAC,WAAW,CAAC;KACtB,CAAC,CAAA;AACJ,CAAC"}
@@ -8,6 +8,51 @@ import { formatTransactionRequest, } from '../../utils/formatters/transactionReq
8
8
  import { assertRequest } from '../../utils/transaction/assertRequest.js';
9
9
  import { prepareRequest } from '../../utils/transaction/prepareRequest.js';
10
10
  import { getChainId } from '../public/getChainId.js';
11
+ /**
12
+ * Creates, signs, and sends a new transaction to the network.
13
+ *
14
+ * - Docs: https://viem.sh/docs/actions/wallet/sendTransaction.html
15
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/sending-transactions
16
+ * - JSON-RPC Methods:
17
+ * - JSON-RPC Accounts: [`eth_sendTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendtransaction)
18
+ * - Local Accounts: [`eth_sendRawTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendrawtransaction)
19
+ *
20
+ * @param client - Client to use
21
+ * @param parameters - {@link SendTransactionParameters}
22
+ * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link SendTransactionReturnType}
23
+ *
24
+ * @example
25
+ * import { createWalletClient, custom } from 'viem'
26
+ * import { mainnet } from 'viem/chains'
27
+ * import { sendTransaction } from 'viem/wallet'
28
+ *
29
+ * const client = createWalletClient({
30
+ * chain: mainnet,
31
+ * transport: custom(window.ethereum),
32
+ * })
33
+ * const hash = await sendTransaction(client, {
34
+ * account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
35
+ * to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
36
+ * value: 1000000000000000000n,
37
+ * })
38
+ *
39
+ * @example
40
+ * // Account Hoisting
41
+ * import { createWalletClient, http } from 'viem'
42
+ * import { privateKeyToAccount } from 'viem/accounts'
43
+ * import { mainnet } from 'viem/chains'
44
+ * import { sendTransaction } from 'viem/wallet'
45
+ *
46
+ * const client = createWalletClient({
47
+ * account: privateKeyToAccount('0x…'),
48
+ * chain: mainnet,
49
+ * transport: http(),
50
+ * })
51
+ * const hash = await sendTransaction(client, {
52
+ * to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
53
+ * value: 1000000000000000000n,
54
+ * })
55
+ */
11
56
  export async function sendTransaction(client, args) {
12
57
  const { account: account_ = client.account, chain = client.chain, accessList, data, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, to, value, ...rest } = args;
13
58
  if (!account_)
@@ -26,6 +71,7 @@ export async function sendTransaction(client, args) {
26
71
  });
27
72
  }
28
73
  if (account.type === 'local') {
74
+ // Prepare the request for signing (assign appropriate fees, etc.)
29
75
  const request = await prepareRequest(client, {
30
76
  account,
31
77
  accessList,
@@ -63,6 +109,7 @@ export async function sendTransaction(client, args) {
63
109
  nonce,
64
110
  to,
65
111
  value,
112
+ // Pick out extra data that might exist on the chain's transaction request type.
66
113
  ...extract(rest, { formatter }),
67
114
  }, {
68
115
  formatter: formatter || formatTransactionRequest,
@@ -1 +1 @@
1
- {"version":3,"file":"sendTransaction.js","sourceRoot":"","sources":["../../../../src/actions/wallet/sendTransaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAW9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAA;AAC/E,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAA;AAC3D,OAAO,EAAkB,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,EAEL,wBAAwB,GACzB,MAAM,8CAA8C,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAA;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAgEpD,MAAM,CAAC,KAAK,UAAU,eAAe,CAKnC,MAAiD,EACjD,IAAiE;IAEjE,MAAM,EACJ,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAClC,KAAK,GAAG,MAAM,CAAC,KAAK,EACpB,UAAU,EACV,IAAI,EACJ,GAAG,EACH,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,KAAK,EACL,EAAE,EACF,KAAK,EACL,GAAG,IAAI,EACR,GAAG,IAAI,CAAA;IAER,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,sCAAsC;SACjD,CAAC,CAAA;IACJ,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IAEtC,IAAI;QACF,aAAa,CAAC,IAAI,CAAC,CAAA;QAEnB,IAAI,OAAO,CAAA;QACX,IAAI,KAAK,KAAK,IAAI,EAAE;YAClB,OAAO,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAA;YAClC,kBAAkB,CAAC;gBACjB,cAAc,EAAE,OAAO;gBACvB,KAAK;aACN,CAAC,CAAA;SACH;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE;YAE5B,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE;gBAC3C,OAAO;gBACP,UAAU;gBACV,KAAK;gBACL,IAAI;gBACJ,GAAG;gBACH,QAAQ;gBACR,YAAY;gBACZ,oBAAoB;gBACpB,KAAK;gBACL,EAAE;gBACF,KAAK;gBACL,GAAG,IAAI;aACR,CAAC,CAAA;YAEF,IAAI,CAAC,OAAO;gBAAE,OAAO,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAA;YAChD,MAAM,aAAa,GAAG,CAAC,MAAM,OAAO,CAAC,eAAe,CAAC;gBACnD,OAAO;gBACP,GAAG,OAAO;aACgB,CAAC,CAAS,CAAA;YACtC,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;gBAC1B,MAAM,EAAE,wBAAwB;gBAChC,MAAM,EAAE,CAAC,aAAa,CAAC;aACxB,CAAC,CAAA;SACH;QAED,MAAM,SAAS,GAAG,KAAK,EAAE,UAAU,EAAE,kBAAkB,CAAA;QACvD,MAAM,OAAO,GAAG,MAAM,CACpB;YACE,UAAU;YACV,IAAI;YACJ,IAAI,EAAE,OAAO,CAAC,OAAO;YACrB,GAAG;YACH,QAAQ;YACR,YAAY;YACZ,oBAAoB;YACpB,KAAK;YACL,EAAE;YACF,KAAK;YAEL,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC;SACV,EACvB;YACE,SAAS,EAAE,SAAS,IAAI,wBAAwB;SACjD,CACF,CAAA;QACD,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,qBAAqB;YAC7B,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC,CAAA;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,mBAAmB,CAAC,GAAgB,EAAE;YAC1C,GAAG,IAAI;YACP,OAAO;YACP,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,SAAS;SAC/B,CAAC,CAAA;KACH;AACH,CAAC"}
1
+ {"version":3,"file":"sendTransaction.js","sourceRoot":"","sources":["../../../../src/actions/wallet/sendTransaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAW9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAA;AAC/E,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAA;AAC3D,OAAO,EAAkB,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,EAEL,wBAAwB,GACzB,MAAM,8CAA8C,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAA;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAmBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAKnC,MAAiD,EACjD,IAAiE;IAEjE,MAAM,EACJ,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAClC,KAAK,GAAG,MAAM,CAAC,KAAK,EACpB,UAAU,EACV,IAAI,EACJ,GAAG,EACH,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,KAAK,EACL,EAAE,EACF,KAAK,EACL,GAAG,IAAI,EACR,GAAG,IAAI,CAAA;IAER,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,sCAAsC;SACjD,CAAC,CAAA;IACJ,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IAEtC,IAAI;QACF,aAAa,CAAC,IAAI,CAAC,CAAA;QAEnB,IAAI,OAAO,CAAA;QACX,IAAI,KAAK,KAAK,IAAI,EAAE;YAClB,OAAO,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAA;YAClC,kBAAkB,CAAC;gBACjB,cAAc,EAAE,OAAO;gBACvB,KAAK;aACN,CAAC,CAAA;SACH;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE;YAC5B,kEAAkE;YAClE,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE;gBAC3C,OAAO;gBACP,UAAU;gBACV,KAAK;gBACL,IAAI;gBACJ,GAAG;gBACH,QAAQ;gBACR,YAAY;gBACZ,oBAAoB;gBACpB,KAAK;gBACL,EAAE;gBACF,KAAK;gBACL,GAAG,IAAI;aACR,CAAC,CAAA;YAEF,IAAI,CAAC,OAAO;gBAAE,OAAO,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAA;YAChD,MAAM,aAAa,GAAG,CAAC,MAAM,OAAO,CAAC,eAAe,CAAC;gBACnD,OAAO;gBACP,GAAG,OAAO;aACgB,CAAC,CAAS,CAAA;YACtC,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;gBAC1B,MAAM,EAAE,wBAAwB;gBAChC,MAAM,EAAE,CAAC,aAAa,CAAC;aACxB,CAAC,CAAA;SACH;QAED,MAAM,SAAS,GAAG,KAAK,EAAE,UAAU,EAAE,kBAAkB,CAAA;QACvD,MAAM,OAAO,GAAG,MAAM,CACpB;YACE,UAAU;YACV,IAAI;YACJ,IAAI,EAAE,OAAO,CAAC,OAAO;YACrB,GAAG;YACH,QAAQ;YACR,YAAY;YACZ,oBAAoB;YACpB,KAAK;YACL,EAAE;YACF,KAAK;YACL,gFAAgF;YAChF,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC;SACV,EACvB;YACE,SAAS,EAAE,SAAS,IAAI,wBAAwB;SACjD,CACF,CAAA;QACD,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,qBAAqB;YAC7B,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC,CAAA;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,mBAAmB,CAAC,GAAgB,EAAE;YAC1C,GAAG,IAAI;YACP,OAAO;YACP,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,SAAS;SAC/B,CAAC,CAAA;KACH;AACH,CAAC"}
@@ -1,6 +1,52 @@
1
1
  import { parseAccount } from '../../accounts/utils/parseAccount.js';
2
2
  import { AccountNotFoundError } from '../../errors/account.js';
3
3
  import { stringToHex, toHex } from '../../utils/encoding/toHex.js';
4
+ /**
5
+ * Calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
6
+ *
7
+ * - Docs: https://viem.sh/docs/actions/wallet/signMessage.html
8
+ * - JSON-RPC Methods:
9
+ * - JSON-RPC Accounts: [`personal_sign`](https://docs.metamask.io/guide/signing-data.html#personal-sign)
10
+ * - Local Accounts: Signs locally. No JSON-RPC request.
11
+ *
12
+ * With the calculated signature, you can:
13
+ * - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage.html) to verify the signature,
14
+ * - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress.html) to recover the signing address from a signature.
15
+ *
16
+ * @param client - Client to use
17
+ * @param parameters - {@link SignMessageParameters}
18
+ * @returns The signed message. {@link SignMessageReturnType}
19
+ *
20
+ * @example
21
+ * import { createWalletClient, custom } from 'viem'
22
+ * import { mainnet } from 'viem/chains'
23
+ * import { signMessage } from 'viem/wallet'
24
+ *
25
+ * const client = createWalletClient({
26
+ * chain: mainnet,
27
+ * transport: custom(window.ethereum),
28
+ * })
29
+ * const signature = await signMessage(client, {
30
+ * account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
31
+ * message: 'hello world',
32
+ * })
33
+ *
34
+ * @example
35
+ * // Account Hoisting
36
+ * import { createWalletClient, custom } from 'viem'
37
+ * import { privateKeyToAccount } from 'viem/accounts'
38
+ * import { mainnet } from 'viem/chains'
39
+ * import { signMessage } from 'viem/wallet'
40
+ *
41
+ * const client = createWalletClient({
42
+ * account: privateKeyToAccount('0x…'),
43
+ * chain: mainnet,
44
+ * transport: custom(window.ethereum),
45
+ * })
46
+ * const signature = await signMessage(client, {
47
+ * message: 'hello world',
48
+ * })
49
+ */
4
50
  export async function signMessage(client, { account: account_ = client.account, message, }) {
5
51
  if (!account_)
6
52
  throw new AccountNotFoundError({
@@ -1 +1 @@
1
- {"version":3,"file":"signMessage.js","sourceRoot":"","sources":["../../../../src/actions/wallet/signMessage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAI9D,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AAwDlE,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAAiD,EACjD,EACE,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAClC,OAAO,GACyB;IAElC,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,kCAAkC;SAC7C,CAAC,CAAA;IACJ,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IACtC,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;IAErE,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE;QACrB,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,WAAW,CAAC,OAAO,CAAC,CAAA;QAC5D,IAAI,OAAO,CAAC,GAAG,YAAY,UAAU;YAAE,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAChE,OAAO,OAAO,CAAC,GAAG,CAAA;IACpB,CAAC,CAAC,EAAE,CAAA;IAEJ,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC;KACpC,CAAC,CAAA;AACJ,CAAC"}
1
+ {"version":3,"file":"signMessage.js","sourceRoot":"","sources":["../../../../src/actions/wallet/signMessage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAI9D,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AAUlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAAiD,EACjD,EACE,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAClC,OAAO,GACyB;IAElC,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,kCAAkC;SAC7C,CAAC,CAAA;IACJ,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IACtC,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;IAErE,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE;QACrB,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,WAAW,CAAC,OAAO,CAAC,CAAA;QAC5D,IAAI,OAAO,CAAC,GAAG,YAAY,UAAU;YAAE,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAChE,OAAO,OAAO,CAAC,GAAG,CAAA;IACpB,CAAC,CAAC,EAAE,CAAA;IAEJ,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC;KACpC,CAAC,CAAA;AACJ,CAAC"}
@@ -3,6 +3,104 @@ import { AccountNotFoundError } from '../../errors/account.js';
3
3
  import { isHex } from '../../utils/data/isHex.js';
4
4
  import { stringify } from '../../utils/stringify.js';
5
5
  import { validateTypedData } from '../../utils/typedData.js';
6
+ /**
7
+ * Signs typed data and calculates an Ethereum-specific signature in [https://eips.ethereum.org/EIPS/eip-712](https://eips.ethereum.org/EIPS/eip-712): `sign(keccak256("\x19\x01" ‖ domainSeparator ‖ hashStruct(message)))`
8
+ *
9
+ * - Docs: https://viem.sh/docs/actions/wallet/signTypedData.html
10
+ * - JSON-RPC Methods:
11
+ * - JSON-RPC Accounts: [`eth_signTypedData_v4`](https://docs.metamask.io/guide/signing-data.html#signtypeddata-v4)
12
+ * - Local Accounts: Signs locally. No JSON-RPC request.
13
+ *
14
+ * @param client - Client to use
15
+ * @param parameters - {@link SignTypedDataParameters}
16
+ * @returns The signed data. {@link SignTypedDataReturnType}
17
+ *
18
+ * @example
19
+ * import { createWalletClient, custom } from 'viem'
20
+ * import { mainnet } from 'viem/chains'
21
+ * import { signTypedData } from 'viem/wallet'
22
+ *
23
+ * const client = createWalletClient({
24
+ * chain: mainnet,
25
+ * transport: custom(window.ethereum),
26
+ * })
27
+ * const signature = await signTypedData(client, {
28
+ * account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
29
+ * domain: {
30
+ * name: 'Ether Mail',
31
+ * version: '1',
32
+ * chainId: 1,
33
+ * verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
34
+ * },
35
+ * types: {
36
+ * Person: [
37
+ * { name: 'name', type: 'string' },
38
+ * { name: 'wallet', type: 'address' },
39
+ * ],
40
+ * Mail: [
41
+ * { name: 'from', type: 'Person' },
42
+ * { name: 'to', type: 'Person' },
43
+ * { name: 'contents', type: 'string' },
44
+ * ],
45
+ * },
46
+ * primaryType: 'Mail',
47
+ * message: {
48
+ * from: {
49
+ * name: 'Cow',
50
+ * wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
51
+ * },
52
+ * to: {
53
+ * name: 'Bob',
54
+ * wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
55
+ * },
56
+ * contents: 'Hello, Bob!',
57
+ * },
58
+ * })
59
+ *
60
+ * @example
61
+ * // Account Hoisting
62
+ * import { createWalletClient, http } from 'viem'
63
+ * import { privateKeyToAccount } from 'viem/accounts'
64
+ * import { mainnet } from 'viem/chains'
65
+ * import { signTypedData } from 'viem/wallet'
66
+ *
67
+ * const client = createWalletClient({
68
+ * account: privateKeyToAccount('0x…'),
69
+ * chain: mainnet,
70
+ * transport: http(),
71
+ * })
72
+ * const signature = await signTypedData(client, {
73
+ * domain: {
74
+ * name: 'Ether Mail',
75
+ * version: '1',
76
+ * chainId: 1,
77
+ * verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
78
+ * },
79
+ * types: {
80
+ * Person: [
81
+ * { name: 'name', type: 'string' },
82
+ * { name: 'wallet', type: 'address' },
83
+ * ],
84
+ * Mail: [
85
+ * { name: 'from', type: 'Person' },
86
+ * { name: 'to', type: 'Person' },
87
+ * { name: 'contents', type: 'string' },
88
+ * ],
89
+ * },
90
+ * primaryType: 'Mail',
91
+ * message: {
92
+ * from: {
93
+ * name: 'Cow',
94
+ * wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
95
+ * },
96
+ * to: {
97
+ * name: 'Bob',
98
+ * wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
99
+ * },
100
+ * contents: 'Hello, Bob!',
101
+ * },
102
+ * })
103
+ */
6
104
  export async function signTypedData(client, { account: account_ = client.account, domain, message, primaryType, types: types_, }) {
7
105
  if (!account_)
8
106
  throw new AccountNotFoundError({
@@ -22,6 +120,8 @@ export async function signTypedData(client, { account: account_ = client.account
22
120
  ].filter(Boolean),
23
121
  ...types_,
24
122
  };
123
+ // Need to do a runtime validation check on addresses, byte ranges, integer ranges, etc
124
+ // as we can't statically check this with TypeScript.
25
125
  validateTypedData({
26
126
  domain,
27
127
  message,
@@ -1 +1 @@
1
- {"version":3,"file":"signTypedData.js","sourceRoot":"","sources":["../../../../src/actions/wallet/signTypedData.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAK9D,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAA;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AA6G5D,MAAM,CAAC,KAAK,UAAU,aAAa,CAMjC,MAAiD,EACjD,EACE,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAClC,MAAM,EACN,OAAO,EACP,WAAW,EACX,KAAK,EAAE,MAAM,GAC+C;IAE9D,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,oCAAoC;SAC/C,CAAC,CAAA;IACJ,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IAEtC,MAAM,KAAK,GAAG;QACZ,YAAY,EAAE;YACZ,MAAM,EAAE,IAAI,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;YAChD,MAAM,EAAE,OAAO,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtD,MAAM,EAAE,OAAO,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACvD,MAAM,EAAE,iBAAiB,IAAI;gBAC3B,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,SAAS;aAChB;YACD,MAAM,EAAE,IAAI,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;SAClD,CAAC,MAAM,CAAC,OAAO,CAAC;QACjB,GAAI,MAAqB;KAC1B,CAAA;IAID,iBAAiB,CAAC;QAChB,MAAM;QACN,OAAO;QACP,WAAW;QACX,KAAK;KACiB,CAAC,CAAA;IAEzB,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;QAC1B,OAAO,OAAO,CAAC,aAAa,CAAC;YAC3B,MAAM;YACN,WAAW;YACX,KAAK;YACL,OAAO;SACe,CAAC,CAAA;IAE3B,MAAM,SAAS,GAAG,SAAS,CACzB,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,EACrD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAC3D,CAAA;IACD,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,sBAAsB;QAC9B,MAAM,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC;KACrC,CAAC,CAAA;AACJ,CAAC"}
1
+ {"version":3,"file":"signTypedData.js","sourceRoot":"","sources":["../../../../src/actions/wallet/signTypedData.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAK9D,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAA;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAW5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAMjC,MAAiD,EACjD,EACE,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAClC,MAAM,EACN,OAAO,EACP,WAAW,EACX,KAAK,EAAE,MAAM,GAC+C;IAE9D,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,oCAAoC;SAC/C,CAAC,CAAA;IACJ,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IAEtC,MAAM,KAAK,GAAG;QACZ,YAAY,EAAE;YACZ,MAAM,EAAE,IAAI,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;YAChD,MAAM,EAAE,OAAO,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtD,MAAM,EAAE,OAAO,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACvD,MAAM,EAAE,iBAAiB,IAAI;gBAC3B,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,SAAS;aAChB;YACD,MAAM,EAAE,IAAI,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;SAClD,CAAC,MAAM,CAAC,OAAO,CAAC;QACjB,GAAI,MAAqB;KAC1B,CAAA;IAED,uFAAuF;IACvF,qDAAqD;IACrD,iBAAiB,CAAC;QAChB,MAAM;QACN,OAAO;QACP,WAAW;QACX,KAAK;KACiB,CAAC,CAAA;IAEzB,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;QAC1B,OAAO,OAAO,CAAC,aAAa,CAAC;YAC3B,MAAM;YACN,WAAW;YACX,KAAK;YACL,OAAO;SACe,CAAC,CAAA;IAE3B,MAAM,SAAS,GAAG,SAAS,CACzB,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,EACrD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAC3D,CAAA;IACD,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,sBAAsB;QAC9B,MAAM,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC;KACrC,CAAC,CAAA;AACJ,CAAC"}
@@ -1,4 +1,24 @@
1
1
  import { numberToHex } from '../../utils/encoding/toHex.js';
2
+ /**
3
+ * Switch the target chain in a wallet.
4
+ *
5
+ * - Docs: https://viem.sh/docs/actions/wallet/switchChain.html
6
+ * - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326)
7
+ *
8
+ * @param client - Client to use
9
+ * @param parameters - {@link SwitchChainParameters}
10
+ *
11
+ * @example
12
+ * import { createWalletClient, custom } from 'viem'
13
+ * import { mainnet, optimism } from 'viem/chains'
14
+ * import { switchChain } from 'viem/wallet'
15
+ *
16
+ * const client = createWalletClient({
17
+ * chain: mainnet,
18
+ * transport: custom(window.ethereum),
19
+ * })
20
+ * await switchChain(client, { id: optimism.id })
21
+ */
2
22
  export async function switchChain(client, { id }) {
3
23
  await client.request({
4
24
  method: 'wallet_switchEthereumChain',
@@ -1 +1 @@
1
- {"version":3,"file":"switchChain.js","sourceRoot":"","sources":["../../../../src/actions/wallet/switchChain.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AA2B3D,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAAiD,EACjD,EAAE,EAAE,EAAyB;IAE7B,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,4BAA4B;QACpC,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;aACzB;SACF;KACF,CAAC,CAAA;AACJ,CAAC"}
1
+ {"version":3,"file":"switchChain.js","sourceRoot":"","sources":["../../../../src/actions/wallet/switchChain.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAO3D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAAiD,EACjD,EAAE,EAAE,EAAyB;IAE7B,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,4BAA4B;QACpC,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;aACzB;SACF;KACF,CAAC,CAAA;AACJ,CAAC"}
@@ -1,3 +1,31 @@
1
+ /**
2
+ * Adds an EVM chain to the wallet.
3
+ *
4
+ * - Docs: https://viem.sh/docs/actions/wallet/watchAsset.html
5
+ * - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-747)
6
+ *
7
+ * @param client - Client to use
8
+ * @param parameters - {@link WatchAssetParameters}
9
+ * @returns Boolean indicating if the token was successfully added. {@link WatchAssetReturnType}
10
+ *
11
+ * @example
12
+ * import { createWalletClient, custom } from 'viem'
13
+ * import { mainnet } from 'viem/chains'
14
+ * import { watchAsset } from 'viem/wallet'
15
+ *
16
+ * const client = createWalletClient({
17
+ * chain: mainnet,
18
+ * transport: custom(window.ethereum),
19
+ * })
20
+ * const success = await watchAsset(client, {
21
+ * type: 'ERC20',
22
+ * options: {
23
+ * address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
24
+ * decimals: 18,
25
+ * symbol: 'WETH',
26
+ * },
27
+ * })
28
+ */
1
29
  export async function watchAsset(client, params) {
2
30
  const added = await client.request({
3
31
  method: 'wallet_watchAsset',
@@ -1 +1 @@
1
- {"version":3,"file":"watchAsset.js","sourceRoot":"","sources":["../../../../src/actions/wallet/watchAsset.ts"],"names":[],"mappings":"AAqCA,MAAM,CAAC,KAAK,UAAU,UAAU,CAI9B,MAAiD,EACjD,MAA4B;IAE5B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACjC,MAAM,EAAE,mBAAmB;QAC3B,MAAM;KACP,CAAC,CAAA;IACF,OAAO,KAAK,CAAA;AACd,CAAC"}
1
+ {"version":3,"file":"watchAsset.js","sourceRoot":"","sources":["../../../../src/actions/wallet/watchAsset.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAI9B,MAAiD,EACjD,MAA4B;IAE5B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACjC,MAAM,EAAE,mBAAmB;QAC3B,MAAM;KACP,CAAC,CAAA;IACF,OAAO,KAAK,CAAA;AACd,CAAC"}
@@ -1,5 +1,55 @@
1
1
  import { encodeFunctionData, } from '../../utils/abi/encodeFunctionData.js';
2
2
  import { sendTransaction, } from './sendTransaction.js';
3
+ /**
4
+ * Executes a write function on a contract.
5
+ *
6
+ * - Docs: https://viem.sh/docs/contract/writeContract.html
7
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/writing-to-contracts
8
+ *
9
+ * 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.html) is needed to be broadcast in order to change the state.
10
+ *
11
+ * Internally, uses a [Wallet Client](https://viem.sh/docs/clients/wallet.html) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
12
+ *
13
+ * __Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract.html#usage) before you execute it.__
14
+ *
15
+ * @param client - Client to use
16
+ * @param parameters - {@link WriteContractParameters}
17
+ * @returns A [Transaction Hash](https://viem.sh/docs/glossary/terms.html#hash). {@link WriteContractReturnType}
18
+ *
19
+ * @example
20
+ * import { createWalletClient, custom, parseAbi } from 'viem'
21
+ * import { mainnet } from 'viem/chains'
22
+ * import { writeContract } from 'viem/contract'
23
+ *
24
+ * const client = createWalletClient({
25
+ * chain: mainnet,
26
+ * transport: custom(window.ethereum),
27
+ * })
28
+ * const hash = await writeContract(client, {
29
+ * address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
30
+ * abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
31
+ * functionName: 'mint',
32
+ * args: [69420],
33
+ * })
34
+ *
35
+ * @example
36
+ * // With Validation
37
+ * import { createWalletClient, http, parseAbi } from 'viem'
38
+ * import { mainnet } from 'viem/chains'
39
+ * import { simulateContract, writeContract } from 'viem/contract'
40
+ *
41
+ * const client = createWalletClient({
42
+ * chain: mainnet,
43
+ * transport: http(),
44
+ * })
45
+ * const { request } = await simulateContract(client, {
46
+ * address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
47
+ * abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
48
+ * functionName: 'mint',
49
+ * args: [69420],
50
+ * }
51
+ * const hash = await writeContract(client, request)
52
+ */
3
53
  export async function writeContract(client, { abi, address, args, dataSuffix, functionName, ...request }) {
4
54
  const data = encodeFunctionData({
5
55
  abi,
@@ -1 +1 @@
1
- {"version":3,"file":"writeContract.js","sourceRoot":"","sources":["../../../../src/actions/wallet/writeContract.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,kBAAkB,GACnB,MAAM,uCAAuC,CAAA;AAE9C,OAAO,EAGL,eAAe,GAChB,MAAM,sBAAsB,CAAA;AAuE7B,MAAM,CAAC,KAAK,UAAU,aAAa,CAOjC,MAAiD,EACjD,EACE,GAAG,EACH,OAAO,EACP,IAAI,EACJ,UAAU,EACV,YAAY,EACZ,GAAG,OAAO,EAOX;IAED,MAAM,IAAI,GAAG,kBAAkB,CAAC;QAC9B,GAAG;QACH,IAAI;QACJ,YAAY;KACmD,CAAC,CAAA;IAClE,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE;QACzC,IAAI,EAAE,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;QAChE,EAAE,EAAE,OAAO;QACX,GAAG,OAAO;KAC+D,CAAC,CAAA;IAC5E,OAAO,IAAI,CAAA;AACb,CAAC"}
1
+ {"version":3,"file":"writeContract.js","sourceRoot":"","sources":["../../../../src/actions/wallet/writeContract.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,kBAAkB,GACnB,MAAM,uCAAuC,CAAA;AAE9C,OAAO,EAGL,eAAe,GAChB,MAAM,sBAAsB,CAAA;AAqB7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAOjC,MAAiD,EACjD,EACE,GAAG,EACH,OAAO,EACP,IAAI,EACJ,UAAU,EACV,YAAY,EACZ,GAAG,OAAO,EAOX;IAED,MAAM,IAAI,GAAG,kBAAkB,CAAC;QAC9B,GAAG;QACH,IAAI;QACJ,YAAY;KACmD,CAAC,CAAA;IAClE,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE;QACzC,IAAI,EAAE,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;QAChE,EAAE,EAAE,OAAO;QACX,GAAG,OAAO;KAC+D,CAAC,CAAA;IAC5E,OAAO,IAAI,CAAA;AACb,CAAC"}