9bc6d01 · urbit.org · git.iko.soy

git.iko.soy/urbit.org

scry: remove contents and fix headers

9bc6d01tinnus-napbus5 years ago

content/docs/arvo/jael/scry.md+30−48

@@ -6,106 +6,88 @@ template = "doc.html"

7Jael's scry endpoints never take a `care`. The particular endpoints are specified in the place of the desk in the path prefix, then additional arguments are specified in the path. Note this style of scry path is considered outdated, and may be changed in the future.

9−# Contents

10−

11−- [step](#step) - Web login code revision number.

12−- [code](#code) - Web login code.

13−- [life](#life) - Key revision number (`life`).

14−- [lyfe](#lyfe) - Unitised `life`.

15−- [rift](#rift) - Continuity number (`rift`).

16−- [ryft](#ryft) - Unitised `rift`.

17−- [vein](#vein) - Private key.

18−- [vile](#vile) - Jammed `seed` boot parameters.

19−- [deed](#deed) - Public key and related details.

20−- [earl](#earl) - Derive moon keys.

21−- [sein](#sein) - Sponsor.

22−- [saxo](#saxo) - Sponsorship chain.

23−- [subscriptions](#subscriptions) - Public key trackers.

24−- [sources](#sources) - PKI sources.

25−- [turf](#turf) - Galaxy domain prefixes.

26−

27−# `%step`

9+## `%step`

29A `%step` scry gets the current web login code revision number. It takes your ship name as its `path` and the type returned is a `@ud`.

11A `%step` scry gets the current web login code revision number. It takes your ship name as its `path` and the type returned is a `@ud`.

31−## Example

13+### Example

33```

15```

34> .^(@ud %j /=step=/(scot %p our))

16> .^(@ud %j /=step=/(scot %p our))

350

170

36```

18```

38−# `%code`

20+## `%code`

40A `%code` scry gets the current web login code. It takes your ship name as its `path` and the type returned is a `@p`.

22A `%code` scry gets the current web login code. It takes your ship name as its `path` and the type returned is a `@p`.

42−## Example

24+### Example

44```

26```

45> .^(@p %j /=code=/(scot %p our))

27> .^(@p %j /=code=/(scot %p our))

46~lidlut-tabwed-pillex-ridrup

28~lidlut-tabwed-pillex-ridrup

47```

29```

49−# `%life`

31+## `%life`

51A `%life` scry gets the current `life` (key revision number) of a ship if known, otherwise it crashes. It takes a ship as its `path` and the type returned is a `@ud`.

33A `%life` scry gets the current `life` (key revision number) of a ship if known, otherwise it crashes. It takes a ship as its `path` and the type returned is a `@ud`.

53−## Example

35+### Example

55```

37```

56> .^(@ud %j /=life=/(scot %p our))

38> .^(@ud %j /=life=/(scot %p our))

571

391

58```

40```

60−# `%lyfe`

42+## `%lyfe`

62A `%lyfe` scry gets the current unitized `life` (key revision number) of a ship if known, otherwise returns `~`. It takes a ship as its `path` and the type returned is a `(unit @ud)`.

44A `%lyfe` scry gets the current unitized `life` (key revision number) of a ship if known, otherwise returns `~`. It takes a ship as its `path` and the type returned is a `(unit @ud)`.

64−## Example

46+### Example

66```

48```

67> .^((unit @ud) %j /=lyfe=/(scot %p our))

49> .^((unit @ud) %j /=lyfe=/(scot %p our))

68[~ 1]

50[~ 1]

69```

51```

71−# `%rift`

53+## `%rift`

73A `%rift` scry gets the current `rift` (continuity number) of a ship if known, otherwise it crashes. It takes a ship as its `path` and the type returned is a `@ud`.

55A `%rift` scry gets the current `rift` (continuity number) of a ship if known, otherwise it crashes. It takes a ship as its `path` and the type returned is a `@ud`.

75−## Example

57+### Example

77```

59```

78.^(@ud %j /=rift=/(scot %p our))

60.^(@ud %j /=rift=/(scot %p our))

791

611

80```

62```

82−# `%ryft`

64+## `%ryft`

84A `%ryft` scry gets the current unitized `rift` (continuity number) of a ship if known, otherwise it returns `~`. It takes a ship as its `path` and the type returned is a `(unit @ud)`.

66A `%ryft` scry gets the current unitized `rift` (continuity number) of a ship if known, otherwise it returns `~`. It takes a ship as its `path` and the type returned is a `(unit @ud)`.

86−## Example

68+### Example

88```

70```

89> .^((unit @ud) %j /=ryft=/(scot %p our))

71> .^((unit @ud) %j /=ryft=/(scot %p our))

90[~ 1]

72[~ 1]

91```

73```

93−# `%vein`

75+## `%vein`

95A `%vein` scry gets your ship's private key for the specified `life`. It takes a `life` `@ud` as its `path` and the type returned is a `ring`.

77A `%vein` scry gets your ship's private key for the specified `life`. It takes a `life` `@ud` as its `path` and the type returned is a `ring`.

97−## Example

79+### Example

99```

81```

100> .^(@uw %j /=vein=/1)

82> .^(@uw %j /=vein=/1)

1010w84.0MwlQ.y2Ly9.6HVmH.8SYwo.EvuLC.f5YRw.T2NzD.EHtjZ.gpHZb.J0Pu5.aTGVL.UugSA.EZ~E9.~PODC.cohVD.B1zWj.ZWnJ2

830w84.0MwlQ.y2Ly9.6HVmH.8SYwo.EvuLC.f5YRw.T2NzD.EHtjZ.gpHZb.J0Pu5.aTGVL.UugSA.EZ~E9.~PODC.cohVD.B1zWj.ZWnJ2

102```

84```

103

104−# `%vile`

86+## `%vile`

105

106A `%vile` scry gets your `jam`mmed private boot parameters at your ship's current `life`. It takes no additional arguments in its `path`. The type returned is a `@` which is a `jam`med [$seed](@/docs/arvo/jael/data-types.md#seed).

88A `%vile` scry gets your `jam`mmed private boot parameters at your ship's current `life`. It takes no additional arguments in its `path`. The type returned is a `@` which is a `jam`med [$seed](@/docs/arvo/jael/data-types.md#seed).

107

108−## Examples

90+### Examples

109

110```

92```

111> .^(@ %j /=vile=)

93> .^(@ %j /=vile=)

@@ -122,11 +104,11 @@ A `%vile` scry gets your `jam`mmed private boot parameters at your ship's curren

122]

104]

123```

105```

124

106

125−# `%deed`

107+## `%deed`

126

108

127A `%deed` scry gets the `life`, pubkey and maybe a signature if the ship in question is a comet. It takes the target ship and life as its `path` like `/~sampel-palnet/1` and the type returned is a `[life pass (unit @ux)]`.

109A `%deed` scry gets the `life`, pubkey and maybe a signature if the ship in question is a comet. It takes the target ship and life as its `path` like `/~sampel-palnet/1` and the type returned is a `[life pass (unit @ux)]`.

128

110

129−## Example

111+### Example

130

112

131```

113```

132> .^([life pass (unit @ux)] %j /=deed=/(scot %p our)/1)

114> .^([life pass (unit @ux)] %j /=deed=/(scot %p our)/1)

@@ -136,11 +118,11 @@ A `%deed` scry gets the `life`, pubkey and maybe a signature if the ship in ques

136]

118]

137```

119```

138

120

139−# `%earl`

121+## `%earl`

140

122

141A `%earl` scry deterministically derives a private key for a moon. Note this is a holdover from an old version of moon infrastructure, the current `|moon` generator doesn't use this and instead generates moon private keys non-deterministically. It takes the moon name and your ship's current `life` (not the moon's `life`) as its `path` like `/~doznec-dozzod-dozzod-dozzod/1`. The type returned is a [$seed](@/docs/arvo/jael/data-types.md#seed), the `life` of the moon in the `lyf` field of the `seed` will always be `1`.

123A `%earl` scry deterministically derives a private key for a moon. Note this is a holdover from an old version of moon infrastructure, the current `|moon` generator doesn't use this and instead generates moon private keys non-deterministically. It takes the moon name and your ship's current `life` (not the moon's `life`) as its `path` like `/~doznec-dozzod-dozzod-dozzod/1`. The type returned is a [$seed](@/docs/arvo/jael/data-types.md#seed), the `life` of the moon in the `lyf` field of the `seed` will always be `1`.

142

124

143−## Example

125+### Example

144

126

145```

127```

146> .^(seed:jael %j /=earl=/~doznec-dozzod-dozzod-dozzod/1)

128> .^(seed:jael %j /=earl=/~doznec-dozzod-dozzod-dozzod/1)

@@ -152,29 +134,29 @@ A `%earl` scry deterministically derives a private key for a moon. Note this is

152]

134]

153```

135```

154

136

155−# `%sein`

137+## `%sein`

156

138

157A `%sein` scry gets the sponsor for the specified ship. This scry is used implicitly by `sein:title`. It takes the target ship as its `path` and the type returned is a `@p`.

139A `%sein` scry gets the sponsor for the specified ship. This scry is used implicitly by `sein:title`. It takes the target ship as its `path` and the type returned is a `@p`.

158

140

159−## Example

141+### Example

160

142

161```

143```

162> .^(@p %j /=sein=/~sampel-palnet)

144> .^(@p %j /=sein=/~sampel-palnet)

163~talpur

145~talpur

164```

146```

165

147

166−# `%saxo`

148+## `%saxo`

167

149

168A `%saxo` scry gets the sponsorship chain for the target ship (including the target ship itself). For example, a `%saxo` scry for a planet will return the planet, its star and the star's galaxy. This scry is used implicitly by `saxo:title`. It takes the target ship as its `path` and the type returned is a `(list @p)`.

150A `%saxo` scry gets the sponsorship chain for the target ship (including the target ship itself). For example, a `%saxo` scry for a planet will return the planet, its star and the star's galaxy. This scry is used implicitly by `saxo:title`. It takes the target ship as its `path` and the type returned is a `(list @p)`.

169

151

170−## Example

152+### Example

171

153

172```

154```

173> .^((list @p) %j /=saxo=/~sampel-palnet)

155> .^((list @p) %j /=saxo=/~sampel-palnet)

174~[~sampel-palnet ~talpur ~pur]

156~[~sampel-palnet ~talpur ~pur]

175```

157```

176

158

177−# `%subscriptions`

159+## `%subscriptions`

178

160

179A `%subscriptions` scry gets the current state of subscriptions to public key updates (typically initiated with a [%public-keys task](@/docs/arvo/jael/tasks.md#public-keys)). It takes a `life` as its `path` and returns a triple consisting of the following:

161A `%subscriptions` scry gets the current state of subscriptions to public key updates (typically initiated with a [%public-keys task](@/docs/arvo/jael/tasks.md#public-keys)). It takes a `life` as its `path` and returns a triple consisting of the following:

180

162

@@ -186,18 +168,18 @@ nel=(set duct) :: trackers of all

186

168

187The `yen` `jug` maps subscribed `duct`s to the `ship`s they're tracking, and `ney` is just the inverse, mapping tracked `ship`s to subscribed `duct`s. The `nel` set contains `duct`s track all public key updates.

169The `yen` `jug` maps subscribed `duct`s to the `ship`s they're tracking, and `ney` is just the inverse, mapping tracked `ship`s to subscribed `duct`s. The `nel` set contains `duct`s track all public key updates.

188

170

189−## Example

171+### Example

190

172

191```

173```

192.^([yen=(jug duct ship) ney=(jug ship duct) nel=(set duct)] %j /=subscriptions=/1)

174.^([yen=(jug duct ship) ney=(jug ship duct) nel=(set duct)] %j /=subscriptions=/1)

193[yen={} ney={} nel={}]

175[yen={} ney={} nel={}]

194```

176```

195

177

196−# `%sources`

178+## `%sources`

197

179

198A `%sources` scry gets the current state of Jael's sources for PKI updates. It takes no additional arguments in its `path` and returns a [$state-eth-node](@/docs/arvo/jael/data-types.md#state-eth-node).

180A `%sources` scry gets the current state of Jael's sources for PKI updates. It takes no additional arguments in its `path` and returns a [$state-eth-node](@/docs/arvo/jael/data-types.md#state-eth-node).

199

181

200−## Example

182+### Example

201

183

202```

184```

203> .^(state-eth-node:jael %j /=sources=)

185> .^(state-eth-node:jael %j /=sources=)

@@ -210,11 +192,11 @@ A `%sources` scry gets the current state of Jael's sources for PKI updates. It t

210]

192]

211```

193```

212

194

213−# `%turf`

195+## `%turf`

214

196

215A `%turf` scry gets the list of domain prefixes for galaxies. It takes no additional arguments in its `path`. It returns a `(list turf)`, where a `turf` is a TLD-first `(list @t)`, so `urbit.org` as a `turf` is `~['org' 'urbit']`.

197A `%turf` scry gets the list of domain prefixes for galaxies. It takes no additional arguments in its `path`. It returns a `(list turf)`, where a `turf` is a TLD-first `(list @t)`, so `urbit.org` as a `turf` is `~['org' 'urbit']`.

216

198

217−## Example

199+### Example

218

200

219```

201```

220> .^((list turf) %j /=turf=)

202> .^((list turf) %j /=turf=)