core: actions, query: expose limit param for getOrderHistory & getTas…

…kHistory (#149) * core: actions, query: expose limit param for getOrderHistory & getTaskHistory * chore: version packages
renegade-fi · Jan 9, 2025 · 4b52216 · 4b52216
1 parent dea5932
commit 4b52216
Show file tree

Hide file tree

Showing 16 changed files with 90 additions and 33 deletions.
diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @renegade-fi/core
 
+## 0.4.15
+
+### Patch Changes
+
+- expose history length params & useQuery util
+
 ## 0.4.14
 
 ### Patch Changes

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@renegade-fi/core",
   "description": "VanillaJS library for Renegade",
-  "version": "0.4.14",
+  "version": "0.4.15",
   "repository": {
     "type": "git",
     "url": "https://github.com/renegade-fi/typescript-sdk.git",

diff --git a/packages/core/src/actions/getTaskHistory.ts b/packages/core/src/actions/getTaskHistory.ts
@@ -2,24 +2,36 @@ import { getWalletId } from './getWalletId.js'
 
 import { getRelayerWithAuth } from '../utils/http.js'
 
-import { TASK_HISTORY_ROUTE } from '../constants.js'
+import { TASK_HISTORY_LEN_PARAM, TASK_HISTORY_ROUTE } from '../constants.js'
 import type { RenegadeConfig } from '../createConfig.js'
 import { BaseError, type BaseErrorType } from '../errors/base.js'
 import type { Task as TaskHistoryItem } from '../types/task.js'
 
+export type GetTaskHistoryParameters = {
+  limit?: number
+}
+
 export type GetTaskHistoryReturnType = Map<string, TaskHistoryItem>
 
 export type GetTaskHistoryErrorType = BaseErrorType
 
 export async function getTaskHistory(
   config: RenegadeConfig,
+  parameters: GetTaskHistoryParameters = {},
 ): Promise<GetTaskHistoryReturnType> {
   const { getBaseUrl } = config
+  const { limit } = parameters
   const walletId = getWalletId(config)
-  const res = await getRelayerWithAuth(
-    config,
-    getBaseUrl(TASK_HISTORY_ROUTE(walletId)),
-  )
+  let url = getBaseUrl(TASK_HISTORY_ROUTE(walletId))
+
+  if (limit !== undefined) {
+    const searchParams = new URLSearchParams({
+      [TASK_HISTORY_LEN_PARAM]: limit.toString(),
+    })
+    url += `?${searchParams.toString()}`
+  }
+  const res = await getRelayerWithAuth(config, url)
+
   if (!res.tasks) {
     throw new BaseError('No tasks found')
   }

diff --git a/packages/core/src/constants.ts b/packages/core/src/constants.ts
@@ -115,6 +115,9 @@ export const GET_TASK_QUEUE_ROUTE = (wallet_id: string) =>
 /// The route to fetch task history for a wallet
 export const TASK_HISTORY_ROUTE = (wallet_id: string) =>
   `/wallet/${wallet_id}/task-history`
+/// The name of the query parameter specifying the length of the task history
+/// to return
+export const TASK_HISTORY_LEN_PARAM = 'task_history_len'
 
 ////////////////////////////////////////////////////////////////////////////////
 // Health check

diff --git a/packages/core/src/exports/actions.ts b/packages/core/src/exports/actions.ts
@@ -150,6 +150,7 @@ export {
 export {
   type GetTaskHistoryErrorType,
   type GetTaskHistoryReturnType,
+  type GetTaskHistoryParameters,
   getTaskHistory,
 } from '../actions/getTaskHistory.js'
 

diff --git a/packages/core/src/exports/index.ts b/packages/core/src/exports/index.ts
@@ -143,6 +143,7 @@ export {
 export {
   type GetTaskHistoryErrorType,
   type GetTaskHistoryReturnType,
+  type GetTaskHistoryParameters,
   getTaskHistory,
 } from '../actions/getTaskHistory.js'
 

diff --git a/packages/core/src/query/getOrderHistory.ts b/packages/core/src/query/getOrderHistory.ts
@@ -1,23 +1,26 @@
 import type { QueryOptions } from '@tanstack/query-core'
 import {
   type GetOrderHistoryErrorType,
+  type GetOrderHistoryParameters,
   type GetOrderHistoryReturnType,
   getOrderHistory,
 } from '../actions/getOrderHistory.js'
 import type { Config } from '../createConfig.js'
 import type { Evaluate } from '../types/utils.js'
 import { type ScopeKeyParameter, filterQueryOptions } from './utils.js'
 
-export type GetOrderHistoryOptions = Evaluate<ScopeKeyParameter>
+export type GetOrderHistoryOptions = Evaluate<
+  GetOrderHistoryParameters & ScopeKeyParameter
+>
 
 export function getOrderHistoryQueryOptions(
   config: Config,
   options: GetOrderHistoryOptions = {},
 ) {
   return {
     async queryFn({ queryKey }) {
-      const { scopeKey: _ } = queryKey[1]
-      const history = await getOrderHistory(config)
+      const { scopeKey: _, ...parameters } = queryKey[1]
+      const history = await getOrderHistory(config, parameters)
       return history ?? null
     },
     queryKey: getOrderHistoryQueryKey({

diff --git a/packages/core/src/query/getTaskHistory.ts b/packages/core/src/query/getTaskHistory.ts
@@ -1,23 +1,26 @@
 import type { QueryOptions } from '@tanstack/query-core'
 import {
   type GetTaskHistoryErrorType,
+  type GetTaskHistoryParameters,
   type GetTaskHistoryReturnType,
   getTaskHistory,
 } from '../actions/getTaskHistory.js'
 import type { Config } from '../createConfig.js'
 import type { Evaluate } from '../types/utils.js'
 import { type ScopeKeyParameter, filterQueryOptions } from './utils.js'
 
-export type GetTaskHistoryOptions = Evaluate<ScopeKeyParameter>
+export type GetTaskHistoryOptions = Evaluate<
+  GetTaskHistoryParameters & ScopeKeyParameter
+>
 
 export function getTaskHistoryQueryOptions(
   config: Config,
   options: GetTaskHistoryOptions = {},
 ) {
   return {
     async queryFn({ queryKey }) {
-      const { scopeKey: _ } = queryKey[1]
-      const history = await getTaskHistory(config)
+      const { scopeKey: _, ...parameters } = queryKey[1]
+      const history = await getTaskHistory(config, parameters)
       return history ?? null
     },
     queryKey: getTaskHistoryQueryKey({

diff --git a/packages/core/src/utils.d.ts b/packages/core/src/utils.d.ts
@@ -1,24 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
-* @param {Function} sign_message
-* @returns {Promise<any>}
-*/
-export function generate_wallet_secrets(sign_message: Function): Promise<any>;
-/**
-* @param {string} path
-* @param {any} headers
-* @param {string} body
-* @param {string} key
-* @returns {string}
-*/
-export function create_request_signature(path: string, headers: any, body: string, key: string): string;
-/**
-* @param {string} b64_key
-* @returns {string}
-*/
-export function b64_to_hex_hmac_key(b64_key: string): string;
-/**
 * @param {string} seed
 * @returns {any}
 */
@@ -158,6 +140,24 @@ export function assemble_external_match(do_gas_estimation: boolean, updated_orde
 */
 export function create_external_wallet(wallet_id: string, blinder_seed: string, share_seed: string, pk_root: string, sk_match: string, symmetric_key: string): Promise<any>;
 /**
+* @param {Function} sign_message
+* @returns {Promise<any>}
+*/
+export function generate_wallet_secrets(sign_message: Function): Promise<any>;
+/**
+* @param {string} path
+* @param {any} headers
+* @param {string} body
+* @param {string} key
+* @returns {string}
+*/
+export function create_request_signature(path: string, headers: any, body: string, key: string): string;
+/**
+* @param {string} b64_key
+* @returns {string}
+*/
+export function b64_to_hex_hmac_key(b64_key: string): string;
+/**
 * @param {string} wallet_id
 * @param {string} blinder_seed
 * @param {string} share_seed

diff --git a/packages/node/CHANGELOG.md b/packages/node/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @renegade-fi/node
 
+## 0.4.15
+
+### Patch Changes
+
+- Updated dependencies
+  - @renegade-fi/core@0.4.15
+
 ## 0.4.14
 
 ### Patch Changes

diff --git a/packages/node/package.json b/packages/node/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@renegade-fi/node",
   "description": "Node.js library for Renegade",
-  "version": "0.4.14",
+  "version": "0.4.15",
   "repository": {
     "type": "git",
     "url": "https://github.com/renegade-fi/typescript-sdk.git",

diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @renegade-fi/react
 
+## 0.4.16
+
+### Patch Changes
+
+- expose history length params & useQuery util
+- Updated dependencies
+  - @renegade-fi/core@0.4.15
+
 ## 0.4.15
 
 ### Patch Changes

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@renegade-fi/react",
   "description": "React library for Renegade",
-  "version": "0.4.15",
+  "version": "0.4.16",
   "repository": {
     "type": "git",
     "url": "https://github.com/renegade-fi/typescript-sdk.git",

diff --git a/packages/react/src/exports/index.ts b/packages/react/src/exports/index.ts
@@ -205,6 +205,12 @@ export {
   type UseWithdrawReturnType,
 } from '../hooks/useWithdraw.js'
 
+////////////////////////////////////////////////////////////////////////////////
+// Utils
+////////////////////////////////////////////////////////////////////////////////
+
+export { useQuery } from '../utils/query.js'
+
 ////////////////////////////////////////////////////////////////////////////////
 // @renegade/core
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/packages/test/CHANGELOG.md b/packages/test/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @renegade-fi/test
 
+## 0.3.14
+
+### Patch Changes
+
+- Updated dependencies
+  - @renegade-fi/core@0.4.15
+
 ## 0.3.13
 
 ### Patch Changes

diff --git a/packages/test/package.json b/packages/test/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@renegade-fi/test",
-  "version": "0.3.13",
+  "version": "0.3.14",
   "description": "Testing helpers for Renegade",
   "private": true,
   "files": [