on master help sign in
data-types: fix links
cb980f8tinnus-napbus
content/docs/arvo/jael/data-types.md+13−18
@@ -4,12 +4,7 @@ weight = 4
4template = "doc.html"
4template = "doc.html"
5+++
5+++
6
6
7−Jael's section in `lull.hoon` contains three ancillary cores with their own type definitions as well as Jael's general types, so this reference is divided as follows:
7+Jael's section in `lull.hoon` contains three ancillary cores with their own type definitions as well as Jael's general types.
8−
9−- [jael](#public-keys-result) - General structures.
10−- [block:jael](#block) - Structures for Ethereum blocks.
11−- [point:jael](#point) - Structures for points (Ship IDs in Azimuth).
12−- [pki:jael](#pki) - Largely unused apart from [$oath:pki](#oath-pki).
13
8
14### `$public-keys-result`
9### `$public-keys-result`
15
10
@@ -21,9 +16,9 @@ Jael's section in `lull.hoon` contains three ancillary cores with their own type
21 ==
16 ==
22```
17```
23
18
24−This is what Jael gives (in a [%public-keys](@/docs/arvo/jael/tasks.md#public-keys) `gift`) to subcribers who are tracking public key information for a `set` of `ship`s.
19+This is what Jael gives (in a [%public-keys](/docs/arvo/jael/tasks#public-keys) `gift`) to subcribers who are tracking public key information for a `set` of `ship`s.
25
20
26−Typically the `%full` kind with a `map` of `ship`s to [$point:point](#point-point)s is given immediately upon subscription and contains all public key records for the ships in question. After the `%full`, a `%diff` (including a [$diff:point](#diff-point)) will be given whenever a change (such as the sponsor or pubkey) has occurred for one of the ships being tracked, and a `%breach` will be given whenever a continuity breach for a tracked ship occurs.
21+Typically the `%full` kind with a `map` of `ship`s to [$point:point](#pointpoint)s is given immediately upon subscription and contains all public key records for the ships in question. After the `%full`, a `%diff` (including a [$diff:point](#diffpoint)) will be given whenever a change (such as the sponsor or pubkey) has occurred for one of the ships being tracked, and a `%breach` will be given whenever a continuity breach for a tracked ship occurs.
27
22
28### `$seed`
23### `$seed`
29
24
@@ -49,7 +44,7 @@ Private boot parameters. The `who` field is the name of the ship, `lyf` is the `
49Ship initialisation parameters.
44Ship initialisation parameters.
50
45
51- [$seed](#seed) contains the private boot parameters.
46- [$seed](#seed) contains the private boot parameters.
52−- `spon` is a `list` of ships and their [$point](#point-point)s in the ship's sponsorship chain, all the way to the galaxy level.
47+- `spon` is a `list` of ships and their [$point](#pointpoint)s in the ship's sponsorship chain, all the way to the galaxy level.
53- `czar` is a map from each galaxy's `@p` to its `rift`, `life`, and public key (`pass`).
48- `czar` is a map from each galaxy's `@p` to its `rift`, `life`, and public key (`pass`).
54- `turf` is a `list` of DNS suffixes used for galaxies, which is `urbit.org` by default.
49- `turf` is a `list` of DNS suffixes used for galaxies, which is `urbit.org` by default.
55- `bloq` is the number of the Ethereum block in which the ship registered its keys with the Azimuth smart contract.
50- `bloq` is the number of the Ethereum block in which the ship registered its keys with the Azimuth smart contract.
@@ -119,7 +114,7 @@ Ethereum block number.
119+$ id [=hash =number]
114+$ id [=hash =number]
120```
115```
121
116
122−Ethereum block identifier - contains both the [$hash:block](#hash-block) and [$number:block](#number-block).
117+Ethereum block identifier - contains both the [$hash:block](#hashblock) and [$number:block](#numberblock).
123
118
124### `$block:block`
119### `$block:block`
125
120
@@ -127,7 +122,7 @@ Ethereum block identifier - contains both the [$hash:block](#hash-block) and [$n
127+$ block [=id =parent=hash]
122+$ block [=id =parent=hash]
128```
123```
129
124
130−A reference to an Ethereum block - contains the [$id:block](#id-block) and the [$hash:block](#hash-block) of its parent for ordering purposes.
125+A reference to an Ethereum block - contains the [$id:block](#idblock) and the [$hash:block](#hashblock) of its parent for ordering purposes.
131
126
132## point
127## point
133
128
@@ -160,7 +155,7 @@ An update to a ship's keys. The `life` is the key revision number, `crypt-suite`
160+$ diffs (list diff)
155+$ diffs (list diff)
161```
156```
162
157
163−A list of invertible [$diff:point](#diff-point)s.
158+A list of invertible [$diff:point](#diffpoint)s.
164
159
165### `$diff:point`
160### `$diff:point`
166
161
@@ -175,7 +170,7 @@ A list of invertible [$diff:point](#diff-point)s.
175An invertible diff for public key (and related) changes to the state of an Azimuth point (ship ID).
170An invertible diff for public key (and related) changes to the state of an Azimuth point (ship ID).
176
171
177- `%rift` is a change to the `rift` (continuity breach number) that occurs when a ship undergoes a continuity breach.
172- `%rift` is a change to the `rift` (continuity breach number) that occurs when a ship undergoes a continuity breach.
178−- `%keys` is a change to a ship's `life` and public key, specified in the [$key-update:point](#key-update-point).
173+- `%keys` is a change to a ship's `life` and public key, specified in the [$key-update:point](#key-updatepoint).
179- `%spon` is a change to a ship's sponsor.
174- `%spon` is a change to a ship's sponsor.
180
175
181The `from` and `to` field specify the old a new values respectively.
176The `from` and `to` field specify the old a new values respectively.
@@ -186,7 +181,7 @@ The `from` and `to` field specify the old a new values respectively.
186+$ udiffs (list [=ship =udiff])
181+$ udiffs (list [=ship =udiff])
187```
182```
188
183
189−A list of non-invertible [$udiff:point](#udiff-point)s.
184+A list of non-invertible [$udiff:point](#udiffpoint)s.
190
185
191### `$udiff:point`
186### `$udiff:point`
192
187
@@ -202,18 +197,18 @@ A list of non-invertible [$udiff:point](#udiff-point)s.
202
197
203A non-invertible diff for public key (and related) changes to the state of an Azimuth point (ship ID).
198A non-invertible diff for public key (and related) changes to the state of an Azimuth point (ship ID).
204
199
205−The [$id:block](#id-block) contains the block number and block hash of the Ethereum block in which the change occurred. The next part specifies what changed, where:
200+The [$id:block](#idblock) contains the block number and block hash of the Ethereum block in which the change occurred. The next part specifies what changed, where:
206
201
207- `%rift` means the ship has undergone a continuity breach and therefore the `rift` (continuity revision number) has changed.
202- `%rift` means the ship has undergone a continuity breach and therefore the `rift` (continuity revision number) has changed.
208−- `%keys` means the ship's `life` (key revision number) has changed, the [$key-update:point](#key-update-point) contains the new `life` and pubkeys.
203+- `%keys` means the ship's `life` (key revision number) has changed, the [$key-update:point](#key-updatepoint) contains the new `life` and pubkeys.
209- `%spon` means the ship's sponsor has changed.
204- `%spon` means the ship's sponsor has changed.
210- `%disavow` means a previous Ethereum block has been disavowed.
205- `%disavow` means a previous Ethereum block has been disavowed.
211
206
212−A `udiff:point` can be converted to a [$diff:point](#diff-point) with the `+udiff-to-diff:point` function.
207+A `udiff:point` can be converted to a [$diff:point](#diffpoint) with the `+udiff-to-diff:point` function.
213
208
214## pki
209## pki
215
210
216−This structure is mostly a holdover from prior versions of Jael and is unused apart from [$oath:pki](#oath-pki).
211+This structure is mostly a holdover from prior versions of Jael and is unused apart from [$oath:pki](#oathpki).
217
212
218### `$hand:pki`
213### `$hand:pki`
219
214