AccountHttp | symbol-sdk

Account http repository.

since: 1.0

Hierarchy

Http
- AccountHttp

Implements

AccountRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AccountHttp(url: string): AccountHttp

Overrides Http.constructor
- Defined in infrastructure/AccountHttp.ts:43
Constructor

Parameters
- url: string
Returns AccountHttp

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:93
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:40
Parameters
- Optional networkType: NetworkType | Observable<NetworkType>
Returns Observable<NetworkType>

errorHandling

errorHandling(error: any): Error

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

getAccountIncomingTransactions

getAccountIncomingTransactions(address: Address, queryParams?: QueryParams, transactionFilter?: TransactionFilter): Observable<Transaction[]>

Implementation of AccountRepository.getAccountIncomingTransactions
- Defined in infrastructure/AccountHttp.ts:135
Gets an array of transactions for which an account is the recipient of a transaction. A transaction is said to be incoming with respect to an account if the account is the recipient of a transaction.

Parameters
- address: Address
  - Address can be created rawAddress or publicKey
- Optional queryParams: QueryParams
  
  (Optional) Query params
- Optional transactionFilter: TransactionFilter
  
  (Optional) Transaction filter
Returns Observable<Transaction[]>

Observable<Transaction[]>

getAccountInfo

getAccountInfo(address: Address): Observable<AccountInfo>

Implementation of AccountRepository.getAccountInfo
- Defined in infrastructure/AccountHttp.ts:60
Gets an AccountInfo for an account.

Parameters
- address: Address
  
  Address
Returns Observable<AccountInfo>

Observable

getAccountOutgoingTransactions

getAccountOutgoingTransactions(address: Address, queryParams?: QueryParams, transactionFilter?: TransactionFilter): Observable<Transaction[]>

Implementation of AccountRepository.getAccountOutgoingTransactions
- Defined in infrastructure/AccountHttp.ts:154
Gets an array of transactions for which an account is the sender a transaction. A transaction is said to be outgoing with respect to an account if the account is the sender of a transaction.

Parameters
- address: Address
  - Address can be created rawAddress or publicKey
- Optional queryParams: QueryParams
  
  (Optional) Query params
- Optional transactionFilter: TransactionFilter
  
  (Optional) Transaction filter
Returns Observable<Transaction[]>

Observable<Transaction[]>

getAccountPartialTransactions

getAccountPartialTransactions(address: Address, queryParams?: QueryParams, transactionFilter?: TransactionFilter): Observable<AggregateTransaction[]>

Implementation of AccountRepository.getAccountPartialTransactions
- Defined in infrastructure/AccountHttp.ts:193
Gets an array of transactions for which an account is the sender or has sign the transaction. A transaction is said to be aggregate bonded with respect to an account if there are missing signatures.

Parameters
- address: Address
  - Address can be created rawAddress or publicKey
- Optional queryParams: QueryParams
  
  (Optional) Query params
- Optional transactionFilter: TransactionFilter
  
  (Optional) Transaction filter
Returns Observable<AggregateTransaction[]>

Observable<AggregateTransaction[]>

getAccountTransactions

getAccountTransactions(address: Address, queryParams?: QueryParams, transactionFilter?: TransactionFilter): Observable<Transaction[]>

Implementation of AccountRepository.getAccountTransactions
- Defined in infrastructure/AccountHttp.ts:115
Gets an array of confirmed transactions for which an account is signer or receiver.

Parameters
- address: Address
  - Address can be created rawAddress or publicKey
- Optional queryParams: QueryParams
  
  (Optional) Query params
- Optional transactionFilter: TransactionFilter
  
  (Optional) Transaction filter
Returns Observable<Transaction[]>

Observable<Transaction[]>

getAccountUnconfirmedTransactions

getAccountUnconfirmedTransactions(address: Address, queryParams?: QueryParams, transactionFilter?: TransactionFilter): Observable<Transaction[]>

Implementation of AccountRepository.getAccountUnconfirmedTransactions
- Defined in infrastructure/AccountHttp.ts:174
Gets the array of transactions for which an account is the sender or receiver and which have not yet been included in a block. Unconfirmed transactions are those transactions that have not yet been included in a block. Unconfirmed transactions are not guaranteed to be included in any block.

Parameters
- address: Address
  - Address can be created rawAddress or publicKey
- Optional queryParams: QueryParams
  
  (Optional) Query params
- Optional transactionFilter: TransactionFilter
  
  (Optional) Transaction filter
Returns Observable<Transaction[]>

Observable<Transaction[]>

getAccountsInfo

getAccountsInfo(addresses: Address[]): Observable<AccountInfo[]>

Implementation of AccountRepository.getAccountsInfo
- Defined in infrastructure/AccountHttp.ts:69
Gets AccountsInfo for different accounts.

Parameters
- addresses: Address[]
  
  List of Address
Returns Observable<AccountInfo[]>

Observable<AccountInfo[]>

queryParams

queryParams(queryParams?: QueryParams): any

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

transactionFilter

transactionFilter(filter?: TransactionFilter): any

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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Returns AccountHttp

Properties

Protected url

Methods

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

getAccountIncomingTransactions

Parameters

address: Address

Optional queryParams: QueryParams

Optional transactionFilter: TransactionFilter

Returns Observable<Transaction[]>

getAccountInfo

Parameters

address: Address

Returns Observable<AccountInfo>

getAccountOutgoingTransactions

Parameters

address: Address

Optional queryParams: QueryParams

Optional transactionFilter: TransactionFilter

Returns Observable<Transaction[]>

getAccountPartialTransactions

Parameters

address: Address

Optional queryParams: QueryParams

Optional transactionFilter: TransactionFilter

Returns Observable<AggregateTransaction[]>

getAccountTransactions

Parameters

address: Address

Optional queryParams: QueryParams

Optional transactionFilter: TransactionFilter

Returns Observable<Transaction[]>

getAccountUnconfirmedTransactions

Parameters

address: Address

Optional queryParams: QueryParams

Optional transactionFilter: TransactionFilter

Returns Observable<Transaction[]>

getAccountsInfo

Parameters

addresses: Address[]

Returns Observable<AccountInfo[]>

queryParams

Parameters

Optional queryParams: QueryParams

Returns any

transactionFilter

Parameters

Optional filter: TransactionFilter

Returns any