Skip to content

Commit

Permalink
docs: Update Hummingbot plugin configuration for consistency
Browse files Browse the repository at this point in the history
- Update environment variable references to use HUMMINGBOT_API_KEY consistently
- Add Environment Variables section to README
- Use environment variable references in configuration examples
  • Loading branch information
Sumeet Chougule authored and Sumeet Chougule committed Dec 30, 2024
1 parent 89ba3bb commit ec74a6b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
2 changes: 1 addition & 1 deletion agent/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ export async function createAgent(
getSecret(character, "AVALANCHE_PRIVATE_KEY")
? avalanchePlugin
: null,
getSecret(character, "HUMMINGBOT_PRIVATE_KEY")
getSecret(character, "HUMMINGBOT_API_KEY")
? hummingbotPlugin
: null,
].filter(Boolean),
Expand Down
21 changes: 15 additions & 6 deletions packages/plugin-hummingbot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ A powerful plugin that integrates Hummingbot's market making capabilities with E
npm install @eliza/plugin-hummingbot
```

## Environment Variables

The plugin uses the following environment variables:
```
HUMMINGBOT_API_URL=http://localhost:15888 # Hummingbot REST API URL
HUMMINGBOT_WS_URL=ws://localhost:8060 # Hummingbot WebSocket URL
HUMMINGBOT_API_KEY=your-api-key # Hummingbot API Key
```

## Usage in Eliza Character

Add the plugin to your character configuration:
Expand All @@ -28,9 +37,9 @@ Add the plugin to your character configuration:
"settings": {
"HUMMINGBOT_CONFIG": {
"instance": {
"url": "http://localhost:15888",
"wsUrl": "ws://localhost:8060",
"apiKey": "your-hummingbot-api-key",
"url": "${HUMMINGBOT_API_URL}",
"wsUrl": "${HUMMINGBOT_WS_URL}",
"apiKey": "${HUMMINGBOT_API_KEY}",
"instanceId": "eli-agent"
},
"defaultStrategy": {
Expand Down Expand Up @@ -64,9 +73,9 @@ import { SimpleMarketMaking } from '@eliza/plugin-hummingbot/strategies';
// Initialize the plugin
const plugin = new HummingbotPlugin({
instance: {
url: 'http://localhost:15888', // Default Hummingbot REST API port
wsUrl: 'ws://localhost:8060', // Default Hummingbot WebSocket port
apiKey: 'your-api-key',
url: process.env.HUMMINGBOT_API_URL, // Default Hummingbot REST API port
wsUrl: process.env.HUMMINGBOT_WS_URL, // Default Hummingbot WebSocket port
apiKey: process.env.HUMMINGBOT_API_KEY,
instanceId: 'instance-1'
}
});
Expand Down

0 comments on commit ec74a6b

Please sign in to comment.