@openvtc/trust-tasks 0.26.20 → 0.26.21

package/dist/vta/pcs/voter/accept/0.1/payload.js

@@ -0,0 +1,247 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/pcs/voter/accept/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/pcs/voter/accept/0.1";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/pcs/voter/accept/0.1#response";
+/**
+ * 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/voter/accept/0.1",
+    "title": "VTA PCS — Voter Accept — payload",
+    "description": "A voter's client hands its VTA the community's answer to a ticket request; the VTA unblinds it into the voter's ticket for the election and keeps it.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "contextId",
+        "community",
+        "electionId",
+        "parameters",
+        "response"
+    ],
+    "properties": {
+        "contextId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "description": "The context the voter belongs to."
+        },
+        "community": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 2048,
+            "description": "The community's DID."
+        },
+        "electionId": {
+            "$ref": "#/$defs/ElectionId"
+        },
+        "parameters": {
+            "$ref": "#/$defs/VotingParameters",
+            "description": "The community's published voting parameters. Its `votingKey` MUST be the one the request was registered under."
+        },
+        "response": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "electionId",
+                "label",
+                "preCredential"
+            ],
+            "description": "The payload of the community's vtc/elections/tickets/issue/0.1 response, without its ext.",
+            "properties": {
+                "electionId": {
+                    "$ref": "#/$defs/ElectionId"
+                },
+                "label": {
+                    "type": "string",
+                    "pattern": "^voter/[A-Za-z0-9._-]{1,128}$",
+                    "description": "The ticket class label signed under, `voter/<electionId>`."
+                },
+                "preCredential": {
+                    "type": "string",
+                    "maxLength": 4096,
+                    "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$",
+                    "description": "The pre-credential, multibase base58btc. Useless to anyone but the holder of the request's blinding state."
+                }
+            }
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA PCS — Voter Accept — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "electionId",
+                "ticketHeld"
+            ],
+            "properties": {
+                "electionId": {
+                    "$ref": "#/$defs/ElectionId"
+                },
+                "ticketHeld": {
+                    "const": true,
+                    "description": "The engine now holds the voter's ticket for the election. The ticket itself is never returned."
+                },
+                "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-]+)+$"
+            }
+        },
+        "ElectionId": {
+            "title": "ElectionId",
+            "description": "An election's identifier, unique within its community. A closed alphabet: it appears in the ticket class label `voter/<electionId>` and is framed into every hash a cast is bound to.",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9._-]{1,128}$"
+        },
+        "VotingParameters": {
+            "title": "VotingParameters",
+            "description": "The community's published voting parameters: the PCS suite and the voting verification key tickets are issued under (VTI-VOT-020). Distinct from its hidden-vetting helper key.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "suite",
+                "votingKey"
+            ],
+            "properties": {
+                "suite": {
+                    "type": "string",
+                    "const": "ps-ddh-bls12381"
+                },
+                "votingKey": {
+                    "$ref": "#/$defs/Multibase"
+                }
+            }
+        },
+        "Multibase": {
+            "title": "Multibase",
+            "description": "A binary value, multibase base58btc over the suite's canonical (compressed) encoding.",
+            "type": "string",
+            "maxLength": 16384,
+            "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+        }
+    }
+};
+/** 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 — Voter Accept — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "electionId",
+                "ticketHeld"
+            ],
+            "properties": {
+                "electionId": {
+                    "$ref": "#/$defs/ElectionId"
+                },
+                "ticketHeld": {
+                    "const": true,
+                    "description": "The engine now holds the voter's ticket for the election. The ticket itself is never returned."
+                },
+                "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-]+)+$"
+            }
+        },
+        "ElectionId": {
+            "title": "ElectionId",
+            "description": "An election's identifier, unique within its community. A closed alphabet: it appears in the ticket class label `voter/<electionId>` and is framed into every hash a cast is bound to.",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9._-]{1,128}$"
+        },
+        "VotingParameters": {
+            "title": "VotingParameters",
+            "description": "The community's published voting parameters: the PCS suite and the voting verification key tickets are issued under (VTI-VOT-020). Distinct from its hidden-vetting helper key.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "suite",
+                "votingKey"
+            ],
+            "properties": {
+                "suite": {
+                    "type": "string",
+                    "const": "ps-ddh-bls12381"
+                },
+                "votingKey": {
+                    "$ref": "#/$defs/Multibase"
+                }
+            }
+        },
+        "Multibase": {
+            "title": "Multibase",
+            "description": "A binary value, multibase base58btc over the suite's canonical (compressed) encoding.",
+            "type": "string",
+            "maxLength": 16384,
+            "pattern": "^z[1-9A-HJ-NP-Za-km-z]+$"
+        }
+    }
+};
+/**
+ * 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,
+};
+/**
+ * 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,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vta/pcs/voter/accept/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vta/pcs/voter/accept/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkDH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,sDAA+D,CAAC;AAKxF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,+DAAwE,CAAC;AAK1G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,sDAAsD;IAC7D,OAAO,EAAE,kCAAkC;IAC3C,aAAa,EAAE,uJAAuJ;IACtK,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,WAAW;QACX,WAAW;QACX,YAAY;QACZ,YAAY;QACZ,UAAU;KACX;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,mCAAmC;SACnD;QACD,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,sBAAsB;SACtC;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,oBAAoB;SAC7B;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,0BAA0B;YAClC,aAAa,EAAE,gHAAgH;SAChI;QACD,UAAU,EAAE;YACV,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,OAAO;gBACP,eAAe;aAChB;YACD,aAAa,EAAE,2FAA2F;YAC1G,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,+BAA+B;oBAC1C,aAAa,EAAE,4DAA4D;iBAC5E;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,SAAS,EAAE,0BAA0B;oBACrC,aAAa,EAAE,4GAA4G;iBAC5H;aACF;SACF;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,2CAA2C;YACpD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,YAAY,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,aAAa,EAAE,gGAAgG;iBAChH;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,YAAY;YACrB,aAAa,EAAE,uLAAuL;YACtM,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,yBAAyB;SACrC;QACD,kBAAkB,EAAE;YAClB,OAAO,EAAE,kBAAkB;YAC3B,aAAa,EAAE,iLAAiL;YAChM,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;gBACP,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,OAAO,EAAE,iBAAiB;iBAC3B;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,mBAAmB;iBAC5B;aACF;SACF;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,uFAAuF;YACtG,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,KAAK;YAClB,SAAS,EAAE,0BAA0B;SACtC;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,2CAA2C;YACpD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,YAAY;gBACZ,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,YAAY,EAAE;oBACZ,MAAM,EAAE,oBAAoB;iBAC7B;gBACD,YAAY,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,aAAa,EAAE,gGAAgG;iBAChH;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,YAAY;YACrB,aAAa,EAAE,uLAAuL;YACtM,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,yBAAyB;SACrC;QACD,kBAAkB,EAAE;YAClB,OAAO,EAAE,kBAAkB;YAC3B,aAAa,EAAE,iLAAiL;YAChM,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;gBACP,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,MAAM,EAAE,QAAQ;oBAChB,OAAO,EAAE,iBAAiB;iBAC3B;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,mBAAmB;iBAC5B;aACF;SACF;QACD,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,uFAAuF;YACtG,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,KAAK;YAClB,SAAS,EAAE,0BAA0B;SACtC;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}