@openvtc/trust-tasks 0.25.0 → 0.25.2

package/src/vta/pcs/tokens/abandon/0.1/payload.ts

@@ -0,0 +1,392 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/tokens/abandon/0.1/payload.schema.json
+ */
+
+import type { Ext, Multibase, TokenDraw, VetterSummary } from "../../../../../_shared/components.js";
+
+
+/**
+ * A vetter's client tells its VTA that the community refused a token draw, so the VTA stops holding it in flight.
+ */
+export interface VTAPCSTokensAbandonPayload {
+  /**
+   * The context the engine belongs to. Its key is derived from this context's base.
+   */
+  contextId: string;
+  /**
+   * The community's DID: the helper whose parameters the engine runs under.
+   */
+  community: string;
+  draw: TokenDraw;
+  ext?: Ext;
+}
+export interface VTAPCSTokensAbandonResponsePayload {
+  vetter: VetterSummary;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, Multibase, TokenDraw, VetterSummary };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/tokens/abandon/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAPCSTokensAbandonPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/tokens/abandon/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAPCSTokensAbandonResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/vta/pcs/tokens/abandon/0.1",
+  "title": "VTA PCS — Tokens — Abandon — payload",
+  "description": "A vetter's client tells its VTA that the community refused a token draw, so the VTA stops holding it in flight.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "community",
+    "draw"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The context the engine belongs to. Its key is derived from this context's base."
+    },
+    "community": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The community's DID: the helper whose parameters the engine runs under."
+    },
+    "draw": {
+      "$ref": "#/$defs/TokenDraw"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Tokens — Abandon — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "vetter"
+      ],
+      "properties": {
+        "vetter": {
+          "$ref": "#/$defs/VetterSummary"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "VetterSummary": {
+      "title": "VetterSummary",
+      "description": "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contextId",
+        "community",
+        "memberDid",
+        "suite",
+        "id",
+        "enrolledLabels",
+        "pendingLabels",
+        "tokensFree",
+        "tokensHeld",
+        "drawsInFlight",
+        "attested"
+      ],
+      "properties": {
+        "contextId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "community": {
+          "type": "string",
+          "minLength": 1
+        },
+        "memberDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member DID the engine draws tokens as. Bound into every token request."
+        },
+        "suite": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64
+        },
+        "id": {
+          "$ref": "#/$defs/Multibase",
+          "description": "The vetter's PCS identifier for this community."
+        },
+        "enrolledLabels": {
+          "type": "array",
+          "description": "Class labels this vetter holds a credential under, newest first.",
+          "items": {
+            "type": "string",
+            "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+          }
+        },
+        "pendingLabels": {
+          "type": "array",
+          "description": "Class labels requested and not yet accepted.",
+          "items": {
+            "type": "string",
+            "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+          }
+        },
+        "tokensFree": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Tokens held and not reserved."
+        },
+        "tokensHeld": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Tokens held in all."
+        },
+        "drawsInFlight": {
+          "type": "array",
+          "description": "Draws requested and not yet accepted or abandoned.",
+          "items": {
+            "$ref": "#/$defs/TokenDraw"
+          }
+        },
+        "attested": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Attestations made through this engine."
+        }
+      }
+    },
+    "TokenDraw": {
+      "title": "TokenDraw",
+      "description": "One draw of the token drip: a label and a tick.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "tick"
+      ],
+      "properties": {
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "tick": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "Multibase": {
+      "title": "Multibase",
+      "description": "A binary value, multibase base58btc over the suite's canonical encoding.",
+      "type": "string",
+      "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA PCS — Tokens — Abandon — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "vetter"
+      ],
+      "properties": {
+        "vetter": {
+          "$ref": "#/$defs/VetterSummary"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "VetterSummary": {
+      "title": "VetterSummary",
+      "description": "A vetter engine as the VTA holds it, without its key, its credentials or its tokens.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contextId",
+        "community",
+        "memberDid",
+        "suite",
+        "id",
+        "enrolledLabels",
+        "pendingLabels",
+        "tokensFree",
+        "tokensHeld",
+        "drawsInFlight",
+        "attested"
+      ],
+      "properties": {
+        "contextId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "community": {
+          "type": "string",
+          "minLength": 1
+        },
+        "memberDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member DID the engine draws tokens as. Bound into every token request."
+        },
+        "suite": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64
+        },
+        "id": {
+          "$ref": "#/$defs/Multibase",
+          "description": "The vetter's PCS identifier for this community."
+        },
+        "enrolledLabels": {
+          "type": "array",
+          "description": "Class labels this vetter holds a credential under, newest first.",
+          "items": {
+            "type": "string",
+            "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+          }
+        },
+        "pendingLabels": {
+          "type": "array",
+          "description": "Class labels requested and not yet accepted.",
+          "items": {
+            "type": "string",
+            "pattern": "^vetter/[0-9]{4}-[0-9]{2}$"
+          }
+        },
+        "tokensFree": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Tokens held and not reserved."
+        },
+        "tokensHeld": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Tokens held in all."
+        },
+        "drawsInFlight": {
+          "type": "array",
+          "description": "Draws requested and not yet accepted or abandoned.",
+          "items": {
+            "$ref": "#/$defs/TokenDraw"
+          }
+        },
+        "attested": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Attestations made through this engine."
+        }
+      }
+    },
+    "TokenDraw": {
+      "title": "TokenDraw",
+      "description": "One draw of the token drip: a label and a tick.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "tick"
+      ],
+      "properties": {
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "tick": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "Multibase": {
+      "title": "Multibase",
+      "description": "A binary value, multibase base58btc over the suite's canonical encoding.",
+      "type": "string",
+      "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;