Class BlockHttp

Blockchain http repository.

since: 1.0

Hierarchy

Http
- BlockHttp

Implements

BlockRepository

Index

Constructors

constructor

Properties

fetchApi
url

Methods

Constructors

constructor

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

Overrides Http.constructor
- Defined in infrastructure/BlockHttp.ts:41
Constructor

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

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:110
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:101
Returns Configuration

createNetworkTypeObservable

createNetworkTypeObservable(networkType?: NetworkType | Observable<NetworkType>): Observable<NetworkType>

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

getBlockByHeight

getBlockByHeight(height: UInt64): Observable<BlockInfo>

Implementation of BlockRepository.getBlockByHeight
- Defined in infrastructure/BlockHttp.ts:58
Gets a BlockInfo for a given block height

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

Observable

getMerkleTransaction

getMerkleTransaction(height: UInt64, hash: string): Observable<MerkleProofInfo>

Implementation of BlockRepository.getMerkleTransaction
- Defined in infrastructure/BlockHttp.ts:130
Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block. The path is the complementary data needed to calculate the merkle root. A client can compare if the calculated root equals the one recorded in the block header, verifying that the transaction was included in the block.

Parameters
- height: UInt64
  
  The height of the block.
- hash: string
  
  The hash of the transaction.
Returns Observable<MerkleProofInfo>

Observable

queryParams

queryParams(queryParams?: QueryParams): any

Inherited from Http.queryParams
- Defined in infrastructure/Http.ts:93
Parameters
- Optional queryParams: QueryParams
Returns any

search

search(criteria: BlockSearchCriteria): Observable<Page<BlockInfo>>

Implementation of BlockRepository.search
- Defined in infrastructure/BlockHttp.ts:67
Gets an array of bocks.

Parameters
- criteria: BlockSearchCriteria
  
  Block search criteria
Returns Observable<Page<BlockInfo>>

Observable<BlockInfo[]>

Static errorHandling

errorHandling(error: any): Observable<never>

Inherited from Http.errorHandling
- Defined in infrastructure/Http.ts:36
Parameters
- error: any
Returns Observable<never>

Generated using TypeDoc