add faucet.type to docs

cosmology-tech · Sep 15, 2023 · 5ba63ee · 5ba63ee
1 parent 0e3ca35
commit 5ba63ee
Showing 1 changed file with 11 additions and 5 deletions.
diff --git a/docs/pages/config/chains.mdx b/docs/pages/config/chains.mdx
@@ -144,8 +144,11 @@ For more details on the resource directive have a look at [kubernetes resources]
 > We recommend to specify resources as per your requirements
 
 ## `faucet` (optional)
-Every genesis node runs a [cosmjs faucet](https://github.com/cosmos/cosmjs/tree/main/packages/faucet), by default
-setting for faucet [here](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml#L32...#L38) but can be
+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)
+
+Setting for cosmjs-faucet [here](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml#L32...#L38) but can be
 overridden with this directive, specially for compatible cosmjs version with the chain version.
 
 ```yaml
@@ -154,17 +157,20 @@ chains:
   type: osmosis
   numValidators: 1
   faucet:
-    image: ghcr.io/cosmology-tech/starship/cosmjs-faucet:v0.30.1
-    concurrency: 2          # default is 10
+    type: cosmjs            # default is cosmjs, allowed [cosmjs, starship]
+    image: ghcr.io/cosmology-tech/starship/cosmjs-faucet:v0.30.1  # optional, default image set if not specified
+    concurrency: 2          # optional, default is 5
     resources:
       cpu: "0.3"
       memory: "600M"
 ```
 
-Note `concurrency` in `faucet` is the number of concurrent requests the faucet can handle.
+> Note `concurrency` in `faucet` is the number of concurrent requests the faucet can handle.
 If you are running a chain with less resources, or want faster startup time,
 then you can reduce the `concurrency` to a lower number.
 
+> Note: use `faucet.type: starship` for chains not supported by `cosmjs`. Mainly `injective`, `evmos`, `cheqd` etc.
+
 ## `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)