0xMiden / 0xMiden/developer-playground

Instructions table

Aberta Para iniciantes
#1 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Rust
Estrelas
0
Forks
1
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
json, rust
Domínio
developer-experience, documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
70/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.