@ottochain/sdk 2.2.5 → 2.4.0

package/dist/types/apps/contracts/index.d.ts

@@ -6,7 +6,7 @@
  * @example
  * ```typescript
  * import {
- *   ContractState,
+ *   State,
  *   Contract,
  *   getContractDefinition,
  *   CONTRACTS_DEFINITIONS
@@ -18,7 +18,8 @@
  *
  * @packageDocumentation
  */
-export { ContractState, Contract, ProposeContractRequest, AcceptContractRequest, CompleteContractRequest, RejectContractRequest, DisputeContractRequest, ContractDefinition, contractStateFromJSON, contractStateToJSON, } from "../../generated/ottochain/apps/contracts/v1/contract.js";
+export { State, Contract, ProposeContractRequest, AcceptContractRequest, CompleteContractRequest, RejectContractRequest, DisputeContractRequest, ContractDefinition, stateFromJSON, stateToJSON, } from "../../generated/ottochain/apps/contracts/v1/contract.js";
+export { State as ContractState, stateFromJSON as contractStateFromJSON, stateToJSON as contractStateToJSON, } from "../../generated/ottochain/apps/contracts/v1/contract.js";
 import { contractUniversalDef, contractAgreementDef, contractEscrowDef } from "./state-machines/index.js";
 import type { FiberAppDefinition } from "../../schema/fiber-app.js";
 export { contractUniversalDef, contractAgreementDef, contractEscrowDef };
@@ -63,22 +64,38 @@ export declare const CONTRACTS_DEFINITIONS: {
             PROPOSED: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "initial";
+                };
             };
             ACTIVE: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "active";
+                };
             };
             COMPLETED: {
                 id: string;
                 isFinal: true;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "terminal";
+                };
             };
             CANCELLED: {
                 id: string;
                 isFinal: true;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "terminal";
+                };
             };
         };
         initialState: "PROPOSED";
@@ -199,7 +216,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             };
         };
         createSchema: {
-            required: readonly ["proposer", "counterparty"];
+            required: readonly ["proposer", "counterparty", "arbitrator"];
             properties: {
                 proposer: {
                     type: "address";
@@ -211,6 +228,11 @@ export declare const CONTRACTS_DEFINITIONS: {
                     description: string;
                     immutable: true;
                 };
+                arbitrator: {
+                    type: "address";
+                    description: string;
+                    immutable: true;
+                };
             };
         };
         stateSchema: {
@@ -224,6 +246,10 @@ export declare const CONTRACTS_DEFINITIONS: {
                 counterparty: {
                     type: "address";
                 };
+                arbitrator: {
+                    type: "address";
+                    immutable: true;
+                };
                 completions: {
                     type: "array";
                 };
@@ -300,18 +326,6 @@ export declare const CONTRACTS_DEFINITIONS: {
             };
             resolve: {
                 properties: {
-                    judicialRuling: {
-                        type: "boolean";
-                        nullable: true;
-                    };
-                    proposerApproves: {
-                        type: "boolean";
-                        nullable: true;
-                    };
-                    counterpartyApproves: {
-                        type: "boolean";
-                        nullable: true;
-                    };
                     resolution: {
                         type: "string";
                     };
@@ -326,32 +340,56 @@ export declare const CONTRACTS_DEFINITIONS: {
             PROPOSED: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "initial";
+                };
             };
             ACTIVE: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "active";
+                };
             };
             COMPLETED: {
                 id: string;
                 isFinal: true;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "terminal";
+                };
             };
             DISPUTED: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "pending";
+                };
             };
             REJECTED: {
                 id: string;
                 isFinal: true;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "terminal";
+                };
             };
             CANCELLED: {
                 id: string;
                 isFinal: true;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "terminal";
+                };
             };
         };
         initialState: "PROPOSED";
@@ -359,14 +397,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             from: "PROPOSED";
             to: "ACTIVE";
             eventName: "accept";
-            guard: {
-                "===": {
-                    var: string;
-                }[];
-                and?: undefined;
-                ">="?: undefined;
-                or?: undefined;
-            };
+            guard: import("../../index.js").GuardRule;
             effect: {
                 merge: ({
                     var: string;
@@ -385,14 +416,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             from: "PROPOSED";
             to: "REJECTED";
             eventName: "reject";
-            guard: {
-                "===": {
-                    var: string;
-                }[];
-                and?: undefined;
-                ">="?: undefined;
-                or?: undefined;
-            };
+            guard: import("../../index.js").GuardRule;
             effect: {
                 merge: ({
                     var: string;
@@ -415,14 +439,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             from: "PROPOSED";
             to: "CANCELLED";
             eventName: "cancel";
-            guard: {
-                "===": {
-                    var: string;
-                }[];
-                and?: undefined;
-                ">="?: undefined;
-                or?: undefined;
-            };
+            guard: import("../../index.js").GuardRule;
             effect: {
                 merge: ({
                     var: string;
@@ -442,28 +459,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             to: "ACTIVE";
             eventName: "submit_completion";
             guard: {
-                and: ({
-                    or: {
-                        "===": {
-                            var: string;
-                        }[];
-                    }[];
-                    "!"?: undefined;
-                } | {
-                    "!": {
-                        in: ({
-                            var: string;
-                            map?: undefined;
-                        } | {
-                            map: {
-                                var: string;
-                            }[];
-                            var?: undefined;
-                        })[];
-                    }[];
-                    or?: undefined;
-                })[];
-                "==="?: undefined;
+                and: import("../../index.js").GuardRule[];
                 ">="?: undefined;
                 or?: undefined;
             };
@@ -497,11 +493,10 @@ export declare const CONTRACTS_DEFINITIONS: {
             eventName: "finalize";
             guard: {
                 ">=": (number | {
-                    size: {
+                    length: {
                         var: string;
-                    };
+                    }[];
                 })[];
-                "==="?: undefined;
                 and?: undefined;
                 or?: undefined;
             };
@@ -523,16 +518,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             from: "ACTIVE";
             to: "DISPUTED";
             eventName: "dispute";
-            guard: {
-                or: {
-                    "===": {
-                        var: string;
-                    }[];
-                }[];
-                "==="?: undefined;
-                and?: undefined;
-                ">="?: undefined;
-            };
+            guard: import("../../index.js").GuardRule;
             effect: {
                 merge: ({
                     var: string;
@@ -560,18 +546,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             to: "COMPLETED";
             eventName: "resolve";
             guard: {
-                or: ({
-                    var: string;
-                    and?: undefined;
-                } | {
-                    and: {
-                        "===": (boolean | {
-                            var: string;
-                        })[];
-                    }[];
-                    var?: undefined;
-                })[];
-                "==="?: undefined;
+                or: import("../../index.js").GuardRule[];
                 and?: undefined;
                 ">="?: undefined;
             };
@@ -591,7 +566,7 @@ export declare const CONTRACTS_DEFINITIONS: {
                         var: string;
                     };
                     rulingId: {
-                        var: string;
+                        if: (import("../../index.js").GuardRule | null)[];
                     };
                     var?: undefined;
                 })[];
@@ -601,16 +576,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             from: "ACTIVE";
             to: "CANCELLED";
             eventName: "cancel";
-            guard: {
-                or: {
-                    "===": {
-                        var: string;
-                    }[];
-                }[];
-                "==="?: undefined;
-                and?: undefined;
-                ">="?: undefined;
-            };
+            guard: import("../../index.js").GuardRule;
             effect: {
                 merge: ({
                     var: string;
@@ -663,7 +629,7 @@ export declare const CONTRACTS_DEFINITIONS: {
             };
         };
         createSchema: {
-            required: readonly ["depositor", "beneficiary", "requiredAmount"];
+            required: readonly ["depositor", "beneficiary", "requiredAmount", "arbiter"];
             properties: {
                 depositor: {
                     type: "address";
@@ -673,6 +639,11 @@ export declare const CONTRACTS_DEFINITIONS: {
                     type: "address";
                     description: string;
                 };
+                arbiter: {
+                    type: "address";
+                    description: string;
+                    immutable: true;
+                };
                 requiredAmount: {
                     type: "number";
                     minimum: number;
@@ -703,6 +674,10 @@ export declare const CONTRACTS_DEFINITIONS: {
                 beneficiary: {
                     type: "address";
                 };
+                arbiter: {
+                    type: "address";
+                    immutable: true;
+                };
                 requiredAmount: {
                     type: "number";
                 };
@@ -787,9 +762,6 @@ export declare const CONTRACTS_DEFINITIONS: {
             dispute: {};
             ruling: {
                 properties: {
-                    judicialRuling: {
-                        type: "boolean";
-                    };
                     splits: {
                         type: "array";
                     };
@@ -798,56 +770,81 @@ export declare const CONTRACTS_DEFINITIONS: {
                     };
                 };
             };
-            refund: {
-                properties: {
-                    mutualConsent: {
-                        type: "boolean";
-                        nullable: true;
-                    };
-                };
-            };
+            refund: {};
             cancel: {};
         };
         states: {
             CREATED: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "initial";
+                };
             };
             FUNDED: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "active";
+                };
             };
             ACTIVE: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "active";
+                };
             };
             RELEASING: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "pending";
+                };
             };
             DISPUTED: {
                 id: string;
                 isFinal: false;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "pending";
+                };
             };
             RELEASED: {
                 id: string;
                 isFinal: true;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "terminal";
+                };
             };
             REFUNDED: {
                 id: string;
                 isFinal: true;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "terminal";
+                };
             };
             SPLIT: {
                 id: string;
                 isFinal: true;
-                metadata: null;
+                metadata: {
+                    label: string;
+                    description: string;
+                    category: "terminal";
+                };
             };
         };
         initialState: "CREATED";
@@ -856,20 +853,8 @@ export declare const CONTRACTS_DEFINITIONS: {
             to: "FUNDED";
             eventName: "deposit";
             guard: {
-                and: ({
-                    "===": {
-                        var: string;
-                    }[];
-                    ">="?: undefined;
-                } | {
-                    ">=": {
-                        var: string;
-                    }[];
-                    "==="?: undefined;
-                })[];
+                and: import("../../index.js").GuardRule[];
                 or?: undefined;
-                "==="?: undefined;
-                var?: undefined;
             };
             effect: {
                 merge: ({
@@ -887,24 +872,13 @@ export declare const CONTRACTS_DEFINITIONS: {
                 })[];
             };
             dependencies: never[];
-            spawns?: undefined;
         } | {
             from: "FUNDED";
             to: "ACTIVE";
             eventName: "activate";
             guard: {
-                or: ({
-                    "===": {
-                        var: string;
-                    }[];
-                    var?: undefined;
-                } | {
-                    var: string;
-                    "==="?: undefined;
-                })[];
+                or: import("../../index.js").GuardRule[];
                 and?: undefined;
-                "==="?: undefined;
-                var?: undefined;
             };
             effect: {
                 merge: ({
@@ -918,19 +892,11 @@ export declare const CONTRACTS_DEFINITIONS: {
                 })[];
             };
             dependencies: never[];
-            spawns?: undefined;
         } | {
             from: "ACTIVE";
             to: "RELEASING";
             eventName: "request_release";
-            guard: {
-                "===": {
-                    var: string;
-                }[];
-                and?: undefined;
-                or?: undefined;
-                var?: undefined;
-            };
+            guard: import("../../index.js").GuardRule;
             effect: {
                 merge: ({
                     var: string;
@@ -960,26 +926,13 @@ export declare const CONTRACTS_DEFINITIONS: {
                 })[];
             };
             dependencies: never[];
-            spawns?: undefined;
         } | {
             from: "RELEASING";
             to: "RELEASED";
             eventName: "approve_release";
             guard: {
-                or: ({
-                    "===": {
-                        var: string;
-                    }[];
-                    ">="?: undefined;
-                } | {
-                    ">=": {
-                        var: string;
-                    }[];
-                    "==="?: undefined;
-                })[];
+                or: import("../../index.js").GuardRule[];
                 and?: undefined;
-                "==="?: undefined;
-                var?: undefined;
             };
             effect: {
                 merge: ({
@@ -997,57 +950,50 @@ export declare const CONTRACTS_DEFINITIONS: {
                 })[];
             };
             dependencies: never[];
-            spawns?: undefined;
         } | {
             from: "RELEASING";
             to: "DISPUTED";
             eventName: "dispute";
             guard: {
-                and: ({
-                    "===": {
-                        var: string;
-                    }[];
-                    "<"?: undefined;
-                } | {
-                    "<": {
-                        var: string;
-                    }[];
-                    "==="?: undefined;
-                })[];
+                and: import("../../index.js").GuardRule[];
                 or?: undefined;
-                "==="?: undefined;
-                var?: undefined;
             };
             effect: {
                 merge: ({
                     var: string;
                     disputedAt?: undefined;
+                    _emit?: undefined;
                 } | {
                     disputedAt: {
                         var: string;
                     };
                     var?: undefined;
-                })[];
-            };
-            spawns: {
-                sm: string;
-                initialData: {
-                    caseType: string;
-                    plaintiff: {
-                        var: string;
-                    };
-                    defendant: {
-                        var: string;
-                    };
-                    claim: {
-                        escrowId: {
-                            var: string;
-                        };
-                        amount: {
-                            var: string;
+                    _emit?: undefined;
+                } | {
+                    _emit: {
+                        name: string;
+                        data: {
+                            caseType: string;
+                            plaintiff: {
+                                var: string;
+                            };
+                            defendant: {
+                                var: string;
+                            };
+                            claim: {
+                                escrowId: {
+                                    var: string;
+                                };
+                                amount: {
+                                    var: string;
+                                };
+                            };
                         };
-                    };
-                };
+                        destination: string;
+                    }[];
+                    var?: undefined;
+                    disputedAt?: undefined;
+                })[];
             };
             dependencies: never[];
         } | {
@@ -1055,10 +1001,8 @@ export declare const CONTRACTS_DEFINITIONS: {
             to: "SPLIT";
             eventName: "ruling";
             guard: {
-                var: string;
-                and?: undefined;
+                and: import("../../index.js").GuardRule[];
                 or?: undefined;
-                "==="?: undefined;
             };
             effect: {
                 merge: ({
@@ -1076,24 +1020,21 @@ export declare const CONTRACTS_DEFINITIONS: {
                 })[];
             };
             dependencies: never[];
-            spawns?: undefined;
         } | {
             from: "ACTIVE";
             to: "REFUNDED";
             eventName: "refund";
             guard: {
                 or: ({
-                    var: string;
+                    and: import("../../index.js").GuardRule[];
                     ">="?: undefined;
                 } | {
                     ">=": {
                         var: string;
                     }[];
-                    var?: undefined;
+                    and?: undefined;
                 })[];
                 and?: undefined;
-                "==="?: undefined;
-                var?: undefined;
             };
             effect: {
                 merge: ({
@@ -1107,19 +1048,11 @@ export declare const CONTRACTS_DEFINITIONS: {
                 })[];
             };
             dependencies: never[];
-            spawns?: undefined;
         } | {
             from: "CREATED";
             to: "REFUNDED";
             eventName: "cancel";
-            guard: {
-                "===": {
-                    var: string;
-                }[];
-                and?: undefined;
-                or?: undefined;
-                var?: undefined;
-            };
+            guard: import("../../index.js").GuardRule;
             effect: {
                 merge: ({
                     var: string;
@@ -1132,7 +1065,6 @@ export declare const CONTRACTS_DEFINITIONS: {
                 })[];
             };
             dependencies: never[];
-            spawns?: undefined;
         })[];
     };
 };