Michael Freno
7c684a42cc
- Consolidated duplicate UndoManagers to single instance - Fixed connection promise to only resolve on 'connected' status - Fixed WebSocketProvider import (WebsocketProvider) - Added proper doc.destroy() cleanup - Renamed isPresenceInitialized property to avoid conflict Co-Authored-By: Paperclip <noreply@paperclip.ing>
113 lines
3.8 KiB
TypeScript
113 lines
3.8 KiB
TypeScript
import type { Address } from 'abitype'
|
|
|
|
import {
|
|
type ReadContractErrorType,
|
|
readContract,
|
|
} from '../../actions/public/readContract.js'
|
|
import type { Client } from '../../clients/createClient.js'
|
|
import type { Transport } from '../../clients/transports/createTransport.js'
|
|
import type { ErrorType } from '../../errors/utils.js'
|
|
import type { Account, GetAccountParameter } from '../../types/account.js'
|
|
import type { Chain, GetChainParameter } from '../../types/chain.js'
|
|
import type {
|
|
TransactionRequestEIP1559,
|
|
TransactionSerializable,
|
|
} from '../../types/transaction.js'
|
|
import type { RequestErrorType } from '../../utils/buildRequest.js'
|
|
import { getChainContractAddress } from '../../utils/chain/getChainContractAddress.js'
|
|
import type { HexToNumberErrorType } from '../../utils/encoding/fromHex.js'
|
|
import {
|
|
type SerializeTransactionErrorType,
|
|
serializeTransaction,
|
|
} from '../../utils/transaction/serializeTransaction.js'
|
|
import { parseGwei } from '../../utils/unit/parseGwei.js'
|
|
import { gasPriceOracleAbi } from '../abis.js'
|
|
import { contracts } from '../contracts.js'
|
|
|
|
export type EstimateL1GasParameters<
|
|
chain extends Chain | undefined = Chain | undefined,
|
|
account extends Account | undefined = Account | undefined,
|
|
chainOverride extends Chain | undefined = Chain | undefined,
|
|
> = Omit<TransactionRequestEIP1559, 'from'> &
|
|
GetAccountParameter<account> &
|
|
GetChainParameter<chain, chainOverride> & {
|
|
/** Gas price oracle address. */
|
|
gasPriceOracleAddress?: Address | undefined
|
|
}
|
|
|
|
export type EstimateL1GasReturnType = bigint
|
|
|
|
export type EstimateL1GasErrorType =
|
|
| RequestErrorType
|
|
| SerializeTransactionErrorType
|
|
| HexToNumberErrorType
|
|
| ReadContractErrorType
|
|
| ErrorType
|
|
|
|
/**
|
|
* Estimates the L1 data gas required to execute an L2 transaction.
|
|
*
|
|
* @param client - Client to use
|
|
* @param parameters - {@link EstimateL1GasParameters}
|
|
* @returns The gas estimate. {@link EstimateL1GasReturnType}
|
|
*
|
|
* @example
|
|
* import { createPublicClient, http, parseEther } from 'viem'
|
|
* import { optimism } from 'viem/chains'
|
|
* import { estimateL1Gas } from 'viem/chains/optimism'
|
|
*
|
|
* const client = createPublicClient({
|
|
* chain: optimism,
|
|
* transport: http(),
|
|
* })
|
|
* const l1Gas = await estimateL1Gas(client, {
|
|
* account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
|
|
* to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
|
|
* value: parseEther('1'),
|
|
* })
|
|
*/
|
|
export async function estimateL1Gas<
|
|
chain extends Chain | undefined,
|
|
account extends Account | undefined,
|
|
chainOverride extends Chain | undefined = undefined,
|
|
>(
|
|
client: Client<Transport, chain, account>,
|
|
args: EstimateL1GasParameters<chain, account, chainOverride>,
|
|
): Promise<EstimateL1GasReturnType> {
|
|
const {
|
|
chain = client.chain,
|
|
gasPriceOracleAddress: gasPriceOracleAddress_,
|
|
} = args
|
|
|
|
const gasPriceOracleAddress = (() => {
|
|
if (gasPriceOracleAddress_) return gasPriceOracleAddress_
|
|
if (chain)
|
|
return getChainContractAddress({
|
|
chain,
|
|
contract: 'gasPriceOracle',
|
|
})
|
|
return contracts.gasPriceOracle.address
|
|
})()
|
|
|
|
const transaction = serializeTransaction({
|
|
...args,
|
|
chainId: chain?.id ?? 1,
|
|
type: 'eip1559',
|
|
|
|
// Set upper-limit-ish stub values. Shouldn't affect the estimate too much as we are
|
|
// tweaking dust bytes here (as opposed to long `data` bytes).
|
|
// See: https://github.com/ethereum-optimism/optimism/blob/54d02df55523c9e1b4b38ed082c12a42087323a0/packages/contracts-bedrock/src/L2/GasPriceOracle.sol#L242-L248.
|
|
gas: args.data ? 300_000n : 21_000n,
|
|
maxFeePerGas: parseGwei('5'),
|
|
maxPriorityFeePerGas: parseGwei('1'),
|
|
nonce: 1,
|
|
} as TransactionSerializable)
|
|
|
|
return readContract(client, {
|
|
abi: gasPriceOracleAbi,
|
|
address: gasPriceOracleAddress,
|
|
functionName: 'getL1GasUsed',
|
|
args: [transaction as any],
|
|
})
|
|
}
|