movetool icon indicating copy to clipboard operation
movetool copied to clipboard

[开发工具] 错误码描述表生成工具或者查询工具

Open pause125 opened this issue 3 years ago • 0 comments

目前 StarcoinFramework 的错误码查询不太方便, 具体体现在:

  1. 错误码规范由 category 和 reason 构成, https://github.com/starcoinorg/starcoin-framework/blob/main/build/StarcoinFramework/docs/Errors.md#function-make 。因此程序返回的错误码不太直观,需要开发者熟悉这一计算方式,并且每次需要根据错误码计算出 category 和 reason。
  2. 计算出 category 和 reason 后,需要去对应模块查找原因。

目前有 starcoin 命令行工具可以查询,使用方法如下:

starcoin% dev move-explain -a 6
{
  "ok": {
    "category_code": 6,
    "category_name": null,
    "reason_code": 0,
    "reason_name": null
  }
}

该命令行工具每次都需要启动一个 starcoin node,体验不太好;并且错误描述似乎也不够详细。

如果有一个工具能够生成统一的错误码解释表,能很好的方便开发者查询错误。或者做一个更友好的错误码查询工具。 可以设计一些错误码的注释规范等,便于工具捕获信息。

pause125 avatar Aug 15 '22 14:08 pause125