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: add how to generate mainnet/testnet/QA genesis file #221

Merged
merged 1 commit into from
Dec 19, 2022

Conversation

unclezoro
Copy link
Collaborator

Description

In this pr, the readme guide user to generate the genesis file in one short command.

Rationale

Currently, when we upgrade a smart contract on BSC network, it is hard for another developer to verify whether the byte code is right or not.

We introduce some docs in this PR, so that reviewer can easily verify the bytecode.

Example

NA

Changes

Nono

@unclezoro unclezoro added the r4r label Dec 19, 2022
@unclezoro unclezoro changed the title docs: add how to generate mainnet/testnet/QA gemesis file docs: add how to generate mainnet/testnet/QA genesis file Dec 19, 2022
README.md Outdated
@@ -24,6 +24,10 @@ Truffle: v5.1.31

Solc: 0.6.4+commit.1dca32f3

Tips: You can manage multi version of
- solc by [solc-select](https://github.com/crytic/solc-select).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we add an example command e.g. solc-select install 0.6.4 && solc-select use 0.6.4 ?
Similar for nvm.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, updated.

@unclezoro unclezoro merged commit d98c857 into bnb-chain:develop Dec 19, 2022
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
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
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants