LayerXcom / confidential-computing-modules

A Module for Privacy-preserving State Transitions with Verifiability
90 stars 9 forks source link

refactor: `frame/` のリファクタリングと、使い方解説ドキュメント #641

Closed laysakura closed 3 years ago

laysakura commented 3 years ago

Issueへのリンク

Fixes: #610 Fixes: #611

(e2e テストを走らせたく、ブランチ名を変えるために #638 を閉じて立て直しました)

やったこと

frame/ 以下のフレームワークはとても良いもの(特に ecall_entry_point() を中心とした設計)だと思うが、実際に使ってみて慣れるまでに時間がかかったのと、名称や構造に一部違和感があったので、リファクタリングをする。 またフレームワークの使い方ドキュメントがあると新feature実装や改修の際に役立つと感じたので追加する。

やらないこと

image

誰か今後書いてくれたら嬉しいな

動作検証

CI pass (含む e2e) テストのカバレッジを知らないので、これでどの程度自信を持ってよいのか...

特に、 cmd: u32 の付け間違えなどに一抹の不安... → この箇所はセルフレビューでだいぶ自信持てた

参考

laysakura commented 3 years ago

レビューありがとうございましたマーーーーーーーーーーーーーーーーーーージします!