viem 2.22.5 → 2.22.7

package/_esm/zksync/actions/requestExecute.js

@@ -0,0 +1,167 @@
+import { generatePrivateKey } from '../../accounts/generatePrivateKey.js';
+import { privateKeyToAddress } from '../../accounts/utils/privateKeyToAddress.js';
+import { readContract } from '../../actions/public/readContract.js';
+import { sendTransaction, } from '../../actions/wallet/sendTransaction.js';
+import { publicActions } from '../../clients/decorators/public.js';
+import { AccountNotFoundError } from '../../errors/account.js';
+import { ClientChainNotConfiguredError } from '../../errors/chain.js';
+import { encodeFunctionData, isAddressEqual, parseAccount, } from '../../utils/index.js';
+import { bridgehubAbi } from '../constants/abis.js';
+import { ethAddressInContracts } from '../constants/address.js';
+import { requiredL1ToL2GasPerPubdataLimit } from '../constants/number.js';
+import { BaseFeeHigherThanValueError, } from '../errors/bridge.js';
+import { estimateGasL1ToL2 } from './estimateGasL1ToL2.js';
+import { getBridgehubContractAddress } from './getBridgehubContractAddress.js';
+/**
+ * Requests execution of a L2 transaction from L1.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link RequestExecuteParameters}
+ * @returns hash - The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link RequestExecuteReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zksync, mainnet } from 'viem/chains'
+ * import { requestExecute, publicActionsL2 } from 'viem/zksync'
+ *
+ * const client = createPublicClient({
+ *     chain: mainnet,
+ *     transport: http(),
+ * })
+ *
+ * const clientL2 = createPublicClient({
+ *   chain: zksync,
+ *   transport: http(),
+ * }).extend(publicActionsL2())
+ *
+ * const hash = await requestExecute(client, {
+ *     client: clientL2,
+ *     account: privateKeyToAccount('0x…'),
+ *     contractAddress: '0x43020e6e11cef7dce8e37baa09d9a996ac722057'
+ *     calldata: '0x',
+ *     l2Value: 1_000_000_000_000_000_000n,
+ * })
+ *
+ * @example Account Hoisting
+ * import { createPublicClient, createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zksync, mainnet } from 'viem/chains'
+ * import { requestExecute, publicActionsL2 } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ *
+ * const clientL2 = createPublicClient({
+ *   chain: zksync,
+ *   transport: http(),
+ * }).extend(publicActionsL2())
+ *
+ * const hash = await requestExecute(client, {
+ *     client: clientL2,
+ *     contractAddress: '0x43020e6e11cef7dce8e37baa09d9a996ac722057'
+ *     calldata: '0x',
+ *     l2Value: 1_000_000_000_000_000_000n,
+ * })
+ */
+export async function requestExecute(client, parameters) {
+    let { account: account_ = client.account, chain: chain_ = client.chain, client: l2Client, contractAddress, calldata, l2Value = 0n, mintValue = 0n, operatorTip = 0n, factoryDeps = [], gasPerPubdataByte = requiredL1ToL2GasPerPubdataLimit, refundRecipient, l2GasLimit, value, gasPrice, maxFeePerGas, maxPriorityFeePerGas, ...rest } = parameters;
+    const account = account_ ? parseAccount(account_) : client.account;
+    if (!account)
+        throw new AccountNotFoundError({
+            docsPath: '/docs/actions/wallet/sendTransaction',
+        });
+    if (!l2Client.chain)
+        throw new ClientChainNotConfiguredError();
+    const bridgehub = await getBridgehubContractAddress(l2Client);
+    const baseToken = await readContract(client, {
+        address: bridgehub,
+        abi: bridgehubAbi,
+        functionName: 'baseToken',
+        args: [BigInt(l2Client.chain.id)],
+    });
+    const isETHBasedChain = isAddressEqual(baseToken, ethAddressInContracts);
+    refundRecipient ??= account.address;
+    l2GasLimit ??= await estimateGasL1ToL2(l2Client, {
+        chain: l2Client.chain,
+        // If the `from` address is not provided, we use a random address, because
+        // due to storage slot aggregation, the gas estimation will depend on the address
+        // and so estimation for the zero address may be smaller than for the sender.
+        account: l2Client.account ??
+            parseAccount(privateKeyToAddress(generatePrivateKey())),
+        data: calldata,
+        to: contractAddress,
+        value: l2Value,
+        gasPerPubdata: gasPerPubdataByte,
+        factoryDeps,
+    });
+    let gasPriceForEstimation = maxFeePerGas || gasPrice;
+    if (!gasPriceForEstimation) {
+        const estimatedFee = await getFeePrice(client);
+        gasPriceForEstimation = estimatedFee.maxFeePerGas;
+        maxFeePerGas = estimatedFee.maxFeePerGas;
+        maxPriorityFeePerGas ??= estimatedFee.maxPriorityFeePerGas;
+    }
+    const baseCost = await readContract(client, {
+        address: bridgehub,
+        abi: bridgehubAbi,
+        functionName: 'l2TransactionBaseCost',
+        args: [
+            BigInt(l2Client.chain.id),
+            gasPriceForEstimation,
+            l2GasLimit,
+            gasPerPubdataByte,
+        ],
+    });
+    const l2Costs = baseCost + operatorTip + l2Value;
+    let providedValue = isETHBasedChain ? value : mintValue;
+    if (!providedValue || providedValue === 0n) {
+        providedValue = l2Costs;
+    }
+    if (baseCost > providedValue)
+        throw new BaseFeeHigherThanValueError(baseCost, providedValue);
+    const data = encodeFunctionData({
+        abi: bridgehubAbi,
+        functionName: 'requestL2TransactionDirect',
+        args: [
+            {
+                chainId: BigInt(l2Client.chain.id),
+                mintValue: providedValue,
+                l2Contract: contractAddress,
+                l2Value: l2Value,
+                l2Calldata: calldata,
+                l2GasLimit: l2GasLimit,
+                l2GasPerPubdataByteLimit: gasPerPubdataByte,
+                factoryDeps: factoryDeps,
+                refundRecipient: refundRecipient,
+            },
+        ],
+    });
+    return await sendTransaction(client, {
+        chain: chain_,
+        account: account,
+        to: bridgehub,
+        value: isETHBasedChain ? providedValue : value,
+        data,
+        gasPrice,
+        maxFeePerGas,
+        maxPriorityFeePerGas,
+        ...rest,
+    });
+}
+async function getFeePrice(client) {
+    const client_ = client.extend(publicActions);
+    const block = await client_.getBlock();
+    const baseFee = typeof block.baseFeePerGas !== 'bigint'
+        ? await client_.getGasPrice()
+        : block.baseFeePerGas;
+    const maxPriorityFeePerGas = await client_.estimateMaxPriorityFeePerGas();
+    return {
+        maxFeePerGas: (baseFee * 3n) / 2n + maxPriorityFeePerGas,
+        maxPriorityFeePerGas: maxPriorityFeePerGas,
+    };
+}
+//# sourceMappingURL=requestExecute.js.map

package/_esm/zksync/actions/requestExecute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestExecute.js","sourceRoot":"","sources":["../../../zksync/actions/requestExecute.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAA;AAEzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAA;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AACnE,OAAO,EAIL,eAAe,GAChB,MAAM,yCAAyC,CAAA;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAA;AASrE,OAAO,EAEL,kBAAkB,EAClB,cAAc,EACd,YAAY,GACb,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAA;AACzE,OAAO,EACL,2BAA2B,GAE5B,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AA4C9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAOlC,MAAyC,EACzC,UAMC;IAED,IAAI,EACF,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAClC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,EAC5B,MAAM,EAAE,QAAQ,EAChB,eAAe,EACf,QAAQ,EACR,OAAO,GAAG,EAAE,EACZ,SAAS,GAAG,EAAE,EACd,WAAW,GAAG,EAAE,EAChB,WAAW,GAAG,EAAE,EAChB,iBAAiB,GAAG,gCAAgC,EACpD,eAAe,EACf,UAAU,EACV,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,GAAG,IAAI,EACR,GAAG,UAAU,CAAA;IAEd,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAA;IAClE,IAAI,CAAC,OAAO;QACV,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,sCAAsC;SACjD,CAAC,CAAA;IACJ,IAAI,CAAC,QAAQ,CAAC,KAAK;QAAE,MAAM,IAAI,6BAA6B,EAAE,CAAA;IAE9D,MAAM,SAAS,GAAG,MAAM,2BAA2B,CAAC,QAAQ,CAAC,CAAA;IAC7D,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QAC3C,OAAO,EAAE,SAAS;QAClB,GAAG,EAAE,YAAY;QACjB,YAAY,EAAE,WAAW;QACzB,IAAI,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KAClC,CAAC,CAAA;IACF,MAAM,eAAe,GAAG,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAA;IAExE,eAAe,KAAK,OAAO,CAAC,OAAO,CAAA;IACnC,UAAU,KAAK,MAAM,iBAAiB,CAAC,QAAQ,EAAE;QAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,0EAA0E;QAC1E,iFAAiF;QACjF,6EAA6E;QAC7E,OAAO,EACL,QAAQ,CAAC,OAAO;YAChB,YAAY,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,CAAC,CAAC;QACzD,IAAI,EAAE,QAAQ;QACd,EAAE,EAAE,eAAe;QACnB,KAAK,EAAE,OAAO;QACd,aAAa,EAAE,iBAAiB;QAChC,WAAW;KACZ,CAAC,CAAA;IAEF,IAAI,qBAAqB,GAAG,YAAY,IAAI,QAAQ,CAAA;IACpD,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAA;QAC9C,qBAAqB,GAAG,YAAY,CAAC,YAAY,CAAA;QACjD,YAAY,GAAG,YAAY,CAAC,YAAY,CAAA;QACxC,oBAAoB,KAAK,YAAY,CAAC,oBAAoB,CAAA;IAC5D,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QAC1C,OAAO,EAAE,SAAS;QAClB,GAAG,EAAE,YAAY;QACjB,YAAY,EAAE,uBAAuB;QACrC,IAAI,EAAE;YACJ,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,qBAAqB;YACrB,UAAU;YACV,iBAAiB;SAClB;KACF,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,OAAO,CAAA;IAChD,IAAI,aAAa,GAAG,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IACvD,IAAI,CAAC,aAAa,IAAI,aAAa,KAAK,EAAE,EAAE,CAAC;QAC3C,aAAa,GAAG,OAAO,CAAA;IACzB,CAAC;IAED,IAAI,QAAQ,GAAG,aAAa;QAC1B,MAAM,IAAI,2BAA2B,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAEhE,MAAM,IAAI,GAAG,kBAAkB,CAAC;QAC9B,GAAG,EAAE,YAAY;QACjB,YAAY,EAAE,4BAA4B;QAC1C,IAAI,EAAE;YACJ;gBACE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,SAAS,EAAE,aAAa;gBACxB,UAAU,EAAE,eAAe;gBAC3B,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,QAAQ;gBACpB,UAAU,EAAE,UAAU;gBACtB,wBAAwB,EAAE,iBAAiB;gBAC3C,WAAW,EAAE,WAAW;gBACxB,eAAe,EAAE,eAAe;aACjC;SACF;KACF,CAAC,CAAA;IAEF,OAAO,MAAM,eAAe,CAAC,MAAM,EAAE;QACnC,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,OAAO;QAChB,EAAE,EAAE,SAAS;QACb,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK;QAC9C,IAAI;QACJ,QAAQ;QACR,YAAY;QACZ,oBAAoB;QACpB,GAAG,IAAI;KACqB,CAAC,CAAA;AACjC,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,MAAgC;IAEhC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;IAC5C,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAA;IACtC,MAAM,OAAO,GACX,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;QACrC,CAAC,CAAC,MAAM,OAAO,CAAC,WAAW,EAAE;QAC7B,CAAC,CAAC,KAAK,CAAC,aAAa,CAAA;IACzB,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,4BAA4B,EAAE,CAAA;IAEzE,OAAO;QACL,YAAY,EAAE,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,oBAAoB;QACxD,oBAAoB,EAAE,oBAAoB;KAC3C,CAAA;AACH,CAAC"}