@openvtc/trust-tasks 0.20.1 → 0.20.3

package/src/vtc/vetting/pcs-challenge/0.1/payload.ts

@@ -0,0 +1,187 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/vetting/pcs-challenge/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * An applicant asks the community for the single-use challenge its hidden-vetting proof must be bound to. The community issues one per applicant and spends it when the proof is counted, so a proof cannot be submitted twice.
+ */
+export interface VTCVettingPCSChallengePayload {
+  /**
+   * OPTIONAL. The `id` of the admission criterion the coming submission answers. A community running one hidden-vetting criterion needs no hint; one running several may use it to refuse early rather than at submit.
+   */
+  criterionId?: string;
+  ext?: Ext;
+}
+/**
+ * The challenge, and when it stops being accepted.
+ */
+export interface VTCVettingPCSChallengeResponsePayload {
+  /**
+   * Lowercase hex, 16 bytes. Compared for equality and never parsed; the applicant binds it into the proof's context.
+   */
+  challenge: string;
+  /**
+   * After this instant the challenge is refused. A submission that misses it asks for another.
+   */
+  expiresAt: 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/pcs-challenge/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCVettingPCSChallengePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/pcs-challenge/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCVettingPCSChallengeResponsePayload;
+
+/**
+ * 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/pcs-challenge/0.1",
+  "title": "VTC — Vetting PCS Challenge — payload",
+  "description": "An applicant asks the community for the single-use challenge its hidden-vetting proof must be bound to. The community issues one per applicant and spends it when the proof is counted, so a proof cannot be submitted twice.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "criterionId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "OPTIONAL. The `id` of the admission criterion the coming submission answers. A community running one hidden-vetting criterion needs no hint; one running several may use it to refuse early rather than at submit."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Vetting PCS Challenge — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "challenge",
+        "expiresAt"
+      ],
+      "description": "The challenge, and when it stops being accepted.",
+      "properties": {
+        "challenge": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{32}$",
+          "description": "Lowercase hex, 16 bytes. Compared for equality and never parsed; the applicant binds it into the proof's context."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "After this instant the challenge is refused. A submission that misses it asks for another."
+        },
+        "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 Challenge — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "challenge",
+        "expiresAt"
+      ],
+      "description": "The challenge, and when it stops being accepted.",
+      "properties": {
+        "challenge": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{32}$",
+          "description": "Lowercase hex, 16 bytes. Compared for equality and never parsed; the applicant binds it into the proof's context."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "After this instant the challenge is refused. A submission that misses it asks for another."
+        },
+        "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;

package/src/vtc/vetting/vetters/event-mode/0.1/payload.ts

@@ -0,0 +1,375 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/vetting/vetters/event-mode/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * A vetter asks to vet at a named event, at one of the rates the community publishes. The community answers where the request stands; it does not answer whether it was granted, because a vetter cannot raise its own cap and the group it would join may not exist yet.
+ */
+export interface VTCVettingEventModePayload {
+  /**
+   * The event, as the community names it. It is the whole anonymity set for anything spent under this event's tokens, so it names a gathering people attend — never one desk, one day or one vetter.
+   */
+  eventId: string;
+  /**
+   * One of the tiers the community publishes. A tier is picked from a menu rather than a number being named, so that no vetter's requested rate is itself a distinguishing detail.
+   */
+  tier: string;
+  window: EventWindow;
+  ext?: Ext;
+}
+/**
+ * The days the event runs. Dates, not timestamps: an hour would say when a vetter expects to be at a desk, and the tokens are day-scale anyway.
+ */
+export interface EventWindow {
+  /**
+   * First day of the event, inclusive.
+   */
+  startDate: string;
+  /**
+   * Last day of the event, inclusive. It is not before `startDate`.
+   */
+  endDate: string;
+}
+/**
+ * Where the request stands. `pending` is the ordinary answer to a first request and is not a refusal — a refusal is a `trust-task-error`.
+ */
+export interface VTCVettingEventModeResponsePayload {
+  /**
+   * The event the request names.
+   */
+  eventId: string;
+  /**
+   * `pending`: recorded, awaiting an approver and the group floor. `approved`: the event's label is live and this vetter may draw under it.
+   */
+  state: "pending" | "approved";
+  /**
+   * The tier recorded for this vetter at this event.
+   */
+  tier: string;
+  window: EventWindow;
+  /**
+   * How many vetters have asked for this event so far, including this one. A count, never a list: who else is at the event is the anonymity set, and naming its members would hand out the very thing the set exists to hide.
+   */
+  groupSize: number;
+  /**
+   * How many vetters this community requires before an event may be approved at all. A one-vetter event is an event key with one holder, which is a name.
+   */
+  groupFloor: number;
+  /**
+   * Present when `state` is `approved`: the token label to draw under, for `vtc/vetting/vetters/pcs-tokens`.
+   */
+  label?: string;
+  /**
+   * Present when `state` is `approved`: how many tokens a tick under this label yields. It is the tier's rate, and it is the community's cap, not the vetter's request.
+   */
+  dripPerTick?: number;
+  /**
+   * Present when `state` is `approved`: the last day this label will be accepted. It is after `window.endDate` by the community's grace period, so an applicant met on the final day still has time to submit.
+   */
+  closesAfter?: 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/event-mode/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCVettingEventModePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/vetters/event-mode/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCVettingEventModeResponsePayload;
+
+/**
+ * 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/event-mode/0.1",
+  "title": "VTC — Vetting Event Mode — payload",
+  "description": "A vetter asks to vet at a named event, at one of the rates the community publishes. The community answers where the request stands; it does not answer whether it was granted, because a vetter cannot raise its own cap and the group it would join may not exist yet.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "eventId",
+    "tier",
+    "window"
+  ],
+  "properties": {
+    "eventId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[a-z0-9]([a-z0-9-]*[a-z0-9])?$",
+      "description": "The event, as the community names it. It is the whole anonymity set for anything spent under this event's tokens, so it names a gathering people attend — never one desk, one day or one vetter."
+    },
+    "tier": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "description": "One of the tiers the community publishes. A tier is picked from a menu rather than a number being named, so that no vetter's requested rate is itself a distinguishing detail."
+    },
+    "window": {
+      "$ref": "#/$defs/Window"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Window": {
+      "title": "Event window",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "startDate",
+        "endDate"
+      ],
+      "description": "The days the event runs. Dates, not timestamps: an hour would say when a vetter expects to be at a desk, and the tokens are day-scale anyway.",
+      "properties": {
+        "startDate": {
+          "type": "string",
+          "format": "date",
+          "description": "First day of the event, inclusive."
+        },
+        "endDate": {
+          "type": "string",
+          "format": "date",
+          "description": "Last day of the event, inclusive. It is not before `startDate`."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Vetting Event Mode — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "eventId",
+        "state",
+        "tier",
+        "window",
+        "groupSize",
+        "groupFloor"
+      ],
+      "description": "Where the request stands. `pending` is the ordinary answer to a first request and is not a refusal — a refusal is a `trust-task-error`.",
+      "properties": {
+        "eventId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The event the request names."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "approved"
+          ],
+          "description": "`pending`: recorded, awaiting an approver and the group floor. `approved`: the event's label is live and this vetter may draw under it."
+        },
+        "tier": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The tier recorded for this vetter at this event."
+        },
+        "window": {
+          "$ref": "#/$defs/Window"
+        },
+        "groupSize": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many vetters have asked for this event so far, including this one. A count, never a list: who else is at the event is the anonymity set, and naming its members would hand out the very thing the set exists to hide."
+        },
+        "groupFloor": {
+          "type": "integer",
+          "minimum": 2,
+          "description": "How many vetters this community requires before an event may be approved at all. A one-vetter event is an event key with one holder, which is a name."
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Present when `state` is `approved`: the token label to draw under, for `vtc/vetting/vetters/pcs-tokens`."
+        },
+        "dripPerTick": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Present when `state` is `approved`: how many tokens a tick under this label yields. It is the tier's rate, and it is the community's cap, not the vetter's request."
+        },
+        "closesAfter": {
+          "type": "string",
+          "format": "date",
+          "description": "Present when `state` is `approved`: the last day this label will be accepted. It is after `window.endDate` by the community's grace period, so an applicant met on the final day still has time to submit."
+        },
+        "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": {
+    "Window": {
+      "title": "Event window",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "startDate",
+        "endDate"
+      ],
+      "description": "The days the event runs. Dates, not timestamps: an hour would say when a vetter expects to be at a desk, and the tokens are day-scale anyway.",
+      "properties": {
+        "startDate": {
+          "type": "string",
+          "format": "date",
+          "description": "First day of the event, inclusive."
+        },
+        "endDate": {
+          "type": "string",
+          "format": "date",
+          "description": "Last day of the event, inclusive. It is not before `startDate`."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Vetting Event Mode — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "eventId",
+        "state",
+        "tier",
+        "window",
+        "groupSize",
+        "groupFloor"
+      ],
+      "description": "Where the request stands. `pending` is the ordinary answer to a first request and is not a refusal — a refusal is a `trust-task-error`.",
+      "properties": {
+        "eventId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The event the request names."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "approved"
+          ],
+          "description": "`pending`: recorded, awaiting an approver and the group floor. `approved`: the event's label is live and this vetter may draw under it."
+        },
+        "tier": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The tier recorded for this vetter at this event."
+        },
+        "window": {
+          "$ref": "#/$defs/Window"
+        },
+        "groupSize": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many vetters have asked for this event so far, including this one. A count, never a list: who else is at the event is the anonymity set, and naming its members would hand out the very thing the set exists to hide."
+        },
+        "groupFloor": {
+          "type": "integer",
+          "minimum": 2,
+          "description": "How many vetters this community requires before an event may be approved at all. A one-vetter event is an event key with one holder, which is a name."
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Present when `state` is `approved`: the token label to draw under, for `vtc/vetting/vetters/pcs-tokens`."
+        },
+        "dripPerTick": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Present when `state` is `approved`: how many tokens a tick under this label yields. It is the tier's rate, and it is the community's cap, not the vetter's request."
+        },
+        "closesAfter": {
+          "type": "string",
+          "format": "date",
+          "description": "Present when `state` is `approved`: the last day this label will be accepted. It is after `window.endDate` by the community's grace period, so an applicant met on the final day still has time to submit."
+        },
+        "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;