0xMiden / 0xMiden/developer-playground

Instructions table

Ouverte Adaptée aux débutants
#1 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Rust
Étoiles
0
Forks
1
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
json, rust
Domaine
developer-experience, documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
70/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.