@ottochain/sdk 2.3.0 → 2.5.0

package/dist/esm/apps/markets/state-machines/market-crowdfund.js

@@ -1,139 +1,140 @@
-import { defineFiberApp } from "../../../schema/fiber-app.js";
+import { defineFiberApp } from '../../../schema/fiber-app.js';
+import { signerIsParty, signerIsNotParty } from '../../../schema/guards.js';
 /**
  * All-or-nothing crowdfunding with threshold, deadline, and stretch goals.
  */
 export const marketCrowdfundDef = defineFiberApp({
     metadata: {
-        name: "MarketCrowdfund",
-        app: "markets",
-        type: "crowdfund",
-        version: "1.0.0",
-        description: "All-or-nothing crowdfunding with threshold, deadline, and stretch goals",
+        name: 'MarketCrowdfund',
+        app: 'markets',
+        type: 'crowdfund',
+        version: '1.0.0',
+        description: 'All-or-nothing crowdfunding with threshold, deadline, and stretch goals',
         crossReferences: {
             creatorIdentityId: "Links to creator's IdentityAgent",
-            treasuryId: "Links to Treasury for fund custody",
+            treasuryId: 'Links to Treasury for fund custody',
         },
     },
     createSchema: {
-        required: ["creator", "threshold", "deadline"],
+        required: ['creator', 'threshold', 'deadline'],
         properties: {
             creator: {
-                type: "address",
-                description: "DAG address of campaign creator",
+                type: 'address',
+                description: 'DAG address of campaign creator',
                 immutable: true,
             },
             threshold: {
-                type: "number",
+                type: 'number',
                 minimum: 0,
-                description: "Funding goal amount",
+                description: 'Funding goal amount',
                 immutable: true,
             },
             deadline: {
-                type: "timestamp",
-                description: "Campaign deadline",
+                type: 'timestamp',
+                description: 'Campaign deadline',
                 immutable: true,
             },
             minPledge: {
-                type: "number",
+                type: 'number',
                 minimum: 0,
-                description: "Minimum pledge amount",
+                description: 'Minimum pledge amount',
             },
-            stretchGoals: { type: "array", description: "Stretch goal targets" },
+            stretchGoals: { type: 'array', description: 'Stretch goal targets' },
         },
     },
     stateSchema: {
         properties: {
-            status: { type: "string", computed: true },
-            creator: { type: "address", immutable: true },
-            threshold: { type: "number", immutable: true },
-            deadline: { type: "timestamp", immutable: true },
-            minPledge: { type: "number" },
-            stretchGoals: { type: "array" },
-            pledges: { type: "array", computed: true },
-            totalPledged: { type: "number", computed: true },
-            backerCount: { type: "number", computed: true },
-            refundsClaimed: { type: "array", computed: true },
+            status: { type: 'string', computed: true },
+            creator: { type: 'address', immutable: true },
+            threshold: { type: 'number', immutable: true },
+            deadline: { type: 'timestamp', immutable: true },
+            minPledge: { type: 'number' },
+            stretchGoals: { type: 'array' },
+            pledges: { type: 'array', computed: true },
+            totalPledged: { type: 'number', computed: true },
+            backerCount: { type: 'number', computed: true },
+            refundsClaimed: { type: 'array', computed: true },
         },
     },
     eventSchemas: {
-        launch: { description: "Launch the campaign" },
-        cancel: { description: "Cancel the campaign" },
+        launch: { description: 'Launch the campaign' },
+        cancel: { description: 'Cancel the campaign' },
         pledge: {
-            description: "Make a pledge",
-            required: ["amount"],
+            description: 'Make a pledge',
+            required: ['amount'],
             properties: {
-                amount: { type: "number", minimum: 0 },
-                rewardTier: { type: "string" },
+                amount: { type: 'number', minimum: 0 },
+                rewardTier: { type: 'string' },
             },
         },
         increase_pledge: {
-            description: "Increase an existing pledge",
-            required: ["additionalAmount"],
-            properties: { additionalAmount: { type: "number", minimum: 0 } },
+            description: 'Increase an existing pledge',
+            required: ['additionalAmount'],
+            properties: { additionalAmount: { type: 'number', minimum: 0 } },
         },
-        finalize: { description: "Finalize the campaign after deadline" },
-        claim_refund: { description: "Claim refund in failed campaign" },
+        finalize: { description: 'Finalize the campaign after deadline' },
+        claim_refund: { description: 'Claim refund in failed campaign' },
     },
     states: {
         PROPOSED: {
-            id: "PROPOSED",
+            id: 'PROPOSED',
             isFinal: false,
             metadata: {
-                label: "Proposed",
-                description: "Campaign created but not yet open",
-                category: "initial",
+                label: 'Proposed',
+                description: 'Campaign created but not yet open',
+                category: 'initial',
             },
         },
         OPEN: {
-            id: "OPEN",
+            id: 'OPEN',
             isFinal: false,
             metadata: {
-                label: "Open",
-                description: "Accepting pledges",
-                category: "active",
+                label: 'Open',
+                description: 'Accepting pledges',
+                category: 'active',
             },
         },
         FUNDED: {
-            id: "FUNDED",
+            id: 'FUNDED',
             isFinal: true,
             metadata: {
-                label: "Funded",
-                description: "Threshold met, funds released to creator",
-                category: "terminal",
+                label: 'Funded',
+                description: 'Threshold met, funds released to creator',
+                category: 'terminal',
             },
         },
         REFUNDED: {
-            id: "REFUNDED",
+            id: 'REFUNDED',
             isFinal: true,
             metadata: {
-                label: "Refunded",
-                description: "Threshold not met, all pledges refunded",
-                category: "terminal",
+                label: 'Refunded',
+                description: 'Threshold not met, all pledges refunded',
+                category: 'terminal',
             },
         },
         CANCELLED: {
-            id: "CANCELLED",
+            id: 'CANCELLED',
             isFinal: true,
             metadata: {
-                label: "Cancelled",
-                description: "Campaign cancelled by creator",
-                category: "terminal",
+                label: 'Cancelled',
+                description: 'Campaign cancelled by creator',
+                category: 'terminal',
             },
         },
     },
-    initialState: "PROPOSED",
+    initialState: 'PROPOSED',
     transitions: [
         {
-            from: "PROPOSED",
-            to: "OPEN",
-            eventName: "launch",
-            guard: { "===": [{ var: "event.agent" }, { var: "state.creator" }] },
+            from: 'PROPOSED',
+            to: 'OPEN',
+            eventName: 'launch',
+            guard: signerIsParty('state.creator'),
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "OPEN",
-                        launchedAt: { var: "$timestamp" },
+                        status: 'OPEN',
+                        launchedAt: { var: '$ordinal' },
                         pledges: [],
                         totalPledged: 0,
                         backerCount: 0,
@@ -143,78 +144,74 @@ export const marketCrowdfundDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "PROPOSED",
-            to: "CANCELLED",
-            eventName: "cancel",
-            guard: { "===": [{ var: "event.agent" }, { var: "state.creator" }] },
+            from: 'PROPOSED',
+            to: 'CANCELLED',
+            eventName: 'cancel',
+            guard: signerIsParty('state.creator'),
             effect: {
-                merge: [
-                    { var: "state" },
-                    { status: "CANCELLED", cancelledAt: { var: "$timestamp" } },
-                ],
+                merge: [{ var: 'state' }, { status: 'CANCELLED', cancelledAt: { var: '$ordinal' } }],
             },
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "OPEN",
-            eventName: "pledge",
+            from: 'OPEN',
+            to: 'OPEN',
+            eventName: 'pledge',
             guard: {
                 and: [
-                    { ">": [{ var: "event.amount" }, 0] },
-                    { "!==": [{ var: "event.agent" }, { var: "state.creator" }] },
+                    { '>': [{ var: 'event.amount' }, 0] },
+                    signerIsNotParty('state.creator'),
                     {
                         or: [
-                            { "!": [{ var: "state.minPledge" }] },
-                            { ">=": [{ var: "event.amount" }, { var: "state.minPledge" }] },
+                            { '!': [{ var: 'state.minPledge' }] },
+                            { '>=': [{ var: 'event.amount' }, { var: 'state.minPledge' }] },
                         ],
                     },
-                    { "<=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
+                    { '<=': [{ var: '$ordinal' }, { var: 'state.deadline' }] },
                 ],
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
                         pledges: {
                             cat: [
-                                { var: "state.pledges" },
+                                { var: 'state.pledges' },
                                 [
                                     {
-                                        backer: { var: "event.agent" },
-                                        amount: { var: "event.amount" },
-                                        rewardTier: { var: "event.rewardTier" },
-                                        pledgedAt: { var: "$timestamp" },
+                                        backer: { var: 'event.agent' },
+                                        amount: { var: 'event.amount' },
+                                        rewardTier: { var: 'event.rewardTier' },
+                                        pledgedAt: { var: '$ordinal' },
                                     },
                                 ],
                             ],
                         },
                         totalPledged: {
-                            "+": [{ var: "state.totalPledged" }, { var: "event.amount" }],
+                            '+': [{ var: 'state.totalPledged' }, { var: 'event.amount' }],
                         },
-                        backerCount: { "+": [{ var: "state.backerCount" }, 1] },
+                        backerCount: { '+': [{ var: 'state.backerCount' }, 1] },
                     },
                 ],
             },
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "OPEN",
-            eventName: "increase_pledge",
+            from: 'OPEN',
+            to: 'OPEN',
+            eventName: 'increase_pledge',
             guard: {
                 and: [
-                    { ">": [{ var: "event.additionalAmount" }, 0] },
-                    { "<=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
+                    { '>': [{ var: 'event.additionalAmount' }, 0] },
+                    { '<=': [{ var: '$ordinal' }, { var: 'state.deadline' }] },
                     {
-                        ">": [
+                        '>': [
                             {
-                                size: {
-                                    filter: [
-                                        { var: "state.pledges" },
-                                        { "===": [{ var: "backer" }, { var: "event.agent" }] },
-                                    ],
-                                },
+                                length: [
+                                    {
+                                        filter: [{ var: 'state.pledges' }, { '===': [{ var: 'backer' }, { var: 'event.agent' }] }],
+                                    },
+                                ],
                             },
                             0,
                         ],
@@ -223,13 +220,10 @@ export const marketCrowdfundDef = defineFiberApp({
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
                         totalPledged: {
-                            "+": [
-                                { var: "state.totalPledged" },
-                                { var: "event.additionalAmount" },
-                            ],
+                            '+': [{ var: 'state.totalPledged' }, { var: 'event.additionalAmount' }],
                         },
                     },
                 ],
@@ -237,26 +231,23 @@ export const marketCrowdfundDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "FUNDED",
-            eventName: "finalize",
+            from: 'OPEN',
+            to: 'FUNDED',
+            eventName: 'finalize',
             guard: {
                 and: [
-                    { ">=": [{ var: "state.totalPledged" }, { var: "state.threshold" }] },
-                    { ">=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
+                    { '>=': [{ var: 'state.totalPledged' }, { var: 'state.threshold' }] },
+                    { '>=': [{ var: '$ordinal' }, { var: 'state.deadline' }] },
                 ],
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "FUNDED",
-                        fundedAt: { var: "$timestamp" },
+                        status: 'FUNDED',
+                        fundedAt: { var: '$ordinal' },
                         stretchGoalsReached: {
-                            filter: [
-                                { var: "state.stretchGoals" },
-                                { "<=": [{ var: "target" }, { var: "state.totalPledged" }] },
-                            ],
+                            filter: [{ var: 'state.stretchGoals' }, { '<=': [{ var: 'target' }, { var: 'state.totalPledged' }] }],
                         },
                     },
                 ],
@@ -264,50 +255,49 @@ export const marketCrowdfundDef = defineFiberApp({
             dependencies: [],
         },
         {
-            from: "OPEN",
-            to: "REFUNDED",
-            eventName: "finalize",
+            from: 'OPEN',
+            to: 'REFUNDED',
+            eventName: 'finalize',
             guard: {
                 and: [
-                    { "<": [{ var: "state.totalPledged" }, { var: "state.threshold" }] },
-                    { ">=": [{ var: "$timestamp" }, { var: "state.deadline" }] },
+                    { '<': [{ var: 'state.totalPledged' }, { var: 'state.threshold' }] },
+                    { '>=': [{ var: '$ordinal' }, { var: 'state.deadline' }] },
                 ],
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
-                        status: "REFUNDED",
-                        refundedAt: { var: "$timestamp" },
-                        reason: "threshold_not_met",
+                        status: 'REFUNDED',
+                        refundedAt: { var: '$ordinal' },
+                        reason: 'threshold_not_met',
                     },
                 ],
             },
             dependencies: [],
         },
         {
-            from: "REFUNDED",
-            to: "REFUNDED",
-            eventName: "claim_refund",
+            from: 'REFUNDED',
+            to: 'REFUNDED',
+            eventName: 'claim_refund',
             guard: {
                 and: [
                     {
-                        ">": [
+                        '>': [
                             {
-                                size: {
-                                    filter: [
-                                        { var: "state.pledges" },
-                                        { "===": [{ var: "backer" }, { var: "event.agent" }] },
-                                    ],
-                                },
+                                length: [
+                                    {
+                                        filter: [{ var: 'state.pledges' }, { '===': [{ var: 'backer' }, { var: 'event.agent' }] }],
+                                    },
+                                ],
                             },
                             0,
                         ],
                     },
                     {
-                        "!": [
+                        '!': [
                             {
-                                in: [{ var: "event.agent" }, { var: "state.refundsClaimed" }],
+                                in: [{ var: 'event.agent' }, { var: 'state.refundsClaimed' }],
                             },
                         ],
                     },
@@ -315,10 +305,10 @@ export const marketCrowdfundDef = defineFiberApp({
             },
             effect: {
                 merge: [
-                    { var: "state" },
+                    { var: 'state' },
                     {
                         refundsClaimed: {
-                            cat: [{ var: "state.refundsClaimed" }, [{ var: "event.agent" }]],
+                            cat: [{ var: 'state.refundsClaimed' }, [{ var: 'event.agent' }]],
                         },
                     },
                 ],