Class ReceiptHttp

Receipt http repository.

since: 1.0

Hierarchy

Http
- ReceiptHttp

Implements

ReceiptRepository

Index

Constructors

constructor

Properties

url

Methods

Constructors

constructor

new ReceiptHttp(url: string, networkType?: NetworkType | Observable<NetworkType>): ReceiptHttp

Overrides Http.constructor
- Defined in infrastructure/ReceiptHttp.ts:45
Constructor

Parameters
- url: string
- Optional networkType: NetworkType | Observable<NetworkType>
Returns ReceiptHttp

Properties

Protected Readonly 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:88
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:62
Parameters
- error: any
Returns Error

getBlockReceipts

getBlockReceipts(height: UInt64): Observable<Statement>

Implementation of ReceiptRepository.getBlockReceipts
- Defined in infrastructure/ReceiptHttp.ts:82
Gets an array receipts for a block height.

Parameters
- height: UInt64
  
  Block height from which will be the first block in the array
Returns Observable<Statement>

Observable

getMerkleReceipts

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

Implementation of ReceiptRepository.getMerkleReceipts
- Defined in infrastructure/ReceiptHttp.ts:69
Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to 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 receipt was linked with the block.

Parameters
- height: UInt64
  
  The height of the block.
- hash: string
  
  The hash of the receipt statement or resolution.
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

Generated using TypeDoc