-
Notifications
You must be signed in to change notification settings - Fork 13
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
feat: use jinja for templating #21
Open
skellet0r
wants to merge
18
commits into
iamdefinitelyahuman:master
Choose a base branch
from
skellet0r:dev
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
More clarity
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
Redid the mock
ERC20
contract and used Jinja2 templating to clean/simplify the process of generating contracts with different return values / failure conditions.Previously, we did manual string manipulation, however that is very clunky and doesn't invite modification. Using jinja however, the source modifications can be done in the contract file itself, rather than via the python
format
function.This also serves as an example for future modifications / templates. Although unused by me, there could very well be ERC721, ERC777, ERC1363, ERC1155 ... and more token templates.
How I did it
Mainly using the Jinja2 documentation https://jinja.palletsprojects.com/, the templating syntax is rather simple to catch on to, and has a rich set of features (such as macros which enable DRY code).
How to verify it
I ported over an actual set of ERC20 test cases, to verify that the contract works properly (not just return values), The tests are parametrized over the set of possible variations:
Success Value:
True
,False
,None
Failure Value:
True
,False
,None
,"revert"
Checklist