TransactionHttp | symbol-sdk

Transaction http repository.

since: 1.0

Hierarchy

Http
- TransactionHttp

Implements

TransactionRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TransactionHttp(url: string): TransactionHttp

Overrides Http.constructor
- Defined in infrastructure/TransactionHttp.ts:58
Constructor

Parameters
- url: string
Returns TransactionHttp

Properties

Protected Readonly url

url: string

Methods

announce

announce(signedTransaction: SignedTransaction): Observable<TransactionAnnounceResponse>

Implementation of TransactionRepository.announce
- Defined in infrastructure/TransactionHttp.ts:109
Send a signed transaction

Parameters
- signedTransaction: SignedTransaction
  
  Signed transaction
Returns Observable<TransactionAnnounceResponse>

Observable

announceAggregateBonded

announceAggregateBonded(signedTransaction: SignedTransaction): Observable<TransactionAnnounceResponse>

Implementation of TransactionRepository.announceAggregateBonded
- Defined in infrastructure/TransactionHttp.ts:124
Send a signed transaction with missing signatures

Parameters
- signedTransaction: SignedTransaction
  
  Signed transaction
Returns Observable<TransactionAnnounceResponse>

Observable

announceAggregateBondedCosignature

announceAggregateBondedCosignature(cosignatureSignedTransaction: CosignatureSignedTransaction): Observable<TransactionAnnounceResponse>

Implementation of TransactionRepository.announceAggregateBondedCosignature
- Defined in infrastructure/TransactionHttp.ts:139
Send a cosignature signed transaction of an already announced transaction

Parameters
- cosignatureSignedTransaction: CosignatureSignedTransaction
  
  Cosignature signed transaction
Returns Observable<TransactionAnnounceResponse>

Observable

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

getTransaction

getTransaction(transactionId: string, transactionGroup: TransactionGroup): Observable<Transaction>

Implementation of TransactionRepository.getTransaction
- Defined in infrastructure/TransactionHttp.ts:78
Gets a transaction for a transactionId

Parameters
- transactionId: string
  
  Transaction id or hash.
- transactionGroup: TransactionGroup
  
  Transaction group.
Returns Observable<Transaction>

Observable

getTransactionEffectiveFee

getTransactionEffectiveFee(transactionId: string): Observable<number>

Implementation of TransactionRepository.getTransactionEffectiveFee
- Defined in infrastructure/TransactionHttp.ts:158
Gets a transaction's effective paid fee

Parameters
- transactionId: string
  
  Transaction id or hash.
Returns Observable<number>

Observable

getTransactionsById

getTransactionsById(transactionIds: string[]): Observable<Transaction[]>

Implementation of TransactionRepository.getTransactionsById
- Defined in infrastructure/TransactionHttp.ts:90
Gets an array of transactions for different transaction ids

Parameters
- transactionIds: string[]
  
  Array of transactions id and/or hash.
Returns Observable<Transaction[]>

Observable<Transaction[]>

queryParams

queryParams(queryParams?: QueryParams): any

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

search

search(criteria: TransactionSearchCriteria): Observable<Page<Transaction>>

Implementation of TransactionRepository.search
- Defined in infrastructure/TransactionHttp.ts:185
Returns an array of transactions.

summary

Get transactions

Parameters
- criteria: TransactionSearchCriteria
  
  Transaction search criteria
Returns Observable<Page<Transaction>>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Returns TransactionHttp

Properties

Protected Readonly url

Methods

announce

Parameters

signedTransaction: SignedTransaction

Returns Observable<TransactionAnnounceResponse>

announceAggregateBonded

Parameters

signedTransaction: SignedTransaction

Returns Observable<TransactionAnnounceResponse>

announceAggregateBondedCosignature

Parameters

cosignatureSignedTransaction: CosignatureSignedTransaction

Returns Observable<TransactionAnnounceResponse>

Protected call

Type parameters

D

M

Parameters

remoteCall: Promise<{ body: D; response: IncomingMessage }>

mapper: (value: D, index: number) => M

Parameters

value: D

index: number

Returns M

Returns Observable<M>

createNetworkTypeObservable

Parameters

Optional networkType: NetworkType | Observable<NetworkType>

Returns Observable<NetworkType>

errorHandling

Parameters

error: any

Returns Error

getTransaction

Parameters

transactionId: string

transactionGroup: TransactionGroup

Returns Observable<Transaction>

getTransactionEffectiveFee

Parameters

transactionId: string

Returns Observable<number>

getTransactionsById

Parameters

transactionIds: string[]

Returns Observable<Transaction[]>

queryParams

Parameters

Optional queryParams: QueryParams

Returns any

search

Parameters

criteria: TransactionSearchCriteria

Returns Observable<Page<Transaction>>