Skip to main content

ParentToChildMessageCreator

Classes

ParentToChildMessageCreator

Creates retryable tickets by directly calling the Inbox contract on Parent chain

Methods

createRetryableTicket()
createRetryableTicket(
params: OmitTyped<ParentToChildMessageNoGasParams, "excessFeeRefundAddress" | "callValueRefundAddress"> & Partial<ParentToChildMessageNoGasParams> & object | ParentToChildTransactionRequest & object,
childProvider: Provider,
options?: GasOverrides): Promise<ParentContractTransaction<ParentTransactionReceipt>>

Creates a retryable ticket by directly calling the Inbox contract on Parent chain

Parameters
ParameterType
paramsOmitTyped<ParentToChildMessageNoGasParams, "excessFeeRefundAddress" | "callValueRefundAddress"> & Partial<ParentToChildMessageNoGasParams> & object | ParentToChildTransactionRequest & object
childProviderProvider
options?GasOverrides
Returns

Promise<ParentContractTransaction<ParentTransactionReceipt>>

Source

message/ParentToChildMessageCreator.ts:203

getTicketCreationRequest()
static getTicketCreationRequest(
params: ParentToChildMessageParams,
parentProvider: Provider,
childProvider: Provider,
options?: GasOverrides): Promise<ParentToChildTransactionRequest>

Generate a transaction request for creating a retryable ticket

Parameters
ParameterTypeDescription
paramsParentToChildMessageParams
parentProviderProvider
childProviderProvider
options?GasOverrides
Returns

Promise <ParentToChildTransactionRequest>

Source

message/ParentToChildMessageCreator.ts:136

getTicketCreationRequestCallData()
static protected getTicketCreationRequestCallData(
params: ParentToChildMessageParams,
estimates: Pick<RetryableData, ParentToChildGasKeys>,
excessFeeRefundAddress: string,
callValueRefundAddress: string,
nativeTokenIsEth: boolean): string

Prepare calldata for a call to create a retryable ticket

Parameters
ParameterTypeDescription
paramsParentToChildMessageParams
estimatesPick<RetryableData, ParentToChildGasKeys>
excessFeeRefundAddressstring
callValueRefundAddressstring
nativeTokenIsEthboolean
Returns

string

Source

message/ParentToChildMessageCreator.ts:89

getTicketEstimate()
static protected getTicketEstimate(
params: ParentToChildMessageNoGasParams,
parentProvider: Provider,
childProvider: Provider,
retryableGasOverrides?: GasOverrides): Promise<Pick<RetryableData, ParentToChildGasKeys>>

Gets a current estimate for the supplied params

Parameters
ParameterTypeDescription
paramsParentToChildMessageNoGasParams
parentProviderProvider
childProviderProvider
retryableGasOverrides?GasOverrides
Returns

Promise<Pick<RetryableData, ParentToChildGasKeys>>

Source

message/ParentToChildMessageCreator.ts:63