Repository navigation
Expand file tree
/
Copy pathRestClient.ts
More file actions
1762 lines (1604 loc) · 48.6 KB
/
Copy pathRestClient.ts
File metadata and controls
1762 lines (1604 loc) · 48.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { MAINNET_API_URL, TESTNET_API_URL } from './constants.js';
import type { AssetIdentifier } from './lib/action-factory.js';
import type { ResolvedAsset } from './lib/asset-resolver.js';
import { BaseRestClient } from './lib/BaseRestClient.js';
import { decimalToWire } from './lib/decimal.js';
import { normalizeAddresses } from './lib/normalize-addresses.js';
import {
decimalOrSubaccountAmount,
floorDecimalPlaces,
marketLimitPrice,
normalizeUserRequest,
positiveDecimal,
} from './lib/request-utils.js';
import { USER_SIGNED_ACTIONS } from './lib/user-signed-actions.js';
import type {
ApproveApiWalletRequest,
CancelOrdersByClientOrderIdRequest,
CancelOrdersRequest,
CancelTwapOrderRequest,
ConvertToMultiSigUserRequest,
DelegateOrUndelegateStakeRequest,
DeployPerpRequest,
DeploySpotRequest,
L1RequestOptions,
LinkStakingAccountRequest,
ModifyOrderRequest,
ModifyOrdersRequest,
SendAssetFromApiWalletRequest,
SendAssetRequest,
SendSpotAssetRequest,
SendToEvmWithDataRequest,
SendUsdRequest,
SetIsolatedMarginLeverageRequest,
SetUserAbstractionRequest,
SubmitLimitOrderRequest,
SubmitMarketCloseRequest,
SubmitMarketOrderRequest,
SubmitOrderRequest,
SubmitTwapOrderRequest,
SubmitUserOutcomeRequest,
TransferSpotToOrFromSubAccountRequest,
TransferUsdBetweenSpotAndPerpRequest,
TransferUsdToOrFromSubAccountRequest,
TransferVaultFundsRequest,
UpdateIsolatedMarginRequest,
UpdateLeverageRequest,
UserSignedRequestOptions,
UserToggleRequest,
WithdrawUsdRequest,
} from './types/request/exchange.types.js';
import type {
AccountDexRequest,
AccountRequest,
GetCandlesRequest,
GetFundingHistoryRequest,
GetMaxBuilderFeeRequest,
GetOrderBookRequest,
GetOrderStatusRequest,
GetPreTransferCheckRequest,
GetUserBorrowLendInterestRequest,
GetUserFillsByTimeRequest,
GetUserFillsRequest,
GetUserFundingHistoryRequest,
GetUserNonFundingLedgerUpdatesRequest,
GetUserTwapSliceFillsByTimeRequest,
GetVaultDetailsRequest,
UserRequest,
} from './types/request/info.types.js';
import type {
CancelResponseData,
ExchangeResponse,
OrderResponseData,
TwapCancelResponseData,
TwapOrderResponseData,
} from './types/response/exchange.types.js';
import type {
AccountBalancesResponse,
ActiveAssetData,
AlignedQuoteTokenStatus,
AllMidsResponse,
BorrowLendReserveEntry,
BorrowLendReserveState,
BorrowLendUserState,
Candle,
ExchangeStatus,
ExtraAgent,
FrontendOpenOrder,
FundingHistory,
GossipPriorityAuctionStatus,
HistoricalOrder,
LeadingVault,
LegalStatus,
LiquidatablePosition,
MaxMarketOrderNotional,
MultiSigSigners,
OpenOrder,
OrderBookResponse,
OrderStatusResponse,
OutcomeDeployerLimits,
OutcomeMetadata,
PerpAccountSummaryResponse,
PerpAnnotation,
PerpCategory,
PerpConciseAnnotation,
PerpDeployAuctionStatus,
PerpDex,
PerpDexLimits,
PerpDexStatus,
PerpMarginTable,
PerpMeta,
PerpMetaAndAssetContexts,
PortfolioEntry,
PredictedFunding,
PreTransferCheck,
ReferralInfo,
SettledOutcome,
SpotBalancesResponse,
SpotDeployStateResponse,
SpotMeta,
SpotMetaAndAssetContexts,
SpotPairDeployAuctionStatus,
StakingDelegation,
StakingHistoryEntry,
StakingReward,
StakingSummary,
SubAccount,
SubAccountWithAllDexStates,
TokenDetails,
Trade,
TwapHistoryEntry,
TwapSliceFill,
UserAbstraction,
UserBorrowLendInterest,
UserFees,
UserFill,
UserFunding,
UserNonFundingLedgerUpdate,
UserRateLimit,
UserRoleResponse,
UserVaultDeposit,
ValidatorL1Vote,
ValidatorSummary,
VaultDetails,
VaultSummary,
WebData2,
} from './types/response/info.types.js';
import type {
JsonObject,
RestClientNetworkOptions,
RestClientOptions,
} from './types/shared.types.js';
type InfoParams = object;
const DEFAULT_MARKET_ORDER_SLIPPAGE = 0.05;
function hip3Dex(canonicalName: string): string | undefined {
return canonicalName.includes(':')
? canonicalName.split(':', 1)[0]
: undefined;
}
export class RestClient extends BaseRestClient {
constructor(
options: RestClientOptions = {},
networkOptions: RestClientNetworkOptions = {},
) {
super(
options.baseUrl ??
(options.testnet === true ? TESTNET_API_URL : MAINNET_API_URL),
options,
networkOptions,
);
}
resolveAsset(identifier: AssetIdentifier): Promise<ResolvedAsset> {
return this.assetResolver.resolve(identifier);
}
nameToCoin(name: string): Promise<string> {
return this.assetResolver.nameToCoin(name);
}
refreshAssetMetadata(): Promise<void> {
return this.assetResolver.refresh();
}
getAccountAddress(): Promise<string> {
return this.resolveAccountAddress(undefined);
}
/**
* Mid prices for all coins (`allMids`).
*
* An empty book falls back to the last trade price. Spot mids are included
* only when `dex` is omitted or empty.
*/
getAllMids(params: { dex?: string } = {}): Promise<AllMidsResponse> {
return this.info('allMids', params);
}
/**
* User's active asset data (`activeAssetData`): leverage, max trade size,
* available to trade, and mark price for one coin.
*/
getActiveAssetData(
params: AccountRequest & { coin: string },
): Promise<ActiveAssetData> {
return this.accountInfo('activeAssetData', params);
}
/**
* Borrow and lend reserve state for every token (`allBorrowLendReserveStates`).
*
* Each entry is `[token, reserve]`.
*/
getAllBorrowLendReserveStates(): Promise<BorrowLendReserveEntry[]> {
return this.info('allBorrowLendReserveStates', {});
}
/**
* Metadata for every perp DEX (`allPerpMetas`).
*
* Each entry is one DEX: universe, margin tables, and collateral token.
* Index 0 is the default perp DEX.
*/
getAllPerpMetadata(): Promise<PerpMeta[]> {
return this.info('allPerpMetas', {});
}
/**
* Builder addresses this user has approved (`approvedBuilders`).
*/
getApprovedBuilders(params: AccountRequest = {}): Promise<string[]> {
return this.accountInfo('approvedBuilders', params);
}
/**
* Borrow and lend reserve state for one token (`borrowLendReserveState`).
*/
getBorrowLendReserveState(params: {
token: number;
}): Promise<BorrowLendReserveState> {
return this.info('borrowLendReserveState', params);
}
/**
* User borrow and lend balances (`borrowLendUserState`).
*
* `tokenToState` entries are `[token, state]`.
*/
getUserBorrowLendState(
params: AccountRequest = {},
): Promise<BorrowLendUserState> {
return this.accountInfo('borrowLendUserState', params);
}
/**
* Candle snapshot (`candleSnapshot`).
*
* Only the most recent 5000 candles are available. HIP-3 coins use a
* `dex:COIN` name.
*/
async getCandles(params: GetCandlesRequest): Promise<Candle[]> {
return this.info('candleSnapshot', {
req: { ...params, coin: await this.nameToCoin(params.coin) },
});
}
/**
* Perp account summary (`clearinghouseState`): open positions and margin.
*
* `assetPositions[].position.szi` is signed: positive is long, negative is short.
* Under unified account or portfolio margin, use spot balances for the
* trading account balance across spot and perps.
*/
getPerpAccountSummary(
params: AccountDexRequest = {},
): Promise<PerpAccountSummaryResponse> {
return this.accountInfo('clearinghouseState', params);
}
/**
* Stake delegated to validators (`delegations`).
*/
getStakingDelegations(
params: AccountRequest = {},
): Promise<StakingDelegation[]> {
return this.accountInfo('delegations', params);
}
/**
* Staking history (`delegatorHistory`).
*
* `delta` is one of `delegate`, `cDeposit`, or `withdrawal`.
*/
getStakingHistory(
params: AccountRequest = {},
): Promise<StakingHistoryEntry[]> {
return this.accountInfo('delegatorHistory', params);
}
/**
* Staking rewards (`delegatorRewards`).
*
* `source` is `"delegation"` or `"commission"` in the documented samples.
*/
getStakingRewards(params: AccountRequest = {}): Promise<StakingReward[]> {
return this.accountInfo('delegatorRewards', params);
}
/**
* Staking summary (`delegatorSummary`): delegated, undelegated, and pending withdrawals.
*/
getStakingSummary(params: AccountRequest = {}): Promise<StakingSummary> {
return this.accountInfo('delegatorSummary', params);
}
getExchangeStatus(): Promise<ExchangeStatus> {
return this.info('exchangeStatus', {});
}
getExtraAgents(params: AccountRequest = {}): Promise<ExtraAgent[]> {
return this.accountInfo('extraAgents', params);
}
/**
* Open orders with trigger and reduce-only fields (`frontendOpenOrders`).
*
* Spot orders are included only for the first perp DEX.
*/
getFrontendOpenOrders(
params: AccountDexRequest = {},
): Promise<FrontendOpenOrder[]> {
return this.accountInfo('frontendOpenOrders', params);
}
/**
* Historical funding rates for one coin (`fundingHistory`).
*/
async getFundingHistory(
params: GetFundingHistoryRequest,
): Promise<FundingHistory[]> {
return this.info('fundingHistory', {
...params,
coin: await this.nameToCoin(params.coin),
});
}
getGossipPriorityAuctionStatus(): Promise<GossipPriorityAuctionStatus> {
return this.info('gossipPriorityAuctionStatus', {});
}
getGossipRootIps(): Promise<string[]> {
return this.info('gossipRootIps', {});
}
/**
* Recent historical orders (`historicalOrders`).
*
* Returns at most 2000 orders. `status` uses the same values as `getOrderStatus()`.
*/
getOrderHistory(params: AccountRequest = {}): Promise<HistoricalOrder[]> {
return this.accountInfo('historicalOrders', params);
}
getVipStatus(params: AccountRequest = {}): Promise<boolean> {
return this.accountInfo('isVip', params);
}
/**
* L2 order book (`l2Book`).
*
* At most 20 levels per side. `nSigFigs` aggregates prices. `mantissa` is
* only valid when `nSigFigs` is 5.
*/
async getOrderBook(
params: GetOrderBookRequest,
): Promise<OrderBookResponse | null> {
return this.info('l2Book', {
...params,
coin: await this.nameToCoin(params.coin),
});
}
getLeadingVaults(params: AccountRequest = {}): Promise<LeadingVault[]> {
return this.accountInfo('leadingVaults', params);
}
getLegalStatus(params: AccountRequest = {}): Promise<LegalStatus> {
return this.accountInfo('legalCheck', params);
}
getLiquidatablePositions(): Promise<LiquidatablePosition[]> {
return this.info('liquidatable', {});
}
getMarginTable(params: { id: number }): Promise<PerpMarginTable> {
return this.info('marginTable', params);
}
/**
* Maximum approved builder fee (`maxBuilderFee`).
*
* The number is in tenths of a basis point. `1` means 0.001%.
*/
getMaxBuilderFee(params: GetMaxBuilderFeeRequest): Promise<number> {
return this.accountInfo('maxBuilderFee', params);
}
getMaxMarketOrderNotionals(): Promise<MaxMarketOrderNotional[]> {
return this.info('maxMarketOrderNtls', {});
}
/**
* Perp metadata (`meta`): universe and margin tables.
*
* `dex` defaults to the empty string, which is the first perp DEX.
*/
getPerpMetadata(params: { dex?: string } = {}): Promise<PerpMeta> {
return this.info('meta', params);
}
/**
* Perp metadata plus asset contexts (`metaAndAssetCtxs`).
*
* The tuple is `[meta, contexts]`. Contexts line up with `meta.universe`
* and include mark price, funding, open interest, and related fields.
* `dex` defaults to the empty string, which is the first perp DEX.
*/
getPerpAssetContexts(
params: { dex?: string } = {},
): Promise<PerpMetaAndAssetContexts> {
return this.info('metaAndAssetCtxs', params);
}
/**
* Open orders (`openOrders`).
*
* Spot orders are included only for the first perp DEX. `side` `"B"` is bid
* and `"A"` is ask.
*/
getOpenOrders(params: AccountDexRequest = {}): Promise<OpenOrder[]> {
return this.accountInfo('openOrders', params);
}
/**
* Order status by order id or client order id (`orderStatus`).
*
* `status: "unknownOid"` means the order was not found. Otherwise
* `status` is `"order"` and `order.status` is the order state.
*/
getOrderStatus(params: GetOrderStatusRequest): Promise<OrderStatusResponse> {
return this.accountInfo('orderStatus', params);
}
/**
* Outcome metadata (`outcomeMeta`): outcomes, questions, and deployers.
*/
getOutcomeMetadata(): Promise<OutcomeMetadata> {
return this.info('outcomeMeta', {});
}
/**
* Remaining outcome deployment allowance for a venue (`outcomeDeployerLimits`).
*
* `venue` is the venue name, for example `"out"`.
*/
getOutcomeDeployerLimits(params: {
venue: string;
}): Promise<OutcomeDeployerLimits> {
return this.info('outcomeDeployerLimits', params);
}
/**
* Perp annotation for one coin (`perpAnnotation`).
*
* Returns `null` when the coin has no annotation.
*/
getPerpAnnotation(params: { coin: string }): Promise<PerpAnnotation | null> {
return this.info('perpAnnotation', params);
}
/**
* Perp category for each listed coin (`perpCategories`).
*
* Each entry is `[coin, category]`.
*/
getPerpCategories(): Promise<PerpCategory[]> {
return this.info('perpCategories', {});
}
/**
* Concise perp annotations (`perpConciseAnnotations`).
*
* Each entry is `[coin, annotation]`. `keywords` is omitted when absent.
*/
getConcisePerpAnnotations(): Promise<PerpConciseAnnotation[]> {
return this.info('perpConciseAnnotations', {});
}
/**
* Perp deploy auction status (`perpDeployAuctionStatus`).
*/
getPerpDeployAuctionStatus(): Promise<PerpDeployAuctionStatus> {
return this.info('perpDeployAuctionStatus', {});
}
/**
* Builder-deployed perp market limits (`perpDexLimits`).
*
* `dex` is required. The empty string is not allowed.
*/
getPerpDexLimits(params: { dex: string }): Promise<PerpDexLimits> {
return this.info('perpDexLimits', params);
}
/**
* Perp DEX deposit status (`perpDexStatus`).
*
* The empty string is the first perp DEX.
*/
getPerpDexStatus(params: { dex: string }): Promise<PerpDexStatus> {
return this.info('perpDexStatus', params);
}
/**
* All perpetual DEXs (`perpDexs`).
*
* Index 0 is `null`, the default perp DEX. Later entries are
* builder-deployed HIP-3 DEXs.
*/
getPerpDexs(): Promise<Array<PerpDex | null>> {
return this.info('perpDexs', {});
}
/**
* Coins currently at their open-interest cap (`perpsAtOpenInterestCap`).
*
* `dex` selects a builder-deployed market. Omitted means the first perp DEX.
*/
getPerpsAtOpenInterestCap(params: { dex?: string } = {}): Promise<string[]> {
return this.info('perpsAtOpenInterestCap', params);
}
/**
* Account value, PnL, and volume history (`portfolio`).
*
* Each entry is `[period, snapshot]`. Periods include `day`, `week`,
* `month`, `allTime`, and the `perp*` variants.
*/
getPortfolio(params: AccountRequest = {}): Promise<PortfolioEntry[]> {
return this.accountInfo('portfolio', params);
}
getPreTransferCheck(
params: GetPreTransferCheckRequest,
): Promise<PreTransferCheck> {
return this.info('preTransferCheck', normalizeAddresses(params));
}
/**
* Predicted funding rates by venue (`predictedFundings`).
*
* Only the first perp DEX is supported. Each entry is `[coin, venues]`,
* and each venue is `[venue, quote]`. `quote` is `null` when that venue
* has no predicted rate.
*/
getPredictedFundingRates(): Promise<PredictedFunding[]> {
return this.info('predictedFundings', {});
}
getRecentTrades(params: { coin: string }): Promise<Trade[]> {
return this.info('recentTrades', params);
}
/**
* Referral state (`referral`).
*
* `referredBy` is `null` when the user was not referred. `referrerState.stage`
* is `"ready"` or `"needToTrade"`. Claimed rewards now also appear in the
* non-funding ledger. `rewardHistory` is legacy.
*/
getReferralInfo(params: AccountRequest = {}): Promise<ReferralInfo> {
return this.accountInfo('referral', params);
}
/**
* Settled outcome (`settledOutcome`).
*
* Returns `null` when the outcome is still unsettled.
*/
getSettledOutcome(params: {
outcome: number;
}): Promise<SettledOutcome | null> {
return this.info('settledOutcome', params);
}
async getBalances(
params: AccountDexRequest = {},
): Promise<AccountBalancesResponse> {
const user = await this.resolveAccountAddress(params.user);
const [perp, spot] = await Promise.all([
this.getPerpAccountSummary({
user,
...(params.dex === undefined ? {} : { dex: params.dex }),
}),
this.getSpotBalances({ user }),
]);
return { perp, spot, user };
}
/**
* Spot token balances (`spotClearinghouseState`).
*
* Under unified account or portfolio margin, this is the trading-account
* balance across spot and perps.
*/
getSpotBalances(params: AccountRequest = {}): Promise<SpotBalancesResponse> {
return this.accountInfo('spotClearinghouseState', params);
}
/**
* Spot deploy state for a user (`spotDeployState`), including the gas auction.
*/
getSpotDeployAuctionStatus(
params: AccountRequest = {},
): Promise<SpotDeployStateResponse> {
return this.accountInfo('spotDeployState', params);
}
/**
* Spot metadata (`spotMeta`): tokens and trading pairs.
*/
getSpotMetadata(): Promise<SpotMeta> {
return this.info('spotMeta', {});
}
/**
* Spot metadata plus asset contexts (`spotMetaAndAssetCtxs`).
*
* The tuple is `[meta, contexts]`. Contexts include mark price, volume,
* and supply. `midPx` is `null` when there is no mid.
*/
getSpotAssetContexts(): Promise<SpotMetaAndAssetContexts> {
return this.info('spotMetaAndAssetCtxs', {});
}
/**
* Dutch auction for deploying a spot pair (`spotPairDeployAuctionStatus`).
*/
getSpotPairDeployAuctionStatus(): Promise<SpotPairDeployAuctionStatus> {
return this.info('spotPairDeployAuctionStatus', {});
}
/**
* Subaccounts of a master (`subAccounts`).
*
* Returns `null` when the address has no subaccounts.
*/
getSubAccounts(params: AccountRequest = {}): Promise<SubAccount[] | null> {
return this.accountInfo('subAccounts', params);
}
getSubAccountsWithAllDexStates(
params: AccountRequest = {},
): Promise<SubAccountWithAllDexStates[] | null> {
return this.accountInfo('subAccounts2', params);
}
/**
* Token details (`tokenDetails`): supply, prices, and genesis balances.
*
* `tokenId` is the 34-character onchain id, for example
* `0x00000000000000000000000000000000`.
*/
getTokenDetails(params: { tokenId: string }): Promise<TokenDetails> {
return this.info('tokenDetails', params);
}
getTwapHistory(params: AccountRequest = {}): Promise<TwapHistoryEntry[]> {
return this.accountInfo('twapHistory', params);
}
/**
* Account abstraction mode (`userAbstraction`).
*/
getUserAbstraction(params: AccountRequest = {}): Promise<UserAbstraction> {
return this.accountInfo('userAbstraction', params);
}
getUserBorrowLendInterest(
params: GetUserBorrowLendInterestRequest,
): Promise<UserBorrowLendInterest[]> {
return this.accountInfo('userBorrowLendInterest', params);
}
/**
* Whether HIP-3 DEX abstraction is enabled (`userDexAbstraction`).
*/
getUserDexAbstraction(params: AccountRequest = {}): Promise<boolean> {
return this.accountInfo('userDexAbstraction', params);
}
/**
* User fee rates and the current fee schedule (`userFees`).
*/
getUserFees(params: AccountRequest = {}): Promise<UserFees> {
return this.accountInfo('userFees', params);
}
/**
* Recent fills (`userFills`).
*
* Returns at most 2000 fills. `builderFee` is omitted when it is zero.
* `side` `"B"` is buy and `"A"` is sell.
*/
getUserFills(params: GetUserFillsRequest = {}): Promise<UserFill[]> {
return this.accountInfo('userFills', params);
}
/**
* Fills in a time range (`userFillsByTime`).
*
* Returns at most 2000 fills, and only the 10000 most recent fills are available.
* Paginate by using the last `time` as the next `startTime`.
*/
getUserFillsByTime(params: GetUserFillsByTimeRequest): Promise<UserFill[]> {
return this.accountInfo('userFillsByTime', params);
}
/**
* User funding payments (`userFunding`).
*
* `startTime` is inclusive, in milliseconds. `endTime` defaults to now.
*/
getUserFundingHistory(
params: GetUserFundingHistoryRequest = {},
): Promise<UserFunding[]> {
return this.accountInfo('userFunding', params);
}
/**
* User non-funding ledger updates (`userNonFundingLedgerUpdates`):
* deposits, withdrawals, transfers, and other account events.
*
* `startTime` is inclusive, in milliseconds. `endTime` defaults to now.
* Read `delta.type` to see which delta fields are set.
*/
getUserNonFundingLedgerUpdates(
params: GetUserNonFundingLedgerUpdatesRequest = {},
): Promise<UserNonFundingLedgerUpdate[]> {
return this.accountInfo('userNonFundingLedgerUpdates', params);
}
/**
* Address request usage and cap (`userRateLimit`).
*
* `nRequestsUsed` is usage above the reserved amount.
* `nRequestsSurplus` is reserved amount not yet used.
*/
getUserRateLimit(params: AccountRequest = {}): Promise<UserRateLimit> {
return this.accountInfo('userRateLimit', params);
}
/**
* Account role (`userRole`): user, agent, vault, subaccount, or missing.
*
* Query the master or subaccount address itself. An agent wallet address
* returns the agent role, not the trading account.
*/
getUserRole(params: UserRequest): Promise<UserRoleResponse> {
return this.info('userRole', normalizeUserRequest(params));
}
getMultiSigSigners(
params: AccountRequest = {},
): Promise<MultiSigSigners | null> {
return this.accountInfo('userToMultiSigSigners', params);
}
/**
* Recent TWAP slice fills (`userTwapSliceFills`).
*
* Returns at most 2000 fills. TWAP fill hashes are zero.
*/
getUserTwapSliceFills(params: AccountRequest = {}): Promise<TwapSliceFill[]> {
return this.accountInfo('userTwapSliceFills', params);
}
getUserTwapSliceFillsByTime(
params: GetUserTwapSliceFillsByTimeRequest,
): Promise<TwapSliceFill[]> {
return this.accountInfo('userTwapSliceFillsByTime', params);
}
/**
* Vault equity for this user (`userVaultEquities`).
*/
getUserVaultDeposits(
params: AccountRequest = {},
): Promise<UserVaultDeposit[]> {
return this.accountInfo('userVaultEquities', params);
}
getValidatorL1Votes(): Promise<ValidatorL1Vote[]> {
return this.info('validatorL1Votes', {});
}
getValidatorSummaries(): Promise<ValidatorSummary[]> {
return this.info('validatorSummaries', {});
}
/**
* Vault details (`vaultDetails`).
*
* Returns `null` when the vault does not exist. `relationship.type` is
* `"normal"`, `"parent"`, or `"child"`. Pass `user` for `followerState`.
*/
getVaultDetails(
params: GetVaultDetailsRequest,
): Promise<VaultDetails | null> {
return this.info('vaultDetails', normalizeAddresses(params));
}
getVaultSummaries(): Promise<VaultSummary[]> {
return this.info('vaultSummaries', {});
}
getWebData2(params: AccountRequest = {}): Promise<WebData2> {
return this.accountInfo('webData2', params);
}
/** Published response schema; the public API currently rejects this request type. */
getAlignedQuoteTokenStatus(params: {
token: number;
}): Promise<AlignedQuoteTokenStatus> {
return this.info('alignedQuoteTokenInfo', params);
}
/**
* Place one or more orders (`order`).
*
* Each status is `resting`, `filled`, or `error`. The request can succeed
* while an individual order is rejected.
*/
async submitOrder(
params: SubmitOrderRequest,
options: L1RequestOptions = {},
): Promise<ExchangeResponse<OrderResponseData>> {
const action = await this.actionBuilder.actions.order(
params.orders,
params.grouping,
);
return this.submitRawL1Action(action, options);
}
/**
* Place an IOC order around the current mid (`order`).
*
* `maxSlippage` is a fraction from 0 inclusive to 1 exclusive. The default is 0.05.
*/
async submitMarketOrder(
params: SubmitMarketOrderRequest,
options: L1RequestOptions = {},
): Promise<ExchangeResponse<OrderResponseData>> {
const maxSlippage = params.maxSlippage ?? DEFAULT_MARKET_ORDER_SLIPPAGE;
if (!Number.isFinite(maxSlippage) || maxSlippage < 0 || maxSlippage >= 1) {
throw new RangeError('maxSlippage must be at least 0 and less than 1.');
}
positiveDecimal(params.size, 'size');
const asset = await this.resolveAsset(params.symbol);
if (asset.szDecimals === undefined) {
throw new TypeError(
`Market order metadata is unavailable for "${asset.canonicalName}". Use a metadata-derived symbol instead of a numeric asset ID.`,
);
}
const dex = hip3Dex(asset.canonicalName);
const mid =
params.price ??
(await this.getAllMids(dex ? { dex } : {}))[asset.canonicalName];
if (mid === undefined) {
throw new TypeError(
`Hyperliquid did not return a midpoint for "${asset.canonicalName}".`,
);
}
const isBuy = params.side === 'buy';
return this.submitOrder(
{
orders: [
{
a: asset.assetId,
b: isBuy,
...(params.clientOrderId === undefined
? {}
: { c: params.clientOrderId }),
p: marketLimitPrice(mid, isBuy, maxSlippage, asset),
r: params.reduceOnly ?? false,
s: floorDecimalPlaces(params.size, asset.szDecimals, 'size'),
t: { limit: { tif: 'Ioc' } },
},
],
},
options,
);
}
/**
* Close a perp position with a reduce-only IOC order (`order`).
*
* Closes the entire position for that coin, not just a recently opened size.
* Size defaults to the open position size.
*/
async submitMarketClose(
params: SubmitMarketCloseRequest,
options: L1RequestOptions = {},
): Promise<ExchangeResponse<OrderResponseData>> {
const asset = await this.resolveAsset(params.symbol);
const dex = hip3Dex(asset.canonicalName);
const summary = await this.getPerpAccountSummary(dex ? { dex } : {});
const requested =
typeof params.symbol === 'string' ? params.symbol : asset.canonicalName;
const assetPosition = summary.assetPositions.find(
(entry) =>
entry.position.coin === asset.canonicalName ||
entry.position.coin === requested,
);
if (!assetPosition) {
throw new TypeError(`No perpetual position found for "${requested}".`);
}
const { szi } = assetPosition.position;
const size = params.size ?? (szi.startsWith('-') ? szi.slice(1) : szi);
return this.submitMarketOrder(
{
...(params.clientOrderId === undefined
? {}
: { clientOrderId: params.clientOrderId }),
...(params.maxSlippage === undefined
? {}
: { maxSlippage: params.maxSlippage }),
...(params.price === undefined ? {} : { price: params.price }),
reduceOnly: true,
side: szi.startsWith('-') ? 'buy' : 'sell',
size,
symbol: params.symbol,
},
options,
);
}
/**
* Place a limit order (`order`).
*
* `postOnly` sends ALO. `timeInForce: "IOC"` sends IOC. Otherwise the order is GTC.
*/
async submitLimitOrder(
params: SubmitLimitOrderRequest,
options: L1RequestOptions = {},
): Promise<ExchangeResponse<OrderResponseData>> {
return this.submitOrder(
{
orders: [
{
a: params.symbol,
b: params.side === 'buy',
...(params.clientOrderId === undefined
? {}
: { c: params.clientOrderId }),
p: positiveDecimal(params.price, 'price'),
r: params.reduceOnly ?? false,
s: positiveDecimal(params.size, 'size'),
t: {
limit: {
tif: params.postOnly
? 'Alo'
: params.timeInForce === 'IOC'
? 'Ioc'
: 'Gtc',
},
},
},
],
},
options,
);
}
/**
* Modify one resting order (`modify`).
*
* Success is the default acknowledgement. The exchange assigns a new oid.
* Callers must read open orders (or use cloid) to find it.
*