blockworks-foundation
/
solana-with-rpc-optimizations
mirror of https://github.com/blockworks-foundation/solana-with-rpc-optimizations.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
solana-with-rpc-optimizations/book/src/SUMMARY.md

53 lines
2.0 KiB
Markdown
Raw Normal View History

Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
# Solana Architecture
Make markdown docs more modular No need to assume the book context.
2018-11-07 07:58:20 -08:00
- [Introduction](introduction.md)
Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
Various book cleanup * Merge Leader and Validator diagrams * New sdk-tools diagram * Move terminology to just after introduction * Purge use of LAMPORT as an acronym * Add notes about persistent storage
2018-11-17 17:01:21 -08:00
- [Terminology](terminology.md)
Move testnet demos into the book Have git readme focus on fullnode development and the book focus on users.
2018-11-25 22:09:50 -08:00
- [Getting Started](getting-started.md)
Add web wallet example
2018-12-12 12:39:06 -08:00
- [Example: Web Wallet](webwallet.md)
Move testnet demos into the book Have git readme focus on fullnode development and the book focus on users.
2018-11-25 22:09:50 -08:00
Cleanup book (#1904) * Cleanup book * Distinguish upstream from downstream validators * Add BroadcastStage to Fullnode/Tpu diagrams * First attempt to re-describe the runtime * Reorg book Push back details of the fullnode implementation
2018-11-25 15:58:38 -08:00
- [Programming Model](programs.md)
Add instructions to build and run tic-tac-toe
2018-12-11 13:23:32 -08:00
- [Example: Tic-Tac-Toe](tictactoe.md)
Integrate EntryTree description into the TVU doc
2018-12-12 10:33:33 -08:00
- [Drones](drones.md)
Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
Reorg the markdown book to cater to app devs First, talk about how a client interacts with Solana to do useful things. Then describe how the fullnode you're talking to works and why it's so very fast. Last, why that fullnode you don't trust does what you asked it to anyway.
2018-11-21 15:18:51 -08:00
- [A Solana Cluster](cluster.md)
- [Synchronization](synchronization.md)
Add leader rotation links Avoid the term "leader selection" here. More precise terms are "leader scheduling", "leader rotation", and "fork selection."
2018-11-28 15:26:38 -08:00
- [Leader Rotation](leader-rotation.md)
Migrate all RFC content into the book
2018-12-12 10:18:49 -08:00
- [Fork Generation](fork-generation.md)
Move data plane fanout chapter out of proposals
2019-02-22 13:41:03 -08:00
- [Data Plane Fanout](data-plane-fanout.md)
Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
Cleanup book (#1904) * Cleanup book * Distinguish upstream from downstream validators * Add BroadcastStage to Fullnode/Tpu diagrams * First attempt to re-describe the runtime * Reorg book Push back details of the fullnode implementation
2018-11-25 15:58:38 -08:00
- [Anatomy of a Fullnode](fullnode.md)
Uppercase acronyms Looks like there will be very little Rust code in the markdown book so switching back to English capitalization conventions.
2018-11-25 21:39:41 -08:00
- [TPU](tpu.md)
- [TVU](tvu.md)
Integrate the blocktree proposal into the book (#2704)
2019-02-08 19:27:35 -08:00
- [Blocktree](blocktree.md)
Rename Ncp to GossipService And BroadcastStage to BroadcastService since it's not included in the TPU pipeline.
2018-12-06 12:52:47 -08:00
- [Gossip Service](gossip.md)
Cleanup book (#1904) * Cleanup book * Distinguish upstream from downstream validators * Add BroadcastStage to Fullnode/Tpu diagrams * First attempt to re-describe the runtime * Reorg book Push back details of the fullnode implementation
2018-11-25 15:58:38 -08:00
- [The Runtime](runtime.md)
Rename Appendix to API Reference And move before the proposals, since all this stuff is already implemented.
2019-02-08 16:24:33 -08:00
- [API Reference](api-reference.md)
Call it blockstreamer
2019-02-21 15:20:19 -08:00
- [Blockstreamer](blockstreamer.md)
Rename Appendix to API Reference And move before the proposals, since all this stuff is already implemented.
2019-02-08 16:24:33 -08:00
- [JSON RPC API](jsonrpc-api.md)
- [JavaScript API](javascript-api.md)
- [solana-wallet CLI](wallet.md)
Add new proposal process And move replication and enclave proposals there to get a feel for how it'd look.
2018-12-12 08:13:04 -08:00
- [Proposed Architectural Changes](proposals.md)
- [Ledger Replication](ledger-replication.md)
Cleanup
2019-02-06 16:13:11 -08:00
- [Secure Vote Signing](vote-signer.md)
Migrate all RFC content into the book
2018-12-12 10:18:49 -08:00
- [Staking Rewards](staking-rewards.md)
Add fork selection RFC (#2061) RFC and simulation for fork generation.
2018-12-14 11:15:23 -08:00
- [Fork Selection](fork-selection.md)
Add design proposal for reliable vote transmission (#2601) * reliable vote transmission design proposal * summary * comments
2019-01-31 07:34:49 -08:00
- [Reliable Vote Transmission](reliable-vote-transmission.md)
Rename, purge use of term delta This would be a fine document to introduce the term delta, but it looks like the content flows just fine without it.
2019-02-07 14:11:00 -08:00
- [Bank Forks](bank-forks.md)
Move economics into the proposed changes Once this is implemented, we'll move it into the "A Solana Cluster" section.
2019-02-05 16:21:38 -08:00
- [Cluster Economics](ed_overview.md)
- [Validation-client Economics](ed_validation_client_economics.md)
- [State-validation Protocol-based Rewards](ed_vce_state_validation_protocol_based_rewards.md)
- [State-validation Transaction Fees](ed_vce_state_validation_transaction_fees.md)
- [Replication-validation Transaction Fees](ed_vce_replication_validation_transaction_fees.md)
- [Validation Stake Delegation](ed_vce_validation_stake_delegation.md)
- [Replication-client Economics](ed_replication_client_economics.md)
- [Storage-replication Rewards](ed_rce_storage_replication_rewards.md)
- [Replication-client Reward Auto-delegation](ed_rce_replication_client_reward_auto_delegation.md)
- [Economic Sustainability](ed_economic_sustainability.md)
- [Attack Vectors](ed_attack_vectors.md)
- [References](ed_references.md)
Add design for the leader validator loop (#2650)
2019-02-13 11:00:43 -08:00
- [Leader-to-Validator Transition](leader-validator-transition.md)