Skip to main content

transactionRequest

Interfaces

ChildToParentTransactionRequest

A transaction request for a transaction that will trigger a child to parent message

Properties

PropertyTypeDescription
estimateParentGasLimit(l1Provider: Provider) => Promise<BigNumber>Estimate the gas limit required to execute the withdrawal on the parent chain.
Note that this is only a rough estimate as it may not be possible to know
the exact size of the proof straight away, however the real value should be
within a few thousand gas of this estimate.

ParentToChildTransactionRequest

A transaction request for a transaction that will trigger some sort of execution on the child chain

Properties

PropertyTypeDescription
retryableDataOmitTyped<ParentToChildMessageNoGasParams, "excessFeeRefundAddress" | "callValueRefundAddress"> & Partial<ParentToChildMessageNoGasParams> & ParentToChildMessageGasParamsInformation about the retryable ticket, and it's subsequent execution, that
will occur on the child chain
txRequestRequired<Pick<TransactionRequest, "data" | "value" | "from" | "to">>Core fields needed to form the parent component of the transaction request

Methods

isValid()
isValid(): Promise<boolean>

If this request were sent now, would it have enough margin to reliably succeed

Returns

Promise<boolean>

Source

dataEntities/transactionRequest.ts:28

Functions

isChildToParentTransactionRequest()

function isChildToParentTransactionRequest<T>(possibleRequest: ChildToParentTransactionRequest | IsNotTransactionRequest<T>): possibleRequest is ChildToParentTransactionRequest

Check if an object is of ChildToParentTransactionRequest type

Type parameters

Type parameter
T

Parameters

ParameterTypeDescription
possibleRequestChildToParentTransactionRequest | IsNotTransactionRequest<T>

Returns

possibleRequest is ChildToParentTransactionRequest

Source

dataEntities/transactionRequest.ts:70


isParentToChildTransactionRequest()

function isParentToChildTransactionRequest<T>(possibleRequest: ParentToChildTransactionRequest | IsNotTransactionRequest<T>): possibleRequest is ParentToChildTransactionRequest

Check if an object is of ParentToChildTransactionRequest type

Type parameters

Type parameter
T

Parameters

ParameterTypeDescription
possibleRequestParentToChildTransactionRequest | IsNotTransactionRequest<T>

Returns

possibleRequest is ParentToChildTransactionRequest

Source

dataEntities/transactionRequest.ts:57