0xMiden / 0xMiden/developer-playground

Instructions table

オープン 初心者向け
#1 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Rust
スター
0
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

説明

## People need to know what they can call
Developers using the new Miden developer playground need to know the API they can use to build their account and note scripts. Basically, developers can use all the procedures in https://github.com/0xPolygonMiden/miden-base/tree/main/crates/miden-lib/asm/miden.

The goal is to have an instruction table as we have it in the VM playground, see here https://github.com/0xPolygonMiden/examples/blob/main/playground/src/pages/InstructionTable.tsx

## Create a JSON file with all instructions across all categories
The VM playground builds its instructions table from that JSON file https://github.com/0xPolygonMiden/examples/blob/main/playground/src/data/instructions.tsx.

We need a similar table for the miden-lib API categorized in Accounts, Notes, Transaction, Faucet, Tx.

The table will include the following properties:
- instruction
- stackInput
- stackOutput
- notes

We can ignore `cycles` for now.

## Example output
The JSON file will look like

```json
"class": "Account",
"instructions": [
{
"instruction": "get_id",
"stackInput": "[...]",
"stackOutput": "[acct_id_prefix, acct_id_suffix]",
"notes": "Returns the account ID. Where: acct_id_prefix and acct_id_suffix are the prefix and suffix felts of the account ID."
},
```

## This can be build using ChatGPT
The easiest way to create the aforementioned JSON will be to use ChatGPT and feed it with `account.masm`, `asset.masm`, ..., and let it create the JSON.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Examine the MASM files in the miden-lib repository (crates/miden-lib/asm/miden) to understand the instruction categories (Account, Note, Transaction, Faucet, Tx). Use ChatGPT or manual parsing to extract each instruction's name, stack input, stack output, and notes. Structure the output as a JSON file following the provided example, grouping by class. Validate the JSON format against the existing instructions.tsx in the VM playground examples.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
json, rust
領域
developer-experience, documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
70/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。