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 DefaultPatience DefaultPollingInterval DefaultTimeout

Methods

awaitAllEvents awaitAnyEvent awaitCompleted awaitConditionally awaitOnCondition awaitPending getAllTransactionEvents transactionOrTxHashToTxHash NoopOnStatusReceived

Constructors

constructor

new TransactionWatcher(fetcher, options?): TransactionWatcher
A transaction watcher (awaiter).
Parameters
- fetcher: ITransactionFetcher
  The transaction fetcher
- options: {
      patienceMilliseconds?: number;
      pollingIntervalMilliseconds?: number;
      timeoutMilliseconds?: number;
  } = {}
  The options
  - Optional patienceMilliseconds?: 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.
  - Optional pollingIntervalMilliseconds?: number
    The polling interval, in milliseconds
  - Optional timeoutMilliseconds?: number
    The timeout, in milliseconds
Returns TransactionWatcher
- Defined in src/transactionWatcher.ts:46

Properties

`Protected` `Readonly` fetcher

fetcher: ITransactionFetcher

`Protected` `Readonly` patienceMilliseconds

patienceMilliseconds: number

`Protected` `Readonly` pollingIntervalMilliseconds

pollingIntervalMilliseconds: number

`Protected` `Readonly` timeoutMilliseconds

timeoutMilliseconds: number

`Static` DefaultPatience

DefaultPatience: number = 0

`Static` DefaultPollingInterval

DefaultPollingInterval: number = 6000

`Static` DefaultTimeout

DefaultTimeout: number = ...

Methods

awaitAllEvents

awaitAllEvents(transactionOrTxHash, events): Promise<ITransactionOnNetwork>
Parameters
- transactionOrTxHash: string | ITransaction
- events: string[]
Returns Promise<ITransactionOnNetwork>
- Defined in src/transactionWatcher.ts:97

awaitAnyEvent

awaitAnyEvent(transactionOrTxHash, events): Promise<ITransactionOnNetwork>
Parameters
- transactionOrTxHash: string | ITransaction
- events: string[]
Returns Promise<ITransactionOnNetwork>
- Defined in src/transactionWatcher.ts:118

awaitCompleted

awaitCompleted(transactionOrTxHash): Promise<ITransactionOnNetwork>
Waits until the transaction is completely processed.
Parameters
- transactionOrTxHash: string | ITransaction
Returns Promise<ITransactionOnNetwork>
- Defined in src/transactionWatcher.ts:80

`Protected` awaitConditionally

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

awaitOnCondition

awaitOnCondition(transactionOrTxHash, condition): Promise<ITransactionOnNetwork>
Parameters
- transactionOrTxHash: string | ITransaction
- condition: ((data) => boolean)
  - - (data): boolean
    - Parameters
      data: ITransactionOnNetwork
      Returns boolean
Returns Promise<ITransactionOnNetwork>
- Defined in src/transactionWatcher.ts:139

awaitPending

awaitPending(transactionOrTxHash): Promise<ITransactionOnNetwork>
Waits until the transaction reaches the "pending" status.
Parameters
- transactionOrTxHash: string | ITransaction
Returns Promise<ITransactionOnNetwork>
- Defined in src/transactionWatcher.ts:65

`Protected` getAllTransactionEvents

getAllTransactionEvents(transaction): ITransactionEvent[]
Parameters
- transaction: ITransactionOnNetwork
Returns ITransactionEvent[]
- Defined in src/transactionWatcher.ts:221

`Private` transactionOrTxHashToTxHash

transactionOrTxHashToTxHash(transactionOrTxHash): string
Parameters
- transactionOrTxHash: string | ITransaction
Returns string
- Defined in src/transactionWatcher.ts:152

`Static` NoopOnStatusReceived

NoopOnStatusReceived(_): void
Parameters
- _: ITransactionStatus
Returns void
- Defined in src/transactionWatcher.ts:30

Class TransactionWatcher

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional patienceMilliseconds?: number

Optional pollingIntervalMilliseconds?: number

Optional timeoutMilliseconds?: number

Returns TransactionWatcher

Properties

Protected Readonly fetcher

Protected Readonly patienceMilliseconds

Protected Readonly pollingIntervalMilliseconds

Protected Readonly timeoutMilliseconds

Static DefaultPatience

Static DefaultPollingInterval

Static DefaultTimeout

Methods

awaitAllEvents

Parameters

Returns Promise<ITransactionOnNetwork>

awaitAnyEvent

Parameters

Returns Promise<ITransactionOnNetwork>

awaitCompleted

Parameters

Returns Promise<ITransactionOnNetwork>

Protected awaitConditionally

Type Parameters

Parameters

Parameters

Returns boolean

Returns Promise<TData>

Returns Err

Returns Promise<TData>

awaitOnCondition

Parameters

Parameters

Returns boolean

Returns Promise<ITransactionOnNetwork>

awaitPending

Parameters

Returns Promise<ITransactionOnNetwork>

Protected getAllTransactionEvents

Parameters

Returns ITransactionEvent[]

Private transactionOrTxHashToTxHash

Parameters

Returns string

Static NoopOnStatusReceived

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` patienceMilliseconds?: number

`Optional` pollingIntervalMilliseconds?: number

`Optional` timeoutMilliseconds?: number

`Protected` `Readonly` fetcher

`Protected` `Readonly` patienceMilliseconds

`Protected` `Readonly` pollingIntervalMilliseconds

`Protected` `Readonly` timeoutMilliseconds

`Static` DefaultPatience

`Static` DefaultPollingInterval

`Static` DefaultTimeout

`Protected` awaitConditionally

`Protected` getAllTransactionEvents

`Private` transactionOrTxHashToTxHash

`Static` NoopOnStatusReceived