Class BlockHttp

Blockchain http repository.

since: 1.0

Hierarchy

Http
- BlockHttp

Implements

BlockRepository

Index

Constructors

constructor

Properties

url

Methods

Constructors

constructor

new BlockHttp(url: string): BlockHttp

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

Parameters
- url: string
Returns BlockHttp

Properties

Protected url

url: string

Methods

Protected call

call<D, M>(remoteCall: Promise<{ body: D; response: IncomingMessage }>, mapper: (value: D, index: number) => M): Observable<M>

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

Type parameters
- D
- M
Parameters
- remoteCall: Promise<{ body: D; response: IncomingMessage }>
  
  the remote call
- mapper: (value: D, index: number) => M
  
  the mapper from dto to the model object.
  - - (value: D, index: number): M
    - Parameters
      - value: D
      - index: number
      Returns M
Returns Observable<M>

createNetworkTypeObservable

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

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

errorHandling

errorHandling(error: any): Error

Inherited from Http.errorHandling
- Defined in infrastructure/Http.ts:68
Parameters
- error: any
Returns Error

getBlockByHeight

getBlockByHeight(height: UInt64): Observable<BlockInfo>

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

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

Observable

getBlockTransactions

getBlockTransactions(height: UInt64, queryParams?: QueryParams): Observable<Transaction[]>

Implementation of BlockRepository.getBlockTransactions
- Defined in infrastructure/BlockHttp.ts:67
Gets array of transactions included in a block for a block height

Parameters
- height: UInt64
  
  Block height
- Optional queryParams: QueryParams
  
  (Optional) Query params
Returns Observable<Transaction[]>

Observable<Transaction[]>

getBlocksByHeightWithLimit

getBlocksByHeightWithLimit(height: UInt64, limit: number): Observable<BlockInfo[]>

Implementation of BlockRepository.getBlocksByHeightWithLimit
- Defined in infrastructure/BlockHttp.ts:88
Gets array of BlockInfo for a block height with limit

Parameters
- height: UInt64
  
  Block height from which will be the first block in the array
- limit: number
  
  Number of blocks returned.
Returns Observable<BlockInfo[]>

Observable<BlockInfo[]>

getMerkleTransaction

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

Implementation of BlockRepository.getMerkleTransaction
- Defined in infrastructure/BlockHttp.ts:136
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:54
Parameters
- Optional queryParams: QueryParams
Returns any

transactionFilter

transactionFilter(filter?: TransactionFilter): any

Inherited from Http.transactionFilter
- Defined in infrastructure/Http.ts:62
Parameters
- Optional filter: TransactionFilter
Returns any

Generated using TypeDoc