Class NodeHttp

Node http repository.

since: 1.0

Hierarchy

Http
- NodeHttp

Implements

NodeRepository

Index

Constructors

constructor

Properties

fetchApi
url

Methods

Constructors

constructor

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

Overrides Http.constructor
- Defined in infrastructure/NodeHttp.ts:35
Constructor

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

Properties

Protected Optional Readonly fetchApi

fetchApi: any

fetch function to be used when performing rest requests.

Protected Readonly url

url: string

Base catapult-rest url

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?: NetworkType | Observable<NetworkType>): Observable<NetworkType>

Inherited from Http.createNetworkTypeObservable
- Defined in infrastructure/Http.ts:76
Parameters
- Optional networkType: NetworkType | Observable<NetworkType>
Returns Observable<NetworkType>

getNodeHealth

getNodeHealth(): Observable<NodeHealth>

Implementation of NodeRepository.getNodeHealth
- Defined in infrastructure/NodeHttp.ts:106
Gets blockchain server info.

Returns Observable<NodeHealth>

Observable

getNodeInfo

getNodeInfo(): Observable<NodeInfo>

Implementation of NodeRepository.getNodeInfo
- Defined in infrastructure/NodeHttp.ts:51
Supplies additional information about the application running on a node.

summary

Get the node information

Returns Observable<NodeInfo>

getNodePeers

getNodePeers(): Observable<NodeInfo[]>

Implementation of NodeRepository.getNodePeers
- Defined in infrastructure/NodeHttp.ts:59
Gets the list of peers visible by the node,

summary

Gets the list of peers visible by the node

Returns Observable<NodeInfo[]>

getNodeRoles

getNodeRoles(roleType: number): RoleType[]

- Defined in infrastructure/NodeHttp.ts:144
Return user friendly role type list

Parameters
- roleType: number
  
  combined node role types
Returns RoleType[]

getNodeTime

getNodeTime(): Observable<NodeTime>

Implementation of NodeRepository.getNodeTime
- Defined in infrastructure/NodeHttp.ts:67
Gets the node time at the moment the reply was sent and received.

summary

Get the node time

Returns Observable<NodeTime>

getServerInfo

getServerInfo(): Observable<ServerInfo>

Implementation of NodeRepository.getServerInfo
- Defined in infrastructure/NodeHttp.ts:95
Gets blockchain server info.

Returns Observable<ServerInfo>

Observable

getStorageInfo

getStorageInfo(): Observable<StorageInfo>

Implementation of NodeRepository.getStorageInfo
- Defined in infrastructure/NodeHttp.ts:84
Gets blockchain storage info.

Returns Observable<StorageInfo>

Observable

getUnlockedAccount

getUnlockedAccount(): Observable<string[]>

Implementation of NodeRepository.getUnlockedAccount
- Defined in infrastructure/NodeHttp.ts:114
Return unlocked harvesting account from node.

Returns Observable<string[]>

Observable<string[]>

Private toNodeInfo

toNodeInfo(nodeInfo: NodeInfoDTO): NodeInfo

- Defined in infrastructure/NodeHttp.ts:126
It maps NodeInfoDTO to NodeInfo

Parameters
- nodeInfo: NodeInfoDTO
  
  the dto object.
Returns NodeInfo

the model object

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