0xMiden / 0xMiden/developer-playground

Instructions table

Aperta Adatta ai principianti
#1 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Rust
Stelle
0
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## 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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
json, rust
Ambito
developer-experience, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
70/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.