Bump blockexplorer version to 1.32.0

automerge

.appveyor.yml

@@ -0,0 +1,41 @@
+os: Visual Studio 2017
+version: '{build}'
+
+branches:
+  only:
+  - master
+  - /^v[0-9.]+/
+
+cache:
+  - '%USERPROFILE%\.cargo'
+  - '%APPVEYOR_BUILD_FOLDER%\target'
+
+build_script:
+  - bash ci/publish-tarball.sh
+
+notifications:
+  - provider: Slack
+    incoming_webhook:
+      secure: 6HnLbeS6/Iv7JSMrrHQ7V9OSIjH/3KFzvZiinNWgQqEN0e9A6zaE4MwEXUYDWbcvVJiQneWit6dswY8Scoms2rS1PWEN5N6sjgLgyzroptc=
+    channel: ci-status
+    on_build_success: false
+    on_build_failure: true
+    on_build_status_changed: true
+
+deploy:
+  - provider: S3
+    access_key_id:
+      secure: G6uzyGqbkMCXS2+sCeBCT/+s/11AHLWXCuGayfKcMEE=
+    secret_access_key:
+      secure: Lc+aVrbcPSXoDV7h2J7gqKT+HX0n3eEzp3JIrSP2pcKxbAikGnCtOogCiHO9/er2
+    bucket: release.solana.com
+    region: us-west-1
+    set_public: true
+
+  - provider: GitHub
+    auth_token:
+      secure: vQ3jMl5LQrit6+TQONA3ZgQjZ/Ej62BN2ReVb2NSOwjITHMu1131hjc3dOrMEZL6
+    draft: false
+    prerelease: false
+    on:
+      appveyor_repo_tag: true

.buildkite/env/.gitignore

@@ -0,0 +1 @@
+/secrets_unencrypted.ejson

.buildkite/env/secrets.ejson

@@ -1,10 +1,14 @@
 {
     "_public_key": "ae29f4f7ad2fc92de70d470e411c8426d5d48db8817c9e3dae574b122192335f",
     "environment": {
-      "CODECOV_TOKEN": "EJ[1:Kqnm+k1Z4p8nr7GqMczXnzh6azTk39tj3bAbCKPitUc=:EzVa4Gpj2Qn5OhZQlVfGFchuROgupvnW:CbWc6sNh1GCrAbrncxDjW00zUAD/Sa+ccg7CFSz8Ua6LnCYnSddTBxJWcJEbEs0MrjuZRQ==]",
-      "CRATES_IO_TOKEN": "EJ[1:Kqnm+k1Z4p8nr7GqMczXnzh6azTk39tj3bAbCKPitUc=:qF7QrUM8j+19mptcE1YS71CqmrCM13Ah:TZCatJeT1egCHiufE6cGFC1VsdJkKaaqV6QKWkEsMPBKvOAdaZbbVz9Kl+lGnIsF]",
-      "INFLUX_DATABASE": "EJ[1:Kqnm+k1Z4p8nr7GqMczXnzh6azTk39tj3bAbCKPitUc=:PetD/4c/EbkQmFEcK21g3cBBAPwFqHEw:wvYmDZRajy2WngVFs9AlwyHk]",
-      "INFLUX_USERNAME": "EJ[1:Kqnm+k1Z4p8nr7GqMczXnzh6azTk39tj3bAbCKPitUc=:WcnqZdmDFtJJ01Zu5LbeGgbYGfRzBdFc:a7c5zDDtCOu5L1Qd2NKkxT6kljyBcbck]",
-      "INFLUX_PASSWORD": "EJ[1:Kqnm+k1Z4p8nr7GqMczXnzh6azTk39tj3bAbCKPitUc=:LIZgP9Tp9yE9OlpV8iogmLOI7iW7SiU3:x0nYdT1A6sxu+O+MMLIN19d2t6rrK1qJ3+HnoWG3PDodsXjz06YJWQKU/mx6saqH+QbGtGV5mk0=]"
+      "CODECOV_TOKEN": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:ks2/ElgxwgxqgmFcxTHANNLmj23YH74h:U4uzRONRfiQyqy6HrPQ/e7OnBUY4HkW37R0iekkF3KJ9UGnHqT1UvwgVbDqLahtDIJ4rWw==]",
+      "CRATES_IO_TOKEN": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:lKMh3aLW+jyRrfS/c7yvkpB+TaPhXqLq:j0v27EbaPgwRdHZAbsM0FlAnt3r9ScQrFbWJYOAZtM3qestEiByTlKpZ0eyF/823]",
+      "GITHUB_TOKEN": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:Ll78c3jGpYqnTwR7HJq3mNNUC7pOv9Lu:GrInO2r8MjmP5c54szkyygdsrW5KQYkDgJQUVyFEPyG8SWfchyM9Gur8RV0a+cdwuxNkHLi4U2M=]",
+      "INFLUX_DATABASE": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:IlH/ZLTXv3SwlY3TVyAPCX2KzLRY6iG3:gGmUGSU/kCfR/mTwKONaUC/X]",
+      "INFLUX_PASSWORD": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:o2qm95GU4VrrcC4OU06jjPvCwKZy/CZF:OW2ga3kLOQJvaDEdGRJ+gn3L2ckFm8AJZtv9wj/GeUIKDH2A4uBPTHsAH9PMe6zujpuHGk3qbeg=]",
+      "INFLUX_USERNAME": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:yDWW/uIHsJqOTDYskZoSx3pzoB1vztWY:2z31oTA3g0Xs9fCczGNJRcx8xf/hFCed]",
+      "SOLANA_INSTALL_UPDATE_MANIFEST_KEYPAIR_x86_64_unknown_linux_gnu": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:RqRaHlYUvGPNFJa6gmciaYM3tRJTURUH:q78/3GTHCN3Uqx9z4nOBjPZcO1lOazNoB/mdhGRDFsnAqVd2hU8zbKkqLrZfLlGqyD8WQOFuw5oTJR9qWg6L9LcOyj3pGL8jWF2yjgZxdtNMXnkbSrCWLooWBBLT61jYQnEwg73gT8ld3Q8EVv3T+MeSMu6FnPz+0+bqQCAGgfqksP4hsUAJGzgZu+i0tNOdlT7fxnh5KJK/yFM/CKgN2sRwEjukA9hXsffyB61g2zqzTDJxCUDLbCVrCkA/bfUk7Of/t0W5t0nK1H3oyGZEc/lRMauCknDBka3Gz11dVss2QT19WQNh0u7bHVaT/U4lepX1j9Zv]",
+      "SOLANA_INSTALL_UPDATE_MANIFEST_KEYPAIR_x86_64_apple_darwin": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:wFDl3INEnA3EQDHRX40avqGe1OMoJxyy:6ncCRVRTIRuYI5o/gayeuWCudWvmKNYr8KEHAWeTq34a5bdcKInBdKhjmjX+wLHqsEwQ5gcyhcxy4Ri2mbuN6AHazfZOZlubQkGlyUOAIYO5D5jkbyIh40DAtjVzo1MD/0HsW9zdGOzqUKp5xJJeDsbR4F153jbxa7fvwF90Q4UQjYFTKAtExEmHtDGSJG48ToVwTabTV/OnISMIggDZBviIv2QWHvXgK07b2mUj34rHJywEDGN1nj5rITTDdUeRcB1x4BAMOe94kTFPSTaj/OszvYlGECt8rkKFqbm092qL+XLfiBaImqe/WJHRCnAj6Don]",
+      "SOLANA_INSTALL_UPDATE_MANIFEST_KEYPAIR_x86_64_pc_windows_msvc": "EJ[1:8iZ6baJB4fbBV+XDsrUooyGAnGL/8Ol+4Qd0zKh5YjI=:wAh+dBuZopv6vruVOYegUcq/aBnbksT1:qIJfCfDvDWiqicMOkmbJs/0n7UJLKNmgMQaKzeQ8J7Q60YpXbtWzKVW3tS6lzlgf64m3MrPXyo1C+mWh6jkjsb18T/OfggZy1ZHM4AcsOC6/ldUkV5YtuxUQuAmd5jCuV/R7iuYY8Z66AcfAevlb+bnLpgIifdA8fh/IktOo58nZUQwZDdppAacmftsLc6Frn5Er6A6+EXpxK1nmnlmLJ4AJztqlh6X0r+JvE2O7qeoZUXrIegnkxo7Aay7I/dd8zdYpp7ICSiTEtfVN/xNIu/5QmTRU7gWoz7cPl9epq4aiEALzPOzb6KVOiRcsOg+TlFvLQ71Ik5o=]"
     }
 }

.buildkite/hooks/post-checkout

@@ -1,2 +1,35 @@
 CI_BUILD_START=$(date +%s)
 export CI_BUILD_START
+
+source ci/env.sh
+
+#
+# Kill any running docker containers, which are potentially left over from the
+# previous CI job
+#
+(
+  containers=$(docker ps -q)
+  if [[ $(hostname) != metrics-solana-com && -n $containers ]]; then
+    echo "+++ Killing stale docker containers"
+    docker ps
+
+    # shellcheck disable=SC2086 # Don't want to double quote $containers
+    docker kill $containers
+  fi
+)
+
+# Processes from previously aborted CI jobs seem to loiter, unclear why as one
+# would expect the buildkite-agent to clean up all child processes of the
+# aborted CI job.
+# But as a workaround for now manually kill some known loiterers.  These
+# processes will all have the `init` process as their PPID:
+(
+  victims=
+  for name in bash cargo docker solana; do
+    victims="$victims $(pgrep -u "$(id -u)" -P 1 -d \  $name)"
+  done
+  for victim in $victims; do
+    echo "Killing pid $victim"
+    kill -9 "$victim" || true
+  done
+)

.buildkite/hooks/post-command

@@ -10,6 +10,8 @@
   set -x
   rsync -a --delete --link-dest="$PWD" target "$d"
   du -hs "$d"
+  read -r cacheSizeInGB _ < <(du -s --block-size=1800000000 "$d")
+  echo "--- ${cacheSizeInGB}GB: $d"
 )
 
 #

.buildkite/hooks/pre-command

@@ -14,14 +14,18 @@ export PS4="++"
 (
   set -x
   d=$HOME/cargo-target-cache/"$BUILDKITE_LABEL"
+  MAX_CACHE_SIZE=18 # gigabytes
 
   if [[ -d $d ]]; then
     du -hs "$d"
-    read -r cacheSizeInGB _ < <(du -s --block-size=1000000000 "$d")
-    if [[ $cacheSizeInGB -gt 10 ]]; then
-      echo "$d has gotten too large, removing it"
+    read -r cacheSizeInGB _ < <(du -s --block-size=1800000000 "$d")
+    echo "--- ${cacheSizeInGB}GB: $d"
+    if [[ $cacheSizeInGB -gt $MAX_CACHE_SIZE ]]; then
+      echo "--- $d is too large, removing it"
       rm -rf "$d"
     fi
+  else
+    echo "--- $d not present"
   fi
 
   mkdir -p "$d"/target

.codecov.yml

@@ -1,5 +1,12 @@
-ignore:
-  - "src/bin" 
 coverage:
+  range: 50..100
+  round: down
+  precision: 1
   status:
+    project: off
     patch: off
+
+comment:
+  layout: "diff"
+  behavior: default
+  require_changes: no

.gitignore

@@ -1,7 +1,12 @@
-/target/
 /book/html/
 /book/src/img/
 /book/src/tests.ok
+/farf/
+/solana-release/
+/solana-release.tar.bz2
+/solana-metrics/
+/solana-metrics.tar.bz2
+/target/
 
 **/*.rs.bk
 .cargo
@@ -18,3 +23,4 @@ log-*.txt
 # intellij files
 /.idea/
 /solana.iml
+/.vscode/

.travis.yml

@@ -0,0 +1,44 @@
+os:
+  - osx
+
+language: rust
+cache: cargo
+rust:
+  - 1.35.0
+
+install:
+  - source ci/rust-version.sh
+  - test $rust_stable = $TRAVIS_RUST_VERSION # Update .travis.yml rust version above when this fails
+
+script:
+  - source ci/env.sh
+  - ci/publish-tarball.sh
+
+branches:
+  only:
+    - master
+    - /^v\d+\.\d+(\.\d+)?(-\S*)?$/
+
+notifications:
+  slack:
+    on_success: change
+    secure: F4IjOE05MyaMOdPRL+r8qhs7jBvv4yDM3RmFKE1zNXnfUOqV4X38oQM1EI+YVsgpMQLj/pxnEB7wcTE4Bf86N6moLssEULCpvAuMVoXj4QbWdomLX+01WbFa6fLVeNQIg45NHrz2XzVBhoKOrMNnl+QI5mbR2AlS5oqsudHsXDnyLzZtd4Y5SDMdYG1zVWM01+oNNjgNfjcCGmOE/K0CnOMl6GPi3X9C34tJ19P2XT7MTDsz1/IfEF7fro2Q8DHEYL9dchJMoisXSkem5z7IDQkGzXsWdWT4NnndUvmd1MlTCE9qgoXDqRf95Qh8sB1Dz08HtvgfaosP2XjtNTfDI9BBYS15Ibw9y7PchAJE1luteNjF35EOy6OgmCLw/YpnweqfuNViBZz+yOPWXVC0kxnPIXKZ1wyH9ibeH6E4hr7a8o9SV/6SiWIlbYF+IR9jPXyTCLP/cc3sYljPWxDnhWFwFdRVIi3PbVAhVu7uWtVUO17Oc9gtGPgs/GrhOMkJfwQPXaudRJDpVZowxTX4x9kefNotlMAMRgq+Drbmgt4eEBiCNp0ITWgh17BiE1U09WS3myuduhoct85+FoVeaUkp1sxzHVtGsNQH0hcz7WcpZyOM+AwistJA/qzeEDQao5zi1eKWPbO2xAhi2rV1bDH6bPf/4lDBwLRqSiwvlWU=
+
+deploy:
+  - provider: s3
+    access_key_id: $AWS_ACCESS_KEY_ID
+    secret_access_key: $AWS_SECRET_ACCESS_KEY
+    bucket: release.solana.com
+    region: us-west-1
+    skip_cleanup: true
+    acl: public_read
+    local_dir: travis-s3-upload
+    on:
+      all_branches: true
+  - provider: releases
+    api_key: $GITHUB_TOKEN
+    skip_cleanup: true
+    file_glob: true
+    file: travis-release-upload/*
+    on:
+      tags: true

CONTRIBUTING.md

@@ -8,6 +8,56 @@ don't agree with a convention, submit a PR patching this document and let's disc
 the PR is accepted, *all* code should be updated as soon as possible to reflect the new
 conventions.
 
+Pull Requests
+---
+
+Small, frequent PRs are much preferred to large, infrequent ones. A large PR is difficult
+to review, can block others from making progress, and can quickly get its author into
+"rebase hell". A large PR oftentimes arises when one change requires another, which requires
+another, and then another. When you notice those dependencies, put the fix into a commit of
+its own, then checkout a new branch, and cherrypick it. Open a PR to start the review
+process and then jump back to your original branch to keep making progress. Once the commit
+is merged, you can use git-rebase to purge it from your original branch.
+
+```bash
+$ git pull --rebase upstream master
+```
+
+### How big is too big?
+
+If there are no functional changes, PRs can be very large and that's no problem. If,
+however, your changes are making meaningful changes or additions, then about 1,000 lines of
+changes is about the most you should ask a Solana maintainer to review.
+
+### Should I send small PRs as I develop large, new components?
+
+Add only code to the codebase that is ready to be deployed. If you are building a large
+library, consider developing it in a separate git repository. When it is ready to be
+integrated, the Solana maintainers will work with you to decide on a path forward. Smaller
+libraries may be copied in whereas very large ones may be pulled in with a package manager.
+
+### When will my PR be reviewed?
+
+PRs are typically reviewed and merged in under 7 days. If your PR has been open for longer,
+it's a strong indicator that the reviewers aren't confident the change meets the quality
+standards of the codebase. You might consider closing it and coming back with smaller PRs
+and longer descriptions detailing what problem it solves and how it solves it.
+
+Draft Pull Requests
+---
+
+If you want early feedback on your PR, use GitHub's "Draft Pull Request"
+mechanism. Draft PRs are a convenient way to collaborate with the Solana
+maintainers without triggering notifications as you make changes. When you feel
+your PR is ready for a broader audience, you can transition your draft PR to a
+standard PR with the click of a button.
+
+Do not add reviewers to draft PRs.  GitHub doesn't automatically clear approvals
+when you click "Ready for Review", so a review that meant "I approve of the
+direction" suddenly has the appearance of "I approve of these changes." Instead,
+add a comment that mentions the usernames that you would like a review from. Ask
+explicitly what you would like feedback on.
+
 Rust coding conventions
 ---
 
@@ -46,24 +96,23 @@ understood. Avoid introducing new 3-letter terms, which can be confused with 3-l
 [Terms currently in use](book/src/terminology.md)
 
 
-Proposing architectural changes
+Design Proposals
 ---
 
 Solana's architecture is described by a book generated from markdown files in
 the `book/src/` directory, maintained by an *editor* (currently @garious). To
-change the architecture, you'll need to at least propose a change the content
-under the [Proposed
-Changes](https://solana-labs.github.io/solana/proposals.html) chapter. Here's
-the full process:
+add a design proposal, you'll need to at least propose a change the content
+under the [Accepted Design
+Proposals](https://solana-labs.github.io/book-edge/proposals.html) chapter.
+Here's the full process:
 
-1. Propose to a change to the architecture by creating a PR that adds a
-   markdown document to the directory `book/src/` and references it from the
-   [table of contents](book/src/SUMMARY.md). Add the editor and any relevant
-   *maintainers* to the PR review.
+1. Propose a design by creating a PR that adds a markdown document to the
+   directory `book/src/` and references it from the [table of
+   contents](book/src/SUMMARY.md). Add any relevant *maintainers* to the PR review.
 2. The PR being merged indicates your proposed change was accepted and that the
-   editor and maintainers support your plan of attack.
+   maintainers support your plan of attack.
 3. Submit PRs that implement the proposal. When the implementation reveals the
-   need for tweaks to the architecture, be sure to update the proposal and have
+   need for tweaks to the proposal, be sure to update the proposal and have
    that change reviewed by the same people as in step 1.
-4. Once the implementation is complete, the editor will then work to integrate
-   the document into the book.
+4. Once the implementation is complete, submit a PR that moves the link from
+   the Accepted Proposals to the Implemented Proposals section.

Cargo.toml

@@ -1,117 +1,48 @@
-[package]
-name = "solana"
-description = "Blockchain, Rebuilt for Scale"
-version = "0.11.0"
-documentation = "https://docs.rs/solana"
-homepage = "https://solana.com/"
-readme = "README.md"
-repository = "https://github.com/solana-labs/solana"
-authors = ["Solana Maintainers <maintainers@solana.com>"]
-license = "Apache-2.0"
-edition = "2018"
-
-[badges]
-codecov = { repository = "solana-labs/solana", branch = "master", service = "github" }
-
-[features]
-bpf_c = ["solana-bpfloader/bpf_c"]
-chacha = []
-cuda = []
-erasure = []
-ipv6 = []
-test = []
-unstable = []
-
-[dependencies]
-bincode = "1.0.0"
-bs58 = "0.2.0"
-bv = { version = "0.10.0", features = ["serde"] }
-byteorder = "1.2.1"
-chrono = { version = "0.4.0", features = ["serde"] }
-hashbrown = "0.1.7"
-indexmap = "1.0"
-itertools = "0.8.0"
-libc = "0.2.45"
-log = "0.4.2"
-nix = "0.12.0"
-rand = "0.6.1"
-rand_chacha = "0.1.0"
-rayon = "1.0.0"
-reqwest = "0.9.0"
-ring = "0.13.2"
-rocksdb = "0.10.1"
-serde = "1.0.82"
-serde_derive = "1.0.82"
-serde_json = "1.0.10"
-solana-bpfloader = { path = "programs/native/bpf_loader", version = "0.11.0" }
-solana-drone = { path = "drone", version = "0.11.0" }
-solana-jsonrpc-core = "0.4.0"
-solana-jsonrpc-http-server = "0.4.0"
-solana-jsonrpc-macros = "0.4.0"
-solana-jsonrpc-pubsub = "0.4.0"
-solana-jsonrpc-ws-server = "0.4.0"
-solana-logger = { path = "logger", version = "0.11.0" }
-solana-metrics = { path = "metrics", version = "0.11.0" }
-solana-native-loader = { path = "programs/native/native_loader", version = "0.11.0" }
-solana-netutil = { path = "netutil", version = "0.11.0" }
-solana-sdk = { path = "sdk", version = "0.11.0" }
-solana-system-program = { path = "programs/native/system", version = "0.11.0" }
-tokio = "0.1"
-tokio-codec = "0.1"
-untrusted = "0.6.2"
-
-[dev-dependencies]
-hex-literal = "0.1.1"
-matches = "0.1.6"
-
-[[bench]]
-name = "bank"
-
-[[bench]]
-name = "banking_stage"
-
-[[bench]]
-name = "db_ledger"
-
-[[bench]]
-name = "ledger"
-
-[[bench]]
-name = "signature"
-
-[[bench]]
-name = "sigverify"
-
-[[bench]]
-required-features = ["chacha"]
-name = "chacha"
-
 [workspace]
 members = [
-    ".",
+    "bench-exchange",
     "bench-streamer",
     "bench-tps",
+    "chacha-sys",
+    "client",
+    "core",
     "drone",
-    "fullnode",
-    "fullnode-config",
+    "validator",
     "genesis",
+    "gossip",
+    "install",
     "keygen",
+    "kvstore",
     "ledger-tool",
     "logger",
+    "merkle-tree",
     "metrics",
-    "programs/bpf/rust/noop",
-    "programs/native/bpf_loader",
-    "programs/native/budget",
-    "programs/native/erc20",
-    "programs/native/lua_loader",
-    "programs/native/native_loader",
-    "programs/native/noop",
-    "programs/native/storage",
-    "programs/native/system",
-    "programs/native/vote",
+    "netutil",
+    "programs/bpf",
+    "programs/bpf_loader_api",
+    "programs/bpf_loader_program",
+    "programs/budget_api",
+    "programs/budget_program",
+    "programs/config_api",
+    "programs/config_program",
+    "programs/exchange_api",
+    "programs/exchange_program",
+    "programs/failure_program",
+    "programs/noop_program",
+    "programs/stake_api",
+    "programs/stake_program",
+    "programs/storage_api",
+    "programs/storage_program",
+    "programs/token_api",
+    "programs/token_program",
+    "programs/vote_api",
+    "programs/vote_program",
     "replicator",
+    "runtime",
     "sdk",
     "upload-perf",
+    "validator-info",
     "vote-signer",
     "wallet",
 ]
+exclude = ["programs/bpf/rust/noop"]

README.md

@@ -26,7 +26,43 @@ Furthermore, and much to our surprise, it can be implemented using a mechanism t
 Architecture
 ===
 
-Before you jump into the code, review the online book [Solana: Blockchain Rebuilt for Scale](https://solana-labs.github.io/solana/).
+Before you jump into the code, review the online book [Solana: Blockchain Rebuilt for Scale](https://solana-labs.github.io/book/).
+
+(The _latest_ development version of the online book is also [available here](https://solana-labs.github.io/book-edge/).)
+
+Release Binaries
+===
+Official release binaries are available at [Github Releases](https://github.com/solana-labs/solana/releases).
+
+Additionally we provide pre-release binaries for the latest code on the edge and
+beta channels.  Note that these pre-release binaries may be less stable than an
+official release.
+
+### Edge channel
+#### Linux (x86_64-unknown-linux-gnu)
+* [solana.tar.bz2](http://release.solana.com/edge/solana-release-x86_64-unknown-linux-gnu.tar.bz2)
+* [solana-install-init](http://release.solana.com/edge/solana-install-init-x86_64-unknown-linux-gnu) as a stand-alone executable
+#### mac OS (x86_64-apple-darwin)
+* [solana.tar.bz2](http://release.solana.com/edge/solana-release-x86_64-apple-darwin.tar.bz2)
+* [solana-install-init](http://release.solana.com/edge/solana-install-init-x86_64-apple-darwin) as a stand-alone executable
+#### Windows (x86_64-pc-windows-msvc)
+* [solana.tar.bz2](http://release.solana.com/edge/solana-release-x86_64-pc-windows-msvc.tar.bz2)
+* [solana-install-init.exe](http://release.solana.com/edge/solana-install-init-x86_64-pc-windows-msvc.exe) as a stand-alone executable
+#### All platforms
+* [solana-metrics.tar.bz2](http://release.solana.com.s3.amazonaws.com/edge/solana-metrics.tar.bz2)
+
+### Beta channel
+#### Linux (x86_64-unknown-linux-gnu)
+* [solana.tar.bz2](http://release.solana.com/beta/solana-release-x86_64-unknown-linux-gnu.tar.bz2)
+* [solana-install-init](http://release.solana.com/beta/solana-install-init-x86_64-unknown-linux-gnu) as a stand-alone executable
+#### mac OS (x86_64-apple-darwin)
+* [solana.tar.bz2](http://release.solana.com/beta/solana-release-x86_64-apple-darwin.tar.bz2)
+* [solana-install-init](http://release.solana.com/beta/solana-install-init-x86_64-apple-darwin) as a stand-alone executable
+#### Windows (x86_64-pc-windows-msvc)
+* [solana.tar.bz2](http://release.solana.com/beta/solana-release-x86_64-pc-windows-msvc.tar.bz2)
+* [solana-install-init.exe](http://release.solana.com/beta/solana-install-init-x86_64-pc-windows-msvc.exe) as a stand-alone executable
+#### All platforms
+* [solana-metrics.tar.bz2](http://release.solana.com.s3.amazonaws.com/beta/solana-metrics.tar.bz2)
 
 Developing
 ===
@@ -39,10 +75,10 @@ Install rustc, cargo and rustfmt:
 ```bash
 $ curl https://sh.rustup.rs -sSf | sh
 $ source $HOME/.cargo/env
-$ rustup component add rustfmt-preview
+$ rustup component add rustfmt
 ```
 
-If your rustc version is lower than 1.31.0, please update it:
+If your rustc version is lower than 1.34.0, please update it:
 
 ```bash
 $ rustup update
@@ -64,7 +100,12 @@ $ cd solana
 Build
 
 ```bash
-$ cargo build --all
+$ cargo build
+```
+
+Then to run a minimal local cluster
+```bash
+$ ./run.sh
 ```
 
 Testing
@@ -73,40 +114,28 @@ Testing
 Run the test suite:
 
 ```bash
-$ cargo test --all
-```
-
-To emulate all the tests that will run on a Pull Request, run:
-
-```bash
-$ ./ci/run-local.sh
+$ cargo test
 ```
 
 Local Testnet
 ---
 
-Start your own testnet locally, instructions are in the book [Solana: Blockchain Rebuild for Scale: Getting Started](https://solana-labs.github.io/solana/getting-started.html).
+Start your own testnet locally, instructions are in the book [Solana: Blockchain Rebuild for Scale: Getting Started](https://solana-labs.github.io/book/getting-started.html).
 
 Remote Testnets
 ---
 
 We maintain several testnets:
 
-* `testnet` - public stable testnet accessible via testnet.solana.com, with an https proxy for web apps at api.testnet.solana.com. Runs 24/7
+* `testnet` - public stable testnet accessible via testnet.solana.com. Runs 24/7
 * `testnet-beta` - public beta channel testnet accessible via beta.testnet.solana.com. Runs 24/7
 * `testnet-edge` - public edge channel testnet accessible via edge.testnet.solana.com. Runs 24/7
-* `testnet-perf` - permissioned stable testnet running a 24/7 soak test
-* `testnet-beta-perf` - permissioned beta channel testnet running a multi-hour soak test weekday mornings
-* `testnet-edge-perf` - permissioned edge channel testnet running a multi-hour soak test weekday mornings
 
 ## Deploy process
 
 They are deployed with the `ci/testnet-manager.sh` script through a list of [scheduled
 buildkite jobs](https://buildkite.com/solana-labs/testnet-management/settings/schedules).
-Each testnet can be manually manipulated from buildkite as well.  The `-perf`
-testnets use a release tarball while the non`-perf` builds use the snap build
-(we've observed that the snap build runs slower than a tarball but this has yet
-to be root caused).
+Each testnet can be manually manipulated from buildkite as well.
 
 ## How do I reset the testnet?
 Manually trigger the [testnet-management](https://buildkite.com/solana-labs/testnet-management) pipeline
@@ -127,10 +156,52 @@ can run your own testnet using the scripts in the `net/` directory.
 Edit `ci/testnet-manager.sh`
 
 
+## Metrics Server Maintenance
+Sometimes the dashboard becomes unresponsive. This happens due to glitch in the metrics server.
+The current solution is to reset the metrics server. Use the following steps.
+
+1. The server is hosted in a GCP VM instance. Check if the VM instance is down by trying to SSH
+ into it from the GCP console. The name of the VM is ```metrics-solana-com```.
+2. If the VM is inaccessible, reset it from the GCP console.
+3. Once VM is up (or, was already up), the metrics services can be restarted from build automation.
+    1. Navigate to https://buildkite.com/solana-labs/metrics-dot-solana-dot-com in your web browser
+    2. Click on ```New Build```
+    3. This will show a pop up dialog. Click on ```options``` drop down.
+    4. Type in ```FORCE_START=true``` in ```Environment Variables``` text box.
+    5. Click ```Create Build```
+    6. This will restart the metrics services, and the dashboards should be accessible afterwards.
+
+## Debugging Testnet
+Testnet may exhibit different symptoms of failures. Primary statistics to check are
+1. Rise in Confirmation Time
+2. Nodes are not voting
+3. Panics, and OOM notifications
+
+Check the following if there are any signs of failure.
+1. Did testnet deployment fail?
+    1. View buildkite logs for the last deployment: https://buildkite.com/solana-labs/testnet-management
+    2. Use the relevant branch
+    3. If the deployment failed, look at the build logs. The build artifacts for each remote node is uploaded.
+       It's a good first step to triage from these logs.
+2. You may have to log into remote node if the deployment succeeded, but something failed during runtime.
+    1. Get the private key for the testnet deployment from ```metrics-solana-com``` GCP instance.
+    2. SSH into ```metrics-solana-com``` using GCP console and do the following.
+    ```bash
+    sudo bash
+    cd ~buildkite-agent/.ssh
+    ls
+    ```
+    3. Copy the relevant private key to your local machine
+    4. Find the public IP address of the AWS instance for the remote node using AWS console
+    5. ```ssh -i <private key file> ubuntu@<ip address of remote node>```
+    6. The logs are in ```~solana\solana``` folder
+
+
 Benchmarking
 ---
 
-First install the nightly build of rustc. `cargo bench` requires unstable features:
+First install the nightly build of rustc. `cargo bench` requires use of the
+unstable features only available in the nightly build.
 
 ```bash
 $ rustup install nightly
@@ -139,7 +210,7 @@ $ rustup install nightly
 Run the benchmarks:
 
 ```bash
-$ cargo +nightly bench --features="unstable"
+$ cargo +nightly bench
 ```
 
 Release Process

RELEASE.md

@@ -43,8 +43,7 @@ the `master` branch as late as possible prior to the milestone release.
 
 ### v*X.Y.Z* release tag
 The release tags are created as desired by the owner of the given stabilization
-branch, and cause that *X.Y.Z* release to be shipped to https://crates.io,
-https://snapcraft.io/, and elsewhere.
+branch, and cause that *X.Y.Z* release to be shipped to https://crates.io
 
 Immediately after a new v*X.Y.Z* branch tag has been created, the `Cargo.toml`
 patch version number (*Z*) of the stabilization branch is incremented by the
@@ -62,29 +61,116 @@ There are three release channels that map to branches as follows:
 
 ## Release Steps
 
-### Changing channels
-
-When cutting a new channel branch these pre-steps are required:
+### Creating a new branch from master
 
+#### Create the new branch
 1. Pick your branch point for release on master.
-2. Create the branch.  The name should be "v" + the first 2 "version" fields from Cargo.toml.  For example, a Cargo.toml with version = "0.9.0" implies the next branch name is "v0.9".
-4. Push the new branch to the solana repository
-3. Update Cargo.toml on master to the next semantic version (e.g. 0.9.0 -> 0.10.0) by running `./scripts/increment-cargo-version.sh`.
-5. Land your Cargo.toml change as a master PR.
+1. Create the branch.  The name should be "v" + the first 2 "version" fields
+   from Cargo.toml.  For example, a Cargo.toml with version = "0.9.0" implies
+   the next branch name is "v0.9".
+    1.  Note the Cargo.toml in the repo root directory does not contain a version.  Look at any other Cargo.toml file.
+1. Create a new branch and push this branch to the solana repository.
+    1. `git checkout -b <branchname>`
+    1. `git push -u origin <branchname>`
 
-At this point, ci/channel-info.sh should show your freshly cut release branch as "BETA_CHANNEL" and the previous release branch as "STABLE_CHANNEL".
+#### Update master with the next version
 
-### Updating channels (i.e. "making a release")
+1. After the new branch has been created and pushed, update Cargo.toml on **master** to the next semantic version (e.g. 0.9.0 -> 0.10.0)
+   by running `./scripts/increment-cargo-version.sh`, then rebuild with
+   `cargo build` to cause a refresh of `Cargo.lock`.
+1. Push your Cargo.toml change and the autogenerated Cargo.lock changes to the
+   master branch
+
+At this point, `ci/channel-info.sh` should show your freshly cut release branch as
+"BETA_CHANNEL" and the previous release branch as "STABLE_CHANNEL".
+
+### Update documentation
+
+Document the new recommended version by updating
+```export SOLANA_RELEASE=[new scheduled TESTNET_TAG value]```
+in book/src/testnet-participation.md on the release (beta) branch.
+
+### Make the Release
 
 We use [github's Releases UI](https://github.com/solana-labs/solana/releases) for tagging a release.
 
 1. Go [there ;)](https://github.com/solana-labs/solana/releases).
-2. Click "Draft new release".  The release tag must exactly match the `version` field in `/Cargo.toml` prefixed by `v` (ie, `<branchname>.X`).
-3. If the first major release on the branch (e.g. v0.8.0), paste in [this template](https://raw.githubusercontent.com/solana-labs/solana/master/.github/RELEASE_TEMPLATE.md) and fill it in.
-4. Test the release by generating a tag using semver's rules.  First try at a release should be `<branchname>.X-rc.0`.
-5. Verify release automation:
+1. Click "Draft new release".  The release tag must exactly match the `version`
+   field in `/Cargo.toml` prefixed by `v` (ie, `<branchname>.X`).
+   1.  If the Cargo.toml verion field is **0.12.3**, then the release tag must be **v0.12.3**
+1. If this is the first release on the branch (e.g. v0.13.**0**), paste in [this
+   template](https://raw.githubusercontent.com/solana-labs/solana/master/.github/RELEASE_TEMPLATE.md)
+   and fill it in.
+1. Test the release by generating a tag using semver's rules.  First try at a
+   release should be `<branchname>.X-rc.0`.
+1. Verify release automation:
    1. [Crates.io](https://crates.io/crates/solana) should have an updated Solana version.
-   2. ...
-6. After testnet deployment, verify that testnets are running correct software.  http://metrics.solana.com should show testnet running on a hash from your newly created branch.
-7. Once the release has been made, update Cargo.toml on release to the next semantic version (e.g. 0.9.0 -> 0.9.1) by running `./scripts/increment-cargo-version.sh patch`.
+1. Once the release has been made, update Cargo.toml on the release branch to the next
+   semantic version (e.g. 0.9.0 -> 0.9.1) by running
+   `./scripts/increment-cargo-version.sh patch`, then rebuild with `cargo
+   build` to cause a refresh of `Cargo.lock`.
+1. Push your Cargo.toml change and the autogenerated Cargo.lock changes to the
+   release branch.
 
+### Publish updated Book
+We maintain three copies of the "book" as official documentation:
+
+1) "Book" is the documentation for the latest official release.  This should get manually updated whenever a new release is made.  It is published here:
+https://solana-labs.github.io/book/
+
+2) "Book-edge" tracks the tip of the master branch and updates automatically.
+https://solana-labs.github.io/book-edge/
+
+3) "Book-beta" tracks the tip of the beta branch and updates automatically.
+https://solana-labs.github.io/book-beta/
+
+To manually trigger an update of the "Book", create a new job of the manual-update-book pipeline.
+Set the tag of the latest release as the PUBLISH_BOOK_TAG environment variable.
+```bash
+PUBLISH_BOOK_TAG=v0.16.6
+```
+https://buildkite.com/solana-labs/manual-update-book
+
+### Update software on testnet.solana.com
+
+The testnet running on testnet.solana.com is set to use a fixed release tag
+which is set in the Buildkite testnet-management pipeline.
+This tag needs to be updated and the testnet restarted after a new release
+tag is created.
+
+#### Update testnet schedules
+
+Go to https://buildkite.com/solana-labs and click through: Pipelines ->
+testnet-management -> Pipeline Settings -> Schedules
+Or just click here:
+https://buildkite.com/solana-labs/testnet-management/settings/schedules
+
+There are two scheduled jobs for testnet: a daily restart and an hourly sanity-or-restart. \
+https://buildkite.com/solana-labs/testnet-management/settings/schedules/0efd7856-7143-4713-8817-47e6bdb05387
+https://buildkite.com/solana-labs/testnet-management/settings/schedules/2a926646-d972-42b5-aeb9-bb6759592a53
+
+On each schedule:
+1.  Set TESTNET_TAG environment variable to the desired release tag.
+    1. Example, TESTNET_TAG=v0.13.2
+1.  Set the Build Branch to the branch that TESTNET_TAG is from.
+    1. Example: v0.13
+
+#### Restart the testnet
+
+Trigger a TESTNET_OP=create-and-start to refresh the cluster with the new version
+
+1.  Go to https://buildkite.com/solana-labs/testnet-management
+2.  Click "New Build" and use the following settings, then click "Create Build"
+    1.  Commit: HEAD
+    1.  Branch: [channel branch as set in the schedules]
+    1.  Environment Variables:
+```
+TESTNET=testnet
+TESTNET_TAG=[same value as used in TESTNET_TAG in the schedules]
+TESTNET_OP=create-and-start
+```
+
+### Alert the community
+
+Notify Discord users on #validator-support that a new release for
+testnet.solana.com is available

bench-exchange/.gitignore

@@ -0,0 +1,3 @@
+/target/
+/config/
+/config-local/

bench-exchange/Cargo.toml

@@ -0,0 +1,42 @@
+[package]
+authors = ["Solana Maintainers <maintainers@solana.com>"]
+edition = "2018"
+name = "solana-bench-exchange"
+version = "0.16.7"
+repository = "https://github.com/solana-labs/solana"
+license = "Apache-2.0"
+homepage = "https://solana.com/"
+publish = false
+
+[dependencies]
+bincode = "1.1.4"
+bs58 = "0.2.0"
+clap = "2.32.0"
+env_logger = "0.6.0"
+itertools = "0.8.0"
+log = "0.4.6"
+num-derive = "0.2"
+num-traits = "0.2"
+rand = "0.6.5"
+rayon = "1.1.0"
+serde = "1.0.92"
+serde_derive = "1.0.92"
+serde_json = "1.0.39"
+serde_yaml = "0.8.9"
+# solana-runtime = { path = "../solana/runtime"}
+solana = { path = "../core", version = "0.16.7" }
+solana-client = { path = "../client", version = "0.16.7" }
+solana-drone = { path = "../drone", version = "0.16.7" }
+solana-exchange-api = { path = "../programs/exchange_api", version = "0.16.7" }
+solana-exchange-program = { path = "../programs/exchange_program", version = "0.16.7" }
+solana-logger = { path = "../logger", version = "0.16.7" }
+solana-metrics = { path = "../metrics", version = "0.16.7" }
+solana-netutil = { path = "../netutil", version = "0.16.7" }
+solana-runtime = { path = "../runtime", version = "0.16.7" }
+solana-sdk = { path = "../sdk", version = "0.16.7" }
+untrusted = "0.6.2"
+ws = "0.8.1"
+
+[features]
+cuda = ["solana/cuda"]
+

bench-exchange/README.md

@@ -0,0 +1,483 @@
+# token-exchange
+Solana Token Exchange Bench
+
+If you can't wait; jump to [Running the exchange](#Running-the-exchange) to
+learn how to start and interact with the exchange.
+
+### Table of Contents
+[Overview](#Overview)<br>
+[Premiss](#Premiss)<br>
+[Exchange startup](#Exchange-startup)<br>
+[Trade requests](#Trade-requests)<br>
+[Trade cancellations](#Trade-cancellations)<br>
+[Trade swap](#Trade-swap)<br>
+[Exchange program operations](#Exchange-program-operations)<br>
+[Quotes and OHLCV](#Quotes-and-OHLCV)<br>
+[Investor strategies](#Investor-strategies)<br>
+[Running the exchange](#Running-the-exchange)<br>
+
+## Overview
+
+An exchange is a marketplace where one asset can be traded for another.  This
+demo demonstrates one way to host an exchange on the Solana blockchain by
+emulating a currency exchange.
+
+The assets are virtual tokens held by investors who may post trade requests to
+the exchange.  A Swapper monitors the exchange and posts swap requests for
+matching trade orders.  All the transactions can execute concurrently.
+
+## Premise
+
+- Exchange
+  -  An exchange is a marketplace where one asset can be traded for another.
+     The exchange in this demo is the on-chain program that implements the
+     tokens and the policies for trading those tokens.
+- Token
+  - A virtual asset that can be owned, traded, and holds virtual intrinsic value
+    compared to other assets.  There are four types of tokens in this demo, A,
+    B, C, D.  Each one may be traded for another.
+- Token account
+  - An account owned by the exchange that holds a quantity of one type of token.
+- Account request
+  - A request to create a token account
+- Token request
+  - A request to deposit tokens of a particular type into a token account.
+- Token pair
+  - A unique ordered list of two tokens.  For the four types of tokens used in
+    this demo, the valid pairs are AB, AC, AD, BC, BD, CD.
+- Direction of trade
+  - Describes which token in the pair the investor wants to sell and buy and can
+    be either "To" or "From".  For example, if an investor issues a "To" trade
+    for "AB" then they which to exchange A tokens to B tokens.  A "From" order
+    would read the other way,  A tokens from B tokens.
+- Price ratio
+  -  An expression of the relative prices of two tokens.  They consist of the
+     price of the primary token and the price of the secondary token.  For
+     simplicity sake, the primary token's price is always 1, which forces the
+     secondary to be the common denominator.  For example, if token A was worth
+     2 and token B was worth 6, the price ratio would be 1:3 or just 3.  Price
+     ratios are represented as fixed point numbers.  The fixed point scaler is
+     defined in
+     [exchange_state.rs](https://github.com/solana-labs/solana/blob/c2fdd1362a029dcf89c8907c562d2079d977df11/programs/exchange_api/src/exchange_state.rs#L7)
+- Trade request
+  - A Solana transaction executed by the exchange requesting the trade of one
+    type of token for another.  Trade requests are made up of the token pair,
+    the direction of the trade, quantity of the primary token, the price ratio,
+    and the two token accounts to be credited/deducted.  An example trade
+    request looks like "T AB 5 2" which reads "Exchange 5 A tokens to B tokens
+    at a price ratio of 1:2"  A fulfilled trade would result in 5 A tokens
+    deducted and 10 B tokens credited to the trade initiator's token accounts.
+    Successful trade requests result in a trade order.
+- Trade order
+  - The result of a successful trade request.  Trade orders are stored in
+    accounts owned by the submitter of the trade request.  They can only be
+    canceled by their owner but can be used by anyone in a trade swap.  They
+    contain the same information as the trade request.
+- Price spread
+  - The difference between the two matching trade orders. The spread is the
+    profit of the Swapper initiating the swap request.
+- Swap requirements
+  - Policies that result in a successful trade swap.
+- Swap request
+  - A request to exchange tokens between to trade orders
+- Trade swap
+  - A successful trade.  A swap consists of two matching trade orders that meet
+    swap requirements.  A trade swap may not wholly satisfy one or both of the
+    trade orders in which case the trade orders are adjusted appropriately.  As
+    long as the swap requirements are met there will be an exchange of tokens
+    between accounts.  Any price spread is deposited into the Swapper's profit
+    account.  All trade swaps are recorded in a new account for posterity.
+- Investor
+  - Individual investors who hold a number of tokens and wish to trade them on
+    the exchange.  Investors operate as Solana thin clients who own a set of
+    accounts containing tokens and/or trade requests.  Investors post
+    transactions to the exchange in order to request tokens and post or cancel
+    trade requests.
+- Swapper
+  - An agent who facilitates trading between investors.  Swappers operate as
+    Solana thin clients who monitor all the trade orders looking for a trade
+    match.  Once found, the Swapper issues a swap request to the exchange.
+    Swappers are the engine of the exchange and are rewarded for their efforts by
+    accumulating the price spreads of the swaps they initiate.  Swappers also
+    provide current bid/ask price and OHLCV (Open, High, Low, Close, Volume)
+    information on demand via a public network port.
+- Transaction fees
+  - Solana transaction fees are paid for by the transaction submitters who are
+    the Investors and Swappers.
+
+## Exchange startup
+
+The exchange is up and running when it reaches a state where it can take
+investor's trades and Swapper's swap requests.  To achieve this state the
+following must occur in order:
+
+- Start the Solana blockchain
+- Start the Swapper thin-client
+- The Swapper subscribes to change notifications for all the accounts owned by
+  the exchange program id.  The subscription is managed via Solana's JSON RPC
+  interface.
+- The Swapper starts responding to queries for bid/ask price and OHLCV
+
+The Swapper responding successfully to price and OHLCV requests is the signal to
+the investors that trades submitted after that point will be analyzed.  <!--This
+is not ideal, and instead investors should be able to submit trades at any time,
+and the Swapper could come and go without missing a trade.  One way to achieve
+this is for the Swapper to read the current state of all accounts looking for all
+open trade orders.-->
+
+Investors will initially query the exchange to discover their current balance
+for each type of token.  If the investor does not already have an account for
+each type of token, they will submit account requests.  Swappers as well will
+request accounts to hold the tokens they earn by initiating trade swaps.
+
+```rust
+/// Supported token types
+pub enum Token {
+    A,
+    B,
+    C,
+    D,
+}
+
+/// Supported token pairs
+pub enum TokenPair {
+    AB,
+    AC,
+    AD,
+    BC,
+    BD,
+    CD,
+}
+
+pub enum ExchangeInstruction {
+    /// New token account
+    /// key 0 - Signer
+    /// key 1 - New token account
+    AccountRequest,
+}
+
+/// Token accounts are populated with this structure
+pub struct TokenAccountInfo {
+    /// Investor who owns this account
+    pub owner: Pubkey,
+    /// Current number of tokens this account holds
+    pub tokens: Tokens,
+}
+```
+
+For this demo investors or Swappers can request more tokens from the exchange at
+any time by submitting token requests. In non-demos, an exchange of this type
+would provide another way to exchange a 3rd party asset into tokens.
+
+To request tokens, investors submit transfer requests:
+
+```rust
+pub enum ExchangeInstruction {
+    /// Transfer tokens between two accounts
+    /// key 0 - Account to transfer tokens to
+    /// key 1 - Account to transfer tokens from.  This can be the exchange program itself,
+    ///         the exchange has a limitless number of tokens it can transfer.
+    TransferRequest(Token, u64),
+}
+```
+
+## Trade requests
+
+When an investor decides to exchange a token of one type for another, they
+submit a transaction to the Solana Blockchain containing a trade request, which,
+if successful, is turned into a trade order.  Trade orders do not expire but are
+cancellable. <!-- Trade orders should have a timestamp to enable trade
+expiration -->  When a trade order is created, tokens are deducted from a token
+account and the trade order acts as an escrow.  The tokens are held until the
+trade order is fulfilled or canceled. If the direction is `To`, then the number
+of `tokens` are deducted from the primary account, if `From` then `tokens`
+multiplied by `price` are deducted from the secondary account.  Trade orders are
+no longer valid when the number of `tokens` goes to zero, at which point they
+can no longer be used. <!-- Could support refilling trade orders, so trade order
+accounts are refilled rather than accumulating -->
+
+```rust
+/// Direction of the exchange between two tokens in a pair
+pub enum Direction {
+    /// Trade first token type (primary) in the pair 'To' the second
+    To,
+    /// Trade first token type in the pair 'From' the second (secondary)
+    From,
+}
+
+pub struct TradeRequestInfo {
+    /// Direction of trade
+    pub direction: Direction,
+
+    /// Token pair to trade
+    pub pair: TokenPair,
+
+    /// Number of tokens to exchange; refers to the primary or the secondary depending on the direction
+    pub tokens: u64,
+
+    /// The price ratio the primary price over the secondary price.  The primary price is fixed
+    /// and equal to the variable `SCALER`.
+    pub price: u64,
+
+    /// Token account to deposit tokens on successful swap
+    pub dst_account: Pubkey,
+}
+
+pub enum ExchangeInstruction {
+    /// Trade request
+    /// key 0 - Signer
+    /// key 1 - Account in which to record the swap
+    /// key 2 - Token account associated with this trade
+    TradeRequest(TradeRequestInfo),
+}
+
+/// Trade accounts are populated with this structure
+pub struct TradeOrderInfo {
+    /// Owner of the trade order
+    pub owner: Pubkey,
+    /// Direction of the exchange
+    pub direction: Direction,
+    /// Token pair indicating two tokens to exchange, first is primary
+    pub pair: TokenPair,
+    /// Number of tokens to exchange; primary or secondary depending on direction
+    pub tokens: u64,
+    /// Scaled price of the secondary token given the primary is equal to the scale value
+    /// If scale is 1 and price is 2 then ratio is 1:2 or 1 primary token for 2 secondary tokens
+    pub price: u64,
+    /// account which the tokens were source from.  The trade account holds the tokens in escrow
+    /// until either one or more part of a swap or the trade is canceled.
+    pub src_account: Pubkey,
+    /// account which the tokens the tokens will be deposited into on a successful trade
+    pub dst_account: Pubkey,
+}
+```
+
+## Trade cancellations
+
+An investor may cancel a trade at anytime, but only trades they own.  If the
+cancellation is successful, any tokens held in escrow are returned to the
+account from which they came.
+
+```rust
+pub enum ExchangeInstruction {
+    /// Trade cancellation
+    /// key 0 - Signer
+    /// key 1 -Trade order to cancel
+    TradeCancellation,
+}
+```
+
+## Trade swaps
+
+The Swapper is monitoring the accounts assigned to the exchange program and
+building a trade-order table.  The trade order table is used to identify
+matching trade orders which could be fulfilled.  When a match is found the
+Swapper should issue a swap request.  Swap requests may not satisfy the entirety
+of either order, but the exchange will greedily fulfill it.  Any leftover tokens
+in either account will keep the trade order valid for further swap requests in
+the future.
+
+Matching trade orders are defined by the following swap requirements:
+
+- Opposite polarity (one `To` and one `From`)
+- Operate on the same token pair
+- The price ratio of the `From` order is greater than or equal to the `To` order
+- There are sufficient tokens to perform the trade
+
+Orders can be written in the following format:
+
+`investor direction pair quantity price-ratio`
+
+For example:
+
+- `1 T AB 2 1`
+  - Investor 1 wishes to exchange 2 A tokens to B tokens at a ratio of 1 A to 1
+    B
+- `2 F AC 6 1.2`
+  - Investor 2 wishes to exchange A tokens from 6 B tokens at a ratio of 1 A
+    from 1.2 B
+
+An order table could look something like the following. Notice how the columns
+are sorted low to high and high to low, respectively.  Prices are dramatic and
+whole for clarity.
+
+|Row| To          | From       |
+|---|-------------|------------|
+| 1 | 1 T AB 2 4  | 2 F AB 2 8 |
+| 2 | 1 T AB 1 4  | 2 F AB 2 8 |
+| 3 | 1 T AB 6 6  | 2 F AB 2 7 |
+| 4 | 1 T AB 2 8  | 2 F AB 3 6 |
+| 5 | 1 T AB 2 10 | 2 F AB 1 5 |
+
+As part of a successful swap request, the exchange will credit tokens to the
+Swapper's account equal to the difference in the price ratios or the two orders.
+These tokens are considered the Swapper's profit for initiating the trade.
+
+The Swapper would initiate the following swap on the order table above:
+
+  - Row 1, To:   Investor 1 trades 2 A tokens to 8 B tokens
+  - Row 1, From: Investor 2 trades 2 A tokens from 8 B tokens
+  - Swapper takes 8 B tokens as profit
+
+Both row 1 trades are fully realized, table becomes:
+
+|Row| To          | From       |
+|---|-------------|------------|
+| 1 | 1 T AB 1 4  | 2 F AB 2 8 |
+| 2 | 1 T AB 6 6  | 2 F AB 2 7 |
+| 3 | 1 T AB 2 8  | 2 F AB 3 6 |
+| 4 | 1 T AB 2 10 | 2 F AB 1 5 |
+
+The Swapper would initiate the following swap:
+
+  - Row 1, To:   Investor 1 trades 1 A token to 4 B tokens
+  - Row 1, From: Investor 2 trades 1 A token from 4 B tokens
+  - Swapper takes 4 B tokens as profit
+
+Row 1 From is not fully realized, table becomes:
+
+|Row| To          | From       |
+|---|-------------|------------|
+| 1 | 1 T AB 6 6  | 2 F AB 1 8 |
+| 2 | 1 T AB 2 8  | 2 F AB 2 7 |
+| 3 | 1 T AB 2 10 | 2 F AB 3 6 |
+| 4 |             | 2 F AB 1 5 |
+
+The Swapper would initiate the following swap:
+
+  - Row 1, To:   Investor 1 trades 1 A token to 6 B tokens
+  - Row 1, From: Investor 2 trades 1 A token from 6 B tokens
+  - Swapper takes 2 B tokens as profit
+
+Row 1 To is now fully realized, table becomes:
+
+|Row| To          | From       |
+|---|-------------|------------|
+| 1 | 1 T AB 5 6  | 2 F AB 2 7 |
+| 2 | 1 T AB 2 8  | 2 F AB 3 5 |
+| 3 | 1 T AB 2 10 | 2 F AB 1 5 |
+
+The Swapper would initiate the following last swap:
+
+  - Row 1, To:   Investor 1 trades 2 A token to 12 B tokens
+  - Row 1, From: Investor 2 trades 2 A token from 12 B tokens
+  - Swapper takes 4 B tokens as profit
+
+Table becomes:
+
+|Row| To          | From       |
+|---|-------------|------------|
+| 1 | 1 T AB 3 6  | 2 F AB 3 5 |
+| 2 | 1 T AB 2 8  | 2 F AB 1 5 |
+| 3 | 1 T AB 2 10 |            |
+
+At this point the lowest To's price is larger than the largest From's price so
+no more swaps would be initiated until new orders came in.
+
+```rust
+pub enum ExchangeInstruction {
+    /// Trade swap request
+    /// key 0 - Signer
+    /// key 1 - Account in which to record the swap
+    /// key 2 - 'To' trade order
+    /// key 3 - `From` trade order
+    /// key 4 - Token account associated with the To Trade
+    /// key 5 - Token account associated with From trade
+    /// key 6 - Token account in which to deposit the Swappers profit from the swap.
+    SwapRequest,
+}
+
+/// Swap accounts are populated with this structure
+pub struct TradeSwapInfo {
+    /// Pair swapped
+    pub pair: TokenPair,
+    /// `To` trade order
+    pub to_trade_order: Pubkey,
+    /// `From` trade order
+    pub from_trade_order: Pubkey,
+    /// Number of primary tokens exchanged
+    pub primary_tokens: u64,
+    /// Price the primary tokens were exchanged for
+    pub primary_price: u64,
+    /// Number of secondary tokens exchanged
+    pub secondary_tokens: u64,
+    /// Price the secondary tokens were exchanged for
+    pub secondary_price: u64,
+}
+```
+
+## Exchange program operations
+
+Putting all the commands together from above, the following operations will be
+supported by the on-chain exchange program:
+
+```rust
+pub enum ExchangeInstruction {
+    /// New token account
+    /// key 0 - Signer
+    /// key 1 - New token account
+    AccountRequest,
+
+    /// Transfer tokens between two accounts
+    /// key 0 - Account to transfer tokens to
+    /// key 1 - Account to transfer tokens from.  This can be the exchange program itself,
+    ///         the exchange has a limitless number of tokens it can transfer.
+    TransferRequest(Token, u64),
+
+    /// Trade request
+    /// key 0 - Signer
+    /// key 1 - Account in which to record the swap
+    /// key 2 - Token account associated with this trade
+    TradeRequest(TradeRequestInfo),
+
+    /// Trade cancellation
+    /// key 0 - Signer
+    /// key 1 -Trade order to cancel
+    TradeCancellation,
+
+    /// Trade swap request
+    /// key 0 - Signer
+    /// key 1 - Account in which to record the swap
+    /// key 2 - 'To' trade order
+    /// key 3 - `From` trade order
+    /// key 4 - Token account associated with the To Trade
+    /// key 5 - Token account associated with From trade
+    /// key 6 - Token account in which to deposit the Swappers profit from the swap.
+    SwapRequest,
+}
+```
+
+## Quotes and OHLCV
+
+The Swapper will provide current bid/ask price quotes based on trade actively and
+also provide OHLCV based on some time window.  The details of how the bid/ask
+price quotes are calculated are yet to be decided.
+
+## Investor strategies
+
+To make a compelling demo, the investors needs to provide interesting trade
+behavior.  Something as simple as a randomly twiddled baseline would be a
+minimum starting point.
+
+## Running the exchange
+
+The exchange bench posts trades and swaps matches as fast as it can.  
+
+You might want to bump the duration up
+to 60 seconds and the batch size to 1000 for better numbers.  You can modify those
+in client_demo/src/demo.rs::test_exchange_local_cluster.
+
+The following command runs the bench:
+
+```bash
+$ RUST_LOG=solana_bench_exchange=info cargo test --release -- --nocapture test_exchange_local_cluster
+```
+
+To also see the cluster messages:
+
+```bash
+$ RUST_LOG=solana_bench_exchange=info,solana=info cargo test --release -- --nocapture test_exchange_local_cluster
+```
+
+
+

bench-exchange/src/cli.rs

@@ -0,0 +1,218 @@
+use clap::{crate_description, crate_name, crate_version, value_t, App, Arg, ArgMatches};
+use solana::gen_keys::GenKeys;
+use solana_drone::drone::DRONE_PORT;
+use solana_sdk::signature::{read_keypair, Keypair, KeypairUtil};
+use std::net::SocketAddr;
+use std::process::exit;
+use std::time::Duration;
+
+pub struct Config {
+    pub entrypoint_addr: SocketAddr,
+    pub drone_addr: SocketAddr,
+    pub identity: Keypair,
+    pub threads: usize,
+    pub num_nodes: usize,
+    pub duration: Duration,
+    pub transfer_delay: u64,
+    pub fund_amount: u64,
+    pub batch_size: usize,
+    pub chunk_size: usize,
+    pub account_groups: usize,
+    pub client_ids_and_stake_file: String,
+    pub write_to_client_file: bool,
+    pub read_from_client_file: bool,
+}
+
+impl Default for Config {
+    fn default() -> Self {
+        Self {
+            entrypoint_addr: SocketAddr::from(([127, 0, 0, 1], 8001)),
+            drone_addr: SocketAddr::from(([127, 0, 0, 1], DRONE_PORT)),
+            identity: Keypair::new(),
+            num_nodes: 1,
+            threads: 4,
+            duration: Duration::new(u64::max_value(), 0),
+            transfer_delay: 0,
+            fund_amount: 100_000,
+            batch_size: 100,
+            chunk_size: 100,
+            account_groups: 100,
+            client_ids_and_stake_file: String::new(),
+            write_to_client_file: false,
+            read_from_client_file: false,
+        }
+    }
+}
+
+pub fn build_args<'a, 'b>() -> App<'a, 'b> {
+    App::new(crate_name!())
+        .about(crate_description!())
+        .version(crate_version!())
+        .arg(
+            Arg::with_name("entrypoint")
+                .short("n")
+                .long("entrypoint")
+                .value_name("HOST:PORT")
+                .takes_value(true)
+                .required(false)
+                .default_value("127.0.0.1:8001")
+                .help("Cluster entry point; defaults to 127.0.0.1:8001"),
+        )
+        .arg(
+            Arg::with_name("drone")
+                .short("d")
+                .long("drone")
+                .value_name("HOST:PORT")
+                .takes_value(true)
+                .required(false)
+                .default_value("127.0.0.1:9900")
+                .help("Location of the drone; defaults to 127.0.0.1:9900"),
+        )
+        .arg(
+            Arg::with_name("identity")
+                .short("i")
+                .long("identity")
+                .value_name("PATH")
+                .takes_value(true)
+                .help("File containing a client identity (keypair)"),
+        )
+        .arg(
+            Arg::with_name("threads")
+                .long("threads")
+                .value_name("<threads>")
+                .takes_value(true)
+                .required(false)
+                .default_value("1")
+                .help("Number of threads submitting transactions"),
+        )
+        .arg(
+            Arg::with_name("num-nodes")
+                .long("num-nodes")
+                .value_name("NUM")
+                .takes_value(true)
+                .required(false)
+                .default_value("1")
+                .help("Wait for NUM nodes to converge"),
+        )
+        .arg(
+            Arg::with_name("duration")
+                .long("duration")
+                .value_name("SECS")
+                .takes_value(true)
+                .default_value("60")
+                .help("Seconds to run benchmark, then exit; default is forever"),
+        )
+        .arg(
+            Arg::with_name("transfer-delay")
+                .long("transfer-delay")
+                .value_name("<delay>")
+                .takes_value(true)
+                .required(false)
+                .default_value("0")
+                .help("Delay between each chunk"),
+        )
+        .arg(
+            Arg::with_name("fund-amount")
+                .long("fund-amount")
+                .value_name("<fund>")
+                .takes_value(true)
+                .required(false)
+                .default_value("100000")
+                .help("Number of lamports to fund to each signer"),
+        )
+        .arg(
+            Arg::with_name("batch-size")
+                .long("batch-size")
+                .value_name("<batch>")
+                .takes_value(true)
+                .required(false)
+                .default_value("1000")
+                .help("Number of transactions before the signer rolls over"),
+        )
+        .arg(
+            Arg::with_name("chunk-size")
+                .long("chunk-size")
+                .value_name("<cunk>")
+                .takes_value(true)
+                .required(false)
+                .default_value("500")
+                .help("Number of transactions to generate and send at a time"),
+        )
+        .arg(
+            Arg::with_name("account-groups")
+                .long("account-groups")
+                .value_name("<groups>")
+                .takes_value(true)
+                .required(false)
+                .default_value("10")
+                .help("Number of account groups to cycle for each batch"),
+        )
+        .arg(
+            Arg::with_name("write-client-keys")
+                .long("write-client-keys")
+                .value_name("FILENAME")
+                .takes_value(true)
+                .help("Generate client keys and stakes and write the list to YAML file"),
+        )
+        .arg(
+            Arg::with_name("read-client-keys")
+                .long("read-client-keys")
+                .value_name("FILENAME")
+                .takes_value(true)
+                .help("Read client keys and stakes from the YAML file"),
+        )
+}
+
+pub fn extract_args<'a>(matches: &ArgMatches<'a>) -> Config {
+    let mut args = Config::default();
+
+    args.entrypoint_addr = solana_netutil::parse_host_port(matches.value_of("entrypoint").unwrap())
+        .unwrap_or_else(|e| {
+            eprintln!("failed to parse entrypoint address: {}", e);
+            exit(1)
+        });
+
+    args.drone_addr = solana_netutil::parse_host_port(matches.value_of("drone").unwrap())
+        .unwrap_or_else(|e| {
+            eprintln!("failed to parse drone address: {}", e);
+            exit(1)
+        });
+
+    if matches.is_present("identity") {
+        args.identity = read_keypair(matches.value_of("identity").unwrap())
+            .expect("can't read client identity");
+    } else {
+        args.identity = {
+            let seed = [42_u8; 32];
+            let mut rnd = GenKeys::new(seed);
+            rnd.gen_keypair()
+        };
+    }
+    args.threads = value_t!(matches.value_of("threads"), usize).expect("Failed to parse threads");
+    args.num_nodes =
+        value_t!(matches.value_of("num-nodes"), usize).expect("Failed to parse num-nodes");
+    let duration = value_t!(matches.value_of("duration"), u64).expect("Failed to parse duration");
+    args.duration = Duration::from_secs(duration);
+    args.transfer_delay =
+        value_t!(matches.value_of("transfer-delay"), u64).expect("Failed to parse transfer-delay");
+    args.fund_amount =
+        value_t!(matches.value_of("fund-amount"), u64).expect("Failed to parse fund-amount");
+    args.batch_size =
+        value_t!(matches.value_of("batch-size"), usize).expect("Failed to parse batch-size");
+    args.chunk_size =
+        value_t!(matches.value_of("chunk-size"), usize).expect("Failed to parse chunk-size");
+    args.account_groups = value_t!(matches.value_of("account-groups"), usize)
+        .expect("Failed to parse account-groups");
+
+    if let Some(s) = matches.value_of("write-client-keys") {
+        args.write_to_client_file = true;
+        args.client_ids_and_stake_file = s.to_string();
+    }
+
+    if let Some(s) = matches.value_of("read-client-keys") {
+        assert!(!args.write_to_client_file);
+        args.read_from_client_file = true;
+        args.client_ids_and_stake_file = s.to_string();
+    }
+    args
+}

bench-exchange/src/main.rs

@@ -0,0 +1,87 @@
+pub mod bench;
+mod cli;
+pub mod order_book;
+
+#[cfg(test)]
+#[macro_use]
+extern crate solana_exchange_program;
+
+use crate::bench::{airdrop_lamports, create_client_accounts_file, do_bench_exchange, Config};
+use log::*;
+use solana::gossip_service::{discover_cluster, get_multi_client};
+use solana_sdk::signature::KeypairUtil;
+
+fn main() {
+    solana_logger::setup();
+    solana_metrics::set_panic_hook("bench-exchange");
+
+    let matches = cli::build_args().get_matches();
+    let cli_config = cli::extract_args(&matches);
+
+    let cli::Config {
+        entrypoint_addr,
+        drone_addr,
+        identity,
+        threads,
+        num_nodes,
+        duration,
+        transfer_delay,
+        fund_amount,
+        batch_size,
+        chunk_size,
+        account_groups,
+        client_ids_and_stake_file,
+        write_to_client_file,
+        read_from_client_file,
+        ..
+    } = cli_config;
+
+    let config = Config {
+        identity,
+        threads,
+        duration,
+        transfer_delay,
+        fund_amount,
+        batch_size,
+        chunk_size,
+        account_groups,
+        client_ids_and_stake_file,
+        read_from_client_file,
+    };
+
+    if write_to_client_file {
+        create_client_accounts_file(
+            &config.client_ids_and_stake_file,
+            config.batch_size,
+            config.account_groups,
+            config.fund_amount,
+        );
+    } else {
+        info!("Connecting to the cluster");
+        let (nodes, _replicators) =
+            discover_cluster(&entrypoint_addr, num_nodes).unwrap_or_else(|_| {
+                panic!("Failed to discover nodes");
+            });
+
+        let (client, num_clients) = get_multi_client(&nodes);
+
+        info!("{} nodes found", num_clients);
+        if num_clients < num_nodes {
+            panic!("Error: Insufficient nodes discovered");
+        }
+
+        if !read_from_client_file {
+            info!("Funding keypair: {}", config.identity.pubkey());
+
+            let accounts_in_groups = batch_size * account_groups;
+            const NUM_SIGNERS: u64 = 2;
+            airdrop_lamports(
+                &client,
+                &drone_addr,
+                &config.identity,
+                fund_amount * (accounts_in_groups + 1) as u64 * NUM_SIGNERS,
+            );
+        }
+        do_bench_exchange(vec![client], config);
+    }
+}

bench-exchange/src/order_book.rs

@@ -0,0 +1,138 @@
+use itertools::EitherOrBoth::{Both, Left, Right};
+use itertools::Itertools;
+use log::*;
+use solana_exchange_api::exchange_state::*;
+use solana_sdk::pubkey::Pubkey;
+use std::cmp::Ordering;
+use std::collections::BinaryHeap;
+use std::{error, fmt};
+
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub struct ToOrder {
+    pub pubkey: Pubkey,
+    pub info: TradeOrderInfo,
+}
+
+impl Ord for ToOrder {
+    fn cmp(&self, other: &Self) -> Ordering {
+        other.info.price.cmp(&self.info.price)
+    }
+}
+impl PartialOrd for ToOrder {
+    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+        Some(self.cmp(other))
+    }
+}
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub struct FromOrder {
+    pub pubkey: Pubkey,
+    pub info: TradeOrderInfo,
+}
+
+impl Ord for FromOrder {
+    fn cmp(&self, other: &Self) -> Ordering {
+        self.info.price.cmp(&other.info.price)
+    }
+}
+impl PartialOrd for FromOrder {
+    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+        Some(self.cmp(other))
+    }
+}
+
+#[derive(Default)]
+pub struct OrderBook {
+    // TODO scale to x token types
+    to_ab: BinaryHeap<ToOrder>,
+    from_ab: BinaryHeap<FromOrder>,
+}
+impl fmt::Display for OrderBook {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        writeln!(
+            f,
+            "+-Order Book--------------------------+-------------------------------------+"
+        )?;
+        for (i, it) in self
+            .to_ab
+            .iter()
+            .zip_longest(self.from_ab.iter())
+            .enumerate()
+        {
+            match it {
+                Both(to, from) => writeln!(
+                    f,
+                    "| T AB {:8} for {:8}/{:8} | F AB {:8} for {:8}/{:8} |{}",
+                    to.info.tokens,
+                    SCALER,
+                    to.info.price,
+                    from.info.tokens,
+                    SCALER,
+                    from.info.price,
+                    i
+                )?,
+                Left(to) => writeln!(
+                    f,
+                    "| T AB {:8} for {:8}/{:8} |                                     |{}",
+                    to.info.tokens, SCALER, to.info.price, i
+                )?,
+                Right(from) => writeln!(
+                    f,
+                    "|                                     | F AB {:8} for {:8}/{:8} |{}",
+                    from.info.tokens, SCALER, from.info.price, i
+                )?,
+            }
+        }
+        write!(
+            f,
+            "+-------------------------------------+-------------------------------------+"
+        )?;
+        Ok(())
+    }
+}
+
+impl OrderBook {
+    // TODO
+    // pub fn cancel(&mut self, pubkey: Pubkey) -> Result<(), Box<dyn error::Error>> {
+    //     Ok(())
+    // }
+    pub fn push(
+        &mut self,
+        pubkey: Pubkey,
+        info: TradeOrderInfo,
+    ) -> Result<(), Box<dyn error::Error>> {
+        check_trade(info.direction, info.tokens, info.price)?;
+        match info.direction {
+            Direction::To => {
+                self.to_ab.push(ToOrder { pubkey, info });
+            }
+            Direction::From => {
+                self.from_ab.push(FromOrder { pubkey, info });
+            }
+        }
+        Ok(())
+    }
+    pub fn pop(&mut self) -> Option<(ToOrder, FromOrder)> {
+        if let Some(pair) = Self::pop_pair(&mut self.to_ab, &mut self.from_ab) {
+            return Some(pair);
+        }
+        None
+    }
+    pub fn get_num_outstanding(&self) -> (usize, usize) {
+        (self.to_ab.len(), self.from_ab.len())
+    }
+
+    fn pop_pair(
+        to_ab: &mut BinaryHeap<ToOrder>,
+        from_ab: &mut BinaryHeap<FromOrder>,
+    ) -> Option<(ToOrder, FromOrder)> {
+        let to = to_ab.peek()?;
+        let from = from_ab.peek()?;
+        if from.info.price < to.info.price {
+            debug!("Trade not viable");
+            return None;
+        }
+        let to = to_ab.pop()?;
+        let from = from_ab.pop()?;
+        Some((to, from))
+    }
+}

bench-streamer/.gitignore

@@ -0,0 +1 @@
+/target/

bench-streamer/Cargo.toml

@@ -2,16 +2,17 @@
 authors = ["Solana Maintainers <maintainers@solana.com>"]
 edition = "2018"
 name = "solana-bench-streamer"
-version = "0.11.0"
+version = "0.16.7"
 repository = "https://github.com/solana-labs/solana"
 license = "Apache-2.0"
 homepage = "https://solana.com/"
 
 [dependencies]
-clap = "2.32.0"
-solana = { path = "..", version = "0.11.0" }
-solana-logger = { path = "../logger", version = "0.11.0" }
-solana-netutil = { path = "../netutil", version = "0.11.0" }
+clap = "2.33.0"
+solana = { path = "../core", version = "0.16.7" }
+solana-logger = { path = "../logger", version = "0.16.7" }
+solana-netutil = { path = "../netutil", version = "0.16.7" }
 
 [features]
-cuda = []
+cuda = ["solana/cuda"]
+

bench-streamer/src/main.rs

@@ -1,5 +1,5 @@
-use clap::{App, Arg};
-use solana::packet::{Packet, SharedPackets, BLOB_SIZE, PACKET_DATA_SIZE};
+use clap::{crate_description, crate_name, crate_version, App, Arg};
+use solana::packet::{Packet, Packets, BLOB_SIZE, PACKET_DATA_SIZE};
 use solana::result::Result;
 use solana::streamer::{receiver, PacketReceiver};
 use std::cmp::max;
@@ -14,19 +14,19 @@ use std::time::SystemTime;
 
 fn producer(addr: &SocketAddr, exit: Arc<AtomicBool>) -> JoinHandle<()> {
     let send = UdpSocket::bind("0.0.0.0:0").unwrap();
-    let msgs = SharedPackets::default();
-    let msgs_ = msgs.clone();
-    msgs.write().unwrap().packets.resize(10, Packet::default());
-    for w in &mut msgs.write().unwrap().packets {
+    let mut msgs = Packets::default();
+    msgs.packets.resize(10, Packet::default());
+    for w in &mut msgs.packets {
         w.meta.size = PACKET_DATA_SIZE;
         w.meta.set_addr(&addr);
     }
+    let msgs = Arc::new(msgs);
     spawn(move || loop {
         if exit.load(Ordering::Relaxed) {
             return;
         }
         let mut num = 0;
-        for p in &msgs_.read().unwrap().packets {
+        for p in &msgs.packets {
             let a = p.meta.addr();
             assert!(p.meta.size < BLOB_SIZE);
             send.send_to(&p.data[..p.meta.size], &a).unwrap();
@@ -43,7 +43,7 @@ fn sink(exit: Arc<AtomicBool>, rvs: Arc<AtomicUsize>, r: PacketReceiver) -> Join
         }
         let timer = Duration::new(1, 0);
         if let Ok(msgs) = r.recv_timeout(timer) {
-            rvs.fetch_add(msgs.read().unwrap().packets.len(), Ordering::Relaxed);
+            rvs.fetch_add(msgs.packets.len(), Ordering::Relaxed);
         }
     })
 }
@@ -51,7 +51,9 @@ fn sink(exit: Arc<AtomicBool>, rvs: Arc<AtomicUsize>, r: PacketReceiver) -> Join
 fn main() -> Result<()> {
     let mut num_sockets = 1usize;
 
-    let matches = App::new("solana-bench-streamer")
+    let matches = App::new(crate_name!())
+        .about(crate_description!())
+        .version(crate_version!())
         .arg(
             Arg::with_name("num-recv-sockets")
                 .long("num-recv-sockets")
@@ -81,12 +83,7 @@ fn main() -> Result<()> {
 
         let (s_reader, r_reader) = channel();
         read_channels.push(r_reader);
-        read_threads.push(receiver(
-            Arc::new(read),
-            exit.clone(),
-            s_reader,
-            "bench-streamer",
-        ));
+        read_threads.push(receiver(Arc::new(read), &exit, s_reader));
     }
 
     let t_producer1 = producer(&addr, exit.clone());

bench-tps/.gitignore

@@ -0,0 +1,3 @@
+/target/
+/config/
+/config-local/

bench-tps/Cargo.toml

@@ -2,20 +2,28 @@
 authors = ["Solana Maintainers <maintainers@solana.com>"]
 edition = "2018"
 name = "solana-bench-tps"
-version = "0.11.0"
+version = "0.16.7"
 repository = "https://github.com/solana-labs/solana"
 license = "Apache-2.0"
 homepage = "https://solana.com/"
 
 [dependencies]
-clap = "2.32.0"
-rayon = "1.0.3"
-serde_json = "1.0.10"
-solana = { path = "..", version = "0.11.0" }
-solana-drone = { path = "../drone", version = "0.11.0" }
-solana-logger = { path = "../logger", version = "0.11.0" }
-solana-metrics = { path = "../metrics", version = "0.11.0" }
-solana-sdk = { path = "../sdk", version = "0.11.0" }
+clap = "2.33.0"
+log = "0.4.6"
+rayon = "1.1.0"
+serde = "1.0.92"
+serde_derive = "1.0.92"
+serde_json = "1.0.39"
+serde_yaml = "0.8.9"
+solana = { path = "../core", version = "0.16.7" }
+solana-client = { path = "../client", version = "0.16.7" }
+solana-drone = { path = "../drone", version = "0.16.7" }
+solana-logger = { path = "../logger", version = "0.16.7" }
+solana-metrics = { path = "../metrics", version = "0.16.7" }
+solana-netutil = { path = "../netutil", version = "0.16.7" }
+solana-runtime = { path = "../runtime", version = "0.16.7" }
+solana-sdk = { path = "../sdk", version = "0.16.7" }
 
 [features]
-cuda = []
+cuda = ["solana/cuda"]
+

bench-tps/src/bench.rs

@@ -1,182 +1,234 @@
 use solana_metrics;
 
+use log::*;
 use rayon::prelude::*;
-use solana::client::mk_client;
-use solana::cluster_info::NodeInfo;
-use solana::thin_client::ThinClient;
+use solana::gen_keys::GenKeys;
+use solana_client::perf_utils::{sample_txs, SampleStats};
 use solana_drone::drone::request_airdrop_transaction;
-use solana_metrics::influxdb;
+use solana_metrics::datapoint_info;
+use solana_sdk::client::Client;
 use solana_sdk::hash::Hash;
 use solana_sdk::signature::{Keypair, KeypairUtil};
-use solana_sdk::system_transaction::SystemTransaction;
+use solana_sdk::system_instruction;
+use solana_sdk::system_transaction;
 use solana_sdk::timing::timestamp;
 use solana_sdk::timing::{duration_as_ms, duration_as_s};
 use solana_sdk::transaction::Transaction;
 use std::cmp;
 use std::collections::VecDeque;
 use std::net::SocketAddr;
-use std::process::exit;
 use std::sync::atomic::{AtomicBool, AtomicIsize, AtomicUsize, Ordering};
 use std::sync::{Arc, RwLock};
 use std::thread::sleep;
+use std::thread::Builder;
 use std::time::Duration;
 use std::time::Instant;
 
-pub struct NodeStats {
-    /// Maximum TPS reported by this node
-    pub tps: f64,
-    /// Total transactions reported by this node
-    pub tx: u64,
+pub const MAX_SPENDS_PER_TX: u64 = 4;
+pub const NUM_LAMPORTS_PER_ACCOUNT: u64 = 128;
+
+#[derive(Debug)]
+pub enum BenchTpsError {
+    AirdropFailure,
 }
 
-pub const MAX_SPENDS_PER_TX: usize = 4;
+pub type Result<T> = std::result::Result<T, BenchTpsError>;
 
 pub type SharedTransactions = Arc<RwLock<VecDeque<Vec<(Transaction, u64)>>>>;
 
-pub fn metrics_submit_token_balance(token_balance: u64) {
-    println!("Token balance: {}", token_balance);
-    solana_metrics::submit(
-        influxdb::Point::new("bench-tps")
-            .add_tag("op", influxdb::Value::String("token_balance".to_string()))
-            .add_field("balance", influxdb::Value::Integer(token_balance as i64))
-            .to_owned(),
+pub struct Config {
+    pub id: Keypair,
+    pub threads: usize,
+    pub thread_batch_sleep_ms: usize,
+    pub duration: Duration,
+    pub tx_count: usize,
+    pub sustained: bool,
+}
+
+impl Default for Config {
+    fn default() -> Self {
+        Self {
+            id: Keypair::new(),
+            threads: 4,
+            thread_batch_sleep_ms: 0,
+            duration: Duration::new(std::u64::MAX, 0),
+            tx_count: 500_000,
+            sustained: false,
+        }
+    }
+}
+
+pub fn do_bench_tps<T>(
+    clients: Vec<T>,
+    config: Config,
+    gen_keypairs: Vec<Keypair>,
+    keypair0_balance: u64,
+) -> u64
+where
+    T: 'static + Client + Send + Sync,
+{
+    let Config {
+        id,
+        threads,
+        thread_batch_sleep_ms,
+        duration,
+        tx_count,
+        sustained,
+    } = config;
+
+    let clients: Vec<_> = clients.into_iter().map(Arc::new).collect();
+    let client = &clients[0];
+
+    let start = gen_keypairs.len() - (tx_count * 2) as usize;
+    let keypairs = &gen_keypairs[start..];
+
+    let first_tx_count = client.get_transaction_count().expect("transaction count");
+    println!("Initial transaction count {}", first_tx_count);
+
+    let exit_signal = Arc::new(AtomicBool::new(false));
+
+    // Setup a thread per validator to sample every period
+    // collect the max transaction rate and total tx count seen
+    let maxes = Arc::new(RwLock::new(Vec::new()));
+    let sample_period = 1; // in seconds
+    println!("Sampling TPS every {} second...", sample_period);
+    let v_threads: Vec<_> = clients
+        .iter()
+        .map(|client| {
+            let exit_signal = exit_signal.clone();
+            let maxes = maxes.clone();
+            let client = client.clone();
+            Builder::new()
+                .name("solana-client-sample".to_string())
+                .spawn(move || {
+                    sample_txs(&exit_signal, &maxes, sample_period, &client);
+                })
+                .unwrap()
+        })
+        .collect();
+
+    let shared_txs: SharedTransactions = Arc::new(RwLock::new(VecDeque::new()));
+
+    let shared_tx_active_thread_count = Arc::new(AtomicIsize::new(0));
+    let total_tx_sent_count = Arc::new(AtomicUsize::new(0));
+
+    let s_threads: Vec<_> = (0..threads)
+        .map(|_| {
+            let exit_signal = exit_signal.clone();
+            let shared_txs = shared_txs.clone();
+            let shared_tx_active_thread_count = shared_tx_active_thread_count.clone();
+            let total_tx_sent_count = total_tx_sent_count.clone();
+            let client = client.clone();
+            Builder::new()
+                .name("solana-client-sender".to_string())
+                .spawn(move || {
+                    do_tx_transfers(
+                        &exit_signal,
+                        &shared_txs,
+                        &shared_tx_active_thread_count,
+                        &total_tx_sent_count,
+                        thread_batch_sleep_ms,
+                        &client,
+                    );
+                })
+                .unwrap()
+        })
+        .collect();
+
+    // generate and send transactions for the specified duration
+    let start = Instant::now();
+    let mut reclaim_lamports_back_to_source_account = false;
+    let mut i = keypair0_balance;
+    let mut blockhash = Hash::default();
+    let mut blockhash_time = Instant::now();
+    while start.elapsed() < duration {
+        // ping-pong between source and destination accounts for each loop iteration
+        // this seems to be faster than trying to determine the balance of individual
+        // accounts
+        let len = tx_count as usize;
+        if let Ok((new_blockhash, _fee_calculator)) = client.get_new_blockhash(&blockhash) {
+            blockhash = new_blockhash;
+        } else {
+            if blockhash_time.elapsed().as_secs() > 30 {
+                panic!("Blockhash is not updating");
+            }
+            sleep(Duration::from_millis(100));
+            continue;
+        }
+        blockhash_time = Instant::now();
+        let balance = client.get_balance(&id.pubkey()).unwrap_or(0);
+        metrics_submit_lamport_balance(balance);
+        generate_txs(
+            &shared_txs,
+            &blockhash,
+            &keypairs[..len],
+            &keypairs[len..],
+            threads,
+            reclaim_lamports_back_to_source_account,
+        );
+        // In sustained mode overlap the transfers with generation
+        // this has higher average performance but lower peak performance
+        // in tested environments.
+        if !sustained {
+            while shared_tx_active_thread_count.load(Ordering::Relaxed) > 0 {
+                sleep(Duration::from_millis(1));
+            }
+        }
+
+        i += 1;
+        if should_switch_directions(NUM_LAMPORTS_PER_ACCOUNT, i) {
+            reclaim_lamports_back_to_source_account = !reclaim_lamports_back_to_source_account;
+        }
+    }
+
+    // Stop the sampling threads so it will collect the stats
+    exit_signal.store(true, Ordering::Relaxed);
+
+    println!("Waiting for validator threads...");
+    for t in v_threads {
+        if let Err(err) = t.join() {
+            println!("  join() failed with: {:?}", err);
+        }
+    }
+
+    // join the tx send threads
+    println!("Waiting for transmit threads...");
+    for t in s_threads {
+        if let Err(err) = t.join() {
+            println!("  join() failed with: {:?}", err);
+        }
+    }
+
+    let balance = client.get_balance(&id.pubkey()).unwrap_or(0);
+    metrics_submit_lamport_balance(balance);
+
+    compute_and_report_stats(
+        &maxes,
+        sample_period,
+        &start.elapsed(),
+        total_tx_sent_count.load(Ordering::Relaxed),
+    );
+
+    let r_maxes = maxes.read().unwrap();
+    r_maxes.first().unwrap().1.txs
+}
+
+fn metrics_submit_lamport_balance(lamport_balance: u64) {
+    println!("Token balance: {}", lamport_balance);
+    datapoint_info!(
+        "bench-tps-lamport_balance",
+        ("balance", lamport_balance, i64)
     );
 }
 
-pub fn sample_tx_count(
-    exit_signal: &Arc<AtomicBool>,
-    maxes: &Arc<RwLock<Vec<(SocketAddr, NodeStats)>>>,
-    first_tx_count: u64,
-    v: &NodeInfo,
-    sample_period: u64,
-) {
-    let mut client = mk_client(&v);
-    let mut now = Instant::now();
-    let mut initial_tx_count = client.transaction_count();
-    let mut max_tps = 0.0;
-    let mut total;
-
-    let log_prefix = format!("{:21}:", v.tpu.to_string());
-
-    loop {
-        let tx_count = client.transaction_count();
-        assert!(
-            tx_count >= initial_tx_count,
-            "expected tx_count({}) >= initial_tx_count({})",
-            tx_count,
-            initial_tx_count
-        );
-        let duration = now.elapsed();
-        now = Instant::now();
-        let sample = tx_count - initial_tx_count;
-        initial_tx_count = tx_count;
-
-        let ns = duration.as_secs() * 1_000_000_000 + u64::from(duration.subsec_nanos());
-        let tps = (sample * 1_000_000_000) as f64 / ns as f64;
-        if tps > max_tps {
-            max_tps = tps;
-        }
-        if tx_count > first_tx_count {
-            total = tx_count - first_tx_count;
-        } else {
-            total = 0;
-        }
-        println!(
-            "{} {:9.2} TPS, Transactions: {:6}, Total transactions: {}",
-            log_prefix, tps, sample, total
-        );
-        sleep(Duration::new(sample_period, 0));
-
-        if exit_signal.load(Ordering::Relaxed) {
-            println!("{} Exiting validator thread", log_prefix);
-            let stats = NodeStats {
-                tps: max_tps,
-                tx: total,
-            };
-            maxes.write().unwrap().push((v.tpu, stats));
-            break;
-        }
-    }
-}
-
-/// Send loopback payment of 0 tokens and confirm the network processed it
-pub fn send_barrier_transaction(barrier_client: &mut ThinClient, last_id: &mut Hash, id: &Keypair) {
-    let transfer_start = Instant::now();
-
-    let mut poll_count = 0;
-    loop {
-        if poll_count > 0 && poll_count % 8 == 0 {
-            println!(
-                "polling for barrier transaction confirmation, attempt {}",
-                poll_count
-            );
-        }
-
-        *last_id = barrier_client.get_last_id();
-        let signature = barrier_client
-            .transfer(0, &id, id.pubkey(), last_id)
-            .expect("Unable to send barrier transaction");
-
-        let confirmatiom = barrier_client.poll_for_signature(&signature);
-        let duration_ms = duration_as_ms(&transfer_start.elapsed());
-        if confirmatiom.is_ok() {
-            println!("barrier transaction confirmed in {} ms", duration_ms);
-
-            solana_metrics::submit(
-                influxdb::Point::new("bench-tps")
-                    .add_tag(
-                        "op",
-                        influxdb::Value::String("send_barrier_transaction".to_string()),
-                    )
-                    .add_field("poll_count", influxdb::Value::Integer(poll_count))
-                    .add_field("duration", influxdb::Value::Integer(duration_ms as i64))
-                    .to_owned(),
-            );
-
-            // Sanity check that the client balance is still 1
-            let balance = barrier_client
-                .poll_balance_with_timeout(
-                    &id.pubkey(),
-                    &Duration::from_millis(100),
-                    &Duration::from_secs(10),
-                )
-                .expect("Failed to get balance");
-            if balance != 1 {
-                panic!("Expected an account balance of 1 (balance: {}", balance);
-            }
-            break;
-        }
-
-        // Timeout after 3 minutes.  When running a CPU-only leader+validator+drone+bench-tps on a dev
-        // machine, some batches of transactions can take upwards of 1 minute...
-        if duration_ms > 1000 * 60 * 3 {
-            println!("Error: Couldn't confirm barrier transaction!");
-            exit(1);
-        }
-
-        let new_last_id = barrier_client.get_last_id();
-        if new_last_id == *last_id {
-            if poll_count > 0 && poll_count % 8 == 0 {
-                println!("last_id is not advancing, still at {:?}", *last_id);
-            }
-        } else {
-            *last_id = new_last_id;
-        }
-
-        poll_count += 1;
-    }
-}
-
-pub fn generate_txs(
+fn generate_txs(
     shared_txs: &SharedTransactions,
+    blockhash: &Hash,
     source: &[Keypair],
     dest: &[Keypair],
     threads: usize,
     reclaim: bool,
-    leader: &NodeInfo,
 ) {
-    let mut client = mk_client(leader);
-    let last_id = client.get_last_id();
     let tx_count = source.len();
     println!("Signing transactions... {} (reclaim={})", tx_count, reclaim);
     let signing_start = Instant::now();
@@ -190,7 +242,7 @@ pub fn generate_txs(
         .par_iter()
         .map(|(id, keypair)| {
             (
-                Transaction::system_new(id, keypair.pubkey(), 1, last_id),
+                system_transaction::create_user_account(id, &keypair.pubkey(), 1, *blockhash),
                 timestamp(),
             )
         })
@@ -205,16 +257,11 @@ pub fn generate_txs(
         bsps * 1_000_000_f64,
         nsps / 1_000_f64,
         duration_as_ms(&duration),
-        last_id,
+        blockhash,
     );
-    solana_metrics::submit(
-        influxdb::Point::new("bench-tps")
-            .add_tag("op", influxdb::Value::String("generate_txs".to_string()))
-            .add_field(
-                "duration",
-                influxdb::Value::Integer(duration_as_ms(&duration) as i64),
-            )
-            .to_owned(),
+    datapoint_info!(
+        "bench-tps-generate_txs",
+        ("duration", duration_as_ms(&duration), i64)
     );
 
     let sz = transactions.len() / threads;
@@ -227,18 +274,21 @@ pub fn generate_txs(
     }
 }
 
-pub fn do_tx_transfers(
+fn do_tx_transfers<T: Client>(
     exit_signal: &Arc<AtomicBool>,
     shared_txs: &SharedTransactions,
-    leader: &NodeInfo,
     shared_tx_thread_count: &Arc<AtomicIsize>,
     total_tx_sent_count: &Arc<AtomicUsize>,
+    thread_batch_sleep_ms: usize,
+    client: &Arc<T>,
 ) {
-    let client = mk_client(&leader);
     loop {
+        if thread_batch_sleep_ms > 0 {
+            sleep(Duration::from_millis(thread_batch_sleep_ms as u64));
+        }
         let txs;
         {
-            let mut shared_txs_wl = shared_txs.write().unwrap();
+            let mut shared_txs_wl = shared_txs.write().expect("write lock in do_tx_transfers");
             txs = shared_txs_wl.pop_front();
         }
         if let Some(txs0) = txs {
@@ -246,7 +296,7 @@ pub fn do_tx_transfers(
             println!(
                 "Transferring 1 unit {} times... to {}",
                 txs0.len(),
-                leader.tpu
+                client.as_ref().transactions_addr(),
             );
             let tx_len = txs0.len();
             let transfer_start = Instant::now();
@@ -255,7 +305,9 @@ pub fn do_tx_transfers(
                 if now > tx.1 && now - tx.1 > 1000 * 30 {
                     continue;
                 }
-                client.transfer_signed(&tx.0).unwrap();
+                client
+                    .async_send_transaction(tx.0)
+                    .expect("async_send_transaction in do_tx_transfers");
             }
             shared_tx_thread_count.fetch_add(-1, Ordering::Relaxed);
             total_tx_sent_count.fetch_add(tx_len, Ordering::Relaxed);
@@ -264,15 +316,10 @@ pub fn do_tx_transfers(
                 duration_as_ms(&transfer_start.elapsed()),
                 tx_len as f32 / duration_as_s(&transfer_start.elapsed()),
             );
-            solana_metrics::submit(
-                influxdb::Point::new("bench-tps")
-                    .add_tag("op", influxdb::Value::String("do_tx_transfers".to_string()))
-                    .add_field(
-                        "duration",
-                        influxdb::Value::Integer(duration_as_ms(&transfer_start.elapsed()) as i64),
-                    )
-                    .add_field("count", influxdb::Value::Integer(tx_len as i64))
-                    .to_owned(),
+            datapoint_info!(
+                "bench-tps-do_tx_transfers",
+                ("duration", duration_as_ms(&transfer_start.elapsed()), i64),
+                ("count", tx_len, i64)
             );
         }
         if exit_signal.load(Ordering::Relaxed) {
@@ -281,8 +328,8 @@ pub fn do_tx_transfers(
     }
 }
 
-pub fn verify_funding_transfer(client: &mut ThinClient, tx: &Transaction, amount: u64) -> bool {
-    for a in &tx.account_keys[1..] {
+fn verify_funding_transfer<T: Client>(client: &T, tx: &Transaction, amount: u64) -> bool {
+    for a in &tx.message().account_keys[1..] {
         if client.get_balance(a).unwrap_or(0) >= amount {
             return true;
         }
@@ -294,10 +341,17 @@ pub fn verify_funding_transfer(client: &mut ThinClient, tx: &Transaction, amount
 /// fund the dests keys by spending all of the source keys into MAX_SPENDS_PER_TX
 /// on every iteration.  This allows us to replay the transfers because the source is either empty,
 /// or full
-pub fn fund_keys(client: &mut ThinClient, source: &Keypair, dests: &[Keypair], tokens: u64) {
-    let total = tokens * dests.len() as u64;
+pub fn fund_keys<T: Client>(
+    client: &T,
+    source: &Keypair,
+    dests: &[Keypair],
+    total: u64,
+    max_fee: u64,
+    mut extra: u64,
+) {
     let mut funded: Vec<(&Keypair, u64)> = vec![(source, total)];
     let mut notfunded: Vec<&Keypair> = dests.iter().collect();
+    let lamports_per_account = (total - (extra * max_fee)) / (notfunded.len() as u64 + 1);
 
     println!("funding keys {}", dests.len());
     while !notfunded.is_empty() {
@@ -305,12 +359,13 @@ pub fn fund_keys(client: &mut ThinClient, source: &Keypair, dests: &[Keypair], t
         let mut to_fund = vec![];
         println!("creating from... {}", funded.len());
         for f in &mut funded {
-            let max_units = cmp::min(notfunded.len(), MAX_SPENDS_PER_TX);
+            let max_units = cmp::min(notfunded.len() as u64, MAX_SPENDS_PER_TX);
             if max_units == 0 {
                 break;
             }
-            let start = notfunded.len() - max_units;
-            let per_unit = f.1 / (max_units as u64);
+            let start = notfunded.len() - max_units as usize;
+            let fees = if extra > 0 { max_fee } else { 0 };
+            let per_unit = (f.1 - lamports_per_account - fees) / max_units;
             let moves: Vec<_> = notfunded[start..]
                 .iter()
                 .map(|k| (k.pubkey(), per_unit))
@@ -322,9 +377,10 @@ pub fn fund_keys(client: &mut ThinClient, source: &Keypair, dests: &[Keypair], t
             if !moves.is_empty() {
                 to_fund.push((f.0, moves));
             }
+            extra -= 1;
         }
 
-        // try to transfer a "few" at a time with recent last_id
+        // try to transfer a "few" at a time with recent blockhash
         //  assume 4MB network buffers, and 512 byte packets
         const FUND_CHUNK_LEN: usize = 4 * 1024 * 1024 / 512;
 
@@ -338,7 +394,10 @@ pub fn fund_keys(client: &mut ThinClient, source: &Keypair, dests: &[Keypair], t
                 .map(|(k, m)| {
                     (
                         k.clone(),
-                        Transaction::system_move_many(k, &m, Default::default(), 0),
+                        Transaction::new_unsigned_instructions(system_instruction::transfer_many(
+                            &k.pubkey(),
+                            &m,
+                        )),
                     )
                 })
                 .collect();
@@ -348,7 +407,7 @@ pub fn fund_keys(client: &mut ThinClient, source: &Keypair, dests: &[Keypair], t
             while !to_fund_txs.is_empty() {
                 let receivers = to_fund_txs
                     .iter()
-                    .fold(0, |len, (_, tx)| len + tx.instructions.len());
+                    .fold(0, |len, (_, tx)| len + tx.message().instructions.len());
 
                 println!(
                     "{} {} to {} in {} txs",
@@ -362,21 +421,27 @@ pub fn fund_keys(client: &mut ThinClient, source: &Keypair, dests: &[Keypair], t
                     to_fund_txs.len(),
                 );
 
-                let last_id = client.get_last_id();
+                let (blockhash, _fee_calculator) = client.get_recent_blockhash().unwrap();
 
-                // re-sign retained to_fund_txes with updated last_id
+                // re-sign retained to_fund_txes with updated blockhash
                 to_fund_txs.par_iter_mut().for_each(|(k, tx)| {
-                    tx.sign(&[k], last_id);
+                    tx.sign(&[*k], blockhash);
                 });
 
                 to_fund_txs.iter().for_each(|(_, tx)| {
-                    client.transfer_signed(&tx).expect("transfer");
+                    client.async_send_transaction(tx.clone()).expect("transfer");
                 });
 
                 // retry anything that seems to have dropped through cracks
                 //  again since these txs are all or nothing, they're fine to
                 //  retry
-                to_fund_txs.retain(|(_, tx)| !verify_funding_transfer(client, &tx, amount));
+                for _ in 0..10 {
+                    to_fund_txs.retain(|(_, tx)| !verify_funding_transfer(client, &tx, amount));
+                    if to_fund_txs.is_empty() {
+                        break;
+                    }
+                    sleep(Duration::from_millis(100));
+                }
 
                 tries += 1;
             }
@@ -387,30 +452,37 @@ pub fn fund_keys(client: &mut ThinClient, source: &Keypair, dests: &[Keypair], t
     }
 }
 
-pub fn airdrop_tokens(
-    client: &mut ThinClient,
+pub fn airdrop_lamports<T: Client>(
+    client: &T,
     drone_addr: &SocketAddr,
     id: &Keypair,
     tx_count: u64,
-) {
-    let starting_balance = client.poll_get_balance(&id.pubkey()).unwrap_or(0);
-    metrics_submit_token_balance(starting_balance);
+) -> Result<()> {
+    let starting_balance = client.get_balance(&id.pubkey()).unwrap_or(0);
+    metrics_submit_lamport_balance(starting_balance);
     println!("starting balance {}", starting_balance);
 
     if starting_balance < tx_count {
         let airdrop_amount = tx_count - starting_balance;
         println!(
-            "Airdropping {:?} tokens from {} for {}",
+            "Airdropping {:?} lamports from {} for {}",
             airdrop_amount,
             drone_addr,
             id.pubkey(),
         );
 
-        let last_id = client.get_last_id();
-        match request_airdrop_transaction(&drone_addr, &id.pubkey(), airdrop_amount, last_id) {
+        let (blockhash, _fee_calculator) = client.get_recent_blockhash().unwrap();
+        match request_airdrop_transaction(&drone_addr, &id.pubkey(), airdrop_amount, blockhash) {
             Ok(transaction) => {
-                let signature = client.transfer_signed(&transaction).unwrap();
-                client.poll_for_signature(&signature).unwrap();
+                let signature = client.async_send_transaction(transaction).unwrap();
+                client
+                    .poll_for_signature_confirmation(&signature, 1)
+                    .unwrap_or_else(|_| {
+                        panic!(
+                            "Error requesting airdrop: to addr: {:?} amount: {}",
+                            drone_addr, airdrop_amount
+                        )
+                    })
             }
             Err(err) => {
                 panic!(
@@ -420,13 +492,13 @@ pub fn airdrop_tokens(
             }
         };
 
-        let current_balance = client.poll_get_balance(&id.pubkey()).unwrap_or_else(|e| {
+        let current_balance = client.get_balance(&id.pubkey()).unwrap_or_else(|e| {
             println!("airdrop error {}", e);
             starting_balance
         });
         println!("current balance {}...", current_balance);
 
-        metrics_submit_token_balance(current_balance);
+        metrics_submit_lamport_balance(current_balance);
         if current_balance - starting_balance != airdrop_amount {
             println!(
                 "Airdrop failed! {} {} {}",
@@ -434,13 +506,14 @@ pub fn airdrop_tokens(
                 current_balance,
                 starting_balance
             );
-            exit(1);
+            return Err(BenchTpsError::AirdropFailure);
         }
     }
+    Ok(())
 }
 
-pub fn compute_and_report_stats(
-    maxes: &Arc<RwLock<Vec<(SocketAddr, NodeStats)>>>,
+fn compute_and_report_stats(
+    maxes: &Arc<RwLock<Vec<(String, SampleStats)>>>,
     sample_period: u64,
     tx_send_elapsed: &Duration,
     total_tx_send_count: usize,
@@ -454,17 +527,14 @@ pub fn compute_and_report_stats(
     println!("---------------------+---------------+--------------------");
 
     for (sock, stats) in maxes.read().unwrap().iter() {
-        let maybe_flag = match stats.tx {
+        let maybe_flag = match stats.txs {
             0 => "!!!!!",
             _ => "",
         };
 
         println!(
             "{:20} | {:13.2} | {} {}",
-            (*sock).to_string(),
-            stats.tps,
-            stats.tx,
-            maybe_flag
+            sock, stats.tps, stats.txs, maybe_flag
         );
 
         if stats.tps == 0.0 {
@@ -475,27 +545,33 @@ pub fn compute_and_report_stats(
         if stats.tps > max_of_maxes {
             max_of_maxes = stats.tps;
         }
-        if stats.tx > max_tx_count {
-            max_tx_count = stats.tx;
+        if stats.txs > max_tx_count {
+            max_tx_count = stats.txs;
         }
     }
 
     if total_maxes > 0.0 {
         let num_nodes_with_tps = maxes.read().unwrap().len() - nodes_with_zero_tps;
-        let average_max = total_maxes / num_nodes_with_tps as f64;
+        let average_max = total_maxes / num_nodes_with_tps as f32;
         println!(
             "\nAverage max TPS: {:.2}, {} nodes had 0 TPS",
             average_max, nodes_with_zero_tps
         );
     }
 
+    let total_tx_send_count = total_tx_send_count as u64;
+    let drop_rate = if total_tx_send_count > max_tx_count {
+        (total_tx_send_count - max_tx_count) as f64 / total_tx_send_count as f64
+    } else {
+        0.0
+    };
     println!(
         "\nHighest TPS: {:.2} sampling period {}s max transactions: {} clients: {} drop rate: {:.2}",
         max_of_maxes,
         sample_period,
         max_tx_count,
         maxes.read().unwrap().len(),
-        (total_tx_send_count as u64 - max_tx_count) as f64 / total_tx_send_count as f64,
+        drop_rate,
     );
     println!(
         "\tAverage TPS: {}",
@@ -503,16 +579,87 @@ pub fn compute_and_report_stats(
     );
 }
 
-// First transfer 3/4 of the tokens to the dest accounts
-// then ping-pong 1/4 of the tokens back to the other account
-// this leaves 1/4 token buffer in each account
-pub fn should_switch_directions(num_tokens_per_account: u64, i: u64) -> bool {
-    i % (num_tokens_per_account / 4) == 0 && (i >= (3 * num_tokens_per_account) / 4)
+// First transfer 3/4 of the lamports to the dest accounts
+// then ping-pong 1/4 of the lamports back to the other account
+// this leaves 1/4 lamport buffer in each account
+fn should_switch_directions(num_lamports_per_account: u64, i: u64) -> bool {
+    i % (num_lamports_per_account / 4) == 0 && (i >= (3 * num_lamports_per_account) / 4)
+}
+
+pub fn generate_keypairs(seed_keypair: &Keypair, count: u64) -> (Vec<Keypair>, u64) {
+    let mut seed = [0u8; 32];
+    seed.copy_from_slice(&seed_keypair.to_bytes()[..32]);
+    let mut rnd = GenKeys::new(seed);
+
+    let mut total_keys = 0;
+    let mut extra = 0; // This variable tracks the number of keypairs needing extra transaction fees funded
+    let mut delta = 1;
+    while total_keys < count {
+        extra += delta;
+        delta *= MAX_SPENDS_PER_TX;
+        total_keys += delta;
+    }
+    (rnd.gen_n_keypairs(total_keys), extra)
+}
+
+pub fn generate_and_fund_keypairs<T: Client>(
+    client: &T,
+    drone_addr: Option<SocketAddr>,
+    funding_pubkey: &Keypair,
+    tx_count: usize,
+    lamports_per_account: u64,
+) -> Result<(Vec<Keypair>, u64)> {
+    info!("Creating {} keypairs...", tx_count * 2);
+    let (mut keypairs, extra) = generate_keypairs(funding_pubkey, tx_count as u64 * 2);
+    info!("Get lamports...");
+
+    // Sample the first keypair, see if it has lamports, if so then resume.
+    // This logic is to prevent lamport loss on repeated solana-bench-tps executions
+    let last_keypair_balance = client
+        .get_balance(&keypairs[tx_count * 2 - 1].pubkey())
+        .unwrap_or(0);
+
+    if lamports_per_account > last_keypair_balance {
+        let (_, fee_calculator) = client.get_recent_blockhash().unwrap();
+        let account_desired_balance =
+            lamports_per_account - last_keypair_balance + fee_calculator.max_lamports_per_signature;
+        let extra_fees = extra * fee_calculator.max_lamports_per_signature;
+        let total = account_desired_balance * (1 + keypairs.len() as u64) + extra_fees;
+        if client.get_balance(&funding_pubkey.pubkey()).unwrap_or(0) < total {
+            airdrop_lamports(client, &drone_addr.unwrap(), funding_pubkey, total)?;
+        }
+        info!("adding more lamports {}", account_desired_balance);
+        fund_keys(
+            client,
+            funding_pubkey,
+            &keypairs,
+            total,
+            fee_calculator.max_lamports_per_signature,
+            extra,
+        );
+    }
+
+    // 'generate_keypairs' generates extra keys to be able to have size-aligned funding batches for fund_keys.
+    keypairs.truncate(2 * tx_count);
+
+    Ok((keypairs, last_keypair_balance))
 }
 
 #[cfg(test)]
 mod tests {
     use super::*;
+    use solana::cluster_info::FULLNODE_PORT_RANGE;
+    use solana::local_cluster::{ClusterConfig, LocalCluster};
+    use solana::validator::ValidatorConfig;
+    use solana_client::thin_client::create_client;
+    use solana_drone::drone::run_local_drone;
+    use solana_runtime::bank::Bank;
+    use solana_runtime::bank_client::BankClient;
+    use solana_sdk::client::SyncClient;
+    use solana_sdk::fee_calculator::FeeCalculator;
+    use solana_sdk::genesis_block::create_genesis_block;
+    use std::sync::mpsc::channel;
+
     #[test]
     fn test_switch_directions() {
         assert_eq!(should_switch_directions(20, 0), false);
@@ -527,4 +674,104 @@ mod tests {
         assert_eq!(should_switch_directions(20, 100), true);
         assert_eq!(should_switch_directions(20, 101), false);
     }
+
+    #[test]
+    fn test_bench_tps_local_cluster() {
+        solana_logger::setup();
+        const NUM_NODES: usize = 1;
+        let cluster = LocalCluster::new(&ClusterConfig {
+            node_stakes: vec![999_990; NUM_NODES],
+            cluster_lamports: 2_000_000,
+            validator_configs: vec![ValidatorConfig::default(); NUM_NODES],
+            ..ClusterConfig::default()
+        });
+
+        let drone_keypair = Keypair::new();
+        cluster.transfer(&cluster.funding_keypair, &drone_keypair.pubkey(), 1_000_000);
+
+        let (addr_sender, addr_receiver) = channel();
+        run_local_drone(drone_keypair, addr_sender, None);
+        let drone_addr = addr_receiver.recv_timeout(Duration::from_secs(2)).unwrap();
+
+        let mut config = Config::default();
+        config.tx_count = 100;
+        config.duration = Duration::from_secs(5);
+
+        let client = create_client(
+            (cluster.entry_point_info.rpc, cluster.entry_point_info.tpu),
+            FULLNODE_PORT_RANGE,
+        );
+
+        let lamports_per_account = 100;
+        let (keypairs, _keypair_balance) = generate_and_fund_keypairs(
+            &client,
+            Some(drone_addr),
+            &config.id,
+            config.tx_count,
+            lamports_per_account,
+        )
+        .unwrap();
+
+        let total = do_bench_tps(vec![client], config, keypairs, 0);
+        assert!(total > 100);
+    }
+
+    #[test]
+    fn test_bench_tps_bank_client() {
+        let (genesis_block, id) = create_genesis_block(10_000);
+        let bank = Bank::new(&genesis_block);
+        let clients = vec![BankClient::new(bank)];
+
+        let mut config = Config::default();
+        config.id = id;
+        config.tx_count = 10;
+        config.duration = Duration::from_secs(5);
+
+        let (keypairs, _keypair_balance) =
+            generate_and_fund_keypairs(&clients[0], None, &config.id, config.tx_count, 20).unwrap();
+
+        do_bench_tps(clients, config, keypairs, 0);
+    }
+
+    #[test]
+    fn test_bench_tps_fund_keys() {
+        let (genesis_block, id) = create_genesis_block(10_000);
+        let bank = Bank::new(&genesis_block);
+        let client = BankClient::new(bank);
+        let tx_count = 10;
+        let lamports = 20;
+
+        let (keypairs, _keypair_balance) =
+            generate_and_fund_keypairs(&client, None, &id, tx_count, lamports).unwrap();
+
+        for kp in &keypairs {
+            assert_eq!(client.get_balance(&kp.pubkey()).unwrap(), lamports);
+        }
+    }
+
+    #[test]
+    fn test_bench_tps_fund_keys_with_fees() {
+        let (mut genesis_block, id) = create_genesis_block(10_000);
+        let fee_calculator = FeeCalculator::new(11);
+        genesis_block.fee_calculator = fee_calculator;
+        let bank = Bank::new(&genesis_block);
+        let client = BankClient::new(bank);
+        let tx_count = 10;
+        let lamports = 20;
+
+        let (keypairs, _keypair_balance) =
+            generate_and_fund_keypairs(&client, None, &id, tx_count, lamports).unwrap();
+
+        let max_fee = client
+            .get_recent_blockhash()
+            .unwrap()
+            .1
+            .max_lamports_per_signature;
+        for kp in &keypairs {
+            assert_eq!(
+                client.get_balance(&kp.pubkey()).unwrap(),
+                lamports + max_fee
+            );
+        }
+    }
 }

bench-tps/src/cli.rs

@@ -2,52 +2,59 @@ use std::net::SocketAddr;
 use std::process::exit;
 use std::time::Duration;
 
-use clap::{crate_version, App, Arg, ArgMatches};
+use clap::{crate_description, crate_name, crate_version, App, Arg, ArgMatches};
 use solana_drone::drone::DRONE_PORT;
+use solana_sdk::fee_calculator::FeeCalculator;
 use solana_sdk::signature::{read_keypair, Keypair, KeypairUtil};
 
 /// Holds the configuration for a single run of the benchmark
 pub struct Config {
-    pub network_addr: SocketAddr,
+    pub entrypoint_addr: SocketAddr,
     pub drone_addr: SocketAddr,
     pub id: Keypair,
     pub threads: usize,
     pub num_nodes: usize,
     pub duration: Duration,
     pub tx_count: usize,
+    pub thread_batch_sleep_ms: usize,
     pub sustained: bool,
-    pub reject_extra_nodes: bool,
-    pub converge_only: bool,
+    pub client_ids_and_stake_file: String,
+    pub write_to_client_file: bool,
+    pub read_from_client_file: bool,
+    pub target_lamports_per_signature: u64,
 }
 
 impl Default for Config {
     fn default() -> Config {
         Config {
-            network_addr: SocketAddr::from(([127, 0, 0, 1], 8001)),
+            entrypoint_addr: SocketAddr::from(([127, 0, 0, 1], 8001)),
             drone_addr: SocketAddr::from(([127, 0, 0, 1], DRONE_PORT)),
             id: Keypair::new(),
             threads: 4,
             num_nodes: 1,
             duration: Duration::new(std::u64::MAX, 0),
             tx_count: 500_000,
+            thread_batch_sleep_ms: 0,
             sustained: false,
-            reject_extra_nodes: false,
-            converge_only: false,
+            client_ids_and_stake_file: String::new(),
+            write_to_client_file: false,
+            read_from_client_file: false,
+            target_lamports_per_signature: FeeCalculator::default().target_lamports_per_signature,
         }
     }
 }
 
 /// Defines and builds the CLI args for a run of the benchmark
 pub fn build_args<'a, 'b>() -> App<'a, 'b> {
-    App::new("solana-bench-tps")
+    App::new(crate_name!()).about(crate_description!())
         .version(crate_version!())
         .arg(
-            Arg::with_name("network")
+            Arg::with_name("entrypoint")
                 .short("n")
-                .long("network")
+                .long("entrypoint")
                 .value_name("HOST:PORT")
                 .takes_value(true)
-                .help("Rendezvous with the network at this gossip entry point; defaults to 127.0.0.1:8001"),
+                .help("Rendezvous with the cluster at this entry point; defaults to 127.0.0.1:8001"),
         )
         .arg(
             Arg::with_name("drone")
@@ -55,7 +62,7 @@ pub fn build_args<'a, 'b>() -> App<'a, 'b> {
                 .long("drone")
                 .value_name("HOST:PORT")
                 .takes_value(true)
-                .help("Location of the drone; defaults to network:DRONE_PORT"),
+                .help("Location of the drone; defaults to entrypoint:DRONE_PORT"),
         )
         .arg(
             Arg::with_name("identity")
@@ -73,11 +80,6 @@ pub fn build_args<'a, 'b>() -> App<'a, 'b> {
                 .takes_value(true)
                 .help("Wait for NUM nodes to converge"),
         )
-        .arg(
-            Arg::with_name("reject-extra-nodes")
-                .long("reject-extra-nodes")
-                .help("Require exactly `num-nodes` on convergence. Appropriate only for internal networks"),
-        )
         .arg(
             Arg::with_name("threads")
                 .short("t")
@@ -93,11 +95,6 @@ pub fn build_args<'a, 'b>() -> App<'a, 'b> {
                 .takes_value(true)
                 .help("Seconds to run benchmark, then exit; default is forever"),
         )
-        .arg(
-            Arg::with_name("converge-only")
-                .long("converge-only")
-                .help("Exit immediately after converging"),
-        )
         .arg(
             Arg::with_name("sustained")
                 .long("sustained")
@@ -110,6 +107,38 @@ pub fn build_args<'a, 'b>() -> App<'a, 'b> {
                 .takes_value(true)
                 .help("Number of transactions to send per batch")
         )
+        .arg(
+            Arg::with_name("thread-batch-sleep-ms")
+                .short("z")
+                .long("thread-batch-sleep-ms")
+                .value_name("NUM")
+                .takes_value(true)
+                .help("Per-thread-per-iteration sleep in ms"),
+        )
+        .arg(
+            Arg::with_name("write-client-keys")
+                .long("write-client-keys")
+                .value_name("FILENAME")
+                .takes_value(true)
+                .help("Generate client keys and stakes and write the list to YAML file"),
+        )
+        .arg(
+            Arg::with_name("read-client-keys")
+                .long("read-client-keys")
+                .value_name("FILENAME")
+                .takes_value(true)
+                .help("Read client keys and stakes from the YAML file"),
+        )
+        .arg(
+            Arg::with_name("target_lamports_per_signature")
+                .long("target-lamports-per-signature")
+                .value_name("LAMPORTS")
+                .takes_value(true)
+                .help(
+                    "The cost in lamports that the cluster will charge for signature \
+                     verification when the cluster is operating at target-signatures-per-slot",
+                ),
+        )
 }
 
 /// Parses a clap `ArgMatches` structure into a `Config`
@@ -120,15 +149,15 @@ pub fn build_args<'a, 'b>() -> App<'a, 'b> {
 pub fn extract_args<'a>(matches: &ArgMatches<'a>) -> Config {
     let mut args = Config::default();
 
-    if let Some(addr) = matches.value_of("network") {
-        args.network_addr = addr.parse().unwrap_or_else(|e| {
-            eprintln!("failed to parse network: {}", e);
+    if let Some(addr) = matches.value_of("entrypoint") {
+        args.entrypoint_addr = solana_netutil::parse_host_port(addr).unwrap_or_else(|e| {
+            eprintln!("failed to parse entrypoint address: {}", e);
             exit(1)
         });
     }
 
     if let Some(addr) = matches.value_of("drone") {
-        args.drone_addr = addr.parse().unwrap_or_else(|e| {
+        args.drone_addr = solana_netutil::parse_host_port(addr).unwrap_or_else(|e| {
             eprintln!("failed to parse drone address: {}", e);
             exit(1)
         });
@@ -158,9 +187,29 @@ pub fn extract_args<'a>(matches: &ArgMatches<'a>) -> Config {
         args.tx_count = s.to_string().parse().expect("can't parse tx_account");
     }
 
+    if let Some(t) = matches.value_of("thread-batch-sleep-ms") {
+        args.thread_batch_sleep_ms = t
+            .to_string()
+            .parse()
+            .expect("can't parse thread-batch-sleep-ms");
+    }
+
     args.sustained = matches.is_present("sustained");
-    args.converge_only = matches.is_present("converge-only");
-    args.reject_extra_nodes = matches.is_present("reject-extra-nodes");
+
+    if let Some(s) = matches.value_of("write-client-keys") {
+        args.write_to_client_file = true;
+        args.client_ids_and_stake_file = s.to_string();
+    }
+
+    if let Some(s) = matches.value_of("read-client-keys") {
+        assert!(!args.write_to_client_file);
+        args.read_from_client_file = true;
+        args.client_ids_and_stake_file = s.to_string();
+    }
+
+    if let Some(v) = matches.value_of("target_lamports_per_signature") {
+        args.target_lamports_per_signature = v.to_string().parse().expect("can't parse lamports");
+    }
 
     args
 }

bench-tps/src/main.rs

@@ -1,304 +1,123 @@
 mod bench;
 mod cli;
 
-use solana::client::mk_client;
-use solana::cluster_info::{ClusterInfo, NodeInfo};
-use solana::gossip_service::GossipService;
-
-use solana::service::Service;
-use solana::signature::GenKeys;
-use solana::thin_client::poll_gossip_for_leader;
-use solana_metrics;
-use solana_sdk::signature::KeypairUtil;
-
-use std::collections::VecDeque;
+use crate::bench::{
+    do_bench_tps, generate_and_fund_keypairs, generate_keypairs, Config, NUM_LAMPORTS_PER_ACCOUNT,
+};
+use solana::gossip_service::{discover_cluster, get_multi_client};
+use solana_sdk::fee_calculator::FeeCalculator;
+use solana_sdk::signature::{Keypair, KeypairUtil};
+use std::collections::HashMap;
+use std::fs::File;
+use std::io::prelude::*;
+use std::path::Path;
 use std::process::exit;
-use std::sync::atomic::{AtomicBool, AtomicIsize, AtomicUsize, Ordering};
-use std::sync::{Arc, RwLock};
-use std::thread::sleep;
-use std::thread::Builder;
-use std::time::Duration;
-use std::time::Instant;
 
-use crate::bench::*;
-
-/// Creates a cluster and waits for the network to converge, returning the peers, leader, and gossip service
-/// # Arguments
-/// `leader` - the input leader node
-/// `exit_signal` - atomic bool used to signal early exit to cluster
-/// `num_nodes` - the number of nodes
-/// # Panics
-/// Panics if the spy node `RwLock` somehow ends up unreadable
-fn converge(
-    leader: &NodeInfo,
-    exit_signal: &Arc<AtomicBool>,
-    num_nodes: usize,
-) -> (Vec<NodeInfo>, Option<NodeInfo>, GossipService) {
-    //lets spy on the network
-    let (node, gossip_socket) = ClusterInfo::spy_node();
-    let mut spy_cluster_info = ClusterInfo::new(node);
-    spy_cluster_info.insert_info(leader.clone());
-    spy_cluster_info.set_leader(leader.id);
-    let spy_ref = Arc::new(RwLock::new(spy_cluster_info));
-    let gossip_service = GossipService::new(&spy_ref, None, gossip_socket, exit_signal.clone());
-    let mut v: Vec<NodeInfo> = vec![];
-    // wait for the network to converge, 30 seconds should be plenty
-    for _ in 0..30 {
-        {
-            let spy_ref = spy_ref.read().unwrap();
-
-            println!("{}", spy_ref.node_info_trace());
-
-            if spy_ref.leader_data().is_some() {
-                v = spy_ref.rpc_peers();
-                if v.len() >= num_nodes {
-                    println!("CONVERGED!");
-                    break;
-                } else {
-                    println!(
-                        "{} node(s) discovered (looking for {} or more)",
-                        v.len(),
-                        num_nodes
-                    );
-                }
-            }
-        }
-        sleep(Duration::new(1, 0));
-    }
-    let leader = spy_ref.read().unwrap().leader_data().cloned();
-    (v, leader, gossip_service)
-}
+/// Number of signatures for all transactions in ~1 week at ~100K TPS
+pub const NUM_SIGNATURES_FOR_TXS: u64 = 100_000 * 60 * 60 * 24 * 7;
 
 fn main() {
     solana_logger::setup();
     solana_metrics::set_panic_hook("bench-tps");
 
     let matches = cli::build_args().get_matches();
-
-    let cfg = cli::extract_args(&matches);
+    let cli_config = cli::extract_args(&matches);
 
     let cli::Config {
-        network_addr: network,
+        entrypoint_addr,
         drone_addr,
         id,
         threads,
         num_nodes,
         duration,
         tx_count,
+        thread_batch_sleep_ms,
         sustained,
-        reject_extra_nodes,
-        converge_only,
-    } = cfg;
+        client_ids_and_stake_file,
+        write_to_client_file,
+        read_from_client_file,
+        target_lamports_per_signature,
+    } = cli_config;
 
-    println!("Looking for leader at {:?}", network);
-    let leader = poll_gossip_for_leader(network, None).expect("unable to find leader on network");
+    if write_to_client_file {
+        let (keypairs, _) = generate_keypairs(&id, tx_count as u64 * 2);
+        let num_accounts = keypairs.len() as u64;
+        let max_fee = FeeCalculator::new(target_lamports_per_signature).max_lamports_per_signature;
+        let num_lamports_per_account = (num_accounts - 1 + NUM_SIGNATURES_FOR_TXS * max_fee)
+            / num_accounts
+            + NUM_LAMPORTS_PER_ACCOUNT;
+        let mut accounts = HashMap::new();
+        keypairs.iter().for_each(|keypair| {
+            accounts.insert(
+                serde_json::to_string(&keypair.to_bytes().to_vec()).unwrap(),
+                num_lamports_per_account,
+            );
+        });
 
-    let exit_signal = Arc::new(AtomicBool::new(false));
-    let (nodes, leader, gossip_service) = converge(&leader, &exit_signal, num_nodes);
+        let serialized = serde_yaml::to_string(&accounts).unwrap();
+        let path = Path::new(&client_ids_and_stake_file);
+        let mut file = File::create(path).unwrap();
+        file.write_all(&serialized.into_bytes()).unwrap();
+        return;
+    }
 
-    if nodes.len() < num_nodes {
-        println!(
+    println!("Connecting to the cluster");
+    let (nodes, _replicators) =
+        discover_cluster(&entrypoint_addr, num_nodes).unwrap_or_else(|err| {
+            eprintln!("Failed to discover {} nodes: {:?}", num_nodes, err);
+            exit(1);
+        });
+
+    let (client, num_clients) = get_multi_client(&nodes);
+
+    if nodes.len() < num_clients {
+        eprintln!(
             "Error: Insufficient nodes discovered.  Expecting {} or more",
             num_nodes
         );
         exit(1);
     }
-    if reject_extra_nodes && nodes.len() > num_nodes {
-        println!(
-            "Error: Extra nodes discovered.  Expecting exactly {}",
-            num_nodes
-        );
-        exit(1);
-    }
 
-    if leader.is_none() {
-        println!("no leader");
-        exit(1);
-    }
+    let (keypairs, keypair_balance) = if read_from_client_file {
+        let path = Path::new(&client_ids_and_stake_file);
+        let file = File::open(path).unwrap();
 
-    if converge_only {
-        return;
-    }
+        let accounts: HashMap<String, u64> = serde_yaml::from_reader(file).unwrap();
+        let mut keypairs = vec![];
+        let mut last_balance = 0;
 
-    let leader = leader.unwrap();
-
-    println!("leader RPC is at {} {}", leader.rpc, leader.id);
-    let mut client = mk_client(&leader);
-    let mut barrier_client = mk_client(&leader);
-
-    let mut seed = [0u8; 32];
-    seed.copy_from_slice(&id.public_key_bytes()[..32]);
-    let mut rnd = GenKeys::new(seed);
-
-    println!("Creating {} keypairs...", tx_count * 2);
-    let mut total_keys = 0;
-    let mut target = tx_count * 2;
-    while target > 0 {
-        total_keys += target;
-        target /= MAX_SPENDS_PER_TX;
-    }
-    let gen_keypairs = rnd.gen_n_keypairs(total_keys as u64);
-    let barrier_id = rnd.gen_n_keypairs(1).pop().unwrap();
-
-    println!("Get tokens...");
-    let num_tokens_per_account = 20;
-
-    // Sample the first keypair, see if it has tokens, if so then resume
-    // to avoid token loss
-    let keypair0_balance = client
-        .poll_get_balance(&gen_keypairs.last().unwrap().pubkey())
-        .unwrap_or(0);
-
-    if num_tokens_per_account > keypair0_balance {
-        let extra = num_tokens_per_account - keypair0_balance;
-        let total = extra * (gen_keypairs.len() as u64);
-        airdrop_tokens(&mut client, &drone_addr, &id, total);
-        println!("adding more tokens {}", extra);
-        fund_keys(&mut client, &id, &gen_keypairs, extra);
-    }
-    let start = gen_keypairs.len() - (tx_count * 2) as usize;
-    let keypairs = &gen_keypairs[start..];
-    airdrop_tokens(&mut barrier_client, &drone_addr, &barrier_id, 1);
-
-    println!("Get last ID...");
-    let mut last_id = client.get_last_id();
-    println!("Got last ID {:?}", last_id);
-
-    let first_tx_count = client.transaction_count();
-    println!("Initial transaction count {}", first_tx_count);
-
-    // Setup a thread per validator to sample every period
-    // collect the max transaction rate and total tx count seen
-    let maxes = Arc::new(RwLock::new(Vec::new()));
-    let sample_period = 1; // in seconds
-    println!("Sampling TPS every {} second...", sample_period);
-    let v_threads: Vec<_> = nodes
-        .into_iter()
-        .map(|v| {
-            let exit_signal = exit_signal.clone();
-            let maxes = maxes.clone();
-            Builder::new()
-                .name("solana-client-sample".to_string())
-                .spawn(move || {
-                    sample_tx_count(&exit_signal, &maxes, first_tx_count, &v, sample_period);
-                })
-                .unwrap()
+        accounts.into_iter().for_each(|(keypair, balance)| {
+            let bytes: Vec<u8> = serde_json::from_str(keypair.as_str()).unwrap();
+            keypairs.push(Keypair::from_bytes(&bytes).unwrap());
+            last_balance = balance;
+        });
+        // Sort keypairs so that do_bench_tps() uses the same subset of accounts for each run.
+        // This prevents the amount of storage needed for bench-tps accounts from creeping up
+        // across multiple runs.
+        keypairs.sort_by(|x, y| x.pubkey().to_string().cmp(&y.pubkey().to_string()));
+        (keypairs, last_balance)
+    } else {
+        generate_and_fund_keypairs(
+            &client,
+            Some(drone_addr),
+            &id,
+            tx_count,
+            NUM_LAMPORTS_PER_ACCOUNT,
+        )
+        .unwrap_or_else(|e| {
+            eprintln!("Error could not fund keys: {:?}", e);
+            exit(1);
         })
-        .collect();
+    };
 
-    let shared_txs: SharedTransactions = Arc::new(RwLock::new(VecDeque::new()));
+    let config = Config {
+        id,
+        threads,
+        thread_batch_sleep_ms,
+        duration,
+        tx_count,
+        sustained,
+    };
 
-    let shared_tx_active_thread_count = Arc::new(AtomicIsize::new(0));
-    let total_tx_sent_count = Arc::new(AtomicUsize::new(0));
-
-    let s_threads: Vec<_> = (0..threads)
-        .map(|_| {
-            let exit_signal = exit_signal.clone();
-            let shared_txs = shared_txs.clone();
-            let leader = leader.clone();
-            let shared_tx_active_thread_count = shared_tx_active_thread_count.clone();
-            let total_tx_sent_count = total_tx_sent_count.clone();
-            Builder::new()
-                .name("solana-client-sender".to_string())
-                .spawn(move || {
-                    do_tx_transfers(
-                        &exit_signal,
-                        &shared_txs,
-                        &leader,
-                        &shared_tx_active_thread_count,
-                        &total_tx_sent_count,
-                    );
-                })
-                .unwrap()
-        })
-        .collect();
-
-    // generate and send transactions for the specified duration
-    let start = Instant::now();
-    let mut reclaim_tokens_back_to_source_account = false;
-    let mut i = keypair0_balance;
-    while start.elapsed() < duration {
-        let balance = client.poll_get_balance(&id.pubkey()).unwrap_or(0);
-        metrics_submit_token_balance(balance);
-
-        // ping-pong between source and destination accounts for each loop iteration
-        // this seems to be faster than trying to determine the balance of individual
-        // accounts
-        let len = tx_count as usize;
-        generate_txs(
-            &shared_txs,
-            &keypairs[..len],
-            &keypairs[len..],
-            threads,
-            reclaim_tokens_back_to_source_account,
-            &leader,
-        );
-        // In sustained mode overlap the transfers with generation
-        // this has higher average performance but lower peak performance
-        // in tested environments.
-        if !sustained {
-            while shared_tx_active_thread_count.load(Ordering::Relaxed) > 0 {
-                sleep(Duration::from_millis(100));
-            }
-        }
-        // It's not feasible (would take too much time) to confirm each of the `tx_count / 2`
-        // transactions sent by `generate_txs()` so instead send and confirm a single transaction
-        // to validate the network is still functional.
-        send_barrier_transaction(&mut barrier_client, &mut last_id, &barrier_id);
-
-        i += 1;
-        if should_switch_directions(num_tokens_per_account, i) {
-            reclaim_tokens_back_to_source_account = !reclaim_tokens_back_to_source_account;
-        }
-    }
-
-    // Stop the sampling threads so it will collect the stats
-    exit_signal.store(true, Ordering::Relaxed);
-
-    println!("Waiting for validator threads...");
-    for t in v_threads {
-        if let Err(err) = t.join() {
-            println!("  join() failed with: {:?}", err);
-        }
-    }
-
-    // join the tx send threads
-    println!("Waiting for transmit threads...");
-    for t in s_threads {
-        if let Err(err) = t.join() {
-            println!("  join() failed with: {:?}", err);
-        }
-    }
-
-    let balance = client.poll_get_balance(&id.pubkey()).unwrap_or(0);
-    metrics_submit_token_balance(balance);
-
-    compute_and_report_stats(
-        &maxes,
-        sample_period,
-        &start.elapsed(),
-        total_tx_sent_count.load(Ordering::Relaxed),
-    );
-
-    // join the cluster_info client threads
-    gossip_service.join().unwrap();
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    #[test]
-    fn test_switch_directions() {
-        assert_eq!(should_switch_directions(20, 0), false);
-        assert_eq!(should_switch_directions(20, 1), false);
-        assert_eq!(should_switch_directions(20, 14), false);
-        assert_eq!(should_switch_directions(20, 15), true);
-        assert_eq!(should_switch_directions(20, 16), false);
-        assert_eq!(should_switch_directions(20, 19), false);
-        assert_eq!(should_switch_directions(20, 20), true);
-        assert_eq!(should_switch_directions(20, 21), false);
-        assert_eq!(should_switch_directions(20, 99), false);
-        assert_eq!(should_switch_directions(20, 100), true);
-        assert_eq!(should_switch_directions(20, 101), false);
-    }
+    do_bench_tps(vec![client], config, keypairs, keypair_balance);
 }

benches/bank.rs

@@ -1,57 +0,0 @@
-#![feature(test)]
-
-extern crate test;
-
-use solana::bank::*;
-use solana::mint::Mint;
-use solana::status_deque::MAX_ENTRY_IDS;
-use solana_sdk::hash::hash;
-use solana_sdk::signature::{Keypair, KeypairUtil};
-use solana_sdk::system_transaction::SystemTransaction;
-use solana_sdk::transaction::Transaction;
-use test::Bencher;
-
-#[bench]
-fn bench_process_transaction(bencher: &mut Bencher) {
-    let mint = Mint::new(100_000_000);
-    let bank = Bank::new(&mint);
-
-    // Create transactions between unrelated parties.
-    let transactions: Vec<_> = (0..4096)
-        .into_iter()
-        .map(|_| {
-            // Seed the 'from' account.
-            let rando0 = Keypair::new();
-            let tx = Transaction::system_move(
-                &mint.keypair(),
-                rando0.pubkey(),
-                10_000,
-                bank.last_id(),
-                0,
-            );
-            assert_eq!(bank.process_transaction(&tx), Ok(()));
-
-            // Seed the 'to' account and a cell for its signature.
-            let rando1 = Keypair::new();
-            let tx = Transaction::system_move(&rando0, rando1.pubkey(), 1, bank.last_id(), 0);
-            assert_eq!(bank.process_transaction(&tx), Ok(()));
-
-            // Finally, return the transaction to the benchmark.
-            tx
-        })
-        .collect();
-
-    let mut id = bank.last_id();
-
-    for _ in 0..(MAX_ENTRY_IDS - 1) {
-        bank.register_tick(&id);
-        id = hash(&id.as_ref())
-    }
-
-    bencher.iter(|| {
-        // Since benchmarker runs this multiple times, we need to clear the signatures.
-        bank.clear_signatures();
-        let results = bank.process_transactions(&transactions);
-        assert!(results.iter().all(Result::is_ok));
-    })
-}

benches/banking_stage.rs

@@ -1,232 +0,0 @@
-#![feature(test)]
-
-extern crate test;
-
-use rand::{thread_rng, Rng};
-use rayon::prelude::*;
-use solana::bank::Bank;
-use solana::banking_stage::{BankingStage, NUM_THREADS};
-use solana::entry::Entry;
-use solana::mint::Mint;
-use solana::packet::to_packets_chunked;
-use solana::status_deque::MAX_ENTRY_IDS;
-use solana_sdk::hash::hash;
-use solana_sdk::pubkey::Pubkey;
-use solana_sdk::signature::{Keypair, KeypairUtil, Signature};
-use solana_sdk::system_transaction::SystemTransaction;
-use solana_sdk::transaction::Transaction;
-use std::iter;
-use std::sync::mpsc::{channel, Receiver};
-use std::sync::Arc;
-use std::time::Duration;
-use test::Bencher;
-
-fn check_txs(receiver: &Receiver<Vec<Entry>>, ref_tx_count: usize) {
-    let mut total = 0;
-    loop {
-        let entries = receiver.recv_timeout(Duration::new(1, 0));
-        if let Ok(entries) = entries {
-            for entry in &entries {
-                total += entry.transactions.len();
-            }
-        } else {
-            break;
-        }
-        if total >= ref_tx_count {
-            break;
-        }
-    }
-    assert_eq!(total, ref_tx_count);
-}
-
-#[bench]
-fn bench_banking_stage_multi_accounts(bencher: &mut Bencher) {
-    let txes = 1000 * NUM_THREADS;
-    let mint_total = 1_000_000_000_000;
-    let mint = Mint::new(mint_total);
-
-    let (verified_sender, verified_receiver) = channel();
-    let bank = Arc::new(Bank::new(&mint));
-    let dummy_leader_id = Keypair::new().pubkey();
-    let dummy = Transaction::system_move(
-        &mint.keypair(),
-        mint.keypair().pubkey(),
-        1,
-        mint.last_id(),
-        0,
-    );
-    let transactions: Vec<_> = (0..txes)
-        .into_par_iter()
-        .map(|_| {
-            let mut new = dummy.clone();
-            let from: Vec<u8> = (0..64).map(|_| thread_rng().gen()).collect();
-            let to: Vec<u8> = (0..64).map(|_| thread_rng().gen()).collect();
-            let sig: Vec<u8> = (0..64).map(|_| thread_rng().gen()).collect();
-            new.account_keys[0] = Pubkey::new(&from[0..32]);
-            new.account_keys[1] = Pubkey::new(&to[0..32]);
-            new.signatures = vec![Signature::new(&sig[0..64])];
-            new
-        })
-        .collect();
-    // fund all the accounts
-    transactions.iter().for_each(|tx| {
-        let fund = Transaction::system_move(
-            &mint.keypair(),
-            tx.account_keys[0],
-            mint_total / txes as u64,
-            mint.last_id(),
-            0,
-        );
-        let x = bank.process_transaction(&fund);
-        assert!(x.is_ok());
-    });
-    //sanity check, make sure all the transactions can execute sequentially
-    transactions.iter().for_each(|tx| {
-        let res = bank.process_transaction(&tx);
-        assert!(res.is_ok(), "sanity test transactions");
-    });
-    bank.clear_signatures();
-    //sanity check, make sure all the transactions can execute in parallel
-    let res = bank.process_transactions(&transactions);
-    for r in res {
-        assert!(r.is_ok(), "sanity parallel execution");
-    }
-    bank.clear_signatures();
-    let verified: Vec<_> = to_packets_chunked(&transactions.clone(), 192)
-        .into_iter()
-        .map(|x| {
-            let len = x.read().unwrap().packets.len();
-            (x, iter::repeat(1).take(len).collect())
-        })
-        .collect();
-    let (_stage, signal_receiver) = BankingStage::new(
-        &bank,
-        verified_receiver,
-        Default::default(),
-        &mint.last_id(),
-        None,
-        dummy_leader_id,
-    );
-
-    let mut id = mint.last_id();
-    for _ in 0..MAX_ENTRY_IDS {
-        id = hash(&id.as_ref());
-        bank.register_tick(&id);
-    }
-
-    bencher.iter(move || {
-        // make sure the tx last id is still registered
-        if bank.count_valid_ids(&[mint.last_id()]).len() == 0 {
-            bank.register_tick(&mint.last_id());
-        }
-        for v in verified.chunks(verified.len() / NUM_THREADS) {
-            verified_sender.send(v.to_vec()).unwrap();
-        }
-        check_txs(&signal_receiver, txes);
-        bank.clear_signatures();
-    });
-}
-
-#[bench]
-fn bench_banking_stage_multi_programs(bencher: &mut Bencher) {
-    let progs = 4;
-    let txes = 1000 * NUM_THREADS;
-    let mint_total = 1_000_000_000_000;
-    let mint = Mint::new(mint_total);
-
-    let (verified_sender, verified_receiver) = channel();
-    let bank = Arc::new(Bank::new(&mint));
-    let dummy_leader_id = Keypair::new().pubkey();
-    let dummy = Transaction::system_move(
-        &mint.keypair(),
-        mint.keypair().pubkey(),
-        1,
-        mint.last_id(),
-        0,
-    );
-    let transactions: Vec<_> = (0..txes)
-        .into_par_iter()
-        .map(|_| {
-            let mut new = dummy.clone();
-            let from: Vec<u8> = (0..32).map(|_| thread_rng().gen()).collect();
-            let sig: Vec<u8> = (0..64).map(|_| thread_rng().gen()).collect();
-            let to: Vec<u8> = (0..32).map(|_| thread_rng().gen()).collect();
-            new.account_keys[0] = Pubkey::new(&from[0..32]);
-            new.account_keys[1] = Pubkey::new(&to[0..32]);
-            let prog = new.instructions[0].clone();
-            for i in 1..progs {
-                //generate programs that spend to random keys
-                let to: Vec<u8> = (0..32).map(|_| thread_rng().gen()).collect();
-                let to_key = Pubkey::new(&to[0..32]);
-                new.account_keys.push(to_key);
-                assert_eq!(new.account_keys.len(), i + 2);
-                new.instructions.push(prog.clone());
-                assert_eq!(new.instructions.len(), i + 1);
-                new.instructions[i].accounts[1] = 1 + i as u8;
-                assert_eq!(new.key(i, 1), Some(&to_key));
-                assert_eq!(
-                    new.account_keys[new.instructions[i].accounts[1] as usize],
-                    to_key
-                );
-            }
-            assert_eq!(new.instructions.len(), progs);
-            new.signatures = vec![Signature::new(&sig[0..64])];
-            new
-        })
-        .collect();
-    transactions.iter().for_each(|tx| {
-        let fund = Transaction::system_move(
-            &mint.keypair(),
-            tx.account_keys[0],
-            mint_total / txes as u64,
-            mint.last_id(),
-            0,
-        );
-        assert!(bank.process_transaction(&fund).is_ok());
-    });
-    //sanity check, make sure all the transactions can execute sequentially
-    transactions.iter().for_each(|tx| {
-        let res = bank.process_transaction(&tx);
-        assert!(res.is_ok(), "sanity test transactions");
-    });
-    bank.clear_signatures();
-    //sanity check, make sure all the transactions can execute in parallel
-    let res = bank.process_transactions(&transactions);
-    for r in res {
-        assert!(r.is_ok(), "sanity parallel execution");
-    }
-    bank.clear_signatures();
-    let verified: Vec<_> = to_packets_chunked(&transactions.clone(), 96)
-        .into_iter()
-        .map(|x| {
-            let len = x.read().unwrap().packets.len();
-            (x, iter::repeat(1).take(len).collect())
-        })
-        .collect();
-    let (_stage, signal_receiver) = BankingStage::new(
-        &bank,
-        verified_receiver,
-        Default::default(),
-        &mint.last_id(),
-        None,
-        dummy_leader_id,
-    );
-
-    let mut id = mint.last_id();
-    for _ in 0..MAX_ENTRY_IDS {
-        id = hash(&id.as_ref());
-        bank.register_tick(&id);
-    }
-
-    bencher.iter(move || {
-        // make sure the transactions are still valid
-        if bank.count_valid_ids(&[mint.last_id()]).len() == 0 {
-            bank.register_tick(&mint.last_id());
-        }
-        for v in verified.chunks(verified.len() / NUM_THREADS) {
-            verified_sender.send(v.to_vec()).unwrap();
-        }
-        check_txs(&signal_receiver, txes);
-        bank.clear_signatures();
-    });
-}

benches/db_ledger.rs

@@ -1,199 +0,0 @@
-#![feature(test)]
-use rand;
-
-extern crate test;
-
-use rand::seq::SliceRandom;
-use rand::{thread_rng, Rng};
-use rocksdb::{Options, DB};
-use solana::db_ledger::{DataCf, DbLedger, LedgerColumnFamilyRaw};
-use solana::ledger::{get_tmp_ledger_path, make_large_test_entries, make_tiny_test_entries, Block};
-use solana::packet::{Blob, BLOB_HEADER_SIZE};
-use test::Bencher;
-
-// Given some blobs and a ledger at ledger_path, benchmark writing the blobs to the ledger
-fn bench_write_blobs(bench: &mut Bencher, blobs: &mut [&mut Blob], ledger_path: &str) {
-    let db_ledger =
-        DbLedger::open(&ledger_path).expect("Expected to be able to open database ledger");
-    let slot = 0;
-    let num_blobs = blobs.len();
-    bench.iter(move || {
-        for blob in blobs.iter_mut() {
-            let index = blob.index().unwrap();
-            let key = DataCf::key(slot, index);
-            let size = blob.size().unwrap();
-            db_ledger
-                .data_cf
-                .put(&db_ledger.db, &key, &blob.data[..BLOB_HEADER_SIZE + size])
-                .unwrap();
-            blob.set_index(index + num_blobs as u64).unwrap();
-        }
-    });
-
-    DB::destroy(&Options::default(), &ledger_path)
-        .expect("Expected successful database destruction");
-}
-
-// Insert some blobs into the ledger in preparation for read benchmarks
-fn setup_read_bench(
-    db_ledger: &mut DbLedger,
-    num_small_blobs: u64,
-    num_large_blobs: u64,
-    slot: u64,
-) {
-    // Make some big and small entries
-    let mut entries = make_large_test_entries(num_large_blobs as usize);
-    entries.extend(make_tiny_test_entries(num_small_blobs as usize));
-
-    // Convert the entries to blobs, write the blobs to the ledger
-    let shared_blobs = entries.to_blobs();
-    for b in shared_blobs.iter() {
-        b.write().unwrap().set_slot(slot).unwrap();
-    }
-    db_ledger
-        .write_shared_blobs(&shared_blobs)
-        .expect("Expectd successful insertion of blobs into ledger");
-}
-
-// Write small blobs to the ledger
-#[bench]
-#[ignore]
-fn bench_write_small(bench: &mut Bencher) {
-    let ledger_path = get_tmp_ledger_path("bench_write_small");
-    let num_entries = 32 * 1024;
-    let entries = make_tiny_test_entries(num_entries);
-    let shared_blobs = entries.to_blobs();
-    let mut blob_locks: Vec<_> = shared_blobs.iter().map(|b| b.write().unwrap()).collect();
-    let mut blobs: Vec<&mut Blob> = blob_locks.iter_mut().map(|b| &mut **b).collect();
-    bench_write_blobs(bench, &mut blobs, &ledger_path);
-}
-
-// Write big blobs to the ledger
-#[bench]
-#[ignore]
-fn bench_write_big(bench: &mut Bencher) {
-    let ledger_path = get_tmp_ledger_path("bench_write_big");
-    let num_entries = 32 * 1024;
-    let entries = make_tiny_test_entries(num_entries);
-    let shared_blobs = entries.to_blobs();
-    let mut blob_locks: Vec<_> = shared_blobs.iter().map(|b| b.write().unwrap()).collect();
-    let mut blobs: Vec<&mut Blob> = blob_locks.iter_mut().map(|b| &mut **b).collect();
-    bench_write_blobs(bench, &mut blobs, &ledger_path);
-}
-
-#[bench]
-#[ignore]
-fn bench_read_sequential(bench: &mut Bencher) {
-    let ledger_path = get_tmp_ledger_path("bench_read_sequential");
-    let mut db_ledger =
-        DbLedger::open(&ledger_path).expect("Expected to be able to open database ledger");
-
-    // Insert some big and small blobs into the ledger
-    let num_small_blobs = 32 * 1024;
-    let num_large_blobs = 32 * 1024;
-    let total_blobs = num_small_blobs + num_large_blobs;
-    let slot = 0;
-    setup_read_bench(&mut db_ledger, num_small_blobs, num_large_blobs, slot);
-
-    let num_reads = total_blobs / 15;
-    let mut rng = rand::thread_rng();
-    bench.iter(move || {
-        // Generate random starting point in the range [0, total_blobs - 1], read num_reads blobs sequentially
-        let start_index = rng.gen_range(0, num_small_blobs + num_large_blobs);
-        for i in start_index..start_index + num_reads {
-            let _ =
-                db_ledger
-                    .data_cf
-                    .get_by_slot_index(&db_ledger.db, slot, i as u64 % total_blobs);
-        }
-    });
-
-    DB::destroy(&Options::default(), &ledger_path)
-        .expect("Expected successful database destruction");
-}
-
-#[bench]
-#[ignore]
-fn bench_read_random(bench: &mut Bencher) {
-    let ledger_path = get_tmp_ledger_path("bench_read_random");
-    let mut db_ledger =
-        DbLedger::open(&ledger_path).expect("Expected to be able to open database ledger");
-
-    // Insert some big and small blobs into the ledger
-    let num_small_blobs = 32 * 1024;
-    let num_large_blobs = 32 * 1024;
-    let total_blobs = num_small_blobs + num_large_blobs;
-    let slot = 0;
-    setup_read_bench(&mut db_ledger, num_small_blobs, num_large_blobs, slot);
-
-    let num_reads = total_blobs / 15;
-
-    // Generate a num_reads sized random sample of indexes in range [0, total_blobs - 1],
-    // simulating random reads
-    let mut rng = rand::thread_rng();
-    let indexes: Vec<usize> = (0..num_reads)
-        .map(|_| rng.gen_range(0, total_blobs) as usize)
-        .collect();
-    bench.iter(move || {
-        for i in indexes.iter() {
-            let _ = db_ledger
-                .data_cf
-                .get_by_slot_index(&db_ledger.db, slot, *i as u64);
-        }
-    });
-
-    DB::destroy(&Options::default(), &ledger_path)
-        .expect("Expected successful database destruction");
-}
-
-#[bench]
-#[ignore]
-fn bench_insert_data_blob_small(bench: &mut Bencher) {
-    let ledger_path = get_tmp_ledger_path("bench_insert_data_blob_small");
-    let db_ledger =
-        DbLedger::open(&ledger_path).expect("Expected to be able to open database ledger");
-    let num_entries = 32 * 1024;
-    let entries = make_tiny_test_entries(num_entries);
-    let mut shared_blobs = entries.to_blobs();
-    shared_blobs.shuffle(&mut thread_rng());
-
-    bench.iter(move || {
-        for blob in shared_blobs.iter_mut() {
-            let index = blob.read().unwrap().index().unwrap();
-            db_ledger.write_shared_blobs(vec![blob.clone()]).unwrap();
-            blob.write()
-                .unwrap()
-                .set_index(index + num_entries as u64)
-                .unwrap();
-        }
-    });
-
-    DB::destroy(&Options::default(), &ledger_path)
-        .expect("Expected successful database destruction");
-}
-
-#[bench]
-#[ignore]
-fn bench_insert_data_blob_big(bench: &mut Bencher) {
-    let ledger_path = get_tmp_ledger_path("bench_insert_data_blob_big");
-    let db_ledger =
-        DbLedger::open(&ledger_path).expect("Expected to be able to open database ledger");
-    let num_entries = 32 * 1024;
-    let entries = make_large_test_entries(num_entries);
-    let mut shared_blobs = entries.to_blobs();
-    shared_blobs.shuffle(&mut thread_rng());
-
-    bench.iter(move || {
-        for blob in shared_blobs.iter_mut() {
-            let index = blob.read().unwrap().index().unwrap();
-            db_ledger.write_shared_blobs(vec![blob.clone()]).unwrap();
-            blob.write()
-                .unwrap()
-                .set_index(index + num_entries as u64)
-                .unwrap();
-        }
-    });
-
-    DB::destroy(&Options::default(), &ledger_path)
-        .expect("Expected successful database destruction");
-}

book/.gitattributes

@@ -0,0 +1 @@
+theme/highlight.js binary

book/art/data-plane-fanout.bob

@@ -0,0 +1,19 @@
++------------------------------------------------------------------+
+|                                                                  |
+|   +-----------------+    Neighborhood 0    +-----------------+   |
+|   |                 +--------------------->+                 |   |
+|   |   Validator 1   |                      |   Validator 2   |   |
+|   |                 +<---------------------+                 |   |
+|   +--------+-+------+                      +------+-+--------+   |
+|            | |                                    | |            |
+|            | +-----------------------------+      | |            |
+|            |      +------------------------+------+ |            |
+|            |      |                        |        |            |
++------------------------------------------------------------------+
+             |      |                        |        |
+             v      v                        v        v
+   +---------+------+---+                  +-+--------+---------+
+   |                    |                  |                    |
+   |   Neighborhood 1   |                  |   Neighborhood 2   |
+   |                    |                  |                    |
+   +--------------------+                  +--------------------+

book/art/data-plane-neighborhood.bob

@@ -0,0 +1,25 @@
++---------------------------------------------------------------------------------------------------------+
+|                                           Neighborhood Above                                            |
+|                                                                                                         |
+|      +----------------+       +----------------+       +----------------+       +----------------+      |
+|      |                +------>+                +------>+                +------>+                |      |
+|      |   Neighbor 1   |       |   Neighbor 2   |       |   Neighbor 3   |       |   Neighbor 4   |      |
+|      |                +<------+                +<------+                +<------+                |      |
+|      +--+-------------+       +--+-------------+       +-----+----------+       +--+-------------+      |
+|         |                        |                           |                     |                    |
++---------------------------------------------------------------------------------------------------------+
+          |                        |                           |                     |
+          |                        |                           |                     |
+          |                        |                           |                     |
+          |                        |                           |                     |
+          |                        |                           |                     |
++---------------------------------------------------------------------------------------------------------+
+|         |                        |        Neighborhood Below |                     |                    |
+|         v                        v                           v                     v                    |
+|      +--+-------------+       +--+-------------+       +-----+----------+       +--+-------------+      |
+|      |                +------>+                +------>+                +------>+                |      |
+|      |   Neighbor 1   |       |   Neighbor 2   |       |   Neighbor 3   |       |   Neighbor 4   |      |
+|      |                +<------+                +<------+                +<------+                |      |
+|      +----------------+       +----------------+       +----------------+       +----------------+      |
+|                                                                                                         |
++---------------------------------------------------------------------------------------------------------+

book/art/data-plane-seeding.bob

@@ -0,0 +1,15 @@
+                          +--------------+
+                          |              |
+             +------------+    Leader    +------------+
+             |            |              |            |
+             |            +--------------+            |
+             v                                        v
++------------+----------------------------------------+------------+
+|                                                                  |
+|   +-----------------+    Neighborhood 0    +-----------------+   |
+|   |                 +--------------------->+                 |   |
+|   |   Validator 1   |                      |   Validator 2   |   |
+|   |                 +<---------------------+                 |   |
+|   +-----------------+                      +-----------------+   |
+|                                                                  |
++------------------------------------------------------------------+

book/art/data-plane.bob

@@ -1,25 +1,18 @@
-                                     .-------------.
-                                     |             |
-                       .-------------+   Leader    +══════════════╗
-                       |             |             |              ║
-                       |             `-------------`              ║
-                       v                                          v
-                .-------------.                            .-------------.
-                |             +--------------------------->|             |
-           .----+ Validator 1 |                            | Validator 2 +═══╗
-           |    |             |<═══════════════════════════+             |   ║
-           |    `------+------`                            `------+------`   ║
-           |           |                                          ║          ║
-           |           `------------------------------.           ║          ║
-           |                                          |           ║          ║
-           |                     ╔════════════════════════════════╝          ║
-           |                     ║                    |                      ║
-           V                     v                    V                      v
-    .-------------.       .-------------.       .-------------.       .-------------.
-    |             |       |             |       |             |       |             |
-    | Validator 3 +------>| Validator 4 +══════>| Validator 5 +------>| Validator 6 |
-    |             |       |             |       |             |       |             |
-    `-------------`       `-------------`       `-------------`       `------+------`
-           ^                                                                 ║
-           ║                                                                 ║
-           ╚═════════════════════════════════════════════════════════════════╝
+                                  +--------------------+
+                                  |                    |
+                         +--------+   Neighborhood 0   +----------+
+                         |        |                    |          |
+                         |        +--------------------+          |
+                         v                                        v
+               +---------+----------+                  +----------+---------+
+               |                    |                  |                    |
+               |   Neighborhood 1   |                  |   Neighborhood 2   |
+               |                    |                  |                    |
+               +---+-----+----------+                  +----------+-----+---+
+                   |     |                                        |     |
+                   v     v                                        v     v
++------------------+-+ +-+------------------+  +------------------+-+ +-+------------------+
+|                    | |                    |  |                    | |                    |
+|   Neighborhood 3   | |   Neighborhood 4   |  |   Neighborhood 5   | |   Neighborhood 6   |
+|                    | |                    |  |                    | |                    |
++--------------------+ +--------------------+  +--------------------+ +--------------------+

book/art/forks-pruned.bob

@@ -0,0 +1,9 @@
+     1
+     |
+     2
+    /|
+   / |
+  |  |
+  |  4
+  |
+  5

book/art/forks-pruned2.bob

@@ -0,0 +1,11 @@
+ 1
+ |
+ 3
+ |\
+ | \
+ |  |
+ |  |
+ |  |
+ 6  |
+    |
+    7

book/art/forks.bob

@@ -0,0 +1,13 @@
+     1
+     |\
+     2 \
+    /|  |
+   / |  3
+  |  |  |\
+  |  4  | \
+  |     |  |
+  5     |  |
+        |  |
+        6  |
+           |
+           7

book/art/fullnode.bob

@@ -1,27 +0,0 @@
-             .---------------------------.
-             |  Fullnode                 |
-             |                           |
- .--------.  |  .------------------.     |
- |        |---->|                  |     |
- | Client |  |  | JSON RPC Service |     |
- |        |<----|                  |     |
- `----+---`  |  `------------------`     |
-      |      |     ^                     |    .------------------.
-      |      |     |  .----------------. |    | Validators       |
-      |      |     |  | Gossip Service +----->|                  |
-      |      |     |  `--------+-------` |    |  .------------.  |
-      |      |     |         ^ |         |    |  |            |  |
-      |      |     |         | v         |    |  | Upstream   |  |
-      |      |  .--+---.   .-+---.       |    |  | Validators |  |
-      |      |  | Bank |<--| TVU |<--------------+            |  |
-      |      |  `------`   `-----`       |    |  `------------`  |
-      |      |     ^                     |    |                  |
-      |      |     |                     |    |  .------------.  |
-      |      |  .--+--.   .-----------.  |    |  |            |  |
-      `-------->| TPU +-->| Broadcast +--------->| Downstream |  |
-             |  `-----`   | Service   |  |    |  | Validators |  |
-             |            `-----------`  |    |  |            |  |
-             |                           |    |  `------------`  |
-             `---------------------------`    |                  |
-                                              `------------------`
-

book/art/passive-staking-callflow.msc

@@ -0,0 +1,30 @@
+msc {
+  hscale="2.2";
+   VoteSigner,
+   Validator,
+   Cluster,
+   StakerX,
+   StakerY;
+
+   |||;
+  Validator box Validator [label="boot.."];
+
+  VoteSigner <:> Validator [label="register\n\n(optional)"];
+  Validator => Cluster [label="VoteState::Initialize(VoteSigner)"];
+  StakerX => Cluster [label="StakeState::Delegate(Validator)"];
+  StakerY => Cluster [label="StakeState::Delegate(Validator)"];
+
+     |||;
+  Validator box Cluster [label="\nvalidate\n"];
+  Validator => VoteSigner [label="sign(vote)"];
+  VoteSigner >> Validator [label="signed vote"];
+
+  Validator => Cluster [label="gossip(vote)"];
+  ...;
+  ... ;
+  Validator abox Validator [label="\nmax\nlockout\n"];
+       |||;
+  StakerX => Cluster [label="StakeState::RedeemCredits()"];
+  StakerY => Cluster [label="StakeState::RedeemCredits()"] ;
+
+}

book/art/runtime.bob

@@ -1,9 +1,10 @@
+.------------.     .-----------.    .---------------.    .--------------.    .-----------------------.
+| PoH verify +---> | sigverify +--->| lock accounts +--->| validate fee +--->| allocate new accounts +--->
+|     TVU    |     `-----------`    `---------------`    `--------------`    `-----------------------`
+`------------`
 
-.-----------.    .-------------.    .--------------.    .--------------------.    
-| sigverify +--->| lock memory +--->| validate fee +--->| allocate accounts  +--->
-`-----------`    `-------------`    `--------------`    `--------------------`    
-                                
-    .------------.    .---------.    .--------------.   .--------------.
---->| load data  +--->| execute +--->| commit data  +-->|unlock memory |
-    `------------`    `---------`    `--------------`   `--------------`
+    .---------------.    .---------.    .------------.    .-----------------.   .-----------------.
+--->| load accounts +--->| execute +--->| PoH record +--->| commit accounts +-->| unlock accounts |
+    `---------------`    `---------`    |    TPU     |    `-----------------`   `-----------------`
+                                        `------------`
 

book/art/tpu.bob

@@ -1,16 +1,17 @@
-             .------------------------------------------------------.
-             |  TPU                     .-------------.             |
-             |                          | PoH Service |             |
-             |                          `--------+----`             |
-             |                              ^    |                  |
-             |                              |    v                  |
-             |  .-------.  .-----------.  .-+-------.   .--------.  |  .------------.
- .---------. |  | Fetch |  | SigVerify |  | Banking |   | Ledger |  |  | Broadcast  |
- | Clients |--->| Stage |->| Stage     |->| Stage   |-->| Write  +---->| Service    |
- `---------` |  |       |  |           |  |         |   | Stage  |  |  |            |
-             |  `-------`  `-----------`  `----+----`   `--------`  |  `------------`
-             |                                 |                    |
-             `---------------------------------|--------------------`
+
+                                        .-------------.
+                                        | PoH Service |
+                                        `--------+----`
+                                            ^    |
+             .------------------------------|----|--------------------.
+             | TPU                          |    v                    |
+             |  .-------.  .-----------.  .-+-------.  .-----------.  |  .------------.
+ .---------. |  | Fetch |  | SigVerify |  | Banking |  | Broadcast |  |  | Downstream |
+ | Clients |--->| Stage |->| Stage     |->| Stage   |->| Stage     |---->| Validators |
+ `---------` |  |       |  |           |  |         |  |           |  |  |            |
+             |  `-------`  `-----------`  `----+----`  `-----------`  |  `------------`
+             |                                 |                      |
+             `---------------------------------|----------------------`
                                                |
                                                v
                                             .------.

book/art/tvu.bob

@@ -3,17 +3,17 @@
                                                   `--------`
                                                        ^
                                                        |
-                  .------------------------------------|---------------------------------.
-                  |  TVU                               |                                 |
-                  |                                    |                                 |
-                  |  .-------.   .------------.   .----+---.   .--------.   .---------.  |
- .------------.   |  | Blob  |   | Retransmit |   | Replay |   | Ledger |   | Storage |  |
- | Upstream   +----->| Fetch |-->| Stage      |-->| Stage  |-->| Write  |-->| Stage   |  |
- | Validators |   |  | Stage |   |            |   |        |   | Stage  |   |         |  |
- `------------`   |  `-------`   `----+-------`   `----+---`   `--------`   `---------`  |
-                  |        ^          |                |                                 |
-                  |        |          |                |                                 |
-                  `--------|----------|----------------|---------------------------------`
+                  .------------------------------------|--------------------.
+                  |  TVU                               |                    |
+                  |                                    |                    |
+                  |  .-------.   .------------.   .----+---.   .---------.  |
+ .------------.   |  | Blob  |   | Retransmit |   | Replay |   | Storage |  |
+ | Upstream   +----->| Fetch +-->| Stage      +-->| Stage  +-->| Stage   |  |
+ | Validators |   |  | Stage |   |            |   |        |   |         |  |
+ `------------`   |  `-------`   `----+-------`   `----+---`   `---------`  |
+                  |        ^          |                |                    |
+                  |        |          |                |                    |
+                  `--------|----------|----------------|--------------------`
                            |          |                |
                            |          V                v
                           .+-----------.            .------.

book/art/validator-proposal.bob

@@ -0,0 +1,60 @@
+
+                                 .------------.
+                                 | Upstream   |
+                                 | Validators |
+                                 `----+-------`
+                                      |
+                                      |
+             .-----------------------------------.
+             | Validator              |          |
+             |                        v          |
+             |  .-----------.    .------------.  |
+ .--------.  |  | Fetch     |    | Repair     |  |
+ | Client +---->| Stage     |    | Stage      |  |
+ `--------`  |  `---+-------`    `----+-------`  |
+             |      |                 |          |
+             |      v                 v          |
+             |  .-----------.    .------------.  |
+             |  | TPU       |<-->| Blockstore |  |
+             |  |           |    |            |  |
+             |  `-----------`    `----+-------`  |
+             |                        |          |
+             |                        v          |
+             |                   .------------.  |
+             |                   | Multicast  |  |
+             |                   | Stage      |  |
+             |                   `----+-------`  |
+             |                        |          |
+             `-----------------------------------`
+                                      |
+                                      v
+                                 .------------.
+                                 | Downstream |
+                                 | Validators |
+                                 `------------`
+
+
+
+                                 .------------.
+                                 | PoH        |
+                                 | Service    |
+                                 `-------+----`
+                                     ^   |
+                                     |   |
+             .-----------------------------------.
+             | TPU                   |   |       |
+             |                       |   v       |
+  .-------.  |  .-----------.    .---+--------.  |  .------------.
+  | Fetch +---->| SigVerify +--->| Banking    |<--->| Blockstore |
+  | Stage |  |  | Stage     |    | Stage      |  |  |            |
+  `-------`  |  `-----------`    `-----+------`  |  `------------`
+             |                         |         |
+             |                         |         |
+             `-----------------------------------`
+                                       |
+                                       v
+                                 .------------.
+                                 | Banktree   |
+                                 |            |
+                                 `------------`
+

book/art/validator.bob

@@ -0,0 +1,30 @@
+             .--------------------------------------.
+             |  Validator                           |
+             |                                      |
+ .--------.  |  .-------------------.               |
+ |        |---->|                   |               |
+ | Client |  |  | JSON RPC Service  |               |
+ |        |<----|                   |               |
+ `----+---`  |  `-------------------`               |
+      |      |     ^                                |
+      |      |     |     .----------------.         | .------------------.
+      |      |     |     | Gossip Service |<----------| Validators       |
+      |      |     |     `----------------`         | |                  |
+      |      |     |           ^                    | |                  |
+      |      |     |           |                    | |  .------------.  |
+      |      | .---+---.  .----+---. .-----------.  | |  |            |  |
+      |      | | Bank  |<-+ Replay | | BlobFetch |<------+ Upstream   |  |
+      |      | | Forks |  | Stage  | |  Stage    |  | |  | Validators |  |
+      |      | `-------`  `--------` `--+--------`  | |  |            |  |
+      |      |     ^              ^     |           | |  `------------`  |
+      |      |     |              |     v           | |                  |
+      |      |     |           .--+--------.        | |                  |
+      |      |     |           | Blocktree |        | |                  |
+      |      |     |           `-----------`        | |  .------------.  |
+      |      |     |                ^               | |  |            |  |
+      |      |     |                |               | |  | Downstream |  |
+      |      |  .--+--.     .-------+---.           | |  | Validators |  |
+      `-------->| TPU +---->| Broadcast +--------------->|            |  |
+             |  `-----`     | Stage     |           | |  `------------`  |
+             |              `-----------`           | `------------------`
+             `--------------------------------------`

book/build.sh

@@ -3,16 +3,4 @@ set -e
 
 cd "$(dirname "$0")"
 
-cargo_install_unless() {
-  declare crate=$1
-  shift
-
-  "$@" > /dev/null 2>&1 || \
-    cargo install "$crate"
-}
-
-export PATH=$CARGO_HOME/bin:$PATH
-cargo_install_unless mdbook mdbook --help
-cargo_install_unless svgbob_cli svgbob --help
-
 make -j"$(nproc)"

book/makefile

@@ -1,7 +1,8 @@
 BOB_SRCS=$(wildcard art/*.bob)
+MSC_SRCS=$(wildcard art/*.msc)
 MD_SRCS=$(wildcard src/*.md)
 
-SVG_IMGS=$(BOB_SRCS:art/%.bob=src/img/%.svg)
+SVG_IMGS=$(BOB_SRCS:art/%.bob=src/img/%.svg) $(MSC_SRCS:art/%.msc=src/img/%.svg)
 
 all: html/index.html
 
@@ -17,6 +18,10 @@ src/img/%.svg: art/%.bob
 	@mkdir -p $(@D)
 	svgbob < $< > $@
 
+ src/img/%.svg: art/%.msc
+	@mkdir -p $(@D)
+	mscgen -T svg -i $< -o $@
+
 src/%.md: %.md
 	@mkdir -p $(@D)
 	@cp $< $@

book/src/SUMMARY.md

@@ -5,6 +5,8 @@
 - [Terminology](terminology.md)
 
 - [Getting Started](getting-started.md)
+  - [Testnet Participation](testnet-participation.md)
+  - [Testnet Replicator](testnet-replicator.md)
   - [Example: Web Wallet](webwallet.md)
 
 - [Programming Model](programs.md)
@@ -15,23 +17,56 @@
   - [Synchronization](synchronization.md)
   - [Leader Rotation](leader-rotation.md)
   - [Fork Generation](fork-generation.md)
+  - [Managing Forks](managing-forks.md)
+  - [Turbine Block Propagation](turbine-block-propagation.md)
+  - [Ledger Replication](ledger-replication.md)
+  - [Secure Vote Signing](vote-signing.md)
+  - [Stake Delegation and Rewards](stake-delegation-and-rewards.md)
+  - [Performance Metrics](performance-metrics.md)
 
-- [Anatomy of a Fullnode](fullnode.md)
+- [Anatomy of a Validator](validator.md)
   - [TPU](tpu.md)
   - [TVU](tvu.md)
+    - [Blocktree](blocktree.md)
   - [Gossip Service](gossip.md)
   - [The Runtime](runtime.md)
 
-- [Proposed Architectural Changes](proposals.md)
-  - [Ledger Replication](ledger-replication.md)
-  - [Secure Enclave](enclave.md)
-  - [Staking Rewards](staking-rewards.md)
-  - [Fork Selection](fork-selection.md)
-  - [Entry Tree](entry-tree.md)
-
-## Appendix
-
-- [Appendix](appendix.md)
+- [API Reference](api-reference.md)
+  - [Blockstreamer](blockstreamer.md)
   - [JSON RPC API](jsonrpc-api.md)
   - [JavaScript API](javascript-api.md)
   - [solana-wallet CLI](wallet.md)
+
+- [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)
+  - [Credit-only Accounts](credit-only-credit-debit-accounts.md)
+  - [Validator](validator-proposal.md)
+
+- [Implemented Design Proposals](implemented-proposals.md)
+  - [Blocktree](blocktree.md)
+  - [Cluster Software Installation and Updates](installer.md)
+  - [Deterministic Transaction Fees](transaction-fees.md)
+  - [Fork Selection](fork-selection.md)
+  - [Leader-to-Leader Transition](leader-leader-transition.md)
+  - [Leader-to-Validator Transition](leader-validator-transition.md)
+  - [Passive Stake Delegation and Rewards](passive-stake-delegation-and-rewards.md)
+  - [Persistent Account Storage](persistent-account-storage.md)
+  - [Reliable Vote Transmission](reliable-vote-transmission.md)
+  - [Repair Service](repair-service.md) 
+  - [Testing Programs](testing-programs.md)

book/src/api-reference.md

@@ -0,0 +1,4 @@
+# API Reference
+
+The following sections contain API references material you may find useful
+when developing applications utilizing a Solana cluster.

book/src/appendix.md

@@ -1,4 +0,0 @@
-# Appendix
-
-The following sections contain reference material you may find useful in your
-Solana journey.

book/src/block-confirmation.md

@@ -0,0 +1,84 @@
+# Block Confirmation
+
+A validator votes on a PoH hash for two purposes. First, the vote indicates it
+believes the ledger is valid up until that point in time. Second, since many
+valid forks may exist at a given height, the vote also indicates exclusive
+support for the fork. This document describes only the former. The latter is
+described in [fork selection](fork-selection.md).
+
+## Current Design
+
+To start voting, a validator first registers an account to which it will send
+its votes. It then sends votes to that account. The vote contains the tick
+height of the block it is voting on. The account stores the 32 highest heights.
+
+### Problems
+
+* Only the validator knows how to find its own votes directly.
+
+  Other components, such as the one that calculates confirmation time, needs to
+  be baked into the fullnode code. The fullnode code queries the bank for all
+  accounts owned by the vote program.
+
+* Voting ballots do not contain a PoH hash. The validator is only voting that
+  it has observed an arbitrary block at some height.
+
+* Voting ballots do not contain a hash of the bank state. Without that hash,
+  there is no evidence that the validator executed the transactions and
+  verified there were no double spends.
+
+## Proposed Design
+
+### No Cross-block State Initially
+
+At the moment a block is produced, the leader shall add a NewBlock transaction
+to the ledger with a number of tokens that represents the validation reward.
+It is effectively an incremental multisig transaction that sends tokens from
+the mining pool to the validators. The account should allocate just enough
+space to collect the votes required to achieve a supermajority. When a
+validator observes the NewBlock transaction, it has the option to submit a vote
+that includes a hash of its ledger state (the bank state). Once the account has
+sufficient votes, the vote program should disperse the tokens to the
+validators, which causes the account to be deleted.
+
+#### Logging Confirmation Time
+
+The bank will need to be aware of the vote program. After each transaction, it
+should check if it is a vote transaction and if so, check the state of that
+account. If the transaction caused the supermajority to be achieved, it should
+log the time since the NewBlock transaction was submitted.
+
+### Finality and Payouts
+
+Locktower is the proposed [fork selection](fork-selection.md) algorithm. It
+proposes that payment to miners be postponed until the *stack* of validator
+votes reaches a certain depth, at which point rollback is not economically
+feasible. The vote program may therefore implement locktower. Vote instructions
+would need to reference a global locktower account so that it can track
+cross-block state.
+
+## Challenges
+
+### On-chain voting
+
+Using programs and accounts to implement this is a bit tedious. The hardest
+part is figuring out how much space to allocate in NewBlock. The two variables
+are the *active set* and the stakes of those validators. If we calculate the
+active set at the time NewBlock is submitted, the number of validators to
+allocate space for is known upfront. If, however, we allow new validators to
+vote on old blocks, then we'd need a way to allocate space dynamically.
+
+Similar in spirit, if the leader caches stakes at the time of NewBlock, the
+vote program doesn't need to interact with the bank when it processes votes. If
+we don't, then we have the option to allow stakes to float until a vote is
+submitted. A validator could conceivably reference its own staking account, but
+that'd be the current account value instead of the account value of the most
+recently finalized bank state. The bank currently doesn't offer a means to
+reference accounts from particular points in time.
+
+### Voting Implications on Previous Blocks
+
+Does a vote on one height imply a vote on all blocks of lower heights of
+that fork? If it does, we'll need a way to lookup the accounts of all
+blocks that haven't yet reached supermajority. If not, the validator could
+send votes to all blocks explicitly to get the block rewards.

book/src/blockstreamer.md

@@ -0,0 +1,37 @@
+# Blockstreamer
+
+Solana supports a node type called an *blockstreamer*. This fullnode variation
+is intended for applications that need to observe the data plane without
+participating in transaction validation or ledger replication.
+
+A blockstreamer runs without a vote signer, and can optionally stream ledger
+entries out to a Unix domain socket as they are processed. The JSON-RPC service
+still functions as on any other node.
+
+To run a blockstreamer, include the argument `no-signer` and (optional)
+`blockstream` socket location:
+
+```bash
+$ ./multinode-demo/validator-x.sh --no-signer --blockstream <SOCKET>
+```
+
+The stream will output a series of JSON objects:
+- An Entry event JSON object is sent when each ledger entry is processed, with
+the following fields:
+
+   * `dt`, the system datetime, as RFC3339-formatted string
+   * `t`, the event type, always "entry"
+   * `s`, the slot height, as unsigned 64-bit integer
+   * `h`, the tick height, as unsigned 64-bit integer
+   * `entry`, the entry, as JSON object
+
+
+- A Block event JSON object is sent when a block is complete, with the
+following fields:
+
+   * `dt`, the system datetime, as RFC3339-formatted string
+   * `t`, the event type, always "block"
+   * `s`, the slot height, as unsigned 64-bit integer
+   * `h`, the tick height, as unsigned 64-bit integer
+   * `l`, the slot leader id, as base-58 encoded string
+   * `id`, the block id, as base-58 encoded string

book/src/blocktree.md

@@ -0,0 +1,102 @@
+# Blocktree
+
+After a block reaches finality, all blocks from that one on down
+to the genesis block form a linear chain with the familiar name
+blockchain. Until that point, however, the validator must maintain all
+potentially valid chains, called *forks*. The process by which forks
+naturally form as a result of leader rotation is described in
+[fork generation](fork-generation.md). The *blocktree* data structure
+described here is how a validator copes with those forks until blocks
+are finalized.
+
+The blocktree allows a validator to record every blob it observes
+on the network, in any order, as long as the blob is signed by the expected
+leader for a given slot.
+
+Blobs are moved to a fork-able key space the tuple of `leader slot` + `blob
+index` (within the slot).  This permits the skip-list structure of the Solana
+protocol to be stored in its entirety, without a-priori choosing which fork to
+follow, which Entries to persist or when to persist them.
+
+Repair requests for recent blobs are served out of RAM or recent files and out
+of deeper storage for less recent blobs, as implemented by the store backing
+Blocktree.
+
+### Functionalities of Blocktree
+
+1. Persistence: the Blocktree lives in the front of the nodes verification
+   pipeline, right behind network receive and signature verification.  If the
+blob received is consistent with the leader schedule (i.e. was signed by the
+leader for the indicated slot), it is immediately stored.
+2. Repair: repair is the same as window repair above, but able to serve any
+   blob that's been received. Blocktree stores blobs with signatures,
+preserving the chain of origination.
+3. Forks: Blocktree supports random access of blobs, so can support a
+   validator's need to rollback and replay from a Bank checkpoint.
+4. Restart: with proper pruning/culling, the Blocktree can be replayed by
+   ordered enumeration of entries from slot 0.  The logic of the replay stage
+(i.e. dealing with forks) will have to be used for the most recent entries in
+the Blocktree.
+
+### Blocktree Design
+
+1. Entries in the Blocktree are stored as key-value pairs, where the key is the concatenated
+slot index and blob index for an entry, and the value is the entry data. Note blob indexes are zero-based for each slot (i.e. they're slot-relative).
+
+2. The Blocktree maintains metadata for each slot, in the `SlotMeta` struct containing:
+      * `slot_index` - The index of this slot
+      * `num_blocks` - The number of blocks in the slot (used for chaining to a previous slot)
+      * `consumed` - The highest blob index `n`, such that for all `m < n`, there exists a blob in this slot with blob index equal to `n` (i.e. the highest consecutive blob index).
+      * `received` - The highest received blob index for the slot
+      * `next_slots` - A list of future slots this slot could chain to. Used when rebuilding
+      the ledger to find possible fork points.
+      * `last_index` - The index of the blob that is flagged as the last blob for this slot. This flag on a blob will be set by the leader for a slot when they are transmitting the last blob for a slot.
+      * `is_rooted` - True iff every block from 0...slot forms a full sequence without any holes. We can derive is_rooted for each slot with the following rules. Let slot(n) be the slot with index `n`, and slot(n).is_full() is true if the slot with index `n` has all the ticks expected for that slot. Let is_rooted(n) be the statement that "the slot(n).is_rooted is true". Then:
+
+      is_rooted(0)
+      is_rooted(n+1) iff (is_rooted(n) and slot(n).is_full()
+
+3. Chaining - When a blob for a new slot `x` arrives, we check the number of blocks (`num_blocks`) for that new slot (this information is encoded in the blob). We then know that this new slot chains to slot `x - num_blocks`.
+
+4. Subscriptions - The Blocktree records a set of slots that have been "subscribed" to. This means entries that chain to these slots will be sent on the Blocktree channel for consumption by the ReplayStage. See the `Blocktree APIs` for details.
+
+5. Update notifications - The Blocktree notifies listeners when slot(n).is_rooted is flipped from false to true for any `n`.
+
+### Blocktree APIs
+
+The Blocktree offers a subscription based API that ReplayStage uses to ask for entries it's interested in. The entries will be sent on a channel exposed by the Blocktree. These subscription API's are as follows:
+   1. `fn get_slots_since(slot_indexes: &[u64]) -> Vec<SlotMeta>`: Returns new slots connecting to any element of the list `slot_indexes`.
+
+   2. `fn get_slot_entries(slot_index: u64, entry_start_index: usize, max_entries: Option<u64>) -> Vec<Entry>`: Returns the entry vector for the slot starting with `entry_start_index`, capping the result at `max` if `max_entries == Some(max)`, otherwise, no upper limit on the length of the return vector is imposed.
+
+Note: Cumulatively, this means that the replay stage will now have to know when a slot is finished, and subscribe to the next slot it's interested in to get the next set of entries. Previously, the burden of chaining slots fell on the Blocktree.
+
+### Interfacing with Bank
+
+The bank exposes to replay stage:
+
+ 1. `prev_hash`: which PoH chain it's working on as indicated by the hash of the last
+    entry it processed
+ 2. `tick_height`: the ticks in the PoH chain currently being verified by this
+    bank
+ 3. `votes`: a stack of records that contain:
+
+    1. `prev_hashes`: what anything after this vote must chain to in PoH
+    2. `tick_height`: the tick height at which this vote was cast
+    3. `lockout period`: how long a chain must be observed to be in the ledger to
+       be able to be chained below this vote
+
+Replay stage uses Blocktree APIs to find the longest chain of entries it can
+hang off a previous vote.  If that chain of entries does not hang off the
+latest vote, the replay stage rolls back the bank to that vote and replays the
+chain from there.
+
+### Pruning Blocktree
+
+Once Blocktree entries are old enough, representing all the possible forks
+becomes less useful, perhaps even problematic for replay upon restart.  Once a
+validator's votes have reached max lockout, however, any Blocktree contents
+that are not on the PoH chain for that vote for can be pruned, expunged.
+
+Replicator nodes will be responsible for storing really old ledger contents,
+and validators need only persist their bank periodically.

book/src/cluster-test-framework.md

@@ -0,0 +1,122 @@
+# Cluster Test Framework
+
+This document proposes the Cluster Test Framework (CTF).  CTF is a test harness
+that allows tests to execute against a local, in-process cluster or a
+deployed cluster.
+
+## Motivation
+
+The goal of CTF is to provide a framework for writing tests independent of where
+and how the cluster is deployed. Regressions can be captured in these tests and
+the tests can be run against deployed clusters to verify the deployment.  The
+focus of these tests should be on cluster stability, consensus, fault tolerance,
+API stability.
+
+Tests should verify a single bug or scenario, and should be written with the
+least amount of internal plumbing exposed to the test.
+
+## Design Overview
+
+Tests are provided an entry point, which is a `contact_info::ContactInfo`
+structure, and a keypair that has already been funded.
+
+Each node in the cluster is configured with a `fullnode::ValidatorConfig` at boot
+time.  At boot time this configuration specifies any extra cluster configuration
+required for the test. The cluster should boot with the configuration when it
+is run in-process or in a data center.
+
+Once booted, the test will discover the cluster through a gossip entry point and
+configure any runtime behaviors via fullnode RPC.
+
+## Test Interface
+
+Each CTF test starts with an opaque entry point and a funded keypair.  The test
+should not depend on how the cluster is deployed, and should be able to exercise
+all the cluster functionality through the publicly available interfaces.
+
+```rust,ignore
+use crate::contact_info::ContactInfo;
+use solana_sdk::signature::{Keypair, KeypairUtil};
+pub fn test_this_behavior(
+    entry_point_info: &ContactInfo,
+    funding_keypair: &Keypair,
+    num_nodes: usize,
+)
+```
+
+
+## Cluster Discovery
+
+At test start, the cluster has already been established and is fully connected.
+The test can discover most of the available nodes over a few second.
+
+```rust,ignore
+use crate::gossip_service::discover_nodes;
+
+// Discover the cluster over a few seconds.
+let cluster_nodes = discover_nodes(&entry_point_info, num_nodes);
+```
+
+## Cluster Configuration
+
+To enable specific scenarios, the cluster needs to be booted with special
+configurations.  These configurations can be captured in
+`fullnode::ValidatorConfig`.
+
+For example:
+
+```rust,ignore
+let mut validator_config = ValidatorConfig::default();
+validator_config.rpc_config.enable_fullnode_exit = true;
+let local = LocalCluster::new_with_config(
+                num_nodes,
+                10_000,
+                100,
+                &validator_config
+                );
+```
+
+## How to design a new test
+
+For example, there is a bug that shows that the cluster fails when it is flooded
+with invalid advertised gossip nodes.  Our gossip library and protocol may
+change, but the cluster still needs to stay resilient to floods of invalid
+advertised gossip nodes.
+
+Configure the RPC service:
+
+```rust,ignore
+let mut validator_config = ValidatorConfig::default();
+validator_config.rpc_config.enable_rpc_gossip_push = true;
+validator_config.rpc_config.enable_rpc_gossip_refresh_active_set = true;
+```
+
+Wire the RPCs and write a new test:
+
+```rust,ignore
+pub fn test_large_invalid_gossip_nodes(
+    entry_point_info: &ContactInfo,
+    funding_keypair: &Keypair,
+    num_nodes: usize,
+) {
+    let cluster = discover_nodes(&entry_point_info, num_nodes);
+
+    // Poison the cluster.
+    let client = create_client(entry_point_info.client_facing_addr(), FULLNODE_PORT_RANGE);
+    for _ in 0..(num_nodes * 100) {
+        client.gossip_push(
+            cluster_info::invalid_contact_info()
+        );
+    }
+    sleep(Durration::from_millis(1000));
+
+    // Force refresh of the active set.
+    for node in &cluster {
+        let client = create_client(node.client_facing_addr(), FULLNODE_PORT_RANGE);
+        client.gossip_refresh_active_set();
+    }
+
+    // Verify that spends still work.
+    verify_spends(&cluster);
+}
+```

book/src/cluster.md

@@ -28,7 +28,7 @@ its copy.
 
 ## Joining a Cluster
 
-Fullnodes and replicators enter the cluster via registration messages sent to
+Validators and replicators enter the cluster via registration messages sent to
 its *control plane*. The control plane is implemented using a *gossip*
 protocol, meaning that a node may register with any existing node, and expect
 its registration to propagate to all nodes in the cluster. The time it takes
@@ -96,4 +96,5 @@ that header information becomes the primary consumer of network bandwidth. At
 the time of this writing, the approach is scaling well up to about 150
 validators. To scale up to hundreds of thousands of validators, each node can
 apply the same technique as the leader node to another set of nodes of equal
-size. We call the technique *data plane fanout*, but it is not yet implemented.
+size. We call the technique *data plane fanout*; learn more in the [data plan
+fanout](data-plane-fanout.md) section.

book/src/credit-only-credit-debit-accounts.md

@@ -0,0 +1,140 @@
+# Credit-Only Accounts
+
+This design covers the handling of credit-only and credit-debit accounts in the
+[runtime](runtime.md).  Accounts already distinguish themselves as credit-only or
+credit-debit based on the program ID specified by the transaction's instruction.
+Programs must treat accounts that are not owned by them as credit-only.
+
+To identify credit-only accounts by program id would require the account to be
+fetched and loaded from disk.  This operation is expensive, and while it is
+occurring, the runtime would have to reject any transactions referencing the same
+account.
+
+The proposal introduces a `num_readonly_accounts` field to the transaction
+structure, and removes the `program_ids` dedicated vector for program accounts.
+
+This design doesn't change the runtime transaction processing rules.
+Programs still can't write or spend accounts that they do not own, but it
+allows the runtime to optimistically take the correct lock for each account
+specified in the transaction before loading the accounts from storage.
+
+Accounts selected as credit-debit by the transaction can still be treated as
+credit-only by the instructions.
+
+## Runtime handling
+
+credit-only accounts have the following properties:
+
+* Can be deposited into:  Deposits can be implemented as a simple `atomic_add`.
+* read-only access to account data.
+
+Instructions that debit or modify the credit-only account data will fail.
+
+## Account Lock Optimizations
+
+The Accounts module keeps track of current locked accounts in the runtime,
+which separates credit-only accounts from the credit-debit accounts.  The credit-only
+accounts can be cached in memory and shared between all the threads executing
+transactions.
+
+The current runtime can't predict whether an account is credit-only or credit-debit when
+the transaction account keys are locked at the start of the transaction
+processing pipeline.  Accounts referenced by the transaction have not been
+loaded from the disk yet.
+
+An ideal design would cache the credit-only accounts while they are referenced by
+any transaction moving through the runtime, and release the cache when the last
+transaction exits the runtime.
+
+## Credit-only accounts and read-only account data
+
+Credit-only account data can be treated as read-only. Credit-debit
+account data is treated as read-write.
+
+## Transaction changes
+
+To enable the possibility of caching accounts only while they are in the
+runtime, the Transaction structure should be changed in the following way:
+
+* `program_ids: Vec<Pubkey>` - This vector is removed.  Program keys can be
+placed at the end of the `account_keys` vector within the `num_readonly_accounts`
+number set to the number of programs.
+
+* `num_readonly_accounts: u8` - The number of keys from the **end** of the
+transaction's `account_keys` array that is credit-only.
+
+The following possible accounts are present in an transaction:
+
+* paying account
+* RW accounts
+* R accounts
+* Program IDs
+
+The paying account must be credit-debit, and program IDs must be credit-only.  The
+first account in the `account_keys` array is always the account that pays for
+the transaction fee, therefore it cannot be credit-only.  For these reasons the
+credit-only accounts are all grouped together at the end of the `account_keys`
+vector.  Counting credit-only accounts from the end allow for the default `0`
+value to still be functionally correct, since a transaction will succeed with
+all credit-debit accounts.
+
+Since accounts can only appear once in the transaction's `account_keys` array,
+an account can only be credit-only or credit-debit in a single transaction, not
+both.  The runtime treats a transaction as one atomic unit of execution. If any
+instruction needs credit-debit access to an account, a copy needs to be made. The
+write lock is held for the entire time the transaction is being processed by
+the runtime.
+
+## Starvation
+
+Read locks for credit-only accounts can keep the runtime from executing
+transactions requesting a write lock to a credit-debit account.
+
+When a request for a write lock is made while a read lock is open, the
+transaction requesting the write lock should be cached.  Upon closing the read
+lock, the pending transactions can be pushed through the runtime.
+
+While a pending write transaction exists, any additional read lock requests for
+that account should fail.  It follows that any other write lock requests will also 
+fail.  Currently, clients must retransmit when a transaction fails because of 
+a pending transaction.  This approach would mimic that behavior as closely as
+possible while preventing write starvation.
+
+## Program execution with credit-only accounts
+
+Before handing off the accounts to program execution, the runtime can mark each
+account in each instruction as a credit-only account.  The credit-only accounts can
+be passed as references without an extra copy.  The transaction will abort on a
+write to credit-only.
+
+An alternative is to detect writes to credit-only accounts and fail the
+transactions before commit.
+
+## Alternative design
+
+This design attempts to cache a credit-only account after loading without the use
+of a transaction-specified credit-only accounts list.  Instead, the credit-only
+accounts are held in a reference-counted table inside the runtime as the
+transactions are processed.
+
+1. Transaction accounts are locked.
+    a. If the account is present in the ‘credit-only' table, the TX does not fail.
+       The pending state for this TX is marked NeedReadLock.
+2. Transaction accounts are loaded.
+    a. Transaction accounts that are credit-only increase their reference
+       count in the `credit-only` table.
+    b. Transaction accounts that need a write lock and are present in the
+       `credit-only` table fail.
+3. Transaction accounts are unlocked.
+    a. Decrement the `credit-only` lock table reference count; remove if its 0
+    b. Remove from the `lock` set if the account is not in the `credit-only`
+       table.
+
+The downside with this approach is that if the `lock` set mutex is released
+between lock and load to allow better pipelining of transactions, a request for
+a credit-only account may fail. Therefore, this approach is not suitable for
+treating programs as credit-only accounts.
+
+Holding the accounts lock mutex while fetching the account from disk would
+potentially have a significant performance hit on the runtime. Fetching from
+disk is expected to be slow, but can be parallelized between multiple disks.

book/src/drones.md

@@ -10,7 +10,7 @@ client's account.
 A drone is a simple signing service. It listens for requests to sign
 *transaction data*.  Once received, the drone validates the request however it
 sees fit. It may, for example, only accept transaction data with a
-`SystemInstruction::Move` instruction transferring only up to a certain amount
+`SystemInstruction::Transfer` instruction transferring only up to a certain amount
 of tokens. If the drone accepts the transaction, it returns an `Ok(Signature)`
 where `Signature` is a signature of the transaction data using the drone's
 private key. If it rejects the transaction data, it returns a `DroneError`
@@ -46,7 +46,7 @@ desired cluster.
 
 ## Attack vectors
 
-### Invalid last_id
+### Invalid recent_blockhash
 
 The drone may prefer its airdrops only target a particular Solana cluster.  To
 do that, it listens to the cluster for new entry IDs and ensure any requests
@@ -68,15 +68,15 @@ A client may request multiple airdrops before the first has been submitted to
 the ledger. The client may do this maliciously or simply because it thinks the
 first request was dropped. The drone should not simply query the cluster to
 ensure the client has not already received an airdrop. Instead, it should use
-`last_id` to ensure the previous request is expired before signing another.
-Note that the Solana cluster will reject any transaction with a `last_id`
+`recent_blockhash` to ensure the previous request is expired before signing another.
+Note that the Solana cluster will reject any transaction with a `recent_blockhash`
 beyond a certain *age*.
 
 ### Denial of Service
 
 If the transaction data size is smaller than the size of the returned signature
 (or descriptive error), a single client can flood the network.  Considering
-that a simple `Move` operation requires two public keys (each 32 bytes) and a
+that a simple `Transfer` operation requires two public keys (each 32 bytes) and a
 `fee` field, and that the returned signature is 64 bytes (and a byte to
 indicate `Ok`), consideration for this attack may not be required.
 

book/src/ed_attack_vectors.md

@@ -0,0 +1,11 @@
+## Attack Vectors
+
+### Colluding validation and replication clients
+
+A colluding validation-client, may take the strategy to mark PoReps from non-colluding replicator nodes as invalid as an attempt to maximize the rewards for the colluding replicator nodes. In this case, it isn’t feasible for the offended-against replicator nodes to petition the network for resolution as this would result in a network-wide vote on each offending PoRep and create too much overhead for the network to progress adequately. Also, this mitigation attempt would still be vulnerable to a >= 51% staked colluder.
+
+Alternatively, transaction fees from submitted PoReps are pooled and distributed across validation-clients in proportion to the number of valid PoReps discounted by the number of invalid PoReps as voted by each validator-client. Thus invalid votes are directly dis-incentivized through this reward channel. Invalid votes that are revealed by replicator nodes as fishing PoReps, will not be discounted from the payout PoRep count.
+
+Another collusion attack involves a validator-client who may take the strategy to ignore invalid PoReps from colluding replicator and vote them as valid. In this case, colluding replicator-clients would not have to store the data while still receiving rewards for validated PoReps. Additionally, colluding validator nodes would also receive rewards for validating these PoReps. To mitigate this attack, validators must randomly sample PoReps corresponding to the ledger block they are validating and because of this, there will be multiple validators that will receive the colluding replicator’s invalid submissions. These non-colluding validators will be incentivized to mark these PoReps as invalid as they have no way to determine whether the proposed invalid PoRep is actually a fishing PoRep, for which a confirmation vote would result in the validator’s stake being slashed.
+
+In this case, the proportion of time a colluding pair will be successful has an upper limit determined by the % of stake of the network claimed by the colluding validator. This also sets bounds to the value of such an attack. For example, if a colluding validator controls 10% of the total validator stake, transaction fees will be lost (likely sent to mining pool) by the colluding replicator 90% of the time and so the attack vector is only profitable if the per-PoRep reward at least 90% higher than the average PoRep transaction fee. While, probabilistically, some colluding replicator-client PoReps will find their way to colluding validation-clients, the network can also monitor rates of paired (validator + replicator) discrepancies in voting patterns and censor identified colluders in these cases.

book/src/ed_economic_sustainability.md

@@ -0,0 +1,18 @@
+## Economic Sustainability
+
+Long term economic sustainability is one of the guiding principles of Solana’s economic design. While it is impossible to predict how decentralized economies will develop over time, especially economies with flexible decentralized governances, we can arrange economic components such that, under certain conditions, a sustainable economy may take shape in the long term. In the case of Solana’s network, these components take the form of the remittances and deposits into and out of the reserve ‘mining pool’.
+
+The dominant remittances from the Solana mining pool are validator and replicator rewards. The deposit mechanism is a flat, protocol-specified and adjusted, % of each transaction fee.
+
+The Replicator rewards are to be delivered to replicators from the mining pool after successful PoRep validation. The per-PoRep reward amount is determined as a function of the total network storage redundancy at the time of the PoRep validation and the network goal redundancy. This function is likely to take the form of a discount from a base reward to be delivered when the network has achieved and maintained its goal redundancy. An example of such a reward function is shown in **Figure 3**
+
+<!-- ![image alt text](porep_reward.png) -->
+<p style="text-align:center;"><img src="img/porep_reward.png" alt="==PoRep Reward Curve ==" width="800"/></p>
+
+**Figure 3**: Example PoRep reward design as a function of global network storage redundancy.
+
+In the example shown in Figure 1, multiple per PoRep base rewards are explored (as a % of Tx Fee) to be delivered when the global ledger replication redundancy meets 10X. When the global ledger replication redundancy is less than 10X, the base reward is discounted as a function of the square of the ratio of the actual ledger replication redundancy to the goal redundancy (i.e. 10X).
+
+The other protocol-based remittance goes to validation-clients as a reward distributed in proportion to stake-weight for voting to validate the ledger state. The functional issuance of this reward is described in [State-validation Protocol-based Rewards](ed_vce_state_validation_protocol_based_rewards.md) and is designed to reduce over time until validators are incentivized solely through collection of transaction fees. Therefore, in the long-run, protocol-based rewards to replication-nodes will be the only remittances from the mining pool, and will have to be countered by the portion of each non-PoRep transaction fee that is directed back into the mining pool. I.e. for a long-term self-sustaining economy, replicator-client rewards must be subsidized through a minimum fee on each non-PoRep transaction pre-allocated to the mining pool.  Through this constraint, we can write the following inequality:
+
+**== WIP [here](https://docs.google.com/document/d/1HBDasdkjS4Ja9wC_tIUsZPVcxGAWTuYOq9zf6xoQNps/edit?usp=sharing) ==**

book/src/ed_mvp.md

@@ -0,0 +1,12 @@
+## Proposed MVP of Economic Design
+
+The preceeding sections, outlined in the [Economic Design Overview](ed_overview.md), describe a long-term vision of a sustainable Solana economy. Of course, we don't expect the final implementation to perfectly match what has been described above. We intend to fully engage with network stakeholders throughout the implementation phases (i.e. pre-testnet, testnet, mainnet) to ensure the system supports, and is representative of, the various network participants' interests. The first step toward this goal, however, is outlining a some desired MVP economic features to be available for early pre-testnet and testnet participants. Below is a rough sketch outlining basic economic functionality from which a more complete and functional system can be developed.
+
+### MVP Economic Features
+
+* Faucet to deliver testnet SOLs to validators for staking and dapp development.
+* Mechanism by which validators are rewarded in proportion to their stake. Interest rate mechansism (i.e. to be determined by total % staked) to come later.
+* Ability to delegate tokens to validator nodes.
+* Replicators to receive fixed, arbitrary reward for submitting validated PoReps. Reward size mechanism (i.e. PoRep reward as a function of total ledger redundancy) to come later.
+* Pooling of replicator PoRep transaction fees and weighted distribution to validators based on PoRep verification (see [Replication-validation Transaction Fees](ed_vce_replication_validation_transaction_fees.md). It will be useful to test this protection against attacks on testnet.
+* Nice-to-have: auto-delegation of replicator rewards to validator.

book/src/ed_overview.md

@@ -0,0 +1,16 @@
+## Economic Design Overview
+
+Solana’s crypto-economic system is designed to promote a healthy, long term self-sustaining economy with participant incentives aligned to the security and decentralization of the network. The main participants in this economy are validation-clients and replication-clients. Their contributions to the network, state validation and data storage respectively, and their requisite remittance mechanisms are discussed below.
+
+The main channels of participant remittances are referred to as protocol-based rewards and transaction fees. Protocol-based rewards are protocol-derived issuances from a network-controlled reserve of tokens (sometimes referred to as the ‘mining pool’). These rewards will constitute the total reward delivered to replication clients and a portion of the total rewards for validation clients, the remaining sourced from transaction fees. In the early days of the network, it is likely that protocol-based rewards, deployed based on predefined issuance schedule, will drive the majority of participant incentives to join the network.
+
+These protocol-based rewards, to be distributed to participating validation and replication clients, are to be specified as annual interest rates calculated per, real-time, Solana epoch [DEFINITION]. As discussed further below, the issuance rates are determined as a function of total network validator staked percentage and total replication provided by replicators in each previous epoch. The choice for validator and replicator client rewards to be based on participation rates, rather than a global fixed inflation or interest rate, emphasizes a protocol priority of overall economic security, rather than monetary supply predictability. Due to Solana’s hard total supply cap of 1B tokens and the bounds of client participant rates in the protocol, we believe that global interest, and supply issuance, scenarios should be able to be modeled with reasonable uncertainties.
+
+Transaction fees are market-based participant-to-participant transfers, attached to network interactions as a necessary motivation and compensation for the inclusion and execution of a proposed transaction (be it a state execution or proof-of-replication verification). A mechanism for continuous and long-term funding of the mining pool through a pre-dedicated portion of transaction fees is also discussed below.
+
+A high-level schematic of Solana’s crypto-economic design is shown below in **Figure 1**. The specifics of validation-client economics are described in sections: [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) and [Replication-validation Transaction Fees](ed_vce_replication_validation_transaction_fees.md). Also, the chapter titled [Validation Stake Delegation](ed_vce_validation_stake_delegation.md) closes with a discussion of validator delegation opportunties and marketplace. The [Replication-client Economics](ed_replication_client_economics.md) chapter will review the Solana network design for global ledger storage/redundancy and replicator-client economics ([Storage-replication rewards](ed_rce_storage_replication_rewards.md)) along with a replicator-to-validator delegation mechanism designed to aide participant on-boarding into the Solana economy discussed in [Replication-client Reward Auto-delegation](ed_rce_replication_client_reward_auto_delegation.md). The [Economic Sustainability](ed_economic_sustainability.md) section dives deeper into Solana’s design for long-term economic sustainability and outlines the constraints and conditions for a self-sustaining economy. An outline of features for an MVP economic design is discussed in the [Economic Design MVP](ed_mvp.md) section. Finally, in chapter [Attack Vectors](ed_attack_vectors.md), various attack vectors will be described and potential vulnerabilities explored and parameterized.
+
+<!-- ![img alt text](solana_economic_design.png) -->
+<p style="text-align:center;"><img src="img/solana_economic_design.png" alt="== Solana Economic Design Diagram ==" width="800"/></p>
+
+**Figure 1**: Schematic overview of Solana economic incentive design.

book/src/ed_rce_replication_client_reward_auto_delegation.md

@@ -0,0 +1,5 @@
+### Replication-client Reward Auto-delegation
+
+The ability for Solana network participant’s to earn rewards by providing storage service is a unique on-boarding path that requires little hardware overhead and minimal upfront capital. It offers an avenue for individuals with extra-storage space on their home laptops or PCs to contribute to the security of the network and become integrated into the Solana economy.
+
+To enhance this on-boarding ramp and facilitate further participation and investment in the Solana economy, replication-clients have the opportunity to auto-delegate their rewards to validation-clients of their choice. Much like the automatic reinvestment of stock dividends, in this scenario, a replicator-client can earn Solana tokens by providing some storage capacity to the network (i.e. via submitting valid PoReps), have the protocol-based rewards automatically assigned as delegation to a staked validator node and therefore earning interest in the validation-client reward pool.

book/src/ed_rce_storage_replication_rewards.md

@@ -0,0 +1,5 @@
+### Storage-replication Rewards
+
+Replicator-clients download, encrypt and submit PoReps for ledger block sections.3  PoReps submitted to the PoH stream, and subsequently validated, function as evidence that the submitting replicator client is indeed storing the assigned ledger block sections on local hard drive space as a service to the network. Therefore, replicator clients should earn protocol rewards proportional to the amount of storage, and the number of successfully validated PoReps, that they are verifiably providing to the network.
+
+Additionally, replicator clients have the opportunity to capture a portion of slashed bounties [TBD] of dishonest validator clients. This can be accomplished by a replicator client submitting a verifiably false PoRep for which a dishonest validator client receives and signs as a valid PoRep. This reward incentive is to prevent lazy validators and minimize validator-replicator collusion attacks, more on this below.

book/src/ed_references.md

@@ -0,0 +1,7 @@
+## References
+
+1. [https://blog.ethereum.org/2016/07/27/inflation-transaction-fees-cryptocurrency-monetary-policy/](https://blog.ethereum.org/2016/07/27/inflation-transaction-fees-cryptocurrency-monetary-policy/)
+
+2. [https://medium.com/solana-labs/how-to-create-decentralized-storage-for-a-multi-petabyte-digital-ledger-2499a3a8c281](https://medium.com/solana-labs/how-to-create-decentralized-storage-for-a-multi-petabyte-digital-ledger-2499a3a8c281)
+
+3. [https://medium.com/solana-labs/how-to-create-decentralized-storage-for-a-multi-petabyte-digital-ledger-2499a3a8c281](https://medium.com/solana-labs/how-to-create-decentralized-storage-for-a-multi-petabyte-digital-ledger-2499a3a8c281)

book/src/ed_replication_client_economics.md

@@ -0,0 +1,3 @@
+## Replication-client economics
+
+Replication-clients should be rewarded for providing the network with storage space. Incentivization of the set of replicators provides data security through redundancy of the historical ledger. Replication nodes are rewarded in proportion to the amount of ledger data storage provided. These rewards are captured by generating and entering Proofs of Replication (PoReps) into the PoH stream which can be validated by Validation nodes as described above in the [Replication-validation Transaction Fees](ed_vce_replication_validation_transaction_fees.md) chapter.

book/src/ed_validation_client_economics.md

@@ -0,0 +1,3 @@
+## Validation-client Economics
+
+Validator-clients are eligible to receive protocol-based (i.e. via mining pool) rewards issued via stake-based annual interest rates by providing compute (CPU+GPU) resources to validate and vote on a given PoH state. These protocol-based rewards are determined through an algorithmic schedule as a function of total amount of Solana tokens staked in the system and duration since network launch (genesis block). Additionally, these clients may earn revenue through two types of transaction fees: state-validation transaction fees and pooled Proof-of-Replication (PoRep) transaction fees. The distribution of these two types of transaction fees to the participating validation set are designed independently as economic goals and attack vectors are unique between the state- generation/validation mechanism and the ledger replication/validation mechanism. For clarity, we separately describe the design and motivation of the three types of potential revenue streams for validation-clients below: state-validation protocol-based rewards, state-validation transaction fees and PoRep-validation transaction fees.

book/src/ed_vce_replication_validation_transaction_fees.md

@@ -0,0 +1,9 @@
+### Replication-validation Transaction Fees
+
+As previously mentioned, validator-clients will also be responsible for validating PoReps submitted into the PoH stream by replicator-clients. In this case, validators are providing compute (CPU/GPU) and light storage resources to confirm that these replication proofs could only be generated by a client that is storing the referenced PoH leger block.2
+
+While replication-clients are incentivized and rewarded through protocol-based rewards schedule (see [Replication-client Economics](ed_replication_client_economics.md)), validator-clients will be incentivized to include and validate PoReps in PoH through the distribution of the transaction fees associated with the submitted PoRep. As will be described in detail in the Section 3.1, replication-client rewards are protocol-based and designed to reward based on a global data redundancy factor. I.e. the protocol will incentivize replication-client participation through rewards based on a target ledger redundancy (e.g. 10x data redundancy). It was chosen not to include a distribution of these rewards to PoRep validators, and to rely only on the collection of PoRep attached transaction fees, due to the fact that the confluence of two participation incentive modes (state-validation inflation rate via global staked % and replication-validation rewards based on global redundancy factor) on the incentives of a single network participant (a validator-client) potentially opened up a significant incentive-driven attack surface area.
+
+The validation of PoReps by validation-clients is computationally more expensive than state-validation (detail in the [Economic Sustainability](ed_economic_sustainability.md) chapter), thus the transaction fees are expected to be proportionally higher. However, because replication-client rewards are distributed in proportion to and only after submitted PoReps are validated, they are uniquely motivated for the inclusion and validation of their proofs. This pressure is expected to generate an adequate market economy between replication-clients and validation-clients. Additionally, transaction fees submitted with PoReps have no minimum amount pre-allocated to the mining pool, as do state-validation transaction fees.
+
+There are various attack vectors available for colluding validation and replication clients, as described in detail below in [Economic Sustainability](ed_economic_sustainability). To protect against various collusion attack vectors, for a given epoch, PoRep transaction fees are pooled, and redistributed across participating validation-clients in proportion to the number of validated PoReps in the epoch less the number of invalidated PoReps [DIAGRAM]. This design rewards validators proportional to the number of PoReps they process and validate, while providing negative pressure for validation-clients to submit lazy or malicious invalid votes on submitted PoReps (note that it is computationally prohibitive to determine whether a validator-client has marked a valid PoRep as invalid).

book/src/ed_vce_state_validation_protocol_based_rewards.md

@@ -0,0 +1,46 @@
+### State-validation protocol-based rewards
+
+Validator-clients have two functional roles in the Solana network
+
+* Validate (vote) the current global state of that PoH along with any Proofs-of-Replication (see [Replication Client Economics](ed_replication_client_economics.md)) that they are eligible to validate
+
+* Be elected as ‘leader’ on a stake-weighted round-robin schedule during which time they are responsible for collecting outstanding transactions and Proofs-of-Replication and incorporating them into the PoH, thus updating the global state of the network and providing chain continuity.
+
+Validator-client rewards for these services are to be distributed at the end of each Solana epoch. Compensation for validator-clients is provided via a protocol-based annual interest rate dispersed in proportion to the stake-weight of each validator (see below) along with leader-claimed transaction fees available during each leader rotation. I.e. during the time a given validator-client is elected as leader, it has the opportunity to keep a portion of each non-PoRep transaction fee, less a protocol-specified amount that is returned to the mining pool (see [Validation-client State Transaction Fees](ed_vce_state_validation_transaction_fees.md)). PoRep transaction fees are not collected directly by the leader client but pooled and returned to the validator set in proportion to the number of successfully validated PoReps. (see [Replication-client Transaction Fees](ed_vce_replication_validation_transaction_fees.md))
+
+
+The protocol-based annual interest-rate (%) per epoch to be distributed to validation-clients is to be a function of:
+
+* the current fraction of staked SOLs out of the current total circulating supply,
+
+* the global time since the genesis block instantiation
+
+* the up-time/participation [% of available slots/blocks that validator had opportunity to vote on?] of a given validator over the previous epoch.
+
+The first two factors are protocol parameters only (i.e. independent of validator behavior in a given epoch) and describe a global validation reward schedule designed to both incentivize early participation and optimal security in the network. This schedule sets a maximum annual validator-client interest rate per epoch.
+
+At any given point in time, this interest rate is pegged to a defined value given a specific % staked SOL out of the circulating supply (e.g. 10% interest rate when 66% of circulating SOL is staked). The interest rate adjusts as the square-root [TBD] of the % staked, leading to higher validation-client interest rates as the % staked drops below the targeted goal, thus incentivizing more participation leading to more security in the network. An example of such a schedule, for a specified point in time (e.g. network launch) is shown in **Table 1**.
+
+| Percentage circulating supply staked [%] | Annual validator-client interest rate [%] |
+| ---:    | ---:      |
+| 5       | 13.87     |
+| 15      | 13.31     |
+| 25      | 12.73     |
+| 35      | 12.12     |
+| 45      | 11.48     |
+| 55      | 10.80     |
+| **66**  | **10.00** |
+| 75      | 9.29      |
+| 85      | 8.44      |    
+
+**Table 1:** Example interest rate schedule based on % SOL staked out of circulating supply. In this case, interest rates are fixed at 10% for 66% of staked circulating supply
+
+Over time, the interest rate, at any network staked percentage, will drop as described by an algorithmic schedule. Validation-client interest rates are designed to be higher in the early days of the network to incentivize participation and jumpstart the network economy. This mining-pool provided interest rate will reduce over time until a network-chosen baseline value is reached. This is a fixed, long-term, interest rate to be provided to validator-clients. This value does not represent the total interest available to validator-clients as transaction fees for both state-validation and ledger storage replication (PoReps) are not accounted for here. A validation-client interest rate schedule as a function of % network staked and time is shown in** Figure 2**.
+
+<!-- ![== Validation Client Interest Rates Figure ==](validation_client_interest_rates.png =250x) -->
+
+<p style="text-align:center;"><img src="img/validation_client_interest_rates.png" alt="drawing" width="800"/></p>
+
+**Figure 2:** In this example schedule, the annual interest rate [%] reduces at around 16.7% per year, until it reaches the long-term, fixed, 4% rate.
+
+This epoch-specific protocol-defined interest rate sets an upper limit of *protocol-generated* annual interest rate (not absolute total interest rate) possible to be delivered to any validator-client per epoch. The distributed interest rate per epoch is then discounted from this value based on the participation of the validator-client during the previous epoch. Each epoch is comprised of XXX slots. The protocol-defined interest rate is then discounted by the log [TBD] of the % of slots a given validator submitted a vote on a PoH branch during that epoch, see **Figure XX**

book/src/ed_vce_state_validation_transaction_fees.md

@@ -0,0 +1,20 @@
+### State-validation Transaction Fees
+
+Each message sent through the network, to be processed by the current leader validation-client and confirmed as a global state transaction, must contain a transaction fee. Transaction fees offer many benefits in the Solana economic design, for example they:
+
+* provide unit compensation to the validator network for the CPU/GPU resources necessary to process the state transaction,
+
+* reduce network spam by introducing real cost to transactions,
+
+* open avenues for a transaction market to incentivize validation-client to collect and process submitted transactions in their function as leader,
+
+* and provide potential long-term economic stability of the network through a protocol-captured minimum fee amount per transaction, as described below.
+
+Many current blockchain economies (e.g. Bitcoin, Ethereum), rely on protocol-based rewards to support the economy in the short term, with the assumption that the revenue generated through transaction fees will support the economy in the long term, when the protocol derived rewards expire. In an attempt to create a sustainable economy through protocol-based rewards and transaction fees, a fixed portion of each transaction fee is sent to the mining pool, with the resulting fee going to the current leader processing the transaction. These pooled fees, then re-enter the system through rewards distributed to validation-clients, through the process described above, and replication-clients, as discussed below.
+
+The intent of this design is to retain leader incentive to include as many transactions as possible within the leader-slot time, while providing a redistribution avenue that protects against "tax evasion" attacks (i.e. side-channel fee payments)<sup>[1](ed_referenced.md)</sup>. Constraints on the fixed portion of transaction fees going to the mining pool, to establish long-term economic sustainability, are established and discussed in detail in the [Economic Sustainability](ed_economic_sustainability.md) section.
+
+This minimum, protocol-earmarked, portion of each transaction fee can be dynamically adjusted depending on historical gas usage. In this way, the protocol can use the minimum fee to target a desired hardware utilisation. By monitoring a protocol specified gas usage with respect to a desired, target usage amount (e.g. 50% of a block's capacity), the minimum fee can be raised/lowered which should, in turn, lower/raise the actual gas usage per block until it reaches the target amount. This adjustment process can be thought of as similar to the difficulty adjustment algorithm in the Bitcoin protocol, however in this case it is adjusting the minimum transaction fee to guide the transaction processing hardware usage to a desired level.
+
+Additionally, the minimum protocol captured fee can be a consideration in fork selection. In the case of a PoH fork with a  malicious, censoring leader, we would expect the total procotol captured fee to be less than a comparable honest fork, due to the fees lost from censoring. If the censoring leader is to compensate for these lost protocol fees, they would have to replace the fees on their fork themselves, thus potentially reducing the incentive to censor in the first place. 
+

book/src/ed_vce_validation_stake_delegation.md

@@ -0,0 +1,29 @@
+### Validation Stake Delegation
+
+Running a Solana validation-client required relatively modest upfront hardware capital investment. **Table 2** provides an example hardware configuration to support ~1M tx/s with estimated ‘off-the-shelf’ costs:
+
+|Component|Example|Estimated Cost|
+|--- |--- |--- |
+|GPU|2x 2080 Ti|$2500|
+|or|4x 1080 Ti|$2800|
+|OS/Ledger Storage|Samsung 860 Evo 2TB|$370|
+|Accounts storage|2x Samsung 970 Pro M.2 512GB|$340|
+|RAM|32 Gb|$300|
+|Motherboard|AMD x399|$400|
+|CPU|AMD Threadripper 2920x|$650|
+|Case||$100|
+|Power supply|EVGA 1600W|$300|
+|Network|> 500 mbps||
+|Network (1)|Google webpass business bay area 1gbps unlimited|$5500/mo|
+|Network (2)|Hurricane Electric bay area colo 1gbps|$500/mo|
+**Table 2** example high-end hardware setup for running a Solana client.
+
+Despite the low-barrier to entry as a validation-client, from a capital investment perspective, as in any developing economy, there will be much opportunity and need for trusted validation services as evidenced by node reliability, UX/UI, APIs and other software accessibility tools. Additionally, although Solana’s validator node startup costs are nominal when compared to similar networks, they may still be somewhat restrictive for some potential participants. In the spirit of developing a true decentralized, permissionless network, these interested parties still have two options to become involved in the Solana network/economy:
+
+1. Delegation of previously acquired tokens with a reliable validation node to earn a portion of interest generated
+
+2. Provide local storage space as a replication-client and receive rewards by submitting Proof-of-Replication (see [Replication-client Economics](ed_replication_client_economics.md)).
+
+    a. This participant has the additional option to directly delegate their earned storage rewards ([Replication-client Reward Auto-delegation](ed_rce_replication_client_reward_auto_delegation.md))
+
+Delegation of tokens to validation-clients, via option 1, provides a way for passive Solana token holders to become part of the active Solana economy and earn interest rates proportional to the interest rate generated by the delegated validation-client. Additionally, this feature creates a healthy validation-client market, with potential validation-client nodes competing to build reliable, transparent and profitable delegation services.

book/src/entry-tree.md

@@ -1,121 +0,0 @@
-# Entry Tree
-
-This document proposes a change to ledger and window to support Solana's [fork
-generation](fork-generation.md) behavior.
-
-## Current Design
-
-### Functionality of Window And Ledger
-
-The basic responsibilities of the window and the ledger in a Solana fullnode
-are:
-
- 1. Window: serve as a temporary, RAM-backed store of blobs of the PoH chain
-    for re-ordering and assembly into contiguous blocks to be sent to the bank
-    for verification.
- 2. Window: serve as a RAM-backed repair facility for other validator nodes,
-    which may query the network for as-yet unreceived blobs.
- 3. Ledger: provide disk-based storage of the PoH chain in case of node
-    restart.
- 4. Ledger: provide disk-backed repair facility for when the (smaller)
-    RAM-backed window doesn't cover the repair request.
-
-The window is at the front of a validator node's processing pipeline, blobs are
-received, cached, re-ordered before being deserialized into Entries, passed to
-the bank for verification, and finally on to the ledger, which is at the back
-of a validator node's pipeline.
-
-The window holds blobs (the over-the-air format, serialized Entries,
-one-per-blob).  The ledger holds serialized Entries without any blob
-information.
-
-### Limitations
-
-#### One-dimensional key space
-
-The window and the ledger are indexed by ledger height, which is number of
-Entries ever generated in the PoH chain until the current blob.  This
-limitation prevents the window and the ledger from storing the overlapping
-histories possible in Solana's consensus protocol.
-
-#### Limited caching
-
-The window is a circular buffer.  It cannot accept blobs that are farther in
-the future than the window is currently working.  If a blob arrives that is too
-far ahead, it is dropped and will subsequently need to be repaired, incurring
-further delay for the node.
-
-#### Loss of blob signatures
-
-Because the blob signatures are stripped before being stored by the ledger,
-repair requests served from the ledger can't be verified to the original
-leader.
-
-#### Rollback and checkpoint, switching forks, separate functions
-
-The window and the ledger can't handle replay of alternate forks.  Once a Blob
-has passed through the window, it's in the past.  The replay stage of a
-validator will need to roll back to a previous checkpoint and decode an
-alternate set of Blobs to the Bank.  The separated and one-way nature of window
-and ledger makes this hard.
-
-## New Design
-
-A unified window and ledger allows a validator to record every blob it observes
-on the network, in any order, as long as the blob is consistent with the
-network's leader schedule.
-
-Blobs are moved to a fork-able key space the tuple of `leader slot` + `blob
-index` (within the slot).  This permits the skip-list structure of the Solana
-protocol to be stored in its entirety, without a-priori choosing which fork to
-follow, which Entries to persist or when to persist them.
-
-Repair requests for recent blobs are served out of RAM or recent files and out
-of deeper storage for less recent blobs, as implemented by the store backing
-EntryTree.
-
-### Functionalities of EntryTree
-
-1. Persistence: the EntryTree lives in the front of the nodes verification
-   pipeline, right behind network receive and signature verification.  If the
-blob received is consistent with the leader schedule (i.e. was signed by the
-leader for the indicated slot), it is immediately stored.
-2. Repair: repair is the same as window repair above, but able to serve any
-   blob that's been received. EntryTree stores blobs with signatures,
-preserving the chain of origination.
-3. Forks: EntryTree supports random access of blobs, so can support a
-   validator's need to rollback and replay from a Bank checkpoint.
-4. Restart: with proper pruning/culling, the EntryTree can be replayed by
-   ordered enumeration of entries from slot 0.  The logic of the replay stage
-(i.e. dealing with forks) will have to be used for the most recent entries in
-the EntryTree.
-
-### Interfacing with Bank
-
-The bank exposes to replay stage:
-
- 1. prev_id: which PoH chain it's working on as indicated by the id of the last
-    entry it processed
- 2. tick_height: the ticks in the PoH chain currently being verified by this
-    bank
- 3. votes: a stack of records that contain
-
-    1. prev_ids: what anything after this vote must chain to in PoH
-    2. tick height: the tick_height at which this vote was cast
-    3. lockout period: how long a chain must be observed to be in the ledger to
-       be able to be chained below this vote
-
-Replay stage uses EntryTree APIs to find the longest chain of entries it can
-hang off a previous vote.  If that chain of entries does not hang off the
-latest vote, the replay stage rolls back the bank to that vote and replays the
-chain from there.
-
-### Pruning EntryTree
-
-Once EntryTree entries are old enough, representing all the possible forks
-becomes less useful, perhaps even problematic for replay upon restart.  Once a
-validator's votes have reached max lockout, however, any EntryTree contents
-that are not on the PoH chain for that vote for can be pruned, expunged.
-
-Replicator nodes will be responsible for storing really old ledger contents,
-and validators need only persist their bank periodically.

book/src/fork-generation.md

@@ -59,9 +59,11 @@ Validators vote based on a greedy choice to maximize their reward described in
 
 ### Validator's View
 
-#### Time Progression The diagram below represents a validator's view of the
-PoH stream with possible forks over time.  L1, L2, etc. are leader slot, and
-`E`s represent entries from that leader during that leader's slot.  The 'x's
+#### Time Progression
+
+The diagram below represents a validator's view of the
+PoH stream with possible forks over time.  L1, L2, etc. are leader slots, and
+`E`s represent entries from that leader during that leader's slot.  The `x`s
 represent ticks only, and time flows downwards in the diagram.
 
 

book/src/fork-selection.md

@@ -1,53 +1,75 @@
 # Fork Selection
-This article describes Solana's *Nakomoto Fork Selection* algorithm based on time
-locks. It satisfies the following properties:
 
+This design describes a *Fork Selection* algorithm. It addresses the following
+problems:
 
-* A voter can eventually recover from voting on a fork that doesn't become the
-  fork with the desired network finality.
-* If the voters share a common ancestor then they will converge to a fork
-  containing that ancestor no matter how they are partitioned. The converged
-  ancestor may not be the latest possible ancestor at the start of the fork.
-* Rollback requires exponentially more time for older votes than for newer
-  votes.
-* Voters have the freedom to set a minimum network confirmation threshold
-  before committing a vote to a higher lockout.  This allows each voter to make
-  a trade-off between risk and reward. See [cost of rollback](#cost-of-rollback).
+* Some forks may not end up accepted by the super-majority of the cluster, and
+voters need to recover from voting on such forks.
+
+* Many forks may be votable by different voters, and each voter may see a
+different set of votable forks.  The selected forks should eventually converge
+for the cluster.
+
+* Reward based votes have an associated risk.  Voters should have the ability to
+configure how much risk they take on.
+
+* The [cost of rollback](#cost-of-rollback) needs to be computable.  It is
+important to clients that rely on some measurable form of Consistency.  The
+costs to break consistency need to be computable, and increase super-linearly
+for older votes.
+
+* ASIC speeds are different between nodes, and attackers could employ Proof of
+History ASICS that are much faster than the rest of the cluster.  Consensus
+needs to be resistant to attacks that exploit the variability in Proof of
+History ASIC speed.
+
+For brevity this design assumes that a single voter with a stake is deployed as
+an individual validator in the cluster.
 
 ## Time
 
-For networks like Solana, time can be the PoH hash count, which is a VDF that
-provides a source of time before consensus. Other networks adopting this
-approach would need to consider a global source of time.
+The Solana cluster generates a source of time via a Verifiable Delay Function we
+are calling [Proof of History](book/src/synchronization.md).
 
-For Solana, time uniquely identifies a specific leader for fork generation.  At
-any given time only 1 leader, which can be computed from the ledger itself, can
-propose a fork.  For more details, see [fork generation](fork-generation.md)
-and [leader rotation](leader-rotation.md).
+Proof of History is used to create a deterministic round robin schedule for all
+the active leaders.  At any given time only 1 leader, which can be computed from
+the ledger itself, can propose a fork.  For more details, see [fork
+generation](fork-generation.md) and [leader rotation](leader-rotation.md).
+
+## Lockouts
+
+The purpose of the lockout is to force a validator to commit opportunity cost to
+a specific fork.  Lockouts are measured in slots, and therefor represent a
+real-time forced delay that a validator needs to wait before breaking the
+commitment to a fork.
+
+Validators that violate the lockouts and vote for a diverging fork within the
+lockout should be punished. The proposed punishment is to slash the validator
+stake if a concurrent vote within a lockout for a non-descendant fork can be
+proven to the cluster.
 
 ## Algorithm
 
-The basic idea to this approach is to stack consensus votes.  Each vote in the
-stack is a confirmation of a fork.  Each confirmed fork is an ancestor of the
-fork above it.  Each consensus vote has a `lockout` in units of time before the
-validator can submit a vote that does not contain the confirmed fork as an
-ancestor.
+The basic idea to this approach is to stack consensus votes and double lockouts.
+Each vote in the stack is a confirmation of a fork.  Each confirmed fork is an
+ancestor of the fork above it.  Each vote has a `lockout` in units of slots
+before the validator can submit a vote that does not contain the confirmed fork
+as an ancestor.
 
-When a vote is added to the stack, the lockouts of all the previous votes in
-the stack are doubled (more on this in [Rollback](#Rollback)).  With each new
-vote, a voter commits the previous votes to an ever-increasing lockout.  At 32
+When a vote is added to the stack, the lockouts of all the previous votes in the
+stack are doubled (more on this in [Rollback](#Rollback)).  With each new vote,
+a validator commits the previous votes to an ever-increasing lockout.  At 32
 votes we can consider the vote to be at `max lockout` any votes with a lockout
 equal to or above `1<<32` are dequeued (FIFO).  Dequeuing a vote is the trigger
 for a reward.  If a vote expires before it is dequeued, it and all the votes
-above it are popped (LIFO) from the vote stack.  The voter needs to start
+above it are popped (LIFO) from the vote stack.  The validator needs to start
 rebuilding the stack from that point.
 
-
 ### Rollback
 
 Before a vote is pushed to the stack, all the votes leading up to vote with a
 lower lock time than the new vote are popped.  After rollback lockouts are not
-doubled until the voter catches up to the rollback height of votes.
+doubled until the validator catches up to the rollback height of votes.
 
 For example, a vote stack with the following state:
 
@@ -89,67 +111,123 @@ votes.
 
 ### Slashing and Rewards
 
-The purpose of the lockout is to force a voter to commit opportunity cost to a
-specific fork.  Voters that violate the lockouts and vote for a diverging fork
-within the lockout should be punished.  Slashing or simply freezing the voter
-from rewards for a long period of time can be used as punishment.
-
-Voters should be rewarded for selecting the fork that the rest of the network
-selected as often as possible.  This is well-aligned with generating a reward
-when the vote stack is full and the oldest vote needs to be dequeued.  Thus a
-reward should be generated for each successful dequeue.
+Validators should be rewarded for selecting the fork that the rest of the
+cluster selected as often as possible.  This is well-aligned with generating a
+reward when the vote stack is full and the oldest vote needs to be dequeued.
+Thus a reward should be generated for each successful dequeue.
 
 ### Cost of Rollback
 
 Cost of rollback of *fork A* is defined as the cost in terms of lockout time to
-the validators to confirm any other fork that does not include *fork A* as an
+the validator to confirm any other fork that does not include *fork A* as an
 ancestor.
 
 The **Economic Finality** of *fork A* can be calculated as the loss of all the
-rewards from rollback of *fork A* and its descendants, plus the opportunity
-cost of reward due to the exponentially growing lockout of the votes that have
+rewards from rollback of *fork A* and its descendants, plus the opportunity cost
+of reward due to the exponentially growing lockout of the votes that have
 confirmed *fork A*.
 
 ### Thresholds
 
-Each voter can independently set a threshold of network commitment to a fork
-before that voter commits to a fork.  For example, at vote stack index 7, the
-lockout is 256 time units.  A voter may withhold votes and let votes 0-7 expire
-unless the vote at index 7 has at greater than 50% commitment in the network.
-This allows each voter to independently control how much risk to commit to a
-fork.  Committing to forks at a higher frequency would allow the voter to earn
-more rewards.
+Each validator can independently set a threshold of cluster commitment to a fork
+before that validator commits to a fork.  For example, at vote stack index 7,
+the lockout is 256 time units.  A validator may withhold votes and let votes 0-7
+expire unless the vote at index 7 has at greater than 50% commitment in the
+cluster.  This allows each validator to independently control how much risk to
+commit to a fork.  Committing to forks at a higher frequency would allow the
+validator to earn more rewards.
 
 ### Algorithm parameters
 
-These parameters need to be tuned.
+The following parameters need to be tuned:
 
 * Number of votes in the stack before dequeue occurs (32).
+
 * Rate of growth for lockouts in the stack (2x).
+
 * Starting default lockout (2).
-* Threshold depth for minimum network commitment before committing to the fork
-  (8).
-* Minimum network commitment size at threshold depth (50%+).
+
+* Threshold depth for minimum cluster commitment before committing to the fork
+(8).
+
+* Minimum cluster commitment size at threshold depth (50%+).
 
 ### Free Choice
 
-A "Free Choice" is an unenforcible voter action.  A voter that maximizes
-self-reward over all possible futures should behave in such a way that the
-system is stable, and the local greedy choice should result in a greedy choice
-over all possible futures.  A set of voter that are engaging in choices to
-disrupt the protocol should be bound by their stake weight to the denial of
-service.  Two options exits for voter:
+A "Free Choice" is an unenforcible validator action.  There is no way for the
+protocol to encode and enforce these actions since each validator can modify the
+code and adjust the algorithm.  A validator that maximizes self-reward over all
+possible futures should behave in such a way that the system is stable, and the
+local greedy choice should result in a greedy choice over all possible futures.
+A set of validator that are engaging in choices to disrupt the protocol should
+be bound by their stake weight to the denial of service.  Two options exits for
+validator:
 
-* a voter can outrun previous voters in virtual generation and submit a
+* a validator can outrun previous validator in virtual generation and submit a
   concurrent fork
-* a voter can withhold a vote to observe multiple forks before voting
 
-In both cases, the voters in the network have several forks to pick from
+* a validator can withhold a vote to observe multiple forks before voting
+
+In both cases, the validator in the cluster have several forks to pick from
 concurrently, even though each fork represents a different height.  In both
-cases it is impossible for the protocol to detect if the voter behavior is
+cases it is impossible for the protocol to detect if the validator behavior is
 intentional or not.
 
 ### Greedy Choice for Concurrent Forks
 
-When evaluating multiple forks, each voter should pick the fork that will
-maximize economic finality for the network, or the latest fork if all are equal.
+When evaluating multiple forks, each validator should use the following rules:
+
+1. Forks must satisfy the *Threshold* rule.
+
+2. Pick the fork that maximizes the total cluster lockout time for all the
+ancestor forks.
+
+3. Pick the fork that has the greatest amount of cluster transaction fees.
+
+4. Pick the latest fork in terms of PoH.
+
+Cluster transaction fees are fees that are deposited to the mining pool as
+described in the [Staking Rewards](book/src/staking-rewards.md) section.
+
+## PoH ASIC Resistance
+
+Votes and lockouts grow exponentially while ASIC speed up is linear.  There are
+two possible attack vectors involving a faster ASIC.
+
+### ASIC censorship
+
+An attacker generates a concurrent fork that outruns previous leaders in an
+effort to censor them. A fork proposed by this attacker will be available
+concurrently with the next available leader.  For nodes to pick this fork it
+must satisfy the *Greedy Choice* rule.
+
+1. Fork must have equal number of votes for the ancestor fork.
+
+2. Fork cannot be so far a head as to cause expired votes.
+
+3. Fork must have a greater amount of cluster transaction fees.
+
+This attack is then limited to censoring the previous leaders fees, and
+individual transactions.  But it cannot halt the cluster, or reduce the
+validator set compared to the concurrent fork.  Fee censorship is limited to
+access fees going to the leaders but not the validators.
+
+### ASIC Rollback
+
+An attacker generates a concurrent fork from an older block to try to rollback
+the cluster.  In this attack the concurrent fork is competing with forks that
+have already been voted on.  This attack is limited by the exponential growth of
+the lockouts.
+
+* 1 vote has a lockout of 2 slots.  Concurrent fork must be at least 2 slots
+ahead, and be produced in 1 slot. Therefore requires an ASIC 2x faster.
+
+* 2 votes have a lockout of 4 slots.  Concurrent fork must be at least 4 slots
+ahead and produced in 2 slots. Therefore requires an ASIC 2x faster.
+
+* 3 votes have a lockout of 8 slots.  Concurrent fork must be at least 8 slots
+ahead and produced in 3 slots. Therefore requires an ASIC 2.6x faster.
+
+* 10 votes have a lockout of 1024 slots.  1024/10, or 102.4x faster ASIC.
+
+* 20 votes have a lockout of 2^20 slots.  2^20/20, or 52,428.8x faster ASIC.

book/src/getting-started.md

@@ -41,8 +41,14 @@ $ git checkout $TAG
 
 ### Configuration Setup
 
-The network is initialized with a genesis ledger and fullnode configuration files.
-These files can be generated by running the following script.
+Ensure important programs such as the vote program are built before any
+nodes are started
+```bash
+$ cargo build --all
+```
+
+The network is initialized with a genesis ledger generated by running the
+following script.
 
 ```bash
 $ ./multinode-demo/setup.sh
@@ -63,7 +69,7 @@ $ ./multinode-demo/drone.sh
 
 ### Singlenode Testnet
 
-Before you start a fullnode, make sure you know the IP address of the machine you
+Before you start a validator, make sure you know the IP address of the machine you
 want to be the bootstrap leader for the demo, and make sure that udp ports 8000-10000 are
 open on all the machines you want to test with.
 
@@ -80,10 +86,10 @@ The drone does not need to be running for subsequent leader starts.
 ### Multinode Testnet
 
 To run a multinode testnet, after starting a leader node, spin up some
-additional full nodes in separate shells:
+additional validators in separate shells:
 
 ```bash
-$ ./multinode-demo/fullnode-x.sh
+$ ./multinode-demo/validator-x.sh
 ```
 
 To run a performance-enhanced full node on Linux,
@@ -93,7 +99,7 @@ your system:
 ```bash
 $ ./fetch-perf-libs.sh
 $ SOLANA_CUDA=1 ./multinode-demo/bootstrap-leader.sh
-$ SOLANA_CUDA=1 ./multinode-demo/fullnode-x.sh
+$ SOLANA_CUDA=1 ./multinode-demo/validator.sh
 ```
 
 ### Testnet Client Demo
@@ -139,7 +145,7 @@ Generally we are using `debug` for infrequent debug messages, `trace` for potent
 messages and `info` for performance-related logging.
 
 You can also attach to a running process with GDB.  The leader's process is named
-_solana-fullnode_:
+_solana-validator_:
 
 ```bash
 $ sudo gdb
@@ -155,100 +161,8 @@ This will dump all the threads stack traces into gdb.txt
 In this example the client connects to our public testnet. To run validators on the testnet you would need to open udp ports `8000-10000`.
 
 ```bash
-$ ./multinode-demo/client.sh --network $(dig +short testnet.solana.com):8001 --duration 60
+$ ./multinode-demo/client.sh --entrypoint testnet.solana.com:8001 --drone testnet.solana.com:9900 --duration 60 --tx_count 50
 ```
 
 You can observe the effects of your client's transactions on our [dashboard](https://metrics.solana.com:3000/d/testnet/testnet-hud?orgId=2&from=now-30m&to=now&refresh=5s&var-testnet=testnet)
 
-## Linux Snap
-
-A Linux [Snap](https://snapcraft.io/) is available, which can be used to easily
-get Solana running on supported Linux systems without building anything from
-source for evaluation.  Note that CUDA is not supported by the Snap so
-performance will be limited.
-
-The `edge` Snap channel is updated daily with the latest
-development from the `master` branch.  To install:
-
-```bash
-$ sudo snap install solana --edge --devmode
-```
-
-Once installed the usual Solana programs will be available as `solona.*` instead
-of `solana-*`.  For example, `solana.fullnode` instead of `solana-fullnode`.
-
-Update to the latest version at any time with:
-
-```bash
-$ snap info solana
-$ sudo snap refresh solana --devmode
-```
-
-### Daemon Support
-The snap supports running fullnodes and a drone as system daemons.
-
-Run `sudo snap get solana` to view the current daemon configuration.  To view
-daemon logs:
-1. Run `sudo snap logs -n=all solana` to view the daemon initialization log
-2. Runtime logging can be found under `/var/snap/solana/current/bootstrap-leader/`,
-`/var/snap/solana/current/fullnode/`, or `/var/snap/solana/current/drone/` depending
-on which `mode=` was selected.  Within each log directory the file `current`
-contains the latest log, and the files `*.s` (if present) contain older rotated
-logs.
-
-Disable the daemon at any time by running:
-
-```bash
-$ sudo snap set solana mode=
-```
-
-Runtime configuration files for the daemon can be found in
-`/var/snap/solana/current/config`.
-
-#### Leader Daemon
-
-```bash
-$ sudo snap set solana mode=bootstrap-leader
-```
-
-`rsync` must be configured and running on the leader.
-
-1. Ensure rsync is installed with `sudo apt-get -y install rsync`
-2. Edit `/etc/rsyncd.conf` to include the following
-```ini
-[config]
-path = /var/snap/solana/current/config
-hosts allow = *
-read only = true
-```
-3. Run `sudo systemctl enable rsync; sudo systemctl start rsync`
-4. Test by running `rsync -Pzravv rsync://<ip-address-of-leader>/config
-solana-config` from another machine.  **If the leader is running on a cloud
-provider it may be necessary to configure the Firewall rules to permit ingress
-to port tcp:873, tcp:9900 and the port range udp:8000-udp:10000**
-
-
-To run both the Leader and Drone:
-
-```bash
-$ sudo snap set solana mode=bootstrap-leader+drone
-
-```
-
-#### Validator daemon
-
-```bash
-$ sudo snap set solana mode=fullnode
-
-```
-
-By default the node will attempt to connect to **testnet.solana.com**, override the
-cluster entrypoint IP address by running:
-
-```bash
-$ sudo snap set solana mode=fullnode entrypoint-ip=127.0.0.1 #<-- change IP address
-```
-
-It's assumed that the node at the entrypoint IP will be running `rsync`
-configured as described in the previous **Leader daemon** section.
-

book/src/gossip.md

@@ -1,6 +1,6 @@
 # Gossip Service
 
-The Gossip Service acts as a gateway to nodes in the control plane. Fullnodes
+The Gossip Service acts as a gateway to nodes in the control plane. Validators
 use the service to ensure information is available to all other nodes in a cluster.
 The service broadcasts information using a gossip protocol.
 
@@ -22,7 +22,7 @@ gossip endpoint (a socket address).
 
 Records shared over gossip are arbitrary, but signed and versioned (with a
 timestamp) as needed to make sense to the node receiving them. If a node
-recieves two records from the same source, it it updates its own copy with the
+receives two records from the same source, it updates its own copy with the
 record with the most recent timestamp.
 
 ## Gossip Service Interface
@@ -77,3 +77,52 @@ Nodes retain prior versions of values (those updated by a pull or push) and
 expired values (those older than `GOSSIP_PULL_CRDS_TIMEOUT_MS`) in
 `purged_values` (things I recently had).  Nodes purge `purged_values` that are
 older than `5 * GOSSIP_PULL_CRDS_TIMEOUT_MS`.
+
+## Eclipse Attacks
+
+An eclipse attack is an attempt to take over the set of node connections with
+adversarial endpoints.
+
+This is relevant to our implementation in the following ways.
+
+* Pull messages select a random node from the network.  An eclipse attack on
+*pull* would require an attacker to influence the random selection in such a way
+that only adversarial nodes are selected for pull.
+
+* Push messages maintain an active set of nodes and select a random fanout for
+every push message.  An eclipse attack on *push* would influence the active set
+selection, or the random fanout selection.
+
+### Time and Stake based weights
+
+Weights are calculated based on `time since last picked` and the `natural log` of the `stake weight`.
+
+Taking the `ln` of the stake weight allows giving all nodes a fairer chance of network
+coverage in a reasonable amount of time. It helps normalize the large possible `stake weight` differences between nodes.
+This way a node with low `stake weight`, compared to a node with large `stake weight` will only have to wait a
+few multiples of ln(`stake`) seconds before it gets picked.
+
+There is no way for an adversary to influence these parameters.
+
+### Pull Message
+
+A node is selected as a pull target based on the weights described above.
+
+### Push Message
+
+A prune message can only remove an adversary from a potential connection.
+
+Just like *pull message*, nodes are selected into the active set based on weights.
+
+## Notable differences from PlumTree
+
+The active push protocol described here is based on [Plum
+Tree](https://haslab.uminho.pt/jop/files/lpr07a.pdf).  The main differences are:
+
+* Push messages have a wallclock that is signed by the originator.  Once the
+wallclock expires the message is dropped.  A hop limit is difficult to implement
+in an adversarial setting.
+
+* Lazy Push is not implemented because its not obvious how to prevent an
+adversary from forging the message fingerprint.  A naive approach would allow an
+adversary to be prioritized for pull based on their input.

book/src/implemented-proposals.md

@@ -0,0 +1,3 @@
+# Implemented Design Proposals
+
+The following design proposals are fully implemented.

book/src/installer.md

@@ -0,0 +1,213 @@
+## Cluster Software Installation and Updates
+Currently users are required to build the solana cluster software themselves
+from the git repository and manually update it, which is error prone and
+inconvenient.
+
+This document proposes an easy to use software install and updater that can be
+used to deploy pre-built binaries for supported platforms.  Users may elect to
+use binaries supplied by Solana or any other party they trust.  Deployment of
+updates is managed using an on-chain update manifest program.
+
+### Motivating Examples
+#### Fetch and run a pre-built installer using a bootstrap curl/shell script
+The easiest install method for supported platforms:
+```bash
+$ curl -sSf https://raw.githubusercontent.com/solana-labs/solana/v0.16.0/install/solana-install-init.sh | sh
+```
+
+This script will check github for the latest tagged release and download and run the
+`solana-install-init` binary from there.
+
+
+If additional arguments need to be specified during the installation, the
+following shell syntax is used:
+```bash
+$ init_args=.... # arguments for `solana-install-init ...`
+$ curl -sSf https://raw.githubusercontent.com/solana-labs/solana/v0.16.0/install/solana-install-init.sh | sh -s - ${init_args}
+```
+
+#### Fetch and run a pre-built installer from a Github release
+With a well-known release URL, a pre-built binary can be obtained for supported
+platforms:
+
+```bash
+$ curl -o solana-install-init https://github.com/solana-labs/solana/releases/download/v0.16.0/solana-install-init-x86_64-apple-darwin
+$ chmod +x ./solana-install-init
+$ ./solana-install-init --help
+```
+
+#### Build and run the installer from source
+If a pre-built binary is not available for a given platform, building the
+installer from source is always an option:
+```bash
+$ git clone https://github.com/solana-labs/solana.git
+$ cd solana/install
+$ cargo run -- --help
+```
+
+#### Deploy a new update to a cluster
+Given a solana release tarball (as created by `ci/publish-tarball.sh`) that has already been uploaded to a publicly accessible URL,
+the following commands will deploy the update:
+```bash
+$ solana-keygen new -o update-manifest.json  # <-- only generated once, the public key is shared with users
+$ solana-install deploy http://example.com/path/to/solana-release.tar.bz2 update-manifest.json
+```
+
+#### Run a validator node that auto updates itself
+```bash
+$ solana-install init --pubkey 92DMonmBYXwEMHJ99c9ceRSpAmk9v6i3RdvDdXaVcrfj  # <-- pubkey is obtained from whoever is deploying the updates
+$ export PATH=~/.local/share/solana-install/bin:$PATH
+$ solana-keygen ...  # <-- runs the latest solana-keygen
+$ solana-install run solana-validator ...  # <-- runs a validator, restarting it as necesary when an update is applied
+```
+
+### On-chain Update Manifest
+An update manifest is used to advertise the deployment of new release tarballs
+on a solana cluster.  The update manifest is stored using the `config` program,
+and each update manifest account describes a logical update channel for a given
+target triple (eg, `x86_64-apple-darwin`).  The account public key is well-known
+between the entity deploying new updates and users consuming those updates.
+
+The update tarball itself is hosted elsewhere, off-chain and can be fetched from
+the specified `download_url`.
+
+```rust,ignore
+use solana_sdk::signature::Signature;
+
+/// Information required to download and apply a given update
+pub struct UpdateManifest {
+    pub timestamp_secs: u64, // When the release was deployed in seconds since UNIX EPOCH
+    pub download_url: String, // Download URL to the release tar.bz2
+    pub download_sha256: String, // SHA256 digest of the release tar.bz2 file
+}
+
+/// Userdata of an Update Manifest program Account.
+#[derive(Serialize, Deserialize, Default, Debug, PartialEq)]
+pub struct SignedUpdateManifest {
+    pub manifest: UpdateManifest,
+    pub manifest_signature: Signature,
+}
+
+```
+
+Note that the `manifest` field itself contains a corresponding signature
+(`manifest_signature`) to guard against man-in-the-middle attacks between the
+`solana-install` tool and the solana cluster RPC API.
+
+To guard against rollback attacks, `solana-install` will refuse to install an
+update with an older `timestamp_secs` than what is currently installed.
+
+### Release Archive Contents
+A release archive is expected to be a tar file compressed with
+bzip2 with the following internal structure:
+
+* `/version.yml` - a simple YAML file containing the field `"target"` - the
+  target tuple.  Any additional fields are ignored.
+* `/bin/` -- directory containing available programs in the release.
+  `solana-install` will symlink this directory to
+  `~/.local/share/solana-install/bin` for use by the `PATH` environment
+  variable.
+* `...` -- any additional files and directories are permitted
+
+### solana-install Tool
+The `solana-install` tool is used by the user to install and update their cluster software.
+
+It manages the following files and directories in the user's home directory:
+* `~/.config/solana/install/config.yml` - user configuration and information about currently installed software version
+* `~/.local/share/solana/install/bin` - a symlink to the current release. eg, `~/.local/share/solana-update/<update-pubkey>-<manifest_signature>/bin`
+* `~/.local/share/solana/install/releases/<download_sha256>/` - contents of a release
+
+#### Command-line Interface
+```manpage
+solana-install 0.16.0
+The solana cluster software installer
+
+USAGE:
+    solana-install [OPTIONS] <SUBCOMMAND>
+
+FLAGS:
+    -h, --help       Prints help information
+    -V, --version    Prints version information
+
+OPTIONS:
+    -c, --config <PATH>    Configuration file to use [default: /Users/mvines/Library/Preferences/solana/install.yml]
+
+SUBCOMMANDS:
+    deploy    deploys a new update
+    help      Prints this message or the help of the given subcommand(s)
+    info      displays information about the current installation
+    init      initializes a new installation
+    run       Runs a program while periodically checking and applying software updates
+    update    checks for an update, and if available downloads and applies it
+```
+
+```manpage
+solana-install-init
+initializes a new installation
+
+USAGE:
+    solana-install init [OPTIONS]
+
+FLAGS:
+    -h, --help    Prints help information
+
+OPTIONS:
+    -d, --data_dir <PATH>    Directory to store install data [default: /Users/mvines/Library/Application Support/solana]
+    -u, --url <URL>          JSON RPC URL for the solana cluster [default: http://testnet.solana.com:8899]
+    -p, --pubkey <PUBKEY>    Public key of the update manifest [default: 9XX329sPuskWhH4DQh6k16c87dHKhXLBZTL3Gxmve8Gp]
+```
+
+```manpage
+solana-install-info
+displays information about the current installation
+
+USAGE:
+    solana-install info [FLAGS]
+
+FLAGS:
+    -h, --help     Prints help information
+    -l, --local    only display local information, don't check the cluster for new updates
+```
+
+```manpage
+solana-install-deploy
+deploys a new update
+
+USAGE:
+    solana-install deploy <download_url> <update_manifest_keypair>
+
+FLAGS:
+    -h, --help    Prints help information
+
+ARGS:
+    <download_url>               URL to the solana release archive
+    <update_manifest_keypair>    Keypair file for the update manifest (/path/to/keypair.json)
+```
+
+```manpage
+solana-install-update
+checks for an update, and if available downloads and applies it
+
+USAGE:
+    solana-install update
+
+FLAGS:
+    -h, --help    Prints help information
+```
+
+```manpage
+solana-install-run
+Runs a program while periodically checking and applying software updates
+
+USAGE:
+    solana-install run <program_name> [program_arguments]...
+
+FLAGS:
+    -h, --help    Prints help information
+
+ARGS:
+    <program_name>            program to run
+    <program_arguments>...    arguments to supply to the program
+
+The program will be restarted upon a successful software update
+```

book/src/introduction.md

@@ -1,20 +1,20 @@
 # What is Solana?
 
-Solana is the name of an open source project that is implementing a new
+Solana is the name of an open source project that is implementing a new,
 high-performance, permissionless blockchain. Solana is also the name of a
 company headquartered in San Francisco that maintains the open source project.
 
 # About this Book
 
 This book describes the Solana open source project, a blockchain built from the
-ground up for scale. The book covers why to use it, how to use it, how it
+ground up for scale. The book covers why it's useful, how to use it, how it
 works, and why it will continue to work long after the company Solana closes
 its doors. The goal of the Solana architecture is to demonstrate there exists a
 set of software algorithms that when used in combination to implement a
 blockchain, removes software as a performance bottleneck, allowing transaction
 throughput to scale proportionally with network bandwidth. The architecture
-goes on to satisfy all three desirable properties of a proper blockchain: that
-it not only be scalable, but that it is also secure and decentralized.
+goes on to satisfy all three desirable properties of a proper blockchain: 
+it is scalable, secure and decentralized.
 
 The architecture describes a theoretical upper bound of 710 thousand
 transactions per second (tps) on a standard gigabit network and 28.4 million
@@ -32,7 +32,7 @@ solicitation for investment.
 
 # History of the Solana Codebase
 
-In November of 2017 Anatoly Yakovenko published a whitepaper describing Proof
+In November of 2017, Anatoly Yakovenko published a whitepaper describing Proof
 of History, a technique for keeping time between computers that do not trust
 one another. From Anatoly's previous experience designing distributed systems
 at Qualcomm, Mesosphere and Dropbox, he knew that a reliable clock makes
@@ -41,13 +41,13 @@ resulting network can be blazing fast, bound only by network bandwidth.
 
 Anatoly watched as blockchain systems without clocks, such as Bitcoin and
 Ethereum, struggled to scale beyond 15 transactions per second worldwide when
-centralized payment systems such as Visa required peaks of 65,000. Without a
+centralized payment systems such as Visa required peaks of 65,000 tps. Without a
 clock, it was clear they'd never graduate to being the global payment system or
-global supercomputer they had dreamed to be. When Anatoly solved the problem of
+global supercomputer most had dreamed them to be. When Anatoly solved the problem of
 getting computers that don’t trust each other to agree on time, he knew he had
 the key to bring 40 years of distributed systems research to the world of
 blockchain. The resulting cluster wouldn't be just 10 times faster, or a 100
-times, or a 1,000 times, but 10,000 times faster right out of the gate!
+times, or a 1,000 times, but 10,000 times faster, right out of the gate!
 
 Anatoly's implementation began in a private codebase and was implemented in the
 C programming language. Greg Fitzgerald, who had previously worked with Anatoly
@@ -72,7 +72,7 @@ Anatoly recruited Greg, Stephen and three others to co-found a company, then
 called Loom.
 
 Around the same time, Ethereum-based project Loom Network sprung up and many
-people were confused if they were the same project. The Loom team decided it
+people were confused about whether they were the same project. The Loom team decided it
 would rebrand. They chose the name Solana, a nod to a small beach town North of
 San Diego called Solana Beach, where Anatoly, Greg and Stephen lived and surfed
 for three years when they worked for Qualcomm. On March 28th, the team created
@@ -81,13 +81,13 @@ Solana.
 
 In June of 2018, the team scaled up the technology to run on cloud-based
 networks and on July 19th, published a 50-node, permissioned, public testnet
-consistently supporting bursts of 250,000 transactions per second. In the most
-recent release, v0.10 Pillbox, the team published a permissioned testnet
+consistently supporting bursts of 250,000 transactions per second. In a later release in 
+December, called v0.10 Pillbox, the team published a permissioned testnet
 running 150 nodes on a gigabit network and demonstrated soak tests processing
 an *average* of 200 thousand transactions per second with bursts over 500
 thousand. The project was also extended to support on-chain programs written in
 the C programming language and run concurrently in a safe execution environment
-called BPF. Next step: going permissionless.
+called BPF. 
 
 # What is a Solana Cluster?
 
@@ -110,7 +110,7 @@ organization that launched it.
 A sol is the name of Solana's native token, which can be passed to nodes in a
 Solana cluster in exchange for running an on-chain program or validating its
 output. The Solana protocol defines that only 1 billion sols will ever exist,
-but that the system may perform micropayments of fractional sols and that a sol
+but that the system may perform micropayments of fractional sols, and that a sol
 may be split as many as 34 times. The fractional sol is called a *lamport*. It
 is named in honor of Solana's biggest technical influence, [Leslie
 Lamport](https://en.wikipedia.org/wiki/Leslie_Lamport). A lamport has a value

book/src/jsonrpc-api.md

@@ -22,11 +22,19 @@ Methods
 ---
 
 * [confirmTransaction](#confirmtransaction)
-* [getBalance](#getbalance)
 * [getAccountInfo](#getaccountinfo)
-* [getLastId](#getlastid)
+* [getBalance](#getbalance)
+* [getClusterNodes](#getclusternodes)
+* [getEpochInfo](#getepochinfo)
+* [getLeaderSchedule](#getleaderschedule)
+* [getProgramAccounts](#getprogramaccounts)
+* [getRecentBlockhash](#getrecentblockhash)
 * [getSignatureStatus](#getsignaturestatus)
+* [getSlotLeader](#getslotleader)
+* [getNumBlocksSinceSignatureConfirmation](#getnumblockssincesignatureconfirmation)
 * [getTransactionCount](#gettransactioncount)
+* [getTotalSupply](#gettotalsupply)
+* [getEpochVoteAccounts](#getepochvoteaccounts)
 * [requestAirdrop](#requestairdrop)
 * [sendTransaction](#sendtransaction)
 * [startSubscriptionChannel](#startsubscriptionchannel)
@@ -34,6 +42,8 @@ Methods
 * [Subscription Websocket](#subscription-websocket)
   * [accountSubscribe](#accountsubscribe)
   * [accountUnsubscribe](#accountunsubscribe)
+  * [programSubscribe](#programsubscribe)
+  * [programUnsubscribe](#programunsubscribe)
   * [signatureSubscribe](#signaturesubscribe)
   * [signatureUnsubscribe](#signatureunsubscribe)
 
@@ -89,6 +99,32 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "
 {"jsonrpc":"2.0","result":true,"id":1}
 ```
 
+---
+
+### getAccountInfo
+Returns all information associated with the account of provided Pubkey
+
+##### Parameters:
+* `string` - Pubkey of account to query, as base-58 encoded string
+
+##### Results:
+The result field will be a JSON object with the following sub fields:
+
+* `lamports`, number of lamports assigned to this account, as a signed 64-bit integer
+* `owner`, array of 32 bytes representing the program this account has been assigned to
+* `data`, array of bytes representing any data associated with the account
+* `executable`, boolean indicating if the account contains a program (and is strictly read-only)
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "method":"getAccountInfo", "params":["2gVkYWexTHR5Hb2aLeQN3tnngvWzisFKXDUPrgMHpdST"]}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":{"executable":false,"owner":[1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"lamports":1,"data":[3,0,0,0,0,0,0,0,1,0,0,0,0,0,1,0,0,0,0,0,0,0,20,0,0,0,0,0,0,0,50,48,53,48,45,48,49,45,48,49,84,48,48,58,48,48,58,48,48,90,252,10,7,28,246,140,88,177,98,82,10,227,89,81,18,30,194,101,199,16,11,73,133,20,246,62,114,39,20,113,189,32,50,0,0,0,0,0,0,0,247,15,36,102,167,83,225,42,133,127,82,34,36,224,207,130,109,230,224,188,163,33,213,13,5,117,211,251,65,159,197,51,0,0,0,0,0,0]},"id":1}
+```
+
+
 ---
 
 ### getBalance
@@ -111,48 +147,120 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "
 
 ---
 
-### getAccountInfo
-Returns all information associated with the account of provided Pubkey
-
-##### Parameters:
-* `string` - Pubkey of account to query, as base-58 encoded string
-
-##### Results:
-The result field will be a JSON object with the following sub fields:
-
-* `tokens`, number of tokens assigned to this account, as a signed 64-bit integer
-* `owner`, array of 32 bytes representing the program this account has been assigned to
-* `userdata`, array of bytes representing any userdata associated with the account
-* `executable`, boolean indicating if the account contains a program (and is strictly read-only)
-* `loader`, array of 32 bytes representing the loader for this program (if `executable`), otherwise all
-
-##### Example:
-```bash
-// Request
-curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "method":"getAccountInfo", "params":["2gVkYWexTHR5Hb2aLeQN3tnngvWzisFKXDUPrgMHpdST"]}' http://localhost:8899
-
-// Result
-{"jsonrpc":"2.0","result":{"executable":false,"loader":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"owner":[1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"tokens":1,"userdata":[3,0,0,0,0,0,0,0,1,0,0,0,0,0,1,0,0,0,0,0,0,0,20,0,0,0,0,0,0,0,50,48,53,48,45,48,49,45,48,49,84,48,48,58,48,48,58,48,48,90,252,10,7,28,246,140,88,177,98,82,10,227,89,81,18,30,194,101,199,16,11,73,133,20,246,62,114,39,20,113,189,32,50,0,0,0,0,0,0,0,247,15,36,102,167,83,225,42,133,127,82,34,36,224,207,130,109,230,224,188,163,33,213,13,5,117,211,251,65,159,197,51,0,0,0,0,0,0]},"id":1}
-```
-
----
-
-### getLastId
-Returns the last entry ID from the ledger
+### getClusterNodes
+Returns information about all the nodes participating in the cluster
 
 ##### Parameters:
 None
 
 ##### Results:
-* `string` - the ID of last entry, a Hash as base-58 encoded string
+The result field will be an array of JSON objects, each with the following sub fields:
+* `pubkey` - Node public key, as base-58 encoded string
+* `gossip` - Gossip network address for the node
+* `tpu` - TPU network address for the node
+* `rpc` - JSON RPC network address for the node, or `null` if the JSON RPC service is not enabled
 
 ##### Example:
 ```bash
 // Request
-curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "method":"getLastId"}' http://localhost:8899
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "method":"getClusterNodes"}' http://localhost:8899
 
 // Result
-{"jsonrpc":"2.0","result":"GH7ome3EiwEr7tu9JuTh2dpYWBJK3z69Xm1ZE3MEE6JC","id":1}
+{"jsonrpc":"2.0","result":[{"gossip":"10.239.6.48:8001","pubkey":"9QzsJf7LPLj8GkXbYT3LFDKqsj2hHG7TA3xinJHu8epQ","rpc":"10.239.6.48:8899","tpu":"10.239.6.48:8856"}],"id":1}
+```
+
+---
+
+### getEpochInfo
+Returns information about the current epoch
+
+##### Parameters:
+None
+
+##### Results:
+The result field will be an object with the following fields:
+* `epoch`, the current epoch
+* `slotIndex`, the current slot relative to the start of the current epoch
+* `slotsInEpoch`, the number of slots in this epoch
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "method":"getEpochInfo"}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":{"epoch":3,"slotIndex":126,"slotsInEpoch":256},"id":1}
+```
+
+---
+
+### getLeaderSchedule
+Returns the leader schedule for the current epoch
+
+##### Parameters:
+None
+
+##### Results:
+The result field will be an array of leader public keys (as base-58 encoded
+strings) for each slot in the current epoch
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "method":"getLeaderSchedule"}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":[...],"id":1}
+```
+
+---
+
+### getProgramAccounts
+Returns all accounts owned by the provided program Pubkey
+
+##### Parameters:
+* `string` - Pubkey of program, as base-58 encoded string
+
+##### Results:
+The result field will be an array of arrays. Each sub array will contain:
+* `string` - a the account Pubkey as base-58 encoded string
+and a JSON object, with the following sub fields:
+
+* `lamports`, number of lamports assigned to this account, as a signed 64-bit integer
+* `owner`, array of 32 bytes representing the program this account has been assigned to
+* `data`, array of bytes representing any data associated with the account
+* `executable`, boolean indicating if the account contains a program (and is strictly read-only)
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "method":"getProgramAccounts", "params":["8nQwAgzN2yyUzrukXsCa3JELBYqDQrqJ3UyHiWazWxHR"]}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":[["BqGKYtAKu69ZdWEBtZHh4xgJY1BYa2YBiBReQE3pe383", {"executable":false,"owner":[50,28,250,90,221,24,94,136,147,165,253,136,1,62,196,215,225,34,222,212,99,84,202,223,245,13,149,99,149,231,91,96],"lamports":1,"data":[]], ["4Nd1mBQtrMJVYVfKf2PJy9NZUZdTAsp7D4xWLs4gDB4T", {"executable":false,"owner":[50,28,250,90,221,24,94,136,147,165,253,136,1,62,196,215,225,34,222,212,99,84,202,223,245,13,149,99,149,231,91,96],"lamports":10,"data":[]]]},"id":1}
+```
+
+---
+
+### getRecentBlockhash
+Returns a recent block hash from the ledger, and a fee schedule that can be used
+to compute the cost of submitting a transaction using it.
+
+##### Parameters:
+None
+
+##### Results:
+An array consisting of
+* `string` - a Hash as base-58 encoded string
+* `FeeCalculator object` - the fee schedule for this block hash
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "method":"getRecentBlockhash"}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":["GH7ome3EiwEr7tu9JuTh2dpYWBJK3z69Xm1ZE3MEE6JC",{"lamportsPerSignature": 0}],"id":1}
 ```
 
 ---
@@ -166,12 +274,10 @@ events.
 * `string` - Signature of Transaction to confirm, as base-58 encoded string
 
 ##### Results:
-* `string` - Transaction status:
-    * `Confirmed` - Transaction was successful
-    * `SignatureNotFound` - Unknown transaction
-    * `ProgramRuntimeError` - An error occurred in the program that processed this Transaction
-    * `AccountInUse` - Another Transaction had a write lock one of the Accounts specified in this Transaction.  The Transaction may succeed if retried
-    * `GenericFailure` - Some other error occurred.  **Note**: In the future new Transaction statuses may be added to this list.  It's safe to assume that all new statuses will be more specific error conditions that previously presented as `GenericFailure`
+* `null` - Unknown transaction
+* `object` - Transaction status:
+    * `"Ok": null` - Transaction was successful
+    * `"Err": <ERR>` - Transaction failed with TransactionError <ERR> [TransactionError definitions](https://github.com/solana-labs/solana/blob/master/sdk/src/transaction.rs#L14)
 
 ##### Example:
 ```bash
@@ -182,7 +288,48 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "
 {"jsonrpc":"2.0","result":"SignatureNotFound","id":1}
 ```
 
+-----
+
+### getSlotLeader
+Returns the current slot leader
+
+##### Parameters:
+None
+
+##### Results:
+* `string` - Node Id as base-58 encoded string
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "method":"getSlotLeader"}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":"ENvAW7JScgYq6o4zKZwewtkzzJgDzuJAFxYasvmEQdpS","id":1}
+```
+
+-----
+
+### getNumBlocksSinceSignatureConfirmation
+Returns the current number of blocks since signature has been confirmed.
+
+##### Parameters:
+* `string` - Signature of Transaction to confirm, as base-58 encoded string
+
+##### Results:
+* `integer` - count, as unsigned 64-bit integer
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "method":"getNumBlocksSinceSignatureConfirmation", "params":["5VERv8NMvzbJMEkV8xnrLkEaWRtSz9CosKDYjCJjBRnbJLgp8uirBgmQpjKhoR4tjF3ZpRzrFmBV6UjKdiSZkQUW"]}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":8,"id":1}
+```
+
 ---
+
 ### getTransactionCount
 Returns the current Transaction count from the ledger
 
@@ -203,12 +350,57 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "m
 
 ---
 
-### requestAirdrop
-Requests an airdrop of tokens to a Pubkey
+### getTotalSupply
+Returns the current total supply in Lamports
 
 ##### Parameters:
-* `string` - Pubkey of account to receive tokens, as base-58 encoded string
-* `integer` - token quantity, as a signed 64-bit integer
+None
+
+##### Results:
+* `integer` - Total supply, as unsigned 64-bit integer
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "method":"getTotalSupply"}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":10126,"id":1}
+```
+
+---
+
+### getEpochVoteAccounts
+Returns the account info and associated stake for all the voting accounts in the current epoch.
+
+##### Parameters:
+None
+
+##### Results:
+The result field will be an array of JSON objects, each with the following sub fields:
+* `votePubkey` - Vote account public key, as base-58 encoded string
+* `nodePubkey` - Node public key, as base-58 encoded string
+* `stake` - the stake, in lamports, delegated to this vote account
+* `commission`, a 32-bit integer used as a fraction (commission/MAX_U32) for rewards payout
+
+##### Example:
+```bash
+// Request
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "method":"getEpochVoteAccounts"}' http://localhost:8899
+
+// Result
+{"jsonrpc":"2.0","result":[{"commission":0,"nodePubkey":"Et2RaZJdJRTzTkodUwiHr4H6sLkVmijBFv8tkd7oSSFY","stake":42,"votePubkey":"B4CdWq3NBSoH2wYsVE1CaZSWPo2ZtopE4SJipQhZ3srF"}],"id":1}
+```
+
+---
+
+
+### requestAirdrop
+Requests an airdrop of lamports to a Pubkey
+
+##### Parameters:
+* `string` - Pubkey of account to receive lamports, as base-58 encoded string
+* `integer` - lamports, as a signed 64-bit integer
 
 ##### Results:
 * `string` - Transaction Signature of airdrop, as base-58 encoded string
@@ -248,14 +440,25 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "m
 After connect to the RPC PubSub websocket at `ws://<ADDRESS>/`:
 - Submit subscription requests to the websocket using the methods below
 - Multiple subscriptions may be active at once
+- All subscriptions take an optional `confirmations` parameter, which defines
+  how many confirmed blocks the node should wait before sending a notification.
+  The greater the number, the more likely the notification is to represent
+  consensus across the cluster, and the less likely it is to be affected by
+  forking or rollbacks. If unspecified, the default value is 0; the node will
+  send a notification as soon as it witnesses the event. The maximum
+  `confirmations` wait length is the cluster's `MAX_LOCKOUT_HISTORY`, which
+  represents the economic finality of the chain.
 
 ---
 
 ### accountSubscribe
-Subscribe to an account to receive notifications when the userdata for a given account public key changes
+Subscribe to an account to receive notifications when the lamports or data
+for a given account public key changes
 
 ##### Parameters:
 * `string` - account Pubkey, as base-58 encoded string
+* `integer` - optional, number of confirmed blocks to wait before notification.
+  Default: 0, Max: `MAX_LOCKOUT_HISTORY` (greater integers rounded down)
 
 ##### Results:
 * `integer` - Subscription id (needed to unsubscribe)
@@ -265,19 +468,21 @@ Subscribe to an account to receive notifications when the userdata for a given a
 // Request
 {"jsonrpc":"2.0", "id":1, "method":"accountSubscribe", "params":["CM78CPUeXjn8o3yroDHxUtKsZZgoy4GPkPPXfouKNH12"]}
 
+{"jsonrpc":"2.0", "id":1, "method":"accountSubscribe", "params":["CM78CPUeXjn8o3yroDHxUtKsZZgoy4GPkPPXfouKNH12", 15]}
+
 // Result
 {"jsonrpc": "2.0","result": 0,"id": 1}
 ```
 
 ##### Notification Format:
 ```bash
-{"jsonrpc": "2.0","method": "accountNotification", "params": {"result": {"executable":false,"loader":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"owner":[1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"tokens":1,"userdata":[3,0,0,0,0,0,0,0,1,0,0,0,0,0,1,0,0,0,0,0,0,0,20,0,0,0,0,0,0,0,50,48,53,48,45,48,49,45,48,49,84,48,48,58,48,48,58,48,48,90,252,10,7,28,246,140,88,177,98,82,10,227,89,81,18,30,194,101,199,16,11,73,133,20,246,62,114,39,20,113,189,32,50,0,0,0,0,0,0,0,247,15,36,102,167,83,225,42,133,127,82,34,36,224,207,130,109,230,224,188,163,33,213,13,5,117,211,251,65,159,197,51,0,0,0,0,0,0]},"subscription":0}}
+{"jsonrpc": "2.0","method": "accountNotification", "params": {"result": {"executable":false,"owner":[1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"lamports":1,"data":[3,0,0,0,0,0,0,0,1,0,0,0,0,0,1,0,0,0,0,0,0,0,20,0,0,0,0,0,0,0,50,48,53,48,45,48,49,45,48,49,84,48,48,58,48,48,58,48,48,90,252,10,7,28,246,140,88,177,98,82,10,227,89,81,18,30,194,101,199,16,11,73,133,20,246,62,114,39,20,113,189,32,50,0,0,0,0,0,0,0,247,15,36,102,167,83,225,42,133,127,82,34,36,224,207,130,109,230,224,188,163,33,213,13,5,117,211,251,65,159,197,51,0,0,0,0,0,0]},"subscription":0}}
 ```
 
 ---
 
 ### accountUnsubscribe
-Unsubscribe from account userdata change notifications
+Unsubscribe from account change notifications
 
 ##### Parameters:
 * `integer` - id of account Subscription to cancel
@@ -296,12 +501,66 @@ Unsubscribe from account userdata change notifications
 
 ---
 
+### programSubscribe
+Subscribe to a program to receive notifications when the lamports or data
+for a given account owned by the program changes
+
+##### Parameters:
+* `string` - program_id Pubkey, as base-58 encoded string
+* `integer` - optional, number of confirmed blocks to wait before notification.
+  Default: 0, Max: `MAX_LOCKOUT_HISTORY` (greater integers rounded down)
+
+##### Results:
+* `integer` - Subscription id (needed to unsubscribe)
+
+##### Example:
+```bash
+// Request
+{"jsonrpc":"2.0", "id":1, "method":"programSubscribe", "params":["9gZbPtbtHrs6hEWgd6MbVY9VPFtS5Z8xKtnYwA2NynHV"]}
+
+{"jsonrpc":"2.0", "id":1, "method":"programSubscribe", "params":["9gZbPtbtHrs6hEWgd6MbVY9VPFtS5Z8xKtnYwA2NynHV", 15]}
+
+// Result
+{"jsonrpc": "2.0","result": 0,"id": 1}
+```
+
+##### Notification Format:
+* `string` - account Pubkey, as base-58 encoded string
+* `object` - account info JSON object (see [getAccountInfo](#getaccountinfo) for field details)
+```bash
+{"jsonrpc":"2.0","method":"programNotification","params":{{"result":["8Rshv2oMkPu5E4opXTRyuyBeZBqQ4S477VG26wUTFxUM",{"executable":false,"lamports":1,"owner":[129,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"data":[1,1,1,0,0,0,0,0,0,0,20,0,0,0,0,0,0,0,50,48,49,56,45,49,50,45,50,52,84,50,51,58,53,57,58,48,48,90,235,233,39,152,15,44,117,176,41,89,100,86,45,61,2,44,251,46,212,37,35,118,163,189,247,84,27,235,178,62,55,89,0,0,0,0,50,0,0,0,0,0,0,0,235,233,39,152,15,44,117,176,41,89,100,86,45,61,2,44,251,46,212,37,35,118,163,189,247,84,27,235,178,62,45,4,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]}],"subscription":0}}
+```
+
+---
+
+### programUnsubscribe
+Unsubscribe from program-owned account change notifications
+
+##### Parameters:
+* `integer` - id of account Subscription to cancel
+
+##### Results:
+* `bool` - unsubscribe success message
+
+##### Example:
+```bash
+// Request
+{"jsonrpc":"2.0", "id":1, "method":"programUnsubscribe", "params":[0]}
+
+// Result
+{"jsonrpc": "2.0","result": true,"id": 1}
+```
+
+---
+
 ### signatureSubscribe
 Subscribe to a transaction signature to receive notification when the transaction is confirmed
 On `signatureNotification`, the subscription is automatically cancelled
 
 ##### Parameters:
 * `string` - Transaction Signature, as base-58 encoded string
+* `integer` - optional, number of confirmed blocks to wait before notification.
+  Default: 0, Max: `MAX_LOCKOUT_HISTORY` (greater integers rounded down)
 
 ##### Results:
 * `integer` - subscription id (needed to unsubscribe)
@@ -311,6 +570,8 @@ On `signatureNotification`, the subscription is automatically cancelled
 // Request
 {"jsonrpc":"2.0", "id":1, "method":"signatureSubscribe", "params":["2EBVM6cB8vAAD93Ktr6Vd8p67XPbQzCJX47MpReuiCXJAtcjaxpvWpcg9Ege1Nr5Tk3a2GFrByT7WPBjdsTycY9b"]}
 
+{"jsonrpc":"2.0", "id":1, "method":"signatureSubscribe", "params":["2EBVM6cB8vAAD93Ktr6Vd8p67XPbQzCJX47MpReuiCXJAtcjaxpvWpcg9Ege1Nr5Tk3a2GFrByT7WPBjdsTycY9b", 15]}
+
 // Result
 {"jsonrpc": "2.0","result": 0,"id": 1}
 ```
@@ -323,10 +584,10 @@ On `signatureNotification`, the subscription is automatically cancelled
 ---
 
 ### signatureUnsubscribe
-Unsubscribe from account userdata change notifications
+Unsubscribe from signature confirmation notification
 
 ##### Parameters:
-* `integer` - id of account subscription to cancel
+* `integer` - subscription id to cancel
 
 ##### Results:
 * `bool` - unsubscribe success message

book/src/leader-leader-transition.md

@@ -0,0 +1,101 @@
+# Leader to Leader Transition
+
+This design describes how leaders transition production of the PoH ledger
+between each other as each leader generates its own slot.
+
+## Challenges
+
+Current leader and the next leader are both racing to generate the final tick
+for the current slot.  The next leader may arrive at that slot while still
+processing the current leader's entries.
+
+The ideal scenario would be that the next leader generated its own slot right
+after it was able to vote for the current leader.  It is very likely that the
+next leader will arrive at their PoH slot height before the current leader
+finishes broadcasting the entire block.
+
+The next leader has to make the decision of attaching its own block to the last
+completed block, or wait to finalize the pending block.  It is possible that the
+next leader will produce a block that proposes that the current leader failed,
+even though the rest of the network observes that block succeeding.
+
+The current leader has incentives to start its slot as early as possible to
+capture economic rewards.  Those incentives need to be balanced by the leader's
+need to attach its block to a block that has the most commitment from the rest
+of the network.
+
+## Leader timeout
+
+While a leader is actively receiving entries for the previous slot, the leader
+can delay broadcasting the start of its block in real time.  The delay is
+locally configurable by each leader, and can be dynamically based on the
+previous leader's behavior.  If the previous leader's block is confirmed by the
+leader's TVU before the timeout, the PoH is reset to the start of the slot and
+this leader produces its block immediately.
+
+The downsides:
+
+* Leader delays its own slot, potentially allowing the next leader more time to
+catch up.
+
+The upsides compared to guards:
+
+* All the space in a block is used for entries.
+
+* The timeout is not fixed.
+
+* The timeout is local to the leader, and therefore can be clever.  The leader's
+heuristic can take into account turbine performance.
+
+* This design doesn't require a ledger hard fork to update.
+
+* The previous leader can redundantly transmit the last entry in the block to
+the next leader, and the next leader can speculatively decide to trust it to
+generate its block without verification of the previous block.
+
+* The leader can speculatively generate the last tick from the last received
+entry.
+
+* The leader can speculatively process transactions and guess which ones are not
+going to be encoded by the previous leader.  This is also a censorship attack
+vector.  The current leader may withhold transactions that it receives from the
+clients so it can encode them into its own slot. Once processed, entries can be
+replayed into PoH quickly.
+
+## Alternative design options
+
+### Guard tick at the end of the slot
+
+A leader does not produce entries in its block after the *penultimate tick*,
+which is the last tick before the first tick of the next slot.  The network
+votes on the *last tick*, so the time difference between the *penultimate tick*
+and the *last tick* is the forced delay for the entire network, as well as the
+next leader before a new slot can be generated.  The network can produce the
+*last tick* from the *penultimate tick*.
+
+If the next leader receives the *penultimate tick* before it produces its own
+*first tick*, it will reset its PoH and produce the *first tick* from the
+previous leader's *penultimate tick*.  The rest of the network will also reset
+its PoH to produce the *last tick* as the id to vote on.
+
+The downsides:
+
+* Every vote, and therefore confirmation, is delayed by a fixed timeout. 1 tick,
+or around 100ms.
+
+* Average case confirmation time for a transaction would be at least 50ms worse.
+
+* It is part of the ledger definition, so to change this behavior would require
+a hard fork.
+
+* Not all the available space is used for entries.
+
+The upsides compared to leader timeout:
+
+* The next leader has received all the previous entries, so it can start
+processing transactions without recording them into PoH.
+
+* The previous leader can redundantly transmit the last entry containing the
+*penultimate tick* to the next leader.  The next leader can speculatively
+generate the *last tick* as soon as it receives the *penultimate tick*, even
+before verifying it.

book/src/leader-rotation.md

@@ -3,17 +3,102 @@
 At any given moment, a cluster expects only one fullnode to produce ledger
 entries. By having only one leader at a time, all validators are able to replay
 identical copies of the ledger. The drawback of only one leader at a time,
-however, is that a malicious leader is cabable of censoring votes and
+however, is that a malicious leader is capable of censoring votes and
 transactions. Since censoring cannot be distinguished from the network dropping
 packets, the cluster cannot simply elect a single node to hold the leader role
-indefinitely. Instead, the cluster minimizes the influence of a malcioius
+indefinitely. Instead, the cluster minimizes the influence of a malicious
 leader by rotating which node takes the lead.
 
 Each validator selects the expected leader using the same algorithm, described
 below. When the validator receives a new signed ledger entry, it can be certain
-that entry was produced by the expected leader.
+that entry was produced by the expected leader.  The order of slots which each
+leader is assigned a slot is called a *leader schedule*.
 
-## Leader Schedule Generation
+## Leader Schedule Rotation
+
+A validator rejects blocks that are not signed by the *slot leader*.  The list
+of identities of all slot leaders is called a *leader schedule*. The leader
+schedule is recomputed locally and periodically. It assigns slot leaders for a
+duration of time called an _epoch_. The schedule must be computed far in advance
+of the slots it assigns, such that the ledger state it uses to compute the
+schedule is finalized. That duration is called the *leader schedule offset*.
+Solana sets the offset to the duration of slots until the next epoch. That is,
+the leader schedule for an epoch is calculated from the ledger state at the
+start of the previous epoch. The offset of one epoch is fairly arbitrary and
+assumed to be sufficiently long such that all validators will have finalized
+their ledger state before the next schedule is generated. A cluster may choose
+to shorten the offset to reduce the time between stake changes and leader
+schedule updates.
+
+While operating without partitions lasting longer than an epoch, the schedule
+only needs to be generated when the root fork crosses the epoch boundary.  Since
+the schedule is for the next epoch, any new stakes committed to the root fork
+will not be active until the next epoch.  The block used for generating the
+leader schedule is the first block to cross the epoch boundary.
+
+Without a partition lasting longer than an epoch, the cluster will work as
+follows:
+
+1. A validator continuously updates its own root fork as it votes.
+
+2. The validator updates its leader schedule each time the slot height crosses
+an epoch boundary.
+
+For example:
+
+The epoch duration is 100 slots. The root fork is updated from fork computed at
+slot height 99 to a fork computed at slot height 102. Forks with slots at height
+100,101 were skipped because of failures.  The new leader schedule is computed
+using fork at slot height 102.  It is active from slot 200 until it is updated
+again.
+
+No inconsistency can exist because every validator that is voting with the
+cluster has skipped 100 and 101 when its root passes 102.  All validators,
+regardless of voting pattern, would be committing to a root that is either 102,
+or a descendant of 102.
+
+### Leader Schedule Rotation with Epoch Sized Partitions.
+
+The duration of the leader schedule offset has a direct relationship to the
+likelihood of a cluster having an inconsistent view of the correct leader
+schedule.
+
+Consider the following scenario:
+
+Two partitions that are generating half of the blocks each.  Neither is coming
+to a definitive supermajority fork.  Both will cross epoch 100 and 200 without
+actually committing to a root and therefore a cluster wide commitment to a new
+leader schedule.
+
+In this unstable scenario, multiple valid leader schedules exist.
+
+* A leader schedule is generated for every fork whose direct parent is in the
+previous epoch.
+
+* The leader schedule is valid after the start of the next epoch for descendant
+forks until it is updated.
+
+Each partition's schedule will diverge after the partition lasts more than an
+epoch.  For this reason, the epoch duration should be selected to be much much
+larger then slot time and the expected length for a fork to be committed to
+root.
+
+After observing the cluster for a sufficient amount of time, the leader schedule
+offset can be selected based on the median partition duration and its standard
+deviation.  For example, an offset longer then the median partition duration
+plus six standard deviations would reduce the likelihood of an inconsistent
+ledger schedule in the cluster to 1 in 1 million.
+ 
+## Leader Schedule Generation at Genesis
+
+The genesis block declares the first leader for the first epoch.  This leader
+ends up scheduled for the first two epochs because the leader schedule is also
+generated at slot 0 for the next epoch.  The length of the first two epochs can
+be specified in the genesis block as well.  The minimum length of the first
+epochs must be greater than or equal to the maximum rollback depth as defined in
+[fork selection](fork-selection.md).
+
+## Leader Schedule Generation Algorithm
 
 Leader schedule is generated using a predefined seed.  The process is as follows:
 
@@ -27,12 +112,42 @@ Leader schedule is generated using a predefined seed.  The process is as follows
    stake-weighted ordering.
 5. This ordering becomes valid after a cluster-configured number of ticks.
 
+## Schedule Attack Vectors
+
+### Seed
+
 The seed that is selected is predictable but unbiasable.  There is no grinding
-attack to influence its outcome. The active set, however, can be biased by a
-leader by censoring validator votes. To reduce the likelihood of censorship,
-the active set is sampled many slots in advance, such that votes will have been
-collected by multiple leaders. If even one node is honest, the malicious
-leaders will not be able to use censorship to influence the leader schedule.
+attack to influence its outcome. 
+
+### Active Set
+
+A leader can bias the active set by censoring validator votes.  Two possible
+ways exist for leaders to censor the active set:
+
+* Ignore votes from validators 
+* Refuse to vote for blocks with votes from validators
+
+To reduce the likelihood of censorship, the active set is calculated at the
+leader schedule offset boundary over an *active set sampling duration*. The
+active set sampling duration is long enough such that votes will have been
+collected by multiple leaders.
+
+### Staking
+
+Leaders can censor new staking transactions or refuse to validate blocks with
+new stakes.  This attack is similar to censorship of validator votes.
+
+### Validator operational key loss
+
+Leaders and validators are expected to use ephemeral keys for operation, and
+stake owners authorize the validators to do work with their stake via
+delegation.
+
+The cluster should be able to recover from the loss of all the ephemeral keys
+used by leaders and validators, which could occur through a common software
+vulnerability shared by all the nodes.  Stake owners should be able to vote
+directly co-sign a validator vote even though the stake is currently delegated
+to a validator.
 
 ## Appending Entries
 

book/src/leader-validator-transition.md

@@ -0,0 +1,84 @@
+# Leader-to-Validator Transition
+
+A fullnode typically operates as a validator. If, however, a staker delegates
+its stake to a fullnode, it will occasionally be selected as a *slot leader*.
+As a slot leader, the fullnode is responsible for producing blocks during an
+assigned *slot*. A slot has a duration of some number of preconfigured *ticks*.
+The duration of those ticks are estimated with a *PoH Recorder* described later
+in this document.
+
+## BankFork
+
+BankFork tracks changes to the bank state over a specific slot.  Once the final
+tick has been registered the state is frozen. Any attempts to write to are
+rejected.
+
+## Validator
+
+A validator operates on many different concurrent forks of the bank state until
+it generates a PoH hash with a height within its leader slot.
+
+## Slot Leader
+
+A slot leader builds blocks on top of only one fork, the one it last voted on.
+
+## PoH Recorder
+
+Slot leaders and validators use a PoH Recorder for both estimating slot height
+and for recording transactions.
+
+### PoH Recorder when Validating
+
+The PoH Recorder acts as a simple VDF when validating. It tells the validator
+when it needs to switch to the slot leader role. Every time the validator votes
+on a fork, it should use the fork's latest block id to re-seed the VDF.
+Re-seeding solves two problems. First, it synchronizes its VDF to the leader's,
+allowing it to more accurately determine when its leader slot begins. Second,
+if the previous leader goes down, all wallclock time is accounted for in the
+next leader's PoH stream. For example, if one block is missing when the leader
+starts, the block it produces should have a PoH duration of two blocks. The
+longer duration ensures the following leader isn't attempting to snip all the
+transactions from the previous leader's slot.
+
+### PoH Recorder when Leading
+
+A slot leader use the PoH Recorder to record transactions, locking their
+positions in time. The PoH hash must be derived from a previous leader's last
+block.  If it isn't, its block will fail PoH verification and be rejected by
+the cluster.
+
+The PoH Recorder also serves to inform the slot leader when its slot is over.
+The leader needs to take care not to modify its bank if recording the
+transaction would generate a PoH height outside its designated slot.  The
+leader, therefore, should not commit account changes until after it generates
+the entry's PoH hash. When the PoH height falls outside its slot any
+transactions in its pipeline may be dropped or forwarded to the next leader.
+Forwarding is preferred, as it would minimize network congestion, allowing the
+cluster to advertise higher TPS capacity.
+
+
+## Validator Loop
+
+The PoH Recorder manages the transition between modes. Once a ledger is
+replayed, the validator can run until the recorder indicates it should be
+the slot leader. As a slot leader, the node can then execute and record
+transactions.
+
+The loop is synchronized to PoH and does a synchronous start and stop of the
+slot leader functionality. After stopping, the validator's TVU should find
+itself in the same state as if a different leader had sent it the same block.
+The following is pseudocode for the loop:
+
+1. Query the LeaderScheduler for the next assigned slot.
+2. Run the TVU over all the forks.
+   1. TVU will send votes to what it believes is the "best" fork.
+   2. After each vote, restart the PoH Recorder to run until the next assigned
+slot.
+3. When time to be a slot leader, start the TPU. Point it to the last fork the
+   TVU voted on.
+4. Produce entries until the end of the slot.
+   1. For the duration of the slot, the TVU must not vote on other forks.
+   2. After the slot ends, the TPU freezes its BankFork. After freezing,
+      the TVU may resume voting.
+5. Goto 1.
+

book/src/ledger-replication-to-implement.md

@@ -0,0 +1,142 @@
+# Ledger Replication
+
+Replication behavior yet to be implemented.
+
+### Storage epoch
+
+The storage epoch should be the number of slots which results in around 100GB-1TB of
+ledger to be generated for replicators to store. Replicators will start storing ledger
+when a given fork has a high probability of not being rolled back.
+
+### Validator behavior
+
+3. Every NUM\_KEY\_ROTATION\_TICKS it also validates samples received from
+replicators. It signs the PoH hash at that point and uses the following
+algorithm with the signature as the input:
+     - The low 5 bits of the first byte of the signature creates an index into
+       another starting byte of the signature.
+     - The validator then looks at the set of storage proofs where the byte of
+       the proof's sha state vector starting from the low byte matches exactly
+with the chosen byte(s) of the signature.
+     - If the set of proofs is larger than the validator can handle, then it
+       increases to matching 2 bytes in the signature.
+     - Validator continues to increase the number of matching bytes until a
+       workable set is found.
+     - It then creates a mask of valid proofs and fake proofs and sends it to
+       the leader. This is a storage proof confirmation transaction.
+5. After a lockout period of NUM\_SECONDS\_STORAGE\_LOCKOUT seconds, the
+validator then submits a storage proof claim transaction which then causes the
+distribution of the storage reward if no challenges were seen for the proof to
+the validators and replicators party to the proofs.
+
+### Replicator behavior
+
+9. The replicator then generates another set of offsets which it submits a fake
+proof with an incorrect sha state. It can be proven to be fake by providing the
+seed for the hash result.
+     - A fake proof should consist of a replicator hash of a signature of a PoH
+       value. That way when the replicator reveals the fake proof, it can be
+verified on chain.
+10. The replicator monitors the ledger, if it sees a fake proof integrated, it
+creates a challenge transaction and submits it to the current leader. The
+transacation proves the validator incorrectly validated a fake storage proof.
+The replicator is rewarded and the validator's staking balance is slashed or
+frozen.
+
+### Storage proof contract logic
+
+Each replicator and validator will have their own storage account. The validator's
+account would be separate from their gossip id similiar to their vote account.
+These should be implemented as two programs one which handles the validator as the keysigner
+and one for the replicator. In that way when the programs reference other accounts, they
+can check the program id to ensure it is a validator or replicator account they are
+referencing.
+
+#### SubmitMiningProof
+```rust,ignore
+SubmitMiningProof {
+    slot: u64,
+    sha_state: Hash,
+    signature: Signature,
+};
+keys = [replicator_keypair]
+```
+Replicators create these after mining their stored ledger data for a certain hash value.
+The slot is the end slot of the segment of ledger they are storing, the sha\_state
+the result of the replicator using the hash function to sample their encrypted ledger segment.
+The signature is the signature that was created when they signed a PoH value for the
+current storage epoch. The list of proofs from the current storage epoch should be saved
+in the account state, and then transfered to a list of proofs for the previous epoch when
+the epoch passes. In a given storage epoch a given replicator should only submit proofs
+for one segment.
+
+The program should have a list of slots which are valid storage mining slots.
+This list should be maintained by keeping track of slots which are rooted slots in which a significant
+portion of the network has voted on with a high lockout value, maybe 32-votes old. Every SLOTS\_PER\_SEGMENT
+number of slots would be added to this set. The program should check that the slot is in this set. The set can
+be maintained by receiving a AdvertiseStorageRecentBlockHash and checking with its bank/locktower state.
+
+The program should do a signature verify check on the signature, public key from the transaction submitter and the message of
+the previous storage epoch PoH value.
+
+#### ProofValidation
+```rust,ignore
+ProofValidation {
+   proof_mask: Vec<ProofStatus>,
+}
+keys = [validator_keypair, replicator_keypair(s) (unsigned)]
+```
+A validator will submit this transaction to indicate that a set of proofs for a given
+segment are valid/not-valid or skipped where the validator did not look at it. The
+keypairs for the replicators that it looked at should be referenced in the keys so the program
+logic can go to those accounts and see that the proofs are generated in the previous epoch. The
+sampling of the storage proofs should be verified ensuring that the correct proofs are skipped by
+the validator according to the logic outlined in the validator behavior of sampling.
+
+The included replicator keys will indicate the the storage samples which are being referenced; the
+length of the proof\_mask should be verified against the set of storage proofs in the referenced
+replicator account(s), and should match with the number of proofs submitted in the previous storage
+epoch in the state of said replicator account.
+
+#### ClaimStorageReward
+```rust,ignore
+ClaimStorageReward {
+}
+keys = [validator_keypair or replicator_keypair, validator/replicator_keypairs (unsigned)]
+```
+Replicators and validators will use this transaction to get paid tokens from a program state
+where SubmitStorageProof, ProofValidation and ChallengeProofValidations are in a state where
+proofs have been submitted and validated and there are no ChallengeProofValidations referencing
+those proofs. For a validator, it should reference the replicator keypairs to which it has validated
+proofs in the relevant epoch. And for a replicator it should reference validator keypairs for which it
+has validated and wants to be rewarded.
+
+#### ChallengeProofValidation
+```rust,ignore
+ChallengeProofValidation {
+    proof_index: u64,
+    hash_seed_value: Vec<u8>,
+}
+keys = [replicator_keypair, validator_keypair]
+```
+
+This transaction is for catching lazy validators who are not doing the work to validate proofs.
+A replicator will submit this transaction when it sees a validator has approved a fake SubmitMiningProof
+transaction. Since the replicator is a light client not looking at the full chain, it will have to ask
+a validator or some set of validators for this information maybe via RPC call to obtain all ProofValidations for
+a certain segment in the previous storage epoch. The program will look in the validator account
+state see that a ProofValidation is submitted in the previous storage epoch and hash the hash\_seed\_value and
+see that the hash matches the SubmitMiningProof transaction and that the validator marked it as valid. If so,
+then it will save the challenge to the list of challenges that it has in its state.
+
+#### AdvertiseStorageRecentBlockhash
+```rust,ignore
+AdvertiseStorageRecentBlockhash {
+    hash: Hash,
+    slot: u64,
+}
+```
+
+Validators and replicators will submit this to indicate that a new storage epoch has passed and that the
+storage proofs which are current proofs should now be for the previous epoch. Other transactions should
+check to see that the epoch that they are referencing is accurate according to current chain state.

book/src/ledger-replication.md

@@ -1,68 +1,18 @@
 # Ledger Replication
 
 At full capacity on a 1gbps network solana will generate 4 petabytes of data
-per year.  To prevent the network from centralizing around full nodes that have
+per year.  To prevent the network from centralizing around validators that have
 to store the full data set this protocol proposes a way for mining nodes to
-provide storage capacity for pieces of the network.
+provide storage capacity for pieces of the data.
 
 The basic idea to Proof of Replication is encrypting a dataset with a public
 symmetric key using CBC encryption, then hash the encrypted dataset. The main
 problem with the naive approach is that a dishonest storage node can stream the
-encryption and delete the data as its hashed. The simple solution is to force
-the hash to be done on the reverse of the encryption, or perhaps with a random
-order. This ensures that all the data is present during the generation of the
-proof and it also requires the validator to have the entirety of the encrypted
-data present for verification of every proof of every identity. So the space
-required to validate is `number_of_proofs * data_size`
-
-## Terminology
-
-#### replicator
-
-Storage mining client, stores some part of the ledger enumerated in blocks and
-submits storage proofs to the chain. Not a full-node.
-
-#### ledger segment
-
-Portion of the ledger which is downloaded by the replicator where storage proof
-data is derived.
-
-#### CBC block
-
-Smallest encrypted chunk of ledger, an encrypted ledger segment would be made of
-many CBC blocks. `ledger_segment_size / cbc_block_size` to be exact.
-
-#### storage proof
-
-A set of sha hash state which is constructed by sampling the encrypted version
-of the stored ledger segment at certain offsets.
-
-#### fake storage proof
-
-A proof which has the same format as a storage proof, but the sha state is
-actually from hashing a known ledger value which the storage client can reveal
-and is also easily verifiable by the network on-chain.
-
-#### storage proof confirmation
-
-A transaction by a validator which indicates the set of real and fake proofs
-submitted by a storage miner. The transaction would contain a list of proof
-hash values and a bit which says if this hash is valid or fake.
-
-#### storage proof challenge
-
-A transaction from a replicator that verifiably proves that a validator
-confirmed a fake proof.
-
-#### storage proof claim
-
-A transaction from a validator which is after the timeout period given from the
-storage proof confirmation and which no successful challenges have been
-observed which rewards the parties of the storage proofs and confirmations.
-
-#### storage validation capacity
-
-The number of keys and samples that a validator can verify each storage epoch.
+encryption and delete the data as it's hashed. The simple solution is to periodically
+regenerate the hash based on a signed PoH value. This ensures that all the data is present
+during the generation of the proof and it also requires validators to have the
+entirety of the encrypted data present for verification of every proof of every identity.
+So the space required to validate is `number_of_proofs * data_size`
 
 ## Optimization with PoH
 
@@ -72,19 +22,18 @@ PoH ledger. Thus the segments stay in the exact same order for every PoRep and
 verification can stream the data and verify all the proofs in a single batch.
 This way we can verify multiple proofs concurrently, each one on its own CUDA
 core. The total space required for verification is `1_ledger_segment +
-2_cbc_blocks * number_of_identities` with core count of equal to
+2_cbc_blocks * number_of_identities` with core count equal to
 `number_of_identities`. We use a 64-byte chacha CBC block size.
 
 ## Network
 
 Validators for PoRep are the same validators that are verifying transactions.
-They have some stake that they have put up as collateral that ensures that
-their work is honest. If you can prove that a validator verified a fake PoRep,
-then the validators stake can be slashed.
+If a replicator can prove that a validator verified a fake PoRep, then the
+validator will not receive a reward for that storage epoch.
 
-Replicators are specialized *light clients*. They download a part of the ledger
-and store it, and provide PoReps of storing the ledger. For each verified PoRep
-replicators earn a reward of sol from the mining pool.
+Replicators are specialized *light clients*. They download a part of the
+ledger (a.k.a Segment) and store it, and provide PoReps of storing the ledger.
+For each verified PoRep replicators earn a reward of sol from the mining pool.
 
 ## Constraints
 
@@ -102,11 +51,10 @@ changes to determine what rate it can validate storage proofs.
 
 ### Constants
 
-1. NUM\_STORAGE\_ENTRIES: Number of entries in a segment of ledger data. The
+1. SLOTS\_PER\_SEGMENT: Number of slots in a segment of ledger data. The
 unit of storage for a replicator.
-2. NUM\_KEY\_ROTATION\_TICKS: Number of ticks to save a PoH value and cause a
-key generation for the section of ledger just generated and the rotation of
-another key in the set.
+2. NUM\_KEY\_ROTATION\_SEGMENTS: Number of segments after which replicators
+regenerate their encryption keys and select a new dataset to store.
 3. NUM\_STORAGE\_PROOFS: Number of storage proofs required for a storage proof
 claim to be successfully rewarded.
 4. RATIO\_OF\_FAKE\_PROOFS: Ratio of fake proofs to real proofs that a storage
@@ -115,102 +63,108 @@ mining proof claim has to contain to be valid for a reward.
 proof.
 6. NUM\_CHACHA\_ROUNDS: Number of encryption rounds performed to generate
 encrypted state.
+7. NUM\_SLOTS\_PER\_TURN: Number of slots that define a single storage epoch or
+a "turn" of the PoRep game.
 
 ### Validator behavior
 
-1. Validator joins the network and submits a storage validation capacity
-transaction which tells the network how many proofs it can process in a given
-period defined by NUM\_KEY\_ROTATION\_TICKS.
-2. Every NUM\_KEY\_ROTATION\_TICKS the validator stores the PoH value at that
-height.
-3. Every NUM\_KEY\_ROTATION\_TICKS it also validates samples received from
-replicators. It signs the PoH hash at that point and uses the following
-algorithm with the signature as the input:
-     - The low 5 bits of the first byte of the signature creates an index into
-       another starting byte of the signature.
-     - The validator then looks at the set of storage proofs where the byte of
-       the proof's sha state vector starting from the low byte matches exactly
-with the chosen byte(s) of the signature.
-     - If the set of proofs is larger than the validator can handle, then it
-       increases to matching 2 bytes in the signature.
-     - Validator continues to increase the number of matching bytes until a
-       workable set is found.
-     - It then creates a mask of valid proofs and fake proofs and sends it to
-       the leader. This is a storage proof confirmation transaction.
-4. The storage proof confirmation transaction is integrated into the ledger.
-5. After a lockout period of NUM\_SECONDS\_STORAGE\_LOCKOUT seconds, the
-validator then submits a storage proof claim transaction which then causes the
-distribution of the storage reward if no challenges were seen for the proof to
-the validators and replicators party to the proofs.
-6. Validator responds to RPC interfaces for what the last storage epoch PoH
-value is and its entry\_height.
+1. Validators join the network and begin looking for replicator accounts at each
+storage epoch/turn boundary.
+2. Every turn, Validators sign the PoH value at the boundary and use that signature
+to randomly pick proofs to verify from each storage account found in the turn boundary.
+This signed value is also submitted to the validator's storage account and will be used by
+replicators at a later stage to cross-verify.
+3. Every `NUM_SLOTS_PER_TURN` slots the validator advertises the PoH value. This is value
+is also served to Replicators via RPC interfaces.
+4. For a given turn N, all validations get locked out until turn N+3 (a gap of 2 turn/epoch).
+At which point all validations during that turn are available for reward collection.
+5. Any incorrect validations will be marked during the turn in between.
+
 
 ### Replicator behavior
 
 1. Since a replicator is somewhat of a light client and not downloading all the
-ledger data, they have to rely on other full nodes (validators) for
-information. Any given validator may or may not be malicious and give incorrect
-information, although there are not any obvious attack vectors that this could
-accomplish besides having the replicator do extra wasted work.  For many of the
-operations there are number of options depending on how paranoid a replicator
-is:
+ledger data, they have to rely on other validators and replicators for information.
+Any given validator may or may not be malicious and give incorrect information, although
+there are not any obvious attack vectors that this could accomplish besides having the
+replicator do extra wasted work.  For many of the operations there are a number of options
+depending on how paranoid a replicator is:
     - (a) replicator can ask a validator
     - (b) replicator can ask multiple validators
-    - (c) replicator can subscribe to the full transaction stream and generate
-      the information itself
-    - (d) replicator can subscribe to an abbreviated transaction stream to
-      generate the information itself
-2. A replicator obtains the PoH hash corresponding to the last key rotation
-along with its entry\_height.
+    - (c) replicator can ask other replicators
+    - (d) replicator can subscribe to the full transaction stream and generate
+      the information itself (assuming the slot is recent enough)
+    - (e) replicator can subscribe to an abbreviated transaction stream to
+      generate the information itself (assuming the slot is recent enough)
+2. A replicator obtains the PoH hash corresponding to the last turn with its slot.
 3. The replicator signs the PoH hash with its keypair. That signature is the
 seed used to pick the segment to replicate and also the encryption key. The
-replicator mods the signature with the entry\_height to get which segment to
+replicator mods the signature with the slot to get which segment to
 replicate.
 4. The replicator retrives the ledger by asking peer validators and
 replicators. See 6.5.
 5. The replicator then encrypts that segment with the key with chacha algorithm
-in CBC mode with NUM\_CHACHA\_ROUNDS of encryption.
-6. The replicator initializes a chacha rng with the signature from step 2 as
+in CBC mode with `NUM_CHACHA_ROUNDS` of encryption.
+6. The replicator initializes a chacha rng with the a signed recent PoH value as
 the seed.
-7. The replicator generates NUM\_STORAGE\_SAMPLES samples in the range of the
+7. The replicator generates `NUM_STORAGE_SAMPLES` samples in the range of the
 entry size and samples the encrypted segment with sha256 for 32-bytes at each
 offset value. Sampling the state should be faster than generating the encrypted
 segment.
 8. The replicator sends a PoRep proof transaction which contains its sha state
 at the end of the sampling operation, its seed and the samples it used to the
 current leader and it is put onto the ledger.
-9. The replicator then generates another set of offsets which it submits a fake
-proof with an incorrect sha state. It can be proven to be fake by providing the
-seed for the hash result.
-     - A fake proof should consist of a replicator hash of a signature of a PoH
-       value. That way when the replicator reveals the fake proof, it can be
-verified on chain.
-10. The replicator monitors the ledger, if it sees a fake proof integrated, it
-creates a challenge transaction and submits it to the current leader. The
-transacation proves the validator incorrectly validated a fake storage proof.
-The replicator is rewarded and the validator's staking balance is slashed or
-frozen.
+9. During a given turn the replicator should submit many proofs for the same segment
+and based on the `RATIO_OF_FAKE_PROOFS` some of those proofs must be fake.
+10. As the PoRep game enters the next turn, the replicator must submit a
+transaction with the mask of which proofs were fake during the last turn. This
+transaction will define the rewards for both replicators and validators.
+11. Finally for a turn N, as the PoRep game enters turn N + 3, replicator's proofs for
+turn N will be counted towards their rewards.
+
+
+### The PoRep Game
+
+The Proof of Replication game has 4 primary stages. For each "turn" multiple PoRep
+games can be in progress but each in a different stage.
+
+The 4 stages of the PoRep Game are as follows:
+
+1. Proof submission stage
+    - Replicators: submit as many proofs as possible during this stage
+    - Validators: No-op
+2. Proof verification stage
+    - Replicators: No-op
+    - Validators: Select replicators and verify their proofs from the previous turn
+3. Proof challenge stage
+    - Replicators: Submit the proof mask with justifications (for fake proofs submitted 2 turns ago)
+    - Validators: No-op
+4. Reward collection stage
+    - Replicators: Collect rewards for 3 turns ago
+    - Validators:  Collect rewards for 3 turns ago
+
+
+For each turn of the PoRep game, both Validators and Replicators evaluate each
+stage. The stages are run as separate transactions on the storage program.
 
 ### Finding who has a given block of ledger
 
-1. Validators monitor the transaction stream for storage mining proofs, and
-keep a mapping of ledger segments by entry\_height to public keys. When it sees
-a storage mining proof it updates this mapping and provides an RPC interface
-which takes an entry\_height and hands back a list of public keys.  The client
-then looks up in their cluster\_info table to see which network address that
-corresponds to and sends a repair request to retrieve the necessary blocks of
-ledger.
-2. Validators would need to prune this list which it could do by periodically
-looking at the oldest entries in its mappings and doing a network query to see
-if the storage host is still serving the first entry.
+1. Validators monitor the turns in the PoRep game and look at the rooted bank
+at turn boundaries for any proofs.
+2. Validators maintain a map of ledger segments and corresponding replicator public keys.
+The map is updated when a Validator processes a replicator's proofs for a segment.
+The validator provides an RPC interface to access the this map. Using this API, clients
+can map a segment to a replicator's network address (correlating it via cluster_info table).
+The clients can then send repair requests to the replicator to retrieve segments.
+3. Validators would need to invalidate this list every N turns.
 
 ## Sybil attacks
 
 For any random seed, we force everyone to use a signature that is derived from
-a PoH hash. Everyone must use the same count, so the same PoH hash is signed by
-every participant. The signatures are then each cryptographically tied to the
-keypair, which prevents a leader from grinding on the resulting value for more
-than 1 identity.
+a PoH hash at the turn boundary. Everyone uses the same count, so the same PoH
+hash is signed by every participant. The signatures are then each cryptographically
+tied to the keypair, which prevents a leader from grinding on the resulting
+value for more than 1 identity.
 
 Since there are many more client identities then encryption identities, we need
 to split the reward for multiple clients, and prevent Sybil attacks from
@@ -231,8 +185,7 @@ the network can reward long lived client identities more than new ones.
   showing the initial state for the hash.
 - If a validator marks real proofs as fake, no on-chain computation can be done
   to distinguish who is correct. Rewards would have to rely on the results from
-multiple validators in a stake-weighted fashion to catch bad actors and
-replicators from being locked out of the network.
+  multiple validators to catch bad actors and replicators from being denied rewards.
 - Validator stealing mining proof results for itself. The proofs are derived
   from a signature from a replicator, since the validator does not know the
 private key used to generate the encryption key, it cannot be the generator of

book/src/managing-forks.md

@@ -0,0 +1,63 @@
+# Managing Forks in the Ledger
+
+The ledger is permitted to fork at slot boundaries. The resulting data
+structure forms a tree called a *blocktree*. When the fullnode interprets the
+blocktree, it must maintain state for each fork in the chain. We call each
+instance an *active fork*.  It is the responsibility of a fullnode to weigh
+those forks, such that it may eventually select a fork.
+
+A fullnode selects a fork by submiting a vote to a slot leader on that fork.
+The vote commits the fullnode for a duration of time called a *lockout period*.
+The fullnode is not permitted to vote on a different fork until that lockout
+period expires. Each subsequent vote on the same fork doubles the length of the
+lockout period. After some cluster-configured number of votes (currently 32),
+the length of the lockout period reaches what's called *max lockout*. Until the
+max lockout is reached, the fullnode has the option to wait until the lockout
+period is over and then vote on another fork. When it votes on another fork, it
+performs a operation called *rollback*, whereby the state rolls back in time to
+a shared checkpoint and then jumps forward to the tip of the fork that it just
+voted on. The maximum distance that a fork may roll back is called the
+*rollback depth*. Rollback depth is the number of votes required to achieve
+max lockout. Whenever a fullnode votes, any checkpoints beyond the rollback
+depth become unreachable. That is, there is no scenario in which the fullnode
+will need to roll back beyond rollback depth. It therefore may safely *prune*
+unreachable forks and *squash* all checkpoints beyond rollback depth into the
+root checkpoint.
+
+## Active Forks
+
+An active fork is as a sequence of checkpoints that has a length at least one
+longer than the rollback depth. The shortest fork will have a length exactly
+one longer than the rollback depth.  For example:
+
+<img alt="Forks" src="img/forks.svg" class="center"/>
+
+The following sequences are *active forks*:
+
+* {4, 2, 1}
+* {5, 2, 1}
+* {6, 3, 1}
+* {7, 3, 1}
+
+## Pruning and Squashing
+
+A fullnode may vote on any checkpoint in the tree.  In the diagram above,
+that's every node except the leaves of the tree.  After voting, the fullnode
+prunes nodes that fork from a distance farther than the rollback depth and then
+takes the opportunity to minimize its memory usage by squashing any nodes it
+can into the root.
+
+Starting from the example above, wth a rollback depth of 2, consider a vote on
+5 versus a vote on 6. First, a vote on 5:
+
+<img alt="Forks after pruning" src="img/forks-pruned.svg" class="center"/>
+
+The new root is 2, and any active forks that are not descendants from 2 are
+pruned.
+
+Alternatively, a vote on 6:
+
+<img alt="Forks" src="img/forks-pruned2.svg" class="center"/>
+
+The tree remains with a root of 1, since the active fork starting at 6 is only
+2 checkpoints from the root.

book/src/passive-stake-delegation-and-rewards.md

@@ -0,0 +1,216 @@
+# Stake Delegation and Reward
+
+This design proposal focuses on the software architecture for the on-chain
+voting and staking programs.  Incentives for staking is covered in [staking
+rewards](staking-rewards.md).
+
+The current architecture requires a vote for each delegated stake from the
+validator, and therefore does not scale to allow replicator clients to
+automatically delegate their rewards.
+
+The design proposes a new set of programs for voting and stake delegation, The
+proposed programs allow many stake accounts to passively earn rewards with a
+single validator vote without permission or active involvement from the
+validator.
+
+## Current Design Problems
+
+In the current design each staker creates their own VoteState, and assigns a
+**delegate** in the VoteState that can submit votes.  Since the validator has to
+actively vote for each stake delegated to it, validators can censor stakes by
+not voting for them.
+
+The number of votes is equal to the number of stakers, and not the number of
+validators.  Replicator clients are expected to delegate their replication
+rewards as they are earned, and therefore the number of stakes is expected to be
+large compared to the number of validators in a long running cluster.
+
+## Proposed changes to the current design.
+
+The general idea is that instead of the staker, the validator will own the
+VoteState program. In this proposal the VoteState program is there to track
+validator votes, count validator generated credits and to provide any
+additional validator specific state.  The VoteState program is not aware of any
+stakes delegated to it, and has no staking weight.
+
+The rewards generated are proportional to the amount of lamports staked.  In
+this proposal stake state is stored as part of the StakeState program. This
+program is owned by the staker only.  Lamports stored in this program are the
+stake.  Unlike the current design, this program contains a new field to indicate
+which VoteState program the stake is delegated to.
+
+### VoteState
+
+VoteState is the current state of all the votes the **delegate** has submitted
+to the bank.  VoteState contains the following state information:
+
+* votes - The submitted votes data structure.
+
+* credits - The total number of rewards this vote program has generated over its
+lifetime.
+
+* root\_slot - The last slot to reach the full lockout commitment necessary for
+rewards.
+
+* commission - The commission taken by this VoteState for any rewards claimed by
+staker's StakeState accounts.  This is the percentage ceiling of the reward.
+
+* Account::lamports - The accumulated lamports from the commission.  These do not
+count as stakes.
+
+* `authorized_vote_signer` - Only this identity is authorized to submit votes, and
+this field can only modified by this entity
+
+### VoteInstruction::Initialize
+
+* `account[0]` - RW - The VoteState
+  `VoteState::authorized_vote_signer` is initialized to `account[0]`
+   other VoteState members defaulted
+
+### VoteInstruction::AuthorizeVoteSigner(Pubkey)
+
+* `account[0]` - RW - The VoteState
+  `VoteState::authorized_vote_signer` is set to to `Pubkey`, instruction must by
+   signed by Pubkey
+
+
+### StakeState
+
+A StakeState takes one of two forms, StakeState::Stake and StakeState::MiningPool.
+
+### StakeState::Stake
+
+Stake is the current delegation preference of the **staker**. Stake
+contains the following state information:
+
+* `voter_pubkey` - The pubkey of the VoteState instance the lamports are
+delegated to.
+
+* `credits_observed` - The total credits claimed over the lifetime of the
+program.
+
+* `stake` - The actual activated stake.
+
+* Account::lamports - Lamports available for staking, including any earned as rewards.
+
+
+### StakeState::MiningPool
+
+There are two approaches to the mining pool.  The bank could allow the
+StakeState program to bypass the token balance check, or a program representing
+the mining pool could run on the network.  To avoid a single network wide lock,
+the pool can be split into several mining pools.  This design focuses on using a
+StakeState::MiningPool as the cluster wide mining pools.
+
+* 256 StakeState::MiningPool are initialized, each with 1/256 number of mining pool
+tokens stored as `Account::lamports`.
+
+The stakes and the MiningPool are accounts that are owned by the same `Stake`
+program.
+
+### StakeInstruction::DelegateStake(stake)
+
+* `account[0]` - RW - The StakeState::Stake instance.
+  `StakeState::Stake::credits_observed` is initialized to `VoteState::credits`.
+  `StakeState::Stake::voter_pubkey` is initialized to `account[1]`
+  `StakeState::Stake::stake` is initialized to `stake`, as long as it's less than account[0].lamports
+
+* `account[1]` - R - The VoteState instance.
+
+### StakeInstruction::RedeemVoteCredits
+
+The VoteState program and the StakeState programs maintain a lifetime counter
+of total rewards generated and claimed.  Therefore an explicit `Clear`
+instruction is not necessary.  When claiming rewards, the total lamports
+deposited into the StakeState and as validator commission is proportional to
+`VoteState::credits - StakeState::credits_observed`.
+
+
+* `account[0]` - RW - The StakeState::MiningPool instance that will fulfill the
+reward.
+* `account[1]` - RW - The StakeState::Stake instance that is redeeming votes
+credits.
+* `account[2]` - R - The VoteState instance, must be the same as
+`StakeState::voter_pubkey`
+
+Reward is payed out for the difference between `VoteState::credits` to
+`StakeState::Delgate.credits_observed`, and `credits_observed` is updated to
+`VoteState::credits`.  The commission is deposited into the `VoteState` token
+balance, and the reward is deposited to the `StakeState::Stake` token balance.  The
+reward and the commission is weighted by the `StakeState::lamports` divided by total lamports staked.
+
+The Staker or the owner of the Stake program sends a transaction with this
+instruction to claim the reward.
+
+Any random MiningPool can be used to redeem the credits.
+
+```rust,ignore
+let credits_to_claim = vote_state.credits - stake_state.credits_observed;
+stake_state.credits_observed = vote_state.credits;
+```
+
+`credits_to_claim` is used to compute the reward and commission, and
+`StakeState::Stake::credits_observed` is updated to the latest
+`VoteState::credits` value.
+
+### Collecting network fees into the MiningPool
+
+At the end of the block, before the bank is frozen, but after it processed all
+the transactions for the block, a virtual instruction is executed to collect
+the transaction fees.
+
+* A portion of the fees are deposited into the leader's account.
+* A portion of the fees are deposited into the smallest StakeState::MiningPool
+account.
+
+### Benefits
+
+* Single vote for all the stakers.
+
+* Clearing of the credit variable is not necessary for claiming rewards.
+
+* Each delegated stake can claim its rewards independently.
+
+* Commission for the work is deposited when a reward is claimed by the delegated
+stake.
+
+This proposal would benefit from the `read-only` accounts proposal to allow for
+many rewards to be claimed concurrently.
+
+## Passive Delegation
+
+Any number of instances of StakeState::Stake programs can delegate to a single
+VoteState program without an interactive action from the identity controlling
+the VoteState program or submitting votes to the program.
+
+The total stake allocated to a VoteState program can be calculated by the sum of
+all the StakeState programs that have the VoteState pubkey as the
+`StakeState::Stake::voter_pubkey`.
+
+## Example Callflow
+
+<img alt="Passive Staking Callflow" src="img/passive-staking-callflow.svg" class="center"/>
+
+## Future work
+
+Validators may want to split the stake delegated to them amongst many validator
+nodes since stake is used as weight in the network control and data planes.  One
+way to implement this would be for the StakeState to delegate to a pool of
+validators instead of a single one.
+
+Instead of a single `vote_pubkey` and `credits_observed` entry in the StakeState
+program, the program can be initialized with a vector of tuples.
+
+```rust,ignore
+Voter {
+    voter_pubkey: Pubkey,
+    credits_observed: u64,
+    weight: u8,
+}
+```
+
+* voters: Vec<Voter> - Array of VoteState accounts that are voting rewards with
+this stake.
+
+A StakeState program would claim a fraction of the reward from each voter in
+the `voters` array, and each voter would be delegated a fraction of the stake.

book/src/performance-metrics.md

@@ -0,0 +1,29 @@
+# Performance Metrics
+
+Solana cluster performance is measured as average number of transactions per second
+that the network can sustain (TPS). And, how long it takes for a transaction to be
+confirmed by super majority of the cluster (Confirmation Time).
+
+Each cluster node maintains various counters that are incremented on certain events.
+These counters are periodically uploaded to a cloud based database. Solana's metrics
+dashboard fetches these counters, and computes the performance metrics and displays
+it on the dashboard. 
+
+## TPS
+
+The leader node's banking stage maintains a count of transactions that it recorded.
+The dashboard displays the count averaged over 2 second period in the TPS time series
+graph. The dashboard also shows per second mean, maximum and total TPS as a running
+counter.
+
+## Confirmation Time
+
+Each validator node maintains a list of active ledger forks that are visible to the node.
+A fork is considered to be frozen when the node has received and processed all entries
+corresponding to the fork. A fork is considered to be confirmed when it receives cumulative
+super majority vote, and when one of its children forks is frozen.
+
+The node assigns a timestamp to every new fork, and computes the time it took to confirm
+the fork. This time is reflected as validator confirmation time in performance metrics.
+The performance dashboard displays the average of each validator node's confirmation time
+as a time series graph. 

book/src/persistent-account-storage.md

@@ -0,0 +1,153 @@
+# Persistent Account Storage
+
+The set of Accounts represent the current computed state of all the transactions
+that have been processed by a fullnode.  Each fullnode needs to maintain this
+entire set.  Each block that is proposed by the network represents a change to
+this set, and since each block is a potential rollback point the changes need to
+be reversible.
+
+Persistent storage like NVMEs are 20 to 40 times cheaper than DDR.  The problem
+with persistent storage is that write and read performance is much slower than
+DDR and care must be taken in how data is read or written to.  Both reads and
+writes can be split between multiple storage drives and accessed in parallel.
+This design proposes a data structure that allows for concurrent reads and
+concurrent writes of storage.   Writes are optimized by using an AppendVec data
+structure, which allows a single writer to append while allowing access to many
+concurrent readers.  The accounts index maintains a pointer to a spot where the
+account was appended to every fork, thus removing the need for explicit
+checkpointing of state.
+
+# AppendVec
+
+AppendVec is a data structure that allows for random reads concurrent with a
+single append-only writer.  Growing or resizing the capacity of the AppendVec
+requires exclusive access.  This is implemented with an atomic `offset`, which
+is updated at the end of a completed append.
+
+The underlying memory for an AppendVec is a memory-mapped file.  Memory-mapped
+files allow for fast random access and paging is handled by the OS.
+
+# Account Index
+
+The account index is designed to support a single index for all the currently
+forked Accounts.
+
+```rust,ignore
+type AppendVecId = usize;
+
+type Fork = u64;
+
+struct AccountMap(Hashmap<Fork, (AppendVecId, u64)>);
+
+type AccountIndex = HashMap<Pubkey, AccountMap>;
+
+```
+
+The index is a map of account Pubkeys to a map of Forks and the location of the
+Account data in an AppendVec.  To get the version of an account for a specific Fork:
+
+```rust,ignore
+/// Load the account for the pubkey.
+/// This function will load the account from the specified fork, falling back to the fork's parents
+/// * fork - a virtual Accounts instance, keyed by Fork.  Accounts keep track of their parents with Forks,
+///       the persistent store
+/// * pubkey - The Account's public key.
+pub fn load_slow(&self, id: Fork, pubkey: &Pubkey) -> Option<&Account>
+```
+
+The read is satisfied by pointing to a memory-mapped location in the
+`AppendVecId` at the stored offset.  A reference can be returned without a copy.
+
+## Root Forks
+
+The [fork selection algorithm](fork-selection.md) eventually selects a fork as a
+root fork and the fork is squashed.  A squashed/root fork cannot be rolled back.
+
+When a fork is squashed, all accounts in its parents not already present in the
+fork are pulled up into the fork by updating the indexes.  Accounts with zero
+balance in the squashed fork are removed from fork by updating the indexes.
+
+An account can be *garbage-collected* when squashing makes it unreachable.
+
+Three possible options exist:
+
+* Maintain a HashSet<u64> of root forks.  One is expected to be created every
+second.  The entire tree can be garbage-collected later. Alternatively, if
+every fork keeps a reference count of accounts, garbage collection could occur
+any time an index location is updated.
+
+* Remove any pruned forks from the index.  Any remaining forks lower in number
+than the root are can be considered root.
+
+* Scan the index, migrate any old roots into the new one.   Any remaining forks
+lower than the new root can be deleted later.
+
+# Append-only Writes
+
+All the updates to Accounts occur as append-only updates.  For every account
+update, a new version is stored in the AppendVec.
+
+It is possible to optimize updates within a single fork by returning a mutable
+reference to an already stored account in a fork.  The Bank already tracks
+concurrent access of accounts and guarantees that a write to a specific account
+fork will not be concurrent with a read to an account at that fork. To support
+this operation, AppendVec should implement this function:
+
+```rust,ignore
+fn get_mut(&self, index: u64) -> &mut T;
+```
+
+This API allows for concurrent mutable access to a memory region at `index`.  It
+relies on the Bank to guarantee exclusive access to that index.
+
+# Garbage collection
+
+As accounts get updated, they move to the end of the AppendVec.  Once capacity
+has run out, a new AppendVec can be created and updates can be stored there.
+Eventually references to an older AppendVec will disappear because all the
+accounts have been updated, and the old AppendVec can be deleted.
+
+To speed up this process, it's possible to move Accounts that have not been
+recently updated to the front of a new AppendVec.  This form of garbage
+collection can be done without requiring exclusive locks to any of the data
+structures except for the index update.
+
+The initial implementation for garbage collection is that once all the accounts in
+an AppendVec become stale versions, it gets reused. The accounts are not updated
+or moved around once appended.
+
+# Index Recovery
+
+Each bank thread has exclusive access to the accounts during append, since the
+accounts locks cannot be released until the data is committed. But there is no
+explicit order of writes between the separate AppendVec files.  To create an
+ordering, the index maintains an atomic write version counter.  Each append to
+the AppendVec records the index write version number for that append in the
+entry for the Account in the AppendVec.
+
+To recover the index, all the AppendVec files can be read in any order, and the
+latest write version for every fork should be stored in the index.
+
+# Snapshots
+
+To snapshot, the underlying memory-mapped files in the AppendVec need to be
+flushed to disk.  The index can be written out to disk as well.
+
+# Performance
+
+* Append-only writes are fast.  SSDs and NVMEs, as well as all the OS level
+kernel data structures, allow for appends to run as fast as PCI or NVMe bandwidth
+will allow (2,700 MB/s).
+
+* Each replay and banking thread writes concurrently to its own AppendVec.
+
+* Each AppendVec could potentially be hosted on a separate NVMe.
+
+* Each replay and banking thread has concurrent read access to all the
+AppendVecs without blocking writes.
+
+* Index requires an exclusive write lock for writes.  Single-thread performance
+for HashMap updates is on the order of 10m per second.
+
+* Banking and Replay stages should use 32 threads per NVMe.  NVMes have
+optimal performance with 32 concurrent readers or writers.

book/src/programs.md

@@ -3,8 +3,8 @@
 A client *app* interacts with a Solana cluster by sending it *transactions*
 with one or more *instructions*. The Solana *runtime* passes those instructions
 to user-contributed *programs*. An instruction might, for example, tell a
-program to move *tokens* from one *account* to another or create an interactive
-contract that governs how tokens are moved. Instructions are executed
+program to transfer *lamports* from one *account* to another or create an interactive
+contract that governs how lamports are transfered. Instructions are executed
 atomically. If any instruction is invalid, any changes made within the
 transaction are discarded.
 
@@ -21,9 +21,7 @@ used to reference the program in subsequent transactions.
 A program may be written in any programming language that can target the
 Berkley Packet Filter (BPF) safe execution environment. The Solana SDK offers
 the best support for C programs, which is compiled to BPF using the [LLVM
-compiler infrastructure](https://llvm.org). Alternatively, a client might
-choose to bypass LLVM and use Python, Lua or C++ to generate BPF directly via
-the [BPF Compiler Collection](https://github.com/iovisor/bcc) (BCC).
+compiler infrastructure](https://llvm.org).
 
 ## Storing State between Transactions
 

book/src/reliable-vote-transmission.md

@@ -0,0 +1,124 @@
+# Reliable Vote Transmission
+
+Validator votes are messages that have a critical function for consensus and
+continuous operation of the network. Therefore it is critical that they are
+reliably delivered and encoded into the ledger.
+
+## Challenges
+
+1. Leader rotation is triggered by PoH, which is clock with high drift.  So many
+nodes are likely to have an incorrect view if the next leader is active in
+realtime or not.
+
+2. The next leader may be easily be flooded.  Thus a DDOS would not only prevent
+delivery of regular transactions, but also consensus messages.
+
+3. UDP is unreliable, and our asynchronous protocol requires any message that is
+transmitted to be retransmitted until it is observed in the ledger.
+Retransmittion could potentially cause an unintentional *thundering herd*
+against the leader with a large number of validators.  Worst case flood would be
+`(num_nodes * num_retransmits)`.
+
+4. Tracking if the vote has been transmitted or not via the ledger does not
+guarantee it will appear in a confirmed block.  The current observed block may
+be unrolled. Validators would need to maintain state for each vote and fork.
+
+
+## Design
+
+1. Send votes as a push message through gossip.  This ensures delivery of the
+vote to all the next leaders, not just the next future one.
+
+2. Leaders will read the Crds table for new votes and encode any new received
+votes into the blocks they propose.  This allows for validator votes to be
+included in rollback forks by all the future leaders.
+
+3. Validators that receive votes in the ledger will add them to their local crds
+table, not as a push request, but simply add them to the table.  This shortcuts
+the push message protocol, so the validation messages do not need to be
+retransmitted twice around the network.
+
+4. CrdsValue for vote should look like this ``` Votes(Vec<Transaction>) ```
+
+Each vote transaction should maintain a `wallclock` in its data.  The merge
+strategy for Votes will keep the last N set of votes as configured by the local
+client.  For push/pull the vector is traversed recursively and each Transaction
+is treated as an individual CrdsValue with its own local wallclock and
+signature.
+
+Gossip is designed for efficient propagation of state.  Messages that are sent
+through gossip-push are batched and propagated with a minimum spanning tree to
+the rest of the network. Any partial failures in the tree are actively repaired
+with the gossip-pull protocol while minimizing the amount of data transfered
+between any nodes.
+
+
+## How this design solves the Challenges
+
+1. Because there is no easy way for validators to be in sync with leaders on the
+leader's "active" state, gossip allows for eventual delivery regardless of that
+state.
+
+2. Gossip will deliver the messages to all the subsequent leaders, so if the
+current leader is flooded the next leader would have already received these
+votes and is able to encode them.
+
+3. Gossip minimizes the number of requests through the network by maintaining an
+efficient spanning tree, and using bloom filters to repair state.  So retransmit
+back-off is not necessary and messages are batched.
+
+4. Leaders that read the crds table for votes will encode all the new valid
+votes that appear in the table.  Even if this leader's block is unrolled, the
+next leader will try to add the same votes without any additional work done by
+the validator.  Thus ensuring not only eventual delivery, but eventual encoding
+into the ledger.
+
+
+## Performance
+
+1. Worst case propagation time to the next leader is Log(N) hops with a base
+depending on the fanout.  With our current default fanout of 6, it is about 6
+hops to 20k nodes.
+
+2. The leader should receive 20k validation votes aggregated by gossip-push into
+64kb blobs. Which would reduce the number of packets for 20k network to 80
+blobs.
+
+3. Each validators votes is replicated across the entire network.  To maintain a
+queue of 5 previous votes the Crds table would grow by 25 megabytes.  `(20,000
+nodes * 256 bytes * 5)`.
+
+## Two step implementation rollout
+
+Initially the network can perform reliably with just 1 vote transmitted and
+maintained through the network with the current Vote implementation.  For small
+networks a fanout of 6 is sufficient.  With small network the memory and push
+overhead is minor.
+
+### Sub 1k validator network
+
+1. Crds just maintains the validators latest vote.
+
+2. Votes are pushed and retransmitted regardless if they are appearing in the
+ledger.
+
+3. Fanout of 6.
+
+* Worst case 256kb memory overhead per node.
+* Worst case 4 hops to propagate to every node.
+* Leader should receive the entire validator vote set in 4 push message blobs.
+
+### Sub 20k network
+
+Everything above plus the following:
+
+1. CRDS table maintains a vector of 5 latest validator votes.
+
+2. Votes encode a wallclock.  CrdsValue::Votes is a type that recurses into the
+transaction vector for all the gossip protocols.
+
+3. Increase fanout to 20.
+
+* Worst case 25mb memory overhead per node.
+* Sub 4 hops worst case to deliver to the entire network.
+* 80 blobs received by the leader for all the validator messages.

book/src/repair-service.md

@@ -0,0 +1,51 @@
+# Repair Service
+
+The RepairService is in charge of retrieving missing blobs that failed to be delivered by primary communication protocols like Avalanche. It is in charge of managing the protocols described below in the `Repair Protocols` section below.  
+
+# Challenges:
+
+1) Validators can fail to receive particular blobs due to network failures
+
+2) Consider a scenario where blocktree contains the set of slots {1, 3, 5}. Then Blocktree receives blobs for some slot 7, where for each of the blobs b, b.parent == 6, so then the parent-child relation 6 -> 7 is stored in blocktree. However, there is no way to chain these slots to any of the existing banks in Blocktree, and thus the `Blob Repair` protocol will not repair these slots. If these slots happen to be part of the main chain, this will halt replay progress on this node.
+
+3) Validators that find themselves behind the cluster by an entire epoch struggle/fail to catch up because they do not have a leader schedule for future epochs. If nodes were to blindly accept repair blobs in these future epochs, this exposes nodes to spam.
+
+# Repair Protocols
+
+The repair protocol makes best attempts to progress the forking structure of Blocktree. 
+
+The different protocol strategies to address the above challenges:
+
+1. Blob Repair (Addresses Challenge #1): 
+    This is the most basic repair protocol, with the purpose of detecting and filling "holes" in the ledger. Blocktree tracks the latest root slot. RepairService will then periodically iterate every fork in blocktree starting from the root slot, sending repair requests to validators for any missing blobs. It will send at most some `N` repair reqeusts per iteration.
+
+    Note: Validators will only accept blobs within the current verifiable epoch (epoch the validator has a leader schedule for).
+
+2. Preemptive Slot Repair (Addresses Challenge #2):
+    The goal of this protocol is to discover the chaining relationship of "orphan" slots that do not currently chain to any known fork. 
+
+    * Blocktree will track the set of "orphan" slots in a separate column family. 
+
+    * RepairService will periodically make `RequestOrphan` requests for each of the orphans in blocktree. 
+
+    `RequestOrphan(orphan)` request - `orphan` is the orphan slot that the requestor wants to know the parents of
+    `RequestOrphan(orphan)` response - The highest blobs for each of the first `N` parents of the requested `orphan` 
+
+    On receiving the responses `p`, where `p` is some blob in a parent slot, validators will:
+        * Insert an empty `SlotMeta` in blocktree for `p.slot` if it doesn't already exist.
+        * If `p.slot` does exist, update the parent of `p` based on `parents`
+
+    Note: that once these empty slots are added to blocktree, the `Blob Repair` protocol should attempt to fill those slots.
+
+    Note: Validators will only accept responses containing blobs within the current verifiable epoch (epoch the validator has a leader schedule for).
+
+3. Repairmen (Addresses Challenge #3):
+    This part of the repair protocol is the primary mechanism by which new nodes joining the cluster catch up after loading a snapshot. This protocol works in a "forward" fashion, so validators can verify every blob that they receive against a known leader schedule.
+
+    Each validator advertises in gossip:
+        * Current root
+        * The set of all completed slots in the confirmed epochs (an epoch that was calculated based on a bank <= current root) past the current root
+
+    Observers of this gossip message with higher epochs (repairmen) send blobs to catch the lagging node up with the rest of the cluster. The repairmen are responsible for sending the slots within the epochs that are confrimed by the advertised `root` in gossip. The repairmen divide the responsibility of sending each of the missing slots in these epochs based on a random seed (simple blob.index iteration by N, seeded with the repairman's node_pubkey). Ideally, each repairman in an N node cluster (N nodes whose epochs are higher than that of the repairee) sends 1/N of the missing blobs. Both data and coding blobs for missing slots are sent. Repairmen do not send blobs again to the same validator until they see the message in gossip updated, at which point they perform another iteration of this protocol.
+
+    Gossip messages are updated every time a validator receives a complete slot within the epoch. Completed slots are detected by blocktree and sent over a channel to RepairService. It is important to note that we know that by the time a slot X is complete, the epoch schedule must exist for the epoch that contains slot X because WindowService will reject blobs for unconfirmed epochs. When a newly completed slot is detected, we also update the current root if it has changed since the last update. The root is made available to RepairService through Blocktree, which holds the latest root.

book/src/runtime.md

@@ -6,7 +6,7 @@ separating program code from the state it operates on, the runtime is able to
 choreograph concurrent access. Transactions accessing only credit-only
 accounts are executed in parallel whereas transactions accessing writable
 accounts are serialized.  The runtime interacts with the program through an
-entrypoint with a well-defined interface.  The userdata stored in an account is
+entrypoint with a well-defined interface.  The data stored in an account is
 an opaque type, an array of bytes. The program has full control over its
 contents.
 
@@ -18,7 +18,7 @@ transaction fails to commit.
 
 ### Account Structure
 
-Accounts maintain a token balance and program-specific memory.
+Accounts maintain a lamport balance and program-specific memory.
 
 # Transaction Engine
 
@@ -27,58 +27,90 @@ entrypoint.
 
 ## Execution
 
-Transactions are batched and processed in a pipeline
+Transactions are batched and processed in a pipeline.  The TPU and TVU follow a
+slightly different path.  The TPU runtime ensures that PoH record occurs before
+memory is committed.
+
+The TVU runtime ensures that PoH verification occurs before the runtime
+processes any transactions.
 
 <img alt="Runtime pipeline" src="img/runtime.svg" class="center"/>
 
-At the *execute* stage, the loaded pages have no data dependencies, so all the
+At the *execute* stage, the loaded accounts have no data dependencies, so all the
 programs can be executed in parallel.
 
 The runtime enforces the following rules:
 
 1. Only the *owner* program may modify the contents of an account.  This means
-   that upon assignment userdata vector is guaranteed to be zero.
+that upon assignment data vector is guaranteed to be zero.
+
 2. Total balances on all the accounts is equal before and after execution of a
-   transaction.
+transaction.
+
 3. After the transaction is executed, balances of credit-only accounts must be
-   greater than or equal to the balances before the transaction.
+greater than or equal to the balances before the transaction.
+
 4. All instructions in the transaction executed atomically. If one fails, all
-   account modifications are discarded.
+account modifications are discarded.
 
 Execution of the program involves mapping the program's public key to an
 entrypoint which takes a pointer to the transaction, and an array of loaded
-pages.
+accounts.
 
 ## SystemProgram Interface
 
-The interface is best described by the `Instruction::userdata` that the user
+The interface is best described by the `Instruction::data` that the user
 encodes.
 
-* `CreateAccount` - This allows the user to create and assign an account to a
-  Program.
-* `Assign` - allows the user to assign an existing account to a program.
-* `Move`  - moves tokens between account's that are associated with
-* `Spawn` - spawn a new program from an account
+* `CreateAccount` - This allows the user to create an account with an allocated
+data array and assign it to a Program.
+
+* `Assign` - Allows the user to assign an existing account to a program.
+
+* `Transfer`  - Transfers lamports between accounts.
+
+## Program State Security
+
+For blockchain to function correctly, the program code must be resilient to user
+inputs.  That is why in this design the program specific code is the only code
+that can change the state of the data byte array in the Accounts that are
+assigned to it.  It is also the reason why `Assign` or `CreateAccount` must zero
+out the data.  Otherwise there would be no possible way for the program to
+distinguish the recently assigned account data from a natively generated
+state transition without some additional metadata from the runtime to indicate
+that this memory is assigned instead of natively generated.
+
+To pass messages between programs, the receiving program must accept the message
+and copy the state over.  But in practice a copy isn't needed and is
+undesirable. The receiving program can read the state belonging to other
+Accounts without copying it, and during the read it has a guarantee of the
+sender program's state.
 
 ## Notes
 
-1. There is no dynamic memory allocation.  Client's need to use `CreateAccount`
+* There is no dynamic memory allocation.  Client's need to use `CreateAccount`
 instructions to create memory before passing it to another program.  This
 instruction can be composed into a single transaction with the call to the
 program itself.
-2. Runtime guarantees that when memory is assigned to the program it is zero
-initialized.
-3. Runtime guarantees that a program's code is the only thing that can modify
-memory that its assigned to
-4. Runtime guarantees that the program can only spend tokens that are in
-accounts that are assigned to it
-5. Runtime guarantees the balances belonging to accounts are balanced before
-and after the transaction
-6. Runtime guarantees that multiple instructions all executed successfully when
-a transaction is committed.
+
+* `CreateAccount` and `Assign` guarantee that when account is assigned to the
+program, the Account's data is zero initialized.
+
+* Once assigned to program an Account cannot be reassigned.
+
+* Runtime guarantees that a program's code is the only code that can modify
+Account data that the Account is assigned to.
+
+* Runtime guarantees that the program can only spend lamports that are in
+accounts that are assigned to it.
+
+* Runtime guarantees the balances belonging to accounts are balanced before
+and after the transaction.
+
+* Runtime guarantees that instructions all executed successfully when a
+transaction is committed.
 
 # Future Work
 
 * [Continuations and Signals for long running
   Transactions](https://github.com/solana-labs/solana/issues/1485)
-

book/src/stake-delegation-and-rewards.md

@@ -0,0 +1,201 @@
+# Stake Delegation and Rewards
+
+Stakers are rewarded for helping to validate the ledger. They do this by
+delegating their stake to validator nodes. Those validators do the legwork of
+replaying the ledger and send votes to a per-node vote account to which stakers
+can delegate their stakes.  The rest of the cluster uses those stake-weighted
+votes to select a block when forks arise. Both the validator and staker need
+some economic incentive to play their part. The validator needs to be
+compensated for its hardware and the staker needs to be compensated for the risk
+of getting its stake slashed.  The economics are covered in [staking
+rewards](staking-rewards.md).  This chapter, on the other hand, describes the
+underlying mechanics of its implementation.
+
+## Basic Design
+
+The general idea is that the validator owns a Vote account. The Vote account
+tracks validator votes, counts validator generated credits, and provides any
+additional validator specific state.  The Vote account is not aware of any
+stakes delegated to it and has no staking weight.
+
+A separate Stake account (created by a staker) names a Vote account to which the
+stake is delegated.  Rewards generated are proportional to the amount of
+lamports staked.  The Stake account is owned by the staker only.  Lamports
+stored in this account are the stake.
+
+## Passive Delegation
+
+Any number of Stake accounts can delegate to a single
+Vote account without an interactive action from the identity controlling
+the Vote account or submitting votes to the account.
+
+The total stake allocated to a Vote account can be calculated by the sum of
+all the Stake accounts that have the Vote account pubkey as the
+`StakeState::Delegate::voter_pubkey`.
+
+## Vote and Stake accounts
+
+The rewards process is split into two on-chain programs. The Vote program solves
+the problem of making stakes slashable. The Stake account acts as custodian of
+the rewards pool, and provides passive delegation. The Stake program is
+responsible for paying out each staker once the staker proves to the Stake
+program that its delegate has participated in validating the ledger.
+
+### VoteState
+
+VoteState is the current state of all the votes the validator has submitted to
+the network. VoteState contains the following state information:
+
+* votes - The submitted votes data structure.
+
+* credits - The total number of rewards this vote program has generated over its
+lifetime.
+
+* root\_slot - The last slot to reach the full lockout commitment necessary for
+rewards.
+
+* commission - The commission taken by this VoteState for any rewards claimed by
+staker's Stake accounts.  This is the percentage ceiling of the reward.
+
+* Account::lamports - The accumulated lamports from the commission.  These do not
+count as stakes.
+
+* `authorized_vote_signer` - Only this identity is authorized to submit votes. This field can only modified by this identity.
+
+### VoteInstruction::Initialize
+
+* `account[0]` - RW - The VoteState
+  `VoteState::authorized_vote_signer` is initialized to `account[0]`
+   other VoteState members defaulted
+
+### VoteInstruction::AuthorizeVoteSigner(Pubkey)
+
+* `account[0]` - RW - The VoteState
+  `VoteState::authorized_vote_signer` is set to to `Pubkey`, instruction must by
+   signed by Pubkey
+
+### VoteInstruction::Vote(Vec<Vote>)
+
+* `account[0]` - RW - The VoteState
+  `VoteState::lockouts` and `VoteState::credits` are updated according to voting lockout rules see [Fork Selection](fork-selection.md)
+
+
+* `account[1]` - RO - A list of some N most recent slots and their hashes for the vote to be verified against.
+
+
+### StakeState
+
+A StakeState takes one of two forms, StakeState::Delegate and StakeState::MiningPool.
+
+### StakeState::Delegate
+
+StakeState is the current delegation preference of the **staker**. StakeState
+contains the following state information:
+
+* Account::lamports - The staked lamports.
+
+* `voter_pubkey` - The pubkey of the VoteState instance the lamports are
+delegated to.
+
+* `credits_observed` - The total credits claimed over the lifetime of the
+program.
+
+### StakeState::MiningPool
+
+There are two approaches to the mining pool.  The bank could allow the
+StakeState program to bypass the token balance check, or a program representing
+the mining pool could run on the network.  To avoid a single network wide lock,
+the pool can be split into several mining pools.  This design focuses on using
+StakeState::MiningPool instances as the cluster wide mining pools.
+
+* 256 StakeState::MiningPool are initialized, each with 1/256 number of mining pool
+tokens stored as `Account::lamports`.
+
+The stakes and the MiningPool are accounts that are owned by the same `Stake`
+program.
+
+<<<<<<< HEAD
+### StakeInstruction::Initialize
+=======
+The Stake account is moved from Uninitialized to StakeState::Stake form.  This is
+how stakers choose their initial delegate validator node and activate their
+stake account lamports.
+>>>>>>> 25080f1a3... fix book typos (#5185)
+
+* `account[0]` - RW - The StakeState::Delegate instance.
+  `StakeState::Delegate::credits_observed` is initialized to `VoteState::credits`.
+  `StakeState::Delegate::voter_pubkey` is initialized to `account[1]`
+
+* `account[1]` - R - The VoteState instance.
+
+### StakeInstruction::RedeemVoteCredits
+
+The Staker or the owner of the Stake account sends a transaction with this
+instruction to claim rewards.
+
+The Vote account and the Stake account pair maintain a lifetime counter
+of total rewards generated and claimed.  When claiming rewards, the total lamports
+deposited into the Stake account and as validator commission is proportional to
+`VoteState::credits - StakeState::credits_observed`.
+
+
+* `account[0]` - RW - The StakeState::MiningPool instance that will fulfill the
+reward.
+* `account[1]` - RW - The StakeState::Delegate instance that is redeeming votes
+credits.
+* `account[2]` - R - The VoteState instance, must be the same as
+`StakeState::voter_pubkey`
+
+Reward is paid out for the difference between `VoteState::credits` to
+`StakeState::Delgate.credits_observed`, and `credits_observed` is updated to
+`VoteState::credits`.  The commission is deposited into the Vote account token
+balance, and the reward is deposited to the Stake account token balance.
+
+The total lamports paid is a percentage-rate of the lamports staked muiltplied by
+the ratio of rewards being redeemed to rewards that could have been generated
+during the rate period.
+
+Any random MiningPool can be used to redeem the credits.
+
+```rust,ignore
+let credits_to_claim = vote_state.credits - stake_state.credits_observed;
+stake_state.credits_observed = vote_state.credits;
+```
+
+`credits_to_claim` is used to compute the reward and commission, and
+`StakeState::Delegate::credits_observed` is updated to the latest
+`VoteState::credits` value.
+
+## Collecting network fees into the MiningPool
+
+At the end of the block, before the bank is frozen, but after it processed all
+the transactions for the block, a virtual instruction is executed to collect
+the transaction fees.
+
+* A portion of the fees are deposited into the leader's account.
+* A portion of the fees are deposited into the smallest StakeState::MiningPool
+account.
+
+## Authorizing a Vote Signer
+
+`VoteInstruction::AuthorizeVoter` allows a staker to choose a signing service
+for its votes. That service is responsible for ensuring the vote won't cause
+the staker to be slashed.
+
+## Benefits of the design
+
+* Single vote for all the stakers.
+
+* Clearing of the credit variable is not necessary for claiming rewards.
+
+* Each delegated stake can claim its rewards independently.
+
+* Commission for the work is deposited when a reward is claimed by the delegated
+stake.
+
+This proposal would benefit from the `read-only` accounts proposal to allow for
+many rewards to be claimed concurrently.
+
+## Example Callflow
+
+<img alt="Passive Staking Callflow" src="img/passive-staking-callflow.svg" class="center"/>

book/src/staking-rewards.md

@@ -1,8 +1,8 @@
 # Staking Rewards
 
-Initial Proof of Stake (PoS) (i.e. using in-protocol asset, SOL, to provide
-secure consensus) design ideas outlined here. Solana will implement a proof of
-stake reward/security scheme for node validators in the cluster. The purpose is
+A Proof of Stake (PoS), (i.e. using in-protocol asset, SOL, to provide
+secure consensus) design is outlined here. Solana implements a proof of
+stake reward/security scheme for validator nodes in the cluster. The purpose is
 threefold:
 
 - Align validator incentives with that of the greater cluster through
@@ -22,8 +22,7 @@ specific attributes to be modified as is allowed by Solana's Proof of History
 
 ### General Overview
 
-Solana's ledger validation design is based on a rotating, stake-weighted
-randomly selected leader broadcasting transactions in a PoH data
+Solana's ledger validation design is based on a rotating, stake-weighted selected leader broadcasting transactions in a PoH data
 structure to validating nodes. These nodes, upon receiving the leader's
 broadcast, have the opportunity to vote on the current state and PoH height by
 signing a transaction into the PoH stream.
@@ -49,44 +48,13 @@ specific parameters will be necessary:
 
 Solana's trustless sense of time and ordering provided by its PoH data
 structure, along with its
-[avalanche](https://www.youtube.com/watch?v=qt_gDRXHrHQ&t=1s) data broadcast
-and transmission design, should provide subsecond confirmation times that scale
+[turbine](https://www.youtube.com/watch?v=qt_gDRXHrHQ&t=1s) data broadcast
+and transmission design, should provide sub-second transaction confirmation times that scale
 with the log of the number of nodes in the cluster. This means we shouldn't
 have to restrict the number of validating nodes with a prohibitive 'minimum
 deposits' and expect nodes to be able to become validators with nominal amounts
-of SOL staked. This should also render validation pools, a proposed solution
-for economic censorship imposed by minimum staking amounts currently described
-in Casper, unnecessary and remove the concern for needing to put slashable
-stake at risk while relying on others to play by the rules.
+of SOL staked. At the same time, Solana's focus on high-throughput should create incentive for validation clients to provide high-performant and reliable hardware. Combined with potential a minimum network speed threshold to join as a validation-client, we expect a healthy validation delegation market to emerge. To this end, Solana's testnet will lead into a "Tour de SOL" validation-client competition, focusing on throughput and uptime to rank and reward testnet validators.
 
-### Stake-weighted Rewards
-
-Rewards are expected to be paid out to active validators as a function of
-validator activity and as a proportion of the percentage of SOL they have at
-stake out of the entirety of the staking pool.
-
-We expect to define a baseline annual validator payout/inflation rate based on
-the total SOL deposited. E.g. 10% annual interest on SOL deposited with X total
-SOL deposited as slashable on the cluster. This is the same design as currently
-proposed in Casper FFG which has additionally specifies how inflation rates
-adjust as a function of total ETH deposited. Specifically, Casper validator
-returns are proportional to the inverse square root of the total deposits and
-initial annual rates are estimated as:
-
-| Deposit Size | Annual Validator Interest |
-|-------------:|--------------------------:|
-| 2.5M ETH     | 10.12%                    |
-| 10M ETH      | 5.00%                     |
-| 20M ETH      | 3.52%                     |
-| 40M ETH      | 2.48%                     |
-
-This has the nice property of potentially incentivizing participation around a
-target deposit size. Incentivisation of specific participation rates more
-directly (rather than deposit size) may something also worth exploring.
-
-The specifics of the Solana validator reward scheme are to be worked out in
-parallel with a design for transaction fee assignment as well as our storage
-mining reward scheme.
 
 ### Slashing rules
 
@@ -96,7 +64,7 @@ capital-at-risk to prevent a logical/optimal strategy of multiple chain voting.
 We intend to implement slashing rules which, if broken, result some amount of
 the offending validator's deposited stake to be removed from circulation. Given
 the ordering properties of the PoH data structure, we believe we can simplify
-our slashing rules to the level of a voting lockout time assigned per vote.  
+our slashing rules to the level of a voting lockout time assigned per vote.
 
 I.e. Each vote has an associated lockout time (PoH duration) that represents a
 duration by any additional vote from that validator must be in a PoH that
@@ -142,15 +110,15 @@ in a slashable amount as a function of either:
 1. the fraction of validators, out of the total validator pool, that were also
    slashed during the same time period (ala Casper)
 2. the amount of time since the vote was cast (e.g. a linearly increasing % of
-   total deposited as slashable amount over time), or both.  
+   total deposited as slashable amount over time), or both.
 
 This is an area currently under exploration
 
 
 ### Penalties
 
-As previously discussed, annual validator reward rates are to be specified as a
-function of total amount staked. The cluster rewards validators who are online
+As discussed in the [Economic Design](ed_overview.md) section, annual validator interest rates are to be specified as a
+function of total percentage of circulating supply that has been staked. The cluster rewards validators who are online
 and actively participating in the validation process throughout the entirety of
 their *validation period*. For validators that go offline/fail to validate
 transactions during this period, their annual reward is effectively reduced.

book/src/synchronization.md

@@ -54,9 +54,9 @@ function](https://eprint.iacr.org/2018/601.pdf) or *VDF*.
 A desirable property of a VDF is that verification time is very fast. Solana's
 approach to verifying its delay function is proportional to the time it took to
 create it. Split over a 4000 core GPU, it is sufficiently fast for Solana's
-needs, but if you asked the authors the paper cited above, they might tell you
+needs, but if you asked the authors of the paper cited above, they might tell you
 ([and have](https://github.com/solana-labs/solana/issues/388)) that Solana's
-approach is algorithmically slow it shouldn't be called a VDF. We argue the
+approach is algorithmically slow and it shouldn't be called a VDF. We argue the
 term VDF should represent the category of verifiable delay functions and not
 just the subset with certain performance characteristics. Until that's
 resolved, Solana will likely continue using the term PoH for its