Class: HttpDataAccess

"http-data-access".HttpDataAccess

Exposes a Data-Access module over HTTP

Hierarchy

Implements

  • IDataAccess

Constructors

constructor

+ new HttpDataAccess(nodeConnectionConfig: AxiosRequestConfig): HttpDataAccess

Defined in request-client.js/src/http-data-access.ts:31

Creates an instance of HttpDataAccess.

Parameters:

NameTypeDefault valueDescription
nodeConnectionConfigAxiosRequestConfig{}Configuration options to connect to the node. Follows Axios configuration format.

Returns: HttpDataAccess

Properties

axiosConfig

Protected axiosConfig: AxiosRequestConfig

Defined in request-client.js/src/http-data-access.ts:31

Configuration that will be sent to axios for each request. We can also create a AxiosInstance with axios.create() but it dramatically complicates testing.

Methods

_getStatus

_getStatus(detailed?: boolean): Promise<any>

Defined in request-client.js/src/http-data-access.ts:213

Gets information from the node (version, files etc...)

Parameters:

NameTypeDescription
detailed?booleanif true get the list of files hashes

Returns: Promise<any>


getChannelsByMultipleTopics

getChannelsByMultipleTopics(topics: string[], updatedBetween?: ITimestampBoundaries): Promise<IReturnGetChannelsByTopic>

Defined in request-client.js/src/http-data-access.ts:187

Gets all the transactions of channel indexed by multiple topics from the node through HTTP.

Parameters:

NameTypeDescription
topicsstring[]topics to search for
updatedBetween?ITimestampBoundariesfilter timestamp boundaries

Returns: Promise<IReturnGetChannelsByTopic>


getChannelsByTopic

getChannelsByTopic(topic: string, updatedBetween?: ITimestampBoundaries): Promise<IReturnGetChannelsByTopic>

Defined in request-client.js/src/http-data-access.ts:160

Gets all the transactions of channel indexed by topic from the node through HTTP.

Parameters:

NameTypeDescription
topicstringtopic to search for
updatedBetween?ITimestampBoundariesfilter timestamp boundaries

Returns: Promise<IReturnGetChannelsByTopic>


getTransactionsByChannelId

getTransactionsByChannelId(channelId: string, timestampBoundaries?: ITimestampBoundaries): Promise<IReturnGetTransactions>

Defined in request-client.js/src/http-data-access.ts:133

Gets the transactions for a channel from the node through HTTP.

Parameters:

NameTypeDescription
channelIdstringThe channel id to search for
timestampBoundaries?ITimestampBoundariesfilter timestamp boundaries

Returns: Promise<IReturnGetTransactions>


initialize

initialize(): Promise<void>

Defined in request-client.js/src/http-data-access.ts:57

Initialize the module. Does nothing, exists only to implement IDataAccess

Returns: Promise<void>

nothing


persistTransaction

persistTransaction(transactionData: ITransaction, channelId: string, topics?: string[]): Promise<IReturnPersistTransaction>

Defined in request-client.js/src/http-data-access.ts:68

Persists a new transaction on a node through HTTP.

Parameters:

NameTypeDescription
transactionDataITransactionThe transaction data
channelIdstring-
topics?string[]The topics used to index the transaction

Returns: Promise<IReturnPersistTransaction>