@totalis/hip4-client 0.83.0 → 0.84.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 `@totalis/hip4-client` follows [semantic versioning](https://semver.org).
 The contract version the generated types come from is `sdkVersion` in `./version`.
 
+## 0.84.0
+
+### Added
+
+- `getGolden`: `golden.placement`, the account's latest golden placement as
+  `placeGolden` answers it, plus `created_at`, or null (TT-2627).
+- `getGoldenSuggestions` items are `GoldenSuggestedCombo`: `payout` is the
+  live best house offer, with its `accept_before` and the five's `band`
+  (`HUGE`, `BIG`, `STEADY`). Contract `211.0.0-golden-live-fives`.
+
 ## 0.83.0
 
 ### Added

package/dist/generated/openapi.d.ts

@@ -724,7 +724,7 @@ export type paths = {
         };
         /**
          * List golden suggestions
-         * @description Up to three ready-made golden Combos that share no outcome, for an account whose golden ticket is available: 5 legs from golden markets at the 1 USDC golden stake, each priced recently by a Totalis maker quote to the promo account. Picking one only fills the slip; place it through POST /v1/me/golden/rfqs, which requotes. A suggestion leaves the list once a leg is no longer a golden market or its quote is two hours old.
+         * @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.
          */
         readonly get: operations["getGoldenSuggestions"];
         readonly put?: never;
@@ -3257,6 +3257,34 @@ export type components = {
         readonly HyperevmKeeperOperationKind: "DEPOSIT_USER_AUTHORIZED" | "WITHDRAW_USER" | "ACCEPT" | "SETTLE" | "CACHE_SETTLEMENT" | "CLAIM" | "SELL_BACK" | "TRANSFER_TICKET" | "ATTEST" | "SYNC" | "TOTALIS_PAYOUT" | "CORE_EXIT" | "SET_AGENT";
         readonly Hash32: string;
         readonly Uint256: string;
+        /**
+         * GoldenPlacementState
+         * @enum {string}
+         */
+        readonly GoldenPlacementState: "PLACING" | "BOUGHT" | "DELIVERED" | "FAILED";
+        /**
+         * GoldenPlacementFailure
+         * @enum {string}
+         */
+        readonly GoldenPlacementFailure: "MAKER_DECLINED" | "ACCEPT_FAILED" | "NOT_ACCEPTED" | "PROMO_BUSY" | "GIFT_FAILED" | "GIFT_EXPIRED";
+        /** GoldenSuggestedCombo */
+        readonly GoldenSuggestedCombo: {
+            readonly legs: readonly components["schemas"]["$defs-Leg"][];
+            /** @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. */
+            readonly cards: readonly components["schemas"]["Card"][];
+            readonly stake: components["schemas"]["$defs-Amount"];
+            /** @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. */
+            readonly payout: components["schemas"]["$defs-Amount"];
+            /** @description When the server first saw that offer. */
+            readonly quoted_at: components["schemas"]["$defs-Timestamp"];
+            /** @description When that offer stops being takeable. Drop the number once it passes without a newer read; never show it after. */
+            readonly accept_before: components["schemas"]["$defs-Timestamp"];
+            /**
+             * @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.
+             * @enum {string}
+             */
+            readonly band: "HUGE" | "BIG" | "STEADY";
+        };
         /** SuggestedCombo */
         readonly SuggestedCombo: {
             readonly legs: readonly components["schemas"]["$defs-Leg"][];
@@ -7842,7 +7870,19 @@ export interface operations {
                             /** @description The gifted position once PLACED; null otherwise. */
                             readonly position_id: null | components["schemas"]["Bytes32"];
                             /** @description While AVAILABLE, why the latest placement failed, if one did; null otherwise. */
-                            readonly last_failure: null | ("MAKER_DECLINED" | "ACCEPT_FAILED" | "NOT_ACCEPTED" | "PROMO_BUSY" | "GIFT_FAILED" | "GIFT_EXPIRED");
+                            readonly last_failure: null | components["schemas"]["GoldenPlacementFailure"];
+                            /** @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. */
+                            readonly placement: null | {
+                                readonly placement_id: components["schemas"]["Uuid"];
+                                /** @description As placeGolden answers it, now. */
+                                readonly state: components["schemas"]["GoldenPlacementState"];
+                                /** @description The placed quote's digest: the position this placement buys, which is the account's once DELIVERED. */
+                                readonly position_id: components["schemas"]["Bytes32"];
+                                /** @description Why it failed, once FAILED; null otherwise. */
+                                readonly failure: null | components["schemas"]["GoldenPlacementFailure"];
+                                /** @description When the placement was recorded. */
+                                readonly created_at: components["schemas"]["$defs-Timestamp"];
+                            };
                         };
                     };
                 };
@@ -7899,8 +7939,8 @@ export interface operations {
                 };
                 content: {
                     readonly "application/json": {
-                        /** @description In order; empty when none is priced. `payout` is the Totalis maker quote's win amount after the profit fee, indicative only. */
-                        readonly combos: readonly components["schemas"]["SuggestedCombo"][];
+                        /** @description Biggest band first; empty while none has a live offer. */
+                        readonly combos: readonly components["schemas"]["GoldenSuggestedCombo"][];
                     };
                 };
             };
@@ -8046,14 +8086,11 @@ export interface operations {
                 content: {
                     readonly "application/json": {
                         readonly placement_id: components["schemas"]["Uuid"];
-                        /**
-                         * @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.
-                         * @enum {string}
-                         */
-                        readonly state: "PLACING" | "BOUGHT" | "DELIVERED" | "FAILED";
+                        /** @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. */
+                        readonly state: components["schemas"]["GoldenPlacementState"];
                         /** @description The quote's digest: the position the gift delivers. */
                         readonly position_id: components["schemas"]["Bytes32"];
-                        readonly failure: null | ("MAKER_DECLINED" | "ACCEPT_FAILED" | "NOT_ACCEPTED" | "PROMO_BUSY" | "GIFT_FAILED" | "GIFT_EXPIRED");
+                        readonly failure: null | components["schemas"]["GoldenPlacementFailure"];
                     };
                 };
             };

package/dist/generated/version.d.ts

@@ -1,5 +1,5 @@
-export declare const sdkVersion = "210.0.0-x-handle";
-export declare const openapiSha256 = "6396986bd3e2372fa6a021bed8745631c98cdc4a775b903d96f366195c6ebda4";
+export declare const sdkVersion = "211.0.0-golden-live-fives";
+export declare const openapiSha256 = "35c16104e0eaa909bfa93999c770a4f209173d37f0ee16c328807ecdecf6c9d5";
 export declare const realtimeSha256 = "f4f1078418b5302417babe1380b85b0c4f89cb0fdfaff3a46154dd2018625c07";
 export declare const jsonSchemaSha256: {
     readonly "account.schema.json": "5106e2d53abef190990eff113f6692dd27df5848439cf5a80a42c11e89f2bef6";

package/dist/generated/version.js

@@ -1,6 +1,6 @@
 // Generated by scripts/generate.mjs; do not edit.
-export const sdkVersion = "210.0.0-x-handle";
-export const openapiSha256 = "6396986bd3e2372fa6a021bed8745631c98cdc4a775b903d96f366195c6ebda4";
+export const sdkVersion = "211.0.0-golden-live-fives";
+export const openapiSha256 = "35c16104e0eaa909bfa93999c770a4f209173d37f0ee16c328807ecdecf6c9d5";
 export const realtimeSha256 = "f4f1078418b5302417babe1380b85b0c4f89cb0fdfaff3a46154dd2018625c07";
 export const jsonSchemaSha256 = {
     "account.schema.json": "5106e2d53abef190990eff113f6692dd27df5848439cf5a80a42c11e89f2bef6",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@totalis/hip4-client",
-  "version": "0.83.0",
+  "version": "0.84.0",
   "description": "Totalis HIP-4 SDK: typed HTTP clients, signer-agnostic typed data, a retrying request layer, pagination, a realtime stream and taker/maker flows",
   "type": "module",
   "files": [