@ottochain/sdk 1.6.0 → 2.0.0

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

@@ -9,22 +9,674 @@
  *   ContractState,
  *   Contract,
  *   getContractDefinition,
- *   getEscrowDefinition
+ *   CONTRACTS_DEFINITIONS
  * } from '@ottochain/sdk/apps/contracts';
  *
- * const contractDef = getContractDefinition();
+ * const agreementDef = getContractDefinition('agreement');
+ * const escrowDef = getContractDefinition('escrow');
  * ```
  *
  * @packageDocumentation
  */
 export { ContractState, Contract, ProposeContractRequest, AcceptContractRequest, CompleteContractRequest, RejectContractRequest, DisputeContractRequest, ContractDefinition, contractStateFromJSON, contractStateToJSON, } from '../../generated/ottochain/apps/contracts/v1/contract.js';
-export type ContractDefinitionType = 'Contract' | 'Escrow';
-export declare const CONTRACT_DEFINITIONS: Record<ContractDefinitionType, unknown>;
+import { contractUniversalDef, contractAgreementDef, contractEscrowDef } from './state-machines/index.js';
+export { contractUniversalDef, contractAgreementDef, contractEscrowDef };
+/** All contract state machine definitions */
+export declare const CONTRACTS_DEFINITIONS: {
+    readonly universal: {
+        readonly metadata: {
+            readonly name: "ContractUniversal";
+            readonly description: "Minimal contract state machine - extend for custom use cases";
+            readonly version: "1.0.0";
+        };
+        readonly states: {
+            readonly PROPOSED: {
+                readonly id: "PROPOSED";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly ACTIVE: {
+                readonly id: "ACTIVE";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly COMPLETED: {
+                readonly id: "COMPLETED";
+                readonly isFinal: true;
+                readonly metadata: null;
+            };
+            readonly CANCELLED: {
+                readonly id: "CANCELLED";
+                readonly isFinal: true;
+                readonly metadata: null;
+            };
+        };
+        readonly initialState: "PROPOSED";
+        readonly transitions: readonly [{
+            readonly from: "PROPOSED";
+            readonly to: "ACTIVE";
+            readonly eventName: "accept";
+            readonly guard: {
+                readonly "==": readonly [1, 1];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "ACTIVE";
+                    readonly acceptedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "PROPOSED";
+            readonly to: "CANCELLED";
+            readonly eventName: "cancel";
+            readonly guard: {
+                readonly "==": readonly [1, 1];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "CANCELLED";
+                    readonly cancelledAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "ACTIVE";
+            readonly to: "COMPLETED";
+            readonly eventName: "complete";
+            readonly guard: {
+                readonly "==": readonly [1, 1];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "COMPLETED";
+                    readonly completedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "ACTIVE";
+            readonly to: "CANCELLED";
+            readonly eventName: "cancel";
+            readonly guard: {
+                readonly "==": readonly [1, 1];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "CANCELLED";
+                    readonly cancelledAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }];
+    };
+    readonly agreement: {
+        readonly metadata: {
+            readonly name: "ContractAgreement";
+            readonly description: "Two-party agreement with mutual completion attestation and dispute resolution";
+            readonly version: "1.0.0";
+            readonly crossReferences: {
+                readonly proposerIdentityId: "Links to proposer's AgentIdentity fiber";
+                readonly counterpartyIdentityId: "Links to counterparty's AgentIdentity fiber";
+                readonly escrowId: "Links to Escrow if payment is escrowed";
+                readonly arbitrationPoolId: "Links to ArbitrationPool for dispute resolution";
+            };
+        };
+        readonly states: {
+            readonly PROPOSED: {
+                readonly id: "PROPOSED";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly ACTIVE: {
+                readonly id: "ACTIVE";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly COMPLETED: {
+                readonly id: "COMPLETED";
+                readonly isFinal: true;
+                readonly metadata: null;
+            };
+            readonly DISPUTED: {
+                readonly id: "DISPUTED";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly REJECTED: {
+                readonly id: "REJECTED";
+                readonly isFinal: true;
+                readonly metadata: null;
+            };
+            readonly CANCELLED: {
+                readonly id: "CANCELLED";
+                readonly isFinal: true;
+                readonly metadata: null;
+            };
+        };
+        readonly initialState: "PROPOSED";
+        readonly transitions: readonly [{
+            readonly from: "PROPOSED";
+            readonly to: "ACTIVE";
+            readonly eventName: "accept";
+            readonly guard: {
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.counterparty";
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "ACTIVE";
+                    readonly acceptedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "PROPOSED";
+            readonly to: "REJECTED";
+            readonly eventName: "reject";
+            readonly guard: {
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.counterparty";
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "REJECTED";
+                    readonly rejectedAt: {
+                        readonly var: "$timestamp";
+                    };
+                    readonly rejectReason: {
+                        readonly var: "event.reason";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "PROPOSED";
+            readonly to: "CANCELLED";
+            readonly eventName: "cancel";
+            readonly guard: {
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.proposer";
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "CANCELLED";
+                    readonly cancelledAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "ACTIVE";
+            readonly to: "ACTIVE";
+            readonly eventName: "submit_completion";
+            readonly guard: {
+                readonly and: readonly [{
+                    readonly or: readonly [{
+                        readonly "===": readonly [{
+                            readonly var: "event.agent";
+                        }, {
+                            readonly var: "state.proposer";
+                        }];
+                    }, {
+                        readonly "===": readonly [{
+                            readonly var: "event.agent";
+                        }, {
+                            readonly var: "state.counterparty";
+                        }];
+                    }];
+                }, {
+                    readonly "!": readonly [{
+                        readonly in: readonly [{
+                            readonly var: "event.agent";
+                        }, {
+                            readonly map: readonly [{
+                                readonly var: "state.completions";
+                            }, {
+                                readonly var: "agent";
+                            }];
+                        }];
+                    }];
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly completions: {
+                        readonly cat: readonly [{
+                            readonly var: "state.completions";
+                        }, readonly [{
+                            readonly agent: {
+                                readonly var: "event.agent";
+                            };
+                            readonly proof: {
+                                readonly var: "event.proof";
+                            };
+                            readonly submittedAt: {
+                                readonly var: "$timestamp";
+                            };
+                        }]];
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "ACTIVE";
+            readonly to: "COMPLETED";
+            readonly eventName: "finalize";
+            readonly guard: {
+                readonly ">=": readonly [{
+                    readonly size: {
+                        readonly var: "state.completions";
+                    };
+                }, 2];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "COMPLETED";
+                    readonly completedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "ACTIVE";
+            readonly to: "DISPUTED";
+            readonly eventName: "dispute";
+            readonly guard: {
+                readonly or: readonly [{
+                    readonly "===": readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly var: "state.proposer";
+                    }];
+                }, {
+                    readonly "===": readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly var: "state.counterparty";
+                    }];
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "DISPUTED";
+                    readonly disputedAt: {
+                        readonly var: "$timestamp";
+                    };
+                    readonly disputeReason: {
+                        readonly var: "event.reason";
+                    };
+                    readonly disputedBy: {
+                        readonly var: "event.agent";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "DISPUTED";
+            readonly to: "COMPLETED";
+            readonly eventName: "resolve";
+            readonly guard: {
+                readonly or: readonly [{
+                    readonly var: "event.judicialRuling";
+                }, {
+                    readonly and: readonly [{
+                        readonly "===": readonly [{
+                            readonly var: "event.proposerApproves";
+                        }, true];
+                    }, {
+                        readonly "===": readonly [{
+                            readonly var: "event.counterpartyApproves";
+                        }, true];
+                    }];
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly status: "COMPLETED";
+                    readonly resolvedAt: {
+                        readonly var: "$timestamp";
+                    };
+                    readonly resolution: {
+                        readonly var: "event.resolution";
+                    };
+                    readonly rulingId: {
+                        readonly var: "event.rulingId";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }];
+    };
+    readonly escrow: {
+        readonly metadata: {
+            readonly name: "ContractEscrow";
+            readonly description: "Asset custody with conditional release, dispute resolution, and split payments";
+            readonly version: "1.0.0";
+            readonly crossReferences: {
+                readonly contractId: "Links to Contract SM that created this escrow";
+                readonly marketId: "Links to Market SM for market-based escrow";
+                readonly insuranceId: "Links to Insurance SM for protected escrow";
+                readonly arbitrationPoolId: "Links to ArbitrationPool for dispute resolution";
+                readonly treasuryId: "Links to Treasury for fee collection";
+            };
+        };
+        readonly states: {
+            readonly CREATED: {
+                readonly id: "CREATED";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly FUNDED: {
+                readonly id: "FUNDED";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly ACTIVE: {
+                readonly id: "ACTIVE";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly RELEASING: {
+                readonly id: "RELEASING";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly DISPUTED: {
+                readonly id: "DISPUTED";
+                readonly isFinal: false;
+                readonly metadata: null;
+            };
+            readonly RELEASED: {
+                readonly id: "RELEASED";
+                readonly isFinal: true;
+                readonly metadata: null;
+            };
+            readonly REFUNDED: {
+                readonly id: "REFUNDED";
+                readonly isFinal: true;
+                readonly metadata: null;
+            };
+            readonly SPLIT: {
+                readonly id: "SPLIT";
+                readonly isFinal: true;
+                readonly metadata: null;
+            };
+        };
+        readonly initialState: "CREATED";
+        readonly transitions: readonly [{
+            readonly from: "CREATED";
+            readonly to: "FUNDED";
+            readonly eventName: "deposit";
+            readonly guard: {
+                readonly and: readonly [{
+                    readonly "===": readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly var: "state.depositor";
+                    }];
+                }, {
+                    readonly ">=": readonly [{
+                        readonly var: "event.amount";
+                    }, {
+                        readonly var: "state.requiredAmount";
+                    }];
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly balance: {
+                        readonly var: "event.amount";
+                    };
+                    readonly fundedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "FUNDED";
+            readonly to: "ACTIVE";
+            readonly eventName: "activate";
+            readonly guard: {
+                readonly or: readonly [{
+                    readonly "===": readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly var: "state.beneficiary";
+                    }];
+                }, {
+                    readonly var: "state.autoActivate";
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly activatedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "ACTIVE";
+            readonly to: "RELEASING";
+            readonly eventName: "request_release";
+            readonly guard: {
+                readonly "===": readonly [{
+                    readonly var: "event.agent";
+                }, {
+                    readonly var: "state.beneficiary";
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly releaseRequest: {
+                        readonly requestedBy: {
+                            readonly var: "event.agent";
+                        };
+                        readonly amount: {
+                            readonly var: "event.amount";
+                        };
+                        readonly reason: {
+                            readonly var: "event.reason";
+                        };
+                        readonly requestedAt: {
+                            readonly var: "$timestamp";
+                        };
+                    };
+                    readonly releaseDeadline: {
+                        readonly "+": readonly [{
+                            readonly var: "$timestamp";
+                        }, {
+                            readonly var: "state.releaseWindowMs";
+                        }];
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "RELEASING";
+            readonly to: "RELEASED";
+            readonly eventName: "approve_release";
+            readonly guard: {
+                readonly or: readonly [{
+                    readonly "===": readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly var: "state.depositor";
+                    }];
+                }, {
+                    readonly ">=": readonly [{
+                        readonly var: "$timestamp";
+                    }, {
+                        readonly var: "state.releaseDeadline";
+                    }];
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly releasedAt: {
+                        readonly var: "$timestamp";
+                    };
+                    readonly releasedTo: {
+                        readonly var: "state.beneficiary";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "RELEASING";
+            readonly to: "DISPUTED";
+            readonly eventName: "dispute";
+            readonly guard: {
+                readonly and: readonly [{
+                    readonly "===": readonly [{
+                        readonly var: "event.agent";
+                    }, {
+                        readonly var: "state.depositor";
+                    }];
+                }, {
+                    readonly "<": readonly [{
+                        readonly var: "$timestamp";
+                    }, {
+                        readonly var: "state.releaseDeadline";
+                    }];
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly disputedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly spawns: {
+                readonly sm: "Judiciary";
+                readonly initialData: {
+                    readonly caseType: "escrow_dispute";
+                    readonly plaintiff: {
+                        readonly var: "state.depositor";
+                    };
+                    readonly defendant: {
+                        readonly var: "state.beneficiary";
+                    };
+                    readonly claim: {
+                        readonly escrowId: {
+                            readonly var: "fiberId";
+                        };
+                        readonly amount: {
+                            readonly var: "state.balance";
+                        };
+                    };
+                };
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "DISPUTED";
+            readonly to: "SPLIT";
+            readonly eventName: "ruling";
+            readonly guard: {
+                readonly var: "event.judicialRuling";
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly splits: {
+                        readonly var: "event.splits";
+                    };
+                    readonly rulingId: {
+                        readonly var: "event.rulingId";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }, {
+            readonly from: "ACTIVE";
+            readonly to: "REFUNDED";
+            readonly eventName: "refund";
+            readonly guard: {
+                readonly or: readonly [{
+                    readonly var: "event.mutualConsent";
+                }, {
+                    readonly ">=": readonly [{
+                        readonly var: "$timestamp";
+                    }, {
+                        readonly var: "state.expiresAt";
+                    }];
+                }];
+            };
+            readonly effect: {
+                readonly merge: readonly [{
+                    readonly var: "state";
+                }, {
+                    readonly refundedAt: {
+                        readonly var: "$timestamp";
+                    };
+                }];
+            };
+            readonly dependencies: readonly [];
+        }];
+    };
+};
+export type ContractType = keyof typeof CONTRACTS_DEFINITIONS;
 /**
- * Get the contract state machine definition.
- */
-export declare function getContractDefinition(): unknown;
-/**
- * Get the escrow state machine definition.
+ * Get a contract state machine definition by type.
+ * @param type - 'universal' | 'agreement' | 'escrow' (default: 'agreement')
  */
+export declare function getContractDefinition(type?: ContractType): unknown;
+/** @deprecated Use getContractDefinition('escrow') */
 export declare function getEscrowDefinition(): unknown;