You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -111,22 +111,11 @@ The following blockchain libraries (generated by Telescope) are available via np
111
111
112
112
Follow the instructions below to generate a new Typescript package that you can publish to npm. You can also follow the video: https://youtu.be/iQf6p65fbdY
113
113
114
-
First, install `telescope`
115
-
```sh
116
-
npm install -g @cosmology/telescope
117
-
```
118
-
119
-
then install either
120
-
121
114
`create-interchain-app`
122
115
```sh
123
116
npm install -g create-interchain-app
124
117
```
125
-
Or
126
-
`create-cosmos-app`
127
-
```sh
128
-
npm install -g create-cosmos-app
129
-
```
118
+
130
119
131
120
### Generate
132
121
@@ -135,13 +124,6 @@ Use the [`create-interchain-app`](https://github.com/hyperweb-io/create-intercha
135
124
```sh
136
125
cia --boilerplate telescope
137
126
138
-
or
139
-
140
-
Use the [`create-cosmos-app`](https://github.com/hyperweb-io/create-cosmos-app/) command to create a new package from the `telescope` boilerplate.
141
-
142
-
```sh
143
-
cca --boilerplate telescope
144
-
```
145
127
146
128
Then, you'll navigate into `./your-project/packages/telescope` package for the next steps.
147
129
@@ -181,11 +163,117 @@ yarn build
181
163
182
164
### Publishing
183
165
184
-
Now you should have code inside of your `./src` folder, ready for publshing. If you used the `create-cosmos-app` boilerplate, use `lerna` to publish (and/or read the README in the boilerplate for instructions), or run `npm publish` from your repository.
166
+
Now you should have code inside of your `./src` folder, ready for publshing. If you used the `create-interchain-app` boilerplate, use `lerna` to publish (and/or read the README in the boilerplate for instructions), or run `npm publish` from your repository.
185
167
186
168
# Usage
187
169
188
-
## Programatic Usage
170
+
## Advanced Install
171
+
The methods below are all the options you can use to install and use Telescope
172
+
173
+
### Telescope CLI
174
+
Install telescope
175
+
```sh
176
+
npm install -g @cosmology/telescope
177
+
```
178
+
The steps by order are: generate, download and transpile.
3. Transpile (Generate TypeScript code from proto files):
221
+
Use default telescope option:
222
+
```sh
223
+
telescope transpile
224
+
```
225
+
226
+
Use customized telescope option:
227
+
```sh
228
+
telescope transpile --config your-config.json
229
+
```
230
+
231
+
### CIA
232
+
Please follow the video: https://youtu.be/iQf6p65fbdY
233
+
Or [Go to Quickstart](#quickstart)
234
+
235
+
### CCA
236
+
First, install `create-cosmos-app`
237
+
238
+
```sh
239
+
npm install -g create-cosmos-app
240
+
```
241
+
242
+
Use the [`create-cosmos-app`](https://github.com/hyperweb-io/create-cosmos-app/) command to create a new package from the `telescope` boilerplate.
243
+
244
+
```sh
245
+
cca --boilerplate telescope
246
+
```
247
+
248
+
Then, you'll navigate into `./your-project/packages/telescope` package for the next steps.
249
+
250
+
Install dependency and use cli to download the protos you want.
251
+
```sh
252
+
yarn install
253
+
telescope download --config ./your.config.json
254
+
```
255
+
256
+
To create the Typescript files for your chain, run the `yarn codegen`command inside of the package.
257
+
258
+
```sh
259
+
yarn codegen
260
+
```
261
+
262
+
### Manual install
263
+
If you want to use telescope in your own project.
264
+
265
+
Run the commandin ./your-project
266
+
```sh
267
+
yarn add --dev @cosmology/telescope
268
+
```
269
+
Install helpers and cosmjs [dependencies listed here](#dependencies)
270
+
271
+
We recommand to use [Go to Programatic Usage](#programatic-usage)
272
+
273
+
You can also use [Go to Telescope Cli](#telescope-cli)
274
+
To be noted for cli command, add 'npx' or 'yarn' prefix when you use it within your project. For instance: 'yarn telescope generate', 'npx telescope download', etc.
.then(() => console.log('✅ Proto download completed'))
311
+
// @ts-ignore
312
+
.catch((error) => {
313
+
console.error('❌ Proto download failed:', error);
314
+
process.exit(1);
315
+
});
316
+
```
317
+
318
+
Transpile command example:
198
319
```js
199
320
import { join } from 'path';
200
321
import telescope from '@cosmology/telescope';
@@ -1269,7 +1390,7 @@ A unified toolkit for building applications and smart contracts in the Interchai
1269
1390
| **Wallet Connectors**| [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)<sup>beta</sup>, [**Cosmos Kit**](https://github.com/hyperweb-io/cosmos-kit) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |
1270
1391
| **Signing Clients** | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)<sup>beta</sup>, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |
1271
1392
| **SDK Clients** | [**Telescope**](https://github.com/hyperweb-io/telescope) | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
1272
-
|**Starter Kits**| [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)<sup>beta</sup>, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app)| Set up a modern Interchain app by running one command. |
1393
+
| **Starter Kits** | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)<sup>beta</sup> | Set up a modern Interchain app by running one command. |
1273
1394
| **UI Kits** | [**Interchain UI**](https://github.com/hyperweb-io/interchain-ui) | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |
1274
1395
| **Testing Frameworks** | [**Starship**](https://github.com/hyperweb-io/starship) | Unified Testing and Development for the Interchain. |
1275
1396
| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app) | Build and deploy full-stack blockchain applications with TypeScript |
0 commit comments