Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
joroshiba committed Apr 2, 2024
1 parent d7aebce commit f5c3cba
Show file tree
Hide file tree
Showing 90 changed files with 5,311 additions and 0 deletions.
226 changes: 226 additions & 0 deletions charts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
# Astria Charts

This directory contains Helm charts which can be used to deploy Astria
components, and run the full Astria stack.

## Dependencies

Main dependencies

* docker - <https://docs.docker.com/get-docker/>
* kubectl - <https://kubernetes.io/docs/tasks/tools/>
* helm - <https://helm.sh/docs/intro/install/>
* kind - <https://kind.sigs.k8s.io/docs/user/quick-start/#installation>
* just - <https://just.systems/man/en/chapter_4.html>

For contract deployment:

* Forge (part of Foundry) -
<https://book.getfoundry.sh/getting-started/installation>

## Setup

In order to startup you will need to have docker running on your machine

### Configuring Funding of Geth

By default, running this local rollup will fund a wallet address
`0xaC21B97d35Bf75A7dAb16f35b111a50e78A72F30`, which you can add to your
preferred wallet using the private key in
`helm/rollup/files/keys/private_key.txt`. This account should never be used for
anything but test transactions.

To change the wallet account which receives funds, use the `deploy-rollup`
command with the optional arguments `evm_funding_address` and
`evm_funding_private_key`.

```bash
# create control plane cluster
just deploy cluster

# ingress controller
just deploy ingress-controller

# wait for ingress.
just wait-for-ingress-controller

# Deploys Sequencer + local DA
just deploy astria-local

# Deploys a geth rollup chain + faucet + blockscout + ingress
# w/ defaults running against local network
# NOTE - default values can be found in `helm/rollup/values.yaml`
just deploy dev-rollup
# w/ custom name and id
just deploy dev-rollup <rollup_name> <network_id>
# w/ custom name, id, and funding address
just deploy dev-rollup <rollup_name> <network_id> <evm_funding_address> <evm_funding_private_key>

# Delete default rollup
just delete rollup
# Delete custom rollup
just delete rollup <rollup_name>

# Delete the entire cluster
just clean

# Delete local persisted data (note: persisted data disabled by default)
just clean-persisted-data
```

### Faucet

The default rollup faucet is available at <http://faucet.astria.localdev.me>.

If you deploy a custom faucet, it will be reachable at
`http://faucet.<rollup_name>.localdev.me`.

By default, the faucet is funded by the account that is funded during geth
genesis. This key is defined in `./evm-rollup/values.yaml` and is identical to
the key in `./evm-rollup/files/keys/private_key.txt`.

### Blockscout

The default Blockscout app is available at <http://blockscout.astria.localdev.me>.

If you deploy a custom Blockscout app, it will be available at
`http://blockscout.<rollup_name>.localdev.me`.

### Sequencer

The default sequencer RPC is available at <http://rpc.sequencer.localdev.me/health>.

### EVM Rollup

The default EVM rollup has an RPC endpoint available at <http://executor.astria.localdev.me>.

There is also a default WSS endpoint available at <ws://ws-executor.astria.localdev.me>.

If you deploy a custom rollup, then the endpoints will be
`http://executor.<rollup_name>.localdev.me` and `ws://ws-executor.<rollup_name>.localdev.me`

### Connecting Metamask

* adding the default network
* network name: `astria`
* rpc url: `http://executor.astria.localdev.me`
* chain id: `912559`
* currency symbol: `RIA`

* adding a custom network
* network name: `<rollup_name>`
* rpc url: `http://executor.<rollup_name>.localdev.me`
* chain id: `<network_id>`
* currency symbol: `RIA`

### Using a local image

Deployment files can be updated to use a locally built docker image, for testing
of local changes. [here](https://github.com/astriaorg/astria/#docker-build).

Once you have a locally built image, update the image in the relevant deployment
to point to your local image, and upload load it into into the cluster. If you
don't already have a cluster running, first run:

```sh
# create control plane cluster
just deploy cluster
```

Then you can run the load-image command with your image name. For instance, if
we have created a local image `astria-sequencer:local`

```sh
# load image into cluster
just load-image astria-sequencer:local
```

To update the chart to utilize the new image, go to `./sequencer/values.yaml`
update the `images.sequencer` image repo to `astria-sequencer` and the `devTag`
to `local`. You can now deploy the chart with your local image.

## Chart Structure

### Dev vs Prod

All of our charts should run against both the lastest code in monorepo AND
against the latest release. Sometimes, there are configuration changes between
releases though. To manage this in various templates you will see the following
pattern (especially in config maps and genesis files):

```yaml
{{- if not .Values.global.dev }}
// information which should be deleted after next cut release
{{- else }}
// things that are only needed for latest, should be promoted at end of release.
{{- end }}
```

## Running a Smoke Test

You can run a basic smoke test, which deploys the astria components and a basic
rollup, runs a tx e2e to ensure it has executed correctly.

To deploy and run this:

```sh
# only if cluster not already created
> just deploy cluster
> just deploy smoke-test
# deploys all components needed to run the smoke test
> just run-smoke-test
# Runs the smoke test will return failure if fails
> just delete smoke-test
# Clean up deployed test
```

## Examing Deployments

[k9s](https://k9scli.io/) is a useful utility for inspecting deployed
containers, logs and services. Additionally you may interact directly with the
kubernetes API some helpful commands below.

### Helpful commands

The following commands are helpful for interacting with the cluster and its
resources. These may be useful for debugging and development, but are not
necessary for running the cluster.

```sh
# list all containers within a deployment
kubectl get -n astria-dev-cluster deployment <DEPLOYMENT_NAME> -o jsonpath='{.spec.template.spec.containers[*].name}'

# log the entire astria cluster
kubectl logs -n astria-dev-cluster -l app=astria-dev-cluster -f

# log nginx controller
kubectl logs -n ingress-nginx -f deployment/ingress-nginx-controller

# list nodes
kubectl get -n astria-dev-cluster nodes

# list pods
kubectl get --all-namespaces pods
kubectl get -n astria-dev-cluster pods

# to log a container you need to first grab the pod name from above
kubectl logs -n astria-dev-cluster -c <CONTAINER_NAME> <POD_NAME>

# delete a single deployment
just delete -n astria-dev-cluster deployment <DEPLOYMENT_NAME>

# delete cluster and resources
just clean

# example of deploying contract w/ forge (https://github.com/foundry-rs/foundry)
RUST_LOG=debug forge create src/Storage.sol:Storage \
--private-key $PRIV_KEY \
--rpc-url "http://executor.astria.localdev.me"
```

### Helpful links

* <https://kubernetes.io/docs/concepts/workloads/pods/init-containers/>
* <https://kubernetes.io/docs/concepts/configuration/configmap/>
* <https://kubernetes.io/docs/reference/kubectl/cheatsheet/>
* <https://jamesdefabia.github.io/docs/user-guide/kubectl/kubectl_logs/>
23 changes: 23 additions & 0 deletions charts/celestia-local/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
32 changes: 32 additions & 0 deletions charts/celestia-local/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
apiVersion: v2
name: celestia-local
description: A Helm chart for Kubernetes

# A chart can be either an 'application' or a 'library' chart.
#
# Application charts are a collection of templates that can be packaged into versioned archives
# to be deployed.
#
# Library charts provide useful utilities or functions for the chart developer. They're included as
# a dependency of application charts to inject those utilities and functions into the rendering
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
type: application

# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.3.6

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "1.3.0"

maintainers:
- name: wafflesvonmaple
url: astria.org
- name: steezeburger
url: astria.org
- name: joroshiba
url: astria.org
19 changes: 19 additions & 0 deletions charts/celestia-local/files/scripts/init-bridge.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#!/bin/sh

set -o errexit -o nounset

# if bridge config already exists then exit early
if [ -f "$home_dir/bridge/config.toml" ]; then
exit 0
fi

celestia bridge init \
--node.store "$home_dir/bridge" \
--core.ip 127.0.0.1 \
--core.rpc.port $celestia_app_host_port \
--core.grpc.port $celestia_app_grpc_port \
--gateway.port $bridge_host_port
cp -r "$home_dir/keyring-test" "$home_dir/bridge/keys/"

sed -i 's/PeersLimit = 5/PeersLimit = 1/' $home_dir/bridge/config.toml
sed -i 's/Low = 50/Low = 0/' $home_dir/bridge/config.toml
32 changes: 32 additions & 0 deletions charts/celestia-local/files/scripts/init-celestia-appd.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/bin/sh

set -o errexit -o nounset

# if app config already exists then we have already ran initialization.
if [ -f "$home_dir/config/config.toml" ]; then
exit 0
fi

celestia-appd init "$chainid" \
--chain-id "$chainid" \
--home "$home_dir"

celestia-appd keys add \
"$validator_key_name" \
--keyring-backend="$keyring_backend" \
--home "$home_dir"

validator_key=$(celestia-appd keys show "$validator_key_name" -a --keyring-backend="$keyring_backend" --home "$home_dir")
celestia-appd add-genesis-account \
"$validator_key" \
--home "$home_dir" \
"$coins"

celestia-appd gentx \
"$validator_key_name" \
"$validator_stake" \
--keyring-backend="$keyring_backend" \
--chain-id "$chainid" \
--home "$home_dir" \

celestia-appd collect-gentxs --home "$home_dir"
Loading

0 comments on commit f5c3cba

Please sign in to comment.