Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/coverage-badge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Coverage Badge

on:
push:
branches:
- main
- master
- 'codex/**'
workflow_dispatch:

permissions:
contents: write

jobs:
coverage-badge:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- run: bun install --frozen-lockfile
- run: bun run test:coverage:ci
- run: bun run coverage:badge
- run: touch coverage/.nojekyll

- name: Deploy coverage badge to gh-pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./coverage
publish_branch: gh-pages
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ jobs:
- name: Type check
run: bunx tsc --noEmit

- name: Run tests
run: bun run test
- name: Coverage gate
run: bun run test:coverage:ci

- name: Verify generated openclaw config
run: bun run build:openclaw:check
Expand Down
7 changes: 2 additions & 5 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,8 @@ jobs:
- name: Type check
run: bunx tsc --noEmit

- name: Run tests
run: bun run test

- name: Unit coverage
run: bun run test:unit:coverage
- name: Coverage gate
run: bun run test:coverage:ci

- name: Verify generated openclaw config
run: bun run build:openclaw:check
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# AelfScan Skill Kit

[English](./README.md) | [中文](./README.zh-CN.md)

[![Unit Tests](https://github.com/AelfScanProject/aelfscan-skill/actions/workflows/test.yml/badge.svg)](https://github.com/AelfScanProject/aelfscan-skill/actions/workflows/test.yml)
[![Coverage](https://img.shields.io/endpoint?url=https://AelfScanProject.github.io/aelfscan-skill/coverage-badge.json)](https://AelfScanProject.github.io/aelfscan-skill/coverage-badge.json)

AelfScan explorer skill toolkit for AI agents, with **SDK + MCP + CLI + OpenClaw** interfaces.

## Features
Expand Down Expand Up @@ -51,6 +56,13 @@ cp .env.example .env
bun run mcp
```

### OpenClaw

```bash
bun run build:openclaw
bun run build:openclaw:check
```

### Run CLI

```bash
Expand Down Expand Up @@ -111,3 +123,8 @@ RUN_LIVE_TESTS=1 bun run test:e2e
## License

MIT

## Security

- Keep API tokens and private keys in env/config only.
- Never leak secret values in tool outputs.
17 changes: 17 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# AelfScan Skill Kit

[中文](./README.zh-CN.md) | [English](./README.md)

[![Unit Tests](https://github.com/AelfScanProject/aelfscan-skill/actions/workflows/test.yml/badge.svg)](https://github.com/AelfScanProject/aelfscan-skill/actions/workflows/test.yml)
[![Coverage](https://img.shields.io/endpoint?url=https://AelfScanProject.github.io/aelfscan-skill/coverage-badge.json)](https://AelfScanProject.github.io/aelfscan-skill/coverage-badge.json)

面向 AI Agent 的 AelfScan 浏览器能力工具包,提供 **SDK + MCP + CLI + OpenClaw** 四种使用方式。

## 功能覆盖
Expand Down Expand Up @@ -51,6 +56,13 @@ cp .env.example .env
bun run mcp
```

### OpenClaw

```bash
bun run build:openclaw
bun run build:openclaw:check
```

### CLI 示例

```bash
Expand Down Expand Up @@ -111,3 +123,8 @@ RUN_LIVE_TESTS=1 bun run test:e2e
## License

MIT

## 安全

- API Token 和私钥仅通过环境变量或配置注入。
- 工具输出中禁止泄露敏感字段。
32 changes: 32 additions & 0 deletions SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: "aelfscan-skill"
description: "AelfScan explorer data retrieval and analytics skill for agents."
---

# AelfScan Skill

## When to use
- Use this skill when you need AelfScan explorer search and analytics data retrieval tasks.

## Capabilities
- Domain coverage: search, blockchain, address, token, NFT, statistics
- Single tool descriptor source for SDK/CLI/MCP/OpenClaw
- MCP output governance controls and standardized trace-aware errors
- Supports SDK, CLI, MCP, and OpenClaw integration from one codebase.

## Safe usage rules
- Never print private keys, mnemonics, or tokens in channel outputs.
- For write operations, require explicit user confirmation and validate parameters before sending transactions.
- Prefer `simulate` or read-only queries first when available.

## Command recipes
- Start MCP server: `bun run mcp`
- Run CLI entry: `bun run cli`
- Generate OpenClaw config: `bun run build:openclaw`
- Verify OpenClaw config: `bun run build:openclaw:check`
- Run CI coverage gate: `bun run test:coverage:ci`

## Limits / Non-goals
- This skill focuses on domain operations and adapters; it is not a full wallet custody system.
- Do not hardcode environment secrets in source code or docs.
- Avoid bypassing validation for external service calls.
1 change: 0 additions & 1 deletion bin/generate-coverage-badge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ const badge = {
label: 'coverage',
message: `${rounded}%`,
color,
generatedAt: new Date().toISOString(),
};

fs.mkdirSync(path.dirname(outputPath), { recursive: true });
Expand Down
5 changes: 5 additions & 0 deletions bin/generate-openclaw.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ const openclaw = {
command: 'bun',
args: ['run', 'aelfscan_skill.ts', descriptor.domain, descriptor.action],
cwd: '.',
inputSchema: {
type: 'object',
properties: {},
additionalProperties: true,
},
})),
};

Expand Down
Loading