Skip to content

Latest commit

 

History

History

packages

README.md

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

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".

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

Deploying Starship 🚀

yarn starship start

Running End-to-End Tests 🧪

# test
yarn starship:test

# watch
yarn starship:watch

Teardown 🛠️

# stop ports and delete deployment
yarn starship stop

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 start --config ./config/settings.json

Run starhip (manually)

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({
  name: 'osmojs',
  config: 'path/to/config.yaml',
  repo: 'starship',
  repoUrl: 'https://hyperweb-io.github.io/starship/',
  chart: 'devnet',
  version: '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();

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

// using init for init the config and a default connected registry fetcher.
await ConfigContext.init(configFile);

Registry

Using init for init the config and pass an optional customized registry fetcher.

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

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

const fetcher = new ChainRegistryFetcher({
  // your own options
});

await ConfigContext.init(configFile, fetcher);

Or use useRegistry to get a registry fetcher.

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

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

const fetcher = await useRegistry(configFile);

await ConfigContext.init(configFile, fetcher);

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

Interchain JavaScript Stack ⚛️

A unified toolkit for building applications and smart contracts in the Interchain ecosystem

Category Tools Description
Chain Information Chain Registry, Utils, Client Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
Wallet Connectors Interchain Kitbeta, Cosmos Kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
Signing Clients InterchainJSbeta, CosmJS A single, universal signing interface for any network
SDK Clients Telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
Starter Kits Create Interchain Appbeta, Create Cosmos App Set up a modern Interchain app by running one command.
UI Kits Interchain UI The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
Testing Frameworks Starship Unified Testing and Development for the Interchain.
TypeScript Smart Contracts Create Hyperweb App Build and deploy full-stack blockchain applications with TypeScript
CosmWasm Contracts CosmWasm TS Codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.

Credits

🛠 Built by the Constructive team — makers of Hyperweb

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.