@velocity-exchange/sdk 0.4.0 → 0.6.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.
Files changed (323) hide show
  1. package/README.md +3 -3
  2. package/lib/browser/adminClient.d.ts +35 -0
  3. package/lib/browser/adminClient.js +65 -0
  4. package/lib/browser/config.js +6 -7
  5. package/lib/browser/constants/numericConstants.d.ts +1 -1
  6. package/lib/browser/constants/numericConstants.js +1 -1
  7. package/lib/browser/decode/user.js +5 -1
  8. package/lib/browser/idl/velocity.d.ts +146 -3
  9. package/lib/browser/idl/velocity.json +147 -4
  10. package/lib/browser/orderSubscriber/OrderSubscriber.js +3 -0
  11. package/lib/browser/pyth/pythLazerSubscriber.js +37 -27
  12. package/lib/browser/types.d.ts +4 -0
  13. package/lib/browser/user.d.ts +15 -0
  14. package/lib/browser/user.js +37 -1
  15. package/lib/browser/velocityClient.d.ts +46 -10
  16. package/lib/browser/velocityClient.js +107 -35
  17. package/lib/node/adminClient.d.ts +35 -0
  18. package/lib/node/adminClient.d.ts.map +1 -1
  19. package/lib/node/adminClient.js +65 -0
  20. package/lib/node/config.d.ts.map +1 -1
  21. package/lib/node/config.js +6 -7
  22. package/lib/node/constants/numericConstants.d.ts +1 -1
  23. package/lib/node/constants/numericConstants.d.ts.map +1 -1
  24. package/lib/node/constants/numericConstants.js +1 -1
  25. package/lib/node/decode/user.d.ts.map +1 -1
  26. package/lib/node/decode/user.js +5 -1
  27. package/lib/node/idl/velocity.d.ts +146 -3
  28. package/lib/node/idl/velocity.d.ts.map +1 -1
  29. package/lib/node/idl/velocity.json +147 -4
  30. package/lib/node/orderSubscriber/OrderSubscriber.d.ts.map +1 -1
  31. package/lib/node/orderSubscriber/OrderSubscriber.js +3 -0
  32. package/lib/node/pyth/pythLazerSubscriber.d.ts.map +1 -1
  33. package/lib/node/pyth/pythLazerSubscriber.js +37 -27
  34. package/lib/node/types.d.ts +4 -0
  35. package/lib/node/types.d.ts.map +1 -1
  36. package/lib/node/user.d.ts +15 -0
  37. package/lib/node/user.d.ts.map +1 -1
  38. package/lib/node/user.js +37 -1
  39. package/lib/node/velocityClient.d.ts +46 -10
  40. package/lib/node/velocityClient.d.ts.map +1 -1
  41. package/lib/node/velocityClient.js +107 -35
  42. package/package.json +7 -3
  43. package/.prettierignore +0 -1
  44. package/CHANGELOG.md +0 -132
  45. package/build-browser.js +0 -58
  46. package/bunfig.toml +0 -3
  47. package/esbuild-shims.js +0 -12
  48. package/scripts/deposit-isolated-positions.ts +0 -110
  49. package/scripts/find-flagged-users.ts +0 -213
  50. package/scripts/grpc-client-test-comparison.ts +0 -372
  51. package/scripts/grpc-multiuser-client-test-comparison.ts +0 -158
  52. package/scripts/postbuild.js +0 -95
  53. package/scripts/single-grpc-client-test.ts +0 -284
  54. package/scripts/withdraw-isolated-positions.ts +0 -174
  55. package/src/accounts/README_WebSocketAccountSubscriberV2.md +0 -95
  56. package/src/accounts/README_WebSocketProgramAccountSubscriberV2.md +0 -135
  57. package/src/accounts/basicUserAccountSubscriber.ts +0 -79
  58. package/src/accounts/basicUserStatsAccountSubscriber.ts +0 -87
  59. package/src/accounts/bulkAccountLoader.ts +0 -358
  60. package/src/accounts/bulkUserStatsSubscription.ts +0 -40
  61. package/src/accounts/bulkUserSubscription.ts +0 -39
  62. package/src/accounts/customizedCadenceBulkAccountLoader.ts +0 -250
  63. package/src/accounts/fetch.ts +0 -200
  64. package/src/accounts/grpcAccountSubscriber.ts +0 -225
  65. package/src/accounts/grpcInsuranceFundStakeAccountSubscriber.ts +0 -73
  66. package/src/accounts/grpcMultiAccountSubscriber.ts +0 -566
  67. package/src/accounts/grpcMultiUserAccountSubscriber.ts +0 -328
  68. package/src/accounts/grpcProgramAccountSubscriber.ts +0 -264
  69. package/src/accounts/grpcUserAccountSubscriber.ts +0 -63
  70. package/src/accounts/grpcUserStatsAccountSubscriber.ts +0 -65
  71. package/src/accounts/grpcVelocityClientAccountSubscriber.ts +0 -257
  72. package/src/accounts/grpcVelocityClientAccountSubscriberV2.ts +0 -941
  73. package/src/accounts/laserProgramAccountSubscriber.ts +0 -266
  74. package/src/accounts/oneShotUserAccountSubscriber.ts +0 -88
  75. package/src/accounts/oneShotUserStatsAccountSubscriber.ts +0 -94
  76. package/src/accounts/pollingInsuranceFundStakeAccountSubscriber.ts +0 -223
  77. package/src/accounts/pollingOracleAccountSubscriber.ts +0 -151
  78. package/src/accounts/pollingTokenAccountSubscriber.ts +0 -147
  79. package/src/accounts/pollingUserAccountSubscriber.ts +0 -198
  80. package/src/accounts/pollingUserStatsAccountSubscriber.ts +0 -180
  81. package/src/accounts/pollingVelocityClientAccountSubscriber.ts +0 -774
  82. package/src/accounts/testBulkAccountLoader.ts +0 -59
  83. package/src/accounts/types.ts +0 -428
  84. package/src/accounts/utils.ts +0 -90
  85. package/src/accounts/webSocketAccountSubscriber.ts +0 -304
  86. package/src/accounts/webSocketAccountSubscriberV2.ts +0 -536
  87. package/src/accounts/webSocketInsuranceFundStakeAccountSubscriber.ts +0 -171
  88. package/src/accounts/webSocketProgramAccountSubscriber.ts +0 -244
  89. package/src/accounts/webSocketProgramAccountSubscriberV2.ts +0 -1048
  90. package/src/accounts/webSocketProgramAccountsSubscriberV2.ts +0 -1042
  91. package/src/accounts/webSocketUserAccountSubscriber.ts +0 -139
  92. package/src/accounts/webSocketUserStatsAccountSubsriber.ts +0 -131
  93. package/src/accounts/webSocketVelocityClientAccountSubscriber.ts +0 -865
  94. package/src/accounts/webSocketVelocityClientAccountSubscriberV2.ts +0 -897
  95. package/src/accounts/websocketProgramUserAccountSubscriber.ts +0 -127
  96. package/src/addresses/marketAddresses.ts +0 -28
  97. package/src/addresses/pda.ts +0 -620
  98. package/src/adminClient.ts +0 -8136
  99. package/src/assert/assert.ts +0 -5
  100. package/src/auctionSubscriber/auctionSubscriber.ts +0 -86
  101. package/src/auctionSubscriber/auctionSubscriberGrpc.ts +0 -99
  102. package/src/auctionSubscriber/index.ts +0 -9
  103. package/src/auctionSubscriber/types.ts +0 -30
  104. package/src/bankrun/bankrunConnection.ts +0 -630
  105. package/src/blockhashSubscriber/BlockhashSubscriber.ts +0 -160
  106. package/src/blockhashSubscriber/index.ts +0 -6
  107. package/src/blockhashSubscriber/types.ts +0 -13
  108. package/src/clock/clockSubscriber.ts +0 -146
  109. package/src/config.ts +0 -312
  110. package/src/constants/index.ts +0 -9
  111. package/src/constants/numericConstants.ts +0 -194
  112. package/src/constants/perpMarkets.ts +0 -127
  113. package/src/constants/spotMarkets.ts +0 -104
  114. package/src/constants/txConstants.ts +0 -2
  115. package/src/constituentMap/constituentMap.ts +0 -305
  116. package/src/constituentMap/pollingConstituentAccountSubscriber.ts +0 -99
  117. package/src/constituentMap/webSocketConstituentAccountSubscriber.ts +0 -121
  118. package/src/core/VelocityCore.ts +0 -606
  119. package/src/core/index.ts +0 -12
  120. package/src/core/instructions/deposit.ts +0 -64
  121. package/src/core/instructions/fill.ts +0 -51
  122. package/src/core/instructions/funding.ts +0 -33
  123. package/src/core/instructions/liquidation.ts +0 -55
  124. package/src/core/instructions/orders.ts +0 -84
  125. package/src/core/instructions/perpOrders.ts +0 -312
  126. package/src/core/instructions/settlement.ts +0 -40
  127. package/src/core/instructions/trigger.ts +0 -41
  128. package/src/core/instructions/withdraw.ts +0 -65
  129. package/src/core/remainingAccounts.ts +0 -320
  130. package/src/core/signedMsg.ts +0 -109
  131. package/src/decode/customCoder.ts +0 -148
  132. package/src/decode/user.ts +0 -401
  133. package/src/dlob/DLOB.ts +0 -2793
  134. package/src/dlob/DLOBNode.ts +0 -305
  135. package/src/dlob/DLOBSubscriber.ts +0 -269
  136. package/src/dlob/NodeList.ts +0 -244
  137. package/src/dlob/orderBookLevels.ts +0 -695
  138. package/src/dlob/types.ts +0 -37
  139. package/src/events/eventList.ts +0 -114
  140. package/src/events/eventSubscriber.ts +0 -521
  141. package/src/events/eventsServerLogProvider.ts +0 -189
  142. package/src/events/fetchLogs.ts +0 -219
  143. package/src/events/parse.ts +0 -271
  144. package/src/events/pollingLogProvider.ts +0 -113
  145. package/src/events/sort.ts +0 -51
  146. package/src/events/txEventCache.ts +0 -92
  147. package/src/events/types.ts +0 -337
  148. package/src/events/webSocketLogProvider.ts +0 -152
  149. package/src/factory/bigNum.ts +0 -709
  150. package/src/factory/oracleClient.ts +0 -73
  151. package/src/idl/pyth.json +0 -142
  152. package/src/idl/pyth.ts +0 -97
  153. package/src/idl/pyth_solana_receiver.json +0 -628
  154. package/src/idl/token_faucet.json +0 -229
  155. package/src/idl/token_faucet.ts +0 -197
  156. package/src/idl/velocity.json +0 -23974
  157. package/src/idl/velocity.ts +0 -23980
  158. package/src/index.ts +0 -150
  159. package/src/indicative-quotes/indicativeQuotesSender.ts +0 -233
  160. package/src/isomorphic/README.md +0 -19
  161. package/src/isomorphic/anchor.browser.ts +0 -44
  162. package/src/isomorphic/anchor.node.ts +0 -1
  163. package/src/isomorphic/anchor.ts +0 -1
  164. package/src/isomorphic/anchor29.browser.ts +0 -24
  165. package/src/isomorphic/anchor29.node.ts +0 -1
  166. package/src/isomorphic/anchor29.ts +0 -1
  167. package/src/isomorphic/grpc.browser.ts +0 -4
  168. package/src/isomorphic/grpc.node.ts +0 -130
  169. package/src/isomorphic/grpc.ts +0 -1
  170. package/src/jupiter/jupiterClient.ts +0 -502
  171. package/src/keypair.ts +0 -32
  172. package/src/margin/README.md +0 -138
  173. package/src/marginCalculation.ts +0 -407
  174. package/src/marinade/idl/idl.json +0 -1962
  175. package/src/marinade/index.ts +0 -73
  176. package/src/marinade/types.ts +0 -3925
  177. package/src/math/amm.ts +0 -1758
  178. package/src/math/auction.ts +0 -480
  179. package/src/math/bankruptcy.ts +0 -138
  180. package/src/math/builder.ts +0 -130
  181. package/src/math/conversion.ts +0 -45
  182. package/src/math/exchangeStatus.ts +0 -261
  183. package/src/math/funding.ts +0 -498
  184. package/src/math/insurance.ts +0 -171
  185. package/src/math/liquidation.ts +0 -433
  186. package/src/math/margin.ts +0 -327
  187. package/src/math/market.ts +0 -487
  188. package/src/math/oracles.ts +0 -477
  189. package/src/math/orders.ts +0 -500
  190. package/src/math/position.ts +0 -381
  191. package/src/math/repeg.ts +0 -223
  192. package/src/math/spotBalance.ts +0 -996
  193. package/src/math/spotMarket.ts +0 -115
  194. package/src/math/spotPosition.ts +0 -263
  195. package/src/math/state.ts +0 -71
  196. package/src/math/superStake.ts +0 -602
  197. package/src/math/tiers.ts +0 -73
  198. package/src/math/trade.ts +0 -879
  199. package/src/math/utils.ts +0 -183
  200. package/src/memcmp.ts +0 -279
  201. package/src/oracles/oracleClientCache.ts +0 -41
  202. package/src/oracles/oracleId.ts +0 -99
  203. package/src/oracles/prelaunchOracleClient.ts +0 -63
  204. package/src/oracles/pythClient.ts +0 -125
  205. package/src/oracles/pythLazerClient.ts +0 -141
  206. package/src/oracles/quoteAssetOracleClient.ts +0 -43
  207. package/src/oracles/strictOraclePrice.ts +0 -40
  208. package/src/oracles/types.ts +0 -82
  209. package/src/oracles/utils.ts +0 -45
  210. package/src/orderParams.ts +0 -117
  211. package/src/orderSubscriber/OrderSubscriber.ts +0 -378
  212. package/src/orderSubscriber/PollingSubscription.ts +0 -50
  213. package/src/orderSubscriber/WebsocketSubscription.ts +0 -137
  214. package/src/orderSubscriber/grpcSubscription.ts +0 -155
  215. package/src/orderSubscriber/index.ts +0 -7
  216. package/src/orderSubscriber/types.ts +0 -64
  217. package/src/priorityFee/averageOverSlotsStrategy.ts +0 -17
  218. package/src/priorityFee/averageStrategy.ts +0 -13
  219. package/src/priorityFee/ewmaStrategy.ts +0 -51
  220. package/src/priorityFee/heliusPriorityFeeMethod.ts +0 -68
  221. package/src/priorityFee/index.ts +0 -16
  222. package/src/priorityFee/maxOverSlotsStrategy.ts +0 -18
  223. package/src/priorityFee/maxStrategy.ts +0 -8
  224. package/src/priorityFee/priorityFeeSubscriber.ts +0 -328
  225. package/src/priorityFee/priorityFeeSubscriberMap.ts +0 -134
  226. package/src/priorityFee/solanaPriorityFeeMethod.ts +0 -46
  227. package/src/priorityFee/types.ts +0 -82
  228. package/src/priorityFee/velocityPriorityFeeMethod.ts +0 -53
  229. package/src/pyth/constants.ts +0 -9
  230. package/src/pyth/index.ts +0 -15
  231. package/src/pyth/pythLazerSubscriber.ts +0 -365
  232. package/src/pyth/types.ts +0 -4451
  233. package/src/pyth/utils.ts +0 -13
  234. package/src/slot/SlotSubscriber.ts +0 -126
  235. package/src/slot/SlothashSubscriber.ts +0 -163
  236. package/src/swap/UnifiedSwapClient.ts +0 -315
  237. package/src/swift/grpcSignedMsgUserAccountSubscriber.ts +0 -81
  238. package/src/swift/index.ts +0 -10
  239. package/src/swift/signedMsgUserAccountSubscriber.ts +0 -251
  240. package/src/swift/swiftOrderSubscriber.ts +0 -351
  241. package/src/testClient.ts +0 -42
  242. package/src/titan/titanClient.ts +0 -438
  243. package/src/token/index.ts +0 -13
  244. package/src/tokenFaucet.ts +0 -296
  245. package/src/tx/baseTxSender.ts +0 -651
  246. package/src/tx/blockhashFetcher/baseBlockhashFetcher.ts +0 -31
  247. package/src/tx/blockhashFetcher/cachedBlockhashFetcher.ts +0 -105
  248. package/src/tx/blockhashFetcher/types.ts +0 -9
  249. package/src/tx/fastSingleTxSender.ts +0 -200
  250. package/src/tx/forwardOnlyTxSender.ts +0 -193
  251. package/src/tx/priorityFeeCalculator.ts +0 -117
  252. package/src/tx/reportTransactionError.ts +0 -176
  253. package/src/tx/retryTxSender.ts +0 -177
  254. package/src/tx/txHandler.ts +0 -1009
  255. package/src/tx/txParamProcessor.ts +0 -225
  256. package/src/tx/types.ts +0 -117
  257. package/src/tx/utils.ts +0 -133
  258. package/src/tx/whileValidTxSender.ts +0 -377
  259. package/src/types.ts +0 -2575
  260. package/src/user.ts +0 -5316
  261. package/src/userConfig.ts +0 -38
  262. package/src/userMap/PollingSubscription.ts +0 -61
  263. package/src/userMap/WebsocketSubscription.ts +0 -93
  264. package/src/userMap/grpcSubscription.ts +0 -93
  265. package/src/userMap/referrerMap.ts +0 -360
  266. package/src/userMap/revenueShareEscrowMap.ts +0 -342
  267. package/src/userMap/userMap.ts +0 -784
  268. package/src/userMap/userMapConfig.ts +0 -82
  269. package/src/userMap/userStatsMap.ts +0 -393
  270. package/src/userName.ts +0 -37
  271. package/src/userStats.ts +0 -159
  272. package/src/userStatsConfig.ts +0 -35
  273. package/src/util/TransactionConfirmationManager.ts +0 -333
  274. package/src/util/chainClock.ts +0 -65
  275. package/src/util/computeUnits.ts +0 -101
  276. package/src/util/digest.ts +0 -33
  277. package/src/util/ed25519Utils.ts +0 -95
  278. package/src/util/promiseTimeout.ts +0 -23
  279. package/src/velocityClient.ts +0 -14802
  280. package/src/velocityClientConfig.ts +0 -119
  281. package/src/wallet.ts +0 -91
  282. package/tests/VelocityCore/builder_escrow.test.ts +0 -121
  283. package/tests/VelocityCore/decode.test.ts +0 -16
  284. package/tests/VelocityCore/fill_trigger.test.ts +0 -73
  285. package/tests/VelocityCore/instructions.test.ts +0 -46
  286. package/tests/VelocityCore/pdas.test.ts +0 -30
  287. package/tests/VelocityCore/perp_orders.test.ts +0 -205
  288. package/tests/VelocityCore/remainingAccounts.test.ts +0 -72
  289. package/tests/VelocityCore/settlement_liquidation.test.ts +0 -69
  290. package/tests/accounts/customizedCadenceBulkAccountLoader.test.ts +0 -211
  291. package/tests/amm/test.ts +0 -2402
  292. package/tests/auctions/test.ts +0 -81
  293. package/tests/bn/test.ts +0 -355
  294. package/tests/builder/builderFee.test.ts +0 -42
  295. package/tests/ci/verifyConstants.ts +0 -393
  296. package/tests/decode/test.ts +0 -262
  297. package/tests/decode/userAccountBufferStrings.ts +0 -102
  298. package/tests/dlob/helpers.ts +0 -748
  299. package/tests/dlob/test.ts +0 -6969
  300. package/tests/dlob/tickSizeStandardization.ts +0 -545
  301. package/tests/events/parseLogsForCuUsage.ts +0 -139
  302. package/tests/exchangeStatus/test.ts +0 -45
  303. package/tests/insurance/test.ts +0 -40
  304. package/tests/liquidation/test.ts +0 -125
  305. package/tests/oracles/mmOracleGate.test.ts +0 -379
  306. package/tests/oracles/pythPegSnap.test.ts +0 -76
  307. package/tests/sdkParity/enumParity.test.ts +0 -84
  308. package/tests/sdkParity/marginCategoryFill.test.ts +0 -143
  309. package/tests/sdkParity/memcmpOffsets.test.ts +0 -139
  310. package/tests/spot/test.ts +0 -281
  311. package/tests/tx/TransactionConfirmationManager.test.ts +0 -312
  312. package/tests/tx/cachedBlockhashFetcher.test.ts +0 -96
  313. package/tests/tx/priorityFeeCalculator.ts +0 -77
  314. package/tests/tx/priorityFeeStrategy.ts +0 -95
  315. package/tests/user/bankruptcy.ts +0 -165
  316. package/tests/user/feeAndWithdrawLimits.ts +0 -284
  317. package/tests/user/getMarginCalculation.ts +0 -586
  318. package/tests/user/helpers.ts +0 -184
  319. package/tests/user/liquidations.ts +0 -129
  320. package/tests/user/marginCalculations.test.ts +0 -321
  321. package/tests/user/test.ts +0 -833
  322. package/tsconfig.browser.json +0 -18
  323. package/tsconfig.json +0 -36
@@ -1,82 +0,0 @@
1
- import { Commitment, Connection, MemcmpFilter } from '@solana/web3.js';
2
- import { VelocityClient } from '../velocityClient';
3
- import { GrpcConfigs } from '../accounts/types';
4
-
5
- /** Passed into `UserMap.getUniqueAuthorities` to filter which users' authorities are returned. */
6
- export type UserAccountFilterCriteria = {
7
- /** Only return users that have `hasOpenOrder` set on their `UserAccount`. */
8
- hasOpenOrders: boolean;
9
- };
10
-
11
- /**
12
- * Selects how `UserMap`/`UserStatsMap` bulk-load accounts on sync.
13
- * - `'default'`: a single `getProgramAccounts` call with server-side memcmp filters. Simple, but can hit RPC/node response-size limits when there are many accounts.
14
- * - `'paginated'`: a filtered `getProgramAccounts` prefetch for just the pubkeys, followed by chunked `getMultipleAccountsInfoAndContext` calls with bounded concurrency. More RPC calls, but scales to large account counts.
15
- */
16
- export type SyncConfig =
17
- | {
18
- type: 'default';
19
- }
20
- | {
21
- type: 'paginated';
22
- /** Number of accounts fetched per `getMultipleAccountsInfoAndContext` call. Defaults to 100. */
23
- chunkSize?: number;
24
- /** Max number of chunk-fetch tasks in flight at once. Defaults to 10. */
25
- concurrencyLimit?: number;
26
- };
27
-
28
- type UserMapConfigBase = {
29
- /** Connection to use specifically for this map. If omitted, uses the `VelocityClient`'s connection. */
30
- connection?: Connection;
31
- /** How the map keeps its accounts up to date after the initial sync. */
32
- subscriptionConfig:
33
- | {
34
- type: 'polling';
35
- /** Milliseconds between full re-syncs. */
36
- frequency: number;
37
- commitment?: Commitment;
38
- }
39
- | {
40
- type: 'grpc';
41
- grpcConfigs: GrpcConfigs;
42
- resubTimeoutMs?: number;
43
- logResubMessages?: boolean;
44
- }
45
- | {
46
- type: 'websocket';
47
- resubTimeoutMs?: number;
48
- logResubMessages?: boolean;
49
- commitment?: Commitment;
50
- };
51
-
52
- /** True to skip the initial load of userAccounts via getProgramAccounts */
53
- skipInitialLoad?: boolean;
54
-
55
- /** True to include idle users when loading. Defaults to false to decrease # of accounts subscribed to. */
56
- includeIdle?: boolean;
57
-
58
- /** Whether to skip loading available perp/spot positions and open orders */
59
- fastDecode?: boolean;
60
-
61
- /**
62
- * If true, will not do a full sync whenever StateAccount.numberOfSubAccounts changes.
63
- * default behavior is to do a full sync on changes.
64
- */
65
- disableSyncOnTotalAccountsChange?: boolean;
66
-
67
- /** Bulk-load strategy for the initial sync and subsequent full syncs. Defaults to `{ type: 'default' }`. */
68
- syncConfig?: SyncConfig;
69
-
70
- /** Whether to throw an error if the userMap fails to sync. Defaults to false (errors are logged, not thrown). */
71
- throwOnFailedSync?: boolean;
72
-
73
- /** Whether to filter users by poolId. Defaults to undefined (all users, all pools). */
74
- filterByPoolId?: number;
75
-
76
- /** Extra memcmp filters ANDed onto the base `User`-account filter (and, unless `includeIdle`, the non-idle filter) for both the initial sync and the live subscription. */
77
- additionalFilters?: MemcmpFilter[];
78
- };
79
-
80
- export type UserMapConfig = UserMapConfigBase & {
81
- velocityClient: VelocityClient;
82
- };
@@ -1,393 +0,0 @@
1
- import { VelocityClient } from '../velocityClient';
2
- import { getUserStatsAccountPublicKey } from '../addresses/pda';
3
- import {
4
- OrderRecord,
5
- UserStatsAccount,
6
- DepositRecord,
7
- FundingPaymentRecord,
8
- LiquidationRecord,
9
- OrderActionRecord,
10
- SettlePnlRecord,
11
- NewUserRecord,
12
- InsuranceFundStakeRecord,
13
- } from '../types';
14
- import { UserStats } from '../userStats';
15
- import { WrappedEvent } from '../events/types';
16
- import { BulkAccountLoader } from '../accounts/bulkAccountLoader';
17
- import { PollingUserStatsAccountSubscriber } from '../accounts/pollingUserStatsAccountSubscriber';
18
- import { SyncConfig } from './userMapConfig';
19
- import { getUserStatsFilter } from '../memcmp';
20
- import { PublicKey } from '@solana/web3.js';
21
-
22
- import { UserMap } from './userMap';
23
-
24
- /**
25
- * In-memory cache of `UserStats` accounts (one per trading authority, shared
26
- * across that authority's sub-accounts), keyed by authority pubkey. Backed by
27
- * a shared `BulkAccountLoader` for the default sync strategy so many
28
- * `UserStats` can be fetched/polled together instead of one subscription each.
29
- */
30
- export class UserStatsMap {
31
- /**
32
- * map from authority pubkey to UserStats
33
- */
34
- private userStatsMap = new Map<string, UserStats>();
35
- private velocityClient: VelocityClient;
36
- private bulkAccountLoader: BulkAccountLoader;
37
- private decode;
38
- private syncConfig: SyncConfig;
39
-
40
- private syncPromise?: Promise<void>;
41
- private syncPromiseResolver: () => void = () => {};
42
-
43
- /**
44
- * Creates a new UserStatsMap instance.
45
- *
46
- * @param {VelocityClient} velocityClient - The VelocityClient instance.
47
- * @param {BulkAccountLoader} [bulkAccountLoader] - If not provided, a new BulkAccountLoader with polling disabled will be created.
48
- */
49
- constructor(
50
- velocityClient: VelocityClient,
51
- bulkAccountLoader?: BulkAccountLoader,
52
- syncConfig?: SyncConfig
53
- ) {
54
- this.velocityClient = velocityClient;
55
- if (!bulkAccountLoader) {
56
- bulkAccountLoader = new BulkAccountLoader(
57
- velocityClient.connection,
58
- velocityClient.opts?.commitment ?? 'confirmed',
59
- 0
60
- );
61
- }
62
- this.bulkAccountLoader = bulkAccountLoader;
63
-
64
- this.syncConfig = syncConfig ?? {
65
- type: 'default',
66
- };
67
-
68
- this.decode = (
69
- this.velocityClient.program.account as any
70
- ).userStats.coder.accounts.decodeUnchecked.bind(
71
- (this.velocityClient.program.account as any).userStats.coder.accounts
72
- );
73
- }
74
-
75
- /** Populates the map for `authorities` via `sync()` (no-op if the map already has entries). */
76
- public async subscribe(authorities: PublicKey[]) {
77
- if (this.size() > 0) {
78
- return;
79
- }
80
-
81
- await this.velocityClient.subscribe();
82
- await this.sync(authorities);
83
- }
84
-
85
- /**
86
- *
87
- * @param authority that owns the UserStatsAccount
88
- * @param userStatsAccount optional UserStatsAccount to subscribe to, if undefined will be fetched later
89
- * @param skipFetch if true, will not immediately fetch the UserStatsAccount
90
- */
91
- public async addUserStat(
92
- authority: PublicKey,
93
- userStatsAccount?: UserStatsAccount,
94
- skipFetch?: boolean
95
- ) {
96
- const userStat = new UserStats({
97
- velocityClient: this.velocityClient,
98
- userStatsAccountPublicKey: getUserStatsAccountPublicKey(
99
- this.velocityClient.program.programId,
100
- authority
101
- ),
102
- accountSubscription: {
103
- type: 'polling',
104
- accountLoader: this.bulkAccountLoader,
105
- },
106
- });
107
- if (skipFetch) {
108
- await (
109
- userStat.accountSubscriber as PollingUserStatsAccountSubscriber
110
- ).addToAccountLoader();
111
- } else {
112
- await userStat.subscribe(userStatsAccount);
113
- }
114
-
115
- this.userStatsMap.set(authority.toString(), userStat);
116
- }
117
-
118
- /** Ensures the `UserStats` entry exists for the authority behind `record.user` (looked up/created in `userMap` first), adding it if this map doesn't have it yet. */
119
- public async updateWithOrderRecord(record: OrderRecord, userMap: UserMap) {
120
- const user = await userMap.mustGet(record.user.toString());
121
- if (!this.has(user.getUserAccountOrThrow().authority.toString())) {
122
- await this.addUserStat(
123
- user.getUserAccountOrThrow().authority,
124
- undefined,
125
- false
126
- );
127
- }
128
- }
129
-
130
- /**
131
- * Incrementally updates the map in response to a single program event,
132
- * ensuring a `UserStats` entry exists for every authority the event
133
- * references (deposit/funding/new-user/IF-stake records reference an
134
- * authority directly; order/liquidation/settle-pnl/order-action records
135
- * reference a `User` account and require `userMap` to resolve its authority).
136
- * Events whose required `userMap` is not supplied, or whose type isn't
137
- * recognized, are silently ignored.
138
- */
139
- public async updateWithEventRecord(
140
- record: WrappedEvent<any>,
141
- userMap?: UserMap
142
- ) {
143
- if (record.eventType === 'DepositRecord') {
144
- const depositRecord = record as DepositRecord;
145
- await this.mustGet(depositRecord.userAuthority.toString());
146
- } else if (record.eventType === 'FundingPaymentRecord') {
147
- const fundingPaymentRecord = record as FundingPaymentRecord;
148
- await this.mustGet(fundingPaymentRecord.userAuthority.toString());
149
- } else if (record.eventType === 'LiquidationRecord') {
150
- if (!userMap) {
151
- return;
152
- }
153
-
154
- const liqRecord = record as LiquidationRecord;
155
-
156
- const user = await userMap.mustGet(liqRecord.user.toString());
157
- await this.mustGet(user.getUserAccountOrThrow().authority.toString());
158
-
159
- const liquidatorUser = await userMap.mustGet(
160
- liqRecord.liquidator.toString()
161
- );
162
- await this.mustGet(
163
- liquidatorUser.getUserAccountOrThrow().authority.toString()
164
- );
165
- } else if (record.eventType === 'OrderRecord') {
166
- if (!userMap) {
167
- return;
168
- }
169
- const orderRecord = record as OrderRecord;
170
- await userMap.updateWithOrderRecord(orderRecord);
171
- } else if (record.eventType === 'OrderActionRecord') {
172
- if (!userMap) {
173
- return;
174
- }
175
- const actionRecord = record as OrderActionRecord;
176
-
177
- if (actionRecord.taker) {
178
- const taker = await userMap.mustGet(actionRecord.taker.toString());
179
- await this.mustGet(taker.getUserAccountOrThrow().authority.toString());
180
- }
181
- if (actionRecord.maker) {
182
- const maker = await userMap.mustGet(actionRecord.maker.toString());
183
- await this.mustGet(maker.getUserAccountOrThrow().authority.toString());
184
- }
185
- } else if (record.eventType === 'SettlePnlRecord') {
186
- if (!userMap) {
187
- return;
188
- }
189
- const settlePnlRecord = record as SettlePnlRecord;
190
- const user = await userMap.mustGet(settlePnlRecord.user.toString());
191
- await this.mustGet(user.getUserAccountOrThrow().authority.toString());
192
- } else if (record.eventType === 'NewUserRecord') {
193
- const newUserRecord = record as NewUserRecord;
194
- await this.mustGet(newUserRecord.userAuthority.toString());
195
- } else if (record.eventType === 'InsuranceFundStakeRecord') {
196
- const ifStakeRecord = record as InsuranceFundStakeRecord;
197
- await this.mustGet(ifStakeRecord.userAuthority.toString());
198
- }
199
- }
200
-
201
- /** Returns true if `authorityPublicKey` has a `UserStats` cached in the map. */
202
- public has(authorityPublicKey: string): boolean {
203
- return this.userStatsMap.has(authorityPublicKey);
204
- }
205
-
206
- /** Returns the cached `UserStats` for `authorityPublicKey`, or `undefined` if not (yet) in the map. */
207
- public get(authorityPublicKey: string): UserStats | undefined {
208
- return this.userStatsMap.get(authorityPublicKey);
209
- }
210
-
211
- /**
212
- * Enforce that a UserStats will exist for the given authorityPublicKey,
213
- * reading one from the blockchain if necessary.
214
- * @param authorityPublicKey
215
- * @returns
216
- */
217
- public async mustGet(authorityPublicKey: string): Promise<UserStats> {
218
- if (!this.has(authorityPublicKey)) {
219
- await this.addUserStat(
220
- new PublicKey(authorityPublicKey),
221
- undefined,
222
- false
223
- );
224
- }
225
- const userStats = this.get(authorityPublicKey);
226
- if (!userStats) {
227
- throw new Error(
228
- `UserStatsMap: UserStats missing for authority ${authorityPublicKey} after addUserStat`
229
- );
230
- }
231
- return userStats;
232
- }
233
-
234
- /** Iterates all cached `UserStats` instances. */
235
- public values(): IterableIterator<UserStats> {
236
- return this.userStatsMap.values();
237
- }
238
-
239
- /** Number of authorities currently cached in the map. */
240
- public size(): number {
241
- return this.userStatsMap.size;
242
- }
243
-
244
- /**
245
- * Sync the UserStatsMap
246
- * @param authorities list of authorities to derive UserStatsAccount public keys from.
247
- * You may want to get this list from UserMap in order to filter out idle users
248
- */
249
- public async sync(authorities: PublicKey[]) {
250
- if (this.syncConfig.type === 'default') {
251
- return this.defaultSync(authorities);
252
- } else {
253
- return this.paginatedSync(authorities);
254
- }
255
- }
256
-
257
- /**
258
- * Sync the UserStatsMap using the default sync method, which loads individual users into the bulkAccountLoader and
259
- * loads them. (bulkAccountLoader uses batch getMultipleAccounts)
260
- * @param authorities
261
- */
262
- private async defaultSync(authorities: PublicKey[]) {
263
- await Promise.all(
264
- authorities.map((authority) =>
265
- this.addUserStat(authority, undefined, true)
266
- )
267
- );
268
- await this.bulkAccountLoader.load();
269
- }
270
-
271
- /**
272
- * Sync the UserStatsMap using the paginated sync method, which uses multiple getMultipleAccounts calls (without RPC batching), and limits concurrency.
273
- * @param authorities
274
- */
275
- private async paginatedSync(authorities: PublicKey[]) {
276
- if (this.syncPromise) {
277
- return this.syncPromise;
278
- }
279
-
280
- this.syncPromise = new Promise<void>((resolve) => {
281
- this.syncPromiseResolver = resolve;
282
- });
283
-
284
- try {
285
- let accountsToLoad = authorities;
286
- if (authorities.length === 0) {
287
- const accountsPrefetch =
288
- await this.velocityClient.connection.getProgramAccounts(
289
- this.velocityClient.program.programId,
290
- {
291
- dataSlice: { offset: 0, length: 0 },
292
- filters: [getUserStatsFilter()],
293
- }
294
- );
295
- accountsToLoad = accountsPrefetch.map((account) => account.pubkey);
296
- }
297
-
298
- const limitConcurrency = async (
299
- tasks: Array<() => Promise<void>>,
300
- limit: number
301
- ) => {
302
- const executing: Array<Promise<void>> = [];
303
- const results: Array<Promise<void>> = [];
304
-
305
- for (let i = 0; i < tasks.length; i++) {
306
- const executor = Promise.resolve().then(tasks[i]);
307
- results.push(executor);
308
-
309
- if (executing.length < limit) {
310
- executing.push(executor);
311
- executor.finally(() => {
312
- const index = executing.indexOf(executor);
313
- if (index > -1) {
314
- executing.splice(index, 1);
315
- }
316
- });
317
- } else {
318
- await Promise.race(executing);
319
- }
320
- }
321
-
322
- return Promise.all(results);
323
- };
324
-
325
- const programAccountBufferMap = new Set<string>();
326
-
327
- // @ts-ignore
328
- const chunkSize = this.syncConfig.chunkSize ?? 100;
329
- const tasks: Array<() => Promise<void>> = [];
330
- for (let i = 0; i < accountsToLoad.length; i += chunkSize) {
331
- const chunk = accountsToLoad.slice(i, i + chunkSize);
332
- tasks.push(async () => {
333
- const accountInfos =
334
- await this.velocityClient.connection.getMultipleAccountsInfoAndContext(
335
- chunk,
336
- {
337
- commitment: this.velocityClient.opts?.commitment,
338
- }
339
- );
340
-
341
- for (let j = 0; j < accountInfos.value.length; j += 1) {
342
- const accountInfo = accountInfos.value[j];
343
- if (accountInfo === null) continue;
344
-
345
- const publicKeyString = chunk[j].toString();
346
- if (!this.has(publicKeyString)) {
347
- const buffer = Buffer.from(accountInfo.data);
348
- const decodedUserStats = this.decode(
349
- 'userStats',
350
- buffer
351
- ) as UserStatsAccount;
352
- programAccountBufferMap.add(
353
- decodedUserStats.authority.toBase58()
354
- );
355
- this.addUserStat(
356
- decodedUserStats.authority,
357
- decodedUserStats,
358
- false
359
- );
360
- }
361
- }
362
- });
363
- }
364
-
365
- // @ts-ignore
366
- const concurrencyLimit = this.syncConfig.concurrencyLimit ?? 10;
367
- await limitConcurrency(tasks, concurrencyLimit);
368
-
369
- for (const [key] of this.userStatsMap.entries()) {
370
- if (!programAccountBufferMap.has(key)) {
371
- const user = this.get(key);
372
- if (user) {
373
- await user.unsubscribe();
374
- this.userStatsMap.delete(key);
375
- }
376
- }
377
- }
378
- } catch (err) {
379
- console.error(`Error in UserStatsMap.paginatedSync():`, err);
380
- } finally {
381
- this.syncPromiseResolver();
382
- this.syncPromise = undefined;
383
- }
384
- }
385
-
386
- /** Unsubscribes and removes every cached `UserStats` from the map. */
387
- public async unsubscribe() {
388
- for (const [key, userStats] of this.userStatsMap.entries()) {
389
- await userStats.unsubscribe();
390
- this.userStatsMap.delete(key);
391
- }
392
- }
393
- }
package/src/userName.ts DELETED
@@ -1,37 +0,0 @@
1
- /** Maximum length, in characters/bytes, of a `User`/`SpotMarket`/`PerpMarket` name field on-chain. */
2
- export const MAX_NAME_LENGTH = 32;
3
-
4
- /** Default name assigned to a user's first sub-account (id 0) when none is supplied. */
5
- export const DEFAULT_USER_NAME = 'Main Account';
6
- /** Default name used for a market when no explicit name is configured. */
7
- export const DEFAULT_MARKET_NAME = 'Default Market Name';
8
-
9
- /**
10
- * Encodes a name into the fixed 32-byte, space-padded on-chain representation used by `User`,
11
- * `PerpMarket`, and `SpotMarket` name fields.
12
- * @param name - Name to encode; must be at most `MAX_NAME_LENGTH` (32) characters.
13
- * @returns A 32-element array of bytes: the UTF-8 encoding of `name` followed by space (`0x20`)
14
- * padding to fill the remaining length.
15
- * @throws Error if `name` is longer than `MAX_NAME_LENGTH`.
16
- */
17
- export function encodeName(name: string): number[] {
18
- if (name.length > MAX_NAME_LENGTH) {
19
- throw Error(`Name (${name}) longer than 32 characters`);
20
- }
21
-
22
- const buffer = Buffer.alloc(32);
23
- buffer.fill(name);
24
- buffer.fill(' ', name.length);
25
-
26
- return Array(...buffer);
27
- }
28
-
29
- /**
30
- * Decodes a fixed 32-byte on-chain name field back into a trimmed string, reversing `encodeName`.
31
- * @param bytes - The raw 32-byte name field as read from an account.
32
- * @returns The name with trailing (and leading) whitespace padding removed.
33
- */
34
- export function decodeName(bytes: number[]): string {
35
- const buffer = Buffer.from(bytes);
36
- return buffer.toString('utf8').trim();
37
- }
package/src/userStats.ts DELETED
@@ -1,159 +0,0 @@
1
- /**
2
- * UserStats — abstraction over the on-chain `UserStats` account.
3
- * Tracks referral links, 30-day maker/taker volume, and IF staking stats.
4
- * One `UserStats` account exists per authority (shared across all subaccounts).
5
- */
6
- import { VelocityClient } from './velocityClient';
7
- import { PublicKey } from '@solana/web3.js';
8
- import { DataAndSlot, UserStatsAccountSubscriber } from './accounts/types';
9
- import { UserStatsConfig } from './userStatsConfig';
10
- import { PollingUserStatsAccountSubscriber } from './accounts/pollingUserStatsAccountSubscriber';
11
- import { WebSocketUserStatsAccountSubscriber } from './accounts/webSocketUserStatsAccountSubsriber';
12
- import { ReferrerInfo, UserStatsAccount } from './types';
13
- import {
14
- getUserAccountPublicKeySync,
15
- getUserStatsAccountPublicKey,
16
- } from './addresses/pda';
17
- import { grpcUserStatsAccountSubscriber } from './accounts/grpcUserStatsAccountSubscriber';
18
-
19
- export class UserStats {
20
- velocityClient: VelocityClient;
21
- userStatsAccountPublicKey: PublicKey;
22
- accountSubscriber: UserStatsAccountSubscriber;
23
- isSubscribed = false;
24
-
25
- public constructor(config: UserStatsConfig) {
26
- // Type-system guarantees at least one of the two is supplied.
27
- const velocityClient = config.velocityClient!;
28
- this.velocityClient = velocityClient;
29
- this.userStatsAccountPublicKey = config.userStatsAccountPublicKey;
30
- if (config.accountSubscription?.type === 'polling') {
31
- this.accountSubscriber = new PollingUserStatsAccountSubscriber(
32
- velocityClient.program,
33
- config.userStatsAccountPublicKey,
34
- config.accountSubscription.accountLoader
35
- );
36
- } else if (config.accountSubscription?.type === 'grpc') {
37
- this.accountSubscriber = new grpcUserStatsAccountSubscriber(
38
- config.accountSubscription.grpcConfigs,
39
- velocityClient.program,
40
- config.userStatsAccountPublicKey,
41
- {
42
- resubTimeoutMs: config.accountSubscription?.resubTimeoutMs,
43
- logResubMessages: config.accountSubscription?.logResubMessages,
44
- }
45
- );
46
- } else if (config.accountSubscription?.type === 'websocket') {
47
- this.accountSubscriber = new WebSocketUserStatsAccountSubscriber(
48
- velocityClient.program,
49
- config.userStatsAccountPublicKey,
50
- {
51
- resubTimeoutMs: config.accountSubscription?.resubTimeoutMs,
52
- logResubMessages: config.accountSubscription?.logResubMessages,
53
- },
54
- config.accountSubscription.commitment
55
- );
56
- } else if (config.accountSubscription?.type === 'custom') {
57
- this.accountSubscriber =
58
- config.accountSubscription.userStatsAccountSubscriber;
59
- } else {
60
- const exhaustiveCheck: undefined = config.accountSubscription;
61
-
62
- throw new Error(
63
- `Unknown user stats account subscription type: ${exhaustiveCheck}`
64
- );
65
- }
66
- }
67
-
68
- /**
69
- * Subscribes to this authority's `UserStats` account.
70
- * @param userStatsAccount Optional pre-fetched account to seed the subscriber with, skipping the initial RPC fetch.
71
- * @returns True once the underlying subscriber reports subscribed.
72
- */
73
- public async subscribe(
74
- userStatsAccount?: UserStatsAccount
75
- ): Promise<boolean> {
76
- this.isSubscribed = await this.accountSubscriber.subscribe(
77
- userStatsAccount
78
- );
79
- return this.isSubscribed;
80
- }
81
-
82
- /** Forces the account subscriber to re-fetch the `UserStats` account from RPC. */
83
- public async fetchAccounts(): Promise<void> {
84
- await this.accountSubscriber.fetch();
85
- }
86
-
87
- /** Tears down the `UserStats` account subscription. */
88
- public async unsubscribe(): Promise<void> {
89
- await this.accountSubscriber.unsubscribe();
90
- this.isSubscribed = false;
91
- }
92
-
93
- /** Like `getAccount`, but also returns the slot at which the account was last observed. Same `undefined`-when-not-found contract. */
94
- public getAccountAndSlot(): DataAndSlot<UserStatsAccount> | undefined {
95
- return this.accountSubscriber.getUserStatsAccountAndSlot();
96
- }
97
-
98
- /**
99
- * Returns the cached `UserStats` account, or `undefined` if it has not been
100
- * loaded yet (e.g. `subscribe()` has not resolved, or the account does not
101
- * exist on chain). Unlike `User.getUserAccount`, this does not throw
102
- * `NotSubscribedError` when called before subscribing — it simply returns
103
- * `undefined` from the subscriber's initial (empty) state.
104
- */
105
- public getAccount(): UserStatsAccount | undefined {
106
- return this.accountSubscriber.getUserStatsAccountAndSlot()?.data;
107
- }
108
-
109
- /**
110
- * Like `getAccount` but throws a named error instead of returning
111
- * `undefined` when the stats account has not been loaded yet.
112
- */
113
- public getAccountOrThrow(): UserStatsAccount {
114
- const account = this.getAccount();
115
- if (!account) {
116
- throw new Error('UserStats account not loaded');
117
- }
118
- return account;
119
- }
120
-
121
- /**
122
- * Returns the addresses of this user's referrer's `User` (sub-account 0)
123
- * and `UserStats` accounts, or `undefined` if the account is not loaded or
124
- * has no referrer set (`referrer` is the default/zero pubkey).
125
- */
126
- public getReferrerInfo(): ReferrerInfo | undefined {
127
- const account = this.getAccount();
128
- if (!account || account.referrer.equals(PublicKey.default)) {
129
- return undefined;
130
- } else {
131
- return {
132
- referrer: getUserAccountPublicKeySync(
133
- this.velocityClient.program.programId,
134
- account.referrer,
135
- 0
136
- ),
137
- referrerStats: getUserStatsAccountPublicKey(
138
- this.velocityClient.program.programId,
139
- account.referrer
140
- ),
141
- };
142
- }
143
- }
144
-
145
- /**
146
- * Returns the earliest of the account's three rolling-30-day activity
147
- * timestamps (filler, maker, taker volume), i.e. the oldest evidence of
148
- * account activity — used to estimate account age for deletion-eligibility
149
- * checks (see `User.canBeDeleted`).
150
- * @returns Unix timestamp in seconds.
151
- */
152
- public static getOldestActionTs(account: UserStatsAccount): number {
153
- return Math.min(
154
- account.lastFillerVolume30DTs.toNumber(),
155
- account.lastMakerVolume30DTs.toNumber(),
156
- account.lastTakerVolume30DTs.toNumber()
157
- );
158
- }
159
- }
@@ -1,35 +0,0 @@
1
- import { VelocityClient } from './velocityClient';
2
- import { Commitment, PublicKey } from '@solana/web3.js';
3
- import { BulkAccountLoader } from './accounts/bulkAccountLoader';
4
- import { GrpcConfigs, UserStatsAccountSubscriber } from './accounts/types';
5
-
6
- type UserStatsConfigBase = {
7
- accountSubscription?: UserStatsSubscriptionConfig;
8
- userStatsAccountPublicKey: PublicKey;
9
- };
10
-
11
- export type UserStatsConfig = UserStatsConfigBase & {
12
- velocityClient: VelocityClient;
13
- };
14
-
15
- export type UserStatsSubscriptionConfig =
16
- | {
17
- type: 'websocket';
18
- resubTimeoutMs?: number;
19
- logResubMessages?: boolean;
20
- commitment?: Commitment;
21
- }
22
- | {
23
- type: 'polling';
24
- accountLoader: BulkAccountLoader;
25
- }
26
- | {
27
- type: 'custom';
28
- userStatsAccountSubscriber: UserStatsAccountSubscriber;
29
- }
30
- | {
31
- type: 'grpc';
32
- resubTimeoutMs?: number;
33
- logResubMessages?: boolean;
34
- grpcConfigs: GrpcConfigs;
35
- };