on master help sign in
data-types: fix headers
commitc25d308d9c24224ddbdc0a28dad3b27e73746db9 authortinnus-napbus <admin@tinnus-napbus.xyz> dateWed 28 Jul 2021, 23:48 (5 years ago) parent9bc6d01
1 file changed+23−23
content/docs/arvo/jael/data-types.md+23−23
content/docs/arvo/jael/data-types.md+23−23
@@ -11,7 +11,7 @@ Jael's section in `lull.hoon` contains three ancillary cores with their own type
1111- [point:jael](#point) - Structures for points (Ship IDs in Azimuth).
1212- [pki:jael](#pki) - Largely unused apart from [$oath:pki](#oath-pki).
1313
14−## `$public-keys-result`
14+### `$public-keys-result`
1515
1616```hoon
1717+$ public-keys-result
@@ -25,7 +25,7 @@ This is what Jael gives (in a [%public-keys](@/docs/arvo/jael/tasks.md#public-ke
2525
2626Typically 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.
2727
28−## `$seed`
28+### `$seed`
2929
3030```hoon
3131+$ 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
3333
3434Private 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.
3535
36−## `$dawn-event`
36+### `$dawn-event`
3737
3838```hoon
3939+$ dawn-event
@@ -55,7 +55,7 @@ Ship initialisation parameters.
5555- `bloq` is the number of the Ethereum block in which the ship registered its keys with the Azimuth smart contract.
5656- `node` is the URL of the Ethereum node used to monitor Azimuth.
5757
58−## `$source`
58+### `$source`
5959
6060```hoon
6161+$ source (each ship term)
@@ -63,7 +63,7 @@ Ship initialisation parameters.
6363
6464Source 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.
6565
66−## `$source-id`
66+### `$source-id`
6767
6868```hoon
6969+$ 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 `%
7171
7272Numerical index for Jael to organise its `source`s. Jael assigns its `source-id`s sequentially, starting from `0`.
7373
74−## `$state-eth-node`
74+### `$state-eth-node`
7575
7676```hoon
7777+$ state-eth-node :: node config + meta
@@ -93,11 +93,11 @@ Jael's data about `source`s for PKI updates about ships.
9393- `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.
9494- `ship-sources-reverse` is the same as `ship-sources` but in reverse.
9595
96−# block
96+## block
9797
9898Structures for Ethereum blocks.
9999
100−## `$hash:block`
100+### `$hash:block`
101101
102102```hoon
103103+$ hash @uxblockhash
@@ -105,7 +105,7 @@ Structures for Ethereum blocks.
105105
106106Ethereum block hash.
107107
108−## `$number:block`
108+### `$number:block`
109109
110110```hoon
111111+$ number @udblocknumber
@@ -113,7 +113,7 @@ Ethereum block hash.
113113
114114Ethereum block number.
115115
116−## `$id:block`
116+### `$id:block`
117117
118118```hoon
119119+$ id [=hash =number]
@@ -121,7 +121,7 @@ Ethereum block number.
121121
122122Ethereum block identifier - contains both the [$hash:block](#hash-block) and [$number:block](#number-block).
123123
124−## `$block:block`
124+### `$block:block`
125125
126126```hoon
127127+$ block [=id =parent=hash]
@@ -129,11 +129,11 @@ Ethereum block identifier - contains both the [$hash:block](#hash-block) and [$n
129129
130130A reference to an Ethereum block - contains the [$id:block](#id-block) and the [$hash:block](#hash-block) of its parent for ordering purposes.
131131
132−# point
132+## point
133133
134134Structures for points (Ship IDs in Azimuth).
135135
136−## `$point:point`
136+### `$point:point`
137137
138138```hoon
139139+$ point
@@ -146,7 +146,7 @@ Structures for points (Ship IDs in Azimuth).
146146
147147Public 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.
148148
149−## `$key-update:point`
149+### `$key-update:point`
150150
151151```hoon
152152+$ 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
154154
155155An 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.
156156
157−## `$diffs:point`
157+### `$diffs:point`
158158
159159```hoon
160160+$ diffs (list diff)
@@ -162,7 +162,7 @@ An update to a ship's keys. The `life` is the key revision number, `crypt-suite`
162162
163163A list of invertible [$diff:point](#diff-point)s.
164164
165−## `$diff:point`
165+### `$diff:point`
166166
167167```hoon
168168+$ diff
@@ -180,7 +180,7 @@ An invertible diff for public key (and related) changes to the state of an Azimu
180180
181181The `from` and `to` field specify the old a new values respectively.
182182
183−## `$udiffs:point`
183+### `$udiffs:point`
184184
185185```hoon
186186+$ udiffs (list [=ship =udiff])
@@ -188,7 +188,7 @@ The `from` and `to` field specify the old a new values respectively.
188188
189189A list of non-invertible [$udiff:point](#udiff-point)s.
190190
191−## `$udiff:point`
191+### `$udiff:point`
192192
193193```hoon
194194+$ udiff
@@ -211,11 +211,11 @@ The [$id:block](#id-block) contains the block number and block hash of the Ether
211211
212212A `udiff:point` can be converted to a [$diff:point](#diff-point) with the `+udiff-to-diff:point` function.
213213
214−# pki
214+## pki
215215
216216This structure is mostly a holdover from prior versions of Jael and is unused apart from [$oath:pki](#oath-pki).
217217
218−## `$hand:pki`
218+### `$hand:pki`
219219
220220```hoon
221221+$ hand @uvH
@@ -223,7 +223,7 @@ This structure is mostly a holdover from prior versions of Jael and is unused ap
223223
224224128-bit Hash.
225225
226−## `$mind:pki`
226+### `$mind:pki`
227227
228228```hoon
229229+$ mind [who=ship lyf=life]
@@ -231,7 +231,7 @@ This structure is mostly a holdover from prior versions of Jael and is unused ap
231231
232232Key identifier.
233233
234−## `$name:pki`
234+### `$name:pki`
235235
236236```hoon
237237+$ name (pair @ta @t)
@@ -239,7 +239,7 @@ Key identifier.
239239
240240Name in both ASCII and Unicode.
241241
242−## `$oath:pki`
242+### `$oath:pki`
243243
244244```hoon
245245+$ oath @