c162441 · urbit.org · git.iko.soy

git.iko.soy/urbit.org

layer2 folder

commitc162441d18b4a1abf3c5cd0353ab74fce26327ed authordrbeefsupreme <drbeefsupreme@discordja.net> dateThu 7 Oct 2021, 12:56 (5 years ago) parentdddfb59

12 files changed+27−68

compare with master

unifiedsplit

content/docs/azimuth/_index.md+3−3

@@ -37,7 +37,7 @@ of cryptocurrency.

3737A high-level technical description of the functionality of the naive rollups

3838"Hoon smart contract" and associated apps, such as Bridge and the roller.

3939

40−### [Layer 2 Actions](/docs/azimuth/l2-actions)

40+### [Layer 2 Actions](/docs/azimuth/l2/l2-actions)

4141

4242An exhaustive list of what Azimuth actions can be performed for any given tuple

4343`(ship rank, layer 2 status)`.

@@ -47,11 +47,11 @@ An exhaustive list of what Azimuth actions can be performed for any given tuple

4747Diagrams and explanations of how data flows between Bridge and the various

4848components inside Urbit involved with layer 2.

4949

50−### [Bytestrings](/docs/azimuth/bytestring)

50+### [Bytestrings](/docs/azimuth/l2/bytestring)

5151

5252The bytestring format for layer 2 transactions and batches.

5353

54−### [Roller HTTP RPC API](/docs/azimuth/layer2-api)

54+### [Roller HTTP RPC API](/docs/azimuth/l2/layer2-api)

5555

5656Documentation on the HTTP RPC API used for Urbit to communicate with Bridge to

5757manage layer 2 transactions.

content/docs/azimuth/azimuth-eth.md+2−2

@@ -149,8 +149,8 @@ able to set its own domain name and so we do not expect this to remain the case

149149forever.

150150

151151All data in this ledger is stored and processed locally on your ship by the

152−[`%azimuth` Gall agent](/docs/azimuth/l2-flow#azimuth), including [layer

153−2](/docs/azimuth/layer2) data. Because state transitions resulting from layer 2

152+[`%azimuth` Gall agent](/docs/azimuth/l2/l2-flow#azimuth), including [layer

153+2](/docs/azimuth/l2/layer2) data. Because state transitions resulting from layer 2

154154transactions are not included in this ledger, in general the local store will

155155differ from what is kept in Azimuth.eth.

156156

content/docs/azimuth/azimuth.md+2−2

@@ -30,7 +30,7 @@ with a system of scarce and immutable identities.

3030**Azimuth** is the public-key infrastructure built to be a system of scarce and

3131immutable identities. It consists of a suite of [smart contracts on the Ethereum

3232blockchain](https://github.com/urbit/azimuth) as well as [several

33−apps](/docs/azimuth/l2-flow) run locally on your urbit. Togeter, they determine

33+apps](/docs/azimuth/l2/l2-flow) run locally on your urbit. Togeter, they determine

3434which Ethereum addresses own which Urbit ID's as well as the public keys needed

3535to communicate with those ID's. All identity-related operations, such as

3636transfers, are governed by Azimuth. Azimuth isn't built strictly for Arvo -- the

@@ -103,7 +103,7 @@ a roller to submit single transactions results in significant savings.

103103A casual overview of the naive rollups system can be found on the

104104[blog](/blog/rollups) as well as the Pilot's Manual (insert link). Developers

105105are encouraged to read our Layer 2 documentation, starting with the [Layer 2

106−Overview](/docs/azimuth/layer2).

106+Overview](/docs/azimuth/l2/layer2).

107107

108108## Other resources {#other}

109109

content/docs/azimuth/contract.mddeleted−41

@@ -1,41 +0,0 @@

1−+++

2−title = "Smart Contracts"

3−weight = 4

4−template = "doc.html"

5−+++

6−

7−This document summarizes the Ethereum smart contracts that

8−govern Azimuth, as well as presents some raw data about them.

9−

10−Azimuth consists of the following smart contracts:

11−

12− - [Azimuth.eth](https://etherscan.io/address/azimuth.eth)

13− `0x223c067f8cf28ae173ee5cafea60ca44c335fecb`: contains all on-chain state for

14− Azimuth. Most notably, ownership and public keys. Can't be modified directly,

15− you must use the Ecliptic.

16− - [Ecliptic.eth](https://etherscan.io/address/ecliptic.eth):

17− `0x9ef27de616154FF8B38893C59522b69c7Ba8A81c ` is used as an interface for

18− interacting with your points on-chain. Allows you to configure keys, transfer

19− ownership, etc.

20− - [Polls](https://etherscan.io/address/0x7fecab617c868bb5996d99d95200d2fa708218e4):

21− `0x7fecab617c868bb5996d99d95200d2fa708218e4` registers votes by the Galactic

22− Senate on proposals. These can be either static documents or Ecliptic

23− upgrades.

24− - [Linear Star

25− Release](https://etherscan.io/address/0x86cd9cd0992f04231751e3761de45cecea5d1801):

26− facilitates the release of blocks of stars to their owners over a period of

27− time.

28− - [Conditional Star

29− Release](https://etherscan.io/address/0x8c241098c3d3498fe1261421633fd57986d74aea):

30− `0x8c241098c3d3498fe1261421633fd57986d74aea` facilitates the release of

31− blocks of stars to their owners based on milestones.

32− - [Claims](https://etherscan.io/address/0xe7e7f69b34d7d9bd8d61fb22c33b22708947971a):

33− `0xe7e7f69b34d7d9bd8d61fb22c33b22708947971a` allows point owners to make

34− claims about (for example) their identity, and associate that with their

35− point.

36− - [Censures](https://etherscan.io/address/0x325f68d32bdee6ed86e7235ff2480e2a433d6189):

37− `0x325f68d32bdee6ed86e7235ff2480e2a433d6189` simple reputation management,

38− allowing galaxies and stars to flag points for negative reputation.

39− - [Delegated

40− Sending](https://etherscan.io/address/0xf6b461fe1ad4bd2ce25b23fe0aff2ac19b3dfa76):

41− enables network-effect like distributing of planets.

content/docs/azimuth/ecliptic.md+4−4

@@ -36,7 +36,7 @@ detection.

3636

3737There are currently [28 functions](#write) which may be called to write to

3838the Ecliptic, and [17 functions](#read) to read data from the Ecliptic. Many of these

39−have a corresponding [layer 2 action](/docs/azimuth/l2-actions), and/or can be

39+have a corresponding [layer 2 action](/docs/azimuth/l2/l2-actions), and/or can be

4040performed using [Bridge](/using/id/using-bridge). We note these facts where

4141applicable.

4242

@@ -179,7 +179,7 @@ Requirements:

179179Corresponds to the layer 2 `%detach` action.

180180

181181Unlike all other layer 1 actions, layer 1 sponsors may use a layer 1 `detach` on

182−a layer 2 sponsee. See the [Layer 2](/docs/azimuth/layer2#sponsorship) section

182+a layer 2 sponsee. See the [Layer 2](/docs/azimuth/l2/layer2#sponsorship) section

183183for more detail.

184184

185185### Proxy management {#proxies}

@@ -377,7 +377,7 @@ standard functions that are part of the ERC-721 or ERC-165 interfaces.

377377

378378#### `depositAddress`

379379

380−This returns the deposit address for [layer 2](/docs/azimuth/layer2), which is

380+This returns the deposit address for [layer 2](/docs/azimuth/l2/layer2), which is

381381`0x1111111111111111111111111111111111111111`. Ships sent to this address are

382382controlled on layer 2 instead of via Ecliptic.

383383

@@ -426,5 +426,5 @@ Release](https://etherscan.io/address/0x8c241098c3d3498fe1261421633fd57986d74aea

426426

427427Beginning in 2019, stars may spawn at most 1024 planets. This limit doubles for

428428every subsequent year. However, this limit is not currently implemented on

429−[Layer 2](/docs/azimuth/layer2).

429+[Layer 2](/docs/azimuth/l2/layer2).

430430

content/docs/azimuth/bytestring.md → content/docs/azimuth/l2/bytestring.mdrenamed+1−1

@@ -6,7 +6,7 @@ template = "doc.html"

77This document gives the bytestring format for layer 2 transactions and batches.

9−[Recall](/docs/azimuth/layer2.md) that a layer 2 transaction is a compact

9+[Recall](/docs/azimuth/l2/layer2.md) that a layer 2 transaction is a compact

1010representation of an Azimuth action whose format will be given below, along with

1111a 65-byte ECDSA signature. A `batch` is an atom that is a concatenation of one or more

1212layer 2 transactions. This atom is what is posted on the Ethereum blockchain by

content/docs/azimuth/l2-actions.md → content/docs/azimuth/l2/l2-actions.mdrenamed+1−1

@@ -48,7 +48,7 @@ A planet in dominion `%l1` is said to exist on layer 1, which is the default

4848state for all planets prior to the introduction of naive rollups. In addition to

4949the ordinary layer 1 Azimuth actions a planet can perform, they may also choose to

5050`%escape` or `%cancel-escape` on layer 2 using either their ownership key or

51−[management proxy](/docs/glossary/proxies). See the [layer 2 sponsorship](/docs/azimuth/layer2#sponsorship)

51+[management proxy](/docs/glossary/proxies). See the [layer 2 sponsorship](/docs/azimuth/l2/layer2#sponsorship)

5252section for more information on layer 1 ships performing layer 2

5353sponsorship actions.

5454

content/docs/azimuth/l2-flow.md → content/docs/azimuth/l2/l2-flow.mdrenamed+5−5

@@ -144,7 +144,7 @@ calls, typically sent from other Urbit ID users via Bridge. It then translates

144144these API calls from JSON to a format understood by `%roller` and

145145forwards them. This app

146146does not keep any state - its only purpose is to act as an intermediary between

147−Bridge and `%roller`. See [here](/docs/azimuth/layer2-api) for more

147+Bridge and `%roller`. See [here](/docs/azimuth/l2/layer2-api) for more

148148information on the JSON RPC-API.

149149

150150### `naive.hoon` {#naive}

@@ -154,7 +154,7 @@ information on the JSON RPC-API.

154154transition function which updates the state of the PKI stored in `azimuth.hoon`

155155which handles state transitions caused by both layer 1 and layer 2 transactions.

156156A high-level overview of how `naive.hoon` functions can be found

157−[here](/docs/azimuth/layer2#layer-2).

157+[here](/docs/azimuth/l2/layer2#layer-2).

158158

159159A `verifier` is any gate of the form

160160

@@ -165,10 +165,10 @@ A `verifier` is any gate of the form

165165The `verifier` in use by `naive.hoon` runs the keccak hash function on `dat` to

166166verify that `dat` is data signed by the ECDSA signature given by the `[v r s]`

167167tuple, according to the format for signed transactions outlined in the

168−[bytestring format](/docs/azimuth/bytestring) documentation.

168+[bytestring format](/docs/azimuth/l2/bytestring) documentation.

169169

170170`chain-id` is the ID used by the Ethereum blockchain, which is `1337`. See [bytestring

171−format](/docs/azimuth/bytestring) for more information.

171+format](/docs/azimuth/l2/bytestring) for more information.

172172

173173`state` is the current state of the PKI:

174174

@@ -209,7 +209,7 @@ format](/docs/azimuth/bytestring) for more information.

209209`points` should be self-explanatory if you are already familiar with the

210210structure of Urbit ID. The only new addition is `dominion`, which is a record of

211211whether a ship is on layer 1, layer 2, or layer 1 with a layer 2 spawn proxy.

212−See [Layer 2 actions](/docs/azimuth/l2-actions) for an overview of how

212+See [Layer 2 actions](/docs/azimuth/l2/l2-actions) for an overview of how

213213`dominion` determines the actions available to a ship.

214214

215215`operators` already existed on layer 1 and are defined as a part of the [ERC-721

content/docs/azimuth/layer2-api.md → content/docs/azimuth/l2/layer2-api.mdrenamed

The content is the same.

content/docs/azimuth/layer2.md → content/docs/azimuth/l2/layer2.mdrenamed+4−4

@@ -18,7 +18,7 @@ to either transfer their ship to layer 2 or perform layer 2 actions. For that,

1818see ((bridge documentation yet to be written)). For a casual overview of the

1919rationale and functionality of layer 2, please see this [blog

2020post](/blog/rollups). For more information on how Azimuth works more generally,

21−including interactions with Bridge and Ethereum, see the page on [Azimuth data flow](/docs/azimuth/l2-flow).

21+including interactions with Bridge and Ethereum, see the page on [Azimuth data flow](/docs/azimuth/l2/l2-flow).

2222

2323This page is also not where to find instruction on how to run your own "aggregator"/"roller".

2424Documentation for this process is forthcoming. However, this page does contain

@@ -127,8 +127,8 @@ can also perform a subset of layer 2 actions - namely the ones related to

127127sponsorship.

128128

129129For a complete list of what layer 2 actions each ship rank, layer, and proxy can

130−perform, see [Layer 2 Actions](/docs/azimuth/l2-actions). For an explicit

131−description of the byte format of Layer 2 Ethereum transaction, see [Bytestring format](/docs/azimuth/bytestring).

130+perform, see [Layer 2 Actions](/docs/azimuth/l2/l2-actions). For an explicit

131+description of the byte format of Layer 2 Ethereum transaction, see [Bytestring format](/docs/azimuth/l2/bytestring).

132132

133133### Sponsorship {#sponsorship}

134134

@@ -207,7 +207,7 @@ sponsor of `~sampel-palnet` was `~marzod` before `~sampel-palnet` was deposited

207207to layer 2, and thus the Azimuth PKI on Ethereum will forever reflect this.

208208

209209For more information on how Azimuth state is handled, including how this

210−integrates with Bridge and Ethereum, see [Azimuth data flow](/docs/azimuth/l2-flow).

210+integrates with Bridge and Ethereum, see [Azimuth data flow](/docs/azimuth/l2/l2-flow).

211211

212212### Sponsorship state transitions

213213

content/docs/azimuth/roller.md → content/docs/azimuth/l2/roller.mdrenamed+4−4

@@ -30,14 +30,14 @@ for detailed information on the API.

3030

3131`%roller` is the Gall agent which collects layer 2 Azimuth **transactions**, which

3232are a concatenation of an

33−[action](/docs/azimuth/bytestrings#actions) and a

34−[signature](/docs/azimuth/bytestrings#signatures) and forms them into

35−[batches](/docs/azimuth/bytestrings#batch) to be submitted periodically to the

33+[action](/docs/azimuth/l2/bytestrings#actions) and a

34+[signature](/docs/azimuth/l2/bytestrings#signatures) and forms them into

35+[batches](/docs/azimuth/l2/bytestrings#batch) to be submitted periodically to the

3636Ethereum blockchain.

3737

3838### Transaction format

3939

40−See [Bytestring Format](/docs/azimuth/bytestring) for a technical description of

40+See [Bytestring Format](/docs/azimuth/l2/bytestring) for a technical description of

4141how layer 2 transactions are formatted.

4242

4343### Pending transactions

content/docs/glossary/rollups.md+1−1

@@ -26,5 +26,5 @@ blockchains.

2626- [The Gang Solves the Gas Crisis](/blog/rollups): A casual overview of how

2727naive rollups works.

2828- Pilot's Guide to layer 2 : insert link

29−- [Layer 2 Overview](/docs/azimuth/layer2): where developers should go to learn

29+- [Layer 2 Overview](/docs/azimuth/l2/layer2): where developers should go to learn

3030about the technical details of naive rollups.