viem
Version:
77 lines • 2.97 kB
JavaScript
import { multicall, } from '../../../actions/public/multicall.js';
import { l2OutputOracleAbi, portalAbi } from '../abis.js';
const buffer = 10;
/**
* Returns the time until the withdrawal transaction can be finalized. Used for the [Withdrawal](/op-stack/guides/withdrawals.html) flow.
*
* - Docs: https://viem.sh/op-stack/actions/getTimeToFinalize.html
*
* @param client - Client to use
* @param parameters - {@link GetTimeToFinalizeParameters}
* @returns Time until finalize. {@link GetTimeToFinalizeReturnType}
*
* @example
* import { createPublicClient, http } from 'viem'
* import { getBlockNumber } from 'viem/actions'
* import { mainnet, optimism } from 'viem/chains'
* import { getTimeToFinalize } from 'viem/op-stack'
*
* const publicClientL1 = createPublicClient({
* chain: mainnet,
* transport: http(),
* })
* const publicClientL2 = createPublicClient({
* chain: optimism,
* transport: http(),
* })
*
* const receipt = await publicClientL2.getTransactionReceipt({
* hash: '0x9a2f4283636ddeb9ac32382961b22c177c9e86dd3b283735c154f897b1a7ff4a',
* })
*
* const [withdrawal] = getWithdrawals(receipt)
*
* const { seconds } = await getTimeToFinalize(publicClientL1, {
* withdrawalHash: withdrawal.withdrawalHash,
* targetChain: optimism
* })
*/
export async function getTimeToFinalize(client, parameters) {
const { chain = client.chain, withdrawalHash, targetChain } = parameters;
const l2OutputOracleAddress = (() => {
if (parameters.l2OutputOracleAddress)
return parameters.l2OutputOracleAddress;
if (chain)
return targetChain.contracts.l2OutputOracle[chain.id].address;
return Object.values(targetChain.contracts.l2OutputOracle)[0].address;
})();
const portalAddress = (() => {
if (parameters.portalAddress)
return parameters.portalAddress;
if (chain)
return targetChain.contracts.portal[chain.id].address;
return Object.values(targetChain.contracts.portal)[0].address;
})();
const [[_outputRoot, proveTimestamp, _l2OutputIndex], period] = await multicall(client, {
allowFailure: false,
contracts: [
{
abi: portalAbi,
address: portalAddress,
functionName: 'provenWithdrawals',
args: [withdrawalHash],
},
{
abi: l2OutputOracleAbi,
address: l2OutputOracleAddress,
functionName: 'FINALIZATION_PERIOD_SECONDS',
},
],
});
const secondsSinceProven = Date.now() / 1000 - Number(proveTimestamp);
const secondsToFinalize = Number(period) - secondsSinceProven;
const seconds = Math.floor(secondsToFinalize < 0 ? 0 : secondsToFinalize + buffer);
const timestamp = Date.now() + seconds * 1000;
return { period: Number(period), seconds, timestamp };
}
//# sourceMappingURL=getTimeToFinalize.js.map