Skip to content

Commit

Permalink
Merge branch 'main' into docs/untrack-params.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk authored Nov 21, 2024
2 parents 4cc92f6 + 59ec254 commit 61ff7a9
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 38 deletions.
13 changes: 6 additions & 7 deletions docusaurus/docs/explore/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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

Expand Down
14 changes: 8 additions & 6 deletions docusaurus/docs/explore/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
68 changes: 43 additions & 25 deletions docusaurus/docs/operate/user_guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,62 +3,80 @@ 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
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

Expand Down

0 comments on commit 61ff7a9

Please sign in to comment.