Updated code to reflect Order Status spec changes.

TBD54566975 · Jul 18, 2024 · 8ea160c · 8ea160c
1 parent 5a7a08b
commit 8ea160c
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 8 deletions.
diff --git a/packages/protocol/src/message-kinds/order-status.ts b/packages/protocol/src/message-kinds/order-status.ts
@@ -72,6 +72,6 @@ export class OrderStatus extends Message {
 
   /** Current status of Order that's being executed (e.g. PROCESSING, COMPLETED, FAILED etc.) */
   get orderStatus() {
-    return this.data.orderStatus
+    return this.data.status
   }
 }
diff --git a/packages/protocol/src/types.ts b/packages/protocol/src/types.ts
@@ -406,8 +406,26 @@ export type OrderData = {
  * @beta
  */
 export type OrderStatusData = {
-  /** Current status of Order that's being executed (e.g. PROCESSING, COMPLETED, FAILED etc.) */
-  orderStatus: string
+  /** Current status of Order that's being executed (e.g. PAYIN_PENDING, PAYOUT_PENDING, PAYOUT_SETTLED etc.) */
+  status: OrderStatusEnum
+  /** An explanation of the status */
+  detail?: string
+}
+
+export enum OrderStatusEnum {
+  PayinPending = 'PAYIN_PENDING',
+  PayinInitiated = 'PAYIN_INITIATED',
+  PayinSettled = 'PAYIN_SETTLED',
+  PayinFailed = 'PAYIN_FAILED',
+  PayinExpired = 'PAYIN_EXPIRED',
+  PayoutPending = 'PAYOUT_PENDING',
+  PayoutInitiated = 'PAYOUT_INITIATED',
+  PayoutSettled = 'PAYOUT_SETTLED',
+  PayoutFailed = 'PAYOUT_FAILED',
+  RefundPending = 'REFUND_PENDING',
+  RefundInitiated = 'REFUND_INITIATED',
+  RefundSettled = 'REFUND_SETTLED',
+  RefundFailed = 'REFUND_FAILED'
 }
 
 /**

diff --git a/packages/protocol/tests/exchange.spec.ts b/packages/protocol/tests/exchange.spec.ts
@@ -1,6 +1,6 @@
 import { BearerDid, DidDht, DidJwk } from '@web5/dids'
 import { expect } from 'chai'
-import { Close, DevTools, Exchange, Message, Order, OrderStatus, Quote, Rfq } from '../src/main.js'
+import { Close, DevTools, Exchange, Message, Order, OrderStatus, OrderStatusEnum, Quote, Rfq } from '../src/main.js'
 
 describe('Exchange', () => {
   let aliceDid: BearerDid
@@ -75,7 +75,7 @@ describe('Exchange', () => {
         exchangeId : rfq.metadata.exchangeId
       },
       data: {
-        orderStatus: 'Done'
+        status: OrderStatusEnum.PayoutSettled
       }
     })
   })
@@ -372,7 +372,7 @@ describe('Exchange', () => {
           exchangeId : rfq.metadata.exchangeId
         },
         data: {
-          orderStatus: 'Done'
+          status: OrderStatusEnum.PayoutSettled
         }
       })
       await orderStatus.sign(pfiDid)

diff --git a/packages/protocol/tests/generate-test-vectors.ts b/packages/protocol/tests/generate-test-vectors.ts
@@ -1,5 +1,5 @@
 import { VerifiableCredential } from '@web5/credentials'
-import { Close, DevTools, Message, Order, OrderStatus, Quote, Resource, Rfq } from '../src/main.js'
+import { Close, DevTools, Message, Order, OrderStatus, OrderStatusEnum, Quote, Resource, Rfq } from '../src/main.js'
 import fs from 'fs'
 import { DidDht } from '@web5/dids'
 
@@ -204,7 +204,7 @@ const generateParseOrderStatusVector = async () => {
   const orderStatus = OrderStatus.create({
     metadata : { from: pfiDid.uri, to: aliceDid.uri, exchangeId: Message.generateId('rfq'),  protocol: '1.0' },
     data     : {
-      orderStatus: 'wee'
+      status: OrderStatusEnum.PayinInitiated
     }
   })