Merge pull request #28 from mangrovedao/feat/orderType

feat: order label

.changeset/few-plants-hug.md

@@ -0,0 +1,5 @@
+---
+"@mangrovedao/mgv": patch
+---
+
+Add orderLabel function to lib to get the label of an order

src/lib/index.ts

@@ -44,6 +44,7 @@ export {
   rawLimitOrderResultFromLogs,
   limitOrderResultFromLogs,
   getDefaultLimitOrderGasreq,
+  orderLabel,
 } from './limit-order.js'
 
 // local

src/lib/limit-order.ts

@@ -4,7 +4,7 @@ import type {
   MarketParams,
 } from '../types/index.js'
 import type { OLKey } from '../types/lib.js'
-import { BS } from './enums.js'
+import { BS, Order } from './enums.js'
 import { mgvEventsABI, rawMarketOrderResultFromLogs } from './market-order.js'
 import { flip, hash } from './ol-key.js'
 import { inboundFromOutbound } from './tick.js'
@@ -105,3 +105,17 @@ export type GetDefaultLimitOrderGasreqParams = {
 export function getDefaultLimitOrderGasreq(): bigint {
   return 250_000n
 }
+
+const _orderLabel = {
+  [Order.GTC]: 'Good Til Cancelled',
+  [Order.GTCE]: 'Good Til Cancelled Enforced',
+  [Order.PO]: 'Post Only',
+  [Order.IOC]: 'Immediate Or Cancel',
+  [Order.FOK]: 'Fill Or Kill',
+} as const satisfies { [key in Order]: string }
+
+export function orderLabel<TOrder extends Order = Order>(
+  order: TOrder,
+): (typeof _orderLabel)[TOrder] {
+  return _orderLabel[order]
+}