feature/add-tvm-opcodes-list

[zerefwth]

What is this PR?

Origin: everscale-org/bounties#32
This PR contains a workflow code pipeline for the list of all TVM opcodes.

Changes

Including:

• A folder at src/arch/ that contains markdown generation logic, also can be rendered at the docs website
• CSV file: contain the aggregated information from instructions.csv, tvm.tex(or initial TVM paper), and Everscale Extended Instructions, with an additional column that represented tvm_assembler.
• GitHub workflow file that auto writes the .md after there are push changes to the CSV

Progress

The opcodes collecting job is done. Also fixed the missing description of some opcodes.

Problems:

• Still haven't tested the gas calculation of some new opcodes.
• Still haven't figured out the tvm_asm of some complex opcodes. We may need to discuss this more.

Question?

• What is the layout visual of the expanded column I should handle? I've implemented a single column

[ilyar]

@everscale-org/docs
🚀 preview https://everscale-org.github.io/preview/PR-342/arch/opcodes/tvm_instructions

[zerefwth]

@ilyar Hello, I've added the collapsed column.

[ilyar]

The current result looks very unfinished, especially when compared to the current reference outcome (https://github.com/ton-blockchain/docs/tree/master/docs/smart-contracts/tvm-instructions). The expected result should be no worse than the reference and should take into account the specific features of Everscale, which involve the division of the current virtual machine opcodes into at least two main categories: core opcodes used in the main network and additional opcodes for the specialized Gosh network. Additionally, considering an alternative to Python in favor of a similar npm package should be explored.

[ilyar]

🚀 update preview https://everscale-org.github.io/preview/PR-342/arch/opcodes/tvm_instructions

[qwadratic]

@gadillacer

• the page lacks general rules of how the gas is calculated.
• I see some empty lines in the generated table
• I see that the rightmost column is mostly empty. and for some opcodes, it duplicates the content from the desc column. (screenshot attached)

To describe the general rules of gas calculation, you can get some insight from the original specification by Telegram: https://ton.org/tvm.pdf
Appendix A, section 1:

Also it would be nice if you double-check if the implementation keeps these rules. If not, please outline the differences as well.

[zerefwth]

@ilyar seems like I misunderstood something from the beginning.

@qwadratic

• The data from the expanded column is just an example.

[zerefwth]

@ilyar I've updated a bit according to your requests. Check pls.

Hope you can provide me next step to do after that.

[ilyar]

it’s hard for me to tell you exactly what needs to be changed this process is creative at the moment the result turned out worse than the existing reference, you yourself can see it on the final render, thanks for trying to do it