Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/move get balance.sol from wiki #3448

Merged
merged 14 commits into from
Jul 5, 2024

Conversation

salaheldinsoliman
Copy link
Contributor

@salaheldinsoliman salaheldinsoliman commented Jun 24, 2024

Description of change

This is the first PR addressing moving Wiki contracts to the wasp repo.
A GetBalance.sol contract was added, alongside a solo test for it.

Links to any relevant issues

fixes issue: iotaledger/iota-wiki#1611

How the change has been tested

A Solo test.

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have selected the develop branch as the target branch
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

Signed-off-by: salaheldinsoliman <[email protected]>
@salaheldinsoliman salaheldinsoliman force-pushed the docs/move-GetBalance.sol-from-Wiki branch from 1ff10e8 to f06d075 Compare June 25, 2024 14:55
Signed-off-by: salaheldinsoliman <[email protected]>
@salaheldinsoliman salaheldinsoliman marked this pull request as ready for review June 25, 2024 15:17
packages/vm/core/evm/evmtest/evm_test.go Outdated Show resolved Hide resolved
packages/vm/core/evm/evmtest/contractInstance.go Outdated Show resolved Hide resolved
packages/evm/evmtest/GetBalance.sol Outdated Show resolved Hide resolved
@Dr-Electron
Copy link
Contributor

Just a small comment. Let's move this into its own subfolder. Something like how-tos. This will make it more clear that the team has to be careful when changing this docs as we import them in the wiki. Maybe even add a note about that somewhere in the files? Because we might import subparts of the code and if someone changes a line or two it will break what we show in the wiki

@salaheldinsoliman
Copy link
Contributor Author

salaheldinsoliman commented Jul 2, 2024

Just a small comment. Let's move this into its own subfolder. Something like how-tos. This will make it more clear that the team has to be careful when changing this docs as we import them in the wiki. Maybe even add a note about that somewhere in the files? Because we might import subparts of the code and if someone changes a line or two it will break what we show in the wiki

@Dr-Electron I initially wanted to implement it in /wasp/documentation/tutorial-examples/test, but we would need to modify the CI to build solidity contracts in that dir too. Do you mean a subfolder under the same evmtest dir?

@Dr-Electron
Copy link
Contributor

Just a small comment. Let's move this into its own subfolder. Something like how-tos. This will make it more clear that the team has to be careful when changing this docs as we import them in the wiki. Maybe even add a note about that somewhere in the files? Because we might import subparts of the code and if someone changes a line or two it will break what we show in the wiki

@Dr-Electron I initially wanted to implement it in /wasp/documentation/tutorial-examples/test, but we would need to modify the CI to build solidity contracts in that dir too. Do you mean a subfolder under the same evmtest dir?

Yeah lets keep it in evmtest so the CI need no or just minor changes. But have a subfolder there. Maybe some day we can revisit that whole importing logic 👍

@jorgemmsilva
Copy link
Contributor

you can absolutely create a new directory like /wasp/documentation/tutorial-examples/test. just add another line here:
https://github.com/iotaledger/wasp/blob/develop/Makefile#L39
after that make compile-solidity should compile stuff inside the new dir

@salaheldinsoliman
Copy link
Contributor Author

@jorgemmsilva @Dr-Electron How about a subdir wiki-how-tos under evmtest, to keep all Solidity there? and also since it is not really a tutorial

@jorgemmsilva
Copy link
Contributor

@salaheldinsoliman sounds good to me 👍

@Dr-Electron
Copy link
Contributor

I personally would just call it how_tos so it is the same as in the SDK. But yeah that sounds good. Go for it

@jorgemmsilva jorgemmsilva enabled auto-merge July 5, 2024 11:18
@jorgemmsilva jorgemmsilva force-pushed the docs/move-GetBalance.sol-from-Wiki branch from 9c18cce to 204b27f Compare July 5, 2024 11:25
@jorgemmsilva jorgemmsilva merged commit 456fdb6 into develop Jul 5, 2024
5 checks passed
@jorgemmsilva jorgemmsilva deleted the docs/move-GetBalance.sol-from-Wiki branch July 5, 2024 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants