@@ -8,21 +8,7 @@ This document details all the `task`s you may wish to send Jael, as well as the
9You may also wish to reference the [Data Types](@/docs/arvo/jael/data-types.md) document for details of the types referenced here, and the [Examples](@/docs/arvo/jael/examples.md) document for practical examples of using these `task`s.
9You may also wish to reference the [Data Types](@/docs/arvo/jael/data-types.md) document for details of the types referenced here, and the [Examples](@/docs/arvo/jael/examples.md) document for practical examples of using these `task`s.
13−- [%dawn](#dawn) - _(Internal only)_ - Boot from keys.
14−- [%fake](#fake) - _(Internal only)_ - Boot fake ship.
15−- [%listen](#listen) - _(Usually internal)_ - Set Ethereum Source.
16−- [%meet](#meet) - _Deprecated._
17−- [%moon](#moon) - Register moon keys or otherwise administer a moon.
18−- [%nuke](#nuke) - Cancel subscription to public or private key updates.
19−- [%private-keys](#private-keys) - Subscribe to private key updates.
20−- [%public-keys](#public-keys) - Subscribe to public key (and related) updates from Jael.
21−- [%rekey](#rekey)- Update private keys.
22−- [%turf](#turf) - View domains.
23−- [%step](#step) - Reset web login code.
25−# `%dawn`
11+## `%dawn`
28[%dawn dawn-event]
14[%dawn dawn-event]
@@ -48,11 +34,11 @@ This `task` takes a [$dawn-event](@/docs/arvo/jael/data-types.md#dawn-event) as
49You would not use this `task` manually.
35You would not use this `task` manually.
51−## Returns
37+### Returns
53Jael `%give`s an `%init` `gift` to Unix. This occurs after the Dill `%slip` init.
39Jael `%give`s an `%init` `gift` to Unix. This occurs after the Dill `%slip` init.
55−# `%fake`
41+## `%fake`
58[%fake =ship]
44[%fake =ship]
@@ -68,11 +54,11 @@ The `ship` field specifies the `@p` of the fake ship being created.
69You would not use this `task` manually.
55You would not use this `task` manually.
71−## Returns
57+### Returns
73Jael `%give`s a `%init` `gift` to Unix.
59Jael `%give`s a `%init` `gift` to Unix.
75−# `%listen`
61+## `%listen`
78[%listen whos=(set ship) =source]
64[%listen whos=(set ship) =source]
@@ -86,11 +72,11 @@ Sets the source that the public keys for a set of `ship`s should be obtained fro
87You are unlikely to use this `task` manually.
73You are unlikely to use this `task` manually.
89−## Returns
75+### Returns
91Jael will not return any `gift`s in response to a `%listen` `task`.
77Jael will not return any `gift`s in response to a `%listen` `task`.
93−# `%meet`
79+## `%meet`
96[%meet =ship =life =pass]
82[%meet =ship =life =pass]
@@ -98,7 +84,7 @@ Jael will not return any `gift`s in response to a `%listen` `task`.
99This `task` is deprecated and does not perform any actions.
85This `task` is deprecated and does not perform any actions.
101−# `%moon`
87+## `%moon`
104[%moon =ship =udiff:point]
90[%moon =ship =udiff:point]
@@ -108,11 +94,11 @@ Register moon keys or otherwise administer a moon.
109This 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.md#udiff-point) will contain the bunt of an [$id:block](@/docs/arvo/jael/data-types.md#id-block) (since moons aren't registered in Azimuth) and one of the `udiff` actions depending on what you want to do.
95This 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.md#udiff-point) will contain the bunt of an [$id:block](@/docs/arvo/jael/data-types.md#id-block) (since moons aren't registered in Azimuth) and one of the `udiff` actions depending on what you want to do.
111−## Returns
97+### Returns
113Jael does not return any `gift`s in response to a `%moon` `task`.
99Jael does not return any `gift`s in response to a `%moon` `task`.
115−# `%nuke`
101+## `%nuke`
118[%nuke whos=(set ship)]
104[%nuke whos=(set ship)]
@@ -124,15 +110,15 @@ If you've subscribed to public or private key updates from Jael with a [%private
125To cancel a subscription to the ship's private keys you must leave `whos` empty like `[%nuke ~]`.
111To cancel a subscription to the ship's private keys you must leave `whos` empty like `[%nuke ~]`.
127−## Returns
113+### Returns
129Jael does not return a `gift` in response to a `%nuke` `task`.
115Jael does not return a `gift` in response to a `%nuke` `task`.
131−## Examples
117+### Examples
133See the [%public-keys and %nuke](@/docs/arvo/jael/examples.md#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.md#private-keys) example for cancelling a `%private-keys` subscription.
119See the [%public-keys and %nuke](@/docs/arvo/jael/examples.md#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.md#private-keys) example for cancelling a `%private-keys` subscription.
135−# `%private-keys`
121+## `%private-keys`
138[%private-keys ~]
124[%private-keys ~]
@@ -142,7 +128,7 @@ Subscribe to private key updates.
143Subscribe 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.
129Subscribe 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.
145−## Returns
131+### Returns
147Jael responds to a `%private-keys` `task` with a `%private-keys` `gift` which looks like:
133Jael responds to a `%private-keys` `task` with a `%private-keys` `gift` which looks like:
@@ -152,11 +138,11 @@ Jael responds to a `%private-keys` `task` with a `%private-keys` `gift` which lo
153The `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`.
139The `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`.
155−## Example
141+### Example
157See the [%private-keys](@/docs/arvo/jael/examples.md#private-keys) section of the Examples document for a practical example.
143See the [%private-keys](@/docs/arvo/jael/examples.md#private-keys) section of the Examples document for a practical example.
159−# `%public-keys`
145+## `%public-keys`
162[%public-keys ships=(set ship)]
148[%public-keys ships=(set ship)]
@@ -166,7 +152,7 @@ Subscribe to public key (and related) updates from Jael.
167An 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.
153An 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.
169−## Returns
155+### Returns
171Jael responds to a `%public-keys` `task` with `%public-keys` `gift`s which look like:
157Jael responds to a `%public-keys` `task` with `%public-keys` `gift`s which look like:
@@ -178,11 +164,11 @@ The [$public-keys-result](@/docs/arvo/jael/data-types.md#public-keys-result) con
179Upon 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.
165Upon 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.
181−## Example
167+### Example
183See the [%public-keys and %nuke](@/docs/arvo/jael/examples.md#public-keys-and-nuke) section of the Examples document for a practical example.
169See the [%public-keys and %nuke](@/docs/arvo/jael/examples.md#public-keys-and-nuke) section of the Examples document for a practical example.
185−# `%rekey`
171+## `%rekey`
188[%rekey =life =ring]
174[%rekey =life =ring]
@@ -192,11 +178,11 @@ Update private keys.
193This 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 `@`.
179This 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 `@`.
195−## Returns
181+### Returns
197Jael does not return any `gift` in response to a `%rekey` `task`.
183Jael does not return any `gift` in response to a `%rekey` `task`.
199−# `%turf`
185+## `%turf`
@@ -206,7 +192,7 @@ View domains.
207The 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.md#turf) instead.
193The 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.md#turf) instead.
209−## Returns
195+### Returns
211Jael will respond to a `%turf` `task` with a `%turf` `gift`, which looks like:
197Jael will respond to a `%turf` `task` with a `%turf` `gift`, which looks like:
@@ -216,11 +202,11 @@ Jael will respond to a `%turf` `task` with a `%turf` `gift`, which looks like:
217The `turf` in the `(list turf)` is a domain as a `(list @t)`, TLD-first. The current default is `[['org' 'urbit' ~] ~]`.
203The `turf` in the `(list turf)` is a domain as a `(list @t)`, TLD-first. The current default is `[['org' 'urbit' ~] ~]`.
219−## Example
205+### Example
221See the [%turf section of the Examples document](@/docs/arvo/jael/examples.md#turf) for a practical example.
207See the [%turf section of the Examples document](@/docs/arvo/jael/examples.md#turf) for a practical example.
223−# `%step`
209+## `%step`
@@ -230,10 +216,10 @@ Reset web login code.
231Jael 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.
217Jael 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.
233−## Returns
219+### Returns
235Jael does not return a `gift` in response to a `%step` `task`.
221Jael does not return a `gift` in response to a `%step` `task`.
237−## Example
223+### Example
239See the [%step](@/docs/arvo/jael/examples.md#step) section of the Examples document for a practical example.
225See the [%step](@/docs/arvo/jael/examples.md#step) section of the Examples document for a practical example.