@loafmarkets/shared-types 2.0.27 → 2.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loafmarkets/shared-types",
-  "version": "2.0.27",
+  "version": "2.0.28",
   "description": "Shared contracts for Loaf Markets frontend, backend, and matching engine.",
   "type": "module",
   "private": false,

package/proto/trading.proto

@@ -24,9 +24,9 @@ syntax = "proto3";
 //   - users.id and properties.id are PostgreSQL integer, hence the bounds 1..=2147483647; order,
 //     trade and conditional-order ids are bigint, hence 1..=9223372036854775807.
 //
-// Enums. Enums added for the write-loop matching engine have <NAME>_UNSPECIFIED = 0 and prefixed
-// values; UNSPECIFIED is never a valid business value (rejected in requests, "not applicable" in
-// replies). The older enums OrderSide, OrderType and TimeInForce keep a meaningful zero (BUY, MARKET,
+// Enums. Every enum except OrderSide, OrderType and TimeInForce has <NAME>_UNSPECIFIED = 0 and
+// prefixed values; UNSPECIFIED is never a valid business value (rejected in requests, "not
+// applicable" in replies). OrderSide, OrderType and TimeInForce have a meaningful zero (BUY, MARKET,
 // GTC), so the engine cannot tell an omitted value from that zero: callers must always set them.
 //
 // gRPC status contract (every RPC):
@@ -165,7 +165,6 @@ message SubmitOrderRequest {
   uint64 price = 3;
 
   // Quantity, property tokens x 10; stored as orders.quantity. Required: 1..=9223372036854775807.
-  // Widened from uint32; the varint encoding is the same, so older encoders stay readable.
   uint64 quantity = 4;
 
   // BUY or SELL; any other number is rejected.
@@ -565,8 +564,8 @@ message TradeExecution {
   // trades.tx_hash: the on-chain transaction of the batch proof that covers this trade, "" until it
   // is posted. The engine publishes before any proof exists, so it is always "" today.
   string tx_hash = 52;
-  // Retired fields that no subscriber read: never reuse their numbers or names. 40 to 51 are not free
-  // either: unmerged branches use them (Permit 40 and 41, the ZkLoaf L2 fill fields 42 to 51).
+  // Reserved: never reuse these numbers or names. 40 to 51 are taken too: unmerged branches use them
+  // (Permit 40 and 41, the ZkLoaf L2 fill fields 42 to 51).
   reserved 5, 16 to 24, 26 to 30, 32 to 39;
   reserved "property_token_address", "deadline", "buyer_nonce", "seller_nonce", "buyer_signature",
       "seller_signature", "cpp_signature", "buy_price", "buy_price_multiplier", "buy_quantity",
@@ -594,11 +593,10 @@ message OrderBookSnapshot {
 
 // One price level of an OrderBookSnapshot.
 message PriceLevel {
-  // Level price, USDL x 1000. Declared double for historical reasons: always an integer, printed as a
-  // JSON integer.
+  // Level price, USDL x 1000. Declared double: always an integer, printed as a JSON integer.
   double price = 1;
-  // Sum of the level's unfilled quantities, property tokens x 10. Declared double for historical
-  // reasons: always an integer, printed as a JSON integer.
+  // Sum of the level's unfilled quantities, property tokens x 10. Declared double: always an
+  // integer, printed as a JSON integer.
   double quantity = 2;
   // The level's resting orders in time priority (the first fills first).
   repeated OrderData orders = 3;