Review TODO comments

[JulianGCalderon]

throughout the code there are some todo comments that should be reviewed

• Is the comment still valid? If not, then it could be removed.
• If it is valid, we should create an issue to track it.

To find the todo comments quickly, you could use rg -i '//.*todo'. (requires ripgrep)

At the moment of writing this, there are 29 todo comments.

[hakymulla]

Can i work on this?
what do you mean by if the comment is still valid?

[JulianGCalderon]

Sure, you can work on this!

what do you mean by if the comment is still valid?

What I mean is, has the todo comment been addressed? Maybe it has already been solved and we forgot to remove the comment. Or maybe due to other changes in the repository, the todo comment itself doesn't make sense anymore.

Keep in mind, you don't have to remove all todo comments at once. Some of them may be difficult to understand / require more knowledge of the code base to understand. You can ignore those.

Also, ignore the debug_utils folder for now. You should take a look only at the cairo-native crate (src directory).

Thank you and good luck!

[hakymulla]

is this a proper format
https://docs.google.com/document/d/e/2PACX-1vQFaAZXiUAyXIKNhTidfmxYcaaB5s7_JUhXxnmRlP10p6XVRMxfrZlHkp1hyHsipKNZ0s293u8UMAUF/pub?

Who is to create the issue?

[JulianGCalderon]

Hey @hakymulla! Looks good!

You can create the issues yourself.

Make sure that each issue contains:

• A title.
• An explanation of the comment.
• A permalink to the TODO comment.

Also, please create a PR adding a link to the corresponding issue in each todo comment.

[hakymulla]

Hey @JulianGCalderon ,

// todo add recursive contract test

src/executor/contract.rs#L687

Can you clarify what this means.

[JulianGCalderon]

Hey @hakymulla. Yes, of course.

A Starknet contract can invoke other contracts through the call syscalls (call_contract, library_call). By add recursive contract test, we mean to test a contract that calls itself many times, recursively.

[JulianGCalderon]

Good work @hakymulla! I'll be reviewing the issues you created (and maybe I'll make some modification to make them clearer, if necessary)

[JulianGCalderon]

I reviewed all issues and modified some of them to make them clearer. I also closed some as there were not relevant anymore.

[JulianGCalderon]

I removed the check-outdated flag, because there are still some TODO comments that should be analyzed before closing this issue.