@starship-ci/client

StarshipJS

StarshipJS enables developers to efficiently set up and test chains, explorers, and validators, making it easier to handle development projects spanning several blockchain networks.

StarshipJS is the JS companion to deploy and manage Starship, tailored specifically for Node.js and TypeScript developers. This toolkit provides a seamless, easy-to-use interface that dramatically simplifies the development, testing, and deployment of interchain applications, whether on your local machine or CI/CD environments.

Designed with simplicity and speed in mind, StarshipJS enables developers to quickly integrate Starship into their blockchain projects without complex orchestration.

Features

👨🏻‍💻 Node.js and TypeScript Focused: Tailored specifically for JavaScript ecosystems, StarshipJS brings simplicity to multi-chain development for Node.js and TypeScript environments, streamlining the setup and coding processes.

🚀 Simplified Interchain Development: Enables the straightforward creation of applications that span multiple blockchain networks. This simplifies complex blockchain interactions, enhancing interoperability and making it easier to build sophisticated interchain solutions.

🔒 Security-First Approach: StarshipJS incorporates security best practices from the ground up. Facilitates secure coding practices and configurations, helping developers build secure blockchain applications by default, reducing the risk of vulnerabilities.

Table of contents

• StarshipJS
• Table of contents
• Install
• Recommended Usage
  • Deploying Starship
  • Running End-to-End Tests
  • Teardown
• Advanced Usage
  • Initializing the Client
  • Configuration
  • Starting Port Forwarding
  • Stopping And Cleaning up
• Developing
• Credits

Install

Install the test utilities library, @starship-ci/client with npm or yarn:

npm install @starship-ci/client

Recommended Usage 📘

Stay tuned for a create-cosmos-app boilerplate! For now, this is the most recommended setup. Consider everything else after this section "advanced setup".

• We recommend studying the osmojs starship integration and replicating it.
• Add your configs, similar to how it's done here
• Add your workflows for GitHub Actions like this
• Add yarn starship commands to your package.json scripts like this — Note the jest configurations in the osmojs package

This will allow you to run yarn starship to start, setup, deploy, stop and other starship commands:

Deploying Starship 🚀

yarn starship start

# sanity check
yarn starship get-pods

Running End-to-End Tests 🧪

# test
yarn starship:test

# watch 
yarn starship:watch

Teardown 🛠️

# stop ports and delete deployment
yarn starship stop

Advanced Usage

Manual setup

Instead of using yarn starship start, you can also to each step, and do checks in between:

# setup helm/starship
yarn starship setup

# sanity check
yarn starship get-pods

# deploy starship
yarn starship deploy

# wait til STATUS=Running
yarn starship get-pods

# port forwarding
yarn starship start-ports

# check pids
yarn starship port-pids

The StarshipClient simplifies managing Kubernetes resources, specifically tailored for developers working in interchain environments. Below is an example showing how to instantiate the client and use it to manage a Helm deployment:

Initializing the Client

First, you need to import and initialize the StarshipClient with your Helm configuration:

import { StarshipClient } from '@starship-ci/client';

const client = new StarshipClient({
  helmName: 'osmojs',
  helmFile: 'path/to/config.yaml',
  helmRepo: 'starship',
  helmRepoUrl: 'https://cosmology-tech.github.io/starship/',
  helmChart: 'devnet',
  helmVersion: 'v0.2.3'
});

Configuration

After initializing, you can load in your config. Assuming you have a yaml file:

client.loadConfig();

If you don't have one, you can set and save a configuration directly from the client:

client.setConfig(config);
client.saveConfig(config);

Setting Up and Installing the Chart

After initializing, set up the environment and install the starship helm chart:

// adds helm chart to registry
client.setup();
// installs helm chart
client.deploy();

Starting Port Forwarding

For local development, you might need to forward ports from your Kubernetes pods:

client.startPortForward();

Stopping and Cleaning Up

Once done with development or testing, you can stop the port forwarding and remove the Helm chart:

// stop port forwarding
// remove the deployed release from your Kubernetes cluster
client.undeploy();

// remove the helm chart
client.teardown();

Developing

When first cloning the repo:

yarn
yarn build

Related

Checkout these related projects:

• @cosmology/telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
• @cosmwasm/ts-codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
• chain-registry Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
• cosmos-kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
• create-cosmos-app Set up a modern Cosmos app by running one command.
• interchain-ui The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
• starship Unified Testing and Development for the Interchain.

Credits

🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.