Skip to content

Commit

Permalink
fix links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Anmol1696 committed Jul 11, 2024
1 parent ab3893a commit 12bd670
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
28 changes: 14 additions & 14 deletions docs/pages/config/chains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ chains:
```
## `name`
Type of chain is a short hand to use the default key values for a chain found [here](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml#L54...#L244)
Type of chain is a short hand to use the default key values for a chain found [here](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/values.yaml#L54...#L244)
```yaml
chains:
- id: osmosis-1
Expand Down Expand Up @@ -72,7 +72,7 @@ chains:
> * Packages `curl,make,bash,jq,sed`
> * Chain binaries installed in $PATH

We create docker images with this [Dockerfile](https://github.com/cosmology-tech/starship/blob/main/docker/chains/Dockerfile), using Heighliner base
We create docker images with this [Dockerfile](https://github.com/cosmology-tech/starship/blob/main/starship/docker/chains/Dockerfile), using Heighliner base
images. All supported docker images can be found [here](https://github.com/orgs/cosmology-tech/packages?repo_name=starship)

## `numValidators`
Expand All @@ -88,7 +88,7 @@ chains:
> Note: The first node spun up is a `genesis` node, which spins up before all other validators. Once the genesis node starts
> then all other validator nodes are spun up simultaneously

If number of validators is more than the mnemonics available in the [`keys.json`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/configs/keys.json#L9) file
If number of validators is more than the mnemonics available in the [`keys.json`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/configs/keys.json#L9) file
which is 5, then other validators are created with random mnemonic on initialization.

## `ports`
Expand All @@ -107,7 +107,7 @@ chains:
```

Available endpoints for extra services:
* `exposer`: https://github.com/cosmology-tech/starship/blob/main/proto/exposer/service.proto#L15
* `exposer`: https://github.com/cosmology-tech/starship/blob/main/starship/proto/exposer/service.proto#L15
* `faucet`: https://github.com/cosmos/cosmjs/blob/main/packages/faucet/README.md#using-the-faucet

> Note: Make sure the ports are not overlapping in the config file
Expand Down Expand Up @@ -146,9 +146,9 @@ For more details on the resource directive have a look at [kubernetes resources]
## `faucet` (optional)
Every genesis node runs a faucet. We support 2 types of faucet:
* [cosmjs faucet](https://github.com/cosmos/cosmjs/tree/main/packages/faucet), by default
* [starship faucet](https://github.com/cosmology-tech/starship/tree/main/faucet)
* [starship faucet](https://github.com/cosmology-tech/starship/tree/main/starship/faucet)

Setting for cosmjs-faucet [here](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml#L32...#L38) but can be
Setting for cosmjs-faucet [here](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/values.yaml#L32...#L38) but can be
overridden with this directive, specially for compatible cosmjs version with the chain version.

```yaml
Expand Down Expand Up @@ -177,7 +177,7 @@ then you can reduce the `concurrency` to a lower number.

## `build` (optional)
With the `build` directive in the chain, one can basically build chain binaries on the fly before starting the chain.
When the directive is `enabled`, then the docker image is set to a [`runner` docker image](https://github.com/cosmology-tech/starship/blob/main/docker/starship/runner/Dockerfile)
When the directive is `enabled`, then the docker image is set to a [`runner` docker image](https://github.com/cosmology-tech/starship/blob/main/starship/docker/starship/runner/Dockerfile)
which is a basic alpine image with starship dependencies.
```yaml
chains:
Expand Down Expand Up @@ -231,17 +231,17 @@ chains:

## `scripts` (optional)
Scripts directive will replace the default scripts with the given scripts. In order to use this directive,
one must use [`scripts/install.sh`](https://github.com/cosmology-tech/starship/blob/main/scripts/install.sh) script for running the helm chart.
one must use [`scripts/install.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/scripts/install.sh) script for running the helm chart.

> Since the local scripts are converted into configmaps that are then created in the kubernetes cluster, there is a limit of 1MBi

Types of scripts that are allowed inside the `scripts` dir are:
* `createGenesis`: Script used in the genesis node that will create the `genesis.json` file. Default: [`create-genesis.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/create-genesis.sh)
* `updateGenesis`: Script used to make custom changes to the genesis file. Default: [`update-genesis.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/update-genesis.sh)
* `updateConfig`: Script used to make custom changes to the config files. Default: [`update-config.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/update-config.sh)
* `createValidator`: Script to run the `create-validator` txn on the validator nodes after spinup. Note this script is run as part of the `PostStartHook` of the validator pods. Default: [`create-validator.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/create-validator.sh)
* `transferTokens`: Script run as part of the Starship glue code. This script is related to the faucet that we run. Default: [`transfer-tokens.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/transfer-tokens.sh)
* `buildChain`: Script that builds chain binaries, based on the `build` directive. Default: [`build-chain.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/build-chain.sh)
* `createGenesis`: Script used in the genesis node that will create the `genesis.json` file. Default: [`create-genesis.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/create-genesis.sh)
* `updateGenesis`: Script used to make custom changes to the genesis file. Default: [`update-genesis.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/update-genesis.sh)
* `updateConfig`: Script used to make custom changes to the config files. Default: [`update-config.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/update-config.sh)
* `createValidator`: Script to run the `create-validator` txn on the validator nodes after spinup. Note this script is run as part of the `PostStartHook` of the validator pods. Default: [`create-validator.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/create-validator.sh)
* `transferTokens`: Script run as part of the Starship glue code. This script is related to the faucet that we run. Default: [`transfer-tokens.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/starship/devnet/scripts/default/transfer-tokens.sh)
* `buildChain`: Script that builds chain binaries, based on the `build` directive. Default: [`build-chain.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/build-chain.sh)

One can choose the sub-scripts that need to be overwritten, default scripts will be used instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/config/features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Here is a list of available endpoints and how to use them:
| `/ibc` | List all ibc info for all chains
| `/ibc/{chain_1}/{chain_2}` | IBC information between the 2 chains specified

Proto definition for the service is [here](https://github.com/cosmology-tech/starship/blob/main/proto/registry/service.proto)
Proto definition for the service is [here](https://github.com/cosmology-tech/starship/blob/main/starship/proto/registry/service.proto)

## Explorer
In order to provide a full fledged emulation environment, we have
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/config/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configuration

In Starship one can define the infra required with a simple config file.
The config file one specifies is merged with the default [`values.yaml`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml)
The config file one specifies is merged with the default [`values.yaml`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/values.yaml)
file before the infra is spun up. All supported directives are present in the default `values.yaml`. We will go over most used ones here.

Here is a basic example that will spin up:
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/config/relayers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ relayers:
Available endpoints on
* `rest` endpoints: https://hermes.informal.systems/documentation/rest-api.html?highlight=rest#rest-api
* `exposer` endpoint
* `/create_channel` endpoint: Supports post request. Proto defination: https://github.com/cosmology-tech/starship/blob/main/proto/exposer/service.proto#L47
* `/create_channel` endpoint: Supports post request. Proto defination: https://github.com/cosmology-tech/starship/blob/main/starship/proto/exposer/service.proto#L47

One can use the exposer endpoint on the relayer to create channel from outside.
Note: Still an experimental feature on exposer
Expand Down

0 comments on commit 12bd670

Please sign in to comment.