@ouronet/talos-registry 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,7 +17,7 @@ buildCall("TS01-C1.DPTF|C_Transfer", {
17
17
  Note `1` became `1.0`. Pact's decimal lexer rejects a bare integer in a decimal slot, and that
18
18
  is the least interesting thing this package stops you getting wrong.
19
19
 
20
- **This build:** 423 entrypoints, 428 previews, surface `7e59e59d4c5b7257`, generated against mainnet.
20
+ **This build:** 423 entrypoints, 428 previews, surface `9091592ba15520f4`, generated against mainnet.
21
21
  Every figure in this file is asserted by `tests/readme.test.ts` against the bundled snapshot, so
22
22
  a stale number fails the suite rather than misleading a reader.
23
23
 
@@ -166,3 +166,33 @@ four-segment pipe-joined string and an account is a glyph string, not a `k:` add
166
166
  **They are not submittable.** The accounts are not yours to sign for, and an amount of `1.0` is
167
167
  a placeholder. A preflight-fed parameter is `null` with a note naming the read — the registry
168
168
  will not invent a value it has just told you cannot be constructed.
169
+
170
+ ### Where a ghost may be used — `ghost.use`
171
+
172
+ A ghost is not equally safe on every surface, and a single value cannot say so. Entries whose
173
+ usage is **restricted** carry a `use` block, keyed by parameter name:
174
+
175
+ ```jsonc
176
+ "ghost": {
177
+ "args": { "new-guard": { "readKeyset": "ks" } },
178
+ "use": { "new-guard": { "zbom": false, "display": "(read-keyset \"ks\")" } }
179
+ }
180
+ ```
181
+
182
+ | key | meaning |
183
+ |---|---|
184
+ | `zbom` | may this be **prefilled into an input** that can reach a signed transaction? |
185
+ | `tooltip` | may this be **rendered** where nothing is submitted? |
186
+ | `display` | render *this string* instead of the value |
187
+
188
+ **Both flags default to `true`, and the block appears only when something is restricted** — 6 of
189
+ 423 entrypoints today, every one of them guard-taking. A `use` block on all 2,182 slots would be
190
+ noise consumers learn to skip, and the one entry that matters would be invisible inside it.
191
+
192
+ The case that forced the split is `guard`. A guard **cannot be prefilled** — nobody may hand a
193
+ user a keyset and ask them to sign under it — so `zbom` is `false`. But a tooltip showing the
194
+ guard slot empty teaches the wrong call shape, so `tooltip` stays `true` and `display` renders
195
+ the Pact form the caller actually writes. That is a value which is **correct to show and wrong
196
+ to submit**, which is exactly what one tag cannot express.
197
+
198
+ **Read `use` before prefilling anything.** An absent parameter is unrestricted.