on master help sign in
work in progress
7c6c489syzygyzer
reference/vane-apis/jael.md+29
@@ -9,12 +9,41 @@ template = "doc.html"
9In this document we describe the public interface for Jael. Namely, we describe
9In this document we describe the public interface for Jael. Namely, we describe
10each `task` that Jael can be `%pass`ed, and which `gift`(s) Jael can `%give` in return.
10each `task` that Jael can be `%pass`ed, and which `gift`(s) Jael can `%give` in return.
11
11
12+
12## Tasks
13## Tasks
13
14
14### `%dawn`
15### `%dawn`
15
16
17+This `task` is called only a single time per ship during the vane initialization
18+phase immediately following the beginning of the [adult
19+stage](@/docs/tutorials/arvo/arvo.md#structural-interface-core) to load Azimuth information such as private keys and the sponsor into
20+Jael. This `task` is `%pass`ed to Jael by Dill, as Dill is the first vane to be loaded for
21+technical reasons, though we consider Jael to be the true "first" vane.
22+
16#### Accepts
23#### Accepts
17
24
25+`%dawn` accepts a `dawn-event`:
26+
27+```hoon
28+ +$ dawn-event
29+ $: =seed
30+ spon=(list [=ship point:azimuth-types])
31+ czar=(map ship [=rift =life =pass])
32+ turf=(list turf)
33+ bloq=@ud
34+ node=(unit purl:eyre)
35+ ==
36+```
37+
38+The `seed` is `[who=ship lyf=life key=ring sig=(unit oath:pki)]`. `who` is the
39+`@p` of the ship running the `task`, `lyf` is the current ship key revision, `key`
40+
41+
42+`spon` is a list (why?) of sponsors for the ship, `czar` is a map of ships you
43+know to their rift, life, and public key?
44+
45+`turf` is a `(list @t)` ":: domain, tld first" ?? something to do with DNS?
46+
18#### Returns
47#### Returns
19
48
20
49