Class NetworkHttp

Network http repository.

since: 1.0

Hierarchy

Http
- NetworkHttp

Implements

NetworkRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overrides Http.constructor
- Defined in infrastructure/NetworkHttp.ts:56
Constructor

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

Properties

Protected Optional Readonly fetchApi

fetchApi: any

Private Readonly networkRoutesApi

networkRoutesApi: NetworkRoutesApi

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>

getNetworkName

getNetworkName(): Observable<NetworkName>

Implementation of NetworkRepository.getNetworkName
- Defined in infrastructure/NetworkHttp.ts:83
Get current network type name and description

Returns Observable<NetworkName>

current network type name and description

getNetworkProperties

getNetworkProperties(): Observable<NetworkConfiguration>

Implementation of NetworkRepository.getNetworkProperties
- Defined in infrastructure/NetworkHttp.ts:93
Returns the content from a catapult-server network configuration file (resources/config-network.properties). To enable this feature, the REST setting "network.propertiesFilePath" must define where the file is located. This is adjustable via the configuration file (rest/resources/rest.json) per REST instance.

summary

Get the network properties

Returns Observable<NetworkConfiguration>

getNetworkType

getNetworkType(): Observable<NetworkType>

Implementation of NetworkRepository.getNetworkType
- Defined in infrastructure/NetworkHttp.ts:74
Get current network identifier.

Returns Observable<NetworkType>

network identifier.

getRentalFees

getRentalFees(): Observable<RentalFees>

Implementation of NetworkRepository.getRentalFees
- Defined in infrastructure/NetworkHttp.ts:103
Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available if the REST instance has access to catapult-server resources/config-network.properties file. To activate this feature, add the setting "network.propertiesFilePath" in the configuration file (rest/resources/rest.json).

summary

Get rental fees information

Returns Observable<RentalFees>

getTransactionFees

getTransactionFees(): Observable<TransactionFees>

Implementation of NetworkRepository.getTransactionFees
- Defined in infrastructure/NetworkHttp.ts:121
Returns information about the average, median, highest and lower fee multiplier over the last "numBlocksTransactionFeeStats". The setting "numBlocksTransactionFeeStats" is adjustable via a configuration file (rest/resources/rest.json) per REST instance.

summary

Get transaction fees information

Returns Observable<TransactionFees>

Private mapNetworkConfigurationDto

mapNetworkConfigurationDto(dto: NetworkConfigurationDTO): NetworkConfiguration

- Defined in infrastructure/NetworkHttp.ts:139
Map dto to sdk models

Parameters
- dto: NetworkConfigurationDTO
  
  dto object returned from rest
Returns NetworkConfiguration

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