cosmology-tech / StarshipJS

StarshipJS is the JS companion to deploy and manage Starship aimed to simplify testing for apps that span multiple blockchain networks

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.

Packages

• StarshipJS: A JavaScript library providing the foundational tools and utilities for starship development, designed to work seamlessly with Node.js and TypeScript.
• StarshipJS CLI: The command-line interface that allows developers to easily deploy, manage, and interact with starship directly from the terminal.
• StarshipJS Client: A client library that encapsulates interaction with starship, simplifying command executions and state management through an intuitive API.

Table of contents

• StarshipJS
• Features
• Packages
• Table of contents
• Install
• Recommended Usage
  • Deploying Starship
  • Running End-to-End Tests
  • Teardown
• CLI Usage
  • Install the CLI
  • Run Starship
  • Teardown Starship
• StarshipClient Usage
  • Initializing the Client
  • Configuration
  • Setting UP and Installing the Chart
  • Starting Port Forwarding
  • Stopping and Cleaning Up
• Developing
• Credits

Install

Install the test utilities starshipjs and the CI client @starship-ci/client:

npm install starshipjs @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 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 setup, deploy, clean and other starship commands:

Deploying Starship 🚀

# 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

Running End-to-End Tests 🧪

# test
yarn starship:test

# watch 
yarn starship:watch

Teardown 🛠️

# stop port forwarding (done by clean() too)
# yarn starship stop-ports

# stop ports and delete & remove helm chart
yarn starship clean

CLI Usage

See more usage in the StarshipJS CLI documentation.

Install the CLI

While it's not recommended due to upgrades and package management, you can install globally:

npm install -g @starship-ci/cli

Run starship

starship setup --config ./config/settings.json
starship deploy --config ./config/settings.json
starship start-ports --config ./config/settings.json

Teardown starship

starship undeploy --config ./config/settings.json
starship teardown --config ./config/settings.json

StarshipClient Usage

See more info in the StarshipJS Client documentation.

Install the StarshipClient

Install the CI client @starship-ci/client:

npm install @starship-ci/client

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.1.38'
});

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();

StarshipJS Usage

StarshipJS is a utility library that provides helpers to leverage Starship's internal chain registry, emulating the style of code used in projects like cosmos-kit.

StarshipJS Configuration

Before using StarshipJS, you need to set up the configuration for your blockchain network.

import { ConfigContext } from 'starshipjs';
import { join } from 'path';

// Path to your YAML configuration file
const configFile = join(__dirname, 'your-config.yaml');

// Set the configuration file in StarshipJS
ConfigContext.setConfigFile(configFile);

Registry

import { useRegistry, ConfigContext } from 'starshipjs';

ConfigContext.setRegistry(await useRegistry(Config.configFile));

Chain Info

Get detailed chain information about the blockchain network:

const { chainInfo } = useChain('osmosis');

console.log(chainInfo);

Credits and Faucets

If your blockchain network supports faucets, you can use them to get test tokens:

const { creditFromFaucet } = useChain('osmosis');
const address = 'your-blockchain-address';

await creditFromFaucet(address);

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.