solana-docs 0.0.0 → 1.0.0

package/art/validator.bob

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

package/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
-};

package/build-cli-usage.sh

@@ -1,42 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd "$(dirname "$0")"
-cargo=../cargo
-
-# shellcheck source=ci/rust-version.sh
-source ../ci/rust-version.sh stable
-
-: "${rust_stable:=}" # Pacify shellcheck
-
-usage=$("$cargo" stable -q run -p solana-cli -- -C ~/.foo --help | sed -e 's|'"$HOME"'|~|g' -e 's/[[:space:]]\+$//')
-
-out=${1:-src/cli/usage.md}
-
-cat src/cli/.usage.md.header > "$out"
-
-section() {
-  declare mark=${2:-"###"}
-  declare section=$1
-  read -r name rest <<<"$section"
-
-  printf '%s %s
-' "$mark" "$name"
-  printf '```text
-%s
-```
-
-' "$section"
-}
-
-section "$usage" >> "$out"
-
-usage=$(sed -e '/^ \{5,\}/d' <<<"$usage")
-
-in_subcommands=0
-while read -r subcommand rest; do
-  [[ $subcommand == "SUBCOMMANDS:" ]] && in_subcommands=1 && continue
-  if ((in_subcommands)); then
-      section "$("$cargo" stable -q run -p solana-cli -- help "$subcommand" | sed -e 's|'"$HOME"'|~|g' -e 's/[[:space:]]\+$//')" "####" >> "$out"
-  fi
-done <<<"$usage">>"$out"

package/build.sh

@@ -1,40 +0,0 @@
-#!/usr/bin/env bash
-set -ex
-
-cd "$(dirname "$0")"
-
-# shellcheck source=ci/env.sh
-source ../ci/env.sh
-
-: "${rust_stable_docker_image:=}" # Pacify shellcheck
-
-# shellcheck source=ci/rust-version.sh
-source ../ci/rust-version.sh
-../ci/docker-run.sh "$rust_stable_docker_image" docs/build-cli-usage.sh
-../ci/docker-run.sh "$rust_stable_docker_image" docs/convert-ascii-to-svg.sh
-./set-solana-release-tag.sh
-
-# Get current channel
-eval "$(../ci/channel-info.sh)"
-
-# Synchronize translations with Crowdin only on stable channel
-if [ "$CHANNEL" = stable ]; then
-  echo "Downloading & updating translations..."
-  npm run crowdin:download
-  npm run crowdin:upload
-fi
-
-# Build from /src into /build
-npm run build
-echo $?
-
-# Publish only from merge commits and beta release tags
-if [[ -n $CI ]]; then
-  if [[ -z $CI_PULL_REQUEST ]]; then
-    if [[ -n $CI_TAG ]] && [[ $CI_TAG != $BETA_CHANNEL* ]]; then
-      echo "not a beta tag"
-      exit 0
-    fi
-    ./publish-docs.sh
-  fi
-fi

package/convert-ascii-to-svg.sh

@@ -1,21 +0,0 @@
-#!/usr/bin/env bash
-
-# Convert .bob and .msc files in docs/art to .svg files located where the
-# site build will find them.
-
-set -e
-
-cd "$(dirname "$0")"
-output_dir=static/img
-
-mkdir -p "$output_dir"
-
-while read -r bob_file; do
-  out_file=$(basename "${bob_file%.*}".svg)
-  svgbob "$bob_file" --output "$output_dir/$out_file"
-done < <(find art/*.bob)
-
-while read -r msc_file; do
-  out_file=$(basename "${msc_file%.*}".png)
-  mscgen -T png -o "$output_dir/$out_file" -i "$msc_file"
-done < <(find art/*.msc)

package/crowdin.yml

@@ -1,16 +0,0 @@
-project_id: '2'
-api_token_env: 'CROWDIN_PERSONAL_TOKEN'
-base_url: 'https://solana.crowdin.com'
-preserve_hierarchy: true
-files: [
-    # JSON translation files
-    # {
-    # source: '/i18n/en/**/*',
-    # translation: '/i18n/%two_letters_code%/**/%original_file_name%',
-    #},
-    # Docs Markdown files
-    {
-      source: '/src/**/*.md',
-      translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%',
-    },
-  ]

package/docusaurus.config.js

@@ -1,161 +0,0 @@
-const math = require("remark-math");
-const katex = require("rehype-katex");
-module.exports = {
-  title: "Solana Docs",
-  tagline:
-    "Solana is an open source project implementing a new, high-performance, permissionless blockchain.",
-  url: "https://docs.solana.com",
-  baseUrl: "/",
-  favicon: "img/favicon.ico",
-  organizationName: "solana-labs", // Usually your GitHub org/user name.
-  projectName: "solana", // Usually your repo name.
-  onBrokenLinks: "throw",
-  stylesheets: [
-    {
-      href: "/katex/katex.min.css",
-      type: "text/css",
-      integrity:
-        "sha384-AfEj0r4/OFrOo5t7NnNe46zW/tFgW6x/bCJG8FqQCEo3+Aro6EYUG4+cU+KJWu/X",
-      crossorigin: "anonymous",
-    },
-  ],
-  i18n: {
-    defaultLocale: "en",
-    locales: ["en", "de", "es", "ru", "ar"],
-    // localesNotBuilding: ["ko", "pt", "vi", "zh", "ja"],
-    localeConfigs: {
-      en: {
-        label: "English",
-      },
-      ru: {
-        label: "Русский",
-      },
-      es: {
-        label: "Español",
-      },
-      de: {
-        label: "Deutsch",
-      },
-      ar: {
-        label: "العربية",
-      },
-      ko: {
-        label: "한국어",
-      },
-    },
-  },
-  themeConfig: {
-    navbar: {
-      logo: {
-        alt: "Solana Logo",
-        src: "img/logo-horizontal.svg",
-        srcDark: "img/logo-horizontal-dark.svg",
-      },
-      items: [
-        {
-          href: "https://spl.solana.com",
-          label: "Program Library »",
-          position: "left",
-        },
-        {
-          to: "developing/programming-model/overview",
-          label: "Develop",
-          position: "left",
-        },
-        {
-          to: "running-validator",
-          label: "Validate",
-          position: "left",
-        },
-        {
-          to: "integrations/exchange",
-          label: "Integrate",
-          position: "left",
-        },
-        {
-          to: "cluster/overview",
-          label: "Learn",
-          position: "left",
-        },
-        {
-          type: "localeDropdown",
-          position: "right",
-        },
-        {
-          href: "https://discordapp.com/invite/pquxPsq",
-          label: "Chat",
-          position: "right",
-        },
-        {
-          href: "https://github.com/solana-labs/solana",
-          label: "GitHub",
-          position: "right",
-        },
-      ],
-    },
-    algolia: {
-      // This API key is "search-only" and safe to be published
-      apiKey: "d58e0d68c875346d52645d68b13f3ac0",
-      indexName: "solana",
-      contextualSearch: true,
-    },
-    footer: {
-      style: "dark",
-      links: [
-        {
-          title: "Docs",
-          items: [
-            {
-              label: "Introduction",
-              to: "introduction",
-            },
-          ],
-        },
-        {
-          title: "Community",
-          items: [
-            {
-              label: "Discord",
-              href: "https://discordapp.com/invite/pquxPsq",
-            },
-            {
-              label: "Twitter",
-              href: "https://twitter.com/solana",
-            },
-            {
-              label: "Forums",
-              href: "https://forums.solana.com",
-            },
-          ],
-        },
-        {
-          title: "More",
-          items: [
-            {
-              label: "GitHub",
-              href: "https://github.com/solana-labs/solana",
-            },
-          ],
-        },
-      ],
-      copyright: `Copyright © ${new Date().getFullYear()} Solana Foundation`,
-    },
-  },
-  presets: [
-    [
-      "@docusaurus/preset-classic",
-      {
-        docs: {
-          path: "src",
-          routeBasePath: "/",
-          sidebarPath: require.resolve("./sidebars.js"),
-          remarkPlugins: [math],
-          rehypePlugins: [katex],
-        },
-        theme: {
-          customCss: require.resolve("./src/css/custom.css"),
-        },
-      },
-    ],
-  ],
-};

package/offline-cmd-md-links.sh

@@ -1,11 +0,0 @@
-#!/usr/bin/env bash
-
-CLI_USAGE_RELPATH="../cli/usage.md"
-
-SED_OMIT_NONMATCHING=$'\nt\nd'
-SED_CMD="s:^#### solana-(.*):* [\`\\1\`](${CLI_USAGE_RELPATH}#solana-\\1):${SED_OMIT_NONMATCHING}"
-
-OFFLINE_CMDS=$(grep -E '#### solana-|--signer ' src/cli/usage.md | grep -B1 -- --signer | sed -Ee "$SED_CMD")
-
-# Omit deprecated
-grep -vE '\b(pay)\b' <<<"$OFFLINE_CMDS"

package/publish-docs.sh

@@ -1,56 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-if [[ -d .vercel ]]; then
-  rm -r .vercel
-fi
-
-CONFIG_FILE=vercel.json
-
-if [[ -n $CI_TAG ]]; then
-  PROJECT_NAME=docs-solana-com
-else
-  eval "$(../ci/channel-info.sh)"
-  case $CHANNEL in
-  edge)
-    PROJECT_NAME=edge-docs-solana-com
-    ;;
-  beta)
-    PROJECT_NAME=beta-docs-solana-com
-    ;;
-  *)
-    PROJECT_NAME=docs
-    ;;
-  esac
-fi
-
-cat > "$CONFIG_FILE" <<EOF
-{
-  "name": "$PROJECT_NAME",
-  "scope": "solana-labs",
-  "redirects": [
-    { "source": "/apps", "destination": "/developing/programming-model/overview" },
-    { "source": "/apps/bakcwards-compatibility", "destination": "/developing/backwards-compatibility" },
-    { "source": "/apps/break", "destination": "/developing/on-chain-programs/examples" },
-    { "source": "/apps/builtins", "destination": "/developing/builtin-programs" },
-    { "source": "/apps/drones", "destination": "/developing/on-chain-programs/examples" },
-    { "source": "/apps/hello-world", "destination": "/developing/on-chain-programs/examples" },
-    { "source": "/apps/javascript-api", "destination": "/developing/clients/javascript-api" },
-    { "source": "/apps/jsonrpc-api", "destination": "/developing/clients/jsonrpc-api" },
-    { "source": "/apps/programming-faq", "destination": "/developing/on-chain-programs/faq" },
-    { "source": "/apps/rent", "destination": "/developing/programming-model/accounts" },
-    { "source": "/apps/sysvars", "destination": "/developing/programming-model/sysvars" },
-    { "source": "/apps/webwallet", "destination": "/developing/on-chain-programs/examples" },
-    { "source": "/implemented-proposals/cross-program-invocation", "destination": "/developing/programming-model/cpi" },
-    { "source": "/implemented-proposals/program-derived-addresses", "destination": "/developing/programming-model/program-derived-addresses" },
-    { "source": "/implemented-proposals/secp256k1_instruction", "destination": "/developing/programming-model/secpk1-instructions" }
-  ]
-}
-EOF
-
-[[ -n $VERCEL_TOKEN ]] || {
-  echo "VERCEL_TOKEN is undefined.  Needed for Vercel authentication."
-  exit 1
-}
-vercel deploy . --local-config="$CONFIG_FILE" --confirm --token "$VERCEL_TOKEN" --prod

package/set-solana-release-tag.sh

@@ -1,20 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-cd "$(dirname "$0")"
-
-eval "$(../ci/channel-info.sh)"
-
-if [[ -n $BETA_CHANNEL_LATEST_TAG ]]; then
-  LATEST_SOLANA_RELEASE_VERSION=$BETA_CHANNEL_LATEST_TAG
-else
-  LATEST_SOLANA_RELEASE_VERSION=$STABLE_CHANNEL_LATEST_TAG
-fi
-VERSION_FOR_DOCS_RS="${LATEST_SOLANA_RELEASE_VERSION:1}"
-
-set -x
-if [[ -n $CI ]]; then
-  sed --version || { echo "Error: Incompatible version of sed, use gnu sed"; exit 1; }
-  find src/ -name \*.md -exec sed -i "s/LATEST_SOLANA_RELEASE_VERSION/$LATEST_SOLANA_RELEASE_VERSION/g" {} \;
-  find src/ -name \*.md -exec sed -i "s/VERSION_FOR_DOCS_RS/$VERSION_FOR_DOCS_RS/g" {} \;
-fi

package/sidebars.js

@@ -1,210 +0,0 @@
-module.exports = {
-  docs: {
-    About: ["introduction", "terminology", "history"],
-    Wallets: [
-      "wallet-guide",
-      "wallet-guide/apps",
-      {
-        type: "category",
-        label: "Web Wallets",
-        items: ["wallet-guide/web-wallets", "wallet-guide/solflare"],
-      },
-      {
-        type: "category",
-        label: "Hardware Wallets",
-        items: ["wallet-guide/ledger-live"],
-      },
-      {
-        type: "category",
-        label: "Command-line Wallets",
-        items: [
-          "wallet-guide/cli",
-          "wallet-guide/paper-wallet",
-          {
-            type: "category",
-            label: "Hardware Wallets",
-            items: [
-              "wallet-guide/hardware-wallets",
-              "wallet-guide/hardware-wallets/ledger",
-            ],
-          },
-          "wallet-guide/file-system-wallet",
-        ],
-      },
-      "wallet-guide/support",
-    ],
-    Staking: ["staking", "staking/stake-accounts"],
-    "Command Line": [
-      "cli",
-      "cli/install-solana-cli-tools",
-      "cli/conventions",
-      "cli/choose-a-cluster",
-      "cli/transfer-tokens",
-      "cli/delegate-stake",
-      "cli/deploy-a-program",
-      "offline-signing",
-      "offline-signing/durable-nonce",
-      "cli/usage",
-    ],
-    Developing: [
-      {
-        type: "category",
-        label: "Programming Model",
-        items: [
-          "developing/programming-model/overview",
-          "developing/programming-model/transactions",
-          "developing/programming-model/accounts",
-          "developing/programming-model/runtime",
-          "developing/programming-model/calling-between-programs",
-        ],
-      },
-      {
-        type: "category",
-        label: "Clients",
-        items: [
-          "developing/clients/jsonrpc-api",
-          "developing/clients/javascript-api",
-          "developing/clients/javascript-reference",
-          "developing/clients/rust-api",
-        ],
-      },
-      {
-        type: "category",
-        label: "Runtime Facilities",
-        items: [
-          "developing/runtime-facilities/programs",
-          "developing/runtime-facilities/sysvars",
-        ],
-      },
-      {
-        type: "category",
-        label: "On-chain Programs",
-        items: [
-          "developing/on-chain-programs/overview",
-          "developing/on-chain-programs/developing-rust",
-          "developing/on-chain-programs/developing-c",
-          "developing/on-chain-programs/deploying",
-          "developing/on-chain-programs/debugging",
-          "developing/on-chain-programs/examples",
-          "developing/on-chain-programs/faq",
-        ],
-      },
-      "developing/test-validator",
-      "developing/backwards-compatibility",
-      "developing/plugins/accountsdb_plugin"
-    ],
-    Integrating: ["integrations/exchange"],
-    Validating: [
-      "running-validator",
-      "running-validator/validator-reqs",
-      "running-validator/validator-start",
-      "running-validator/vote-accounts",
-      "running-validator/validator-stake",
-      "running-validator/validator-monitor",
-      "running-validator/validator-info",
-      "running-validator/validator-failover",
-      "running-validator/validator-troubleshoot",
-    ],
-    Clusters: [
-      "clusters",
-      "cluster/rpc-endpoints",
-      "cluster/bench-tps",
-      "cluster/performance-metrics",
-    ],
-    Architecture: [
-      {
-        type: "category",
-        label: "Cluster",
-        items: [
-          "cluster/overview",
-          "cluster/synchronization",
-          "cluster/leader-rotation",
-          "cluster/fork-generation",
-          "cluster/managing-forks",
-          "cluster/turbine-block-propagation",
-          "cluster/vote-signing",
-          "cluster/stake-delegation-and-rewards",
-        ],
-      },
-      {
-        type: "category",
-        label: "Validator",
-        items: [
-          "validator/anatomy",
-          "validator/tpu",
-          "validator/tvu",
-          "validator/blockstore",
-          "validator/gossip",
-          "validator/runtime",
-        ],
-      },
-    ],
-    Economics: [
-      "economics_overview",
-      {
-        type: "category",
-        label: "Inflation Design",
-        items: [
-          "inflation/terminology",
-          "inflation/inflation_schedule",
-          "inflation/adjusted_staking_yield",
-        ],
-      },
-      "transaction_fees",
-      "storage_rent_economics",
-    ],
-    "Design Proposals": [
-      {
-        type: "category",
-        label: "Implemented",
-        items: [
-          "implemented-proposals/implemented-proposals",
-          "implemented-proposals/abi-management",
-          "implemented-proposals/bank-timestamp-correction",
-          "implemented-proposals/commitment",
-          "implemented-proposals/durable-tx-nonces",
-          "implemented-proposals/installer",
-          "implemented-proposals/instruction_introspection",
-          "implemented-proposals/leader-leader-transition",
-          "implemented-proposals/leader-validator-transition",
-          "implemented-proposals/persistent-account-storage",
-          "implemented-proposals/readonly-accounts",
-          "implemented-proposals/reliable-vote-transmission",
-          "implemented-proposals/rent",
-          "implemented-proposals/repair-service",
-          "implemented-proposals/rpc-transaction-history",
-          "implemented-proposals/snapshot-verification",
-          "implemented-proposals/staking-rewards",
-          "implemented-proposals/testing-programs",
-          "implemented-proposals/tower-bft",
-          "implemented-proposals/transaction-fees",
-          "implemented-proposals/validator-timestamp-oracle",
-        ],
-      },
-      {
-        type: "category",
-        label: "Accepted",
-        items: [
-          "proposals/accepted-design-proposals",
-          "proposals/bankless-leader",
-          "proposals/block-confirmation",
-          "proposals/cluster-test-framework",
-          "proposals/embedding-move",
-          "proposals/interchain-transaction-verification",
-          "proposals/ledger-replication-to-implement",
-          "proposals/optimistic-confirmation-and-slashing",
-          "proposals/optimistic_confirmation",
-          "proposals/rip-curl",
-          "proposals/rust-clients",
-          "proposals/simple-payment-and-state-verification",
-          "proposals/slashing",
-          "proposals/snapshot-verification",
-          "proposals/tick-verification",
-          "proposals/transactions-v2",
-          "proposals/validator-proposal",
-          "proposals/vote-signing-to-implement",
-        ],
-      },
-    ],
-  },
-};

package/src/cli/.usage.md.header

@@ -1,59 +0,0 @@
----
-title: CLI Usage Reference
----
-
-The [solana-cli crate](https://crates.io/crates/solana-cli) provides a command-line interface tool for Solana
-
-## Examples
-
-### Get Pubkey
-
-```bash
-// Command
-$ solana-keygen pubkey
-
-// Return
-<PUBKEY>
-```
-
-### Airdrop SOL/Lamports
-
-```bash
-// Command
-$ solana airdrop 1
-
-// Return
-"1 SOL"
-```
-
-### Get Balance
-
-```bash
-// Command
-$ solana balance
-
-// Return
-"3.00050001 SOL"
-```
-
-### Confirm Transaction
-
-```bash
-// Command
-$ solana confirm <TX_SIGNATURE>
-
-// Return
-"Confirmed" / "Not found" / "Transaction failed with error <ERR>"
-```
-
-### Deploy program
-
-```bash
-// Command
-$ solana program deploy <PATH>
-
-// Return
-<PROGRAM_ID>
-```
-
-## Usage