Skip to main content

HistoryModule

@liquidium/client


@liquidium/client / HistoryModule

Class: HistoryModule

Defined in: packages/client/src/modules/history/history.ts:42

User and protocol history data helpers.

Constructors​

Constructor​

new HistoryModule(apiClient): HistoryModule

Defined in: packages/client/src/modules/history/history.ts:43

Parameters​

apiClient​

ApiClient | undefined

Returns​

HistoryModule

Methods​

getLiquidationHistory()​

getLiquidationHistory(profileId, filters?): Promise<PaginatedResponse<UserLiquidationHistoryEntry>>

Defined in: packages/client/src/modules/history/history.ts:115

Returns liquidation history for a user.

Parameters​

profileId​

string

The Liquidium profile principal text.

filters?​

UserLiquidationHistoryFilters = {}

Optional pool, time range, and pagination filters.

Returns​

Promise<PaginatedResponse<UserLiquidationHistoryEntry>>

Paginated liquidation history entries.


getProtocolActivity()​

getProtocolActivity(filters?): Promise<ProtocolActivityEntry[]>

Defined in: packages/client/src/modules/history/history.ts:156

Returns recent protocol-wide lending activity across all users.

Parameters​

filters?​

ProtocolActivityFeedFilters = {}

Optional pool, operation, and limit filters.

Returns​

Promise<ProtocolActivityEntry[]>

Recent confirmed lending activity entries.


getUserTransactionHistory()​

getUserTransactionHistory(profileId, filters?): Promise<PaginatedResponse<UserTransactionHistoryEntry>>

Defined in: packages/client/src/modules/history/history.ts:63

Returns transaction history for a user.

Parameters​

profileId​

string

The Liquidium profile principal text.

filters?​

UserTransactionHistoryFilters = {}

Optional pool, operation, state, time range, and pagination filters.

Returns​

Promise<PaginatedResponse<UserTransactionHistoryEntry>>

Paginated user history entries.