跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.chainstream.io/llms.txt

Use this file to discover all available pages before exploring further.

Monaco 编辑器

查询编辑器基于 Monaco — 与 VS Code 同源 — 并配有 GraphQL 语言 worker,提供:
  • 语法高亮:GraphQL 操作、字段、参数与指令
  • 基于 schema 的自动补全 — 按 Ctrl+Space 查看基于实时 schema 的可用字段、参数与类型
  • 实时错误检测 — 无效字段名、缺少参数或类型不匹配时显示红色下划线与错误标记
  • 括号匹配自动闭合:大括号、圆括号与字符串
  • 多光标编辑:批量修改
自动补全会感知 schema。在某一 Cube(如 DEXTrades)内输入时,建议列表中只会出现该 Cube 合法的字段与参数。

编辑器面板

编辑区域底部有三个标签页,可在其间切换以配置请求的不同部分。

Query 面板

编写 GraphQL 查询的主编辑区。Monaco 的自动补全、高亮与错误检测在此生效。
query {
  Solana {
    DEXTrades(
      limit: {count: 10}
      orderBy: {descending: Block_Time}
    ) {
      Block { Time }
      Transaction { Hash }
      Trade {
        Buy { Currency { MintAddress } Amount PriceInUSD }
        Sell { Currency { MintAddress } Amount }
        Dex { ProtocolName }
      }
    }
  }
}

Variables 面板

通过 Variables 面板向参数化查询传入 JSON 变量。这样查询可复用 — 修改变量值而无需改动查询正文。
query LatestTrades($limit: Int!) {
  Solana {
    DEXTrades(
      limit: {count: $limit}
      orderBy: {descending: Block_Time}
    ) {
      Block { Time }
      Trade {
        Buy { Currency { MintAddress } Amount PriceInUSD }
        Sell { Currency { MintAddress } Amount }
      }
    }
  }
}

Headers 面板

配置随每次请求发送的 HTTP 请求头。Headers 面板 默认显示,并已预置 X-API-KEY 请求头。
{
  "X-API-KEY": "your_api_key"
}
可按需添加其他自定义请求头。所有请求头会随 POST 请求一并发送到 GraphQL 端点。
Content-Type: application/json 会自动添加 — 无需手动设置。

工具栏

工具栏位于编辑器顶部,提供快捷操作:
按钮操作说明
Execute (▶)运行查询将当前查询(含变量与请求头)发送到 GraphQL 端点
Prettify格式化查询自动整理缩进与换行
Copy复制查询将当前查询文本复制到剪贴板
Merge合并片段将内联片段合并为单一扁平查询
Save Query本地保存以标题与可选标签保存当前查询
Export Code导出片段为当前查询生成所选语言的代码片段

执行查询

执行查询的步骤:
  1. 在编辑器中编写或加载查询
  2. 在 Headers 面板设置 X-API-KEY
  3. 点击工具栏 Execute (▶),或按 Ctrl/Cmd+Enter
响应显示在编辑器右侧 Results Panel,JSON 带完整语法高亮。若查询有误,会展示错误响应及错误信息与位置详情。

结果面板

结果面板展示 GraphQL 端点返回的 JSON,并提供:
  • JSON 键、字符串、数字与布尔值的 语法高亮
  • 可折叠节点,便于浏览深层嵌套响应
  • 右键菜单支持 复制响应
典型成功响应包含与查询结构对应的 data 对象,以及展示计费信息的 extensions.credits 对象。

状态栏

IDE 底部状态栏实时反馈查询执行状态:
指示项取值说明
StateReady · Executing... · Success · Error当前请求生命周期状态
Latency120ms从发出请求到收到响应的往返耗时
Size2.4 KB响应体大小
Credits8 CU本查询消耗的 Credit Units(CU)
Credit Units(CU)反映查询的计算成本。扫描数据更多或返回结果更大的查询会消耗更多 CU。详见 计费与额度

键盘快捷键

快捷键操作
Ctrl/Cmd + Enter执行查询
Ctrl/Cmd + B切换侧边栏
Ctrl + Space触发自动补全
Ctrl/Cmd + Shift + P命令面板
Ctrl/Cmd + /切换行注释
Ctrl/Cmd + D选中下一处相同内容
Ctrl/Cmd + Shift + F格式化 / Prettify
Alt + Up/Down上移/下移当前行
在 macOS 上,将 Ctrl 换为 Cmd。IDE 会自动检测操作系统并显示对应的修饰键。