Starship

starship

Starship is a unified development environment that allows Cosmos developers to spin up a fully simulated mini-cosmos ecosystem and write end-to-end test cases

Go to the Official Project (opens in a new tab) (👷‍♀️in progress...).

Quick Start Guide

Prerequisites

To get started, you'll need:

Kubernetes setup (recommended: Docker Desktop with Kubernetes support for local setups): Docker Desktop (opens in a new tab)
kubectl: Installation Guide (opens in a new tab)
helm: Installation Guide (opens in a new tab)

For further information, refer to the Starship Documentation (opens in a new tab) on Kubernetes setup and configuration.

Install

Install the CLI @starship-ci/cli:

npm install -g @starship-ci/cli

Configuration

To configure Starship for multichain support, create a configuration file (e.g., config.yaml). Here’s a sample configuration:

name: starship-localnet
version: 1.5.0
 
chains:
- id: osmosis-1
  name: osmosis
  numValidators: 2
  ports:
    rest: 1313
    rpc: 26653
    faucet: 8003
- id: cosmoshub-4
  name: cosmoshub
  numValidators: 2
  ports:
    rest: 1317
    rpc: 26657
    faucet: 8007
 
relayers:
- name: osmos-cosmos
  type: hermes
  replicas: 1
  chains:
    - osmosis-1
    - cosmoshub-4
 
explorer:
  enabled: true
  ports:
    rest: 8080
 
registry:
  enabled: true
  ports:
    rest: 8081

For more details on the configuration options and directives available, refer to the Starship Config (opens in a new tab).

Versions & Compatibility

Current Versions

Component	Version	Link
Helm Chart	1.4.0	-
Starship NPM CLI	3.4.0	NPM (opens in a new tab)
NPM Client	3.4.0	NPM (opens in a new tab)
NPM StarshipJS	3.3.0	NPM (opens in a new tab)
Starship GitHub Action	0.5.9	Github Action (opens in a new tab)

Compatibility Matrix

Starship Version	Helm Chart	NPM CLI	NPM Client	StarshipJS	GitHub Action
1.4.0	✅ 1.4.0	✅ 3.4.0	✅ 3.4.0	✅ 3.3.0	✅ 0.5.9
1.3.0	✅ 1.3.0	✅ 3.3.0	✅ 3.3.0	✅ 3.3.0	✅ 0.5.9
1.2.0	✅ 1.2.0	✅ 3.2.0	✅ 3.2.0	✅ 3.0.0	✅ 0.5.8
1.1.0	✅ 1.1.0	✅ 3.1.0	✅ 3.1.0	✅ 3.0.0	✅ 0.5.6
1.0.0	✅ 1.0.0	✅ 3.0.0	✅ 3.0.0	✅ 3.0.0	✅ 0.5.5

Note: Starship version 1.2.0+ requires Helm 1.2.0+ and NPM CLI 3.2.0+ for full functionality.

Running Starship

Deploying 🚀

yarn starship start --config config.yaml

Teardown 🛠️

# stop ports and delete deployment
yarn starship stop --config config.yaml

Who is using Starship?

Cosmos-sdk (opens in a new tab)

Cosmos-SDK is running Starship for testing out the latest simapp. Runs in CI/CD (opens in a new tab)

Agoric SDK (opens in a new tab)

Agoric SDK is using Starship to run end-to-end tests for Agoric chain. Runs in CI/CD. Running 4 chains and relayers between them, then using JS based custom e2e testing system that they built.

Mesh-Security (opens in a new tab)

For mesh-security development, Starship is being used to create a dev environment in a cloud cluster to run 2 chains and a relayer, setup mesh-security contracts between them, as well as spin up mesh-security frontend as well.

OsmoJS (opens in a new tab)

JS library using Starship to run end-to-end tests against Osmosis chain. (Run in CI/CD)

persistenceCore (opens in a new tab)

Persistence Core chain using Starship to test chain upgrades. (Run in CI/CD)