@wowok/agent-mcp 2.2.13 → 2.2.14

package/dist/schemas/onchain_operations_guard.schema.json

@@ -0,0 +1,713 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://wowok.net/schemas/onchain_operations_guard.json",
+  "title": "Guard Operation",
+  "description": "On-chain guard operation schema",
+  "type": "object",
+  "properties": {
+    "operation_type": {
+      "const": "guard"
+    },
+    "data": {
+      "type": "object",
+      "description": "On-chain Guard creation. IMPORTANT: All defined data (include all submitted data) must be defined in the 'table' field. USAGE: Set 'namedNew' field with {name, tags?, onChain?} to name the new Guard. The Guard is immutable once created. Define the validation logic in 'root' field. When root.type='file', the file can contain all Guard fields, and any fields defined in the schema will OVERRIDE the file content.",
+      "properties": {
+        "namedNew": {
+          "type": "object",
+          "description": "Name and optional tags for the new Guard object. Set 'onChain: true' to create a public on-chain identity. When using root.type='file', this field OVERRIDES namedNew in the file.",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "The name of the object"
+            },
+            "tags": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "The tags of the object"
+            },
+            "onChain": {
+              "type": "boolean",
+              "description": "CRITICAL: Whether to sync the name to the blockchain. DEFAULT (undefined/false): The name is stored LOCALLY ONLY on your device (PRIVATE). If set to true: The name is published ON-CHAIN and becomes PUBLICLY VISIBLE to everyone."
+            },
+            "replaceExistName": {
+              "type": "boolean",
+              "description": "FORCE CLAIM: Set to true ONLY when the user explicitly expresses a STRONG INTENTION to forcefully take over an existing name."
+            }
+          },
+          "additionalProperties": false
+        },
+        "description": {
+          "type": "string",
+          "description": "Guard description. When using root.type='file', this field OVERRIDES description in the file."
+        },
+        "table": {
+          "type": "array",
+          "description": "Data table of the Guard object. When using root.type='file', this field OVERRIDES table in the file.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "identifier": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 255,
+                "description": "Identifier index (0-255) for referencing this value in Guard nodes"
+              },
+              "bWitness": {
+                "type": "boolean",
+                "description": "Whether this is a witness parameter (provided at runtime)"
+              },
+              "value_type": {
+                "type": "string",
+                "description": "Value type: Bool, Address, String, U8, U16, U32, U64, U128, U256, VecBool, VecAddress, VecString, VecU8, VecU16, VecU32, VecU64, VecU128, VecU256, VecVecU8"
+              },
+              "value": {
+                "description": "The actual value (omit if bWitness is true)"
+              }
+            },
+            "required": [
+              "identifier",
+              "bWitness",
+              "value_type"
+            ]
+          }
+        },
+        "root": {
+          "description": "Root definition: either a direct node tree (type='node') or a file reference (type='file'). When type='file', the file can define all Guard fields (namedNew, description, table, root, rely), and schema fields override file content.",
+          "oneOf": [
+            {
+              "type": "object",
+              "description": "Direct node tree",
+              "properties": {
+                "type": {
+                  "const": "node"
+                },
+                "node": {
+                  "type": "object",
+                  "description": "Guard computational tree root node. MUST return a Bool value (pass/fail). See GuardNode documentation for details.",
+                  "properties": {
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "additionalProperties": true
+                }
+              },
+              "required": [
+                "type",
+                "node"
+              ]
+            },
+            {
+              "type": "object",
+              "description": "File reference",
+              "properties": {
+                "type": {
+                  "const": "file"
+                },
+                "file_path": {
+                  "type": "string",
+                  "description": "Path to JSON or Markdown file containing Guard definition"
+                },
+                "format": {
+                  "type": "string",
+                  "enum": [
+                    "json",
+                    "markdown"
+                  ],
+                  "default": "json",
+                  "description": "File format: 'json' or 'markdown'"
+                }
+              },
+              "required": [
+                "type",
+                "file_path"
+              ]
+            }
+          ]
+        },
+        "rely": {
+          "type": "object",
+          "description": "All Guard objects that the new Guard object depends on.",
+          "properties": {
+            "guards": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "List of dependent Guard object IDs or names."
+            },
+            "logic_or": {
+              "type": "boolean",
+              "description": "Whether to use logical OR operator."
+            }
+          },
+          "required": [
+            "guards"
+          ]
+        }
+      },
+      "required": [
+        "root"
+      ]
+    },
+    "env": {
+      "$ref": "#/definitions/env",
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    },
+    "submission": {
+      "$ref": "#/definitions/submission",
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  "required": [
+    "operation_type",
+    "data"
+  ],
+  "definitions": {
+    "env": {
+      "type": "object",
+      "properties": {
+        "account": {
+          "type": "string",
+          "description": "Account/Object name or ID. If specifying an account, use empty string '' for the default account. If it starts with '0x', it will be treated as an ID. Otherwise, it will be treated as a name (max 64 bcs characters).",
+          "default": ""
+        },
+        "permission_guard": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of permission guard IDs. Used to extend additional operation permissions (requires verification and configuration in the Permission object)."
+        },
+        "no_cache": {
+          "type": "boolean",
+          "description": "Whether to disable caching."
+        },
+        "network": {
+          "type": "string",
+          "enum": [
+            "localnet",
+            "testnet"
+          ],
+          "description": "Network entrypoint: Specifies which network the operation occurs on"
+        },
+        "referrer": {
+          "$ref": "#/definitions/env/properties/account",
+          "description": "Referrer ID. If the user is using the network for the first time, the referrer ID will be recorded."
+        }
+      },
+      "additionalProperties": false,
+      "description": "IMPORTANT: Execution environment includes: account for signing operations, network selection ([object Object]), additional Guard permissions, and more. Used to specify context information during the call. If account is not specified, the default account (\"\") will be used."
+    },
+    "submission": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "submission",
+          "description": "Type of call response: submission"
+        },
+        "guard": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "object": {
+                "type": "string",
+                "description": "Guard object name or ID."
+              },
+              "impack": {
+                "type": "boolean",
+                "description": "Whether the verification result of this Guard participates in the final verification logic. If true, the verification result of this Guard will be included in the final verification result; if false, the verification result of this Guard will not be included."
+              }
+            },
+            "required": [
+              "object",
+              "impack"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "submission": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "guard": {
+                "$ref": "#/definitions/submission/properties/guard/items/properties/object",
+                "description": "Guard object name or ID."
+              },
+              "submission": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "identifier": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "maximum": 255,
+                      "description": "Identifier (0-255) for data lookup in Guard table."
+                    },
+                    "b_submission": {
+                      "type": "boolean",
+                      "description": "Whether user submission is required for this data"
+                    },
+                    "value_type": {
+                      "anyOf": [
+                        {
+                          "type": "number",
+                          "const": 0,
+                          "description": "Bool (0)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 1,
+                          "description": "Address (1)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 2,
+                          "description": "String (2)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 3,
+                          "description": "U8 (3)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 4,
+                          "description": "U16 (4)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 5,
+                          "description": "U32 (5)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 6,
+                          "description": "U64 (6)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 7,
+                          "description": "U128 (7)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 8,
+                          "description": "U256 (8)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 9,
+                          "description": "VecBool (9)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 10,
+                          "description": "VecAddress (10)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 11,
+                          "description": "VecString (11)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 12,
+                          "description": "VecU8 (12)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 13,
+                          "description": "VecU16 (13)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 14,
+                          "description": "VecU32 (14)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 15,
+                          "description": "VecU64 (15)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 16,
+                          "description": "VecU128 (16)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 17,
+                          "description": "VecU256 (17)"
+                        },
+                        {
+                          "type": "number",
+                          "const": 18,
+                          "description": "VecVecU8 (18)"
+                        },
+                        {
+                          "type": "string",
+                          "const": "Bool",
+                          "description": "Bool"
+                        },
+                        {
+                          "type": "string",
+                          "const": "Address",
+                          "description": "Address"
+                        },
+                        {
+                          "type": "string",
+                          "const": "String",
+                          "description": "String"
+                        },
+                        {
+                          "type": "string",
+                          "const": "U8",
+                          "description": "U8"
+                        },
+                        {
+                          "type": "string",
+                          "const": "U16",
+                          "description": "U16"
+                        },
+                        {
+                          "type": "string",
+                          "const": "U32",
+                          "description": "U32"
+                        },
+                        {
+                          "type": "string",
+                          "const": "U64",
+                          "description": "U64"
+                        },
+                        {
+                          "type": "string",
+                          "const": "U128",
+                          "description": "U128"
+                        },
+                        {
+                          "type": "string",
+                          "const": "U256",
+                          "description": "U256"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecBool",
+                          "description": "VecBool"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecAddress",
+                          "description": "VecAddress"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecString",
+                          "description": "VecString"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecU8",
+                          "description": "VecU8"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecU16",
+                          "description": "VecU16"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecU32",
+                          "description": "VecU32"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecU64",
+                          "description": "VecU64"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecU128",
+                          "description": "VecU128"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecU256",
+                          "description": "VecU256"
+                        },
+                        {
+                          "type": "string",
+                          "const": "VecVecU8",
+                          "description": "VecVecU8"
+                        },
+                        {
+                          "type": "string",
+                          "const": "bool",
+                          "description": "bool"
+                        },
+                        {
+                          "type": "string",
+                          "const": "address",
+                          "description": "address"
+                        },
+                        {
+                          "type": "string",
+                          "const": "string",
+                          "description": "string"
+                        },
+                        {
+                          "type": "string",
+                          "const": "u8",
+                          "description": "u8"
+                        },
+                        {
+                          "type": "string",
+                          "const": "u16",
+                          "description": "u16"
+                        },
+                        {
+                          "type": "string",
+                          "const": "u32",
+                          "description": "u32"
+                        },
+                        {
+                          "type": "string",
+                          "const": "u64",
+                          "description": "u64"
+                        },
+                        {
+                          "type": "string",
+                          "const": "u128",
+                          "description": "u128"
+                        },
+                        {
+                          "type": "string",
+                          "const": "u256",
+                          "description": "u256"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecbool",
+                          "description": "vecbool"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecaddress",
+                          "description": "vecaddress"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecstring",
+                          "description": "vecstring"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecu8",
+                          "description": "vecu8"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecu16",
+                          "description": "vecu16"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecu32",
+                          "description": "vecu32"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecu64",
+                          "description": "vecu64"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecu128",
+                          "description": "vecu128"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecu256",
+                          "description": "vecu256"
+                        },
+                        {
+                          "type": "string",
+                          "const": "vecvecu8",
+                          "description": "vecvecu8"
+                        }
+                      ],
+                      "description": "Type of the value"
+                    },
+                    "value": {
+                      "anyOf": [
+                        {
+                          "type": "boolean"
+                        },
+                        {
+                          "anyOf": [
+                            {
+                              "type": "object",
+                              "properties": {
+                                "name_or_address": {
+                                  "$ref": "#/definitions/submission/properties/guard/items/properties/object",
+                                  "description": "Account/Object name or ID. If specifying an account, use empty string '' for the default account. If it starts with '0x', it will be treated as an ID. Otherwise, it will be treated as a name (max 64 bcs characters)."
+                                },
+                                "local_mark_first": {
+                                  "type": "boolean",
+                                  "description": "Whether to prioritize local marks, if true, prioritize local marks, otherwise prioritize global marks"
+                                }
+                              },
+                              "additionalProperties": false,
+                              "description": "Account or address lookup object. Use this to specify which account to use for an operation. EXAMPLE: { name_or_address: 'testor2' } - looks up account by name; EXAMPLE: { name_or_address: '0x1234...' } - uses address directly; If name_or_address is empty string '', uses the default local account."
+                            },
+                            {
+                              "type": "string"
+                            }
+                          ]
+                        },
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "number"
+                        },
+                        {
+                          "type": "array",
+                          "items": {
+                            "type": "boolean"
+                          }
+                        },
+                        {
+                          "anyOf": [
+                            {
+                              "type": "object",
+                              "properties": {
+                                "entities": {
+                                  "type": "array",
+                                  "items": {
+                                    "$ref": "#/definitions/submission/properties/submission/items/properties/submission/items/properties/value/anyOf/1/anyOf/0"
+                                  }
+                                },
+                                "check_all_founded": {
+                                  "type": "boolean",
+                                  "description": "Whether to check all entities are found, if true, all entities must be found (abort and throw exception if any ID not found); if false, only return found IDs"
+                                }
+                              },
+                              "required": [
+                                "entities"
+                              ],
+                              "additionalProperties": false,
+                              "description": "Used to batch find account or object IDs by name"
+                            },
+                            {
+                              "type": "array",
+                              "items": {
+                                "type": "string"
+                              }
+                            }
+                          ]
+                        },
+                        {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        },
+                        {
+                          "type": "array",
+                          "items": {
+                            "type": "number"
+                          }
+                        },
+                        {
+                          "type": "array",
+                          "items": {
+                            "type": "array",
+                            "items": {
+                              "type": "number"
+                            }
+                          }
+                        }
+                      ],
+                      "description": "The actual value data"
+                    },
+                    "name": {
+                      "type": "string",
+                      "default": "",
+                      "description": "Name or description of this data"
+                    },
+                    "object_type": {
+                      "type": "string",
+                      "enum": [
+                        "Permission",
+                        "Repository",
+                        "Arb",
+                        "Arbitration",
+                        "Service",
+                        "Machine",
+                        "Order",
+                        "Progress",
+                        "Payment",
+                        "Treasury",
+                        "Guard",
+                        "Demand",
+                        "Passport",
+                        "Allocation",
+                        "Resource",
+                        "Reward",
+                        "Discount",
+                        "EntityRegistrar",
+                        "EntityLinker",
+                        "Proof",
+                        "WReceivedObject",
+                        "Contact",
+                        "TableItem_ProgressHistory",
+                        "TableItem_PermissionPerm",
+                        "TableItem_DemandPresenter",
+                        "TableItem_MachineNode",
+                        "TableItem_TreasuryHistory",
+                        "TableItem_RepositoryData",
+                        "TableItem_RewardRecord",
+                        "TableItem_EntityLinker",
+                        "TableItem_AddressMark",
+                        "TableItem_EntityRegistrar"
+                      ],
+                      "description": "Object type when value_type is Address and represents a specific object"
+                    }
+                  },
+                  "required": [
+                    "identifier",
+                    "b_submission",
+                    "value_type"
+                  ],
+                  "additionalProperties": false,
+                  "description": "Guard table item"
+                },
+                "description": "User-submitted data required for Guard verification."
+              }
+            },
+            "required": [
+              "guard",
+              "submission"
+            ],
+            "additionalProperties": false,
+            "description": "Permission guard submission data."
+          }
+        }
+      },
+      "required": [
+        "type",
+        "guard",
+        "submission"
+      ],
+      "additionalProperties": false,
+      "description": "Guard verification submission data required to complete an operation. Contains: (1) 'guard' - array of Guard objects to verify, each with an object ID and an 'impack' flag indicating if its result affects the final outcome; (2) 'submission' - array of user data submissions matching the Guard's requirements. The operation proceeds only after all Guards with impack=true are successfully verified."
+    }
+  }
+}