Quickstart

This guide provides a quick reference for setting up and using Telescope to generate TypeScript packages for Cosmos SDK modules. Here is the video for using create-interchain-app boilerplate: https://youtu.be/iQf6p65fbdY (opens in a new tab)

Installation

Install create-interchain-app:

npm install -g create-interchain-app

Package Generation

Using create-interchain-app boilerplate

Create a new package using the telescope boilerplate:

cia --boilerplate telescope

Navigate to the generated project:

cd ./your-project/packages/your-module
yarn install

Working with Protos

Download protocol buffer files:

yarn download-protos

This will clone repositories into ./git-modules and generate proto files in ./protos.

You can modify the configuration in ./scripts/download-protos.ts

Code Generation

Generate TypeScript code from proto files:

yarn codegen

You can modify the configuration in ./scripts/codegen.ts

Building

Build the package for distribution:

yarn build

Publishing

Use lerna for package management:

lerna publish