Skip to content

Commit 2f69f1c

Browse files
committed
fix starship README
1 parent 6c194d2 commit 2f69f1c

File tree

3 files changed

+38
-117
lines changed

3 files changed

+38
-117
lines changed

networks/cosmos/starship/README.md

Lines changed: 9 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,18 @@ Deploy
66
# setup helm/starship
77
yarn starship setup
88

9+
# deploy starship, the command will wait until all pods are running
10+
yarn starship:all
11+
912
# sanity check
1013
yarn starship get-pods
11-
12-
# deploy starship
13-
yarn starship deploy
14-
15-
# wait til STATUS=Running
16-
yarn starship wait-for-pods
17-
or
18-
watch yarn starship get-pods
19-
20-
# port forwarding
21-
yarn starship start-ports
22-
23-
# check pids
24-
yarn starship port-pids
2514
```
2615

2716
Run Tests
2817

2918
```sh
3019
# test
3120
yarn starship:test
32-
33-
# watch
34-
yarn starship:watch
3521
```
3622

3723
Teardown
@@ -41,7 +27,7 @@ Teardown
4127
# yarn starship stop-ports
4228

4329
# stop ports and delete & remove helm chart
44-
yarn starship clean
30+
yarn starship:clean
4531
```
4632

4733
## 1. Installation
@@ -78,12 +64,6 @@ to a kubernetes cluster locally.
7864

7965
NOTE: Resources constraint on local machine will affect the performance of Starship spinup time
8066

81-
```bash
82-
yarn starship setup-kind
83-
```
84-
85-
Run the following command to check connection to a k8s cluster
86-
8767
```bash
8868
kubectl get pods
8969
```
@@ -95,7 +75,9 @@ Now with the dependencies and a kubernetes cluster in handy, we can proceed with
9575
Run
9676

9777
```bash
98-
yarn starship deploy
78+
yarn starship:all
79+
# or
80+
yarn starship start
9981
```
10082

10183
We use the config file `configs/config.yaml` as the genesis file to define the topology of the e2e test infra. Change it as required
@@ -110,7 +92,7 @@ our end-to-end tests.
11092
Run
11193

11294
```bash
113-
npm run starship:test
95+
yarn starship:test
11496
```
11597

11698
## 5. Stop the infra
@@ -120,22 +102,14 @@ The tests should be ideompotent, so the tests can be run multiple times (which i
120102
Once the state of the mini-cosmos is corrupted, you can stop the deployments with
121103

122104
```bash
123-
npm run starship clean
105+
yarn starship:clean
124106
```
125107

126108
Which will
127109

128110
- Stop port-forwarding the traffic to your local
129111
- Delete all the helm charts deployed
130112

131-
## 6. Cleanup kind (optional)
132-
133-
If you are using kind for your kubernetes cluster, you can delete it with
134-
135-
```bash
136-
yarn starship clean-kind
137-
```
138-
139113
## Related
140114

141115
Checkout these related projects:

networks/ethereum/starship/README.md

Lines changed: 20 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,31 @@
33
Deploy
44

55
```sh
6-
yarn starship
6+
# setup helm/starship
7+
yarn starship setup
8+
9+
# deploy starship, the command will wait until all pods are running
10+
yarn starship:all
11+
12+
# sanity check
13+
yarn starship get-pods
714
```
815

916
Run Tests
1017

1118
```sh
19+
# test
1220
yarn starship:test
1321
```
1422

1523
Teardown
1624

1725
```sh
18-
yarn starship:stop
19-
```
20-
21-
Port fording manually if needed
22-
```sh
23-
kubectl port-forward pods/ethereum-1337-0 8545:8545
24-
```
25-
26-
Get chain id from node
27-
```sh
28-
curl -X POST -H "Content-Type: application/json" \
29-
--data '{"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":1}' \
30-
http://localhost:8545/
31-
```
32-
33-
Get balance:
34-
```sh
35-
curl -X POST \
36-
-H "Content-Type: application/json" \
37-
--data '{"jsonrpc":"2.0","method":"eth_getBalance","params":["0x7e5f4552091a69125d5dfcb7b8c2659029395bdf", "latest"],"id":1}' \
38-
http://localhost:8545
39-
```
26+
# stop port forwarding (done by clean() too)
27+
# yarn starship stop-ports
4028

41-
use ws to get latest block height:
42-
```sh
43-
wscat -c ws://127.0.0.1:8546
44-
```
45-
and then paste:
46-
```
47-
{"jsonrpc": "2.0", "id": 1, "method": "eth_subscribe", "params": ["newHeads"]}
29+
# stop ports and delete & remove helm chart
30+
yarn starship:clean
4831
```
4932

5033
## 1. Installation
@@ -81,12 +64,6 @@ to a kubernetes cluster locally.
8164

8265
NOTE: Resources constraint on local machine will affect the performance of Starship spinup time
8366

84-
```bash
85-
yarn starship setup-kind
86-
```
87-
88-
Run the following command to check connection to a k8s cluster
89-
9067
```bash
9168
kubectl get pods
9269
```
@@ -98,7 +75,9 @@ Now with the dependencies and a kubernetes cluster in handy, we can proceed with
9875
Run
9976

10077
```bash
101-
yarn starship deploy
78+
yarn starship:all
79+
# or
80+
yarn starship start
10281
```
10382

10483
We use the config file `configs/config.yaml` as the genesis file to define the topology of the e2e test infra. Change it as required
@@ -113,7 +92,7 @@ our end-to-end tests.
11392
Run
11493

11594
```bash
116-
npm run starship:test
95+
yarn starship:test
11796
```
11897

11998
## 5. Stop the infra
@@ -123,31 +102,23 @@ The tests should be ideompotent, so the tests can be run multiple times (which i
123102
Once the state of the mini-cosmos is corrupted, you can stop the deployments with
124103

125104
```bash
126-
npm run starship clean
105+
yarn starship:clean
127106
```
128107

129108
Which will
130109

131110
- Stop port-forwarding the traffic to your local
132111
- Delete all the helm charts deployed
133112

134-
## 6. Cleanup kind (optional)
135-
136-
If you are using kind for your kubernetes cluster, you can delete it with
137-
138-
```bash
139-
yarn starship clean-kind
140-
```
141-
142113
## Related
143114

144115
Checkout these related projects:
145116

146117
- [@cosmology/telescope](https://github.com/hyperweb-io/telescope) Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
147118
- [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
148119
- [chain-registry](https://github.com/hyperweb-io/chain-registry) Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
149-
- [interchain-kit](https://github.com/hyperweb-io/interchain-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
150-
- [create-interchain-app](https://github.com/hyperweb-io/create-interchain-app) Set up a modern Cosmos app by running one command.
120+
- [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.
121+
- [create-cosmos-app](https://github.com/hyperweb-io/create-cosmos-app) Set up a modern Cosmos app by running one command.
151122
- [interchain-ui](https://github.com/hyperweb-io/interchain-ui) The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
152123
- [starship](https://github.com/hyperweb-io/starship) Unified Testing and Development for the Interchain.
153124

networks/injective/starship/README.md

Lines changed: 9 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,18 @@ Deploy
66
# setup helm/starship
77
yarn starship setup
88

9-
# sanity check
10-
yarn starship get-pods
11-
12-
# deploy starship
13-
yarn starship deploy
9+
# deploy starship, the command will wait until all pods are running
10+
yarn starship:all
1411

15-
# wait til STATUS=Running
12+
# sanity check
1613
yarn starship get-pods
17-
18-
# port forwarding
19-
yarn starship start-ports
20-
21-
# check pids
22-
yarn starship port-pids
2314
```
2415

2516
Run Tests
2617

2718
```sh
2819
# test
2920
yarn starship:test
30-
31-
# watch
32-
yarn starship:watch
3321
```
3422

3523
Teardown
@@ -39,7 +27,7 @@ Teardown
3927
# yarn starship stop-ports
4028

4129
# stop ports and delete & remove helm chart
42-
yarn starship clean
30+
yarn starship:clean
4331
```
4432

4533
## 1. Installation
@@ -76,12 +64,6 @@ to a kubernetes cluster locally.
7664

7765
NOTE: Resources constraint on local machine will affect the performance of Starship spinup time
7866

79-
```bash
80-
yarn starship setup-kind
81-
```
82-
83-
Run the following command to check connection to a k8s cluster
84-
8567
```bash
8668
kubectl get pods
8769
```
@@ -93,7 +75,9 @@ Now with the dependencies and a kubernetes cluster in handy, we can proceed with
9375
Run
9476

9577
```bash
96-
yarn starship deploy
78+
yarn starship:all
79+
# or
80+
yarn starship start
9781
```
9882

9983
We use the config file `configs/config.yaml` as the genesis file to define the topology of the e2e test infra. Change it as required
@@ -108,7 +92,7 @@ our end-to-end tests.
10892
Run
10993

11094
```bash
111-
npm run starship:test
95+
yarn starship:test
11296
```
11397

11498
## 5. Stop the infra
@@ -118,22 +102,14 @@ The tests should be ideompotent, so the tests can be run multiple times (which i
118102
Once the state of the mini-cosmos is corrupted, you can stop the deployments with
119103

120104
```bash
121-
npm run starship clean
105+
yarn starship:clean
122106
```
123107

124108
Which will
125109

126110
- Stop port-forwarding the traffic to your local
127111
- Delete all the helm charts deployed
128112

129-
## 6. Cleanup kind (optional)
130-
131-
If you are using kind for your kubernetes cluster, you can delete it with
132-
133-
```bash
134-
yarn starship clean-kind
135-
```
136-
137113
## Related
138114

139115
Checkout these related projects:

0 commit comments

Comments
 (0)