From 483cdc55425e55e44a7bfd2bdb01a25c9119243b Mon Sep 17 00:00:00 2001 From: Kirk Haines Date: Tue, 5 Mar 2024 16:15:11 -0700 Subject: [PATCH] Update the CLI page to version 0.0.11; improve code boxes (#35) --- content/module-2/5-cli.md | 128 ++++++++++++++++++++--------- src/components/GitHubCodeBlock.tsx | 26 +++--- 2 files changed, 101 insertions(+), 53 deletions(-) diff --git a/content/module-2/5-cli.md b/content/module-2/5-cli.md index 3ff60b6..f70da60 100644 --- a/content/module-2/5-cli.md +++ b/content/module-2/5-cli.md @@ -11,11 +11,11 @@ The Topos CLI has already been mentioned many times in this chapter. Now it is t ## Install from the source -You will fetch and build the [Topos CLI](https://github.com/topos-protocol/topos) from the source. This may take some time; alternatively, you can [download and run a released version directly](https://github.com/topos-protocol/topos/releases/). This section assumes that you work with [version 0.0.5](https://github.com/topos-protocol/topos/releases/tag/v0.0.5). +You will fetch and build the [Topos CLI](https://github.com/topos-protocol/topos) from the source. This may take some time; alternatively, you can [download and run a released version directly](https://github.com/topos-protocol/topos/releases/). This section assumes that you work with [version 0.0.11](https://github.com/topos-protocol/topos/releases/tag/v0.0.11). -The [Topos CLI](https://github.com/topos-protocol/topos) is written in Rust, so you will need to have a [Rust Toolchain installed and ready](https://rustup.rs). Alternatively, you can use a [Rust Docker image](https://hub.docker.com/layers/library/rust/1.72.0-bullseye/images/sha256-e431500c0bd21997da93fbb6cc3a20833f1307306e18982eeb503b6f432ee9f5) to achieve the same. +The [Topos CLI](https://github.com/topos-protocol/topos) is written in Rust, so you will need to have a [Rust Toolchain installed and ready](https://rustup.rs). Alternatively, you can use a [Rust Docker image](https://hub.docker.com/layers/library/rust/1.76.0-bookworm/images/sha256-e431500c0bd21997da93fbb6cc3a20833f1307306e18982eeb503b6f432ee9f5) to achieve the same. @@ -24,30 +24,36 @@ When you are ready, use `cargo` to fetch and compile the CLI: -```sh -$ cargo install topos --git https://github.com/topos-protocol/topos --tag v0.0.5 + ``` +$ cargo install topos --git https://github.com/topos-protocol/topos --tag v0.0.11 +``` + In a new `topos-cli.dockerfile`, put: -```Dockerfile -FROM rust:1.72.0-bullseye + +``` +FROM rust:1.76.0-bookworm RUN apt-get update RUN apt-get install --yes protobuf-compiler llvm-dev libclang-dev clang -RUN cargo install topos --git https://github.com/topos-protocol/topos --tag v0.0.5 +RUN cargo install topos --git https://github.com/topos-protocol/topos --tag v0.0.11 ENTRYPOINT [ "topos" ] ``` + Then create the image: -```sh -$ docker build . -f topos-cli.dockerfile -t topos-cli:v0.0.5 + ``` +$ docker build . -f topos-cli.dockerfile -t topos-cli:v0.0.11 +``` + @@ -59,23 +65,28 @@ You can check your installation with: -```sh + +``` $ topos --help ``` + -```sh -$ docker run --rm topos-cli:v0.0.5 --help + ``` +$ docker run --rm topos-cli:v0.0.11 --help +``` + This will show you all the available commands: -```txt + +``` Topos CLI Usage: topos [OPTIONS] @@ -95,24 +106,28 @@ Options: --home Home directory for the configuration [env: TOPOS_HOME=] [default: /home/user/.config/topos] -h, --help Print help ``` + In order to test the functionality presented here, the Topos CLI will need to download and install the `polygon-edge` binary. Move to a new directory that will be your workspace for this exercise, then: -```sh + +``` $ topos setup subnet $ export TOPOS_POLYGON_EDGE_BIN_PATH=$(pwd) $ export TOPOS_HOME=~/.config/topos/ ``` + Add to your `topos-cli.dockerfile`: -```diff-Dockerfile + +``` RUN cargo install topos --git https://github.com/topos-protocol/topos --branch main + ENV TOPOS_HOME=/root/.config/topos/ @@ -123,12 +138,15 @@ Add to your `topos-cli.dockerfile`: ENTRYPOINT [ "topos" ] ``` + After that, you need to rebuild the image. This should be fast, as it only runs these additional steps: -```sh -$ docker build . -f topos-cli.dockerfile -t topos-cli:v0.0.5 + +``` +$ docker build . -f topos-cli.dockerfile -t topos-cli:v0.0.11 ``` + @@ -138,17 +156,21 @@ By default, the Topos CLI downloads the most recent binary into the current dire -```sh + +``` $ topos setup subnet --help ``` + -```sh + +``` $ docker run --rm \ - topos-cli:v0.0.5 setup subnet --help + topos-cli:v0.0.11 setup subnet --help ``` + @@ -170,25 +192,30 @@ Create your first node, and name it `val-alice`: -```sh + +``` $ topos node init --name val-alice ``` + -```sh + +``` $ docker run --rm \ -v $(pwd)/.config:/root/.config \ - topos-cli:v0.0.5 node init --name val-alice + topos-cli:v0.0.11 node init --name val-alice ``` + This will create some local folders for a validator node with the alias `val_alice` and the three following keys: -```txt + +``` .config/topos/node/val-alice ├── config.toml ├── consensus @@ -197,12 +224,15 @@ This will create some local folders for a validator node with the alias `val_ali └── libp2p └── libp2p.key ``` + The command also warned you that these keys, which should be secret, are in fact stored unencrypted on disk: -```txt + +``` [WARNING: INSECURE LOCAL SECRETS - SHOULD NOT BE RUN IN PRODUCTION] ``` + Another file that has been created is `config.toml`. You will use its content in the next step when you start a node, and it is worth looking at in more detail. @@ -210,7 +240,8 @@ Another file that has been created is `config.toml`. You will use its content in The `config.toml` is the main configuration file. Have a look at the fields: -```toml + +``` [base] name = "val-alice" role = "validator" @@ -225,6 +256,7 @@ graphql-api-addr = "0.0.0.0:4030" grpc-api-addr = "0.0.0.0:1340" metrics-api-addr = "0.0.0.0:3000" ``` + In the `config.toml`, some of the scopes are necessary (`base` and `edge`) while others are optional (`tce`): @@ -246,18 +278,22 @@ Generate a config for a sequencer node with the alias `seq-bob`: -```sh + +``` $ topos node init --name seq-bob --role sequencer ``` + -```sh + +``` $ docker run --rm \ -v $(pwd)/.config:/root/.config \ - topos-cli:v0.0.5 node init --name seq-bob --role sequencer + topos-cli:v0.0.11 node init --name seq-bob --role sequencer ``` + @@ -276,19 +312,23 @@ In order to start a node locally for the Topos Subnet, you will need to fetch th -```sh + +``` $ wget -P $TOPOS_HOME/subnet/topos/ https://gist.githubusercontent.com/gruberb/19dbc24e9b2405e7562f63d4032450e6/raw/12499fdc40980209c7acd2146ee84c779dbe9e4d/genesis.json ``` + -```sh + +``` $ docker run --rm \ -v $(pwd)/.config:/root/.config \ --entrypoint wget \ - topos-cli:v0.0.5 -P $TOPOS_HOME/subnet/topos/ https://gist.githubusercontent.com/gruberb/19dbc24e9b2405e7562f63d4032450e6/raw/12499fdc40980209c7acd2146ee84c779dbe9e4d/genesis.json + topos-cli:v0.0.11 -P $TOPOS_HOME/subnet/topos/ https://gist.githubusercontent.com/gruberb/19dbc24e9b2405e7562f63d4032450e6/raw/12499fdc40980209c7acd2146ee84c779dbe9e4d/genesis.json ``` + @@ -302,9 +342,11 @@ If you are running with Docker, first you need to create the network on which yo -```sh + +``` $ docker network create net-topos-subnet ``` + @@ -314,19 +356,23 @@ When launching a node with the `node` subcommand, you can **specify which node c -```sh + +``` $ topos node up --name val-alice ``` + -```sh + +``` $ docker run --rm -it \ -v $(pwd)/.config:/root/.config \ --network net-topos-subnet \ - topos-cli:v0.0.5 node up --name val-alice + topos-cli:v0.0.11 node up --name val-alice ``` + Do not forget to launch it inside the `net-topos-subnet` network. Be sure to use `-it` so that you can interrupt it with CTRL-C. @@ -338,19 +384,23 @@ This will fetch the config generated for the validator node and start a node wit -```sh + +``` $ topos node up --name seq-bob ``` + -```sh + +``` $ docker run --rm -it \ -v $(pwd)/.config:/root/.config \ --network net-topos-subnet \ - topos-cli:v0.0.5 node up --name seq-bob + topos-cli:v0.0.11 node up --name seq-bob ``` + As before, do not forget to launch it inside the `net-topos-subnet` network so that it can contact `val-alice`. diff --git a/src/components/GitHubCodeBlock.tsx b/src/components/GitHubCodeBlock.tsx index 5631e9d..e6d13eb 100644 --- a/src/components/GitHubCodeBlock.tsx +++ b/src/components/GitHubCodeBlock.tsx @@ -1,12 +1,13 @@ import React, { useState, useEffect } from 'react'; import { Highlight, Prism, themes } from 'prism-react-renderer'; +import 'prismjs/plugins/diff-highlight/prism-diff-highlight'; import rangeParser from 'parse-numeric-range'; import { twMerge } from 'tailwind-merge'; import { githubToken } from '../../githubToken'; (typeof global !== 'undefined' ? global : window).Prism = Prism; -const languages = ['solidity', 'bash']; +const languages = ['bash', 'diff', 'docker', 'shell-session', 'solidity', 'toml', 'yaml']; const asyncImport = async (language) => { await import(`prismjs/components/prism-${language}`); @@ -42,25 +43,21 @@ const calculateLines = (raw) => { } }; -const trimCopiedCode = (code, separators_array, copytrim) => { +const trimCopiedCode = (code, copytrim) => { if (copytrim) { - const re = new RegExp(copytrim, 'g'); + const re = new RegExp(copytrim, 'gm'); code = code.replace(re, ''); } - // if (separators_array(0)) { - // code = code.split('\n').slice(0, separators_array(0)); - // } - return code; }; -const copyToClipboard = (str, separators_array, copytrim, nocopy) => { +const copyToClipboard = (str, copytrim, nocopy) => { if (nocopy == true) { return; } - let codeToCopy = trimCopiedCode(str, separators_array, copytrim); + let codeToCopy = trimCopiedCode(str, copytrim); if (nocopy) { codeToCopy = invertedTrimCode(codeToCopy, nocopy); @@ -195,11 +192,14 @@ export const GitHubCodeBlock: React.FC< const baseUrl = assembleContentUrl(org, repo, tag, path); + if (nocopy === "true") { + nocopy = true; + } + useEffect(() => { console.log('useEffect() called'); const doFetch = async (url, attributes) => { - console.log('doFetch() called'); console.log(`url: ${url}`); console.log(`attributes: ${JSON.stringify(attributes)}`); return await fetch(url, attributes) @@ -217,8 +217,6 @@ export const GitHubCodeBlock: React.FC< }); }; - console.log('doFetch() defined'); - const fetchCode = async () => { if (!nofetch && org && repo && path) { let attributes = { @@ -289,7 +287,7 @@ export const GitHubCodeBlock: React.FC< {nocopy != true && (