ParentToChildMessageCreator

Classes

ParentToChildMessageCreator

Defined in: message/ParentToChildMessageCreator.ts:51

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>>;

Defined in: message/ParentToChildMessageCreator.ts:206

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

Parameters

Parameter	Type
params	| OmitTyped<ParentToChildMessageNoGasParams, "excessFeeRefundAddress" | "callValueRefundAddress"> & Partial<ParentToChildMessageNoGasParams> & object | ParentToChildTransactionRequest & object
childProvider	Provider
options?	GasOverrides

Returns

Promise<ParentContractTransaction<ParentTransactionReceipt>>

getTicketCreationRequest()

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

Defined in: message/ParentToChildMessageCreator.ts:139

Generate a transaction request for creating a retryable ticket

Parameters

Parameter	Type	Description
params	ParentToChildMessageParams
parentProvider	Provider
childProvider	Provider
options?	GasOverrides

Returns

Promise<ParentToChildTransactionRequest>

getTicketCreationRequestCallData()

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

Defined in: message/ParentToChildMessageCreator.ts:92

Prepare calldata for a call to create a retryable ticket

Parameters

Parameter	Type	Description
params	ParentToChildMessageParams
estimates	Pick<RetryableData, ParentToChildGasKeys>
excessFeeRefundAddress	string
callValueRefundAddress	string
nativeTokenIsEth	boolean

Returns

string

getTicketEstimate()

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

Defined in: message/ParentToChildMessageCreator.ts:66

Gets a current estimate for the supplied params

Parameters

Parameter	Type	Description
params	ParentToChildMessageNoGasParams
parentProvider	Provider
childProvider	Provider
retryableGasOverrides?	GasOverrides

Returns

Promise<Pick<RetryableData, ParentToChildGasKeys>>