readme

cosmology-tech · May 8, 2024 · 9f55b09 · 9f55b09
1 parent 38aeeca
commit 9f55b09
Show file tree

Hide file tree

Showing 4 changed files with 333 additions and 30 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Anmol
+Copyright (c) 2024 Interweb, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README-dev.md b/README-dev.md
@@ -0,0 +1,70 @@
+# Starship
+
+<p align="center" width="100%">
+    <img height="148" src="https://user-images.githubusercontent.com/10805402/242348990-c141d6cd-e1c9-413f-af68-283de029c3a4.png" />
+</p>
+
+<p align="center" width="100%">
+   <a href="https://github.com/cosmology-tech/starship/releases/latest"><img height="20" src="https://github.com/cosmology-tech/starship/actions/workflows/release.yaml/badge.svg"></a>
+   <a href="https://github.com/cosmology-tech/starship/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+   <a href="https://github.com/cosmology-tech/starship/actions/workflows/e2e-tests.yaml"><img height="20" src="https://github.com/cosmology-tech/starship/actions/workflows/e2e-tests.yaml/badge.svg"></a>
+   <a href="https://github.com/cosmology-tech/starship/actions/workflows/build.yaml"><img height="20" src="https://github.com/cosmology-tech/starship/actions/workflows/build.yaml/badge.svg"></a>
+   <a href="https://github.com/cosmology-tech/starship/actions/workflows/docs.yaml"><img height="20" src="https://github.com/cosmology-tech/starship/actions/workflows/docs.yaml/badge.svg"></a>
+   <a href="https://github.com/cosmology-tech/starship/actions/workflows/starship-docker.yaml"><img height="20" src="https://github.com/cosmology-tech/starship/actions/workflows/starship-docker.yaml/badge.svg"></a>
+</p>
+
+Universal interchain development environment in k8s. The vision of this project
+is to have a single easy to use developer environment with full testing support
+for multichain use cases
+
+## Installation
+In order to get started with starship, one needs to install the following
+* `kubectl`: https://kubernetes.io/docs/tasks/tools/
+* `kind`: https://kind.sigs.k8s.io/docs/user/quick-start/#installation
+* `helm`: https://helm.sh/docs/intro/install/
+* `jq`: https://stedolan.github.io/jq/download/
+* `yq`: https://github.com/mikefarah/yq/#install
+
+## Getting started
+Follow the steps here: https://docs.cosmology.zone/starship
+
+## Using helm chart
+In order to use the helm chart externally without this repo.
+```bash
+helm repo add starship https://cosmology-tech.github.io/starship
+helm repo update
+
+helm search repo starship/devnet
+```
+Fetch the values.yaml file and update them before installing the chart
+```bash
+helm show values starship/devnet > custom-values.yaml
+# change custom-values.yaml file
+
+helm install -f custom-values.yaml starship/devnet --generate-name
+```
+
+**NOTE: It is recommended to still copy the Makefile from the repo to use the handy commands**
+
+## Related
+
+Checkout these related projects:
+
+* [@cosmology/telescope](https://github.com/cosmology-tech/telescope) Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
+* [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
+* [chain-registry](https://github.com/cosmology-tech/chain-registry) Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
+* [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
+* [create-cosmos-app](https://github.com/cosmology-tech/create-cosmos-app) Set up a modern Cosmos app by running one command.
+* [interchain-ui](https://github.com/cosmology-tech/interchain-ui) The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
+* [starship](https://github.com/cosmology-tech/starship) Unified Testing and Development for the Interchain.
+
+## Credits
+
+🛠 Built by Cosmology — if you like our tools, please consider delegating to [our validator ⚛️](https://cosmology.zone/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.
diff --git a/clients/js/LICENSE b/clients/js/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Anmol
+Copyright (c) 2024 Interweb, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/clients/js/README.md b/clients/js/README.md
@@ -1,47 +1,280 @@
-# Starship
+# StarshipJS
 
-<p align="center" width="100%">
-    <img height="148" src="https://user-images.githubusercontent.com/10805402/242348990-c141d6cd-e1c9-413f-af68-283de029c3a4.png" />
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/10805402/242348990-c141d6cd-e1c9-413f-af68-283de029c3a4.png" width="80"><br />
+  StarshipJS enables developers to efficiently set up and test chains, explorers, and validators, making it easier to handle development projects spanning several blockchain networks.
 </p>
 
 <p align="center" width="100%">
   <a href="https://github.com/cosmology-tech/starship/actions/workflows/run-client-tests.yml">
     <img height="20" src="https://github.com/cosmology-tech/starship/actions/workflows/run-client-tests.yml/badge.svg" />
-  </a><a href="https://github.com/cosmology-tech/starship/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+  </a><a href="https://github.com/cosmology-tech/starship/blob/main/clients/js/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
 </p>
 
-Universal interchain development environment in k8s. The vision of this project
-is to have a single easy to use developer environment with full testing support
-for multichain use cases
+**StarshipJS** is the JS companion to deploy and manage [Starship](https://cosmology.zone/products/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
 
-## Installation
-In order to get started with starship, one needs to install the following
-* `kubectl`: https://kubernetes.io/docs/tasks/tools/
-* `kind`: https://kind.sigs.k8s.io/docs/user/quick-start/#installation
-* `helm`: https://helm.sh/docs/intro/install/
-* `jq`: https://stedolan.github.io/jq/download/
-* `yq`: https://github.com/mikefarah/yq/#install
+- [`StarshipJS`](https://github.com/cosmology-tech/starship/tree/main/clients/js/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`](https://github.com/cosmology-tech/starship/tree/main/clients/js/packages/cli): The command-line interface that allows developers to easily deploy, manage, and interact with starship directly from the terminal.
+- [`StarshipJS Client`](https://github.com/cosmology-tech/starship/tree/main/clients/js/packages/client): A client library that encapsulates interaction with starship, simplifying command executions and state management through an intuitive API.
 
-## Getting started
-Follow the steps here: https://docs.cosmology.zone/starship
+## Table of contents
 
-## Using helm chart
-In order to use the helm chart externally without this repo.
-```bash
-helm repo add starship https://cosmology-tech.github.io/starship
-helm repo update
+- [StarshipJS](#starshipjs)
+- [Features](#features)
+- [Packages](#packages)
+- [Table of contents](#table-of-contents)
+- [Install](#install)
+- [Recommended Usage](#recommended-usage-📘)
+  - [Deploying Starship](#deploying-starship-🚀)
+  - [Running End-to-End Tests](#running-end-to-end-tests-🧪)
+  - [Teardown](#teardown-🛠️)
+- [CLI Usage](#cli-usage)
+  - [Install the CLI](#install-the-cli)
+  - [Run Starship](#run-starship)
+  - [Teardown Starship](#teardown-starship)
+- [StarshipClient Usage](#starshipclient-usage)
+  - [Initializing the Client](#initializing-the-client)
+  - [Configuration](#configuration)
+  - [Setting UP and Installing the Chart](#setting-up-and-installing-the-chart)
+  - [Starting Port Forwarding](#starting-port-forwarding)
+  - [Stopping and Cleaning Up](#stopping-and-cleaning-up)
+- [Developing](#developing)
+- [Credits](#credits)
 
-helm search repo starship/devnet
+## Install
+
+Install the test utilities `starshipjs` and the CI client `@starship-ci/client`:
+
+```sh
+npm install starshipjs @starship-ci/client
 ```
-Fetch the values.yaml file and update them before installing the chart
-```bash
-helm show values starship/devnet > custom-values.yaml
-# change custom-values.yaml file
 
-helm install -f custom-values.yaml starship/devnet --generate-name
+### 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](https://github.com/osmosis-labs/osmojs/tree/main/packages/osmojs/starship) and replicating it.
+- Add your configs, similar to how it's done [here](https://github.com/osmosis-labs/osmojs/tree/main/packages/osmojs/starship/configs)
+- Add your workflows for github [like this](https://github.com/osmosis-labs/osmojs/blob/main/.github/workflows/e2e-tests.yaml)
+- Add `yarn starship` commands to your package.json scripts [like this](https://github.com/osmosis-labs/osmojs/blob/20d749c8c5a4ec3db374221dabdf185fa18025a3/packages/osmojs/package.json#L34C5-L38C74)
+— Note the jest configurations in the [osmojs package](https://github.com/osmosis-labs/osmojs/tree/main/packages/osmojs)
+
+
+This will allow you to run `yarn starship` to `setup`, `deploy`, `clean` and other `starship` commands:
+
+#### Deploying `Starship` 🚀
+
+```sh
+# 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 🧪
+
+```sh
+# test
+yarn starship:test
+
+# watch 
+yarn starship:watch
 ```
 
-**NOTE: It is recommended to still copy the Makefile from the repo to use the handy commands**
+#### Teardown 🛠️
+
+```sh
+# 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`](https://github.com/cosmology-tech/starship/tree/main/clients/js/packages/cli) documentation.
+
+### Install the CLI
+
+While it's not recommended due to upgrades and package management, you can install globally:
+
+```sh
+npm install -g @starship-ci/cli
+```
+
+### Run starship
+
+```sh
+starship setup --config ./config/settings.json
+starship deploy --config ./config/settings.json
+starship start-ports --config ./config/settings.json
+```
+
+### Teardown starship
+
+```sh
+starship undeploy --config ./config/settings.json
+starship teardown --config ./config/settings.json
+```
+
+## StarshipClient Usage
+
+See more info in the [`StarshipJS Client`](https://github.com/cosmology-tech/starship/tree/main/clients/js/packages/client) documentation.
+
+### Install the StarshipClient
+
+Install the CI client `@starship-ci/client`:
+
+```sh
+npm install @starship-ci/client
+```
+
+### Initializing the Client
+
+First, you need to import and initialize the `StarshipClient` with your Helm configuration:
+
+```js
+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:
+
+```js
+client.loadConfig();
+```
+
+If you don't have one, you can set and save a configuration directly from the client:
+
+```js
+client.setConfig(config);
+client.saveConfig(config);
+```
+
+### Setting Up and Installing the Chart
+
+After initializing, set up the environment and install the starship helm chart:
+
+```js
+// 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:
+
+```js
+client.startPortForward();
+```
+
+### Stopping and Cleaning Up
+
+Once done with development or testing, you can stop the port forwarding and remove the Helm chart:
+
+```js
+// stop port forwarding
+// remove the deployed release from your Kubernetes cluster
+client.undeploy();
+
+// remove the helm chart
+client.teardown();
+```
+
+## StarshipJS Usage 
+
+[`StarshipJS`](https://github.com/cosmology-tech/starship/tree/main/clients/js/packages/starshipjs) is a utility library that provides helpers to leverage [Starship](https://github.com/cosmology-tech/starship)'s internal chain registry, emulating the style of code used in projects like [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit).
+
+### StarshipJS Configuration
+
+Before using StarshipJS, you need to set up the configuration for your blockchain network.
+
+```js
+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
+
+```js
+import { useRegistry, ConfigContext } from 'starshipjs';
+
+ConfigContext.setRegistry(await useRegistry(Config.configFile));
+```
+
+## Chain Info
+
+Get detailed chain information about the blockchain network:
+
+```js
+const { chainInfo } = useChain('osmosis');
+
+console.log(chainInfo);
+```
+
+## Credits and Faucets
+
+If your blockchain network supports faucets, you can use them to get test tokens:
+
+```js
+const { creditFromFaucet } = useChain('osmosis');
+const address = 'your-blockchain-address';
+
+await creditFromFaucet(address);
+```
+
+## Developing
+
+
+When first cloning the repo:
+```
+yarn
+yarn build
+```
 
 ## Related