transactionRequest

Interfaces

ChildToParentTransactionRequest

Defined in: dataEntities/transactionRequest.ts:34

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

Properties

Property	Type	Description	Defined in
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.	dataEntities/transactionRequest.ts:44

---

ParentToChildTransactionRequest

Defined in: dataEntities/transactionRequest.ts:13

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

Properties

Property	Type	Description	Defined in
retryableData	OmitTyped<ParentToChildMessageNoGasParams, "excessFeeRefundAddress" | "callValueRefundAddress"> & Partial<ParentToChildMessageNoGasParams> & ParentToChildMessageGasParams	Information about the retryable ticket, and it's subsequent execution, that will occur on the child chain	dataEntities/transactionRequest.ts:24
txRequest	Required<Pick<TransactionRequest, "to" | "data" | "value" | "from">>	Core fields needed to form the parent component of the transaction request	dataEntities/transactionRequest.ts:17

Methods

isValid()

isValid(): Promise<boolean>;

Defined in: dataEntities/transactionRequest.ts:28

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

Returns

Promise<boolean>

Functions

isChildToParentTransactionRequest()

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

Defined in: dataEntities/transactionRequest.ts:70

Check if an object is of ChildToParentTransactionRequest type

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
possibleRequest	| ChildToParentTransactionRequest | IsNotTransactionRequest<T>

Returns

possibleRequest is ChildToParentTransactionRequest

---

isParentToChildTransactionRequest()

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

Defined in: dataEntities/transactionRequest.ts:57

Check if an object is of ParentToChildTransactionRequest type

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
possibleRequest	| ParentToChildTransactionRequest | IsNotTransactionRequest<T>

Returns

possibleRequest is ParentToChildTransactionRequest