300c30e · urbit.org · git.iko.soy

git.iko.soy/urbit.org

Merge pull request #1104 from tinnus-napbus/fix-jael-docs

fix jael docs style

commit300c30ec13a0654f7ecb3306dee17a965b2ef24f authortinnus-napbus <77721746+tinnus-napbus@users.noreply.github.com> dateWed 8 Sep 2021, 17:26 (5 years ago) parentc79b4f4 6c91a5e

2 files changed+30−30

compare with master

unifiedsplit

content/docs/arvo/jael/scry.md+15−15 content/docs/arvo/jael/tasks.md+15−15

content/docs/arvo/jael/scry.md+15−15

@@ -10,7 +10,7 @@ Jael's scry endpoints never take a `care`. The particular endpoints are specifie

1010

1111A `%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`.

1212

13−### Example

13+#### Example

1414

1515```

1616> .^(@ud %j /=step=/(scot %p our))

@@ -21,7 +21,7 @@ A `%step` scry gets the current web login code revision number. It takes your sh

2121

2222A `%code` scry gets the current web login code. It takes your ship name as its `path` and the type returned is a `@p`.

2323

24−### Example

24+#### Example

2525

2626```

2727> .^(@p %j /=code=/(scot %p our))

@@ -32,7 +32,7 @@ A `%code` scry gets the current web login code. It takes your ship name as its `

3232

3333A `%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`.

3434

35−### Example

35+#### Example

3636

3737```

3838> .^(@ud %j /=life=/(scot %p our))

@@ -43,7 +43,7 @@ A `%life` scry gets the current `life` (key revision number) of a ship if known,

4343

4444A `%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)`.

4545

46−### Example

46+#### Example

4747

4848```

4949> .^((unit @ud) %j /=lyfe=/(scot %p our))

@@ -54,7 +54,7 @@ A `%lyfe` scry gets the current unitized `life` (key revision number) of a ship

5454

5555A `%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`.

5656

57−### Example

57+#### Example

5858

5959```

6060.^(@ud %j /=rift=/(scot %p our))

@@ -65,7 +65,7 @@ A `%rift` scry gets the current `rift` (continuity number) of a ship if known, o

6565

6666A `%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)`.

6767

68−### Example

68+#### Example

6969

7070```

7171> .^((unit @ud) %j /=ryft=/(scot %p our))

@@ -76,7 +76,7 @@ A `%ryft` scry gets the current unitized `rift` (continuity number) of a ship if

7676

7777A `%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`.

7878

79−### Example

79+#### Example

8080

8181```

8282> .^(@uw %j /=vein=/1)

@@ -87,7 +87,7 @@ A `%vein` scry gets your ship's private key for the specified `life`. It takes a

8787

8888A `%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#seed).

8989

90−### Examples

90+#### Examples

9191

9292```

9393> .^(@ %j /=vile=)

@@ -108,7 +108,7 @@ A `%vile` scry gets your `jam`mmed private boot parameters at your ship's curren

108108

109109A `%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)]`.

110110

111−### Example

111+#### Example

112112

113113```

114114> .^([life pass (unit @ux)] %j /=deed=/(scot %p our)/1)

@@ -122,7 +122,7 @@ A `%deed` scry gets the `life`, pubkey and maybe a signature if the ship in ques

122122

123123A `%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#seed), the `life` of the moon in the `lyf` field of the `seed` will always be `1`.

124124

125−### Example

125+#### Example

126126

127127```

128128> .^(seed:jael %j /=earl=/~doznec-dozzod-dozzod-dozzod/1)

@@ -138,7 +138,7 @@ A `%earl` scry deterministically derives a private key for a moon. Note this is

138138

139139A `%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`.

140140

141−### Example

141+#### Example

142142

143143```

144144> .^(@p %j /=sein=/~sampel-palnet)

@@ -149,7 +149,7 @@ A `%sein` scry gets the sponsor for the specified ship. This scry is used implic

149149

150150A `%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)`.

151151

152−### Example

152+#### Example

153153

154154```

155155> .^((list @p) %j /=saxo=/~sampel-palnet)

@@ -168,7 +168,7 @@ nel=(set duct) :: trackers of all

168168

169169The `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.

170170

171−### Example

171+#### Example

172172

173173```

174174.^([yen=(jug duct ship) ney=(jug ship duct) nel=(set duct)] %j /=subscriptions=/1)

@@ -179,7 +179,7 @@ The `yen` `jug` maps subscribed `duct`s to the `ship`s they're tracking, and `ne

179179

180180A `%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#state-eth-node).

181181

182−### Example

182+#### Example

183183

184184```

185185> .^(state-eth-node:jael %j /=sources=)

@@ -196,7 +196,7 @@ A `%sources` scry gets the current state of Jael's sources for PKI updates. It t

196196

197197A `%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']`.

198198

199−### Example

199+#### Example

200200

201201```

202202> .^((list turf) %j /=turf=)

content/docs/arvo/jael/tasks.md+15−15

@@ -34,7 +34,7 @@ This `task` takes a [$dawn-event](/docs/arvo/jael/data-types#dawn-event) as its

3434

3535You would not use this `task` manually.

3636

37−### Returns

37+#### Returns

3838

3939Jael `%give`s an `%init` `gift` to Unix. This occurs after the Dill `%slip` init.

4040

@@ -54,7 +54,7 @@ The `ship` field specifies the `@p` of the fake ship being created.

5454

5555You would not use this `task` manually.

5656

57−### Returns

57+#### Returns

5858

5959Jael `%give`s a `%init` `gift` to Unix.

6060

@@ -72,7 +72,7 @@ Sets the source that the public keys for a set of `ship`s should be obtained fro

7272

7373You are unlikely to use this `task` manually.

7474

75−### Returns

75+#### Returns

7676

7777Jael will not return any `gift`s in response to a `%listen` `task`.

7878

@@ -94,7 +94,7 @@ Register moon keys or otherwise administer a moon.

9494

9595This is what is sent to Jael by `%hood` behind the scenes when you run `|moon`, `|moon-breach` or `|moon-cycle-keys`. The `ship` field is the moon's `@p`. The [$udiff:point](/docs/arvo/jael/data-types#udiffpoint) will contain the bunt of an [$id:block](/docs/arvo/jael/data-types#idblock) (since moons aren't registered in Azimuth) and one of the `udiff` actions depending on what you want to do.

9696

97−### Returns

97+#### Returns

9898

9999Jael does not return any `gift`s in response to a `%moon` `task`.

100100

@@ -110,11 +110,11 @@ If you've subscribed to public or private key updates from Jael with a [%private

110110

111111To cancel a subscription to the ship's private keys you must leave `whos` empty like `[%nuke ~]`.

112112

113−### Returns

113+#### Returns

114114

115115Jael does not return a `gift` in response to a `%nuke` `task`.

116116

117−### Examples

117+#### Examples

118118

119119See the [%public-keys and %nuke](/docs/arvo/jael/examples#public-keys-and-nuke) section of the Examples document for an example of using `%nuke` to cancel a `%public-keys` subscription. See the thread in the [%private-keys](/docs/arvo/jael/examples#private-keys) example for cancelling a `%private-keys` subscription.

120120

@@ -128,7 +128,7 @@ Subscribe to private key updates.

128128

129129Subscribe to be notified of private key updates for the local ship. The subscription will continue until Jael receives a [%nuke](#nuke) `task` to cancel it.

130130

131−### Returns

131+#### Returns

132132

133133Jael responds to a `%private-keys` `task` with a `%private-keys` `gift` which looks like:

134134

@@ -138,7 +138,7 @@ Jael responds to a `%private-keys` `task` with a `%private-keys` `gift` which lo

138138

139139The `life` is the current life of the ship and the `vein` `map` contains the private key for each life up to (and including) the current one. Upon first subscribing, Jael will immediately respond with a `%private-keys` `gift`. Then, whenever the ship's private keys are changed, it'll send a new and updated `%private-keys` `gift`.

140140

141−### Example

141+#### Example

142142

143143See the [%private-keys](/docs/arvo/jael/examples#private-keys) section of the Examples document for a practical example.

144144

@@ -152,7 +152,7 @@ Subscribe to public key (and related) updates from Jael.

152152

153153An agent or thread can subscribe to be notified of public key updates, sponsorship changes and continuity breaches for the `set` of `ship`s specified in the `ships` field. The subscription will continue until Jael receives a [%nuke](#nuke) `task` to cancel it.

154154

155−### Returns

155+#### Returns

156156

157157Jael responds to a `%public-keys` `task` with `%public-keys` `gift`s which look like:

158158

@@ -164,7 +164,7 @@ The [$public-keys-result](/docs/arvo/jael/data-types#public-keys-result) contain

164164

165165Upon subscription, Jael will immeditely respond with a `%public-keys` `gift` containing a `%full` `public-keys-result` with the public key for each `life` up until the current one for each `ship` specified in the original `task`. After than, Jael will send a `%public-keys` `gift` with either a `%diff` or `%breach` `public-keys-result` each time a change occurs for any of the `ship`s to which you're subscribed.

166166

167−### Example

167+#### Example

168168

169169See the [%public-keys and %nuke](/docs/arvo/jael/examples#public-keys-and-nuke) section of the Examples document for a practical example.

170170

@@ -178,7 +178,7 @@ Update private keys.

178178

179179This is what is sent to Jael by `%hood` when you run `|rekey`, as you must after setting new Azimuth keys or running `|cycle-moon-keys` on a moon's parent. It will update your `life` (key revision number) and private keys. The `life` field is the new `life` (typically an increment of the current `life`) and the `ring` is a private key `@`.

180180

181−### Returns

181+#### Returns

182182

183183Jael does not return any `gift` in response to a `%rekey` `task`.

184184

@@ -192,7 +192,7 @@ View domains.

192192

193193The domains returned by a `%turf` `task` are used as the base for individual galaxy domain names (e.g. from `urbit.org` you get `zod.urbit.org`, `bus.urbit.org`, etc). Jael gets these from Azimuth, then Ames gets them from Jael and passes them to the runtime, which will perform the DNS lookups and give Ames back the galaxy IP addresses. A `%turf` task takes no additional arguments. You're unlikely to use this manually - if you want the current `turf`s you'd likely want to do a [turf scry](/docs/arvo/jael/scry#turf) instead.

194194

195−### Returns

195+#### Returns

196196

197197Jael will respond to a `%turf` `task` with a `%turf` `gift`, which looks like:

198198

@@ -202,7 +202,7 @@ Jael will respond to a `%turf` `task` with a `%turf` `gift`, which looks like:

202202

203203The `turf` in the `(list turf)` is a domain as a `(list @t)`, TLD-first. The current default is `[['org' 'urbit' ~] ~]`.

204204

205−### Example

205+#### Example

206206

207207See the [%turf section of the Examples document](/docs/arvo/jael/examples#turf) for a practical example.

208208

@@ -216,10 +216,10 @@ Reset web login code.

216216

217217Jael maintains a `step` value that represents the web login code revision number, and uses it to derive the code itself. It begins at `0` and is incremented each time the code is changed. When Jael updates the web login code, it sends Eyre a `%code-changed` `task:eyre` so that Eyre can throw away all of its current cookies and sessions. A `%step` task takes no additional argument.

218218

219−### Returns

219+#### Returns

220220

221221Jael does not return a `gift` in response to a `%step` `task`.

222222

223−### Example

223+#### Example

224224

225225See the [%step](/docs/arvo/jael/examples#step) section of the Examples document for a practical example.