viem 0.0.0-portable-types-20230523145621 → 0.0.0-refactor-generics-20230831161903

package/dist/esm/actions/test/stopImpersonatingAccount.js

@@ -1,3 +1,25 @@
+/**
+ * Stop impersonating an account after having previously used [`impersonateAccount`](https://viem.sh/docs/actions/test/impersonateAccount.html).
+ *
+ * - Docs: https://viem.sh/docs/actions/test/stopImpersonatingAccount.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link StopImpersonatingAccountParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { stopImpersonatingAccount } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await stopImpersonatingAccount(client, {
+ *   address: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+ * })
+ */
 export async function stopImpersonatingAccount(client, { address }) {
     await client.request({
         method: `${client.mode}_stopImpersonatingAccount`,

package/dist/esm/actions/test/stopImpersonatingAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"stopImpersonatingAccount.js","sourceRoot":"","sources":["../../../../src/actions/test/stopImpersonatingAccount.ts"],"names":[],"mappings":"AAoCA,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAG5C,MAAqD,EACrD,EAAE,OAAO,EAAsC;IAE/C,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,2BAA2B;QACjD,MAAM,EAAE,CAAC,OAAO,CAAC;KAClB,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"stopImpersonatingAccount.js","sourceRoot":"","sources":["../../../../src/actions/test/stopImpersonatingAccount.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAI5C,MAAsE,EACtE,EAAE,OAAO,EAAsC;IAE/C,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,2BAA2B;QACjD,MAAM,EAAE,CAAC,OAAO,CAAC;KAClB,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/wallet/addChain.js

@@ -1,4 +1,23 @@
 import { numberToHex } from '../../utils/encoding/toHex.js';
+/**
+ * Adds an EVM chain to the wallet.
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/addChain.html
+ * - JSON-RPC Methods: [`eth_addEthereumChain`](https://eips.ethereum.org/EIPS/eip-3085)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link AddChainParameters}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { optimism } from 'viem/chains'
+ * import { addChain } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   transport: custom(window.ethereum),
+ * })
+ * await addChain(client, { chain: optimism })
+ */
 export async function addChain(client, { chain }) {
     const { id, name, nativeCurrency, rpcUrls, blockExplorers } = chain;
     await client.request({

package/dist/esm/actions/wallet/addChain.js.map

@@ -1 +1 @@
-{"version":3,"file":"addChain.js","sourceRoot":"","sources":["../../../../src/actions/wallet/addChain.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AA0B3D,MAAM,CAAC,KAAK,UAAU,QAAQ,CAI5B,MAAiD,EACjD,EAAE,KAAK,EAAsB;IAE7B,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,KAAK,CAAA;IACnE,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;gBACxB,SAAS,EAAE,IAAI;gBACf,cAAc;gBACd,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;gBAC7B,iBAAiB,EAAE,cAAc;oBAC/B,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC;oBACrD,CAAC,CAAC,SAAS;aACd;SACF;KACF,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"addChain.js","sourceRoot":"","sources":["../../../../src/actions/wallet/addChain.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAO3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAG5B,MAA2C,EAAE,EAAE,KAAK,EAAsB;IAC1E,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,KAAK,CAAA;IACnE,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;gBACxB,SAAS,EAAE,IAAI;gBACf,cAAc;gBACd,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;gBAC7B,iBAAiB,EAAE,cAAc;oBAC/B,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC;oBACrD,CAAC,CAAC,SAAS;aACd;SACF;KACF,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/wallet/deployContract.js

@@ -1,5 +1,32 @@
 import { encodeDeployData } from '../../utils/abi/encodeDeployData.js';
 import { sendTransaction, } from './sendTransaction.js';
+/**
+ * Deploys a contract to the network, given bytecode and constructor arguments.
+ *
+ * - Docs: https://viem.sh/docs/contract/deployContract.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/deploying-contracts
+ *
+ * @param client - Client to use
+ * @param parameters - {@link DeployContractParameters}
+ * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link DeployContractReturnType}
+ *
+ * @example
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { mainnet } from 'viem/chains'
+ * import { deployContract } from 'viem/contract'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const hash = await deployContract(client, {
+ *   abi: [],
+ *   account: '0x…,
+ *   bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
+ * })
+ */
 export function deployContract(walletClient, { abi, args, bytecode, ...request }) {
     const calldata = encodeDeployData({
         abi,

package/dist/esm/actions/wallet/deployContract.js.map

@@ -1 +1 @@
-{"version":3,"file":"deployContract.js","sourceRoot":"","sources":["../../../../src/actions/wallet/deployContract.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAA;AAEtE,OAAO,EAGL,eAAe,GAChB,MAAM,sBAAsB,CAAA;AA6C7B,MAAM,UAAU,cAAc,CAM5B,YAAuD,EACvD,EACE,GAAG,EACH,IAAI,EACJ,QAAQ,EACR,GAAG,OAAO,EACuD;IAEnE,MAAM,QAAQ,GAAG,gBAAgB,CAAC;QAChC,GAAG;QACH,IAAI;QACJ,QAAQ;KAMT,CAAC,CAAA;IACF,OAAO,eAAe,CAAC,YAAY,EAAE;QACnC,GAAG,OAAO;QACV,IAAI,EAAE,QAAQ;KAC2D,CAAC,CAAA;AAC9E,CAAC"}
+{"version":3,"file":"deployContract.js","sourceRoot":"","sources":["../../../../src/actions/wallet/deployContract.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAA;AAEtE,OAAO,EAGL,eAAe,GAChB,MAAM,sBAAsB,CAAA;AAkB7B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,cAAc,CAM5B,YAAiD,EACjD,EACE,GAAG,EACH,IAAI,EACJ,QAAQ,EACR,GAAG,OAAO,EACuD;IAEnE,MAAM,QAAQ,GAAG,gBAAgB,CAAC;QAChC,GAAG;QACH,IAAI;QACJ,QAAQ;KAMT,CAAC,CAAA;IACF,OAAO,eAAe,CAAC,YAAY,EAAE;QACnC,GAAG,OAAO;QACV,IAAI,EAAE,QAAQ;KAC2D,CAAC,CAAA;AAC9E,CAAC"}

package/dist/esm/actions/wallet/getAddresses.js

@@ -1,4 +1,24 @@
 import { checksumAddress } from '../../utils/address/getAddress.js';
+/**
+ * Returns a list of account addresses owned by the wallet or client.
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/getAddresses.html
+ * - JSON-RPC Methods: [`eth_accounts`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_accounts)
+ *
+ * @param client - Client to use
+ * @returns List of account addresses owned by the wallet or client. {@link GetAddressesReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getAddresses } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const accounts = await getAddresses(client)
+ */
 export async function getAddresses(client) {
     const addresses = await client.request({ method: 'eth_accounts' });
     return addresses.map((address) => checksumAddress(address));

package/dist/esm/actions/wallet/getAddresses.js.map

@@ -1 +1 @@
-{"version":3,"file":"getAddresses.js","sourceRoot":"","sources":["../../../../src/actions/wallet/getAddresses.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAwBnE,MAAM,CAAC,KAAK,UAAU,YAAY,CAIhC,MAAiD;IAEjD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAA;IAClE,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;AAC7D,CAAC"}
+{"version":3,"file":"getAddresses.js","sourceRoot":"","sources":["../../../../src/actions/wallet/getAddresses.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAInE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAIhC,MAA2C;IAE3C,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAA;IAClE,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;AAC7D,CAAC"}

package/dist/esm/actions/wallet/getPermissions.js

@@ -1,3 +1,23 @@
+/**
+ * Gets the wallets current permissions.
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/getPermissions.html
+ * - JSON-RPC Methods: [`wallet_getPermissions`](https://eips.ethereum.org/EIPS/eip-2255)
+ *
+ * @param client - Client to use
+ * @returns The wallet permissions. {@link GetPermissionsReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getPermissions } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const permissions = await getPermissions(client)
+ */
 export async function getPermissions(client) {
     const permissions = await client.request({ method: 'wallet_getPermissions' });
     return permissions;

package/dist/esm/actions/wallet/getPermissions.js.map

@@ -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"}
+{"version":3,"file":"getPermissions.js","sourceRoot":"","sources":["../../../../src/actions/wallet/getPermissions.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAGlC,MAA2C;IAC3C,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAA;IAC7E,OAAO,WAAW,CAAA;AACpB,CAAC"}

package/dist/esm/actions/wallet/prepareTransactionRequest.js

@@ -0,0 +1,109 @@
+import { parseAccount } from '../../accounts/utils/parseAccount.js';
+import { internal_estimateFeesPerGas } from '../../actions/public/estimateFeesPerGas.js';
+import { estimateGas, } from '../../actions/public/estimateGas.js';
+import { getBlock } from '../../actions/public/getBlock.js';
+import { getTransactionCount } from '../../actions/public/getTransactionCount.js';
+import { AccountNotFoundError } from '../../errors/account.js';
+import { Eip1559FeesNotSupportedError, MaxFeePerGasTooLowError, } from '../../errors/fee.js';
+import { assertRequest } from '../../utils/transaction/assertRequest.js';
+import { getTransactionType } from '../../utils/transaction/getTransactionType.js';
+/**
+ * Prepares a transaction request for signing.
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest.html
+ *
+ * @param args - {@link PrepareTransactionRequestParameters}
+ * @returns The transaction request. {@link PrepareTransactionRequestReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { prepareTransactionRequest } from 'viem/actions'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const request = await prepareTransactionRequest(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: 1n,
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { mainnet } from 'viem/chains'
+ * import { prepareTransactionRequest } from 'viem/actions'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const request = await prepareTransactionRequest(client, {
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   value: 1n,
+ * })
+ */
+export async function prepareTransactionRequest(client, args) {
+    const { account: account_ = client.account, chain, gas, nonce, type } = args;
+    if (!account_)
+        throw new AccountNotFoundError();
+    const account = parseAccount(account_);
+    const block = await getBlock(client, { blockTag: 'latest' });
+    const request = { ...args, from: account.address };
+    if (typeof nonce === 'undefined')
+        request.nonce = await getTransactionCount(client, {
+            address: account.address,
+            blockTag: 'pending',
+        });
+    if (typeof type === 'undefined') {
+        try {
+            request.type = getTransactionType(request);
+        }
+        catch {
+            // infer type from block
+            request.type =
+                typeof block.baseFeePerGas === 'bigint' ? 'eip1559' : 'legacy';
+        }
+    }
+    if (request.type === 'eip1559') {
+        // EIP-1559 fees
+        const { maxFeePerGas, maxPriorityFeePerGas } = await internal_estimateFeesPerGas(client, {
+            block,
+            chain,
+            request: request,
+        });
+        if (typeof args.maxPriorityFeePerGas === 'undefined' &&
+            args.maxFeePerGas &&
+            args.maxFeePerGas < maxPriorityFeePerGas)
+            throw new MaxFeePerGasTooLowError({
+                maxPriorityFeePerGas,
+            });
+        request.maxPriorityFeePerGas = maxPriorityFeePerGas;
+        request.maxFeePerGas = maxFeePerGas;
+    }
+    else {
+        // Legacy fees
+        if (typeof args.maxFeePerGas !== 'undefined' ||
+            typeof args.maxPriorityFeePerGas !== 'undefined')
+            throw new Eip1559FeesNotSupportedError();
+        const { gasPrice: gasPrice_ } = await internal_estimateFeesPerGas(client, {
+            block,
+            chain,
+            request: request,
+            type: 'legacy',
+        });
+        request.gasPrice = gasPrice_;
+    }
+    if (typeof gas === 'undefined')
+        request.gas = await estimateGas(client, {
+            ...request,
+            account: { address: account.address, type: 'json-rpc' },
+        });
+    assertRequest(request);
+    return request;
+}
+//# sourceMappingURL=prepareTransactionRequest.js.map

package/dist/esm/actions/wallet/prepareTransactionRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepareTransactionRequest.js","sourceRoot":"","sources":["../../../../src/actions/wallet/prepareTransactionRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AACnE,OAAO,EAAE,2BAA2B,EAAE,MAAM,4CAA4C,CAAA;AACxF,OAAO,EAEL,WAAW,GACZ,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAA;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAA;AAGjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EACL,4BAA4B,EAC5B,uBAAuB,GACxB,MAAM,qBAAqB,CAAA;AAQ5B,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAA;AAyBlF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAK7C,MAA2C,EAC3C,IAA2E;IAI3E,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;IAC5E,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,oBAAoB,EAAE,CAAA;IAC/C,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IAEtC,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAA;IAE5D,MAAM,OAAO,GAAG,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,CAAA;IAElD,IAAI,OAAO,KAAK,KAAK,WAAW;QAC9B,OAAO,CAAC,KAAK,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE;YAChD,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,QAAQ,EAAE,SAAS;SACpB,CAAC,CAAA;IAEJ,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QAC/B,IAAI;YACF,OAAO,CAAC,IAAI,GAAG,kBAAkB,CAC/B,OAAkC,CAC5B,CAAA;SACT;QAAC,MAAM;YACN,wBAAwB;YACxB,OAAO,CAAC,IAAI;gBACV,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAA;SACjE;KACF;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;QAC9B,gBAAgB;QAChB,MAAM,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAC1C,MAAM,2BAA2B,CAAC,MAAM,EAAE;YACxC,KAAK;YACL,KAAK;YACL,OAAO,EAAE,OAA8C;SACxD,CAAC,CAAA;QAEJ,IACE,OAAO,IAAI,CAAC,oBAAoB,KAAK,WAAW;YAChD,IAAI,CAAC,YAAY;YACjB,IAAI,CAAC,YAAY,GAAG,oBAAoB;YAExC,MAAM,IAAI,uBAAuB,CAAC;gBAChC,oBAAoB;aACrB,CAAC,CAAA;QAEJ,OAAO,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;QACnD,OAAO,CAAC,YAAY,GAAG,YAAY,CAAA;KACpC;SAAM;QACL,cAAc;QACd,IACE,OAAO,IAAI,CAAC,YAAY,KAAK,WAAW;YACxC,OAAO,IAAI,CAAC,oBAAoB,KAAK,WAAW;YAEhD,MAAM,IAAI,4BAA4B,EAAE,CAAA;QAE1C,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,MAAM,2BAA2B,CAAC,MAAM,EAAE;YACxE,KAAK;YACL,KAAK;YACL,OAAO,EAAE,OAA8C;YACvD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;QACF,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAA;KAC7B;IAED,IAAI,OAAO,GAAG,KAAK,WAAW;QAC5B,OAAO,CAAC,GAAG,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE;YACtC,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE;SAC/B,CAAC,CAAA;IAE7B,aAAa,CAAC,OAAkC,CAAC,CAAA;IAEjD,OAAO,OAIN,CAAA;AACH,CAAC"}

package/dist/esm/actions/wallet/requestAddresses.js

@@ -1,4 +1,28 @@
 import { getAddress } from '../../utils/address/getAddress.js';
+/**
+ * Requests a list of accounts managed by a wallet.
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/requestAddresses.html
+ * - JSON-RPC Methods: [`eth_requestAccounts`](https://eips.ethereum.org/EIPS/eip-1102)
+ *
+ * Sends a request to the wallet, asking for permission to access the user's accounts. After the user accepts the request, it will return a list of accounts (addresses).
+ *
+ * This API can be useful for dapps that need to access the user's accounts in order to execute transactions or interact with smart contracts.
+ *
+ * @param client - Client to use
+ * @returns List of accounts managed by a wallet {@link RequestAddressesReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { requestAddresses } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const accounts = await requestAddresses(client)
+ */
 export async function requestAddresses(client) {
     const addresses = await client.request({ method: 'eth_requestAccounts' });
     return addresses.map((address) => getAddress(address));

package/dist/esm/actions/wallet/requestAddresses.js.map

@@ -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"}
+{"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,MAA2C;IAE3C,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"}

package/dist/esm/actions/wallet/requestPermissions.js

@@ -1,3 +1,26 @@
+/**
+ * Requests permissions for a wallet.
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/requestPermissions.html
+ * - JSON-RPC Methods: [`wallet_requestPermissions`](https://eips.ethereum.org/EIPS/eip-2255)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link RequestPermissionsParameters}
+ * @returns The wallet permissions. {@link RequestPermissionsReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { requestPermissions } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const permissions = await requestPermissions(client, {
+ *   eth_accounts: {}
+ * })
+ */
 export async function requestPermissions(client, permissions) {
     return client.request({
         method: 'wallet_requestPermissions',

package/dist/esm/actions/wallet/requestPermissions.js.map

@@ -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"}
+{"version":3,"file":"requestPermissions.js","sourceRoot":"","sources":["../../../../src/actions/wallet/requestPermissions.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAItC,MAA2C,EAC3C,WAAyC;IAEzC,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,2BAA2B;QACnC,MAAM,EAAE,CAAC,WAAW,CAAC;KACtB,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/wallet/sendRawTransaction.js

@@ -0,0 +1,31 @@
+/**
+ * Sends a **signed** transaction to the network
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction.html
+ * - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link SendRawTransactionParameters}
+ * @returns The transaction hash. {@link SendRawTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { sendRawTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * const hash = await sendRawTransaction(client, {
+ *   serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33'
+ * })
+ */
+export async function sendRawTransaction(client, { serializedTransaction }) {
+    return client.request({
+        method: 'eth_sendRawTransaction',
+        params: [serializedTransaction],
+    });
+}
+//# sourceMappingURL=sendRawTransaction.js.map

package/dist/esm/actions/wallet/sendRawTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendRawTransaction.js","sourceRoot":"","sources":["../../../../src/actions/wallet/sendRawTransaction.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAiC,EACjC,EAAE,qBAAqB,EAAgC;IAEvD,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,wBAAwB;QAChC,MAAM,EAAE,CAAC,qBAAqB,CAAC;KAChC,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/wallet/sendTransaction.js

@@ -3,11 +3,56 @@ import { AccountNotFoundError } from '../../errors/account.js';
 import { assertCurrentChain } from '../../utils/chain.js';
 import { getTransactionError } from '../../utils/errors/getTransactionError.js';
 import { extract } from '../../utils/formatters/extract.js';
-import { format } from '../../utils/formatters/format.js';
 import { formatTransactionRequest, } from '../../utils/formatters/transactionRequest.js';
-import { assertRequest } from '../../utils/transaction/assertRequest.js';
-import { prepareRequest } from '../../utils/transaction/prepareRequest.js';
+import { assertRequest, } from '../../utils/transaction/assertRequest.js';
 import { getChainId } from '../public/getChainId.js';
+import { prepareTransactionRequest } from './prepareTransactionRequest.js';
+import { sendRawTransaction } from './sendRawTransaction.js';
+/**
+ * Creates, signs, and sends a new transaction to the network.
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/sendTransaction.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/sending-transactions
+ * - JSON-RPC Methods:
+ *   - JSON-RPC Accounts: [`eth_sendTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendtransaction)
+ *   - Local Accounts: [`eth_sendRawTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendrawtransaction)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link SendTransactionParameters}
+ * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link SendTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { sendTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await sendTransaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { mainnet } from 'viem/chains'
+ * import { sendTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const hash = await sendTransaction(client, {
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ */
 export async function sendTransaction(client, args) {
     const { account: account_ = client.account, chain = client.chain, accessList, data, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, to, value, ...rest } = args;
     if (!account_)
@@ -26,7 +71,8 @@ export async function sendTransaction(client, args) {
             });
         }
         if (account.type === 'local') {
-            const request = await prepareRequest(client, {
+            // Prepare the request for signing (assign appropriate fees, etc.)
+            const request = await prepareTransactionRequest(client, {
                 account,
                 accessList,
                 chain,
@@ -42,17 +88,19 @@ export async function sendTransaction(client, args) {
             });
             if (!chainId)
                 chainId = await getChainId(client);
-            const signedRequest = (await account.signTransaction({
-                chainId,
+            const serializer = chain?.serializers?.transaction;
+            const serializedTransaction = (await account.signTransaction({
                 ...request,
-            }));
-            return await client.request({
-                method: 'eth_sendRawTransaction',
-                params: [signedRequest],
+                chainId,
+            }, { serializer }));
+            return await sendRawTransaction(client, {
+                serializedTransaction,
             });
         }
-        const formatter = chain?.formatters?.transactionRequest;
+        const format = chain?.formatters?.transactionRequest?.format || formatTransactionRequest;
         const request = format({
+            // Pick out extra data that might exist on the chain's transaction request type.
+            ...extract(rest, { format }),
             accessList,
             data,
             from: account.address,
@@ -63,9 +111,6 @@ export async function sendTransaction(client, args) {
             nonce,
             to,
             value,
-            ...extract(rest, { formatter }),
-        }, {
-            formatter: formatter || formatTransactionRequest,
         });
         return await client.request({
             method: 'eth_sendTransaction',

package/dist/esm/actions/wallet/sendTransaction.js.map

@@ -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"}
+{"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,EAEL,wBAAwB,GACzB,MAAM,8CAA8C,CAAA;AACrD,OAAO,EAEL,aAAa,GACd,MAAM,0CAA0C,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAiB5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAKnC,MAA2C,EAC3C,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,IAA+B,CAAC,CAAA;QAE9C,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,yBAAyB,CAAC,MAAM,EAAE;gBACtD,OAAO;gBACP,UAAU;gBACV,KAAK;gBACL,IAAI;gBACJ,GAAG;gBACH,QAAQ;gBACR,YAAY;gBACZ,oBAAoB;gBACpB,KAAK;gBACL,EAAE;gBACF,KAAK;gBACL,GAAG,IAAI;aACD,CAAC,CAAA;YAET,IAAI,CAAC,OAAO;gBAAE,OAAO,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAA;YAEhD,MAAM,UAAU,GAAG,KAAK,EAAE,WAAW,EAAE,WAAW,CAAA;YAClD,MAAM,qBAAqB,GAAG,CAAC,MAAM,OAAO,CAAC,eAAe,CAC1D;gBACE,GAAG,OAAO;gBACV,OAAO;aACmB,EAC5B,EAAE,UAAU,EAAE,CACf,CAAS,CAAA;YACV,OAAO,MAAM,kBAAkB,CAAC,MAAM,EAAE;gBACtC,qBAAqB;aACtB,CAAC,CAAA;SACH;QAED,MAAM,MAAM,GACV,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,IAAI,wBAAwB,CAAA;QAC3E,MAAM,OAAO,GAAG,MAAM,CAAC;YACrB,gFAAgF;YAChF,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC;YAC5B,UAAU;YACV,IAAI;YACJ,IAAI,EAAE,OAAO,CAAC,OAAO;YACrB,GAAG;YACH,QAAQ;YACR,YAAY;YACZ,oBAAoB;YACpB,KAAK;YACL,EAAE;YACF,KAAK;SACgB,CAAC,CAAA;QACxB,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"}

package/dist/esm/actions/wallet/signMessage.js

@@ -1,6 +1,52 @@
 import { parseAccount } from '../../accounts/utils/parseAccount.js';
 import { AccountNotFoundError } from '../../errors/account.js';
-import { toHex } from '../../utils/encoding/toHex.js';
+import { stringToHex, toHex } from '../../utils/encoding/toHex.js';
+/**
+ * Calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
+ *
+ * - Docs: https://viem.sh/docs/actions/wallet/signMessage.html
+ * - JSON-RPC Methods:
+ *   - JSON-RPC Accounts: [`personal_sign`](https://docs.metamask.io/guide/signing-data.html#personal-sign)
+ *   - Local Accounts: Signs locally. No JSON-RPC request.
+ *
+ * With the calculated signature, you can:
+ * - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage.html) to verify the signature,
+ * - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress.html) to recover the signing address from a signature.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link SignMessageParameters}
+ * @returns The signed message. {@link SignMessageReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { signMessage } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const signature = await signMessage(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   message: 'hello world',
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, custom } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { mainnet } from 'viem/chains'
+ * import { signMessage } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const signature = await signMessage(client, {
+ *   message: 'hello world',
+ * })
+ */
 export async function signMessage(client, { account: account_ = client.account, message, }) {
     if (!account_)
         throw new AccountNotFoundError({
@@ -9,9 +55,16 @@ export async function signMessage(client, { account: account_ = client.account,
     const account = parseAccount(account_);
     if (account.type === 'local')
         return account.signMessage({ message });
+    const message_ = (() => {
+        if (typeof message === 'string')
+            return stringToHex(message);
+        if (message.raw instanceof Uint8Array)
+            return toHex(message.raw);
+        return message.raw;
+    })();
     return client.request({
         method: 'personal_sign',
-        params: [toHex(message), account.address],
+        params: [message_, account.address],
     });
 }
 //# sourceMappingURL=signMessage.js.map

package/dist/esm/actions/wallet/signMessage.js.map

@@ -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,KAAK,EAAE,MAAM,+BAA+B,CAAA;AAwDrD,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;IACrE,OAAO,MAAM,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;KAC1C,CAAC,CAAA;AACJ,CAAC"}
+{"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,MAA2C,EAC3C,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"}