@1stdex/first-sdk 1.0.65 → 1.0.67

package/dist/types/entities/trade/apis/index.d.ts

@@ -0,0 +1,15 @@
+import { CHAIN_IDS } from '../../../constants/chain-configs/chain';
+import type { TradeHistoryResult } from '../types';
+/**
+ * Fetch trade history for a user from the subgraph
+ * @param chainId - chain id from {@link CHAIN_IDS}
+ * @param userAddress - The Ethereum address of the user
+ * @param options - Optional parameters for filtering and pagination
+ * @returns Trade history with pagination info
+ */
+export declare function fetchTradeHistoryFromSubgraph(chainId: CHAIN_IDS, userAddress: `0x${string}`, options?: {
+    tokenAddresses?: `0x${string}`[];
+    limit?: number | undefined;
+    cursor?: string | undefined;
+}): Promise<TradeHistoryResult>;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/entities/trade/apis/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/entities/trade/apis/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AAInE,OAAO,KAAK,EAAS,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAyF1D;;;;;;GAMG;AACH,wBAAsB,6BAA6B,CACjD,OAAO,EAAE,SAAS,EAClB,WAAW,EAAE,KAAK,MAAM,EAAE,EAC1B,OAAO,CAAC,EAAE;IACR,cAAc,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,GACA,OAAO,CAAC,kBAAkB,CAAC,CA6G7B"}

package/dist/types/entities/trade/types.d.ts

@@ -0,0 +1,18 @@
+import { CurrencyFlow } from '../currency/types';
+export type Trade = {
+    id: string;
+    type: 'buy' | 'sell';
+    usdAmount: string;
+    spent: CurrencyFlow;
+    taken: CurrencyFlow;
+    timestamp: number;
+    txHash: `0x${string}`;
+};
+export type TradeHistoryResult = {
+    trades: Trade[];
+    pageInfo: {
+        hasNextPage: boolean;
+        endCursor: string | null;
+    };
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/entities/trade/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/entities/trade/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,YAAY,CAAC;IACpB,KAAK,EAAE,YAAY,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,QAAQ,EAAE;QACR,WAAW,EAAE,OAAO,CAAC;QACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B,CAAC;CACH,CAAC"}

package/dist/types/types/index.d.ts

@@ -8,6 +8,7 @@ export type { DefaultReadContractOptions, DefaultWriteContractOptions, } from '.
 export type { Transaction } from './transaction';
 export type { PermitSignature, ERC20PermitParam } from './permit';
 export type { TransactionType, AnalyticsSnapshot, UserVolumeSnapshot, AnalyticsSummary, TopUser, } from '../entities/analytics/types';
+export type { Trade, TradeHistoryResult } from '../entities/trade/types';
 export declare enum CHART_LOG_INTERVALS {
     oneMinute = "1m",
     threeMinutes = "3m",

package/dist/types/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,YAAY,EACV,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,GACjB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChF,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC1D,YAAY,EACV,MAAM,EACN,cAAc,EACd,QAAQ,GACT,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACrD,YAAY,EACV,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAClE,YAAY,EACV,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,OAAO,GACR,MAAM,6BAA6B,CAAC;AAErC,oBAAY,mBAAmB;IAC7B,SAAS,OAAO;IAChB,YAAY,OAAO;IACnB,WAAW,OAAO;IAClB,UAAU,QAAQ;IAClB,cAAc,QAAQ;IACtB,aAAa,QAAQ;IACrB,OAAO,OAAO;IACd,QAAQ,OAAO;IACf,SAAS,OAAO;IAChB,QAAQ,OAAO;IACf,MAAM,OAAO;IACb,OAAO,OAAO;CACf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,YAAY,EACV,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,GACjB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChF,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC1D,YAAY,EACV,MAAM,EACN,cAAc,EACd,QAAQ,GACT,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACrD,YAAY,EACV,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAClE,YAAY,EACV,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,OAAO,GACR,MAAM,6BAA6B,CAAC;AACrC,YAAY,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAEzE,oBAAY,mBAAmB;IAC7B,SAAS,OAAO;IAChB,YAAY,OAAO;IACnB,WAAW,OAAO;IAClB,UAAU,QAAQ;IAClB,cAAc,QAAQ;IACtB,aAAa,QAAQ;IACrB,OAAO,OAAO;IACd,QAAQ,OAAO;IACf,SAAS,OAAO;IAChB,QAAQ,OAAO;IACf,MAAM,OAAO;IACb,OAAO,OAAO;CACf"}

package/dist/types/views/index.d.ts

@@ -10,4 +10,6 @@ export { getTradingBalance, getPortfolioBalance, getAllBalances, } from './balan
 export { checkTokenAllowances, needsVaultDeposit, getOrderSetupStatus, } from './setup';
 export { getBookPositionValue } from './book';
 export { getOrderPositionValue } from './order';
+export { getTradeHistory } from './trade-history';
+export { getUserVolumeUSD } from './user-volume';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/views/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/views/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,4BAA4B,EAC5B,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EACL,YAAY,EACZ,aAAa,EACb,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/views/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,4BAA4B,EAC5B,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EACL,YAAY,EACZ,aAAa,EACb,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}

package/dist/types/views/trade-history.d.ts

@@ -0,0 +1,41 @@
+import { CHAIN_IDS } from '../constants/chain-configs/chain';
+import { TradeHistoryResult } from '../entities/trade/types';
+/**
+ * Retrieves trade history for the specified user on the given chain.
+ *
+ * @param {CHAIN_IDS} chainId The chain ID.
+ * @param {`0x${string}`} userAddress The Ethereum address of the user.
+ * @param {`0x${string}`[]} tokenAddresses Optional. Filter trades where any of these addresses is either input or output token. If empty array or undefined, no filtering is applied.
+ * @param {number} limit Optional. Maximum number of trades to return per page (default: 50).
+ * @param {string} cursor Optional. Pagination cursor (timestamp) to fetch trades older than this cursor.
+ * @returns {Promise<TradeHistoryResult>} Promise resolving to trade history with pagination metadata.
+ * @example
+ * import { getTradeHistory } from '@1stdex/first-sdk'
+ *
+ * const history = await getTradeHistory({
+ *   chainId: 421614,
+ *   userAddress: '0x5F79EE8f8fA862E98201120d83c4eC39D9468D49'
+ * })
+ *
+ * // Fetch next page
+ * const nextPage = await getTradeHistory({
+ *   chainId: 421614,
+ *   userAddress: '0x5F79EE8f8fA862E98201120d83c4eC39D9468D49',
+ *   cursor: history.pageInfo.endCursor
+ * })
+ *
+ * // Filter by tokens
+ * const usdcTrades = await getTradeHistory({
+ *   chainId: 421614,
+ *   userAddress: '0x5F79EE8f8fA862E98201120d83c4eC39D9468D49',
+ *   tokenAddresses: ['0x036CbD53842c5426634e7929541eC2318f3dCF7e']
+ * })
+ */
+export declare const getTradeHistory: ({ chainId, userAddress, tokenAddresses, limit, cursor, }: {
+    chainId: CHAIN_IDS;
+    userAddress: `0x${string}`;
+    tokenAddresses?: `0x${string}`[];
+    limit?: number;
+    cursor?: string;
+}) => Promise<TradeHistoryResult>;
+//# sourceMappingURL=trade-history.d.ts.map

package/dist/types/views/trade-history.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trade-history.d.ts","sourceRoot":"","sources":["../../../src/views/trade-history.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,eAAe,6DAMzB;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,cAAc,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KAAG,QAAQ,kBAAkB,CAM7B,CAAC"}

package/dist/types/views/user-volume.d.ts

@@ -0,0 +1,21 @@
+import { CHAIN_IDS } from '../constants/chain-configs/chain';
+/**
+ * Retrieves the total volume in USD for a given user address.
+ *
+ * @param {CHAIN_IDS} chainId The chain ID.
+ * @param {`0x${string}`} userAddress The Ethereum address of the user.
+ * @returns {Promise<string>} Promise resolving to the user's total volume in USD.
+ * @example
+ * import { getUserVolumeUSD } from '@1stdex/first-sdk'
+ *
+ * const volumeUSD = await getUserVolumeUSD({
+ *   chainId: 421614,
+ *   userAddress: '0x5F79EE8f8fA862E98201120d83c4eC39D9468D49'
+ * })
+ * console.log(`User volume: $${volumeUSD}`)
+ */
+export declare const getUserVolumeUSD: ({ chainId, userAddress, }: {
+    chainId: CHAIN_IDS;
+    userAddress: `0x${string}`;
+}) => Promise<string>;
+//# sourceMappingURL=user-volume.d.ts.map

package/dist/types/views/user-volume.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-volume.d.ts","sourceRoot":"","sources":["../../../src/views/user-volume.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAW7D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,8BAG1B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;CAC5B,KAAG,QAAQ,MAAM,CAmBjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1stdex/first-sdk",
-  "version": "1.0.65",
+  "version": "1.0.67",
   "description": "🛠 An SDK for building applications on top of 1st V2",
   "files": [
     "dist"