docs: add more comments for contracts #218
Merged
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
cosinlink
changed the title
unclezoro
approved these changes
Dec 19, 2022
unclezoro
changed the title
unclezoro
pushed a commit
that referenced
this pull request
Apr 20, 2023
remove, register, add admin + onlyAdmin modifier add relayer functions helper function to avoid repeat of code verifyRelayer and relayerExistsMap updateParam changes Remove unwanted code and variables Remove old code Formatting + efficient return for verify function decouple registered and nonregistered admins, remove relayer before deleting, correct address size, add old modifier checks before adding relayer seed with current whitelists.todo: add relayers Refactor: replace admin with manager contract and exist checks inside function remove onlyWhitelabelRelayer for the most part. Remove register unregister from template file isRelayer, not verifyRelayer isContract check for manager override in isRelayer refactor naming addRelayer -> editRelayer remove most compilation errors apart from transfer compilation error fix: payable+map extra payables modify templates fix bugs in contract feat: add foundry test (#194) * add foundry test and clean unused files * update readme Remove unneeded modifier + properly remove relayer updateRelayer event and no need for removeRelayer For smooth transition and let old relayers exit Only use updateRelayerEvent + Refacoring functions Better naming of some maps update only once Remove repeated event Remove onlyAllowedParty + correct var order remove deposit + bring back old withdraw test for adding new param which doesn't work correct the test testunregister Check emit event remove manager and ismanger, isrelayer test removeManagerByHimself test + comments testCurrentRelayerTransition() and update() Remove manager struct Refactor + remove unwanted functions Remove check that is not needed Refactor to less confusing name Ensure manager isn't already registered bug info Test for relayer address 0 which had a bug Remove todo which is already done now Combine to one manager struct Remove dues remove unwanted code ensure 0 address is not a relayer remove deposit and dues code in updateParam template file update + correct whitelist mainnet addr check contract first refactor Refactor even names and regenerate interface payable manager not required bug fix of twice adding of same relayer + test emit events in initialisation as well update the template file based on recent changes public to internal + remove unused event Test to ensure a contract can't be a relayer 2 step relayer registration. todo: test update Fix testAddManager Fix the rest of the tests Remove unused comments check for code and proxy relayer + test edge case where manager gets removed before accept name change to be consistent delete provisional relayer when relayer is deleted Check for correct manager update comment dlt managerToProvisionalRelayer when dltng relayer address pr comments update template remove check for contracts on relayer manager docs: add how to generate mainnet/testnet/QA genesis file (#221) docs: add more comments for contracts (#218) Update BEP20Token.template (#236) feat(BEP-171): enhance security of cross-chain (#204) remove unused onlyWhitelabelRelayer relayer: update template extract helper function addNewManager in tests relayer: fix generation scripts
unclezoro
pushed a commit
that referenced
this pull request
Apr 20, 2023
brilliant-lx
pushed a commit
that referenced
this pull request
Apr 20, 2023
admin struct & removeAdminAddress code remove, register, add admin + onlyAdmin modifier add relayer functions helper function to avoid repeat of code verifyRelayer and relayerExistsMap updateParam changes Remove unwanted code and variables Remove old code Formatting + efficient return for verify function decouple registered and nonregistered admins, remove relayer before deleting, correct address size, add old modifier checks before adding relayer seed with current whitelists.todo: add relayers Refactor: replace admin with manager contract and exist checks inside function remove onlyWhitelabelRelayer for the most part. Remove register unregister from template file isRelayer, not verifyRelayer isContract check for manager override in isRelayer refactor naming addRelayer -> editRelayer remove most compilation errors apart from transfer compilation error fix: payable+map extra payables modify templates fix bugs in contract feat: add foundry test (#194) * add foundry test and clean unused files * update readme Remove unneeded modifier + properly remove relayer updateRelayer event and no need for removeRelayer For smooth transition and let old relayers exit Only use updateRelayerEvent + Refacoring functions Better naming of some maps update only once Remove repeated event Remove onlyAllowedParty + correct var order remove deposit + bring back old withdraw test for adding new param which doesn't work correct the test testunregister Check emit event remove manager and ismanger, isrelayer test removeManagerByHimself test + comments testCurrentRelayerTransition() and update() Remove manager struct Refactor + remove unwanted functions Remove check that is not needed Refactor to less confusing name Ensure manager isn't already registered bug info Test for relayer address 0 which had a bug Remove todo which is already done now Combine to one manager struct Remove dues remove unwanted code ensure 0 address is not a relayer remove deposit and dues code in updateParam template file update + correct whitelist mainnet addr check contract first refactor Refactor even names and regenerate interface payable manager not required bug fix of twice adding of same relayer + test emit events in initialisation as well update the template file based on recent changes public to internal + remove unused event Test to ensure a contract can't be a relayer 2 step relayer registration. todo: test update Fix testAddManager Fix the rest of the tests Remove unused comments check for code and proxy relayer + test edge case where manager gets removed before accept name change to be consistent delete provisional relayer when relayer is deleted Check for correct manager update comment dlt managerToProvisionalRelayer when dltng relayer address pr comments update template remove check for contracts on relayer manager docs: add how to generate mainnet/testnet/QA genesis file (#221) docs: add more comments for contracts (#218) Update BEP20Token.template (#236) feat(BEP-171): enhance security of cross-chain (#204) remove unused onlyWhitelabelRelayer relayer: update template extract helper function addNewManager in tests relayer: fix generation scripts
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.
Add more comments for TokenHub contract.