Skip to content

Commit

Permalink
fix doc of injective-vue
Browse files Browse the repository at this point in the history
  • Loading branch information
Zetazzz committed Dec 25, 2024
1 parent 78d5677 commit 67a7b0f
Showing 1 changed file with 50 additions and 73 deletions.
123 changes: 50 additions & 73 deletions examples/injective-vue/README.md
Original file line number Diff line number Diff line change
@@ -1,140 +1,117 @@
# Introduction
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).
## Directory Structure
```
├── src/
│ ├── codegen # containing vue composables generated by `telescope`
│ ├── components/
│ │ ├── asset-list/
│ │ ├── authz/
│ │ ├── provide-liquidity/
│ │ ├── stake-tokens/
│ │ └── voting/
│ ├── composables/
│ │ ├── asset-list/
│ │ ├── authz/
│ │ ├── common/
│ │ ├── injective/
│ │ ├── provide-liquidity/
│ │ ├── stake-tokens/
│ │ └── voting/
│ ├── utils/
│ │ ├── asset-list/
│ │ ├── authz/
│ │ ├── provide-liquidity/
│ │ ├── stake-tokens/
│ │ └── voting/
│ ├── views/
│ │ ├── asset-list.vue
│ │ ├── authz.vue
│ │ ├── index.vue
│ │ └── voting.vue
│ ├── router.ts
│ ├── utils/
│ ├── App.vue
│ └── main.ts

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).

## Getting Started

First, install the packages and run the development server:

```bash
yarn && yarn dev
```
## Pages

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.

### Asset List
- **Completion Status:** ✅ Completed
- **Functionalities:**
- Wallet connect
- Assets display
- IBC transfer

- **Completion Status:** ✅ Completed

- **Functionalities:**
- Wallet connect
- Assets display
- IBC transfer

- **Telescope generated `Vue Composables` Used:**

```ts
cosmos.bank.v1beta1.useBalance
cosmos.bank.v1beta1.useAllBalances
cosmos.staking.v1beta1.useDelegatorDelegations
osmosis.gamm.v1beta1.usePools
```

- **`msgType`s are signAndBroadcasted:**

```ts
/ibc.applications.transfer.v1.MsgTransfer
```

### Auth
- **Completion Status:** ✅ Completed
- **Functionalities:**

- **Completion Status:** ✅ Completed

- **Functionalities:**
- Vote permission granting and revoking
- Send permission granting and revoking
- Delegate permission granting and revoking
- Claim rewards granting and revoking

- **Telescope generated `Vue Composables` Used:**

```ts
cosmos.authz.v1beta1.useGranterGrants
cosmos.authz.v1beta1.useGranteeGrants
cosmos.staking.v1beta1.useValidators
```

- **`msgType`s are signAndBroadcasted:**

```ts
/cosmos.authz.v1beta1.MsgRevoke
/cosmos.authz.v1beta1.MsgGrant
```

### Voting
- **Completion Status:** ✅ Completed
- **Functionalities:**

- **Completion Status:** ✅ Completed

- **Functionalities:**
- Proposals display
- Proposal voting

- **Telescope generated `Vue Composables` Used:**

```ts
cosmos.gov.v1.useProposals
cosmos.gov.v1.useParams
cosmos.gov.v1.useProposals
cosmos.staking.v1beta1.usePools
```

- **`msgType`s are signAndBroadcasted:**

```ts
/cosmos.gov.v1.MsgVote
```

### Injective
- **Completion Status:** ✅ Completed
- **Functionalities:**

- **Completion Status:** ✅ Completed

- **Functionalities:**
- inj balance display
- inj tokens transfer

- **Telescope generated `Vue Composables` Used:**

```ts
cosmos.bank.v1beta1.useBalance
```

- **`msgType`s are signAndBroadcasted:**

```ts
/cosmos.bank.v1beta1.MsgSend
```
### Stake tokens
- **Completion Status:** ⏳ In Progress... 50% done.
- **Functionalities:**
- all validators display
- validators display for a specified address
- claimable rewards display
- staked tokens display for a specified chain
- claim rewards
- manage validators

- **Telescope generated `Vue Composables` Used:**

```ts
cosmos.mint.v1beta.useAnnualProvisions
cosmos.distribution.v1beta1.useParams
cosmos.distribution.v1beta1.useDelegationTotalRewards
codegen.cosmos.staking.v1beta1.useDelegatorValidators
cosmos.staking.v1beta1.useParams
```
- **`msgType`s are signAndBroadcasted:**
```ts
```

### Provide Liquidity
- **Completion Status:** ⏳ In Progress...

### Swap tokens
- **Completion Status:** ⏳ In Progress...

### NFT
- **Completion Status:** ⏳ In Progress...

### Rollkit
- **Completion Status:** ⏳ In Progress...

### Grpc Web & Grpc Gateway
- **Completion Status:** ⏳ In Progress...

0 comments on commit 67a7b0f

Please sign in to comment.