@liberfi.io/types 0.1.179 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -23
- package/dist/index.d.mts +252 -10
- package/dist/index.d.ts +252 -10
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2 -2
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -43,26 +43,29 @@ No peer dependencies required.
|
|
|
43
43
|
| `TokenLiquidity` | Liquidity pool info: pool/pair address, protocol, TVL. |
|
|
44
44
|
| `TokenSecurity` | Security flags: transfer fee, freezable, closable, transferable. |
|
|
45
45
|
| `TokenCandle` | OHLCV candlestick data point with resolution and timestamp. |
|
|
46
|
-
| `TokenHolder` | Single holder: address, amount, USD value, holding ratio.
|
|
46
|
+
| `TokenHolder` | Single holder: address, amount, USD value, holding ratio. Phase 3: `tags`, `lastActiveAt`, `startHoldingAt`. |
|
|
47
|
+
| `HolderTag` | Classification tag for a holder (`kol` / `smart` / `sniper` / `dev` / `bundle` / `bluechip` / `(string & {})`). |
|
|
47
48
|
|
|
48
49
|
### Domain Interfaces — Activity
|
|
49
50
|
|
|
50
|
-
| Type | Description
|
|
51
|
-
| --------------- |
|
|
52
|
-
| `Activity` | On-chain activity record (trade, liquidity, red packet).
|
|
53
|
-
| `ActivityToken` | Token within an activity: address, symbol, amount, USD values.
|
|
54
|
-
| `ActivityDex` | DEX where the activity occurred: name, image, protocol family, program address.
|
|
55
|
-
| `
|
|
51
|
+
| Type | Description |
|
|
52
|
+
| --------------- | ----------------------------------------------------------------------------------------- | -------- |
|
|
53
|
+
| `Activity` | On-chain activity record (trade, liquidity, red packet). Phase 3: `gasFee`, `traderTags`. |
|
|
54
|
+
| `ActivityToken` | Token within an activity: address, symbol, amount, USD values. |
|
|
55
|
+
| `ActivityDex` | DEX where the activity occurred: name, image, protocol family, program address. |
|
|
56
|
+
| `TraderTag` | Classification tag for an activity's trader (same vocabulary as `HolderTag`). |
|
|
57
|
+
| `Trade` | Narrowed subset of `Activity` with `type: "buy" | "sell"`. |
|
|
56
58
|
|
|
57
59
|
### Domain Interfaces — Wallet & Portfolio
|
|
58
60
|
|
|
59
|
-
| Type | Description
|
|
60
|
-
| --------------------- |
|
|
61
|
-
| `Portfolio` | Wallet's token holding: price, amount, decimals
|
|
62
|
-
| `
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
61
|
+
| Type | Description |
|
|
62
|
+
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
63
|
+
| `Portfolio` | Wallet's token holding: price, amount, decimals. Phase 3: `isActive`, `avgCostUsd`, `lastActiveAt`, `walletTokenTags`. |
|
|
64
|
+
| `WalletTokenTag` | Classification tag applied to a wallet-token relationship (e.g. `held`, `sold`, `bluechip`). |
|
|
65
|
+
| `PortfolioPnl` | Per-token PnL details: buy/sell volumes, avg prices, realized/unrealized profit. Phase 3: `isClosed`, `firstBuyAt`, `lastSellAt`. |
|
|
66
|
+
| `WalletPnl` | Wallet-level PnL summary: win rate, total trades, profit breakdown. |
|
|
67
|
+
| `WalletPortfolioPnls` | Paginated portfolio PnL list with wallet-level summary (extends `WalletPnl` + `CursorPagination`). |
|
|
68
|
+
| `WalletPortfolios` | Paginated wallet portfolios with total balance (extends `CursorPagination`). |
|
|
66
69
|
|
|
67
70
|
### API Contract — Pagination
|
|
68
71
|
|
|
@@ -74,15 +77,17 @@ No peer dependencies required.
|
|
|
74
77
|
|
|
75
78
|
### API Contract — Query Options
|
|
76
79
|
|
|
77
|
-
| Type
|
|
78
|
-
|
|
|
79
|
-
| `GetTokenCandlesOptions`
|
|
80
|
-
| `GetTokenListOptions`
|
|
81
|
-
| `SearchTokensOptions`
|
|
82
|
-
| `SearchTokenCursorList`
|
|
83
|
-
| `TokenFilterOption`
|
|
84
|
-
| `GetTradesOptions`
|
|
85
|
-
| `GetActivitiesOptions`
|
|
80
|
+
| Type | Description |
|
|
81
|
+
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
82
|
+
| `GetTokenCandlesOptions` | Candle query options: `after`, `before` (Date), `limit`. |
|
|
83
|
+
| `GetTokenListOptions` | Token list options: `sortBy`, `sortDirection`, `filters`, `keywords`, `excludeKeywords`. |
|
|
84
|
+
| `SearchTokensOptions` | Search options (extends `CursorListOptions`): `chains`, `keyword`, `filters`, `sortBy`, `sortDirection`. |
|
|
85
|
+
| `SearchTokenCursorList` | Search result (extends `CursorList<Token>`): adds `total` count and `extra` metadata. |
|
|
86
|
+
| `TokenFilterOption` | Filter descriptor: `field` (TokenFieldOption), `operator` (eq/gt/between/in/…), `value`. |
|
|
87
|
+
| `GetTradesOptions` | Trade query options (extends `CursorListOptions`): `before`, `after`, `beforeBlockHeight`, `afterBlockHeight`, `type`, `poolAddress`. |
|
|
88
|
+
| `GetActivitiesOptions` | Activity query options (extends `CursorListOptions`): time/block filters plus `type`, and (Phase 3) `sortBy` (`timestamp` / `totalUsd`). |
|
|
89
|
+
| `GetTokenHoldersOptions` | Token holder query options (extends `CursorListOptions`): Phase 3 `sortBy` (`amount` / `usd` / `ratio` / `lastActiveAt`). |
|
|
90
|
+
| `GetWalletPortfolioPnlsOptions` | Wallet PnL detail query options (extends `CursorListOptions`): Phase 3 `resolution` (required; `1d` / `7d` / `30d` / `all`), `positionState` (`open` / `closed` / `all`), `sortBy` (`pnl` / `totalUsd` / `winRate`). |
|
|
86
91
|
|
|
87
92
|
### API Contract — Swap & Transaction
|
|
88
93
|
|
package/dist/index.d.mts
CHANGED
|
@@ -220,6 +220,11 @@ interface ActivityDex {
|
|
|
220
220
|
programAddress?: string;
|
|
221
221
|
}
|
|
222
222
|
type ActivityType = "buy" | "sell" | "liquidity_initialize" | "liquidity_add" | "liquidity_remove" | "red_packet_create" | "red_packet_claim" | "red_packet_complete" | "red_packet_refund";
|
|
223
|
+
/**
|
|
224
|
+
* Classification tag applied to an activity's trader (Phase 3).
|
|
225
|
+
* Same vocabulary as {@link HolderTag}; sparse (~0.1%–2% fill rate).
|
|
226
|
+
*/
|
|
227
|
+
type TraderTag = "kol" | "smart" | "sniper" | "dev" | "bundle" | "bluechip" | (string & {});
|
|
223
228
|
/**
|
|
224
229
|
* An on-chain activity record (trade, liquidity, red packet, etc.).
|
|
225
230
|
*/
|
|
@@ -244,6 +249,16 @@ interface Activity {
|
|
|
244
249
|
status: "pending" | "success" | "failed";
|
|
245
250
|
/** activity time */
|
|
246
251
|
time: Date;
|
|
252
|
+
/**
|
|
253
|
+
* Transaction gas fee as a decimal string in the native token's smallest unit
|
|
254
|
+
* (e.g. lamports on Solana, wei on EVM chains). Phase 3; ~100% fill rate on SOL.
|
|
255
|
+
*/
|
|
256
|
+
gasFee?: string;
|
|
257
|
+
/**
|
|
258
|
+
* Classification tags applied to the trader for this activity (Phase 3).
|
|
259
|
+
* Sparse — only present when the trader matches one of the known patterns.
|
|
260
|
+
*/
|
|
261
|
+
traderTags?: Array<TraderTag>;
|
|
247
262
|
}
|
|
248
263
|
/**
|
|
249
264
|
* A buy/sell trade record. Narrowed subset of {@link Activity}.
|
|
@@ -252,6 +267,63 @@ interface Trade extends Activity {
|
|
|
252
267
|
type: "buy" | "sell";
|
|
253
268
|
}
|
|
254
269
|
|
|
270
|
+
/**
|
|
271
|
+
* Side of a limit order.
|
|
272
|
+
*/
|
|
273
|
+
type LimitOrderSide = "buy" | "sell";
|
|
274
|
+
/**
|
|
275
|
+
* Lifecycle state of a limit order (Phase 3 extension).
|
|
276
|
+
* - `active` — order is open, still watching the target price
|
|
277
|
+
* - `filled` — order was executed
|
|
278
|
+
* - `cancelled` — order was cancelled by the user
|
|
279
|
+
* - `expired` — order reached its deadline without filling
|
|
280
|
+
*/
|
|
281
|
+
type LimitOrderState = "active" | "filled" | "cancelled" | "expired";
|
|
282
|
+
/**
|
|
283
|
+
* A wallet-scoped limit order (not yet backed by a server endpoint;
|
|
284
|
+
* shape captures the Axiom-style `Orders` tab columns so the widget
|
|
285
|
+
* layer can be built against stable types even while the backend is
|
|
286
|
+
* still being designed).
|
|
287
|
+
*/
|
|
288
|
+
interface LimitOrder {
|
|
289
|
+
/** stable order id */
|
|
290
|
+
id: string;
|
|
291
|
+
/** chain id */
|
|
292
|
+
chain: Chain;
|
|
293
|
+
/** owner wallet address */
|
|
294
|
+
wallet: string;
|
|
295
|
+
/** target token address */
|
|
296
|
+
tokenAddress: string;
|
|
297
|
+
/** target token name (mirrored for convenience) */
|
|
298
|
+
tokenName?: string;
|
|
299
|
+
/** target token symbol */
|
|
300
|
+
tokenSymbol?: string;
|
|
301
|
+
/** target token image url */
|
|
302
|
+
tokenImage?: string;
|
|
303
|
+
/** buy or sell */
|
|
304
|
+
side: LimitOrderSide;
|
|
305
|
+
/** order amount in token base units (string to avoid precision loss) */
|
|
306
|
+
amount: string;
|
|
307
|
+
/** optional USD amount at order creation time */
|
|
308
|
+
amountInUsd?: string;
|
|
309
|
+
/** current market cap in USD at query time (display-only) */
|
|
310
|
+
currentMarketCapInUsd?: string;
|
|
311
|
+
/** target market cap in USD at which the order triggers */
|
|
312
|
+
targetMarketCapInUsd?: string;
|
|
313
|
+
/** optional trigger price in USD (alternative to target market cap) */
|
|
314
|
+
targetPriceInUsd?: string;
|
|
315
|
+
/** optional slippage tolerance, range 0-100 */
|
|
316
|
+
slippage?: number;
|
|
317
|
+
/** order state */
|
|
318
|
+
state: LimitOrderState;
|
|
319
|
+
/** order creation time */
|
|
320
|
+
createdAt?: Date;
|
|
321
|
+
/** order expiry time (if any) */
|
|
322
|
+
expiresAt?: Date;
|
|
323
|
+
/** execution time when state is `filled` */
|
|
324
|
+
filledAt?: Date;
|
|
325
|
+
}
|
|
326
|
+
|
|
255
327
|
declare enum SolanaTokenProtocol {
|
|
256
328
|
BAGS = "bags",
|
|
257
329
|
BELIEVE = "believe",
|
|
@@ -802,6 +874,11 @@ interface TokenCandle {
|
|
|
802
874
|
*/
|
|
803
875
|
timestamp: Date;
|
|
804
876
|
}
|
|
877
|
+
/**
|
|
878
|
+
* Classification tag applied to a wallet in the context of a specific token holding.
|
|
879
|
+
* See Phase 3 API doc — values are sparse (only 0.1%–2% of holders have tags).
|
|
880
|
+
*/
|
|
881
|
+
type HolderTag = "kol" | "smart" | "sniper" | "dev" | "bundle" | "bluechip" | (string & {});
|
|
805
882
|
interface TokenHolder {
|
|
806
883
|
/**
|
|
807
884
|
* holder wallet address
|
|
@@ -819,6 +896,21 @@ interface TokenHolder {
|
|
|
819
896
|
* holdings ratio, range is 0-100
|
|
820
897
|
*/
|
|
821
898
|
ratio: string;
|
|
899
|
+
/**
|
|
900
|
+
* Holder classification tags (Phase 3). Sparse — only present when the
|
|
901
|
+
* wallet matches one of the known patterns (kol/smart/sniper/dev/...).
|
|
902
|
+
*/
|
|
903
|
+
tags?: Array<HolderTag>;
|
|
904
|
+
/**
|
|
905
|
+
* The last time this wallet was active on-chain (Phase 3).
|
|
906
|
+
* Sparse (~80% fill rate).
|
|
907
|
+
*/
|
|
908
|
+
lastActiveAt?: Date;
|
|
909
|
+
/**
|
|
910
|
+
* The first time this wallet started holding this token (Phase 3).
|
|
911
|
+
* Sparse (~60% fill rate).
|
|
912
|
+
*/
|
|
913
|
+
startHoldingAt?: Date;
|
|
822
914
|
}
|
|
823
915
|
|
|
824
916
|
/**
|
|
@@ -835,6 +927,11 @@ interface CursorPagination {
|
|
|
835
927
|
hasNext?: boolean;
|
|
836
928
|
}
|
|
837
929
|
|
|
930
|
+
/**
|
|
931
|
+
* Classification tag applied to a wallet in the context of a specific token position
|
|
932
|
+
* (Phase 3). Same vocabulary as holder/trader tags; sparse.
|
|
933
|
+
*/
|
|
934
|
+
type WalletTokenTag = "kol" | "smart" | "sniper" | "dev" | "bundle" | "bluechip" | (string & {});
|
|
838
935
|
/**
|
|
839
936
|
* Portfolio PNL
|
|
840
937
|
*/
|
|
@@ -893,6 +990,15 @@ interface PortfolioPnl {
|
|
|
893
990
|
totalProfitRatio?: string;
|
|
894
991
|
/** average profit per trade in usd */
|
|
895
992
|
avgProfitPerTradeInUsd?: string;
|
|
993
|
+
/**
|
|
994
|
+
* Whether the position is closed (balance == 0). Phase 3; 100% fill rate.
|
|
995
|
+
* Corresponds to `positionState=closed` filter on the pnl-details endpoint.
|
|
996
|
+
*/
|
|
997
|
+
isClosed?: boolean;
|
|
998
|
+
/** First buy time (Phase 3). Sparse (~60% fill rate). */
|
|
999
|
+
firstBuyAt?: Date;
|
|
1000
|
+
/** Last sell time (Phase 3). Sparse (~30% fill rate). */
|
|
1001
|
+
lastSellAt?: Date;
|
|
896
1002
|
}
|
|
897
1003
|
interface Portfolio {
|
|
898
1004
|
/** chain id */
|
|
@@ -917,6 +1023,24 @@ interface Portfolio {
|
|
|
917
1023
|
amountInNative: string;
|
|
918
1024
|
/** token decimals */
|
|
919
1025
|
decimals: number;
|
|
1026
|
+
/**
|
|
1027
|
+
* Whether the wallet currently holds a positive balance of this token (Phase 3).
|
|
1028
|
+
* Always `true` in `net-worth/tokens` responses (the endpoint filters closed positions out).
|
|
1029
|
+
*/
|
|
1030
|
+
isActive?: boolean;
|
|
1031
|
+
/**
|
|
1032
|
+
* Average cost basis in USD (Phase 3). Extremely sparse (~0.2% fill rate) —
|
|
1033
|
+
* backed by historical buy prices and often unavailable.
|
|
1034
|
+
*/
|
|
1035
|
+
avgCostUsd?: string;
|
|
1036
|
+
/**
|
|
1037
|
+
* Last time this wallet operated on this token (Phase 3). Sparse.
|
|
1038
|
+
*/
|
|
1039
|
+
lastActiveAt?: Date;
|
|
1040
|
+
/**
|
|
1041
|
+
* Tags applied to the wallet for this specific token position (Phase 3). Sparse.
|
|
1042
|
+
*/
|
|
1043
|
+
walletTokenTags?: Array<WalletTokenTag>;
|
|
920
1044
|
}
|
|
921
1045
|
/**
|
|
922
1046
|
* Wallet PnL summary
|
|
@@ -1168,6 +1292,12 @@ interface GetTradesOptions extends CursorListOptions {
|
|
|
1168
1292
|
/** filter trades by pool address */
|
|
1169
1293
|
poolAddress?: string;
|
|
1170
1294
|
}
|
|
1295
|
+
/**
|
|
1296
|
+
* Sort field for activity list (Phase 3).
|
|
1297
|
+
* - `timestamp` — order by activity time (default, descending)
|
|
1298
|
+
* - `totalUsd` — order by USD amount (useful for finding whale trades)
|
|
1299
|
+
*/
|
|
1300
|
+
type ActivitiesSortBy = "timestamp" | "totalUsd";
|
|
1171
1301
|
/**
|
|
1172
1302
|
* Options for getting activities
|
|
1173
1303
|
*/
|
|
@@ -1184,11 +1314,96 @@ interface GetActivitiesOptions extends CursorListOptions {
|
|
|
1184
1314
|
type?: ActivityType;
|
|
1185
1315
|
/** filter activities by pool address */
|
|
1186
1316
|
poolAddress?: string;
|
|
1317
|
+
/**
|
|
1318
|
+
* Sort field (Phase 3). Defaults to `timestamp` on the server. When changing
|
|
1319
|
+
* `sortBy`, the caller must discard the previous cursor and restart from page 1.
|
|
1320
|
+
*/
|
|
1321
|
+
sortBy?: ActivitiesSortBy;
|
|
1322
|
+
}
|
|
1323
|
+
/**
|
|
1324
|
+
* Sort field for token holder list (Phase 3).
|
|
1325
|
+
* - `holdingUsd` — order by holding value in USD (default, descending)
|
|
1326
|
+
* - `lastActiveAt` — order by wallet's last activity time
|
|
1327
|
+
* - `realizedPnl` — order by realized PnL on this token; used by the
|
|
1328
|
+
* Top Traders view, which shares the same endpoint but
|
|
1329
|
+
* surfaces traders ranked by profit. Server support for
|
|
1330
|
+
* this sort key is required by `getTopTokenTraders`.
|
|
1331
|
+
*/
|
|
1332
|
+
type TokenHoldersSortBy = "holdingUsd" | "lastActiveAt" | "realizedPnl";
|
|
1333
|
+
/**
|
|
1334
|
+
* Options for getting token holders (Phase 3).
|
|
1335
|
+
*/
|
|
1336
|
+
interface GetTokenHoldersOptions extends CursorListOptions {
|
|
1337
|
+
/**
|
|
1338
|
+
* Sort field. Defaults to `holdingUsd` on the server.
|
|
1339
|
+
* Switching `sortBy` requires discarding the old cursor and restarting from page 1.
|
|
1340
|
+
*/
|
|
1341
|
+
sortBy?: TokenHoldersSortBy;
|
|
1342
|
+
}
|
|
1343
|
+
/**
|
|
1344
|
+
* Resolution window for wallet PnL queries (Phase 3).
|
|
1345
|
+
*/
|
|
1346
|
+
type WalletPnlResolution = "7d" | "30d" | "90d";
|
|
1347
|
+
/**
|
|
1348
|
+
* Position state filter for wallet PnL details (Phase 3).
|
|
1349
|
+
* - `open` — only tokens with current balance > 0 (default)
|
|
1350
|
+
* - `closed` — only tokens with balance == 0 (historical realized PnL)
|
|
1351
|
+
* - `all` — both open and closed positions
|
|
1352
|
+
*/
|
|
1353
|
+
type PositionState = "open" | "closed" | "all";
|
|
1354
|
+
/**
|
|
1355
|
+
* Sort field for wallet PnL details (Phase 3).
|
|
1356
|
+
*/
|
|
1357
|
+
type WalletPnlSortBy = "totalPnl" | "realizedPnl" | "unrealizedPnl";
|
|
1358
|
+
/**
|
|
1359
|
+
* Options for getting wallet portfolio PnL details (Phase 3).
|
|
1360
|
+
*/
|
|
1361
|
+
interface GetWalletPortfolioPnlsOptions extends CursorListOptions {
|
|
1362
|
+
/**
|
|
1363
|
+
* Statistics time window. Defaults to `30d` in the Client implementation
|
|
1364
|
+
* for backward compatibility; the server requires this parameter and will
|
|
1365
|
+
* return 400 if it is missing.
|
|
1366
|
+
*/
|
|
1367
|
+
resolution?: WalletPnlResolution;
|
|
1368
|
+
/** Position state filter. Defaults to `open` on the server. */
|
|
1369
|
+
positionState?: PositionState;
|
|
1370
|
+
/**
|
|
1371
|
+
* Sort field. Defaults to `totalPnl` on the server.
|
|
1372
|
+
* Switching `sortBy` requires discarding the old cursor.
|
|
1373
|
+
*/
|
|
1374
|
+
sortBy?: WalletPnlSortBy;
|
|
1187
1375
|
}
|
|
1188
1376
|
/**
|
|
1189
1377
|
* Resolution subset supported by the trending token list.
|
|
1190
1378
|
*/
|
|
1191
1379
|
type TrendingResolution = Extract<TokenResolution, "1m" | "5m" | "1h" | "4h" | "24h">;
|
|
1380
|
+
/**
|
|
1381
|
+
* Options for listing a wallet's limit orders.
|
|
1382
|
+
*
|
|
1383
|
+
* NOTE: The server does not yet implement a limit-orders endpoint. The
|
|
1384
|
+
* `Client.getWalletLimitOrders` method throws a `NotImplementedError` and
|
|
1385
|
+
* the React hook surfaces an empty result so the widget layer can be built
|
|
1386
|
+
* ahead of backend availability.
|
|
1387
|
+
*/
|
|
1388
|
+
interface GetWalletLimitOrdersOptions extends CursorListOptions {
|
|
1389
|
+
/** filter by order state; defaults to `active`. */
|
|
1390
|
+
state?: LimitOrderState;
|
|
1391
|
+
/** restrict to a single token when provided. */
|
|
1392
|
+
tokenAddress?: string;
|
|
1393
|
+
}
|
|
1394
|
+
/**
|
|
1395
|
+
* Options for listing tokens created by a given wallet (the "Dev Tokens" tab).
|
|
1396
|
+
*
|
|
1397
|
+
* NOTE: The server does not yet implement a creator-index endpoint. The
|
|
1398
|
+
* `Client.getTokensByCreator` method throws a `NotImplementedError` and the
|
|
1399
|
+
* React hook surfaces an empty result for now.
|
|
1400
|
+
*/
|
|
1401
|
+
interface GetTokensByCreatorOptions extends CursorListOptions {
|
|
1402
|
+
/** optional sort field; server behaviour will be defined when endpoint ships. */
|
|
1403
|
+
sortBy?: TokenFieldOption;
|
|
1404
|
+
/** sort direction. */
|
|
1405
|
+
sortDirection?: "asc" | "desc";
|
|
1406
|
+
}
|
|
1192
1407
|
/**
|
|
1193
1408
|
* API client interface
|
|
1194
1409
|
*/
|
|
@@ -1234,10 +1449,10 @@ interface IClient {
|
|
|
1234
1449
|
* fetch token holders
|
|
1235
1450
|
* @param chain chain id
|
|
1236
1451
|
* @param address token address
|
|
1237
|
-
* @param options optional query options
|
|
1452
|
+
* @param options optional query options (Phase 3: sortBy)
|
|
1238
1453
|
* @returns token holders
|
|
1239
1454
|
*/
|
|
1240
|
-
getTokenHolders(chain: Chain, address: string, options?:
|
|
1455
|
+
getTokenHolders(chain: Chain, address: string, options?: GetTokenHoldersOptions): Promise<CursorList<TokenHolder>>;
|
|
1241
1456
|
/**
|
|
1242
1457
|
* fetch token market data
|
|
1243
1458
|
* @param chain chain id
|
|
@@ -1336,13 +1551,10 @@ interface IClient {
|
|
|
1336
1551
|
* fetch wallet portfolio PnL details (per-token)
|
|
1337
1552
|
* @param chain chain id
|
|
1338
1553
|
* @param address wallet address
|
|
1339
|
-
* @param options optional query options
|
|
1554
|
+
* @param options optional query options (Phase 3: resolution, positionState, sortBy)
|
|
1340
1555
|
* @returns portfolio pnl list with summary
|
|
1341
1556
|
*/
|
|
1342
|
-
getWalletPortfolioPnls(chain: Chain, address: string, options?:
|
|
1343
|
-
cursor?: string;
|
|
1344
|
-
limit?: number;
|
|
1345
|
-
}): Promise<WalletPortfolioPnls>;
|
|
1557
|
+
getWalletPortfolioPnls(chain: Chain, address: string, options?: GetWalletPortfolioPnlsOptions): Promise<WalletPortfolioPnls>;
|
|
1346
1558
|
/**
|
|
1347
1559
|
* fetch wallet portfolios for specific tokens
|
|
1348
1560
|
* @param chain chain id
|
|
@@ -1396,6 +1608,27 @@ interface IClient {
|
|
|
1396
1608
|
* @returns presigned upload url
|
|
1397
1609
|
*/
|
|
1398
1610
|
getPresignedUploadUrl(): Promise<string>;
|
|
1611
|
+
/**
|
|
1612
|
+
* fetch a wallet's limit orders.
|
|
1613
|
+
*
|
|
1614
|
+
* Currently unsupported by the backend; implementations throw
|
|
1615
|
+
* `NotImplementedError` to make the gap explicit while the widget-layer
|
|
1616
|
+
* clone of Axiom's Orders tab is being developed.
|
|
1617
|
+
* @param chain chain id
|
|
1618
|
+
* @param address wallet address
|
|
1619
|
+
* @param options optional query options
|
|
1620
|
+
*/
|
|
1621
|
+
getWalletLimitOrders(chain: Chain, address: string, options?: GetWalletLimitOrdersOptions): Promise<CursorList<LimitOrder>>;
|
|
1622
|
+
/**
|
|
1623
|
+
* fetch tokens created by a wallet ("Dev Tokens").
|
|
1624
|
+
*
|
|
1625
|
+
* Currently unsupported by the backend; implementations throw
|
|
1626
|
+
* `NotImplementedError`.
|
|
1627
|
+
* @param chain chain id
|
|
1628
|
+
* @param creator creator wallet address
|
|
1629
|
+
* @param options optional query options
|
|
1630
|
+
*/
|
|
1631
|
+
getTokensByCreator(chain: Chain, creator: string, options?: GetTokensByCreatorOptions): Promise<CursorList<Token>>;
|
|
1399
1632
|
}
|
|
1400
1633
|
interface ISubscription {
|
|
1401
1634
|
unsubscribe(): void;
|
|
@@ -1555,20 +1788,26 @@ interface ISubscribeClient {
|
|
|
1555
1788
|
subscribeStockTokens(chain: Chain, callback: (data: Array<TokenSubscribed>) => void): ISubscription;
|
|
1556
1789
|
}
|
|
1557
1790
|
|
|
1791
|
+
type index_ActivitiesSortBy = ActivitiesSortBy;
|
|
1558
1792
|
type index_BlockchainLatestBlock = BlockchainLatestBlock;
|
|
1559
1793
|
type index_CursorList<T> = CursorList<T>;
|
|
1560
1794
|
type index_CursorListOptions = CursorListOptions;
|
|
1561
1795
|
type index_CursorPagination = CursorPagination;
|
|
1562
1796
|
type index_GetActivitiesOptions = GetActivitiesOptions;
|
|
1563
1797
|
type index_GetTokenCandlesOptions = GetTokenCandlesOptions;
|
|
1798
|
+
type index_GetTokenHoldersOptions = GetTokenHoldersOptions;
|
|
1564
1799
|
type index_GetTokenListOptions = GetTokenListOptions;
|
|
1800
|
+
type index_GetTokensByCreatorOptions = GetTokensByCreatorOptions;
|
|
1565
1801
|
type index_GetTradesOptions = GetTradesOptions;
|
|
1802
|
+
type index_GetWalletLimitOrdersOptions = GetWalletLimitOrdersOptions;
|
|
1803
|
+
type index_GetWalletPortfolioPnlsOptions = GetWalletPortfolioPnlsOptions;
|
|
1566
1804
|
type index_IClient = IClient;
|
|
1567
1805
|
type index_ISubscribeClient = ISubscribeClient;
|
|
1568
1806
|
type index_ISubscription = ISubscription;
|
|
1569
1807
|
type index_LatestBlockParams = LatestBlockParams;
|
|
1570
1808
|
type index_PortfolioPnlSubscribed = PortfolioPnlSubscribed;
|
|
1571
1809
|
type index_PortfolioSubscribed = PortfolioSubscribed;
|
|
1810
|
+
type index_PositionState = PositionState;
|
|
1572
1811
|
type index_SearchTokenCursorList = SearchTokenCursorList;
|
|
1573
1812
|
type index_SearchTokensOptions = SearchTokensOptions;
|
|
1574
1813
|
type index_SendTxParams = SendTxParams;
|
|
@@ -1581,11 +1820,14 @@ type index_SwapRoute = SwapRoute;
|
|
|
1581
1820
|
type index_SwapRoutePlan = SwapRoutePlan;
|
|
1582
1821
|
type index_TokenFieldOption = TokenFieldOption;
|
|
1583
1822
|
type index_TokenFilterOption = TokenFilterOption;
|
|
1823
|
+
type index_TokenHoldersSortBy = TokenHoldersSortBy;
|
|
1584
1824
|
type index_TokenSubscribed = TokenSubscribed;
|
|
1585
1825
|
type index_TrendingResolution = TrendingResolution;
|
|
1826
|
+
type index_WalletPnlResolution = WalletPnlResolution;
|
|
1827
|
+
type index_WalletPnlSortBy = WalletPnlSortBy;
|
|
1586
1828
|
type index_WalletPnlSubscribed = WalletPnlSubscribed;
|
|
1587
1829
|
declare namespace index {
|
|
1588
|
-
export { type index_BlockchainLatestBlock as BlockchainLatestBlock, type index_CursorList as CursorList, type index_CursorListOptions as CursorListOptions, type index_CursorPagination as CursorPagination, type index_GetActivitiesOptions as GetActivitiesOptions, type index_GetTokenCandlesOptions as GetTokenCandlesOptions, type index_GetTokenListOptions as GetTokenListOptions, type index_GetTradesOptions as GetTradesOptions, type index_IClient as IClient, type index_ISubscribeClient as ISubscribeClient, type index_ISubscription as ISubscription, type index_LatestBlockParams as LatestBlockParams, type index_PortfolioPnlSubscribed as PortfolioPnlSubscribed, type index_PortfolioSubscribed as PortfolioSubscribed, type index_SearchTokenCursorList as SearchTokenCursorList, type index_SearchTokensOptions as SearchTokensOptions, type index_SendTxParams as SendTxParams, type index_SendTxResult as SendTxResult, type index_SwapDex as SwapDex, index_SwapMode as SwapMode, type index_SwapParams as SwapParams, type index_SwapRoute as SwapRoute, type index_SwapRoutePlan as SwapRoutePlan, type index_TokenFieldOption as TokenFieldOption, type index_TokenFilterOption as TokenFilterOption, type index_TokenSubscribed as TokenSubscribed, type index_TrendingResolution as TrendingResolution, type index_WalletPnlSubscribed as WalletPnlSubscribed };
|
|
1830
|
+
export { type index_ActivitiesSortBy as ActivitiesSortBy, type index_BlockchainLatestBlock as BlockchainLatestBlock, type index_CursorList as CursorList, type index_CursorListOptions as CursorListOptions, type index_CursorPagination as CursorPagination, type index_GetActivitiesOptions as GetActivitiesOptions, type index_GetTokenCandlesOptions as GetTokenCandlesOptions, type index_GetTokenHoldersOptions as GetTokenHoldersOptions, type index_GetTokenListOptions as GetTokenListOptions, type index_GetTokensByCreatorOptions as GetTokensByCreatorOptions, type index_GetTradesOptions as GetTradesOptions, type index_GetWalletLimitOrdersOptions as GetWalletLimitOrdersOptions, type index_GetWalletPortfolioPnlsOptions as GetWalletPortfolioPnlsOptions, type index_IClient as IClient, type index_ISubscribeClient as ISubscribeClient, type index_ISubscription as ISubscription, type index_LatestBlockParams as LatestBlockParams, type index_PortfolioPnlSubscribed as PortfolioPnlSubscribed, type index_PortfolioSubscribed as PortfolioSubscribed, type index_PositionState as PositionState, type index_SearchTokenCursorList as SearchTokenCursorList, type index_SearchTokensOptions as SearchTokensOptions, type index_SendTxParams as SendTxParams, type index_SendTxResult as SendTxResult, type index_SwapDex as SwapDex, index_SwapMode as SwapMode, type index_SwapParams as SwapParams, type index_SwapRoute as SwapRoute, type index_SwapRoutePlan as SwapRoutePlan, type index_TokenFieldOption as TokenFieldOption, type index_TokenFilterOption as TokenFilterOption, type index_TokenHoldersSortBy as TokenHoldersSortBy, type index_TokenSubscribed as TokenSubscribed, type index_TrendingResolution as TrendingResolution, type index_WalletPnlResolution as WalletPnlResolution, type index_WalletPnlSortBy as WalletPnlSortBy, type index_WalletPnlSubscribed as WalletPnlSubscribed };
|
|
1589
1831
|
}
|
|
1590
1832
|
|
|
1591
1833
|
declare global {
|
|
@@ -1595,6 +1837,6 @@ declare global {
|
|
|
1595
1837
|
};
|
|
1596
1838
|
}
|
|
1597
1839
|
}
|
|
1598
|
-
declare const _default: "0.
|
|
1840
|
+
declare const _default: "0.3.0";
|
|
1599
1841
|
|
|
1600
|
-
export { index as API, type Activity, type ActivityDex, type ActivityToken, type ActivityType, type BlockchainLatestBlock, Chain, ChainNamespace, type CursorList, type CursorListOptions, type CursorPagination, type GetActivitiesOptions, type GetTokenCandlesOptions, type GetTokenListOptions, type GetTradesOptions, type IClient, type ISubscribeClient, type ISubscription, type LatestBlockParams, type Portfolio, type PortfolioPnl, type PortfolioPnlSubscribed, type PortfolioSubscribed, SOLANA_TOKEN_PROTOCOLS, type SearchTokenCursorList, type SearchTokensOptions, type SendTxParams, type SendTxResult, SolanaTokenProtocol, type SwapDex, SwapMode, type SwapParams, type SwapRoute, type SwapRoutePlan, type Token, type TokenCandle, type TokenCreator, type TokenFieldOption, type TokenFilterOption, type TokenHolder, type TokenLaunchedFrom, type TokenLiquidity, type TokenMarketData, type TokenMigratedTo, type TokenProtocol, type TokenResolution, type TokenSecurity, type TokenSocialMedias, type TokenStats, type TokenStatsByResolution, type TokenSubscribed, type Trade, type TrendingResolution, type WalletPnl, type WalletPnlSubscribed, type WalletPortfolioPnls, type WalletPortfolios, _default as version };
|
|
1842
|
+
export { index as API, type ActivitiesSortBy, type Activity, type ActivityDex, type ActivityToken, type ActivityType, type BlockchainLatestBlock, Chain, ChainNamespace, type CursorList, type CursorListOptions, type CursorPagination, type GetActivitiesOptions, type GetTokenCandlesOptions, type GetTokenHoldersOptions, type GetTokenListOptions, type GetTokensByCreatorOptions, type GetTradesOptions, type GetWalletLimitOrdersOptions, type GetWalletPortfolioPnlsOptions, type HolderTag, type IClient, type ISubscribeClient, type ISubscription, type LatestBlockParams, type LimitOrder, type LimitOrderSide, type LimitOrderState, type Portfolio, type PortfolioPnl, type PortfolioPnlSubscribed, type PortfolioSubscribed, type PositionState, SOLANA_TOKEN_PROTOCOLS, type SearchTokenCursorList, type SearchTokensOptions, type SendTxParams, type SendTxResult, SolanaTokenProtocol, type SwapDex, SwapMode, type SwapParams, type SwapRoute, type SwapRoutePlan, type Token, type TokenCandle, type TokenCreator, type TokenFieldOption, type TokenFilterOption, type TokenHolder, type TokenHoldersSortBy, type TokenLaunchedFrom, type TokenLiquidity, type TokenMarketData, type TokenMigratedTo, type TokenProtocol, type TokenResolution, type TokenSecurity, type TokenSocialMedias, type TokenStats, type TokenStatsByResolution, type TokenSubscribed, type Trade, type TraderTag, type TrendingResolution, type WalletPnl, type WalletPnlResolution, type WalletPnlSortBy, type WalletPnlSubscribed, type WalletPortfolioPnls, type WalletPortfolios, type WalletTokenTag, _default as version };
|