@mantleio/viem 0.0.1-alpha.0

package/src/mantle/actions/estimateDepositMNTGas.ts

@@ -0,0 +1,111 @@
+import type { Address } from "viem";
+
+import type { Client, Transport } from "viem";
+import type { Account } from "viem";
+import type { Chain, DeriveChain, GetChainParameter } from "viem";
+import type { UnionEvaluate, UnionOmit } from "viem";
+import {
+	estimateContractGas,
+	type EstimateContractGasErrorType,
+	type EstimateContractGasParameters,
+} from "viem/actions";
+import type { FormattedTransactionRequest } from "viem/utils";
+import { l1StandardBridge } from "../abis.js";
+import type { ErrorType } from "../errors/utils.js";
+import type { GetAccountParameter } from "../types/account.js";
+import type { GetContractAddressParameter } from "../types/contract.js";
+import type { DepositMNTRequest } from "../types/deposit.js";
+import { parseDepositRequest } from "../utils/parseDepositRequest.js";
+
+export type EstimateDepositMNTGasParameters<
+	chain extends Chain | undefined = Chain | undefined,
+	account extends Account | undefined = Account | undefined,
+	chainOverride extends Chain | undefined = Chain | undefined,
+	///
+	derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = UnionEvaluate<
+	UnionOmit<
+		FormattedTransactionRequest<derivedChain>,
+		| "accessList"
+		| "data"
+		| "from"
+		| "gas"
+		| "gasPrice"
+		| "to"
+		| "type"
+		| "value"
+	>
+> &
+	GetAccountParameter<account, Account | Address> &
+	GetChainParameter<chain, chainOverride> &
+	GetContractAddressParameter<derivedChain, "l1StandardBridge"> & {
+		/** L2 transaction request. */
+		request: DepositMNTRequest;
+		/** Gas limit for transaction execution on the L1. */
+		gas?: bigint | undefined;
+	};
+
+export type EstimateDepositMNTGasReturnType = bigint;
+
+export type EstimateDepositMNTGasErrorType =
+	| EstimateContractGasErrorType
+	| ErrorType;
+
+/**
+ * @param client - Client to use
+ * @param parameters - {@link EstimateDepositMNTGasParameters}
+ * @returns The L1 transaction hash. {@link EstimateDepositMNTGasReturnType}
+ */
+export async function estimateDepositMNTGas<
+	chain extends Chain | undefined,
+	account extends Account | undefined,
+	chainOverride extends Chain | undefined = undefined,
+>(
+	client: Client<Transport, chain, account>,
+	parameters: EstimateDepositMNTGasParameters<chain, account, chainOverride>,
+) {
+	const {
+		account,
+		chain = client.chain,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		request: { amount, to },
+		targetChain,
+	} = parameters;
+
+	const l1StandardBridgeAddress = (() => {
+		if (parameters.l1StandardBridgeAddress) {
+			return parameters.l1StandardBridgeAddress;
+		}
+		if (chain) return targetChain!.contracts.l1StandardBridge[chain.id].address;
+		return Object.values(targetChain!.contracts.l1StandardBridge)[0].address;
+	})();
+
+	const { functionName, args } = parseDepositRequest({
+		type: "mnt",
+		amount,
+		to,
+	});
+
+	const params = {
+		account,
+		abi: l1StandardBridge,
+		address: l1StandardBridgeAddress,
+		functionName,
+		args,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		// TODO: Not sure `chain` is necessary since it's not used downstream
+		// in `estimateContractGas` or `estimateGas`
+		// @ts-ignore
+		chain,
+	} satisfies EstimateContractGasParameters<
+		typeof l1StandardBridge,
+		typeof functionName
+	>;
+	return estimateContractGas(client, params as any);
+}

package/src/mantle/actions/estimateFinalizeWithdrawalGas.ts

@@ -0,0 +1,102 @@
+import type { Address } from "viem";
+import type { Client } from "viem";
+import type { Transport } from "viem";
+import type { Account } from "viem";
+import type { Chain, DeriveChain, GetChainParameter } from "viem";
+import type { UnionEvaluate, UnionOmit } from "viem";
+import {
+	estimateContractGas,
+	type EstimateContractGasErrorType,
+	type EstimateContractGasParameters,
+} from "viem/actions";
+import type { FormattedTransactionRequest } from "viem/utils";
+import { portalAbi } from "../abis.js";
+import type { ErrorType } from "../errors/utils.js";
+import type { GetAccountParameter } from "../types/account.js";
+import type { GetContractAddressParameter } from "../types/contract.js";
+import type { Withdrawal } from "../types/withdrawal.js";
+
+export type EstimateFinalizeWithdrawalGasParameters<
+	chain extends Chain | undefined = Chain | undefined,
+	account extends Account | undefined = Account | undefined,
+	chainOverride extends Chain | undefined = Chain | undefined,
+	_derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = UnionEvaluate<
+	UnionOmit<
+		FormattedTransactionRequest<_derivedChain>,
+		| "accessList"
+		| "data"
+		| "from"
+		| "gas"
+		| "gasPrice"
+		| "to"
+		| "type"
+		| "value"
+	>
+> &
+	GetAccountParameter<account, Account | Address> &
+	GetChainParameter<chain, chainOverride> &
+	GetContractAddressParameter<_derivedChain, "portal"> & {
+		/** Gas limit for transaction execution on the L2. */
+		gas?: bigint | undefined;
+		withdrawal: Withdrawal;
+	};
+export type EstimateFinalizeWithdrawalGasReturnType = bigint;
+export type EstimateFinalizeWithdrawalGasErrorType =
+	| EstimateContractGasErrorType
+	| ErrorType;
+
+/**
+ * @param client - Client to use
+ * @param parameters - {@link EstimateFinalizeWithdrawalGasParameters}
+ * @returns Estimated gas. {@link EstimateFinalizeWithdrawalGasReturnType}
+ */
+export async function estimateFinalizeWithdrawalGas<
+	chain extends Chain | undefined,
+	account extends Account | undefined,
+	chainOverride extends Chain | undefined = undefined,
+>(
+	client: Client<Transport, chain, account>,
+	parameters: EstimateFinalizeWithdrawalGasParameters<
+		chain,
+		account,
+		chainOverride
+	>,
+) {
+	const {
+		account,
+		chain = client.chain,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		targetChain,
+		withdrawal,
+	} = parameters;
+
+	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 params = {
+		account,
+		abi: portalAbi,
+		address: portalAddress,
+		functionName: "finalizeWithdrawalTransaction",
+		args: [withdrawal],
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		// TODO: Not sure `chain` is necessary since it's not used downstream
+		// in `estimateContractGas` or `estimateGas`
+		// @ts-ignore
+		chain,
+	} satisfies EstimateContractGasParameters<
+		typeof portalAbi,
+		"finalizeWithdrawalTransaction"
+	>;
+	return estimateContractGas(client, params as any);
+}

package/src/mantle/actions/estimateInitiateERC20WithdrawalGas.ts

@@ -0,0 +1,106 @@
+import type { Address } from "viem";
+
+import type { Client, Transport } from "viem";
+import type { Account } from "viem";
+import type { Chain, DeriveChain, GetChainParameter } from "viem";
+import type { UnionEvaluate, UnionOmit } from "viem";
+import {
+	estimateContractGas,
+	type EstimateContractGasErrorType,
+	type EstimateContractGasParameters,
+} from "viem/actions";
+import type { FormattedTransactionRequest } from "viem/utils";
+import { l2StandardBridge } from "../abis.js";
+import { contracts } from "../contracts.js";
+import type { ErrorType } from "../errors/utils.js";
+import type { GetAccountParameter } from "../types/account.js";
+import type { InitiateERC20WithdrawalRequest } from "../types/withdrawal.js";
+import { parseInitWithdrawequest } from "../utils/parseInitWithdrawRequest.js";
+
+export type EstimateInitiateWithdrawalERC20GasParameters<
+	chain extends Chain | undefined = Chain | undefined,
+	account extends Account | undefined = Account | undefined,
+	chainOverride extends Chain | undefined = Chain | undefined,
+	///
+	derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = UnionEvaluate<
+	UnionOmit<
+		FormattedTransactionRequest<derivedChain>,
+		| "accessList"
+		| "data"
+		| "from"
+		| "gas"
+		| "gasPrice"
+		| "to"
+		| "type"
+		| "value"
+	>
+> &
+	GetAccountParameter<account, Account | Address> &
+	GetChainParameter<chain, chainOverride> & {
+		/** L2 transaction request. */
+		request: InitiateERC20WithdrawalRequest;
+		/** Gas limit for transaction execution on the L1. */
+		gas?: bigint | undefined;
+	};
+
+export type EstimateInitiateERC20WithdrawalGasReturnType = bigint;
+
+export type EstimateInitiateERC20WithdrawalGasErrorType =
+	| EstimateContractGasErrorType
+	| ErrorType;
+
+/**
+ * @param client - Client to use
+ * @param parameters - {@link EstimateInitiateERC20WithdrawalGasParameters}
+ * @returns The L1 transaction hash. {@link EstimateInitiateERC20WithdrawalGasReturnType}
+ */
+export async function estimateInitiateERC20Withdrawal<
+	chain extends Chain | undefined,
+	account extends Account | undefined,
+	chainOverride extends Chain | undefined = undefined,
+>(
+	client: Client<Transport, chain, account>,
+	parameters: EstimateInitiateWithdrawalERC20GasParameters<
+		chain,
+		account,
+		chainOverride
+	>,
+) {
+	const {
+		account,
+		chain = client.chain,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		request: { amount, l2Token, to },
+	} = parameters;
+
+	const { functionName, args } = parseInitWithdrawequest({
+		type: "erc20",
+		l2Token,
+		amount,
+		to,
+	});
+
+	const params = {
+		account,
+		abi: l2StandardBridge,
+		address: contracts.l2StandardBridge.address,
+		functionName,
+		args,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		// TODO: Not sure `chain` is necessary since it's not used downstream
+		// in `estimateContractGas` or `estimateGas`
+		// @ts-ignore
+		chain,
+	} satisfies EstimateContractGasParameters<
+		typeof l2StandardBridge,
+		typeof functionName
+	>;
+	return estimateContractGas(client, params as any);
+}

package/src/mantle/actions/estimateInitiateETHWithdrawalGas.ts

@@ -0,0 +1,105 @@
+import type { Address } from "viem";
+
+import type { Client, Transport } from "viem";
+import type { Account } from "viem";
+import type { Chain, DeriveChain, GetChainParameter } from "viem";
+import type { UnionEvaluate, UnionOmit } from "viem";
+import {
+	estimateContractGas,
+	type EstimateContractGasErrorType,
+	type EstimateContractGasParameters,
+} from "viem/actions";
+import type { FormattedTransactionRequest } from "viem/utils";
+import { l2StandardBridge } from "../abis.js";
+import { contracts } from "../contracts.js";
+import type { ErrorType } from "../errors/utils.js";
+import type { GetAccountParameter } from "../types/account.js";
+import type { InitiateETHWithdrawalRequest } from "../types/withdrawal.js";
+import { parseInitWithdrawequest } from "../utils/parseInitWithdrawRequest.js";
+
+export type EstimateInitiateETHWithdrawalGasParameters<
+	chain extends Chain | undefined = Chain | undefined,
+	account extends Account | undefined = Account | undefined,
+	chainOverride extends Chain | undefined = Chain | undefined,
+	///
+	derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = UnionEvaluate<
+	UnionOmit<
+		FormattedTransactionRequest<derivedChain>,
+		| "accessList"
+		| "data"
+		| "from"
+		| "gas"
+		| "gasPrice"
+		| "to"
+		| "type"
+		| "value"
+	>
+> &
+	GetAccountParameter<account, Account | Address> &
+	GetChainParameter<chain, chainOverride> & {
+		/** L2 transaction request. */
+		request: InitiateETHWithdrawalRequest;
+		/** Gas limit for transaction execution on the L1. */
+		gas?: bigint | undefined;
+	};
+
+export type EstimateInitiateETHWithdrawalGasReturnType = bigint;
+
+export type EstimateInitiateETHWithdrawalGasErrorType =
+	| EstimateContractGasErrorType
+	| ErrorType;
+
+/**
+ * @param client - Client to use
+ * @param parameters - {@link EstimateInitiateETHWithdrawalGasParameters}
+ * @returns The L1 transaction hash. {@link EstimateInitiateETHWithdrawalGasReturnType}
+ */
+export async function estimateInitiateETHWithdrawalGas<
+	chain extends Chain | undefined,
+	account extends Account | undefined,
+	chainOverride extends Chain | undefined = undefined,
+>(
+	client: Client<Transport, chain, account>,
+	parameters: EstimateInitiateETHWithdrawalGasParameters<
+		chain,
+		account,
+		chainOverride
+	>,
+) {
+	const {
+		account,
+		chain = client.chain,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		request: { amount, to },
+	} = parameters;
+
+	const { functionName, args } = parseInitWithdrawequest({
+		type: "eth",
+		amount,
+		to,
+	});
+
+	const params = {
+		account,
+		abi: l2StandardBridge,
+		address: contracts.l2StandardBridge.address,
+		functionName,
+		args,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		// TODO: Not sure `chain` is necessary since it's not used downstream
+		// in `estimateContractGas` or `estimateGas`
+		// @ts-ignore
+		chain,
+	} satisfies EstimateContractGasParameters<
+		typeof l2StandardBridge,
+		typeof functionName
+	>;
+	return estimateContractGas(client, params as any);
+}

package/src/mantle/actions/estimateInitiateMNTWithdrawalGas.ts

@@ -0,0 +1,106 @@
+import type { Address } from "viem";
+
+import type { Client, Transport } from "viem";
+import type { Account } from "viem";
+import type { Chain, DeriveChain, GetChainParameter } from "viem";
+import type { UnionEvaluate, UnionOmit } from "viem";
+import {
+	estimateContractGas,
+	type EstimateContractGasErrorType,
+	type EstimateContractGasParameters,
+} from "viem/actions";
+import type { FormattedTransactionRequest } from "viem/utils";
+import { l2StandardBridge } from "../abis.js";
+import { contracts } from "../contracts.js";
+import type { ErrorType } from "../errors/utils.js";
+import type { GetAccountParameter } from "../types/account.js";
+import type { InitiateMNTWithdrawalRequest } from "../types/withdrawal.js";
+import { parseInitWithdrawequest } from "../utils/parseInitWithdrawRequest.js";
+
+export type EstimateInitiateMNTWithdrawalGasParameters<
+	chain extends Chain | undefined = Chain | undefined,
+	account extends Account | undefined = Account | undefined,
+	chainOverride extends Chain | undefined = Chain | undefined,
+	///
+	derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = UnionEvaluate<
+	UnionOmit<
+		FormattedTransactionRequest<derivedChain>,
+		| "accessList"
+		| "data"
+		| "from"
+		| "gas"
+		| "gasPrice"
+		| "to"
+		| "type"
+		| "value"
+	>
+> &
+	GetAccountParameter<account, Account | Address> &
+	GetChainParameter<chain, chainOverride> & {
+		/** L2 transaction request. */
+		request: InitiateMNTWithdrawalRequest;
+		/** Gas limit for transaction execution on the L1. */
+		gas?: bigint | undefined;
+	};
+
+export type EstimateInitiateMNTWithdrawalGasReturnType = bigint;
+
+export type EstimateInitiateMNTWithdrawalGasErrorType =
+	| EstimateContractGasErrorType
+	| ErrorType;
+
+/**
+ * @param client - Client to use
+ * @param parameters - {@link EstimateInitiateMNTWithdrawalGasParameters}
+ * @returns The L1 transaction hash. {@link EstimateInitiateMNTWithdrawalGasReturnType}
+ */
+export async function estimateInitiateMNTWithdrawalGas<
+	chain extends Chain | undefined,
+	account extends Account | undefined,
+	chainOverride extends Chain | undefined = undefined,
+>(
+	client: Client<Transport, chain, account>,
+	parameters: EstimateInitiateMNTWithdrawalGasParameters<
+		chain,
+		account,
+		chainOverride
+	>,
+) {
+	const {
+		account,
+		chain = client.chain,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		request: { amount, to },
+	} = parameters;
+
+	const { functionName, args } = parseInitWithdrawequest({
+		type: "mnt",
+		amount,
+		to,
+	});
+
+	const params = {
+		account,
+		abi: l2StandardBridge,
+		address: contracts.l2StandardBridge.address,
+		functionName,
+		args,
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		// TODO: Not sure `chain` is necessary since it's not used downstream
+		// in `estimateContractGas` or `estimateGas`
+		// @ts-ignore
+		chain,
+		value: amount,
+	} satisfies EstimateContractGasParameters<
+		typeof l2StandardBridge,
+		typeof functionName
+	>;
+	return estimateContractGas(client, params as any);
+}

package/src/mantle/actions/estimateProveWithdrawalGas.ts

@@ -0,0 +1,114 @@
+import type { Address } from "viem";
+import type { Client } from "viem";
+import type { Transport } from "viem";
+import type { Account } from "viem";
+import type { Chain, DeriveChain, GetChainParameter } from "viem";
+import type { Hex } from "viem";
+import type { UnionEvaluate, UnionOmit } from "viem";
+import {
+	estimateContractGas,
+	type EstimateContractGasErrorType,
+	type EstimateContractGasParameters,
+} from "viem/actions";
+import type { FormattedTransactionRequest } from "viem/utils";
+import { portalAbi } from "../abis.js";
+import type { ErrorType } from "../errors/utils.js";
+import type { GetAccountParameter } from "../types/account.js";
+import type { GetContractAddressParameter } from "../types/contract.js";
+import type { Withdrawal } from "../types/withdrawal.js";
+
+export type EstimateProveWithdrawalGasParameters<
+	chain extends Chain | undefined = Chain | undefined,
+	account extends Account | undefined = Account | undefined,
+	chainOverride extends Chain | undefined = Chain | undefined,
+	_derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = UnionEvaluate<
+	UnionOmit<
+		FormattedTransactionRequest<_derivedChain>,
+		| "accessList"
+		| "data"
+		| "from"
+		| "gas"
+		| "gasPrice"
+		| "to"
+		| "type"
+		| "value"
+	>
+> &
+	GetAccountParameter<account, Account | Address> &
+	GetChainParameter<chain, chainOverride> &
+	GetContractAddressParameter<_derivedChain, "portal"> & {
+		/** Gas limit for transaction execution on the L2. */
+		gas?: bigint | undefined;
+		l2OutputIndex: bigint;
+		outputRootProof: {
+			version: Hex;
+			stateRoot: Hex;
+			messagePasserStorageRoot: Hex;
+			latestBlockhash: Hex;
+		};
+		withdrawalProof: readonly Hex[];
+		withdrawal: Withdrawal;
+	};
+export type EstimateProveWithdrawalGasReturnType = bigint;
+export type EstimateProveWithdrawalGasErrorType =
+	| EstimateContractGasErrorType
+	| ErrorType;
+
+/**
+ * @param client - Client to use
+ * @param parameters - {@link EstimateProveWithdrawalGasParameters}
+ * @returns Estimated gas. {@link EstimateProveWithdrawalGasReturnType}
+ */
+export async function estimateProveWithdrawalGas<
+	chain extends Chain | undefined,
+	account extends Account | undefined,
+	chainOverride extends Chain | undefined = undefined,
+>(
+	client: Client<Transport, chain, account>,
+	parameters: EstimateProveWithdrawalGasParameters<
+		chain,
+		account,
+		chainOverride
+	>,
+) {
+	const {
+		account,
+		chain = client.chain,
+		gas,
+		l2OutputIndex,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		outputRootProof,
+		targetChain,
+		withdrawalProof,
+		withdrawal,
+	} = parameters;
+
+	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 params = {
+		account,
+		abi: portalAbi,
+		address: portalAddress,
+		functionName: "proveWithdrawalTransaction",
+		args: [withdrawal, l2OutputIndex, outputRootProof, withdrawalProof],
+		gas,
+		maxFeePerGas,
+		maxPriorityFeePerGas,
+		nonce,
+		// TODO: Not sure `chain` is necessary since it's not used downstream
+		// in `estimateContractGas` or `estimateGas`
+		// @ts-ignore
+		chain,
+	} satisfies EstimateContractGasParameters<
+		typeof portalAbi,
+		"proveWithdrawalTransaction"
+	>;
+	return estimateContractGas(client, params as any);
+}