@elizaos/plugin-arthera/README.md

Arthera blockchain plugin for ElizaOS - Enables native token transfers and wallet management on Arthera network

# @elizaos-plugins/plugin-arthera

A comprehensive Arthera blockchain integration plugin for ElizaOS that provides native token transfers and wallet management for the Arthera network.

## Features

- **Native Token Transfers**: Transfer AA tokens between addresses on the Arthera network
- **Wallet Integration**: Seamless wallet connection and balance checking
- **Multi-chain Support**: Ready for future multi-chain expansion
- **Custom RPC Support**: Configure custom RPC endpoints for optimal performance

## Installation

```bash
bun install @elizaos-plugins/plugin-arthera
```

## Configuration

The plugin requires the following environment variables:

```env
ARTHERA_PRIVATE_KEY=your_private_key_here
ETHEREUM_PROVIDER_ARTHERA=https://rpc.arthera.net
```

### Environment Variables

- `ARTHERA_PRIVATE_KEY`: Your private key for Arthera wallet (required)
- `ETHEREUM_PROVIDER_ARTHERA`: Custom RPC URL for Arthera network (optional)

## Usage from character file

```typescript
{
  "name": "ArtheraBot",
  "bio": "I am a helpful AI assistant for Arthera blockchain interactions.",
  "plugins": [
    '@elizaos/plugin-sql',
    '@elizaos/plugin-ollama',
    '@elizaos-plugins/plugin-arthera',
  ],
  "topics": ["blockchain", "arthera", "transfers"],
  "adjectives": ["helpful", "efficient"]
}
// etc...
```

## Available Actions

### Transfer Action

Transfer AA tokens from one address to another on the Arthera network.

**Features:**
- Support for native AA token transfers
- Automatic gas estimation
- Transaction validation and error handling
- Real-time transaction status

**Example usage:**

```bash
Transfer 1 AA to 0x742d35Cc6634C0532925a3b844Bc454e4438f44e
```

## Available Providers

### Arthera Wallet Provider

Provides wallet information and context for the connected Arthera account.

**Features:**
- Current wallet address and balance
- Chain information (network ID, name, native currency)
- Real-time balance updates

## Supported Networks

- **Arthera Mainnet**: Full support for native AA token operations
- **Custom RPC**: Configure your own RPC endpoint for enhanced performance

## Development

### Running Tests

```bash
bun test
```

### Running Tests with Coverage

```bash
bun test --coverage
```

### Building

```bash
bun run build
```

### Development Mode

```bash
bun run dev
```

## Dependencies

- `@elizaos/core`: Core ElizaOS functionality
- `viem`: Ethereum-compatible blockchain interaction library
- TypeScript support for enhanced development experience

## Contributing

Contributions are welcome! Please ensure all tests pass before submitting a PR:

```bash
bun test
```

## Credits

This plugin integrates with and builds upon:

- [Arthera Network](https://arthera.net/): Fast and scalable blockchain network
- [Viem](https://viem.sh/): TypeScript interface for Ethereum
- [ElizaOS](https://github.com/elizaos/elizaos): AI agent framework

Special thanks to:
- The Arthera development team
- The Viem development team  
- The ElizaOS community for their contributions and feedback

For more information about Arthera:
- [Arthera Documentation](https://docs.arthera.net/)
- [Arthera Network Explorer](https://explorer.arthera.net/)

## License

This plugin is part of the ElizaOS project. See the main project repository for license information.