starshipjs v2.4.1

StarshipJS

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
• Using with CI/CD
• Using the Client
• Developing
• Credits

Install

Install the test utilities starshipjs:

npm install starshipjs

Using with CI/CD

NOTE: Before you code! You'll want to use the CLI tool (@starship-ci/cli) in a package.json to get starship working.

Install the packages

Install @starship-ci/cli and starshipjs

yarn add --dev starshipjs @starship-ci/cli

Add your configuration files, similar to these:

• Example config.yaml

• Example starship.yaml

• Example jest.config.js

Update your package.json scripts:

"starship": "starship --config ./starship/configs/starship.yaml",
"starship:test": "jest --config ./jest.starship.config.js --verbose --bail",
"starship:watch": "jest --watch --config ./jest.starship.config.js"

See an example here.

Start starship 🚀

yarn starship start

Manual setup & start

yarn starship setup
yarn starship deploy
yarn starship start-ports

Stopping starship

yarn starship stop

Using the Client

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.

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

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.