@ottochain/sdk 2.0.0 → 2.2.0

package/dist/types/apps/markets/state-machines/market-group-buy.d.ts

@@ -0,0 +1,539 @@
+/**
+ * Collective purchasing with quantity thresholds and tiered pricing.
+ */
+export declare const marketGroupBuyDef: {
+    readonly metadata: {
+        readonly name: "MarketGroupBuy";
+        readonly app: "markets";
+        readonly type: "groupBuy";
+        readonly version: "1.0.0";
+        readonly description: "Collective purchasing with quantity thresholds and tiered pricing";
+        readonly crossReferences: {
+            readonly vendorIdentityId: "Links to vendor's IdentityAgent";
+            readonly escrowId: "Links to ContractEscrow for payment custody";
+        };
+    };
+    readonly createSchema: {
+        readonly required: readonly ["organizer", "minQuantity", "deadline"];
+        readonly properties: {
+            readonly organizer: {
+                readonly type: "address";
+                readonly description: "DAG address of group buy organizer";
+                readonly immutable: true;
+            };
+            readonly minQuantity: {
+                readonly type: "number";
+                readonly minimum: 1;
+                readonly description: "Minimum quantity to proceed";
+                readonly immutable: true;
+            };
+            readonly deadline: {
+                readonly type: "timestamp";
+                readonly description: "Order deadline";
+                readonly immutable: true;
+            };
+            readonly vendor: {
+                readonly type: "address";
+                readonly description: "DAG address of the vendor";
+            };
+            readonly maxPerBuyer: {
+                readonly type: "number";
+                readonly minimum: 1;
+                readonly description: "Max quantity per buyer";
+            };
+            readonly priceTiers: {
+                readonly type: "array";
+                readonly description: "Quantity-based pricing tiers";
+            };
+        };
+    };
+    readonly stateSchema: {
+        readonly properties: {
+            readonly status: {
+                readonly type: "string";
+                readonly computed: true;
+            };
+            readonly organizer: {
+                readonly type: "address";
+                readonly immutable: true;
+            };
+            readonly vendor: {
+                readonly type: "address";
+            };
+            readonly minQuantity: {
+                readonly type: "number";
+                readonly immutable: true;
+            };
+            readonly maxPerBuyer: {
+                readonly type: "number";
+            };
+            readonly deadline: {
+                readonly type: "timestamp";
+                readonly immutable: true;
+            };
+            readonly priceTiers: {
+                readonly type: "array";
+            };
+            readonly orders: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+            readonly totalQuantity: {
+                readonly type: "number";
+                readonly computed: true;
+            };
+            readonly currentTier: {
+                readonly type: "number";
+                readonly computed: true;
+            };
+            readonly refundsClaimed: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+        };
+    };
+    readonly eventSchemas: {
+        readonly open: {
+            readonly description: "Open the group buy for orders";
+        };
+        readonly cancel: {
+            readonly description: "Cancel the group buy";
+        };
+        readonly order: {
+            readonly description: "Place an order";
+            readonly required: readonly ["quantity"];
+            readonly properties: {
+                readonly quantity: {
+                    readonly type: "number";
+                    readonly minimum: 1;
+                };
+                readonly shippingInfo: {
+                    readonly type: "object";
+                };
+            };
+        };
+        readonly check_threshold: {
+            readonly description: "Check if minimum threshold reached";
+        };
+        readonly finalize: {
+            readonly description: "Finalize after deadline";
+        };
+        readonly fulfill: {
+            readonly description: "Mark group buy as fulfilled by vendor/organizer";
+        };
+        readonly claim_refund: {
+            readonly description: "Claim refund if threshold not met";
+        };
+    };
+    readonly states: {
+        readonly PROPOSED: {
+            readonly id: "PROPOSED";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Group buy created but not yet open";
+            };
+        };
+        readonly OPEN: {
+            readonly id: "OPEN";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Accepting orders";
+            };
+        };
+        readonly THRESHOLD_MET: {
+            readonly id: "THRESHOLD_MET";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Minimum quantity reached, continuing for better tier";
+            };
+        };
+        readonly PROCESSING: {
+            readonly id: "PROCESSING";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Order placed with vendor, awaiting fulfillment";
+            };
+        };
+        readonly FULFILLED: {
+            readonly id: "FULFILLED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "All items delivered to buyers";
+            };
+        };
+        readonly REFUNDED: {
+            readonly id: "REFUNDED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "Threshold not met, all orders refunded";
+            };
+        };
+        readonly CANCELLED: {
+            readonly id: "CANCELLED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "Group buy cancelled";
+            };
+        };
+    };
+    readonly initialState: "PROPOSED";
+    readonly transitions: readonly [{
+        readonly from: "PROPOSED";
+        readonly to: "OPEN";
+        readonly eventName: "open";
+        readonly guard: {
+            readonly "===": readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.organizer";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "OPEN";
+                readonly openedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly orders: readonly [];
+                readonly totalQuantity: 0;
+                readonly currentTier: 0;
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "PROPOSED";
+        readonly to: "CANCELLED";
+        readonly eventName: "cancel";
+        readonly guard: {
+            readonly "===": readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.organizer";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "CANCELLED";
+                readonly cancelledAt: {
+                    readonly var: "$timestamp";
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "OPEN";
+        readonly to: "OPEN";
+        readonly eventName: "order";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly var: "event.quantity";
+                }, 0];
+            }, {
+                readonly or: readonly [{
+                    readonly "!": readonly [{
+                        readonly var: "state.maxPerBuyer";
+                    }];
+                }, {
+                    readonly "<=": readonly [{
+                        readonly var: "event.quantity";
+                    }, {
+                        readonly var: "state.maxPerBuyer";
+                    }];
+                }];
+            }, {
+                readonly "<=": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.deadline";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly orders: {
+                    readonly cat: readonly [{
+                        readonly var: "state.orders";
+                    }, readonly [{
+                        readonly buyer: {
+                            readonly var: "event.agent";
+                        };
+                        readonly quantity: {
+                            readonly var: "event.quantity";
+                        };
+                        readonly shippingInfo: {
+                            readonly var: "event.shippingInfo";
+                        };
+                        readonly orderedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }]];
+                };
+                readonly totalQuantity: {
+                    readonly "+": readonly [{
+                        readonly var: "state.totalQuantity";
+                    }, {
+                        readonly var: "event.quantity";
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "OPEN";
+        readonly to: "THRESHOLD_MET";
+        readonly eventName: "check_threshold";
+        readonly guard: {
+            readonly ">=": readonly [{
+                readonly var: "state.totalQuantity";
+            }, {
+                readonly var: "state.minQuantity";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "THRESHOLD_MET";
+                readonly thresholdMetAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly currentTier: {
+                    readonly reduce: readonly [{
+                        readonly var: "state.priceTiers";
+                    }, {
+                        readonly if: readonly [{
+                            readonly "<=": readonly [{
+                                readonly var: "current.minQuantity";
+                            }, {
+                                readonly var: "state.totalQuantity";
+                            }];
+                        }, {
+                            readonly var: "current.tier";
+                        }, {
+                            readonly var: "accumulator";
+                        }];
+                    }, 0];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "THRESHOLD_MET";
+        readonly to: "THRESHOLD_MET";
+        readonly eventName: "order";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly var: "event.quantity";
+                }, 0];
+            }, {
+                readonly "<=": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.deadline";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly orders: {
+                    readonly cat: readonly [{
+                        readonly var: "state.orders";
+                    }, readonly [{
+                        readonly buyer: {
+                            readonly var: "event.agent";
+                        };
+                        readonly quantity: {
+                            readonly var: "event.quantity";
+                        };
+                        readonly shippingInfo: {
+                            readonly var: "event.shippingInfo";
+                        };
+                        readonly orderedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }]];
+                };
+                readonly totalQuantity: {
+                    readonly "+": readonly [{
+                        readonly var: "state.totalQuantity";
+                    }, {
+                        readonly var: "event.quantity";
+                    }];
+                };
+                readonly currentTier: {
+                    readonly reduce: readonly [{
+                        readonly var: "state.priceTiers";
+                    }, {
+                        readonly if: readonly [{
+                            readonly "<=": readonly [{
+                                readonly var: "current.minQuantity";
+                            }, {
+                                readonly "+": readonly [{
+                                    readonly var: "state.totalQuantity";
+                                }, {
+                                    readonly var: "event.quantity";
+                                }];
+                            }];
+                        }, {
+                            readonly var: "current.tier";
+                        }, {
+                            readonly var: "accumulator";
+                        }];
+                    }, {
+                        readonly var: "state.currentTier";
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "THRESHOLD_MET";
+        readonly to: "PROCESSING";
+        readonly eventName: "finalize";
+        readonly guard: {
+            readonly ">=": readonly [{
+                readonly var: "$timestamp";
+            }, {
+                readonly var: "state.deadline";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "PROCESSING";
+                readonly finalizedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly finalTier: {
+                    readonly var: "state.currentTier";
+                };
+                readonly finalPricePerUnit: {
+                    readonly var: {
+                        readonly cat: readonly ["state.priceTiers.", {
+                            readonly var: "state.currentTier";
+                        }, ".pricePerUnit"];
+                    };
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "PROCESSING";
+        readonly to: "FULFILLED";
+        readonly eventName: "fulfill";
+        readonly guard: {
+            readonly or: readonly [{
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.vendor";
+                }];
+            }, {
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.organizer";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "FULFILLED";
+                readonly fulfilledAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly trackingInfo: {
+                    readonly var: "event.trackingInfo";
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "OPEN";
+        readonly to: "REFUNDED";
+        readonly eventName: "finalize";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly "<": readonly [{
+                    readonly var: "state.totalQuantity";
+                }, {
+                    readonly var: "state.minQuantity";
+                }];
+            }, {
+                readonly ">=": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.deadline";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "REFUNDED";
+                readonly refundedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly reason: "threshold_not_met";
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "REFUNDED";
+        readonly to: "REFUNDED";
+        readonly eventName: "claim_refund";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly size: {
+                        readonly filter: readonly [{
+                            readonly var: "state.orders";
+                        }, {
+                            readonly "===": readonly [{
+                                readonly var: "buyer";
+                            }, {
+                                readonly var: "event.agent";
+                            }];
+                        }];
+                    };
+                }, 0];
+            }, {
+                readonly "!": readonly [{
+                    readonly in: readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly var: "state.refundsClaimed";
+                    }];
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly refundsClaimed: {
+                    readonly cat: readonly [{
+                        readonly var: "state.refundsClaimed";
+                    }, readonly [{
+                        readonly var: "event.agent";
+                    }]];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }];
+};