SendTxHelper <ReturnFormat, ResolveType, TxType>

Index

Constructors

• constructor

Methods

• checkRevertBeforeSending
• emitConfirmation
• emitReceipt
• emitSending
• emitSent
• emitTransactionHash
• getReceiptWithEvents
• handleError
• handleResolve
• populateGasPrice
• signAndSend

Constructors

publicconstructor

• new SendTxHelper<ReturnFormat, ResolveType, TxType>(__namedParameters: { options: SendTransactionOptions<ResolveType>; promiEvent: Web3PromiEvent<ResolveType, SendSignedTransactionEvents<ReturnFormat> | SendTransactionEvents<ReturnFormat>>; returnFormat: ReturnFormat; web3Context: Web3Context<EthExecutionAPI, any> }): SendTxHelper<ReturnFormat, ResolveType, TxType>

• Type parameters

  • ReturnFormat: DataFormat
  • ResolveType = { blockHash: ByteTypes[ReturnFormat[bytes]]; blockNumber: NumberTypes[ReturnFormat[number]]; contractAddress?: string; cumulativeGasUsed: NumberTypes[ReturnFormat[number]]; effectiveGasPrice?: NumberTypes[ReturnFormat[number]]; events?: {}; from: string; gasUsed: NumberTypes[ReturnFormat[number]]; logs: { address?: string; blockHash?: ByteTypes[ReturnFormat[bytes]]; blockNumber?: NumberTypes[ReturnFormat[number]]; data?: ByteTypes[ReturnFormat[bytes]]; id?: string; logIndex?: NumberTypes[ReturnFormat[number]]; removed?: boolean; topics?: ByteTypes[ReturnFormat[bytes]][]; transactionHash?: ByteTypes[ReturnFormat[bytes]]; transactionIndex?: NumberTypes[ReturnFormat[number]] }[]; logsBloom: ByteTypes[ReturnFormat[bytes]]; root: ByteTypes[ReturnFormat[bytes]]; status: NumberTypes[ReturnFormat[number]]; to: string; transactionHash: ByteTypes[ReturnFormat[bytes]]; transactionIndex: NumberTypes[ReturnFormat[number]]; type?: NumberTypes[ReturnFormat[number]] }
  • TxType = Transaction | TransactionWithFromLocalWalletIndex | TransactionWithToLocalWalletIndex | TransactionWithFromAndToLocalWalletIndex

  Parameters

  • __namedParameters: { options: SendTransactionOptions<ResolveType>; promiEvent: Web3PromiEvent<ResolveType, SendSignedTransactionEvents<ReturnFormat> | SendTransactionEvents<ReturnFormat>>; returnFormat: ReturnFormat; web3Context: Web3Context<EthExecutionAPI, any> }

  • options: SendTransactionOptions<ResolveType>

  • promiEvent: Web3PromiEvent<ResolveType, SendSignedTransactionEvents<ReturnFormat> | SendTransactionEvents<ReturnFormat>>

  • returnFormat: ReturnFormat

  • web3Context: Web3Context<EthExecutionAPI, any>

  Returns SendTxHelper<ReturnFormat, ResolveType, TxType>

Methods

publiccheckRevertBeforeSending

• checkRevertBeforeSending(tx: TransactionCall): Promise<void>

• Parameters

  • tx: TransactionCall

  Returns Promise<void>

publicemitConfirmation

• emitConfirmation(__namedParameters: { customTransactionReceiptSchema?: Schema; receipt: ResolveType; transactionHash: string }): void

• Parameters

  • __namedParameters: { customTransactionReceiptSchema?: Schema; receipt: ResolveType; transactionHash: string }

  • optionalcustomTransactionReceiptSchema: Schema

  • receipt: ResolveType

  • transactionHash: string

  Returns void

publicemitReceipt

• emitReceipt(receipt: ResolveType): void

• Parameters

  • receipt: ResolveType

  Returns void

publicemitSending

• emitSending(tx: string | TxType): void

• Parameters

  • tx: string | TxType

  Returns void

publicemitSent

• emitSent(tx: string | TxType): void

• Parameters

  • tx: string | TxType

  Returns void

publicemitTransactionHash

• emitTransactionHash(hash: string & Uint8Array): void

• Parameters

  • hash: string & Uint8Array

  Returns void

publicgetReceiptWithEvents

• getReceiptWithEvents(data: TransactionReceipt): ResolveType

• Parameters

  • data: TransactionReceipt

  Returns ResolveType

publichandleError

• handleError(__namedParameters: { error: unknown; tx: TransactionCall }): Promise<unknown>

• Parameters

  • __namedParameters: { error: unknown; tx: TransactionCall }

  • error: unknown

  • tx: TransactionCall

  Returns Promise<unknown>

publichandleResolve

• handleResolve(__namedParameters: { receipt: ResolveType; tx: TransactionCall }): Promise<ResolveType>

• Parameters

  • __namedParameters: { receipt: ResolveType; tx: TransactionCall }

  • receipt: ResolveType

  • tx: TransactionCall

  Returns Promise<ResolveType>

publicpopulateGasPrice

• populateGasPrice(__namedParameters: { transaction: TxType; transactionFormatted: TxType }): Promise<TxType>

• Parameters

  • __namedParameters: { transaction: TxType; transactionFormatted: TxType }

  • transaction: TxType

  • transactionFormatted: TxType

  Returns Promise<TxType>

publicsignAndSend

• signAndSend(__namedParameters: { tx: TxType; wallet: undefined | Web3BaseWalletAccount }): Promise<string>

• Parameters

  • __namedParameters: { tx: TxType; wallet: undefined | Web3BaseWalletAccount }

  • tx: TxType

  • wallet: undefined | Web3BaseWalletAccount

  Returns Promise<string>