Skip to content

Commit 67a7b0f

Browse files
committed
fix doc of injective-vue
1 parent 78d5677 commit 67a7b0f

File tree

1 file changed

+50
-73
lines changed

1 file changed

+50
-73
lines changed

examples/injective-vue/README.md

Lines changed: 50 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,140 +1,117 @@
11
# Introduction
2-
This example demonstrates the usage of Vue composables provided by [@interchain-kit/vue](https://github.com/cosmology-tech/interchain-kit/tree/main/packages/vue) and generated by [telescope](https://github.com/cosmology-tech/telescope).
3-
## Directory Structure
4-
```
5-
├── src/
6-
│ ├── codegen # containing vue composables generated by `telescope`
7-
│ ├── components/
8-
│ │ ├── asset-list/
9-
│ │ ├── authz/
10-
│ │ ├── provide-liquidity/
11-
│ │ ├── stake-tokens/
12-
│ │ └── voting/
13-
│ ├── composables/
14-
│ │ ├── asset-list/
15-
│ │ ├── authz/
16-
│ │ ├── common/
17-
│ │ ├── injective/
18-
│ │ ├── provide-liquidity/
19-
│ │ ├── stake-tokens/
20-
│ │ └── voting/
21-
│ ├── utils/
22-
│ │ ├── asset-list/
23-
│ │ ├── authz/
24-
│ │ ├── provide-liquidity/
25-
│ │ ├── stake-tokens/
26-
│ │ └── voting/
27-
│ ├── views/
28-
│ │ ├── asset-list.vue
29-
│ │ ├── authz.vue
30-
│ │ ├── index.vue
31-
│ │ └── voting.vue
32-
│ ├── router.ts
33-
│ ├── utils/
34-
│ ├── App.vue
35-
│ └── main.ts
2+
3+
This example demonstrates the usage of Vue composables provided by [@interchain-kit/vue](https://github.com/cosmology-tech/interchain-kit/tree/main/packages/vue) and [injective-vue](https://github.com/cosmology-tech/interchainjs/tree/main/libs/injective-vue).
4+
5+
## Getting Started
6+
7+
First, install the packages and run the development server:
8+
9+
```bash
10+
yarn && yarn dev
3611
```
37-
## Pages
12+
13+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
14+
15+
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
3816

3917
### Asset List
40-
- **Completion Status:** ✅ Completed
41-
- **Functionalities:**
42-
- Wallet connect
43-
- Assets display
44-
- IBC transfer
18+
19+
- **Completion Status:** ✅ Completed
20+
21+
- **Functionalities:**
22+
- Wallet connect
23+
- Assets display
24+
- IBC transfer
25+
4526
- **Telescope generated `Vue Composables` Used:**
27+
4628
```ts
4729
cosmos.bank.v1beta1.useBalance
4830
cosmos.bank.v1beta1.useAllBalances
4931
cosmos.staking.v1beta1.useDelegatorDelegations
5032
osmosis.gamm.v1beta1.usePools
5133
```
34+
5235
- **`msgType`s are signAndBroadcasted:**
36+
5337
```ts
5438
/ibc.applications.transfer.v1.MsgTransfer
5539
```
5640

5741
### Auth
58-
- **Completion Status:** ✅ Completed
59-
- **Functionalities:**
42+
43+
- **Completion Status:** ✅ Completed
44+
45+
- **Functionalities:**
6046
- Vote permission granting and revoking
6147
- Send permission granting and revoking
6248
- Delegate permission granting and revoking
6349
- Claim rewards granting and revoking
50+
6451
- **Telescope generated `Vue Composables` Used:**
52+
6553
```ts
6654
cosmos.authz.v1beta1.useGranterGrants
6755
cosmos.authz.v1beta1.useGranteeGrants
6856
cosmos.staking.v1beta1.useValidators
6957
```
58+
7059
- **`msgType`s are signAndBroadcasted:**
60+
7161
```ts
7262
/cosmos.authz.v1beta1.MsgRevoke
7363
/cosmos.authz.v1beta1.MsgGrant
7464
```
7565

7666
### Voting
77-
- **Completion Status:** ✅ Completed
78-
- **Functionalities:**
67+
68+
- **Completion Status:** ✅ Completed
69+
70+
- **Functionalities:**
7971
- Proposals display
8072
- Proposal voting
73+
8174
- **Telescope generated `Vue Composables` Used:**
75+
8276
```ts
8377
cosmos.gov.v1.useProposals
8478
cosmos.gov.v1.useParams
8579
cosmos.gov.v1.useProposals
8680
cosmos.staking.v1beta1.usePools
8781
```
82+
8883
- **`msgType`s are signAndBroadcasted:**
84+
8985
```ts
9086
/cosmos.gov.v1.MsgVote
9187
```
9288

9389
### Injective
94-
- **Completion Status:** ✅ Completed
95-
- **Functionalities:**
90+
91+
- **Completion Status:** ✅ Completed
92+
93+
- **Functionalities:**
9694
- inj balance display
9795
- inj tokens transfer
96+
9897
- **Telescope generated `Vue Composables` Used:**
98+
9999
```ts
100100
cosmos.bank.v1beta1.useBalance
101101
```
102+
102103
- **`msgType`s are signAndBroadcasted:**
104+
103105
```ts
104106
/cosmos.bank.v1beta1.MsgSend
105107
```
106-
### Stake tokens
107-
- **Completion Status:** ⏳ In Progress... 50% done.
108-
- **Functionalities:**
109-
- all validators display
110-
- validators display for a specified address
111-
- claimable rewards display
112-
- staked tokens display for a specified chain
113-
- claim rewards
114-
- manage validators
108+
115109
- **Telescope generated `Vue Composables` Used:**
110+
116111
```ts
117112
cosmos.mint.v1beta.useAnnualProvisions
118113
cosmos.distribution.v1beta1.useParams
119114
cosmos.distribution.v1beta1.useDelegationTotalRewards
120115
codegen.cosmos.staking.v1beta1.useDelegatorValidators
121116
cosmos.staking.v1beta1.useParams
122117
```
123-
- **`msgType`s are signAndBroadcasted:**
124-
```ts
125-
```
126-
127-
### Provide Liquidity
128-
- **Completion Status:** ⏳ In Progress...
129-
130-
### Swap tokens
131-
- **Completion Status:** ⏳ In Progress...
132-
133-
### NFT
134-
- **Completion Status:** ⏳ In Progress...
135-
136-
### Rollkit
137-
- **Completion Status:** ⏳ In Progress...
138-
139-
### Grpc Web & Grpc Gateway
140-
- **Completion Status:** ⏳ In Progress...

0 commit comments

Comments
 (0)