@tevm/actions/src/BaseCall/zBaseCallParams.js

A typesafe library for writing forge scripts in typescript

import { z } from 'zod'
import { zCallEvents } from '../common/zCallEvents.js'
import { zAddress } from '../internal/zod/zAddress.js'
import { zBlockOverrideSet } from '../internal/zod/zBlockOverrideSet.js'
import { zBlockParam } from '../internal/zod/zBlockParam.js'
import { zHex } from '../internal/zod/zHex.js'
import { zStateOverrideSet } from '../internal/zod/zStateOverrideSet.js'
import { zBaseParams } from './zBaseParams.js'

export const zBaseCallParams = zBaseParams
	.extend({
		...zCallEvents.shape,
		createTrace: z.boolean().optional().describe('If true, the call will also return a `trace` on the trace property'),
		createAccessList: z
			.boolean()
			.optional()
			.describe('If true, the call will also return a `accessList` on the accessList property'),
		createTransaction: z.union([
			z.boolean().optional().describe('If true, this call is a create transaction. Defaults to false.'),
			z.literal('on-success'),
			z.literal('always'),
			z.literal('never'),
		]),
		addToMempool: z.union([
			z.boolean().optional().describe('If true, this call adds the transaction to the mempool. Defaults to false.'),
			z.literal('on-success'),
			z.literal('always'),
			z.literal('never'),
		]),
		addToBlockchain: z.union([
			z.boolean().optional().describe('If true, this call adds the transaction to the blockchain. Defaults to false.'),
			z.literal('on-success'),
			z.literal('always'),
			z.literal('never'),
		]),
		skipBalance: z.boolean().optional().describe('Set caller to msg.value of less than msg.value Defaults to false.'),
		gasRefund: z.bigint().nonnegative().optional().describe('Refund counter. Defaults to 0'),
		blockTag: zBlockParam
			.optional()
			.describe('The block tag as a block number, block hash or one of "latest", "earliest", "pending" or "safe"'),
		gasPrice: z.bigint().optional().describe('The gas price for the call. Defaults to `0`'),
		origin: zAddress.optional().describe('The address where the call originated from. Defaults to the zero address.'),
		caller: zAddress
			.optional()
			.describe('The address that ran this code (`msg.sender`). Defaults to the zero address.'),
		gas: z
			.bigint()
			.nonnegative()
			.optional()
			.describe('The gas limit for the call. Defaults to `16777215` (`0xffffff`)'),
		value: z
			.bigint()
			.nonnegative()
			.optional()
			.describe('The value in ether that is being sent to `opts.address`. Defaults to `0`'),
		depth: z.number().nonnegative().optional().describe('The call depth. Defaults to `0`'),
		selfdestruct: z.set(zAddress).optional().describe('Addresses to selfdestruct. Defaults to the empty set.'),
		to: zAddress
			.optional()
			.describe(
				'The address of the account that is executing this code (`address(this)`). Defaults to the zero address.',
			),
		blobVersionedHashes: z.array(zHex).optional().describe('Versioned hashes for each blob in a blob transaction'),
		stateOverrideSet: zStateOverrideSet.optional().describe('State override set for the call'),
		blockOverrideSet: zBlockOverrideSet.optional().describe('Block override set for the call'),
		maxFeePerGas: z
			.bigint()
			.optional()
			.describe(
				'The maximum fee per gas for the call for an EIP-1559 tx. If not set it will be calculated based on the parent block.',
			),
		maxPriorityFeePerGas: z
			.bigint()
			.optional()
			.describe('The maximum priority fee per gas for the call for an EIP-1559 tx.'),
	})
	.refine(
		(params) => {
			// Validate that addToMempool and addToBlockchain are not both set
			if (params.addToMempool !== undefined && params.addToBlockchain !== undefined) {
				return false
			}
			return true
		},
		{
			message: 'Cannot set both addToMempool and addToBlockchain simultaneously. Use one or the other.',
		},
	)
	.describe('Properties shared across call-like actions')