git.iko.soy/urbit.org
on master help sign in
data-types: fix headers
c25d308tinnus-napbus
content/docs/arvo/jael/data-types.md+23−23
compare with master
unifiedsplit
@@ -11,7 +11,7 @@ Jael's section in `lull.hoon` contains three ancillary cores with their own type
11- [point:jael](#point) - Structures for points (Ship IDs in Azimuth).
11- [point:jael](#point) - Structures for points (Ship IDs in Azimuth).
12- [pki:jael](#pki) - Largely unused apart from [$oath:pki](#oath-pki).
12- [pki:jael](#pki) - Largely unused apart from [$oath:pki](#oath-pki).
13
13
14−## `$public-keys-result`
14+### `$public-keys-result`
15
15
16```hoon
16```hoon
17+$ public-keys-result
17+$ public-keys-result
@@ -25,7 +25,7 @@ This is what Jael gives (in a [%public-keys](@/docs/arvo/jael/tasks.md#public-ke
25
25
26Typically 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.
26Typically 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.
27
27
28−## `$seed`
28+### `$seed`
29
29
30```hoon
30```hoon
31+$ seed [who=ship lyf=life key=ring sig=(unit oath:pki)]
31+$ seed [who=ship lyf=life key=ring sig=(unit oath:pki)]
@@ -33,7 +33,7 @@ Typically the `%full` kind with a `map` of `ship`s to [$point:point](#point-poin
33
33
34Private boot parameters. The `who` field is the name of the ship, `lyf` is the `life` (key revision number), `key` is the private key and `sig` is the signature of the parent ship if it's a moon, and `~` otherwise.
34Private boot parameters. The `who` field is the name of the ship, `lyf` is the `life` (key revision number), `key` is the private key and `sig` is the signature of the parent ship if it's a moon, and `~` otherwise.
35
35
36−## `$dawn-event`
36+### `$dawn-event`
37
37
38```hoon
38```hoon
39+$ dawn-event
39+$ dawn-event
@@ -55,7 +55,7 @@ Ship initialisation parameters.
55- `bloq` is the number of the Ethereum block in which the ship registered its keys with the Azimuth smart contract.
55- `bloq` is the number of the Ethereum block in which the ship registered its keys with the Azimuth smart contract.
56- `node` is the URL of the Ethereum node used to monitor Azimuth.
56- `node` is the URL of the Ethereum node used to monitor Azimuth.
57
57
58−## `$source`
58+### `$source`
59
59
60```hoon
60```hoon
61+$ source (each ship term)
61+$ source (each ship term)
@@ -63,7 +63,7 @@ Ship initialisation parameters.
63
63
64Source of public key updates for Jael. If it's a `term` it's a Gall agent e.g `%azimuth-tracker`. If it's a `ship`, Jael will subscribe to that ship's Jael for updates - e.g. Jael will subscribe to the parent planet of moons for updates about the moons.
64Source of public key updates for Jael. If it's a `term` it's a Gall agent e.g `%azimuth-tracker`. If it's a `ship`, Jael will subscribe to that ship's Jael for updates - e.g. Jael will subscribe to the parent planet of moons for updates about the moons.
65
65
66−## `$source-id`
66+### `$source-id`
67
67
68```hoon
68```hoon
69+$ source-id @udsourceid
69+$ source-id @udsourceid
@@ -71,7 +71,7 @@ Source of public key updates for Jael. If it's a `term` it's a Gall agent e.g `%
71
71
72Numerical index for Jael to organise its `source`s. Jael assigns its `source-id`s sequentially, starting from `0`.
72Numerical index for Jael to organise its `source`s. Jael assigns its `source-id`s sequentially, starting from `0`.
73
73
74−## `$state-eth-node`
74+### `$state-eth-node`
75
75
76```hoon
76```hoon
77+$ state-eth-node :: node config + meta
77+$ state-eth-node :: node config + meta
@@ -93,11 +93,11 @@ Jael's data about `source`s for PKI updates about ships.
93- `ship-sources` is a `map` from `ship`s to `source-id`s and records where to get updates from for the ships in question. Typically these will map moons to their parent ships.
93- `ship-sources` is a `map` from `ship`s to `source-id`s and records where to get updates from for the ships in question. Typically these will map moons to their parent ships.
94- `ship-sources-reverse` is the same as `ship-sources` but in reverse.
94- `ship-sources-reverse` is the same as `ship-sources` but in reverse.
95
95
96−# block
96+## block
97
97
98Structures for Ethereum blocks.
98Structures for Ethereum blocks.
99
99
100−## `$hash:block`
100+### `$hash:block`
101
101
102```hoon
102```hoon
103+$ hash @uxblockhash
103+$ hash @uxblockhash
@@ -105,7 +105,7 @@ Structures for Ethereum blocks.
105
105
106Ethereum block hash.
106Ethereum block hash.
107
107
108−## `$number:block`
108+### `$number:block`
109
109
110```hoon
110```hoon
111+$ number @udblocknumber
111+$ number @udblocknumber
@@ -113,7 +113,7 @@ Ethereum block hash.
113
113
114Ethereum block number.
114Ethereum block number.
115
115
116−## `$id:block`
116+### `$id:block`
117
117
118```hoon
118```hoon
119+$ id [=hash =number]
119+$ id [=hash =number]
@@ -121,7 +121,7 @@ Ethereum block number.
121
121
122Ethereum block identifier - contains both the [$hash:block](#hash-block) and [$number:block](#number-block).
122Ethereum block identifier - contains both the [$hash:block](#hash-block) and [$number:block](#number-block).
123
123
124−## `$block:block`
124+### `$block:block`
125
125
126```hoon
126```hoon
127+$ block [=id =parent=hash]
127+$ block [=id =parent=hash]
@@ -129,11 +129,11 @@ Ethereum block identifier - contains both the [$hash:block](#hash-block) and [$n
129
129
130A reference to an Ethereum block - contains the [$id:block](#id-block) and the [$hash:block](#hash-block) of its parent for ordering purposes.
130A reference to an Ethereum block - contains the [$id:block](#id-block) and the [$hash:block](#hash-block) of its parent for ordering purposes.
131
131
132−# point
132+## point
133
133
134Structures for points (Ship IDs in Azimuth).
134Structures for points (Ship IDs in Azimuth).
135
135
136−## `$point:point`
136+### `$point:point`
137
137
138```hoon
138```hoon
139+$ point
139+$ point
@@ -146,7 +146,7 @@ Structures for points (Ship IDs in Azimuth).
146
146
147Public key data for a particular ship. The `rift` is the current continuity breach number and `life` is the current key revision number. The `keys` `map` contains the public key (`pass`) for each `life` up to the current one. The `sponsor` is the current sponsor of the ship in question, if it has one.
147Public key data for a particular ship. The `rift` is the current continuity breach number and `life` is the current key revision number. The `keys` `map` contains the public key (`pass`) for each `life` up to the current one. The `sponsor` is the current sponsor of the ship in question, if it has one.
148
148
149−## `$key-update:point`
149+### `$key-update:point`
150
150
151```hoon
151```hoon
152+$ key-update [=life crypto-suite=@ud =pass]
152+$ key-update [=life crypto-suite=@ud =pass]
@@ -154,7 +154,7 @@ Public key data for a particular ship. The `rift` is the current continuity brea
154
154
155An update to a ship's keys. The `life` is the key revision number, `crypt-suite` is a version number for the cryptographic suite used for keys in Azimuth, and `pass` is the public key itself.
155An update to a ship's keys. The `life` is the key revision number, `crypt-suite` is a version number for the cryptographic suite used for keys in Azimuth, and `pass` is the public key itself.
156
156
157−## `$diffs:point`
157+### `$diffs:point`
158
158
159```hoon
159```hoon
160+$ diffs (list diff)
160+$ diffs (list diff)
@@ -162,7 +162,7 @@ An update to a ship's keys. The `life` is the key revision number, `crypt-suite`
162
162
163A list of invertible [$diff:point](#diff-point)s.
163A list of invertible [$diff:point](#diff-point)s.
164
164
165−## `$diff:point`
165+### `$diff:point`
166
166
167```hoon
167```hoon
168+$ diff
168+$ diff
@@ -180,7 +180,7 @@ An invertible diff for public key (and related) changes to the state of an Azimu
180
180
181The `from` and `to` field specify the old a new values respectively.
181The `from` and `to` field specify the old a new values respectively.
182
182
183−## `$udiffs:point`
183+### `$udiffs:point`
184
184
185```hoon
185```hoon
186+$ udiffs (list [=ship =udiff])
186+$ udiffs (list [=ship =udiff])
@@ -188,7 +188,7 @@ The `from` and `to` field specify the old a new values respectively.
188
188
189A list of non-invertible [$udiff:point](#udiff-point)s.
189A list of non-invertible [$udiff:point](#udiff-point)s.
190
190
191−## `$udiff:point`
191+### `$udiff:point`
192
192
193```hoon
193```hoon
194+$ udiff
194+$ udiff
@@ -211,11 +211,11 @@ The [$id:block](#id-block) contains the block number and block hash of the Ether
211
211
212A `udiff:point` can be converted to a [$diff:point](#diff-point) with the `+udiff-to-diff:point` function.
212A `udiff:point` can be converted to a [$diff:point](#diff-point) with the `+udiff-to-diff:point` function.
213
213
214−# pki
214+## pki
215
215
216This structure is mostly a holdover from prior versions of Jael and is unused apart from [$oath:pki](#oath-pki).
216This structure is mostly a holdover from prior versions of Jael and is unused apart from [$oath:pki](#oath-pki).
217
217
218−## `$hand:pki`
218+### `$hand:pki`
219
219
220```hoon
220```hoon
221+$ hand @uvH
221+$ hand @uvH
@@ -223,7 +223,7 @@ This structure is mostly a holdover from prior versions of Jael and is unused ap
223
223
224128-bit Hash.
224128-bit Hash.
225
225
226−## `$mind:pki`
226+### `$mind:pki`
227
227
228```hoon
228```hoon
229+$ mind [who=ship lyf=life]
229+$ mind [who=ship lyf=life]
@@ -231,7 +231,7 @@ This structure is mostly a holdover from prior versions of Jael and is unused ap
231
231
232Key identifier.
232Key identifier.
233
233
234−## `$name:pki`
234+### `$name:pki`
235
235
236```hoon
236```hoon
237+$ name (pair @ta @t)
237+$ name (pair @ta @t)
@@ -239,7 +239,7 @@ Key identifier.
239
239
240Name in both ASCII and Unicode.
240Name in both ASCII and Unicode.
241
241
242−## `$oath:pki`
242+### `$oath:pki`
243
243
244```hoon
244```hoon
245+$ oath @
245+$ oath @