Class FinalizationHttp

Chian http repository.

since: 1.0

Hierarchy

Http
- FinalizationHttp

Implements

FinalizationRepository

Index

Constructors

constructor

Properties

fetchApi
url

Methods

Constructors

constructor

new FinalizationHttp(url: string, fetchApi?: any): FinalizationHttp

Overrides Http.constructor
- Defined in infrastructure/FinalizationHttp.ts:37
Constructor

Parameters
- url: string
  
  Base catapult-rest url
- Optional fetchApi: any
  
  fetch function to be used when performing rest requests.
Returns FinalizationHttp

Properties

Protected Optional Readonly fetchApi

fetchApi: any

Protected Readonly url

url: string

Methods

Protected call

call<D, M>(remoteCall: Promise<D>, mapper: (value: D) => M): Observable<M>

Inherited from Http.call
- Defined in infrastructure/Http.ts:96
This method knows how to call, convert and handle exception when doing remote http operations.

Type parameters
- D
- M
Parameters
- remoteCall: Promise<D>
  
  the remote call
- mapper: (value: D) => M
  
  the mapper from dto to the model object.
  - - (value: D): M
    - Parameters
      - value: D
      Returns M
Returns Observable<M>

config

config(): Configuration

Inherited from Http.config
- Defined in infrastructure/Http.ts:86
Returns Configuration

createNetworkTypeObservable

createNetworkTypeObservable(networkType?: MAIN_NET | TEST_NET | MIJIN | MIJIN_TEST | PRIVATE | PRIVATE_TEST | Observable<NetworkType>): Observable<NetworkType>

Inherited from Http.createNetworkTypeObservable
- Defined in infrastructure/Http.ts:76
Parameters
- Optional networkType: MAIN_NET | TEST_NET | MIJIN | MIJIN_TEST | PRIVATE | PRIVATE_TEST | Observable<NetworkType>
Returns Observable<NetworkType>

getFinalizationProofAtEpoch

getFinalizationProofAtEpoch(epoch: number): Observable<FinalizationProof>

Implementation of FinalizationRepository.getFinalizationProofAtEpoch
- Defined in infrastructure/FinalizationHttp.ts:54
Gets finalization proof for the greatest height associated with the given epoch.

Parameters
- epoch: number
  
  Finalization epoch
Returns Observable<FinalizationProof>

Observable

getFinalizationProofAtHeight

getFinalizationProofAtHeight(height: UInt64): Observable<FinalizationProof>

Implementation of FinalizationRepository.getFinalizationProofAtHeight
- Defined in infrastructure/FinalizationHttp.ts:63
Gets finalization proof at the given height.

Parameters
- height: UInt64
  
  Block height
Returns Observable<FinalizationProof>

Observable

Static errorHandling

errorHandling(error: any): Promise<Error>

Inherited from Http.errorHandling
- Defined in infrastructure/Http.ts:35
Parameters
- error: any
Returns Promise<Error>

Generated using TypeDoc