@openvtc/trust-tasks 0.20.1 → 0.20.2

package/src/vtc/vetting/vetters/pcs-tokens/0.1/payload.ts

@@ -0,0 +1,286 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/vetting/vetters/pcs-tokens/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * A vetter draws its tick of attestation tokens. The draw is unconditional and on a schedule — a vetter asks whether or not it has vetted anyone — because a fetch that tracked activity would report activity.
+ */
+export interface VTCVettingPCSTokensPayload {
+  /**
+   * The token label to draw under: the community's current monthly label, or an event label it has approved for this vetter.
+   */
+  label: string;
+  /**
+   * The vetter's own schedule counter for this label. It makes `once per tick` a rule the community can enforce without learning whether the vetter has been busy.
+   */
+  tick: number;
+  /**
+   * One blinded serial per token asked for. More than the community's published `dripPerTick` is refused outright — the cap is the community's, not the asker's restraint.
+   *
+   * @minItems 1
+   * @maxItems 64
+   */
+  requests: [
+    {
+      /**
+       * A commitment to a serial only the vetter knows.
+       */
+      commitment: string;
+      /**
+       * Proof that the commitment opens to a serial the vetter holds, bound to this label, member and tick.
+       */
+      openingProof: string;
+    },
+    ...{
+      /**
+       * A commitment to a serial only the vetter knows.
+       */
+      commitment: string;
+      /**
+       * Proof that the commitment opens to a serial the vetter holds, bound to this label, member and tick.
+       */
+      openingProof: string;
+    }[]
+  ];
+  ext?: Ext;
+}
+/**
+ * One blind signature per request, in the order asked.
+ */
+export interface VTCVettingPCSTokensResponsePayload {
+  /**
+   * The label served.
+   */
+  label: string;
+  /**
+   * The tick served.
+   */
+  tick: number;
+  /**
+   * The blind signatures, positionally matching `requests`.
+   *
+   * @minItems 1
+   * @maxItems 64
+   */
+  preCredentials: [string, ...string[]];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/vetters/pcs-tokens/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCVettingPCSTokensPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/vetters/pcs-tokens/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCVettingPCSTokensResponsePayload;
+
+/**
+ * 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/vtc/vetting/vetters/pcs-tokens/0.1",
+  "title": "VTC — Vetting PCS Tokens — payload",
+  "description": "A vetter draws its tick of attestation tokens. The draw is unconditional and on a schedule — a vetter asks whether or not it has vetted anyone — because a fetch that tracked activity would report activity.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "label",
+    "tick",
+    "requests"
+  ],
+  "properties": {
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "The token label to draw under: the community's current monthly label, or an event label it has approved for this vetter."
+    },
+    "tick": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "The vetter's own schedule counter for this label. It makes `once per tick` a rule the community can enforce without learning whether the vetter has been busy."
+    },
+    "requests": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 64,
+      "description": "One blinded serial per token asked for. More than the community's published `dripPerTick` is refused outright — the cap is the community's, not the asker's restraint.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "commitment",
+          "openingProof"
+        ],
+        "properties": {
+          "commitment": {
+            "type": "string",
+            "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+            "description": "A commitment to a serial only the vetter knows."
+          },
+          "openingProof": {
+            "type": "string",
+            "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+            "description": "Proof that the commitment opens to a serial the vetter holds, bound to this label, member and tick."
+          }
+        }
+      }
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Vetting PCS Tokens — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "tick",
+        "preCredentials"
+      ],
+      "description": "One blind signature per request, in the order asked.",
+      "properties": {
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The label served."
+        },
+        "tick": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The tick served."
+        },
+        "preCredentials": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 64,
+          "description": "The blind signatures, positionally matching `requests`.",
+          "items": {
+            "type": "string",
+            "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+          }
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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": "VTC Vetting PCS Tokens — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "tick",
+        "preCredentials"
+      ],
+      "description": "One blind signature per request, in the order asked.",
+      "properties": {
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The label served."
+        },
+        "tick": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The tick served."
+        },
+        "preCredentials": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 64,
+          "description": "The blind signatures, positionally matching `requests`.",
+          "items": {
+            "type": "string",
+            "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+          }
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;