AElf Node Skill

English | 中文

AElf Node Skill provides MCP, CLI, and SDK interfaces for AElf public nodes with REST for reads, SDK for contract execution, and selective fallback for fee estimate.

Features

• Read: chain status, block height, block detail, transaction result
• Contract metadata: view methods and system contract address (REST adapter)
• Contract execution: view call and send transaction (SDK)
• Fee estimate: REST first, SDK fallback
• Node registry: import and list custom nodes

Default Nodes

• AELF: https://aelf-public-node.aelf.io
• tDVV: https://tdvv-public-node.aelf.io

Install

bun install

Usage

MCP

bun run mcp

CLI

bun run cli get-chain-status --chain-id AELF

OpenClaw

bun run build:openclaw
bun run build:openclaw:check

Quick Start

# MCP server
bun run mcp

# CLI
bun run cli get-chain-status --chain-id AELF

# Unit tests
bun run test:unit

Setup CLI

This repository includes a one-command setup CLI for Claude, Cursor, and OpenClaw.

bun run setup claude
bun run setup cursor
bun run setup cursor --global
bun run setup openclaw
bun run setup openclaw --config-path /path/to/openclaw-config.json
bun run setup list
bun run setup uninstall claude
bun run setup uninstall cursor --global
bun run setup uninstall openclaw --config-path /path/to/openclaw-config.json

Installed package users can also run:

aelf-node-setup claude

MCP Config Example

Reference file: mcp-config.example.json

{
  "mcpServers": {
    "aelf-node-skill": {
      "command": "bun",
      "args": ["run", "/ABSOLUTE/PATH/TO/src/mcp/server.ts"],
      "env": {
        "AELF_PRIVATE_KEY": "optional_env_fallback_private_key",
        "PORTKEY_WALLET_PASSWORD": "optional_wallet_password",
        "PORTKEY_CA_KEYSTORE_PASSWORD": "optional_keystore_password"
      }
    }
  }
}

Environment

Copy and edit:

cp .env.example .env

• AELF_PRIVATE_KEY: optional env fallback for write operations (highest env priority)
• PORTKEY_PRIVATE_KEY: optional secondary env fallback for shared-skill compatibility
• Write tools (aelf_send_contract_transaction, aelf_estimate_transaction_fee) resolve signer as explicit -> context -> env
• PORTKEY_WALLET_PASSWORD: optional password cache for EOA wallet context
• PORTKEY_CA_KEYSTORE_PASSWORD: optional password cache for CA keystore context
• PORTKEY_SKILL_WALLET_CONTEXT_PATH: optional override for active context path (~/.portkey/skill-wallet/context.v1.json)
• signerMode=daemon is reserved and currently returns SIGNER_DAEMON_NOT_IMPLEMENTED
• AELF_NODE_AELF_RPC_URL: optional override for AELF node
• AELF_NODE_TDVV_RPC_URL: optional override for tDVV node
• AELF_NODE_REGISTRY_PATH: optional custom registry path
• AELF_SDK_INSTANCE_CACHE_MAX: optional max SDK instance cache size (default 32)
• AELF_SDK_CONTRACT_CACHE_MAX: optional max SDK contract cache size (default 256)
• AELF_REST_CLIENT_CACHE_MAX: optional max REST client cache size (default 64)

Tool List

MCP tool names:

• aelf_get_chain_status
• aelf_get_block_height
• aelf_get_block
• aelf_get_transaction_result
• aelf_get_contract_view_methods
• aelf_get_system_contract_address
• aelf_call_contract_view
• aelf_send_contract_transaction
• aelf_estimate_transaction_fee
• aelf_import_node
• aelf_list_nodes

Architecture

• src/core/: business orchestration
• lib/sdk-client.ts: aelf-sdk wrapper
• lib/rest-client.ts: REST adapter with normalized errors
• lib/node-router.ts: node resolution and fallback
• src/mcp/server.ts: MCP adapter
• aelf_node_skill.ts: CLI adapter
• index.ts: SDK exports

Testing

bun run test
bun run test:coverage:ci

Security

• Never put AELF_PRIVATE_KEY in prompts or channel outputs.
• Active wallet context must not contain plaintext private keys.
• Use environment variables for all secrets.

License

MIT