Class TransactionWatcher

TransactionWatcher allows one to continuously watch (monitor), by means of polling, the status of a given transaction.

Index

Constructors

Properties

fetcher patienceMilliseconds pollingIntervalMilliseconds timeoutMilliseconds

Methods

awaitAllEvents awaitAnyEvent awaitCompleted awaitConditionally awaitOnCondition awaitPending getAllTransactionEvents NoopOnStatusReceived

Constructors

constructor

new TransactionWatcher(
    fetcher: ITransactionFetcher,
    options?: {
        patienceMilliseconds?: number;
        pollingIntervalMilliseconds?: number;
        timeoutMilliseconds?: number;
    },
): TransactionWatcher
A transaction watcher (awaiter).
Parameters
- fetcher: ITransactionFetcher
  The transaction fetcher
- options: {
      patienceMilliseconds?: number;
      pollingIntervalMilliseconds?: number;
      timeoutMilliseconds?: number;
  } = {}
  The options
  - OptionalpatienceMilliseconds?: number
    The patience: an extra time (in milliseconds) to wait, after the transaction has reached its desired status. Currently there's a delay between the moment a transaction is marked as "completed" and the moment its outcome (contract results, events and logs) is available.
  - OptionalpollingIntervalMilliseconds?: number
    The polling interval, in milliseconds
  - OptionaltimeoutMilliseconds?: number
    The timeout, in milliseconds
Returns TransactionWatcher
- Defined in src/core/transactionWatcher.ts:40

Properties

`Protected` `Readonly`fetcher

fetcher: ITransactionFetcher

`Protected` `Readonly`patienceMilliseconds

patienceMilliseconds: number

`Protected` `Readonly`pollingIntervalMilliseconds

pollingIntervalMilliseconds: number

`Protected` `Readonly`timeoutMilliseconds

timeoutMilliseconds: number

Methods

awaitAllEvents

awaitAllEvents(txHash: string, events: string[]): Promise<TransactionOnNetwork>
Parameters
- txHash: string
- events: string[]
Returns Promise<TransactionOnNetwork>
- Defined in src/core/transactionWatcher.ts:86

awaitAnyEvent

awaitAnyEvent(txHash: string, events: string[]): Promise<TransactionOnNetwork>
Parameters
- txHash: string
- events: string[]
Returns Promise<TransactionOnNetwork>
- Defined in src/core/transactionWatcher.ts:103

awaitCompleted

awaitCompleted(txHash: string): Promise<TransactionOnNetwork>
Waits until the transaction is completely processed.
Parameters
- txHash: string
  The transaction hash
Returns Promise<TransactionOnNetwork>
- Defined in src/core/transactionWatcher.ts:73

`Protected`awaitConditionally

awaitConditionally<TData>(
    isSatisfied: (data: TData) => boolean,
    doFetch: () => Promise<TData>,
    createError: () => Err,
): Promise<TData>
Type Parameters
- TData
Parameters
- isSatisfied: (data: TData) => boolean
- doFetch: () => Promise<TData>
- createError: () => Err
Returns Promise<TData>
- Defined in src/core/transactionWatcher.ts:132

awaitOnCondition

awaitOnCondition(
txHash: string,
condition: (data: TransactionOnNetwork) => boolean,
): Promise<TransactionOnNetwork>
Parameters
- txHash: string
- condition: (data: TransactionOnNetwork) => boolean
Returns Promise<TransactionOnNetwork>
- Defined in src/core/transactionWatcher.ts:120

awaitPending

awaitPending(txHash: string): Promise<TransactionOnNetwork>
Waits until the transaction reaches the "pending" status.
Parameters
- txHash: string
  The hex-encoded transaction hash
Returns Promise<TransactionOnNetwork>
- Defined in src/core/transactionWatcher.ts:59

`Protected`getAllTransactionEvents

getAllTransactionEvents(transaction: TransactionOnNetwork): TransactionEvent[]
Parameters
- transaction: TransactionOnNetwork
Returns TransactionEvent[]
- Defined in src/core/transactionWatcher.ts:188

`Static`NoopOnStatusReceived

NoopOnStatusReceived(_: TransactionStatus): void
Parameters
- _: TransactionStatus
Returns void
- Defined in src/core/transactionWatcher.ts:24

Class TransactionWatcher

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalpatienceMilliseconds?: number

OptionalpollingIntervalMilliseconds?: number

OptionaltimeoutMilliseconds?: number

Returns TransactionWatcher

Properties

Protected Readonlyfetcher

Protected ReadonlypatienceMilliseconds

Protected ReadonlypollingIntervalMilliseconds

Protected ReadonlytimeoutMilliseconds

Methods

awaitAllEvents

Parameters

Returns Promise<TransactionOnNetwork>

awaitAnyEvent

Parameters

Returns Promise<TransactionOnNetwork>

awaitCompleted

Parameters

Returns Promise<TransactionOnNetwork>

ProtectedawaitConditionally

Type Parameters

Parameters

Returns Promise<TData>

awaitOnCondition

Parameters

Returns Promise<TransactionOnNetwork>

awaitPending

Parameters

Returns Promise<TransactionOnNetwork>

ProtectedgetAllTransactionEvents

Parameters

Returns TransactionEvent[]

StaticNoopOnStatusReceived

Parameters

Returns void

Settings

On This Page

`Optional`patienceMilliseconds?: number

`Optional`pollingIntervalMilliseconds?: number

`Optional`timeoutMilliseconds?: number

`Protected` `Readonly`fetcher

`Protected` `Readonly`patienceMilliseconds

`Protected` `Readonly`pollingIntervalMilliseconds

`Protected` `Readonly`timeoutMilliseconds

`Protected`awaitConditionally

`Protected`getAllTransactionEvents

`Static`NoopOnStatusReceived