From c6b2a0928e9ead38abcb5e5e97e9ede46202d017 Mon Sep 17 00:00:00 2001 From: Daniel Olshansky Date: Thu, 21 Nov 2024 13:02:52 -0800 Subject: [PATCH 1/2] [Docs] Update documentation on installing the `poktrolld` CLI (#949) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Updating the following page for details on how to install the `poktrolld` CLI using homebrew: https://dev.poktroll.com/operate/user_guide/install ![Screenshot 2024-11-21 at 12 58 19 PM](https://github.com/user-attachments/assets/cee0c036-cc6e-486f-8c8e-4db5fa25c4b5) --- docusaurus/docs/operate/user_guide/install.md | 68 ++++++++++++------- 1 file changed, 43 insertions(+), 25 deletions(-) diff --git a/docusaurus/docs/operate/user_guide/install.md b/docusaurus/docs/operate/user_guide/install.md index ffa17875c..b19473f01 100644 --- a/docusaurus/docs/operate/user_guide/install.md +++ b/docusaurus/docs/operate/user_guide/install.md @@ -3,41 +3,47 @@ title: CLI Installation sidebar_position: 0 --- -- [Release binaries](#release-binaries) -- [Installing from source](#installing-from-source) - - [Prerequisites](#prerequisites) -- [Homebrew and pkgx](#homebrew-and-pkgx) +- [MacOS \& Linux Users](#macos--linux-users) + - [Using Homebrew](#using-homebrew) + - [From Source](#from-source) + - [Using release binaries](#using-release-binaries) - [Windows Users](#windows-users) -## Release binaries +## MacOS & Linux Users -Pre-built binaries are available on our [releases page](https://github.com/pokt-network/poktroll/releases). +### Using Homebrew -The following snippet downloads/upgrades the binary to the latest released version (Linux and macOS only): +:::tip +See the [homebrew-poktroll](https://github.com/pokt-network/homebrew-poktroll/) +repository for details on how to install homebrew or other details to install +or debug the CLI. +::: -```bash -# Download the correct binary based on the OS and architecture -curl -LO "https://github.com/pokt-network/poktroll/releases/latest/download/poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" +Ensure you have [Homebrew](https://brew.sh/) installed. -# Extract the downloaded tarball to /usr/local/bin -sudo tar -zxf "poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" -C /usr/local/bin +Then run the following commands: -# Make the binary executable -sudo chmod +x /usr/local/bin/poktrolld +```bash +brew tap pokt-network/poktroll +brew install poktrolld +``` -# Check version +And verify it worked by running: + +```bash poktrolld version +poktrolld --help ``` -## Installing from source - -### Prerequisites +### From Source Ensure you have the following installed: - [Go](https://go.dev/doc/install) (version 1.18 or later) - [Ignite CLI](https://docs.ignite.com/welcome/install) +Then run the following commands: + ```bash git clone https://github.com/pokt-network/poktroll.git cd poktroll @@ -45,20 +51,32 @@ make go_develop make ignite_poktrolld_build ``` -Verify it worked by running: +And verify it worked by running: ```bash +poktrolld version poktrolld --help ``` -## Homebrew and pkgx +### Using release binaries -:::tip -We have an [open GitHub issue](https://github.com/pokt-network/poktroll/issues/535) -to introduce `poktrolld` to [brew](https://brew.sh/) and [pkgx](https://github.com/pkgxdev/pkgx). +Pre-built binaries are available on our [releases page](https://github.com/pokt-network/poktroll/releases). -Please reach out to us in the ticket if you want to pick this ticket! -::: +The following snippet downloads/upgrades the binary to the latest released version: + +```bash +# Download the correct binary based on the OS and architecture +curl -LO "https://github.com/pokt-network/poktroll/releases/latest/download/poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" + +# Extract the downloaded tarball to /usr/local/bin +sudo tar -zxf "poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" -C /usr/local/bin + +# Make the binary executable +sudo chmod +x /usr/local/bin/poktrolld + +# Check version +poktrolld version +``` ## Windows Users From 59ec254f58895cb0a7209d07cd86d59f84e9ae7e Mon Sep 17 00:00:00 2001 From: Daniel Olshansky Date: Thu, 21 Nov 2024 13:37:57 -0800 Subject: [PATCH 2/2] [Docs] Update links to RPC & explorers (#950) Update links to RPC endpoints, faucet & explorers --- docusaurus/docs/explore/rpc.md | 13 ++++++------- docusaurus/docs/explore/tools.md | 14 ++++++++------ 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/docusaurus/docs/explore/rpc.md b/docusaurus/docs/explore/rpc.md index a87c5e1a2..5a407e2ce 100644 --- a/docusaurus/docs/explore/rpc.md +++ b/docusaurus/docs/explore/rpc.md @@ -13,7 +13,6 @@ sidebar_position: 3 ## Types of RPC Endpoints - You can review the difference between them in the [Cosmos SDK docs](https://docs.cosmos.network/main/learn/advanced/grpc_rest#comparison-table). ## Beta TestNet @@ -22,9 +21,9 @@ You can review the difference between them in the [Cosmos SDK docs](https://docs We provide `gRPC`, `JSON-RPC` and `REST` endpoints, which are available here: -- **RPC**: `https://shannon-testnet-grove-seed-rpc.beta.poktroll.com` -- **gRPC**: `https://shannon-testnet-grove-seed-grpc.beta.poktroll.com` -- **REST**: `https://shannon-testnet-grove-seed-api.beta.poktroll.com` +- **RPC**: `https://shannon-testnet-grove-rpc.beta.poktroll.com` +- **gRPC**: `https://shannon-testnet-grove-grpc.beta.poktroll.com` +- **REST**: `https://shannon-testnet-grove-api.beta.poktroll.com` ### Beta JSON-RPC Example @@ -46,9 +45,9 @@ poktrolld query block --type=height 0 --node https://shannon-testnet-grove-seed- We provide `gRPC`, `JSON-RPC` and `REST` endpoints, which are available here: -- **RPC**: `https://shannon-testnet-grove-seed-rpc.alpha.poktroll.com` -- **gRPC**: `https://shannon-testnet-grove-seed-grpc.alpha.poktroll.com` -- **REST**: `https://shannon-testnet-grove-seed-api.alpha.poktroll.com` +- **RPC**: `https://shannon-testnet-grove-rpc.alpha.poktroll.com` +- **gRPC**: `https://shannon-testnet-grove-grpc.alpha.poktroll.com` +- **REST**: `https://shannon-testnet-grove-api.alpha.poktroll.com` ### Alpha JSON-RPC Example diff --git a/docusaurus/docs/explore/tools.md b/docusaurus/docs/explore/tools.md index 1034d1565..9e46f4f64 100644 --- a/docusaurus/docs/explore/tools.md +++ b/docusaurus/docs/explore/tools.md @@ -9,15 +9,17 @@ sidebar_position: 1 ## Beta TestNet -- 🪙 [Shannon Beta Token Faucet](https://faucet.beta.testnet.pokt.network/) -- 🗺️ [Shannon Beta Explorer](https://shannon.beta.testnet.pokt.network) -- 🗺️ [PoktScan's Shannon Beta Explorer](https://shannon.beta.poktscan.com/) +- 🪙 [Token Faucet](https://faucet.beta.testnet.pokt.network/) +- 🗺️ [Explorer](https://shannon.beta.testnet.pokt.network) +- 🗺️ [POKTScan's Explorer](https://shannon-beta.poktscan.com/) +- 👨‍💻 [POKTScan's GraphQL Playground](https://shannon-beta-api.poktscan.com/) ## Alpha TestNet -- 🪙 [Shannon Alpha Token Faucet](https://faucet.alpha.testnet.pokt.network/) -- 🗺️ [Shannon Alpha Explorer](https://shannon.alpha.testnet.pokt.network) -- 🗺️ [PoktScan's Shannon Alpha Explorer](https://shannon.alpha.poktscan.com/) +- 🪙 [Token Faucet](https://faucet.alpha.testnet.pokt.network/) +- 🗺️ [Explorer](https://shannon.alpha.testnet.pokt.network) +- 🗺️ [POKTScan's Explorer](https://shannon-alpha.poktscan.com/) +- 👨‍💻 [POKTScan's GraphQL Playground](https://shannon-alpha-api.poktscan.com/) ## 🛠️ Tools & References