macwarden 0.0.0-stage → 1.0.1

package/schemas/output/bake.schema.json

@@ -0,0 +1,338 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/ZilverZtream/macwarden/blob/main/schemas/output/bake.schema.json",
+  "title": "macwarden bake --json output",
+  "description": "Normative source: SPEC.md, Commands > 4. bake. A dry run returns the plan; a bake returns the new registry entry.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "command",
+    "ok",
+    "warnings",
+    "result",
+    "error"
+  ],
+  "properties": {
+    "schema": {
+      "const": 1
+    },
+    "command": {
+      "const": "bake"
+    },
+    "ok": {
+      "type": "boolean"
+    },
+    "warnings": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/warning"
+      }
+    },
+    "result": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "$ref": "#/$defs/result"
+        }
+      ]
+    },
+    "error": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "$ref": "#/$defs/error"
+        }
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "ok": {
+            "const": true
+          }
+        },
+        "required": [
+          "ok"
+        ]
+      },
+      "then": {
+        "properties": {
+          "result": {
+            "$ref": "#/$defs/result"
+          },
+          "error": {
+            "type": "null"
+          }
+        }
+      },
+      "else": {
+        "properties": {
+          "result": {
+            "type": "null"
+          },
+          "error": {
+            "$ref": "#/$defs/error"
+          }
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "error": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "code",
+        "step",
+        "message"
+      ],
+      "properties": {
+        "code": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 8
+        },
+        "step": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "minLength": 1
+        },
+        "message": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "warning": {
+      "oneOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "code",
+            "message"
+          ],
+          "properties": {
+            "code": {
+              "type": "string",
+              "minLength": 1
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      ]
+    },
+    "rootKeyId": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]{0,19})$",
+      "description": "uint64 as a canonical decimal string (range up to 18446744073709551615 is enforced by the decoder)."
+    },
+    "grade": {
+      "enum": [
+        "ADMIN",
+        "SPEND",
+        "OPERATE",
+        "RECEIVE",
+        "READ",
+        "UNASSESSED"
+      ]
+    },
+    "registryEntry": {
+      "type": "object",
+      "required": [
+        "nodePubkey",
+        "label",
+        "rootKeyId",
+        "permissions",
+        "caveats",
+        "grade",
+        "fingerprint",
+        "outPath",
+        "createdAt",
+        "verified",
+        "status",
+        "revokedAt",
+        "revokeEvidence",
+        "replaces",
+        "replacedBy"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "nodePubkey": {
+          "type": "string",
+          "pattern": "^0[23][0-9a-fA-F]{64}$"
+        },
+        "label": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^[A-Za-z][A-Za-z0-9._-]{0,63}$"
+        },
+        "rootKeyId": {
+          "type": "string",
+          "pattern": "^(0|[1-9][0-9]*)$"
+        },
+        "permissions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "caveats": {
+          "type": "array",
+          "items": {
+            "type": "object"
+          }
+        },
+        "grade": {
+          "enum": [
+            "ADMIN",
+            "SPEND",
+            "OPERATE",
+            "RECEIVE",
+            "READ",
+            "UNASSESSED"
+          ]
+        },
+        "fingerprint": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^fp:[0-9a-f]{16}$"
+        },
+        "outPath": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "verified": {
+          "type": "boolean"
+        },
+        "status": {
+          "enum": [
+            "active",
+            "revoked"
+          ]
+        },
+        "revokedAt": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "revokeEvidence": {
+          "enum": [
+            "rejected",
+            "by-id-only",
+            null
+          ]
+        },
+        "replaces": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^(0|[1-9][0-9]*)$"
+        },
+        "replacedBy": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^(0|[1-9][0-9]*)$"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "fingerprint": {
+                "type": "null"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "verified": {
+                "const": false
+              },
+              "outPath": {
+                "type": "null"
+              }
+            }
+          }
+        }
+      ]
+    },
+    "result": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "dryRun",
+            "label",
+            "permissions",
+            "grade",
+            "caveats"
+          ],
+          "properties": {
+            "dryRun": {
+              "const": true
+            },
+            "label": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^[A-Za-z][A-Za-z0-9._-]{0,63}$"
+            },
+            "grade": {
+              "$ref": "#/$defs/grade"
+            },
+            "permissions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "caveats": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": [
+                  "type",
+                  "value"
+                ]
+              }
+            }
+          }
+        },
+        {
+          "$ref": "#/$defs/registryEntry"
+        }
+      ]
+    }
+  }
+}

package/schemas/output/inspect.schema.json

@@ -0,0 +1,172 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "macwarden inspect --json output",
+  "description": "The single JSON document `macwarden inspect --json` prints to stdout. Normative source: SPEC.md, Global conventions > Output and Commands > 1. inspect. A Nostr Wallet Connect (NIP-47) input yields the nwcResult shape; its connection secret never appears.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schema", "command", "ok", "warnings", "result", "error"],
+  "properties": {
+    "schema": { "const": 1 },
+    "command": { "const": "inspect" },
+    "ok": { "type": "boolean" },
+    "warnings": {
+      "type": "array",
+      "items": { "enum": ["unsafe-arg"] },
+      "uniqueItems": true
+    },
+    "result": {
+      "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/result" }, { "$ref": "#/$defs/nwcResult" }]
+    },
+    "error": {
+      "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/error" }]
+    }
+  },
+  "allOf": [
+    {
+      "if": { "properties": { "ok": { "const": true } }, "required": ["ok"] },
+      "then": {
+        "properties": {
+          "result": { "oneOf": [{ "$ref": "#/$defs/result" }, { "$ref": "#/$defs/nwcResult" }] },
+          "error": { "type": "null" }
+        }
+      },
+      "else": {
+        "properties": {
+          "result": { "type": "null" },
+          "error": { "$ref": "#/$defs/error" }
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "error": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["code", "step", "message"],
+      "properties": {
+        "code": { "enum": [2, 3, 8] },
+        "step": {
+          "description": "null for exit 2; the input or decoding stage for exit 3; internal for exit 8.",
+          "oneOf": [
+            { "type": "null" },
+            {
+              "enum": [
+                "input-read",
+                "input-form",
+                "v2-header",
+                "packet",
+                "identifier-version",
+                "identifier-proto",
+                "identifier-limits",
+                "identifier-root-key-id",
+                "nwc-uri",
+                "nwc-wallet-pubkey",
+                "nwc-relay",
+                "nwc-secret",
+                "nwc-lud16",
+                "internal"
+              ]
+            }
+          ]
+        },
+        "message": { "type": "string" }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "code": { "const": 2 } } },
+          "then": { "properties": { "step": { "type": "null" } } }
+        },
+        {
+          "if": { "properties": { "code": { "const": 3 } } },
+          "then": { "properties": { "step": { "type": "string", "not": { "const": "internal" } } } }
+        },
+        {
+          "if": { "properties": { "code": { "const": 8 } } },
+          "then": { "properties": { "step": { "const": "internal" } } }
+        }
+      ]
+    },
+    "rootKeyId": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]{0,19})$",
+      "description": "uint64 as a canonical decimal string (range up to 18446744073709551615 is enforced by the decoder)."
+    },
+    "fingerprint": { "type": "string", "pattern": "^fp:[0-9a-f]{16}$" },
+    "grade": { "enum": ["ADMIN", "SPEND", "OPERATE", "RECEIVE", "READ", "UNASSESSED"] },
+    "macaroonWarning": {
+      "enum": [
+        "root-key-0",
+        "trailing-bytes",
+        "bad-time-before",
+        "unassessed-uri",
+        "unassessed-permission",
+        "no-permissions",
+        "preimage-exposure"
+      ]
+    },
+    "caveat": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "value"],
+      "properties": {
+        "type": { "enum": ["time-before", "ipaddr", "iprange", "lnd-custom", "third-party", "unknown"] },
+        "value": { "type": "string" },
+        "expired": { "type": "boolean" }
+      },
+      "if": { "properties": { "type": { "const": "time-before" } } },
+      "else": { "properties": { "expired": false } }
+    },
+    "result": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "fingerprint",
+        "location",
+        "rootKeyId",
+        "permissions",
+        "caveats",
+        "grade",
+        "reasons",
+        "warnings",
+        "unassessed",
+        "snapshot"
+      ],
+      "properties": {
+        "fingerprint": { "$ref": "#/$defs/fingerprint" },
+        "location": { "type": ["string", "null"] },
+        "rootKeyId": { "$ref": "#/$defs/rootKeyId" },
+        "permissions": { "type": "array", "items": { "type": "string" } },
+        "caveats": { "type": "array", "items": { "$ref": "#/$defs/caveat" } },
+        "grade": { "$ref": "#/$defs/grade" },
+        "reasons": { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
+        "warnings": { "type": "array", "items": { "$ref": "#/$defs/macaroonWarning" }, "uniqueItems": true },
+        "unassessed": { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
+        "snapshot": { "type": "string", "minLength": 1, "description": "LND version the bundled permission snapshot came from, e.g. 0.21.4-beta." }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "grade": { "const": "UNASSESSED" } } },
+          "then": { "properties": { "reasons": { "type": "array", "maxItems": 0 } } }
+        }
+      ]
+    },
+    "pubkey": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
+    "nwcResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "NIP-47 connection facts. The grade is always SPEND: permissions and budget are set by the wallet service and are not visible.",
+      "required": ["kind", "fingerprint", "walletPubkey", "clientPubkey", "relays", "lud16", "grade", "reasons", "warnings"],
+      "properties": {
+        "kind": { "const": "nwc" },
+        "fingerprint": { "$ref": "#/$defs/fingerprint" },
+        "walletPubkey": { "$ref": "#/$defs/pubkey" },
+        "clientPubkey": { "$ref": "#/$defs/pubkey", "description": "x-only secp256k1 public key derived from the connection secret; wallet services list the connection under it." },
+        "relays": { "type": "array", "minItems": 1, "maxItems": 64, "items": { "type": "string", "pattern": "^wss?://" } },
+        "lud16": { "type": ["string", "null"] },
+        "grade": { "const": "SPEND" },
+        "reasons": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "const": "nwc-wallet-side-limits" } },
+        "warnings": { "type": "array", "items": { "enum": ["relay-details-removed"] }, "uniqueItems": true }
+      }
+    }
+  }
+}