@zoguxprotocol/proto 0.1.0

package/src/codegen/zogux/indexer/shared/removal_reason.ts

@@ -0,0 +1,216 @@
+/** OrderRemovalReason is an enum of all the reasons an order was removed. */
+export enum OrderRemovalReason {
+  /** ORDER_REMOVAL_REASON_UNSPECIFIED - Default value, this is invalid and unused. */
+  ORDER_REMOVAL_REASON_UNSPECIFIED = 0,
+
+  /** ORDER_REMOVAL_REASON_EXPIRED - The order was removed due to being expired. */
+  ORDER_REMOVAL_REASON_EXPIRED = 1,
+
+  /** ORDER_REMOVAL_REASON_USER_CANCELED - The order was removed due to being canceled by a user. */
+  ORDER_REMOVAL_REASON_USER_CANCELED = 2,
+
+  /** ORDER_REMOVAL_REASON_UNDERCOLLATERALIZED - The order was removed due to being undercollateralized. */
+  ORDER_REMOVAL_REASON_UNDERCOLLATERALIZED = 3,
+
+  /**
+   * ORDER_REMOVAL_REASON_INTERNAL_ERROR - The order caused an internal error during order placement and was
+   * removed.
+   */
+  ORDER_REMOVAL_REASON_INTERNAL_ERROR = 4,
+
+  /**
+   * ORDER_REMOVAL_REASON_SELF_TRADE_ERROR - The order would have matched against another order placed by the same
+   * subaccount and was removed.
+   */
+  ORDER_REMOVAL_REASON_SELF_TRADE_ERROR = 5,
+
+  /**
+   * ORDER_REMOVAL_REASON_POST_ONLY_WOULD_CROSS_MAKER_ORDER - The order would have matched against maker orders on the orderbook
+   * despite being a post-only order and was removed.
+   */
+  ORDER_REMOVAL_REASON_POST_ONLY_WOULD_CROSS_MAKER_ORDER = 6,
+
+  /**
+   * ORDER_REMOVAL_REASON_IMMEDIATE_OR_CANCEL_WOULD_REST_ON_BOOK - The order was an ICO order and would have been placed on the orderbook as
+   * resting liquidity and was removed.
+   */
+  ORDER_REMOVAL_REASON_IMMEDIATE_OR_CANCEL_WOULD_REST_ON_BOOK = 7,
+
+  /**
+   * ORDER_REMOVAL_REASON_FOK_ORDER_COULD_NOT_BE_FULLY_FULLED - The order was a fill-or-kill order that could not be fully filled and was
+   * removed.
+   */
+  ORDER_REMOVAL_REASON_FOK_ORDER_COULD_NOT_BE_FULLY_FULLED = 8,
+
+  /**
+   * ORDER_REMOVAL_REASON_REDUCE_ONLY_RESIZE - The order was a reduce-only order that was removed due to either:
+   * - being a taker order and fully-filling the order would flip the side of
+   *    the subaccount's position, in this case the remaining size of the
+   *    order is removed
+   * - being a maker order resting on the book and being removed when either
+   *    the subaccount's position is closed or flipped sides
+   */
+  ORDER_REMOVAL_REASON_REDUCE_ONLY_RESIZE = 9,
+
+  /**
+   * ORDER_REMOVAL_REASON_INDEXER_EXPIRED - The order should be expired, according to the Indexer's cached data, but
+   * the Indexer has yet to receive a message to remove the order. In order to
+   * keep the data cached by the Indexer up-to-date and accurate, clear out
+   * the data if it's expired by sending an order removal with this reason.
+   * Protocol should never send this reason to Indexer.
+   */
+  ORDER_REMOVAL_REASON_INDEXER_EXPIRED = 10,
+
+  /** ORDER_REMOVAL_REASON_REPLACED - The order has been replaced. */
+  ORDER_REMOVAL_REASON_REPLACED = 11,
+
+  /**
+   * ORDER_REMOVAL_REASON_FULLY_FILLED - The order has been fully-filled. Only sent by the Indexer for stateful
+   * orders.
+   */
+  ORDER_REMOVAL_REASON_FULLY_FILLED = 12,
+
+  /**
+   * ORDER_REMOVAL_REASON_EQUITY_TIER - The order has been removed since the subaccount does not satisfy the
+   * equity tier requirements.
+   */
+  ORDER_REMOVAL_REASON_EQUITY_TIER = 13,
+
+  /** ORDER_REMOVAL_REASON_FINAL_SETTLEMENT - The order has been removed since its ClobPair has entered final settlement. */
+  ORDER_REMOVAL_REASON_FINAL_SETTLEMENT = 14,
+
+  /**
+   * ORDER_REMOVAL_REASON_VIOLATES_ISOLATED_SUBACCOUNT_CONSTRAINTS - The order has been removed since filling it would lead to the subaccount
+   * violating isolated subaccount constraints.
+   */
+  ORDER_REMOVAL_REASON_VIOLATES_ISOLATED_SUBACCOUNT_CONSTRAINTS = 15,
+  UNRECOGNIZED = -1,
+}
+export const OrderRemovalReasonSDKType = OrderRemovalReason;
+export function orderRemovalReasonFromJSON(object: any): OrderRemovalReason {
+  switch (object) {
+    case 0:
+    case "ORDER_REMOVAL_REASON_UNSPECIFIED":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_UNSPECIFIED;
+
+    case 1:
+    case "ORDER_REMOVAL_REASON_EXPIRED":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_EXPIRED;
+
+    case 2:
+    case "ORDER_REMOVAL_REASON_USER_CANCELED":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_USER_CANCELED;
+
+    case 3:
+    case "ORDER_REMOVAL_REASON_UNDERCOLLATERALIZED":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_UNDERCOLLATERALIZED;
+
+    case 4:
+    case "ORDER_REMOVAL_REASON_INTERNAL_ERROR":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_INTERNAL_ERROR;
+
+    case 5:
+    case "ORDER_REMOVAL_REASON_SELF_TRADE_ERROR":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_SELF_TRADE_ERROR;
+
+    case 6:
+    case "ORDER_REMOVAL_REASON_POST_ONLY_WOULD_CROSS_MAKER_ORDER":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_POST_ONLY_WOULD_CROSS_MAKER_ORDER;
+
+    case 7:
+    case "ORDER_REMOVAL_REASON_IMMEDIATE_OR_CANCEL_WOULD_REST_ON_BOOK":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_IMMEDIATE_OR_CANCEL_WOULD_REST_ON_BOOK;
+
+    case 8:
+    case "ORDER_REMOVAL_REASON_FOK_ORDER_COULD_NOT_BE_FULLY_FULLED":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_FOK_ORDER_COULD_NOT_BE_FULLY_FULLED;
+
+    case 9:
+    case "ORDER_REMOVAL_REASON_REDUCE_ONLY_RESIZE":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_REDUCE_ONLY_RESIZE;
+
+    case 10:
+    case "ORDER_REMOVAL_REASON_INDEXER_EXPIRED":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_INDEXER_EXPIRED;
+
+    case 11:
+    case "ORDER_REMOVAL_REASON_REPLACED":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_REPLACED;
+
+    case 12:
+    case "ORDER_REMOVAL_REASON_FULLY_FILLED":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_FULLY_FILLED;
+
+    case 13:
+    case "ORDER_REMOVAL_REASON_EQUITY_TIER":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_EQUITY_TIER;
+
+    case 14:
+    case "ORDER_REMOVAL_REASON_FINAL_SETTLEMENT":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_FINAL_SETTLEMENT;
+
+    case 15:
+    case "ORDER_REMOVAL_REASON_VIOLATES_ISOLATED_SUBACCOUNT_CONSTRAINTS":
+      return OrderRemovalReason.ORDER_REMOVAL_REASON_VIOLATES_ISOLATED_SUBACCOUNT_CONSTRAINTS;
+
+    case -1:
+    case "UNRECOGNIZED":
+    default:
+      return OrderRemovalReason.UNRECOGNIZED;
+  }
+}
+export function orderRemovalReasonToJSON(object: OrderRemovalReason): string {
+  switch (object) {
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_UNSPECIFIED:
+      return "ORDER_REMOVAL_REASON_UNSPECIFIED";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_EXPIRED:
+      return "ORDER_REMOVAL_REASON_EXPIRED";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_USER_CANCELED:
+      return "ORDER_REMOVAL_REASON_USER_CANCELED";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_UNDERCOLLATERALIZED:
+      return "ORDER_REMOVAL_REASON_UNDERCOLLATERALIZED";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_INTERNAL_ERROR:
+      return "ORDER_REMOVAL_REASON_INTERNAL_ERROR";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_SELF_TRADE_ERROR:
+      return "ORDER_REMOVAL_REASON_SELF_TRADE_ERROR";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_POST_ONLY_WOULD_CROSS_MAKER_ORDER:
+      return "ORDER_REMOVAL_REASON_POST_ONLY_WOULD_CROSS_MAKER_ORDER";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_IMMEDIATE_OR_CANCEL_WOULD_REST_ON_BOOK:
+      return "ORDER_REMOVAL_REASON_IMMEDIATE_OR_CANCEL_WOULD_REST_ON_BOOK";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_FOK_ORDER_COULD_NOT_BE_FULLY_FULLED:
+      return "ORDER_REMOVAL_REASON_FOK_ORDER_COULD_NOT_BE_FULLY_FULLED";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_REDUCE_ONLY_RESIZE:
+      return "ORDER_REMOVAL_REASON_REDUCE_ONLY_RESIZE";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_INDEXER_EXPIRED:
+      return "ORDER_REMOVAL_REASON_INDEXER_EXPIRED";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_REPLACED:
+      return "ORDER_REMOVAL_REASON_REPLACED";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_FULLY_FILLED:
+      return "ORDER_REMOVAL_REASON_FULLY_FILLED";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_EQUITY_TIER:
+      return "ORDER_REMOVAL_REASON_EQUITY_TIER";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_FINAL_SETTLEMENT:
+      return "ORDER_REMOVAL_REASON_FINAL_SETTLEMENT";
+
+    case OrderRemovalReason.ORDER_REMOVAL_REASON_VIOLATES_ISOLATED_SUBACCOUNT_CONSTRAINTS:
+      return "ORDER_REMOVAL_REASON_VIOLATES_ISOLATED_SUBACCOUNT_CONSTRAINTS";
+
+    case OrderRemovalReason.UNRECOGNIZED:
+    default:
+      return "UNRECOGNIZED";
+  }
+}