@totalis/hip4-client 0.82.0 → 0.84.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/CHANGELOG.md +25 -0
- package/dist/generated/client.d.ts +2 -1
- package/dist/generated/errors.d.ts +1 -0
- package/dist/generated/errors.js +11 -0
- package/dist/generated/openapi.d.ts +118 -12
- package/dist/generated/version.d.ts +4 -4
- package/dist/generated/version.js +4 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,31 @@
|
|
|
3
3
|
`@totalis/hip4-client` follows [semantic versioning](https://semver.org).
|
|
4
4
|
The contract version the generated types come from is `sdkVersion` in `./version`.
|
|
5
5
|
|
|
6
|
+
## 0.84.0
|
|
7
|
+
|
|
8
|
+
### Added
|
|
9
|
+
|
|
10
|
+
- `getGolden`: `golden.placement`, the account's latest golden placement as
|
|
11
|
+
`placeGolden` answers it, plus `created_at`, or null (TT-2627).
|
|
12
|
+
- `getGoldenSuggestions` items are `GoldenSuggestedCombo`: `payout` is the
|
|
13
|
+
live best house offer, with its `accept_before` and the five's `band`
|
|
14
|
+
(`HUGE`, `BIG`, `STEADY`). Contract `211.0.0-golden-live-fives`.
|
|
15
|
+
|
|
16
|
+
## 0.83.0
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- The X handle on public trader profiles (TT-2649). `getTrader`
|
|
21
|
+
(`GET /v1/traders/{username}`) carries `x_username`, the handle of the X
|
|
22
|
+
account linked to the trader's Privy login, unless the trader hid it.
|
|
23
|
+
`VenueIdentity` (`GET /v1/me`) carries `x_username` and `x_shown`, and
|
|
24
|
+
`refreshPicture` (`POST /v1/me/picture`) returns `x_username` beside
|
|
25
|
+
`picture_url`; call it right after the user links X. `setXHandleShown`
|
|
26
|
+
(`PUT /v1/me/public-profile/x`, `{shown}`) shows or hides the handle,
|
|
27
|
+
ordered by Idempotency-Key like `setPublicProfile`; it starts shown. New
|
|
28
|
+
schemas `XUsername` and `XHandleShownRequest`. Contract `210.0.0-x-handle`.
|
|
29
|
+
Additive.
|
|
30
|
+
|
|
6
31
|
## 0.82.0
|
|
7
32
|
|
|
8
33
|
### Changed
|
|
@@ -41,6 +41,7 @@ export type paths = {
|
|
|
41
41
|
readonly "/v1/leaderboard/volume": Pick<SharedPaths["/v1/leaderboard/volume"], "parameters" | "get">;
|
|
42
42
|
readonly "/v1/leaderboard/profit": Pick<SharedPaths["/v1/leaderboard/profit"], "parameters" | "get">;
|
|
43
43
|
readonly "/v1/me/public-profile": Pick<SharedPaths["/v1/me/public-profile"], "parameters" | "put">;
|
|
44
|
+
readonly "/v1/me/public-profile/x": Pick<SharedPaths["/v1/me/public-profile/x"], "parameters" | "put">;
|
|
44
45
|
readonly "/v1/traders/{username}": Pick<SharedPaths["/v1/traders/{username}"], "parameters" | "get">;
|
|
45
46
|
readonly "/v1/traders/{username}/trades": Pick<SharedPaths["/v1/traders/{username}/trades"], "parameters" | "get">;
|
|
46
47
|
readonly "/v1/traders/{username}/positions": Pick<SharedPaths["/v1/traders/{username}/positions"], "parameters" | "get">;
|
|
@@ -110,4 +111,4 @@ export type paths = {
|
|
|
110
111
|
readonly "/v1/makers/{maker_id}/exposure": Pick<SharedPaths["/v1/makers/{maker_id}/exposure"], "parameters" | "get">;
|
|
111
112
|
readonly "/v1/makers/{maker_id}/performance": Pick<SharedPaths["/v1/makers/{maker_id}/performance"], "parameters" | "get">;
|
|
112
113
|
};
|
|
113
|
-
export type operations = Pick<SharedOperations, "abandonCoreExit" | "acceptQuote" | "activeCoreExits" | "admitOwnMaker" | "admitPartnerWallet" | "bindEmbeddedWallet" | "cancelRfq" | "confirmComboCopyAgent" | "confirmCoreCopyAgent" | "createCashout" | "createComment" | "createCoreExit" | "createDeposit" | "createGoldenRfq" | "createRfq" | "createRunOffClaim" | "createWalletChallenge" | "createWalletSession" | "createWithdrawal" | "deleteComment" | "editComment" | "endWalletSession" | "followTrader" | "getAcceptance" | "getAccountActivity" | "getAccountPnl" | "getAccountPosition" | "getBalances" | "getCopyAgents" | "getCopyBudget" | "getCopySettings" | "getCopySummary" | "getCoreExit" | "getDeployment" | "getGolden" | "getGoldenMarkets" | "getGoldenOffer" | "getGoldenSuggestions" | "getHypercoreBalance" | "getHypercorePortfolio" | "getHypercoreSettlementCredits" | "getIdentity" | "getMakerActivity" | "getMakerCapital" | "getMakerExposure" | "getMakerPerformance" | "getMakerPosition" | "getMakerQuotes" | "getMakerTelemetry" | "getMakerVaultFundingTransaction" | "getMakerWithdrawal" | "getMarket" | "getMarketDataConfig" | "getMarketDefinitions" | "getMarketHistory" | "getMarketRecurringRound" | "getMarketReferenceCloses" | "getMarketScoreTimeline" | "getMarketStats" | "getOperation" | "getOwnMaker" | "getPartnerReport" | "getPerpMarks" | "getProfitLeaderboard" | "getQuestion" | "getQuestionRecurringRound" | "getQuestionScoreTimeline" | "getRfq" | "getSeries" | "getSuggestedCombo" | "getTaxonomy" | "getTrader" | "getTraderPnl" | "getUsernameAvailability" | "getVaultAgents" | "getVolumeLeaderboard" | "getWithdrawal" | "grantComboCopyAgent" | "grantVaultAgent" | "likeComment" | "listAccountActivity" | "listAccountPositions" | "listComboCopies" | "listComboFeed" | "listCommentReplies" | "listComments" | "listControlledMakers" | "listCopiedFills" | "listCopyTrades" | "listDiscovery" | "listFollows" | "listMakerActivity" | "listMakerPositions" | "listMakerQuoteHistory" | "listMarkets" | "listOperations" | "listQuotes" | "listTraderPositions" | "listTraderTrades" | "placeGolden" | "reactComment" | "recordAcquisition" | "refreshPicture" | "requestComboCopyAgent" | "requestCoreCopyAgent" | "revokeComboCopyAgent" | "searchCatalog" | "setAvatar" | "setCopyAllocation" | "setCopySettings" | "setPublicProfile" | "setUsername" | "stream" | "streamMarkets" | "switchOffComboCopyAgent" | "switchOffCoreCopyAgent" | "unfollowTrader" | "unlikeComment" | "unreactComment">;
|
|
114
|
+
export type operations = Pick<SharedOperations, "abandonCoreExit" | "acceptQuote" | "activeCoreExits" | "admitOwnMaker" | "admitPartnerWallet" | "bindEmbeddedWallet" | "cancelRfq" | "confirmComboCopyAgent" | "confirmCoreCopyAgent" | "createCashout" | "createComment" | "createCoreExit" | "createDeposit" | "createGoldenRfq" | "createRfq" | "createRunOffClaim" | "createWalletChallenge" | "createWalletSession" | "createWithdrawal" | "deleteComment" | "editComment" | "endWalletSession" | "followTrader" | "getAcceptance" | "getAccountActivity" | "getAccountPnl" | "getAccountPosition" | "getBalances" | "getCopyAgents" | "getCopyBudget" | "getCopySettings" | "getCopySummary" | "getCoreExit" | "getDeployment" | "getGolden" | "getGoldenMarkets" | "getGoldenOffer" | "getGoldenSuggestions" | "getHypercoreBalance" | "getHypercorePortfolio" | "getHypercoreSettlementCredits" | "getIdentity" | "getMakerActivity" | "getMakerCapital" | "getMakerExposure" | "getMakerPerformance" | "getMakerPosition" | "getMakerQuotes" | "getMakerTelemetry" | "getMakerVaultFundingTransaction" | "getMakerWithdrawal" | "getMarket" | "getMarketDataConfig" | "getMarketDefinitions" | "getMarketHistory" | "getMarketRecurringRound" | "getMarketReferenceCloses" | "getMarketScoreTimeline" | "getMarketStats" | "getOperation" | "getOwnMaker" | "getPartnerReport" | "getPerpMarks" | "getProfitLeaderboard" | "getQuestion" | "getQuestionRecurringRound" | "getQuestionScoreTimeline" | "getRfq" | "getSeries" | "getSuggestedCombo" | "getTaxonomy" | "getTrader" | "getTraderPnl" | "getUsernameAvailability" | "getVaultAgents" | "getVolumeLeaderboard" | "getWithdrawal" | "grantComboCopyAgent" | "grantVaultAgent" | "likeComment" | "listAccountActivity" | "listAccountPositions" | "listComboCopies" | "listComboFeed" | "listCommentReplies" | "listComments" | "listControlledMakers" | "listCopiedFills" | "listCopyTrades" | "listDiscovery" | "listFollows" | "listMakerActivity" | "listMakerPositions" | "listMakerQuoteHistory" | "listMarkets" | "listOperations" | "listQuotes" | "listTraderPositions" | "listTraderTrades" | "placeGolden" | "reactComment" | "recordAcquisition" | "refreshPicture" | "requestComboCopyAgent" | "requestCoreCopyAgent" | "revokeComboCopyAgent" | "searchCatalog" | "setAvatar" | "setCopyAllocation" | "setCopySettings" | "setPublicProfile" | "setUsername" | "setXHandleShown" | "stream" | "streamMarkets" | "switchOffComboCopyAgent" | "switchOffCoreCopyAgent" | "unfollowTrader" | "unlikeComment" | "unreactComment">;
|
|
@@ -509,6 +509,7 @@ export declare const operationErrors: {
|
|
|
509
509
|
readonly setCopySettings: readonly ["UNAUTHENTICATED", "FORBIDDEN", "AUTHORIZATION_UNAVAILABLE", "RATE_LIMITED", "ORIGIN_REQUIRED", "IDENTITY_NOT_FOUND", "INVALID_REQUEST", "INVALID_IDEMPOTENCY_KEY", "IDEMPOTENCY_KEY_REUSED", "CONTRACT_UNAVAILABLE"];
|
|
510
510
|
readonly setPublicProfile: readonly ["UNAUTHENTICATED", "FORBIDDEN", "AUTHORIZATION_UNAVAILABLE", "RATE_LIMITED", "INVALID_REQUEST", "INVALID_IDEMPOTENCY_KEY", "IDEMPOTENCY_KEY_REUSED", "IDENTITY_NOT_FOUND", "USERNAME_REQUIRED", "ORIGIN_REQUIRED"];
|
|
511
511
|
readonly setUsername: readonly ["UNAUTHENTICATED", "FORBIDDEN", "AUTHORIZATION_UNAVAILABLE", "DEPENDENCY_STALE", "RATE_LIMITED", "INVALID_REQUEST", "INVALID_IDEMPOTENCY_KEY", "IDEMPOTENCY_KEY_REUSED", "IDENTITY_NOT_FOUND", "USERNAME_NOT_ALLOWED", "USERNAME_TAKEN", "ORIGIN_REQUIRED"];
|
|
512
|
+
readonly setXHandleShown: readonly ["UNAUTHENTICATED", "FORBIDDEN", "AUTHORIZATION_UNAVAILABLE", "RATE_LIMITED", "INVALID_REQUEST", "INVALID_IDEMPOTENCY_KEY", "IDEMPOTENCY_KEY_REUSED", "IDENTITY_NOT_FOUND", "ORIGIN_REQUIRED"];
|
|
512
513
|
readonly stream: readonly ["UNAUTHENTICATED", "FORBIDDEN", "AUTHORIZATION_UNAVAILABLE", "DEPENDENCY_STALE", "RATE_LIMITED", "SUBPROTOCOL_REQUIRED", "CONNECTION_LIMIT", "CONNECTION_DRAIN", "INVALID_REQUEST", "NOT_FOUND", "ORIGIN_REQUIRED"];
|
|
513
514
|
readonly streamMarkets: readonly ["UNAUTHENTICATED", "FORBIDDEN", "AUTHORIZATION_UNAVAILABLE", "DEPENDENCY_STALE", "RATE_LIMITED", "SUBPROTOCOL_REQUIRED", "CONNECTION_LIMIT", "CONNECTION_DRAIN", "ORIGIN_NOT_ALLOWED", "INVALID_QUERY"];
|
|
514
515
|
readonly submitMakerSelfFundedTransaction: readonly ["UNAUTHENTICATED", "FORBIDDEN", "AUTHORIZATION_UNAVAILABLE", "DEPENDENCY_STALE", "RATE_LIMITED", "INVALID_REQUEST", "INVALID_IDEMPOTENCY_KEY", "IDEMPOTENCY_KEY_REUSED", "STATE_CONFLICT", "FINANCIAL_ACTIONS_DISABLED", "INVALID_SIGNATURE", "CONTRACT_SIGNATURE_OVERLOADED", "NOT_FOUND"];
|
package/dist/generated/errors.js
CHANGED
|
@@ -1892,6 +1892,17 @@ export const operationErrors = {
|
|
|
1892
1892
|
"USERNAME_TAKEN",
|
|
1893
1893
|
"ORIGIN_REQUIRED"
|
|
1894
1894
|
],
|
|
1895
|
+
"setXHandleShown": [
|
|
1896
|
+
"UNAUTHENTICATED",
|
|
1897
|
+
"FORBIDDEN",
|
|
1898
|
+
"AUTHORIZATION_UNAVAILABLE",
|
|
1899
|
+
"RATE_LIMITED",
|
|
1900
|
+
"INVALID_REQUEST",
|
|
1901
|
+
"INVALID_IDEMPOTENCY_KEY",
|
|
1902
|
+
"IDEMPOTENCY_KEY_REUSED",
|
|
1903
|
+
"IDENTITY_NOT_FOUND",
|
|
1904
|
+
"ORIGIN_REQUIRED"
|
|
1905
|
+
],
|
|
1895
1906
|
"stream": [
|
|
1896
1907
|
"UNAUTHENTICATED",
|
|
1897
1908
|
"FORBIDDEN",
|
|
@@ -626,7 +626,7 @@ export type paths = {
|
|
|
626
626
|
readonly put?: never;
|
|
627
627
|
/**
|
|
628
628
|
* Refresh X picture
|
|
629
|
-
* @description Reads the profile picture of the X account linked to the authenticated account's Privy login from Privy now, stores
|
|
629
|
+
* @description Reads the profile picture and handle of the X account linked to the authenticated account's Privy login from Privy now, stores them and returns them; GET /v1/me, comments and the leaderboard then serve the picture, and GET /v1/me and the public trader profile the handle. Call it right after the user links or unlinks X. Send no body. Call it after POST /v1/me/embedded-wallet; before that it is 404 IDENTITY_NOT_FOUND. Reading again stores Privy's answer again, so a retry is safe; send no Idempotency-Key. If Privy does not answer it is 503 DEPENDENCY_STALE and the stored picture stays; a server without a Privy app secret answers 503 CONTRACT_UNAVAILABLE. An account that signs in with an external wallet has no Privy login, so it gets the stored picture back. Limited to 10 calls a minute per account.
|
|
630
630
|
*/
|
|
631
631
|
readonly post: operations["refreshPicture"];
|
|
632
632
|
readonly delete?: never;
|
|
@@ -724,7 +724,7 @@ export type paths = {
|
|
|
724
724
|
};
|
|
725
725
|
/**
|
|
726
726
|
* List golden suggestions
|
|
727
|
-
* @description Up to three ready-made golden Combos
|
|
727
|
+
* @description Up to three ready-made golden Combos from different games, for an account whose golden ticket is available: 5 legs from golden markets at the 1 USDC golden stake, one per fair-multiplier band, biggest first. Each shows the best house-maker offer the promo account holds on it right now, live while any ticket holder reads golden Combos; a five with no such offer, or one paying under the golden value floor, is left out. Picking one only fills the slip; place it through POST /v1/me/golden/rfqs, which asks afresh, so the slip's own offer is what places.
|
|
728
728
|
*/
|
|
729
729
|
readonly get: operations["getGoldenSuggestions"];
|
|
730
730
|
readonly put?: never;
|
|
@@ -855,6 +855,26 @@ export type paths = {
|
|
|
855
855
|
readonly patch?: never;
|
|
856
856
|
readonly trace?: never;
|
|
857
857
|
};
|
|
858
|
+
readonly "/v1/me/public-profile/x": {
|
|
859
|
+
readonly parameters: {
|
|
860
|
+
readonly query?: never;
|
|
861
|
+
readonly header?: never;
|
|
862
|
+
readonly path?: never;
|
|
863
|
+
readonly cookie?: never;
|
|
864
|
+
};
|
|
865
|
+
readonly get?: never;
|
|
866
|
+
/**
|
|
867
|
+
* Show or hide the X handle on the public trader profile
|
|
868
|
+
* @description Shows (shown: true) or hides the handle of the X account linked to the authenticated account's Privy login on its public trader profile, GET /v1/traders/{username}. It starts shown: linking X is the consent, and this switch takes it back. GET /v1/me returns the state as x_shown. It is a preference, kept whether or not X is linked, and it does not unlink X. Hiding it reaches signed-out readers within the 30 seconds the edge may cache GET /v1/traders/{username}. Call it after POST /v1/me/embedded-wallet; before that it is 404 IDENTITY_NOT_FOUND. Asking for the current state again returns 204, so a retry is safe. Idempotency-Keys order these requests: the other state under the account's newest key, or under an older key, is 409 IDEMPOTENCY_KEY_REUSED, so a delayed retry never undoes a newer request. A key stamped more than 5 minutes ahead of server time is 400 INVALID_REQUEST. Shares PUT /v1/me/public-profile's 30 calls a minute per account. Servers before contract 210 answer 404.
|
|
869
|
+
*/
|
|
870
|
+
readonly put: operations["setXHandleShown"];
|
|
871
|
+
readonly post?: never;
|
|
872
|
+
readonly delete?: never;
|
|
873
|
+
readonly options?: never;
|
|
874
|
+
readonly head?: never;
|
|
875
|
+
readonly patch?: never;
|
|
876
|
+
readonly trace?: never;
|
|
877
|
+
};
|
|
858
878
|
readonly "/v1/traders/{username}": {
|
|
859
879
|
readonly parameters: {
|
|
860
880
|
readonly query?: never;
|
|
@@ -864,7 +884,7 @@ export type paths = {
|
|
|
864
884
|
};
|
|
865
885
|
/**
|
|
866
886
|
* Get a public trader profile
|
|
867
|
-
* @description A trader's public profile, while they have turned it on with PUT /v1/me/public-profile: their username, avatar, the account wallet they trade from, which clients read HyperCore holdings for from Hyperliquid, their follower count, whether the reader follows them, and their all-time volume, counted as GET /v1/leaderboard/volume counts it. Anyone reads it, signed out or with any credential, from any origin; a supplied credential must still authenticate. A signed-out answer is the same for everyone and is cached for 30 seconds. A username with no public profile, whether private, unknown or held by an account that is not ACTIVE, is 404 NOT_FOUND, signed in or not.
|
|
887
|
+
* @description A trader's public profile, while they have turned it on with PUT /v1/me/public-profile: their username, avatar, X handle unless they hid it, the account wallet they trade from, which clients read HyperCore holdings for from Hyperliquid, their follower count, whether the reader follows them, and their all-time volume, counted as GET /v1/leaderboard/volume counts it. Anyone reads it, signed out or with any credential, from any origin; a supplied credential must still authenticate. A signed-out answer is the same for everyone and is cached for 30 seconds. A username with no public profile, whether private, unknown or held by an account that is not ACTIVE, is 404 NOT_FOUND, signed in or not.
|
|
868
888
|
*/
|
|
869
889
|
readonly get: operations["getTrader"];
|
|
870
890
|
readonly put?: never;
|
|
@@ -3237,6 +3257,34 @@ export type components = {
|
|
|
3237
3257
|
readonly HyperevmKeeperOperationKind: "DEPOSIT_USER_AUTHORIZED" | "WITHDRAW_USER" | "ACCEPT" | "SETTLE" | "CACHE_SETTLEMENT" | "CLAIM" | "SELL_BACK" | "TRANSFER_TICKET" | "ATTEST" | "SYNC" | "TOTALIS_PAYOUT" | "CORE_EXIT" | "SET_AGENT";
|
|
3238
3258
|
readonly Hash32: string;
|
|
3239
3259
|
readonly Uint256: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* GoldenPlacementState
|
|
3262
|
+
* @enum {string}
|
|
3263
|
+
*/
|
|
3264
|
+
readonly GoldenPlacementState: "PLACING" | "BOUGHT" | "DELIVERED" | "FAILED";
|
|
3265
|
+
/**
|
|
3266
|
+
* GoldenPlacementFailure
|
|
3267
|
+
* @enum {string}
|
|
3268
|
+
*/
|
|
3269
|
+
readonly GoldenPlacementFailure: "MAKER_DECLINED" | "ACCEPT_FAILED" | "NOT_ACCEPTED" | "PROMO_BUSY" | "GIFT_FAILED" | "GIFT_EXPIRED";
|
|
3270
|
+
/** GoldenSuggestedCombo */
|
|
3271
|
+
readonly GoldenSuggestedCombo: {
|
|
3272
|
+
readonly legs: readonly components["schemas"]["$defs-Leg"][];
|
|
3273
|
+
/** @description Browse contract 4 discovery card each leg was picked from, in leg order, as read when the five was composed. Lets a client draw a leg that is not on its own page; its prices are not current. */
|
|
3274
|
+
readonly cards: readonly components["schemas"]["Card"][];
|
|
3275
|
+
readonly stake: components["schemas"]["$defs-Amount"];
|
|
3276
|
+
/** @description What the best house-maker offer on this five pays on a win now, after the taker and profit fees, in USDC base units. An indication: the offer is the promo account's, so the slip asks for its own. */
|
|
3277
|
+
readonly payout: components["schemas"]["$defs-Amount"];
|
|
3278
|
+
/** @description When the server first saw that offer. */
|
|
3279
|
+
readonly quoted_at: components["schemas"]["$defs-Timestamp"];
|
|
3280
|
+
/** @description When that offer stops being takeable. Drop the number once it passes without a newer read; never show it after. */
|
|
3281
|
+
readonly accept_before: components["schemas"]["$defs-Timestamp"];
|
|
3282
|
+
/**
|
|
3283
|
+
* @description The fair-multiplier band the five was composed for, a stable slot key: a five that drops out and is replaced keeps its band.
|
|
3284
|
+
* @enum {string}
|
|
3285
|
+
*/
|
|
3286
|
+
readonly band: "HUGE" | "BIG" | "STEADY";
|
|
3287
|
+
};
|
|
3240
3288
|
/** SuggestedCombo */
|
|
3241
3289
|
readonly SuggestedCombo: {
|
|
3242
3290
|
readonly legs: readonly components["schemas"]["$defs-Leg"][];
|
|
@@ -3940,6 +3988,8 @@ export type components = {
|
|
|
3940
3988
|
readonly AvatarSeed: string;
|
|
3941
3989
|
/** @description An X profile picture on pbs.twimg.com or abs.twimg.com, at the size X gave Privy, usually the 48-pixel file ending in _normal; X also serves _bigger (73 px) and _400x400 under the same name. */
|
|
3942
3990
|
readonly XPictureUrl: string;
|
|
3991
|
+
/** @description An X handle without the @, in the case X gave Privy: 1 to 15 letters, digits or underscores. Clients link it as https://x.com/{handle}. */
|
|
3992
|
+
readonly XUsername: string;
|
|
3943
3993
|
readonly VenueIdentity: {
|
|
3944
3994
|
/** @description Totalis account ID. */
|
|
3945
3995
|
readonly account_id: components["schemas"]["Uuid"];
|
|
@@ -3963,6 +4013,10 @@ export type components = {
|
|
|
3963
4013
|
readonly wallet_kind?: "EMBEDDED" | "EXTERNAL";
|
|
3964
4014
|
/** @description Whether the account turned on its public trader profile with PUT /v1/me/public-profile. Servers before contract 190 omit it. */
|
|
3965
4015
|
readonly public_profile?: boolean;
|
|
4016
|
+
/** @description The handle of the X account linked to the account's Privy login, read from Privy with picture_url and served the same way. Absent when the server has none: none is linked, X does not allow it, it has not been read yet, or the server has no Privy app secret. Servers before contract 210 omit it. */
|
|
4017
|
+
readonly x_username?: components["schemas"]["XUsername"];
|
|
4018
|
+
/** @description Whether the public trader profile shows x_username: true until the account hides it with PUT /v1/me/public-profile/x, whether or not X is linked. Servers before contract 210 omit it. */
|
|
4019
|
+
readonly x_shown?: boolean;
|
|
3966
4020
|
};
|
|
3967
4021
|
readonly NonZeroAddress: components["schemas"]["Address"] & unknown;
|
|
3968
4022
|
/** Format: uri */
|
|
@@ -4192,6 +4246,8 @@ export type components = {
|
|
|
4192
4246
|
readonly PictureRefresh: {
|
|
4193
4247
|
/** @description The linked X account's picture; absent when none is linked or it is not on X's profile picture hosts. */
|
|
4194
4248
|
readonly picture_url?: components["schemas"]["XPictureUrl"];
|
|
4249
|
+
/** @description The linked X account's handle; absent when none is linked or X does not allow it. Servers before contract 210 omit it. */
|
|
4250
|
+
readonly x_username?: components["schemas"]["XUsername"];
|
|
4195
4251
|
};
|
|
4196
4252
|
/** @description The canonical contract deployment clients sign against. Totalis structs are signed under the TotalisParlay v1 domain with chainId chain_id and verifyingContract vault_address. */
|
|
4197
4253
|
readonly Deployment: {
|
|
@@ -4679,6 +4735,10 @@ export type components = {
|
|
|
4679
4735
|
/** Format: uint256-decimal */
|
|
4680
4736
|
readonly Uint: string;
|
|
4681
4737
|
readonly ContractSignature: string;
|
|
4738
|
+
readonly XHandleShownRequest: {
|
|
4739
|
+
/** @description true to show the X handle on the public trader profile, false to hide it. */
|
|
4740
|
+
readonly shown: boolean;
|
|
4741
|
+
};
|
|
4682
4742
|
/** @description 1 to 1000 characters after surrounding whitespace is trimmed. Newlines are kept; other control characters are refused. */
|
|
4683
4743
|
readonly CommentBody: string;
|
|
4684
4744
|
/**
|
|
@@ -7810,7 +7870,19 @@ export interface operations {
|
|
|
7810
7870
|
/** @description The gifted position once PLACED; null otherwise. */
|
|
7811
7871
|
readonly position_id: null | components["schemas"]["Bytes32"];
|
|
7812
7872
|
/** @description While AVAILABLE, why the latest placement failed, if one did; null otherwise. */
|
|
7813
|
-
readonly last_failure: null |
|
|
7873
|
+
readonly last_failure: null | components["schemas"]["GoldenPlacementFailure"];
|
|
7874
|
+
/** @description The account's latest placement, the same object placeGolden answers plus when it was recorded, so a client that lost a placement's answer settles it from here; null before the first. */
|
|
7875
|
+
readonly placement: null | {
|
|
7876
|
+
readonly placement_id: components["schemas"]["Uuid"];
|
|
7877
|
+
/** @description As placeGolden answers it, now. */
|
|
7878
|
+
readonly state: components["schemas"]["GoldenPlacementState"];
|
|
7879
|
+
/** @description The placed quote's digest: the position this placement buys, which is the account's once DELIVERED. */
|
|
7880
|
+
readonly position_id: components["schemas"]["Bytes32"];
|
|
7881
|
+
/** @description Why it failed, once FAILED; null otherwise. */
|
|
7882
|
+
readonly failure: null | components["schemas"]["GoldenPlacementFailure"];
|
|
7883
|
+
/** @description When the placement was recorded. */
|
|
7884
|
+
readonly created_at: components["schemas"]["$defs-Timestamp"];
|
|
7885
|
+
};
|
|
7814
7886
|
};
|
|
7815
7887
|
};
|
|
7816
7888
|
};
|
|
@@ -7867,8 +7939,8 @@ export interface operations {
|
|
|
7867
7939
|
};
|
|
7868
7940
|
content: {
|
|
7869
7941
|
readonly "application/json": {
|
|
7870
|
-
/** @description
|
|
7871
|
-
readonly combos: readonly components["schemas"]["
|
|
7942
|
+
/** @description Biggest band first; empty while none has a live offer. */
|
|
7943
|
+
readonly combos: readonly components["schemas"]["GoldenSuggestedCombo"][];
|
|
7872
7944
|
};
|
|
7873
7945
|
};
|
|
7874
7946
|
};
|
|
@@ -8014,14 +8086,11 @@ export interface operations {
|
|
|
8014
8086
|
content: {
|
|
8015
8087
|
readonly "application/json": {
|
|
8016
8088
|
readonly placement_id: components["schemas"]["Uuid"];
|
|
8017
|
-
/**
|
|
8018
|
-
|
|
8019
|
-
* @enum {string}
|
|
8020
|
-
*/
|
|
8021
|
-
readonly state: "PLACING" | "BOUGHT" | "DELIVERED" | "FAILED";
|
|
8089
|
+
/** @description PLACING until the promo account's accept lands, BOUGHT until the gift lands, then DELIVERED; FAILED leaves the golden ticket available again. Read GET /v1/me/golden for its progress. */
|
|
8090
|
+
readonly state: components["schemas"]["GoldenPlacementState"];
|
|
8022
8091
|
/** @description The quote's digest: the position the gift delivers. */
|
|
8023
8092
|
readonly position_id: components["schemas"]["Bytes32"];
|
|
8024
|
-
readonly failure: null |
|
|
8093
|
+
readonly failure: null | components["schemas"]["GoldenPlacementFailure"];
|
|
8025
8094
|
};
|
|
8026
8095
|
};
|
|
8027
8096
|
};
|
|
@@ -8179,6 +8248,41 @@ export interface operations {
|
|
|
8179
8248
|
readonly 503: components["responses"]["Unavailable"];
|
|
8180
8249
|
};
|
|
8181
8250
|
};
|
|
8251
|
+
readonly setXHandleShown: {
|
|
8252
|
+
readonly parameters: {
|
|
8253
|
+
readonly query?: never;
|
|
8254
|
+
readonly header: {
|
|
8255
|
+
/**
|
|
8256
|
+
* @description Lowercase UUIDv7 naming this command, unique per caller and route. A retry with the same key and body returns the original result; the same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`.
|
|
8257
|
+
* @example 0198a6f6-82a5-7abc-9f2a-4f0fb437493e
|
|
8258
|
+
*/
|
|
8259
|
+
readonly "Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
8260
|
+
};
|
|
8261
|
+
readonly path?: never;
|
|
8262
|
+
readonly cookie?: never;
|
|
8263
|
+
};
|
|
8264
|
+
readonly requestBody: {
|
|
8265
|
+
readonly content: {
|
|
8266
|
+
readonly "application/json": components["schemas"]["XHandleShownRequest"];
|
|
8267
|
+
};
|
|
8268
|
+
};
|
|
8269
|
+
readonly responses: {
|
|
8270
|
+
/** @description The handle is in the requested state */
|
|
8271
|
+
readonly 204: {
|
|
8272
|
+
headers: {
|
|
8273
|
+
readonly [name: string]: unknown;
|
|
8274
|
+
};
|
|
8275
|
+
content?: never;
|
|
8276
|
+
};
|
|
8277
|
+
readonly 400: components["responses"]["Error"];
|
|
8278
|
+
readonly 401: components["responses"]["Error"];
|
|
8279
|
+
readonly 403: components["responses"]["Error"];
|
|
8280
|
+
readonly 404: components["responses"]["Error"];
|
|
8281
|
+
readonly 409: components["responses"]["Error"];
|
|
8282
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
8283
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
8284
|
+
};
|
|
8285
|
+
};
|
|
8182
8286
|
readonly getTrader: {
|
|
8183
8287
|
readonly parameters: {
|
|
8184
8288
|
readonly query?: never;
|
|
@@ -8205,6 +8309,8 @@ export interface operations {
|
|
|
8205
8309
|
readonly avatar_seed: components["schemas"]["AvatarSeed"];
|
|
8206
8310
|
/** @description The trader's X picture, shown in place of the generated avatar; absent when there is none, as for GET /v1/me. */
|
|
8207
8311
|
readonly picture_url?: components["schemas"]["XPictureUrl"];
|
|
8312
|
+
/** @description The handle of the X account linked to the trader's Privy login, as for GET /v1/me. Absent when there is none or the trader hid it with PUT /v1/me/public-profile/x; a signed-out answer the edge cached may show it for up to 30 seconds after it changes. Servers before contract 210 omit it. */
|
|
8313
|
+
readonly x_username?: components["schemas"]["XUsername"];
|
|
8208
8314
|
/** @description The account wallet the trader trades from, as GET /v1/me shows it to them. */
|
|
8209
8315
|
readonly account: components["schemas"]["LowercaseNonZeroAddress"];
|
|
8210
8316
|
/** @description When the trader turned the profile on. */
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export declare const sdkVersion = "
|
|
2
|
-
export declare const openapiSha256 = "
|
|
1
|
+
export declare const sdkVersion = "211.0.0-golden-live-fives";
|
|
2
|
+
export declare const openapiSha256 = "35c16104e0eaa909bfa93999c770a4f209173d37f0ee16c328807ecdecf6c9d5";
|
|
3
3
|
export declare const realtimeSha256 = "f4f1078418b5302417babe1380b85b0c4f89cb0fdfaff3a46154dd2018625c07";
|
|
4
4
|
export declare const jsonSchemaSha256: {
|
|
5
5
|
readonly "account.schema.json": "5106e2d53abef190990eff113f6692dd27df5848439cf5a80a42c11e89f2bef6";
|
|
@@ -8,7 +8,7 @@ export declare const jsonSchemaSha256: {
|
|
|
8
8
|
readonly "core-exit.schema.json": "c7f617e815225cdcac95c236f8b73fbe288ee5713ff444c3be90eb915fc3a401";
|
|
9
9
|
readonly "error.schema.json": "d15dad1b8369b45746271e0fddd2106535c22493668b703544c9ddfa80761012";
|
|
10
10
|
readonly "hypercore.schema.json": "5b89b2bbff7ec8cc1b8717375d12ce9cd5ab6aa5af03c4fdc6cc753ef9583a2c";
|
|
11
|
-
readonly "identity.schema.json": "
|
|
11
|
+
readonly "identity.schema.json": "b623b947db4fe8fe1f297158bcc6a555c0333f3937ca925dda20ec4956ea479f";
|
|
12
12
|
readonly "maker-access.schema.json": "49698ee0235e42064aae0397db1e0f646bdc10d9dfa10121714ba06dd69fee3b";
|
|
13
13
|
readonly "maker-action.schema.json": "dc41e52c868848e85cdeb918992cb710d34616d2803a63f6d9a658e016744a50";
|
|
14
14
|
readonly "maker-telemetry.schema.json": "85b111ce0f4935299d1116071b43de12e775bef4e0c283c12f19046d34374a9c";
|
|
@@ -18,7 +18,7 @@ export declare const jsonSchemaSha256: {
|
|
|
18
18
|
readonly "realtime.schema.json": "f4f1078418b5302417babe1380b85b0c4f89cb0fdfaff3a46154dd2018625c07";
|
|
19
19
|
};
|
|
20
20
|
export declare const operations: {
|
|
21
|
-
readonly client: readonly ["abandonCoreExit", "acceptQuote", "activeCoreExits", "admitOwnMaker", "admitPartnerWallet", "bindEmbeddedWallet", "cancelRfq", "confirmComboCopyAgent", "confirmCoreCopyAgent", "createCashout", "createComment", "createCoreExit", "createDeposit", "createGoldenRfq", "createRfq", "createRunOffClaim", "createWalletChallenge", "createWalletSession", "createWithdrawal", "deleteComment", "editComment", "endWalletSession", "followTrader", "getAcceptance", "getAccountActivity", "getAccountPnl", "getAccountPosition", "getBalances", "getCopyAgents", "getCopyBudget", "getCopySettings", "getCopySummary", "getCoreExit", "getDeployment", "getGolden", "getGoldenMarkets", "getGoldenOffer", "getGoldenSuggestions", "getHypercoreBalance", "getHypercorePortfolio", "getHypercoreSettlementCredits", "getIdentity", "getMakerActivity", "getMakerCapital", "getMakerExposure", "getMakerPerformance", "getMakerPosition", "getMakerQuotes", "getMakerTelemetry", "getMakerVaultFundingTransaction", "getMakerWithdrawal", "getMarket", "getMarketDataConfig", "getMarketDefinitions", "getMarketHistory", "getMarketRecurringRound", "getMarketReferenceCloses", "getMarketScoreTimeline", "getMarketStats", "getOperation", "getOwnMaker", "getPartnerReport", "getPerpMarks", "getProfitLeaderboard", "getQuestion", "getQuestionRecurringRound", "getQuestionScoreTimeline", "getRfq", "getSeries", "getSuggestedCombo", "getTaxonomy", "getTrader", "getTraderPnl", "getUsernameAvailability", "getVaultAgents", "getVolumeLeaderboard", "getWithdrawal", "grantComboCopyAgent", "grantVaultAgent", "likeComment", "listAccountActivity", "listAccountPositions", "listComboCopies", "listComboFeed", "listCommentReplies", "listComments", "listControlledMakers", "listCopiedFills", "listCopyTrades", "listDiscovery", "listFollows", "listMakerActivity", "listMakerPositions", "listMakerQuoteHistory", "listMarkets", "listOperations", "listQuotes", "listTraderPositions", "listTraderTrades", "placeGolden", "reactComment", "recordAcquisition", "refreshPicture", "requestComboCopyAgent", "requestCoreCopyAgent", "revokeComboCopyAgent", "searchCatalog", "setAvatar", "setCopyAllocation", "setCopySettings", "setPublicProfile", "setUsername", "stream", "streamMarkets", "switchOffComboCopyAgent", "switchOffCoreCopyAgent", "unfollowTrader", "unlikeComment", "unreactComment"];
|
|
21
|
+
readonly client: readonly ["abandonCoreExit", "acceptQuote", "activeCoreExits", "admitOwnMaker", "admitPartnerWallet", "bindEmbeddedWallet", "cancelRfq", "confirmComboCopyAgent", "confirmCoreCopyAgent", "createCashout", "createComment", "createCoreExit", "createDeposit", "createGoldenRfq", "createRfq", "createRunOffClaim", "createWalletChallenge", "createWalletSession", "createWithdrawal", "deleteComment", "editComment", "endWalletSession", "followTrader", "getAcceptance", "getAccountActivity", "getAccountPnl", "getAccountPosition", "getBalances", "getCopyAgents", "getCopyBudget", "getCopySettings", "getCopySummary", "getCoreExit", "getDeployment", "getGolden", "getGoldenMarkets", "getGoldenOffer", "getGoldenSuggestions", "getHypercoreBalance", "getHypercorePortfolio", "getHypercoreSettlementCredits", "getIdentity", "getMakerActivity", "getMakerCapital", "getMakerExposure", "getMakerPerformance", "getMakerPosition", "getMakerQuotes", "getMakerTelemetry", "getMakerVaultFundingTransaction", "getMakerWithdrawal", "getMarket", "getMarketDataConfig", "getMarketDefinitions", "getMarketHistory", "getMarketRecurringRound", "getMarketReferenceCloses", "getMarketScoreTimeline", "getMarketStats", "getOperation", "getOwnMaker", "getPartnerReport", "getPerpMarks", "getProfitLeaderboard", "getQuestion", "getQuestionRecurringRound", "getQuestionScoreTimeline", "getRfq", "getSeries", "getSuggestedCombo", "getTaxonomy", "getTrader", "getTraderPnl", "getUsernameAvailability", "getVaultAgents", "getVolumeLeaderboard", "getWithdrawal", "grantComboCopyAgent", "grantVaultAgent", "likeComment", "listAccountActivity", "listAccountPositions", "listComboCopies", "listComboFeed", "listCommentReplies", "listComments", "listControlledMakers", "listCopiedFills", "listCopyTrades", "listDiscovery", "listFollows", "listMakerActivity", "listMakerPositions", "listMakerQuoteHistory", "listMarkets", "listOperations", "listQuotes", "listTraderPositions", "listTraderTrades", "placeGolden", "reactComment", "recordAcquisition", "refreshPicture", "requestComboCopyAgent", "requestCoreCopyAgent", "revokeComboCopyAgent", "searchCatalog", "setAvatar", "setCopyAllocation", "setCopySettings", "setPublicProfile", "setUsername", "setXHandleShown", "stream", "streamMarkets", "switchOffComboCopyAgent", "switchOffCoreCopyAgent", "unfollowTrader", "unlikeComment", "unreactComment"];
|
|
22
22
|
readonly maker: readonly ["cancelQuote", "confirmQuote", "createCollateralReduction", "createQuote", "getAccountActivity", "getAccountPosition", "getCollateralReduction", "getDeployment", "getMakerActivity", "getMakerCapital", "getMakerExposure", "getMakerPerformance", "getMakerPosition", "getMakerQuotes", "getMakerTelemetry", "getMakerTelemetryPublication", "getMakerVaultFundingTransaction", "getMakerWithdrawal", "getMarket", "getMarketHistory", "getMarketRecurringRound", "getMarketReferenceCloses", "getOperation", "getQuestion", "getQuestionRecurringRound", "getRfq", "getSeries", "getTaxonomy", "listAccountActivity", "listAccountPositions", "listDiscovery", "listMakerAcceptances", "listMakerActivity", "listMakerPositions", "listMakerQuoteHistory", "listMarkets", "listOperations", "listRfqs", "publishMakerTelemetry", "releaseQuoteLease", "renewQuoteLease", "searchCatalog", "stream", "submitMakerSelfFundedTransaction"];
|
|
23
23
|
readonly operator: readonly ["live", "ready"];
|
|
24
24
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Generated by scripts/generate.mjs; do not edit.
|
|
2
|
-
export const sdkVersion = "
|
|
3
|
-
export const openapiSha256 = "
|
|
2
|
+
export const sdkVersion = "211.0.0-golden-live-fives";
|
|
3
|
+
export const openapiSha256 = "35c16104e0eaa909bfa93999c770a4f209173d37f0ee16c328807ecdecf6c9d5";
|
|
4
4
|
export const realtimeSha256 = "f4f1078418b5302417babe1380b85b0c4f89cb0fdfaff3a46154dd2018625c07";
|
|
5
5
|
export const jsonSchemaSha256 = {
|
|
6
6
|
"account.schema.json": "5106e2d53abef190990eff113f6692dd27df5848439cf5a80a42c11e89f2bef6",
|
|
@@ -9,7 +9,7 @@ export const jsonSchemaSha256 = {
|
|
|
9
9
|
"core-exit.schema.json": "c7f617e815225cdcac95c236f8b73fbe288ee5713ff444c3be90eb915fc3a401",
|
|
10
10
|
"error.schema.json": "d15dad1b8369b45746271e0fddd2106535c22493668b703544c9ddfa80761012",
|
|
11
11
|
"hypercore.schema.json": "5b89b2bbff7ec8cc1b8717375d12ce9cd5ab6aa5af03c4fdc6cc753ef9583a2c",
|
|
12
|
-
"identity.schema.json": "
|
|
12
|
+
"identity.schema.json": "b623b947db4fe8fe1f297158bcc6a555c0333f3937ca925dda20ec4956ea479f",
|
|
13
13
|
"maker-access.schema.json": "49698ee0235e42064aae0397db1e0f646bdc10d9dfa10121714ba06dd69fee3b",
|
|
14
14
|
"maker-action.schema.json": "dc41e52c868848e85cdeb918992cb710d34616d2803a63f6d9a658e016744a50",
|
|
15
15
|
"maker-telemetry.schema.json": "85b111ce0f4935299d1116071b43de12e775bef4e0c283c12f19046d34374a9c",
|
|
@@ -132,6 +132,7 @@ export const operations = {
|
|
|
132
132
|
"setCopySettings",
|
|
133
133
|
"setPublicProfile",
|
|
134
134
|
"setUsername",
|
|
135
|
+
"setXHandleShown",
|
|
135
136
|
"stream",
|
|
136
137
|
"streamMarkets",
|
|
137
138
|
"switchOffComboCopyAgent",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@totalis/hip4-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.84.0",
|
|
4
4
|
"description": "Totalis HIP-4 SDK: typed HTTP clients, signer-agnostic typed data, a retrying request layer, pagination, a realtime stream and taker/maker flows",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|