@ottochain/sdk 2.2.4 → 2.3.0

package/dist/cjs/apps/contracts/state-machines/contract-agreement.js

@@ -87,12 +87,60 @@ exports.contractAgreementDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        PROPOSED: { id: "PROPOSED", isFinal: false, metadata: null },
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        COMPLETED: { id: "COMPLETED", isFinal: true, metadata: null },
-        DISPUTED: { id: "DISPUTED", isFinal: false, metadata: null },
-        REJECTED: { id: "REJECTED", isFinal: true, metadata: null },
-        CANCELLED: { id: "CANCELLED", isFinal: true, metadata: null },
+        PROPOSED: {
+            id: "PROPOSED",
+            isFinal: false,
+            metadata: {
+                label: "Proposed",
+                description: "Agreement proposed; awaiting the counterparty",
+                category: "initial",
+            },
+        },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Agreement accepted and in effect",
+                category: "active",
+            },
+        },
+        COMPLETED: {
+            id: "COMPLETED",
+            isFinal: true,
+            metadata: {
+                label: "Completed",
+                description: "Agreement completed and attested (terminal)",
+                category: "terminal",
+            },
+        },
+        DISPUTED: {
+            id: "DISPUTED",
+            isFinal: false,
+            metadata: {
+                label: "Disputed",
+                description: "A party has raised a dispute; awaiting resolution",
+                category: "pending",
+            },
+        },
+        REJECTED: {
+            id: "REJECTED",
+            isFinal: true,
+            metadata: {
+                label: "Rejected",
+                description: "Proposal rejected by the counterparty (terminal)",
+                category: "terminal",
+            },
+        },
+        CANCELLED: {
+            id: "CANCELLED",
+            isFinal: true,
+            metadata: {
+                label: "Cancelled",
+                description: "Agreement cancelled before completion (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "PROPOSED",
     transitions: [

package/dist/cjs/apps/contracts/state-machines/contract-escrow.js

@@ -124,14 +124,78 @@ exports.contractEscrowDef = (0, fiber_app_js_1.defineFiberApp)({
         cancel: {},
     },
     states: {
-        CREATED: { id: "CREATED", isFinal: false, metadata: null },
-        FUNDED: { id: "FUNDED", isFinal: false, metadata: null },
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        RELEASING: { id: "RELEASING", isFinal: false, metadata: null },
-        DISPUTED: { id: "DISPUTED", isFinal: false, metadata: null },
-        RELEASED: { id: "RELEASED", isFinal: true, metadata: null },
-        REFUNDED: { id: "REFUNDED", isFinal: true, metadata: null },
-        SPLIT: { id: "SPLIT", isFinal: true, metadata: null },
+        CREATED: {
+            id: "CREATED",
+            isFinal: false,
+            metadata: {
+                label: "Created",
+                description: "Escrow created; awaiting funding",
+                category: "initial",
+            },
+        },
+        FUNDED: {
+            id: "FUNDED",
+            isFinal: false,
+            metadata: {
+                label: "Funded",
+                description: "Funds deposited into escrow",
+                category: "active",
+            },
+        },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Escrow in effect while work is performed",
+                category: "active",
+            },
+        },
+        RELEASING: {
+            id: "RELEASING",
+            isFinal: false,
+            metadata: {
+                label: "Releasing",
+                description: "Release approved; payout in progress",
+                category: "pending",
+            },
+        },
+        DISPUTED: {
+            id: "DISPUTED",
+            isFinal: false,
+            metadata: {
+                label: "Disputed",
+                description: "A party disputed the escrow; awaiting arbitration",
+                category: "pending",
+            },
+        },
+        RELEASED: {
+            id: "RELEASED",
+            isFinal: true,
+            metadata: {
+                label: "Released",
+                description: "Funds released to the beneficiary (terminal)",
+                category: "terminal",
+            },
+        },
+        REFUNDED: {
+            id: "REFUNDED",
+            isFinal: true,
+            metadata: {
+                label: "Refunded",
+                description: "Funds refunded to the depositor (terminal)",
+                category: "terminal",
+            },
+        },
+        SPLIT: {
+            id: "SPLIT",
+            isFinal: true,
+            metadata: {
+                label: "Split",
+                description: "Funds split between parties per arbitration (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "CREATED",
     transitions: [

package/dist/cjs/apps/contracts/state-machines/contract-universal.js

@@ -30,10 +30,42 @@ exports.contractUniversalDef = (0, fiber_app_js_1.defineFiberApp)({
         complete: {},
     },
     states: {
-        PROPOSED: { id: "PROPOSED", isFinal: false, metadata: null },
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        COMPLETED: { id: "COMPLETED", isFinal: true, metadata: null },
-        CANCELLED: { id: "CANCELLED", isFinal: true, metadata: null },
+        PROPOSED: {
+            id: "PROPOSED",
+            isFinal: false,
+            metadata: {
+                label: "Proposed",
+                description: "Contract proposed; awaiting acceptance",
+                category: "initial",
+            },
+        },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Contract accepted and in effect",
+                category: "active",
+            },
+        },
+        COMPLETED: {
+            id: "COMPLETED",
+            isFinal: true,
+            metadata: {
+                label: "Completed",
+                description: "Contract obligations fulfilled (terminal)",
+                category: "terminal",
+            },
+        },
+        CANCELLED: {
+            id: "CANCELLED",
+            isFinal: true,
+            metadata: {
+                label: "Cancelled",
+                description: "Contract cancelled before completion (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "PROPOSED",
     transitions: [

package/dist/cjs/apps/governance/state-machines/dao-multisig.js

@@ -120,9 +120,33 @@ exports.daoMultisigDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        PENDING: { id: "PENDING", isFinal: false, metadata: null },
-        DISSOLVED: { id: "DISSOLVED", isFinal: true, metadata: null },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Multisig is idle and ready to propose an action",
+                category: "initial",
+            },
+        },
+        PENDING: {
+            id: "PENDING",
+            isFinal: false,
+            metadata: {
+                label: "Pending",
+                description: "An action is awaiting the required signature threshold",
+                category: "pending",
+            },
+        },
+        DISSOLVED: {
+            id: "DISSOLVED",
+            isFinal: true,
+            metadata: {
+                label: "Dissolved",
+                description: "Multisig DAO dissolved (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "ACTIVE",
     transitions: [

package/dist/cjs/apps/governance/state-machines/dao-reputation.js

@@ -127,9 +127,33 @@ exports.daoReputationDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        VOTING: { id: "VOTING", isFinal: false, metadata: null },
-        DISSOLVED: { id: "DISSOLVED", isFinal: true, metadata: null },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "DAO is idle and ready to accept a proposal",
+                category: "initial",
+            },
+        },
+        VOTING: {
+            id: "VOTING",
+            isFinal: false,
+            metadata: {
+                label: "Voting",
+                description: "Members vote with reputation-weighted power",
+                category: "pending",
+            },
+        },
+        DISSOLVED: {
+            id: "DISSOLVED",
+            isFinal: true,
+            metadata: {
+                label: "Dissolved",
+                description: "Reputation DAO dissolved (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "ACTIVE",
     transitions: [

package/dist/cjs/apps/governance/state-machines/dao-single.js

@@ -78,9 +78,33 @@ exports.daoSingleDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        TRANSFERRING: { id: "TRANSFERRING", isFinal: false, metadata: null },
-        DISSOLVED: { id: "DISSOLVED", isFinal: true, metadata: null },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Single owner controls the DAO and may act or transfer ownership",
+                category: "initial",
+            },
+        },
+        TRANSFERRING: {
+            id: "TRANSFERRING",
+            isFinal: false,
+            metadata: {
+                label: "Transferring",
+                description: "Ownership transfer proposed; awaiting acceptance",
+                category: "pending",
+            },
+        },
+        DISSOLVED: {
+            id: "DISSOLVED",
+            isFinal: true,
+            metadata: {
+                label: "Dissolved",
+                description: "DAO dissolved by its owner (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "ACTIVE",
     transitions: [

package/dist/cjs/apps/governance/state-machines/dao-token.js

@@ -128,10 +128,42 @@ exports.daoTokenDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        VOTING: { id: "VOTING", isFinal: false, metadata: null },
-        QUEUED: { id: "QUEUED", isFinal: false, metadata: null },
-        DISSOLVED: { id: "DISSOLVED", isFinal: true, metadata: null },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "DAO is idle and ready to accept a proposal",
+                category: "initial",
+            },
+        },
+        VOTING: {
+            id: "VOTING",
+            isFinal: false,
+            metadata: {
+                label: "Voting",
+                description: "Token holders are voting on the active proposal",
+                category: "pending",
+            },
+        },
+        QUEUED: {
+            id: "QUEUED",
+            isFinal: false,
+            metadata: {
+                label: "Queued",
+                description: "Passed proposal queued in timelock before execution",
+                category: "pending",
+            },
+        },
+        DISSOLVED: {
+            id: "DISSOLVED",
+            isFinal: true,
+            metadata: {
+                label: "Dissolved",
+                description: "Token DAO dissolved (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "ACTIVE",
     transitions: [

package/dist/cjs/apps/governance/state-machines/governance-simple.js

@@ -133,10 +133,42 @@ exports.govSimpleDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        VOTING: { id: "VOTING", isFinal: false, metadata: null },
-        DISPUTE: { id: "DISPUTE", isFinal: false, metadata: null },
-        DISSOLVED: { id: "DISSOLVED", isFinal: true, metadata: null },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Governance is idle and ready to accept a proposal",
+                category: "initial",
+            },
+        },
+        VOTING: {
+            id: "VOTING",
+            isFinal: false,
+            metadata: {
+                label: "Voting",
+                description: "A proposal is open for voting",
+                category: "pending",
+            },
+        },
+        DISPUTE: {
+            id: "DISPUTE",
+            isFinal: false,
+            metadata: {
+                label: "Dispute",
+                description: "A proposal outcome is being disputed",
+                category: "pending",
+            },
+        },
+        DISSOLVED: {
+            id: "DISSOLVED",
+            isFinal: true,
+            metadata: {
+                label: "Dissolved",
+                description: "Governance entity dissolved (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "ACTIVE",
     transitions: [

package/dist/cjs/apps/governance/state-machines/governance-universal.js

@@ -52,9 +52,33 @@ exports.govUniversalDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        ACTIVE: { id: "ACTIVE", isFinal: false, metadata: null },
-        VOTING: { id: "VOTING", isFinal: false, metadata: null },
-        DISSOLVED: { id: "DISSOLVED", isFinal: true, metadata: null },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Governance is idle and ready to accept a proposal",
+                category: "initial",
+            },
+        },
+        VOTING: {
+            id: "VOTING",
+            isFinal: false,
+            metadata: {
+                label: "Voting",
+                description: "A proposal is open for voting",
+                category: "pending",
+            },
+        },
+        DISSOLVED: {
+            id: "DISSOLVED",
+            isFinal: true,
+            metadata: {
+                label: "Dissolved",
+                description: "Governance entity dissolved (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "ACTIVE",
     transitions: [

package/dist/cjs/apps/identity/state-machines/identity-agent.js

@@ -132,12 +132,60 @@ exports.identityAgentDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        REGISTERED: { id: "REGISTERED", isFinal: false },
-        ACTIVE: { id: "ACTIVE", isFinal: false },
-        CHALLENGED: { id: "CHALLENGED", isFinal: false },
-        SUSPENDED: { id: "SUSPENDED", isFinal: false },
-        PROBATION: { id: "PROBATION", isFinal: false },
-        WITHDRAWN: { id: "WITHDRAWN", isFinal: true },
+        REGISTERED: {
+            id: "REGISTERED",
+            isFinal: false,
+            metadata: {
+                label: "Registered",
+                description: "Agent registered but not yet activated",
+                category: "initial",
+            },
+        },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Agent is active and accruing reputation",
+                category: "active",
+            },
+        },
+        CHALLENGED: {
+            id: "CHALLENGED",
+            isFinal: false,
+            metadata: {
+                label: "Challenged",
+                description: "A challenge has been raised; awaiting resolution",
+                category: "pending",
+            },
+        },
+        SUSPENDED: {
+            id: "SUSPENDED",
+            isFinal: false,
+            metadata: {
+                label: "Suspended",
+                description: "Agent suspended after an upheld challenge",
+                category: "pending",
+            },
+        },
+        PROBATION: {
+            id: "PROBATION",
+            isFinal: false,
+            metadata: {
+                label: "Probation",
+                description: "Conditional reinstatement under monitoring",
+                category: "active",
+            },
+        },
+        WITHDRAWN: {
+            id: "WITHDRAWN",
+            isFinal: true,
+            metadata: {
+                label: "Withdrawn",
+                description: "Agent withdrawn from the registry (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "REGISTERED",
     transitions: [

package/dist/cjs/apps/identity/state-machines/identity-oracle.js

@@ -132,11 +132,51 @@ exports.identityOracleDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        UNREGISTERED: { id: "UNREGISTERED", isFinal: false },
-        REGISTERED: { id: "REGISTERED", isFinal: false },
-        ACTIVE: { id: "ACTIVE", isFinal: false },
-        SLASHED: { id: "SLASHED", isFinal: false },
-        WITHDRAWN: { id: "WITHDRAWN", isFinal: true },
+        UNREGISTERED: {
+            id: "UNREGISTERED",
+            isFinal: false,
+            metadata: {
+                label: "Unregistered",
+                description: "Oracle not yet registered; awaiting stake",
+                category: "initial",
+            },
+        },
+        REGISTERED: {
+            id: "REGISTERED",
+            isFinal: false,
+            metadata: {
+                label: "Registered",
+                description: "Oracle staked and registered but not yet active",
+                category: "pending",
+            },
+        },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Oracle is active and may submit resolutions",
+                category: "active",
+            },
+        },
+        SLASHED: {
+            id: "SLASHED",
+            isFinal: false,
+            metadata: {
+                label: "Slashed",
+                description: "Oracle penalized for a lost dispute; stake reduced",
+                category: "pending",
+            },
+        },
+        WITHDRAWN: {
+            id: "WITHDRAWN",
+            isFinal: true,
+            metadata: {
+                label: "Withdrawn",
+                description: "Oracle withdrawn and stake reclaimed (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "UNREGISTERED",
     transitions: [

package/dist/cjs/apps/identity/state-machines/identity-universal.js

@@ -57,9 +57,33 @@ exports.identityUniversalDef = (0, fiber_app_js_1.defineFiberApp)({
         },
     },
     states: {
-        CREATED: { id: "CREATED", isFinal: false },
-        ACTIVE: { id: "ACTIVE", isFinal: false },
-        INACTIVE: { id: "INACTIVE", isFinal: true },
+        CREATED: {
+            id: "CREATED",
+            isFinal: false,
+            metadata: {
+                label: "Created",
+                description: "Identity registered but not yet activated",
+                category: "initial",
+            },
+        },
+        ACTIVE: {
+            id: "ACTIVE",
+            isFinal: false,
+            metadata: {
+                label: "Active",
+                description: "Identity is active and can be updated",
+                category: "active",
+            },
+        },
+        INACTIVE: {
+            id: "INACTIVE",
+            isFinal: true,
+            metadata: {
+                label: "Inactive",
+                description: "Identity deactivated by its owner (terminal)",
+                category: "terminal",
+            },
+        },
     },
     initialState: "CREATED",
     transitions: [

package/dist/cjs/apps/markets/state-machines/market-auction.js

@@ -73,32 +73,56 @@ exports.marketAuctionDef = (0, fiber_app_js_1.defineFiberApp)({
         PROPOSED: {
             id: "PROPOSED",
             isFinal: false,
-            metadata: { description: "Auction created but not yet open" },
+            metadata: {
+                label: "Proposed",
+                description: "Auction created but not yet open",
+                category: "initial",
+            },
         },
         OPEN: {
             id: "OPEN",
             isFinal: false,
-            metadata: { description: "Accepting bids" },
+            metadata: {
+                label: "Open",
+                description: "Accepting bids",
+                category: "active",
+            },
         },
         CLOSING: {
             id: "CLOSING",
             isFinal: false,
-            metadata: { description: "Bid period ended, determining winner" },
+            metadata: {
+                label: "Closing",
+                description: "Bid period ended, determining winner",
+                category: "pending",
+            },
         },
         SETTLED: {
             id: "SETTLED",
             isFinal: true,
-            metadata: { description: "Winner determined, transfer complete" },
+            metadata: {
+                label: "Settled",
+                description: "Winner determined, transfer complete",
+                category: "terminal",
+            },
         },
         NO_SALE: {
             id: "NO_SALE",
             isFinal: true,
-            metadata: { description: "Reserve not met or no valid bids" },
+            metadata: {
+                label: "No sale",
+                description: "Reserve not met or no valid bids",
+                category: "terminal",
+            },
         },
         CANCELLED: {
             id: "CANCELLED",
             isFinal: true,
-            metadata: { description: "Auction cancelled by seller" },
+            metadata: {
+                label: "Cancelled",
+                description: "Auction cancelled by seller",
+                category: "terminal",
+            },
         },
     },
     initialState: "PROPOSED",