@ottochain/sdk 2.0.0 → 2.1.0

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

@@ -0,0 +1,443 @@
+/**
+ * All-or-nothing crowdfunding with threshold, deadline, and stretch goals.
+ */
+export declare const marketCrowdfundDef: {
+    readonly metadata: {
+        readonly name: "MarketCrowdfund";
+        readonly app: "markets";
+        readonly type: "crowdfund";
+        readonly version: "1.0.0";
+        readonly description: "All-or-nothing crowdfunding with threshold, deadline, and stretch goals";
+        readonly crossReferences: {
+            readonly creatorIdentityId: "Links to creator's IdentityAgent";
+            readonly treasuryId: "Links to Treasury for fund custody";
+        };
+    };
+    readonly createSchema: {
+        readonly required: readonly ["creator", "threshold", "deadline"];
+        readonly properties: {
+            readonly creator: {
+                readonly type: "address";
+                readonly description: "DAG address of campaign creator";
+                readonly immutable: true;
+            };
+            readonly threshold: {
+                readonly type: "number";
+                readonly minimum: 0;
+                readonly description: "Funding goal amount";
+                readonly immutable: true;
+            };
+            readonly deadline: {
+                readonly type: "timestamp";
+                readonly description: "Campaign deadline";
+                readonly immutable: true;
+            };
+            readonly minPledge: {
+                readonly type: "number";
+                readonly minimum: 0;
+                readonly description: "Minimum pledge amount";
+            };
+            readonly stretchGoals: {
+                readonly type: "array";
+                readonly description: "Stretch goal targets";
+            };
+        };
+    };
+    readonly stateSchema: {
+        readonly properties: {
+            readonly status: {
+                readonly type: "string";
+                readonly computed: true;
+            };
+            readonly creator: {
+                readonly type: "address";
+                readonly immutable: true;
+            };
+            readonly threshold: {
+                readonly type: "number";
+                readonly immutable: true;
+            };
+            readonly deadline: {
+                readonly type: "timestamp";
+                readonly immutable: true;
+            };
+            readonly minPledge: {
+                readonly type: "number";
+            };
+            readonly stretchGoals: {
+                readonly type: "array";
+            };
+            readonly pledges: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+            readonly totalPledged: {
+                readonly type: "number";
+                readonly computed: true;
+            };
+            readonly backerCount: {
+                readonly type: "number";
+                readonly computed: true;
+            };
+            readonly refundsClaimed: {
+                readonly type: "array";
+                readonly computed: true;
+            };
+        };
+    };
+    readonly eventSchemas: {
+        readonly launch: {
+            readonly description: "Launch the campaign";
+        };
+        readonly cancel: {
+            readonly description: "Cancel the campaign";
+        };
+        readonly pledge: {
+            readonly description: "Make a pledge";
+            readonly required: readonly ["amount"];
+            readonly properties: {
+                readonly amount: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                };
+                readonly rewardTier: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly increase_pledge: {
+            readonly description: "Increase an existing pledge";
+            readonly required: readonly ["additionalAmount"];
+            readonly properties: {
+                readonly additionalAmount: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                };
+            };
+        };
+        readonly finalize: {
+            readonly description: "Finalize the campaign after deadline";
+        };
+        readonly claim_refund: {
+            readonly description: "Claim refund in failed campaign";
+        };
+    };
+    readonly states: {
+        readonly PROPOSED: {
+            readonly id: "PROPOSED";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Campaign created but not yet open";
+            };
+        };
+        readonly OPEN: {
+            readonly id: "OPEN";
+            readonly isFinal: false;
+            readonly metadata: {
+                readonly description: "Accepting pledges";
+            };
+        };
+        readonly FUNDED: {
+            readonly id: "FUNDED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "Threshold met, funds released to creator";
+            };
+        };
+        readonly REFUNDED: {
+            readonly id: "REFUNDED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "Threshold not met, all pledges refunded";
+            };
+        };
+        readonly CANCELLED: {
+            readonly id: "CANCELLED";
+            readonly isFinal: true;
+            readonly metadata: {
+                readonly description: "Campaign cancelled by creator";
+            };
+        };
+    };
+    readonly initialState: "PROPOSED";
+    readonly transitions: readonly [{
+        readonly from: "PROPOSED";
+        readonly to: "OPEN";
+        readonly eventName: "launch";
+        readonly guard: {
+            readonly "===": readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.creator";
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "OPEN";
+                readonly launchedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly pledges: readonly [];
+                readonly totalPledged: 0;
+                readonly backerCount: 0;
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "PROPOSED";
+        readonly to: "CANCELLED";
+        readonly eventName: "cancel";
+        readonly guard: {
+            readonly "===": readonly [{
+                readonly var: "event.agent";
+            }, {
+                readonly var: "state.creator";
+            }];
+        };
+        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: "pledge";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly var: "event.amount";
+                }, 0];
+            }, {
+                readonly "!==": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.creator";
+                }];
+            }, {
+                readonly or: readonly [{
+                    readonly "!": readonly [{
+                        readonly var: "state.minPledge";
+                    }];
+                }, {
+                    readonly ">=": readonly [{
+                        readonly var: "event.amount";
+                    }, {
+                        readonly var: "state.minPledge";
+                    }];
+                }];
+            }, {
+                readonly "<=": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.deadline";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly pledges: {
+                    readonly cat: readonly [{
+                        readonly var: "state.pledges";
+                    }, readonly [{
+                        readonly backer: {
+                            readonly var: "event.agent";
+                        };
+                        readonly amount: {
+                            readonly var: "event.amount";
+                        };
+                        readonly rewardTier: {
+                            readonly var: "event.rewardTier";
+                        };
+                        readonly pledgedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    }]];
+                };
+                readonly totalPledged: {
+                    readonly "+": readonly [{
+                        readonly var: "state.totalPledged";
+                    }, {
+                        readonly var: "event.amount";
+                    }];
+                };
+                readonly backerCount: {
+                    readonly "+": readonly [{
+                        readonly var: "state.backerCount";
+                    }, 1];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "OPEN";
+        readonly to: "OPEN";
+        readonly eventName: "increase_pledge";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">": readonly [{
+                    readonly var: "event.additionalAmount";
+                }, 0];
+            }, {
+                readonly "<=": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.deadline";
+                }];
+            }, {
+                readonly ">": readonly [{
+                    readonly size: {
+                        readonly filter: readonly [{
+                            readonly var: "state.pledges";
+                        }, {
+                            readonly "===": readonly [{
+                                readonly var: "backer";
+                            }, {
+                                readonly var: "event.agent";
+                            }];
+                        }];
+                    };
+                }, 0];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly totalPledged: {
+                    readonly "+": readonly [{
+                        readonly var: "state.totalPledged";
+                    }, {
+                        readonly var: "event.additionalAmount";
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "OPEN";
+        readonly to: "FUNDED";
+        readonly eventName: "finalize";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly ">=": readonly [{
+                    readonly var: "state.totalPledged";
+                }, {
+                    readonly var: "state.threshold";
+                }];
+            }, {
+                readonly ">=": readonly [{
+                    readonly var: "$timestamp";
+                }, {
+                    readonly var: "state.deadline";
+                }];
+            }];
+        };
+        readonly effect: {
+            readonly merge: readonly [{
+                readonly var: "state";
+            }, {
+                readonly status: "FUNDED";
+                readonly fundedAt: {
+                    readonly var: "$timestamp";
+                };
+                readonly stretchGoalsReached: {
+                    readonly filter: readonly [{
+                        readonly var: "state.stretchGoals";
+                    }, {
+                        readonly "<=": readonly [{
+                            readonly var: "target";
+                        }, {
+                            readonly var: "state.totalPledged";
+                        }];
+                    }];
+                };
+            }];
+        };
+        readonly dependencies: readonly [];
+    }, {
+        readonly from: "OPEN";
+        readonly to: "REFUNDED";
+        readonly eventName: "finalize";
+        readonly guard: {
+            readonly and: readonly [{
+                readonly "<": readonly [{
+                    readonly var: "state.totalPledged";
+                }, {
+                    readonly var: "state.threshold";
+                }];
+            }, {
+                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.pledges";
+                        }, {
+                            readonly "===": readonly [{
+                                readonly var: "backer";
+                            }, {
+                                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 [];
+    }];
+};