on master help sign in
scry: remove contents and fix headers
commit9bc6d0114f49b516fcc876c7ccf4a6c5c9fe0b08 authortinnus-napbus <admin@tinnus-napbus.xyz> dateWed 28 Jul 2021, 23:37 (5 years ago) parent5f50ead
1 file changed+30−48
content/docs/arvo/jael/scry.md+30−48
content/docs/arvo/jael/scry.md+30−48
@@ -6,106 +6,88 @@ template = "doc.html"
66
77Jael's scry endpoints never take a `care`. The particular endpoints are specified in the place of the desk in the path prefix, then additional arguments are specified in the path. Note this style of scry path is considered outdated, and may be changed in the future.
88
9−# Contents
10−
11−- [step](#step) - Web login code revision number.
12−- [code](#code) - Web login code.
13−- [life](#life) - Key revision number (`life`).
14−- [lyfe](#lyfe) - Unitised `life`.
15−- [rift](#rift) - Continuity number (`rift`).
16−- [ryft](#ryft) - Unitised `rift`.
17−- [vein](#vein) - Private key.
18−- [vile](#vile) - Jammed `seed` boot parameters.
19−- [deed](#deed) - Public key and related details.
20−- [earl](#earl) - Derive moon keys.
21−- [sein](#sein) - Sponsor.
22−- [saxo](#saxo) - Sponsorship chain.
23−- [subscriptions](#subscriptions) - Public key trackers.
24−- [sources](#sources) - PKI sources.
25−- [turf](#turf) - Galaxy domain prefixes.
26−
27−# `%step`
9+## `%step`
2810
2911A `%step` scry gets the current web login code revision number. It takes your ship name as its `path` and the type returned is a `@ud`.
3012
31−## Example
13+### Example
3214
3315```
3416> .^(@ud %j /=step=/(scot %p our))
35170
3618```
3719
38−# `%code`
20+## `%code`
3921
4022A `%code` scry gets the current web login code. It takes your ship name as its `path` and the type returned is a `@p`.
4123
42−## Example
24+### Example
4325
4426```
4527> .^(@p %j /=code=/(scot %p our))
4628~lidlut-tabwed-pillex-ridrup
4729```
4830
49−# `%life`
31+## `%life`
5032
5133A `%life` scry gets the current `life` (key revision number) of a ship if known, otherwise it crashes. It takes a ship as its `path` and the type returned is a `@ud`.
5234
53−## Example
35+### Example
5436
5537```
5638> .^(@ud %j /=life=/(scot %p our))
57391
5840```
5941
60−# `%lyfe`
42+## `%lyfe`
6143
6244A `%lyfe` scry gets the current unitized `life` (key revision number) of a ship if known, otherwise returns `~`. It takes a ship as its `path` and the type returned is a `(unit @ud)`.
6345
64−## Example
46+### Example
6547
6648```
6749> .^((unit @ud) %j /=lyfe=/(scot %p our))
6850[~ 1]
6951```
7052
71−# `%rift`
53+## `%rift`
7254
7355A `%rift` scry gets the current `rift` (continuity number) of a ship if known, otherwise it crashes. It takes a ship as its `path` and the type returned is a `@ud`.
7456
75−## Example
57+### Example
7658
7759```
7860.^(@ud %j /=rift=/(scot %p our))
79611
8062```
8163
82−# `%ryft`
64+## `%ryft`
8365
8466A `%ryft` scry gets the current unitized `rift` (continuity number) of a ship if known, otherwise it returns `~`. It takes a ship as its `path` and the type returned is a `(unit @ud)`.
8567
86−## Example
68+### Example
8769
8870```
8971> .^((unit @ud) %j /=ryft=/(scot %p our))
9072[~ 1]
9173```
9274
93−# `%vein`
75+## `%vein`
9476
9577A `%vein` scry gets your ship's private key for the specified `life`. It takes a `life` `@ud` as its `path` and the type returned is a `ring`.
9678
97−## Example
79+### Example
9880
9981```
10082> .^(@uw %j /=vein=/1)
101830w84.0MwlQ.y2Ly9.6HVmH.8SYwo.EvuLC.f5YRw.T2NzD.EHtjZ.gpHZb.J0Pu5.aTGVL.UugSA.EZ~E9.~PODC.cohVD.B1zWj.ZWnJ2
10284```
10385
104−# `%vile`
86+## `%vile`
10587
10688A `%vile` scry gets your `jam`mmed private boot parameters at your ship's current `life`. It takes no additional arguments in its `path`. The type returned is a `@` which is a `jam`med [$seed](@/docs/arvo/jael/data-types.md#seed).
10789
108−## Examples
90+### Examples
10991
11092```
11193> .^(@ %j /=vile=)
@@ -122,11 +104,11 @@ A `%vile` scry gets your `jam`mmed private boot parameters at your ship's curren
122104]
123105```
124106
125−# `%deed`
107+## `%deed`
126108
127109A `%deed` scry gets the `life`, pubkey and maybe a signature if the ship in question is a comet. It takes the target ship and life as its `path` like `/~sampel-palnet/1` and the type returned is a `[life pass (unit @ux)]`.
128110
129−## Example
111+### Example
130112
131113```
132114> .^([life pass (unit @ux)] %j /=deed=/(scot %p our)/1)
@@ -136,11 +118,11 @@ A `%deed` scry gets the `life`, pubkey and maybe a signature if the ship in ques
136118]
137119```
138120
139−# `%earl`
121+## `%earl`
140122
141123A `%earl` scry deterministically derives a private key for a moon. Note this is a holdover from an old version of moon infrastructure, the current `|moon` generator doesn't use this and instead generates moon private keys non-deterministically. It takes the moon name and your ship's current `life` (not the moon's `life`) as its `path` like `/~doznec-dozzod-dozzod-dozzod/1`. The type returned is a [$seed](@/docs/arvo/jael/data-types.md#seed), the `life` of the moon in the `lyf` field of the `seed` will always be `1`.
142124
143−## Example
125+### Example
144126
145127```
146128> .^(seed:jael %j /=earl=/~doznec-dozzod-dozzod-dozzod/1)
@@ -152,29 +134,29 @@ A `%earl` scry deterministically derives a private key for a moon. Note this is
152134]
153135```
154136
155−# `%sein`
137+## `%sein`
156138
157139A `%sein` scry gets the sponsor for the specified ship. This scry is used implicitly by `sein:title`. It takes the target ship as its `path` and the type returned is a `@p`.
158140
159−## Example
141+### Example
160142
161143```
162144> .^(@p %j /=sein=/~sampel-palnet)
163145~talpur
164146```
165147
166−# `%saxo`
148+## `%saxo`
167149
168150A `%saxo` scry gets the sponsorship chain for the target ship (including the target ship itself). For example, a `%saxo` scry for a planet will return the planet, its star and the star's galaxy. This scry is used implicitly by `saxo:title`. It takes the target ship as its `path` and the type returned is a `(list @p)`.
169151
170−## Example
152+### Example
171153
172154```
173155> .^((list @p) %j /=saxo=/~sampel-palnet)
174156~[~sampel-palnet ~talpur ~pur]
175157```
176158
177−# `%subscriptions`
159+## `%subscriptions`
178160
179161A `%subscriptions` scry gets the current state of subscriptions to public key updates (typically initiated with a [%public-keys task](@/docs/arvo/jael/tasks.md#public-keys)). It takes a `life` as its `path` and returns a triple consisting of the following:
180162
@@ -186,18 +168,18 @@ nel=(set duct) :: trackers of all
186168
187169The `yen` `jug` maps subscribed `duct`s to the `ship`s they're tracking, and `ney` is just the inverse, mapping tracked `ship`s to subscribed `duct`s. The `nel` set contains `duct`s track all public key updates.
188170
189−## Example
171+### Example
190172
191173```
192174.^([yen=(jug duct ship) ney=(jug ship duct) nel=(set duct)] %j /=subscriptions=/1)
193175[yen={} ney={} nel={}]
194176```
195177
196−# `%sources`
178+## `%sources`
197179
198180A `%sources` scry gets the current state of Jael's sources for PKI updates. It takes no additional arguments in its `path` and returns a [$state-eth-node](@/docs/arvo/jael/data-types.md#state-eth-node).
199181
200−## Example
182+### Example
201183
202184```
203185> .^(state-eth-node:jael %j /=sources=)
@@ -210,11 +192,11 @@ A `%sources` scry gets the current state of Jael's sources for PKI updates. It t
210192]
211193```
212194
213−# `%turf`
195+## `%turf`
214196
215197A `%turf` scry gets the list of domain prefixes for galaxies. It takes no additional arguments in its `path`. It returns a `(list turf)`, where a `turf` is a TLD-first `(list @t)`, so `urbit.org` as a `turf` is `~['org' 'urbit']`.
216198
217−## Example
199+### Example
218200
219201```
220202> .^((list turf) %j /=turf=)