@ixo/topic-protocol 0.8.0 → 1.0.0-rc.2

package/dist/schemas/payment-terms-v2.schema.json

@@ -0,0 +1,238 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/payment-terms-v2.schema.json",
+    "title": "IXO Claims-native Payment Terms resource v2",
+    "description": "Immutable authoring terms mapped to an IXO Claims Collection. The deployed collection remains authoritative for execution and payment.",
+    "type": "object",
+    "required": [
+        "$schema",
+        "version",
+        "type",
+        "id",
+        "revision",
+        "status",
+        "deedDid",
+        "topicTemplate",
+        "collectionConfiguration",
+        "submitAuthorizationPolicy",
+        "evaluationPolicy",
+        "disputePolicy",
+        "authoredBy",
+        "authoredAt"
+    ],
+    "properties": {
+        "$schema": { "type": "string", "minLength": 1 },
+        "version": { "const": 2 },
+        "type": { "const": "org.ixo.payment-terms" },
+        "id": { "type": "string", "pattern": "^urn:ixo:payment-terms:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" },
+        "revision": { "type": "string", "minLength": 1, "maxLength": 128 },
+        "status": { "enum": ["draft", "accepted", "superseded"] },
+        "deedDid": { "$ref": "#/$defs/did" },
+        "topicTemplate": { "$ref": "#/$defs/templateRef" },
+        "collectionConfiguration": { "$ref": "#/$defs/collectionConfiguration" },
+        "collectionBinding": { "$ref": "#/$defs/collectionBinding" },
+        "submitAuthorizationPolicy": { "$ref": "#/$defs/submitAuthorizationPolicy" },
+        "evaluationPolicy": { "$ref": "#/$defs/evaluationPolicy" },
+        "disputePolicy": { "$ref": "#/$defs/disputePolicy" },
+        "authoredBy": { "$ref": "#/$defs/did" },
+        "authoredAt": { "type": "string", "format": "date-time" },
+        "extensions": { "type": "object" }
+    },
+    "additionalProperties": false,
+    "allOf": [
+        {
+            "if": { "type": "object", "properties": { "status": { "const": "accepted" } }, "required": ["status"] },
+            "then": {
+                "type": "object",
+                "properties": { "collectionBinding": { "$ref": "#/$defs/collectionBinding" } },
+                "required": ["collectionBinding"]
+            }
+        },
+        {
+            "if": {
+                "type": "object",
+                "properties": {
+                    "collectionConfiguration": {
+                        "type": "object",
+                        "properties": { "intentPolicy": { "const": "REQUIRED" } },
+                        "required": ["intentPolicy"]
+                    }
+                },
+                "required": ["collectionConfiguration"]
+            },
+            "then": {
+                "type": "object",
+                "properties": {
+                    "submitAuthorizationPolicy": {
+                        "type": "object",
+                        "properties": { "intentDurationNs": { "not": { "const": "0" } } },
+                        "required": ["intentDurationNs"]
+                    }
+                }
+            }
+        }
+    ],
+    "$defs": {
+        "did": { "type": "string", "pattern": "^did:[a-z0-9]+:.+" },
+        "address": { "type": "string", "minLength": 1, "maxLength": 256 },
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" },
+        "uint": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$" },
+        "positiveUint": { "type": "string", "pattern": "^[1-9][0-9]*$" },
+        "nativeAmount": {
+            "type": "object",
+            "required": ["denom", "amount"],
+            "properties": {
+                "denom": { "type": "string", "minLength": 1, "maxLength": 128 },
+                "amount": { "$ref": "#/$defs/positiveUint" }
+            },
+            "additionalProperties": false
+        },
+        "templateRef": {
+            "type": "object",
+            "required": ["id", "version", "ref", "digest"],
+            "properties": {
+                "id": { "const": "urn:ixo:decision-to-pay:template:verified-work-payment" },
+                "version": { "const": "0.2.0" },
+                "ref": { "type": "string", "format": "uri-reference" },
+                "digest": { "$ref": "#/$defs/digest" }
+            },
+            "additionalProperties": false
+        },
+        "paymentSlot": {
+            "type": "object",
+            "required": ["account", "native", "timeoutNs"],
+            "properties": {
+                "account": { "$ref": "#/$defs/address" },
+                "native": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/$defs/nativeAmount" } },
+                "timeoutNs": { "$ref": "#/$defs/uint" },
+                "isOraclePayment": { "type": "boolean" }
+            },
+            "additionalProperties": false
+        },
+        "payments": {
+            "type": "object",
+            "required": ["approval"],
+            "properties": {
+                "submission": { "$ref": "#/$defs/paymentSlot" },
+                "evaluation": { "$ref": "#/$defs/paymentSlot" },
+                "approval": { "$ref": "#/$defs/paymentSlot" },
+                "rejection": { "$ref": "#/$defs/paymentSlot" }
+            },
+            "additionalProperties": false
+        },
+        "depositRequirement": {
+            "type": "object",
+            "required": ["amount"],
+            "properties": {
+                "amount": { "$ref": "#/$defs/nativeAmount" }
+            },
+            "additionalProperties": false
+        },
+        "collectionConfiguration": {
+            "type": "object",
+            "required": [
+                "authority",
+                "entityDid",
+                "protocolDid",
+                "startsAt",
+                "endsAt",
+                "quota",
+                "state",
+                "intentPolicy",
+                "payments",
+                "serviceAgentDeposit",
+                "evaluationAgentDeposit",
+                "disputeDeposit",
+                "minDepositPeriodNs",
+                "adjudicatorDids"
+            ],
+            "properties": {
+                "authority": { "const": "ixo.claims.v1beta1.Collection" },
+                "entityDid": { "$ref": "#/$defs/did" },
+                "protocolDid": { "$ref": "#/$defs/did" },
+                "startsAt": { "type": "string", "format": "date-time" },
+                "endsAt": { "type": "string", "format": "date-time" },
+                "quota": { "$ref": "#/$defs/positiveUint" },
+                "state": { "const": "OPEN" },
+                "intentPolicy": { "enum": ["ALLOW", "DENY", "REQUIRED"] },
+                "payments": { "$ref": "#/$defs/payments" },
+                "serviceAgentDeposit": { "$ref": "#/$defs/depositRequirement" },
+                "evaluationAgentDeposit": { "$ref": "#/$defs/depositRequirement" },
+                "disputeDeposit": { "$ref": "#/$defs/nativeAmount" },
+                "minDepositPeriodNs": { "$ref": "#/$defs/uint" },
+                "adjudicatorDids": {
+                    "type": "array",
+                    "minItems": 1,
+                    "uniqueItems": true,
+                    "items": { "$ref": "#/$defs/did" }
+                }
+            },
+            "additionalProperties": false
+        },
+        "chainRef": {
+            "type": "object",
+            "required": ["txHash", "height"],
+            "properties": {
+                "txHash": { "type": "string", "pattern": "^[0-9A-Fa-f]{64}$" },
+                "height": { "$ref": "#/$defs/positiveUint" }
+            },
+            "additionalProperties": false
+        },
+        "collectionBinding": {
+            "type": "object",
+            "required": ["collectionId", "configurationDigest", "created"],
+            "properties": {
+                "collectionId": { "$ref": "#/$defs/positiveUint" },
+                "configurationDigest": { "$ref": "#/$defs/digest" },
+                "created": { "$ref": "#/$defs/chainRef" }
+            },
+            "additionalProperties": false
+        },
+        "submitAuthorizationPolicy": {
+            "type": "object",
+            "required": ["typeUrl", "agentQuota", "maxNativeAmount", "intentDurationNs", "expiresAt", "deriveGranteeFromAcceptedBid"],
+            "properties": {
+                "typeUrl": { "const": "/ixo.claims.v1beta1.SubmitClaimAuthorization" },
+                "agentQuota": { "$ref": "#/$defs/positiveUint" },
+                "maxNativeAmount": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/$defs/nativeAmount" } },
+                "intentDurationNs": { "$ref": "#/$defs/uint" },
+                "memberAddress": { "$ref": "#/$defs/address" },
+                "expiresAt": { "type": "string", "format": "date-time" },
+                "deriveGranteeFromAcceptedBid": { "const": true }
+            },
+            "additionalProperties": false
+        },
+        "evaluationPolicy": {
+            "type": "object",
+            "required": ["mode", "engineDid", "evaluatorDids", "allowedStatuses", "grantExpiresAt", "maxCustomNativeAmount", "humanOverrideRequiresNewReceipt"],
+            "properties": {
+                "mode": { "enum": ["HUMAN_SIGNED", "CAPPED_AUTOMATIC"] },
+                "engineDid": { "$ref": "#/$defs/did" },
+                "evaluatorDids": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/$defs/did" } },
+                "allowedStatuses": {
+                    "type": "array",
+                    "minItems": 4,
+                    "uniqueItems": true,
+                    "items": { "enum": ["APPROVED", "REJECTED", "FLAGGED", "INVALIDATED"] }
+                },
+                "grantExpiresAt": { "type": "string", "format": "date-time" },
+                "maxCustomNativeAmount": { "type": "array", "items": { "$ref": "#/$defs/nativeAmount" } },
+                "humanOverrideRequiresNewReceipt": { "const": true }
+            },
+            "additionalProperties": false
+        },
+        "disputePolicy": {
+            "type": "object",
+            "required": ["messageType", "targetRoles", "requiresRegisteredIid", "requiresDeposit", "adjudicationMessageType", "recourse"],
+            "properties": {
+                "messageType": { "const": "/ixo.claims.v1beta1.MsgDisputeClaim" },
+                "targetRoles": { "type": "array", "minItems": 2, "uniqueItems": true, "items": { "enum": ["SUBMITTER", "EVALUATOR"] } },
+                "requiresRegisteredIid": { "const": true },
+                "requiresDeposit": { "const": true },
+                "adjudicationMessageType": { "const": "/ixo.claims.v1beta1.MsgAdjudicateDispute" },
+                "recourse": { "const": "deposit_slashing_and_adjudication_not_payment_reversal" }
+            },
+            "additionalProperties": false
+        }
+    }
+}

package/dist/schemas/topic-contract-body.schema.json

@@ -0,0 +1,57 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/topic-contract-body.schema.json",
+    "title": "Topic contract body v4",
+    "type": "object",
+    "required": ["version", "revision", "kindRef", "authoredBy", "authoredAt", "workingMode", "baseRecipe", "shapeSources", "shapeDigest"],
+    "properties": {
+        "version": { "const": 4 },
+        "revision": { "type": "string", "minLength": 1 },
+        "kindRef": { "type": "object" },
+        "kindProfile": { "type": "object" },
+        "kindResource": { "type": "object" },
+        "authoredBy": { "type": "string", "minLength": 1 },
+        "authoredAt": { "type": "string", "format": "date-time" },
+        "workingMode": { "enum": ["solo", "team", "client"] },
+        "baseRecipe": { "enum": ["project", "flow", "proposal", "evaluation", "claims", "research", "discussion", "incident"] },
+        "topicRecipeRef": { "$ref": "#/$defs/digestRef" },
+        "shapeSources": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/shapeSource" } },
+        "shapeDigest": { "$ref": "#/$defs/digest" },
+        "claimBinding": { "type": "object", "required": ["entityDid", "collectionId"], "properties": { "entityDid": { "type": "string", "pattern": "^did:ixo:" }, "collectionId": { "type": "string", "minLength": 1 } }, "additionalProperties": false },
+        "activationPolicy": { "$ref": "#/$defs/activationPolicy" },
+        "assentPolicy": { "$ref": "#/$defs/assentPolicy" },
+        "locale": { "type": "string" },
+        "timezone": { "type": "string" },
+        "temporalMode": { "enum": ["finite", "ongoing"] },
+        "tags": { "type": "array", "items": { "type": "string" } },
+        "appearance": { "type": "object" },
+        "intent": { "type": "object" },
+        "outcome": { "type": "object" },
+        "completion": { "type": "object" },
+        "ownerId": { "type": "string" },
+        "scope": { "type": "object" },
+        "constraints": { "type": "array", "items": { "type": "object" } },
+        "assumptions": { "type": "array", "items": { "type": "object" } },
+        "questions": { "type": "array", "items": { "type": "object" } },
+        "risks": { "type": "array", "items": { "$ref": "#/$defs/risk" } },
+        "participants": { "type": "array", "items": { "type": "object" } },
+        "roles": { "type": "array", "items": { "type": "object" } },
+        "decision": { "type": "object" },
+        "plan": { "type": "object" },
+        "attachments": { "type": "array", "items": { "type": "object" } },
+        "fieldProvenance": { "type": "object", "propertyNames": { "pattern": "^/" }, "additionalProperties": { "$ref": "#/$defs/fieldProvenance" } }
+    },
+    "additionalProperties": false,
+    "$defs": {
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" },
+        "digestRef": { "type": "object", "required": ["id", "version", "digest"], "properties": { "id": { "type": "string", "format": "uri" }, "version": { "type": "string", "minLength": 1 }, "digest": { "$ref": "#/$defs/digest" } }, "additionalProperties": false },
+        "shapeSource": { "type": "object", "required": ["kind", "id", "version", "digest"], "properties": { "kind": { "enum": ["base-recipe", "topic-recipe", "kind", "topic"] }, "id": { "type": "string", "format": "uri" }, "version": { "type": "string", "minLength": 1 }, "digest": { "$ref": "#/$defs/digest" } }, "additionalProperties": false },
+        "subject": { "type": "object", "required": ["kind", "id"], "properties": { "kind": { "enum": ["actor", "role"] }, "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false },
+        "confirmationRule": { "type": "object", "required": ["mode", "subjects"], "properties": { "mode": { "enum": ["any", "all", "threshold"] }, "subjects": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/subject" } }, "threshold": { "type": "integer", "minimum": 1 } }, "additionalProperties": false },
+        "assentPolicy": { "type": "object", "required": ["mode", "signatories"], "properties": { "mode": { "enum": ["any", "all", "threshold"] }, "signatories": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/subject" } }, "threshold": { "type": "integer", "minimum": 1 } }, "additionalProperties": false },
+        "disputePolicy": { "type": "object", "properties": { "resolvers": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/subject" } }, "process": { "type": "object", "required": ["kind", "id"], "properties": { "kind": { "enum": ["flow", "resource"] }, "id": { "type": "string", "minLength": 1 }, "label": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false },
+        "activationPolicy": { "type": "object", "properties": { "editors": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/subject" } }, "confirmation": { "$ref": "#/$defs/confirmationRule" }, "lifecycle": { "type": "object", "required": ["onExpiry"], "properties": { "effectiveAt": { "type": "string", "format": "date-time" }, "reviewAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "onExpiry": { "const": "pause-consequential" } }, "additionalProperties": false }, "dispute": { "$ref": "#/$defs/disputePolicy" } }, "additionalProperties": false },
+        "risk": { "type": "object", "required": ["id", "description", "status"], "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "impact": { "enum": ["low", "medium", "high", "critical"] }, "status": { "enum": ["open", "mitigated", "accepted", "closed"] }, "owner": { "type": "string" }, "mitigation": { "type": "string" } }, "additionalProperties": false },
+        "fieldProvenance": { "type": "object", "required": ["basis", "acceptance", "sourceEventIds"], "properties": { "basis": { "enum": ["explicit", "contextual", "inferred", "suggested", "retrieved"] }, "acceptance": { "enum": ["proposed", "accepted", "rejected", "superseded"] }, "sourceEventIds": { "type": "array", "items": { "type": "string" } }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }
+    }
+}