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

70 lines
3.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)
Move Testnet Participation under Getting Started
2019-06-10 13:53:31 -07:00
- [Testnet Participation](testnet-participation.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)
Integrate bank-forks proposal into the book
2019-03-04 16:50:36 -08:00
- [Managing Forks](managing-forks.md)
Update book for Turbine (#4583)
2019-06-07 13:03:05 -07:00
- [Turbine Block Propagation](turbine-block-propagation.md)
Attempt to pull the completed replication work into the book
2019-02-22 13:08:05 -08:00
- [Ledger Replication](ledger-replication.md)
Move secure vote signing out of proposals
2019-02-22 13:48:30 -08:00
- [Secure Vote Signing](vote-signing.md)
update book with passive staking (#4451)
2019-05-28 14:02:04 -07:00
- [Stake Delegation and Rewards](stake-delegation-and-rewards.md)
Performance metrics computation methodology (#4041)
2019-04-27 16:37:51 -07:00
- [Performance Metrics](performance-metrics.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
More fullnode -> validator renaming (#4414) * s/fullnode_config/validator_config/g * s/FullnodeConfig/ValidatorConfig/g * mv core/lib/fullnode.rs core/lib/validator.rs * s/Fullnode/Validator/g * Add replicator-x.sh * Rename fullnode.md to validator.md * cargo fmt
2019-05-23 22:05:16 -07:00
- [Anatomy of a Validator](validator.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)
solana-install design proposal
2019-03-13 15:31:05 -07:00
Revert "Move the design proposals to a separate book" This reverts commit 4ca18d6b9affbc574d1b3d3d230230b057f8fde3.
2019-03-23 12:27:09 -07:00
- [Accepted Design Proposals](proposals.md)
- [Ledger Replication](ledger-replication-to-implement.md)
- [Secure Vote Signing](vote-signing-to-implement.md)
- [Staking Rewards](staking-rewards.md)
- [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)
- [Economic Design MVP](ed_mvp.md)
- [References](ed_references.md)
- [Cluster Test Framework](cluster-test-framework.md)
Move stragglers into the book The stuff added between the time we switched to proposals/ and the git-revert
2019-03-25 19:20:20 -07:00
- [Credit-only Accounts](credit-only-credit-debit-accounts.md)
Add design proposal for deterministic transaction fees
2019-03-13 15:07:27 -07:00
- [Deterministic Transaction Fees](transaction-fees.md)
More fullnode -> validator renaming (#4414) * s/fullnode_config/validator_config/g * s/FullnodeConfig/ValidatorConfig/g * mv core/lib/fullnode.rs core/lib/validator.rs * s/Fullnode/Validator/g * Add replicator-x.sh * Rename fullnode.md to validator.md * cargo fmt
2019-05-23 22:05:16 -07:00
- [Validator](validator-proposal.md)
Revert "Move the design proposals to a separate book" This reverts commit 4ca18d6b9affbc574d1b3d3d230230b057f8fde3.
2019-03-23 12:27:09 -07:00
- [Implemented Design Proposals](implemented-proposals.md)
testnet-participation.md is now /implemented/
2019-04-10 11:55:39 -07:00
- [Fork Selection](fork-selection.md)
Revert "Move the design proposals to a separate book" This reverts commit 4ca18d6b9affbc574d1b3d3d230230b057f8fde3.
2019-03-23 12:27:09 -07:00
- [Leader-to-Leader Transition](leader-leader-transition.md)
- [Leader-to-Validator Transition](leader-validator-transition.md)
Move Transact proposal to implemented (#4055) And update names to reflect what was implemented.
2019-04-29 08:13:39 -07:00
- [Testing Programs](testing-programs.md)
Move implemented functionality into the Implemented Proposals section (#4057)
2019-04-29 16:29:41 -07:00
- [Reliable Vote Transmission](reliable-vote-transmission.md)
- [Persistent Account Storage](persistent-account-storage.md)
- [Cluster Software Installation and Updates](installer.md)
update book with passive staking (#4451)
2019-05-28 14:02:04 -07:00
- [Passive Stake Delegation and Rewards](passive-stake-delegation-and-rewards.md)