Skip to content

elizaos-plugins/plugin-akash

Repository files navigation

@elizaos/plugin-akash

Akash Network Plugin for deploying and managing cloud compute resources on ElizaOS.

Installation

npm install @elizaos/plugin-akash

Configuration

Add to your .eliza/.env file:

# Required
AKASH_MNEMONIC=your_wallet_mnemonic_here
AKASH_WALLET_ADDRESS=akash1...  # Optional, but recommended

# Network Configuration (defaults to mainnet)
AKASH_ENV=mainnet  # or testnet
AKASH_NET=https://raw.githubusercontent.com/ovrclk/net/master/mainnet
RPC_ENDPOINT=https://rpc.akashnet.net:443

# Gas Configuration
AKASH_GAS_PRICES=0.025uakt
AKASH_GAS_ADJUSTMENT=1.5
AKASH_FEES=20000uakt
AKASH_DEPOSIT=500000uakt

# Optional Configuration
AKASH_PRICING_API_URL=https://console-api.akash.network/v1/pricing
AKASH_DEFAULT_CPU=1000
AKASH_DEFAULT_MEMORY=1000000000
AKASH_DEFAULT_STORAGE=1000000000
AKASH_SDL=example.sdl.yml
AKASH_MANIFEST_MODE=auto  # auto, manual, or validate_only
AKASH_MANIFEST_VALIDATION_LEVEL=strict  # strict, lenient, or none

Usage

import akashPlugin from '@elizaos/plugin-akash';

// Add to your ElizaOS configuration
const plugins = [akashPlugin];

Actions

Deployment Management

  • CREATE_DEPLOYMENT - Create a new deployment on Akash Network
  • CLOSE_DEPLOYMENT - Close an existing deployment
  • GET_DEPLOYMENT_STATUS - Get the status of a deployment
  • GET_DEPLOYMENT_API - Get deployment API information

Provider Operations

  • GET_PROVIDER_INFO - Get detailed information about a provider
  • GET_PROVIDERS_LIST - List available providers
  • GET_GPU_PRICING - Get GPU pricing information

Utility Actions

  • ESTIMATE_GAS - Estimate gas for operations
  • GET_MANIFEST - Get deployment manifest

Providers

  • akashService - Provides current Akash service state and configuration

Service

The Akash plugin includes a service that manages:

  • Wallet connections
  • Network configuration
  • Deployment lifecycle
  • Provider interactions

Development

npm run dev    # Development mode with watch
npm run build  # Build for production
npm run test   # Run tests
npm run lint   # Lint code
npm run format # Format code

Architecture

This plugin follows the ElizaOS v2 plugin architecture:

  • Service Layer: Manages Akash connections and state
  • Actions: Modular deployment and provider operations
  • Providers: State providers for runtime access
  • Configuration: Zod-validated configuration management

Examples

Create a Deployment

"Can you create a deployment with 2 CPU, 4GB RAM, and 10GB storage?"

Check Provider Info

"Can you check the provider info for akash1ccktptfkvdc67msasmesuy5m7gpc76z75kukpz?"

List Available Providers

"Show me available GPU providers"

Troubleshooting

Common Issues

  1. Wallet Not Initialized

    • Ensure AKASH_MNEMONIC is set in your environment
    • Mnemonic must be 12 or 24 words
  2. Network Connection Issues

    • Verify RPC_ENDPOINT is accessible
    • Check network configuration matches your intended network (mainnet/testnet)
  3. Insufficient Funds

    • Ensure wallet has sufficient AKT for gas and deposits
    • Default deposit is 500000uakt (0.5 AKT)

License

MIT

About

A plugin for Eliza that facilitates deployment management and cloud compute operations on the Akash Network.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors