bitcoin-computer · ClemensLey · May 25, 2024 · May 25, 2024 · May 25, 2024 · May 25, 2024
diff --git a/packages/docs/Examples/index.yml b/packages/docs/Examples/index.yml
@@ -1,2 +1,3 @@
 order: -50
 icon: apps
+expanded: true
diff --git a/packages/docs/API/broadcast.md → packages/docs/Lib/broadcast.md b/packages/docs/API/broadcast.md → packages/docs/Lib/broadcast.md
diff --git a/packages/docs/API/constructor.md → packages/docs/Lib/constructor.md b/packages/docs/API/constructor.md → packages/docs/Lib/constructor.md
diff --git a/packages/docs/API/decode.md → packages/docs/Lib/decode.md b/packages/docs/API/decode.md → packages/docs/Lib/decode.md
diff --git a/packages/docs/API/deploy.md → packages/docs/Lib/deploy.md b/packages/docs/API/deploy.md → packages/docs/Lib/deploy.md
diff --git a/packages/docs/API/encode.md → packages/docs/Lib/encode.md b/packages/docs/API/encode.md → packages/docs/Lib/encode.md
diff --git a/packages/docs/API/encodeCall.md → packages/docs/Lib/encodeCall.md b/packages/docs/API/encodeCall.md → packages/docs/Lib/encodeCall.md
diff --git a/packages/docs/API/encodeNew.md → packages/docs/Lib/encodeNew.md b/packages/docs/API/encodeNew.md → packages/docs/Lib/encodeNew.md
diff --git a/packages/docs/API/faucet.md → packages/docs/Lib/faucet.md b/packages/docs/API/faucet.md → packages/docs/Lib/faucet.md
diff --git a/packages/docs/API/fund.md → packages/docs/Lib/fund.md b/packages/docs/API/fund.md → packages/docs/Lib/fund.md
diff --git a/packages/docs/API/getAddress.md → packages/docs/Lib/getAddress.md b/packages/docs/API/getAddress.md → packages/docs/Lib/getAddress.md
diff --git a/packages/docs/API/getBalance.md → packages/docs/Lib/getBalance.md b/packages/docs/API/getBalance.md → packages/docs/Lib/getBalance.md
diff --git a/packages/docs/API/getChain.md → packages/docs/Lib/getChain.md b/packages/docs/API/getChain.md → packages/docs/Lib/getChain.md
diff --git a/packages/docs/API/getMnemonic.md → packages/docs/Lib/getMnemonic.md b/packages/docs/API/getMnemonic.md → packages/docs/Lib/getMnemonic.md
diff --git a/packages/docs/API/getNetwork.md → packages/docs/Lib/getNetwork.md b/packages/docs/API/getNetwork.md → packages/docs/Lib/getNetwork.md
diff --git a/packages/docs/API/getPassphrase.md → packages/docs/Lib/getPassphrase.md b/packages/docs/API/getPassphrase.md → packages/docs/Lib/getPassphrase.md
diff --git a/packages/docs/API/getPrivateKey.md → packages/docs/Lib/getPrivateKey.md b/packages/docs/API/getPrivateKey.md → packages/docs/Lib/getPrivateKey.md
diff --git a/packages/docs/API/getPublicKey.md → packages/docs/Lib/getPublicKey.md b/packages/docs/API/getPublicKey.md → packages/docs/Lib/getPublicKey.md
diff --git a/packages/docs/API/getUtxos.md → packages/docs/Lib/getUtxos.md b/packages/docs/API/getUtxos.md → packages/docs/Lib/getUtxos.md
diff --git a/packages/docs/API/index.yml → packages/docs/Lib/index.yml b/packages/docs/API/index.yml → packages/docs/Lib/index.yml
@@ -1,2 +1,3 @@
 order: -60
 icon: tools
+expanded: true
diff --git a/packages/docs/API/api.md → packages/docs/Lib/lib.md b/packages/docs/API/api.md → packages/docs/Lib/lib.md
@@ -2,7 +2,7 @@
 order: -40
 ---
 
-# API
+# Lib
 
 This API describes the functionality of the `Computer` [library](https://github.com/bitcoin-computer/monorepo/tree/main/packages/lib#readme).
 

diff --git a/packages/docs/API/load.md → packages/docs/Lib/load.md b/packages/docs/API/load.md → packages/docs/Lib/load.md
diff --git a/packages/docs/API/new.md → packages/docs/Lib/new.md b/packages/docs/API/new.md → packages/docs/Lib/new.md
diff --git a/packages/docs/API/query.md → packages/docs/Lib/query.md b/packages/docs/API/query.md → packages/docs/Lib/query.md
diff --git a/packages/docs/API/rpcCall.md → packages/docs/Lib/rpcCall.md b/packages/docs/API/rpcCall.md → packages/docs/Lib/rpcCall.md
diff --git a/packages/docs/API/send.md → packages/docs/Lib/send.md b/packages/docs/API/send.md → packages/docs/Lib/send.md
diff --git a/packages/docs/API/sign.md → packages/docs/Lib/sign.md b/packages/docs/API/sign.md → packages/docs/Lib/sign.md
diff --git a/packages/docs/API/sync.md → packages/docs/Lib/sync.md b/packages/docs/API/sync.md → packages/docs/Lib/sync.md
diff --git a/packages/docs/comparison.md b/packages/docs/comparison.md
@@ -0,0 +1,117 @@
+---
+order: -37
+icon: diff
+visibility: hidden
+---
+
+# Comparison
+
+## Layer 2
+
+In layer-2 solutions, transactions are performed
+out of the blockchain (layer-1) and can ultimately settle
+back efficiently to the blockchain.
+
+### Side Chains
+* [Stacks](https://docs.stacks.co/)
+* [Rootstock](https://dev.rootstock.io/)
+* [Internet Computer](https://internetcomputer.org/docs/current/home)
+
+### Payment Channel Networks
+* [Ark](https://ark-protocol.org/)
+* [RGB](https://docs.rgb.info/)
+
+### Rollups
+
+*Rollups* execute batches of transactions outside the main blockchain,
+convert them into one single piece of data and submit it to the
+main blockchain. [1]
+
+#### Optimistic Rollups
+
+*Optimistic rollups* assume transactions
+are valid. For a period of time, each user has the opportunity
+to challenge the transaction and, in such a case, must present a
+fraud proof. [1]
+
+Optimistic rollups have two main
+entities participating: aggregators and verifiers. Once an
+aggregator publishes a transaction, there is a period of
+time when each node acting as a verifier can monitor data
+published by the aggregator. If the verifier disagrees with
+the published data, she can challenge the transaction. To
+discourage aggregators and verifiers from acting maliciously,
+both the aggregator and verifier need to stake a bond. If the
+verifier can provide a fraud proof, the aggregator is fined.
+Otherwise, the verifier gets fined. [...] Only one honest verifier is needed to guarantee that the
+aggregator did not act maliciously.[1]
+
+#### Zero-knowledge Rollups
+
+*Zero-knowledge rollups* do not assume fair play, and together with transaction
+data, the aggregator provides a validity proof. [1]
+
+While optimistic rollups use fraud proofs
+for security, Zero-Knowledge (ZK) rollups use validity
+proofs. Instead of allowing the aggregator
+to publish a transaction and then question it, in ZK
+rollups, the aggregator must prove the post-state root is
+the correct result of the batch execution using a validity
+proof. 
+
+#### Optimistic vs ZK Rollups
+
+ Building
+a validity proof requires heavy computations; hence, ZK
+rollups’ offchain fees are higher than optimistic rollups. Additionally, a ZK rollup layer-1 transaction has a much
+higher fixed fee since it requires a validity proof verification
+hence gas fees are higher. [1]
+
+Though, since optimistic rollups
+have a period where verifiers have an opportunity to publish a
+fraud proof, the users need to wait (usually a week) until their
+deposits can be withdrawn, while in ZK-rollups, deposits can
+be withdrawn immediately. [1]
+
+* [BOB](https://docs.gobob.xyz/)
+* [Citrea](https://docs.citrea.xyz/)
+* [Alpen](https://www.alpenlabs.io/)
+
+## Layer 1
+
+### Miner Validated
+* [Bitcoin Script]()
+* [BitVM](https://bitvm.org/) (is this L2?)
+
+### Client Validated
+* [EPOBC](https://github.com/chromaway/ngcccbase/wiki/EPOBC_simple)
+* [CounterParty](https://docs.counterparty.io/docs/basics/what-is-counterparty/)
+* [Ordinals](https://docs.ordinals.com/)
+* [BRC20](https://domo-2.gitbook.io/brc-20-experiment)
+* [Runes](https://docs.ordinals.com/runes.html)
+* [Bitcoin Computer](https://docs.bitcoincomputer.io/)
+
+
+## References
+
+* https://www.bitcoinlayers.org/
+* https://www.bitcoinrollups.io/
+* https://www.hiro.so/blog/building-on-bitcoin-project-comparison
+* https://www.hiro.so/
+
+## Articles
+[1] [SoK: Applications of Sketches and Rollups in Blockchain Networks](https://drive.google.com/file/d/1dJ2OsAc4QvIWzxR1JFFmMfMVYIrnXOWW/view), Arad Kotzer, Daniel Gandelman and Ori Rottenstreich; Technion, Florida State University
+* [Blockchain Scaling Using Rollups: A Comprehensive Survey](https://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=9862815), LOUIS TREMBLAY THIBAULT, TOM SARRY, AND ABDELHAKIM SENHAJI HAFID; Montreal
+* [SoK: unraveling Bitcoin smart contracts](https://eprint.iacr.org/2018/192.pdf), Nicola Atzei, Massimo Bartoletti, Tiziana Cimoli, Stefano Lande; Cagliari, Trento
+Roberto Zunino
+* [Beyond Bitcoin: A Review Study on the Diverse Future of Cryptocurrency](https://www.researchgate.net/publication/373825700_Beyond_Bitcoin_A_Review_Study_on_the_Diverse_Future_of_Cryptocurrency), Mohammed Faez Hasan, University of Kerbala
+* [BitML: A Calculus for Bitcoin Smart Contracts](https://eprint.iacr.org/2018/122.pdf), Massimo Bartoletti, Roberto Zunino; Cagliari, Trento
+* [An Overview of Smart Contract and Use cases in Blockchain Technology](https://www.researchgate.net/profile/Bhabendu-Mohanta/publication/328581609_An_Overview_of_Smart_Contract_and_Use_Cases_in_Blockchain_Technology/links/5bf398a592851c6b27cbfeac/An-Overview-of-Smart-Contract-and-Use-Cases-in-Blockchain-Technology.pdf), Bhabendu Kumar Mohanta, Soumyashree S Panda, Debasish Jena; IIIT Bhubaneswar
+* [Layer 2 Blockchain Scaling: a Survey](https://arxiv.org/pdf/2107.10881), Cosimo Sguanci, Roberto Spatafora, Andrea Mario Vergani; Polytechnico Milano
+* [A Rollup Comparison Framework](https://arxiv.org/pdf/2404.16150), Jan Gorzny, Martin Derka; Zircuit
+* [SoK: Decentralized Finance (DeFi)](https://dl.acm.org/doi/pdf/10.1145/3558535.3559780)
+* [SoK: Communication Across Distributed Ledgers](https://eprint.iacr.org/2019/1128.pdf)
+* [Colored Coins whitepaper](https://www.etoro.com/wp-content/uploads/2022/03/Colored-Coins-white-paper-Digital-Assets.pdf), Yoni Assia, Vitalik Buterin, liorhakiLior, Meni Rosenfeld, Rotem Lev
+
+
+
diff --git a/packages/docs/downloads.md b/packages/docs/downloads.md
@@ -1,11 +1,12 @@
 ---
 order: -20
 icon: download
+visibility: hidden
 ---
 
 # Downloads
 
-All of our code is in the [Bitcoin Computer Monorepo](https://github.com/bitcoin-computer/monorepo/tree/main#readme) on Github. To download it run:
+All code is in the [Bitcoin Computer Monorepo](https://github.com/bitcoin-computer/monorepo/tree/main#readme) on Github. To download it run:
 
 ```bash
 git clone https://github.com/bitcoin-computer/monorepo.git

diff --git a/packages/docs/format.md b/packages/docs/format.md
@@ -0,0 +1,8 @@
+---
+order: -36
+icon: note
+---
+
+# Transaction Format
+
+Coming soon.
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     order: -40
     ---
-    # API
+    # Lib
     This API describes the functionality of the `Computer` [library](https://github.com/bitcoin-computer/monorepo/tree/main/packages/lib#readme).
@@ Expand Down @@