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
Copy file name to clipboardexpand all lines: packages/plugin-cosmos/README.md
+49-6
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,17 @@ This plugin provides actions and utilities for interacting with Cosmos-compatibl
7
7
## Development
8
8
9
9
Prepare Eliza according to [README](../../README.md)
10
-
Add variables required for `@ai16z/plugin-cosmos` :
11
-
```
10
+
Add variables required for `@ai16z/plugin-cosmos` :
11
+
12
+
```
12
13
COSMOS_RECOVERY_PHRASE=your recovery phrase words
13
14
COSMOS_AVAILABLE_CHAINS=chain1,chain2,chain3
14
-
```
15
+
```
15
16
16
17
Ensure the appropriate environment variables are added for the plugin. If they are correctly configured, the project will run with `@ai16z/plugin-cosmos`
17
18
18
-
Run Eliza
19
+
Run Eliza
20
+
19
21
```
20
22
pnpm run dev
21
23
```
@@ -26,13 +28,12 @@ pnpm run dev
26
28
27
29
To start using the plugin, you need to provide your **Cosmos account recovery phrases** and the list of **available chains**. Add the following to your `.env` file:
28
30
29
-
30
31
```env
31
32
COSMOS_RECOVERY_PHRASE=your recovery phrase words
32
33
COSMOS_AVAILABLE_CHAINS=chain1,chain2,chain3
33
34
```
34
-
Ensure that the chain names in `COSMOS_AVAILABLE_CHAINS` match the identifiers from the [chain-registry](https://github.com/cosmos/chain-registry) library for compatibility.
35
35
36
+
Ensure that the chain names in `COSMOS_AVAILABLE_CHAINS` match the identifiers from the [chain-registry](https://github.com/cosmos/chain-registry) library for compatibility.
36
37
37
38
### Using the Cosmos Helper Character
38
39
@@ -51,9 +52,11 @@ To use the character, pass it with the `--characters` flag:
51
52
---
52
53
53
54
### Custom chain configuration
55
+
54
56
Plugin allows you to pass you custom chain config to `createCosmosPlugin` function invoked in `../agent/src/index`.
55
57
56
58
Your custom configuration fulfills the interfaces from `chain-registry`
59
+
57
60
```
58
61
import type { assets, chains } from "chain-registry";
59
62
@@ -99,6 +102,46 @@ Yes
99
102
100
103
4. Action executed.
101
104
105
+
### Token IBC Transfer
106
+
107
+
This plugin supports a token transfer action, which allows users to transfer tokens between addresses on Cosmos-compatible blockchains between different chains.
108
+
109
+
#### Requirements
110
+
111
+
You need to set both chain that you want to transfer founds between in env file. For example:
If you want to transfer your tokens between Osmosis Testnet and Neutron Testnet
118
+
119
+
#### Example Prompts
120
+
121
+
Below are examples of how the ibc transfer action can be initiated and confirmed:
122
+
123
+
**Example**
124
+
125
+
1. User input:
126
+
127
+
```
128
+
Make an IBC transfer 0.0001 OSMO to neutron1nk3uuw6zt5t5aqw5fvujkd54sa4uws9xg2nk82 from osmosistestnet to neutrontestnet
129
+
```
130
+
131
+
2. Plugin response:
132
+
133
+
```
134
+
Before making the IBC transfer, I would like to confirm the details. You would like to transfer 0.0001 OSMO from osmosistestnet to neutrontestnet, specifically to the address neutron1nk3uuw6zt5t5aqw5fvujkd54sa4uws9xg2nk82, is that correct?
0 commit comments