Open
Conversation
Loan token enhancements v1.20.0
tjcloa
reviewed
Jun 8, 2022
| @@ -0,0 +1,59 @@ | |||
| # WHAT IS THIS SCRIPT SET FOR? | |||
|
|
|||
| This set of scripts is intended to help devs to find out if the contracts of a given commit / branch in a repo will reproduce exactly the contracts deployed in the blockchain. | |||
Contributor
There was a problem hiding this comment.
This set of scripts is intended to help devs to find out if the contracts ABI of a given commit / branch in a repo correspond to the contracts deployed in the blockchain.
tjcloa
reviewed
Jun 8, 2022
|
|
||
| This set of scripts is intended to help devs to find out if the contracts of a given commit / branch in a repo will reproduce exactly the contracts deployed in the blockchain. | ||
| These scripts are categorized into four .js files for convenient separate execution. | ||
| This can be used as a tool to predict if the contract code in certain repo / branch / commit will verify in a block explorer. |
Contributor
There was a problem hiding this comment.
Suggested change
| This can be used as a tool to predict if the contract code in certain repo / branch / commit will verify in a block explorer. | |
| This can be used as a tool to identify if the contract code in certain repo / branch / commit will verify in a block explorer. |
tjcloa
reviewed
Jun 8, 2022
|
|
||
| The folder ./scripts/predictor have four .js files and may have several .json files, but one them is invariant: contract_config.json | ||
|
|
||
| These scripts will work only provided that there exist a folder in the repo named ./scripts/contractInteraction contentive of the .json files listing all the Sovryn's deployed contracts. |
Contributor
There was a problem hiding this comment.
Suggested change
| These scripts will work only provided that there exist a folder in the repo named ./scripts/contractInteraction contentive of the .json files listing all the Sovryn's deployed contracts. | |
| These scripts will work only provided that there exists a folder in the repo named ./scripts/contractInteraction contentive of the .json files listing all the Sovryn's deployed contracts. |
pls consider putting all settings - paths etc. in e.g. .deployment-verifier.json or .ts/.js
tjcloa
reviewed
Jun 8, 2022
| ## How to Use These Scripts | ||
|
|
||
| 1. Clone locally the smart contracts git repo. | ||
| 2. Install the dependencies as instructed in the RAEADME.md file of that repo. |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. Install the dependencies as instructed in the RAEADME.md file of that repo. | |
| 2. Install the dependencies as instructed in the README.md file of that repo. |
tjcloa
reviewed
Jun 8, 2022
| $ node createJSON | ||
| ``` | ||
|
|
||
| After this, files like `m_deployed_compiled.json` mut be present. Be ware that if there was a previous .json file with that name, this script will overwrite it. |
Contributor
There was a problem hiding this comment.
pls consider adding it as parameter to cover cases when you can add an external ABI manually and those won't be overwritten
tjcloa
reviewed
Jun 8, 2022
| $ node createJSON | ||
| ``` | ||
|
|
||
| After this, files like `m_deployed_compiled.json` mut be present. Be ware that if there was a previous .json file with that name, this script will overwrite it. |
Contributor
There was a problem hiding this comment.
Suggested change
| After this, files like `m_deployed_compiled.json` mut be present. Be ware that if there was a previous .json file with that name, this script will overwrite it. | |
| After this, files like `m_deployed_compiled.json` mut be present. Beware that if there was a previous .json file with that name, this script will overwrite it. |
tjcloa
reviewed
Jun 8, 2022
| ``` | ||
| $ node findFiles | ||
| ``` | ||
| This will fill the dump files with the paths of the files with the conpiled bytecodes. |
Contributor
There was a problem hiding this comment.
Suggested change
| This will fill the dump files with the paths of the files with the conpiled bytecodes. | |
| This will fill the dump files with the paths of the files with the compiled bytecodes. |
tjcloa
reviewed
Jun 8, 2022
Comment on lines
+30
to
+32
| 4. `./scripts/predictor/contract_config.json` can be edited to extend it. Be ware that the info must be precise or the script may fail with unexpected errors. | ||
| 5. Check the info in folder `./scripts/contractInteraction` and make sure that at least that the files `mainnet_contracts.json` and `testnet_contracts.json` are present with the relevant info. These files are expected to contain as accurate and complete information as possible, about contract deployments on chain. | ||
| 6. Go to the folder `./scripts/predictor` and execute: |
Contributor
There was a problem hiding this comment.
pls consider adding paths to a config like .deployment-verifier.json
tjcloa
reviewed
Jun 8, 2022
| # WHAT IS THIS SCRIPT SET FOR? | ||
|
|
||
| This set of scripts is intended to help devs to find out if the contracts of a given commit / branch in a repo will reproduce exactly the contracts deployed in the blockchain. | ||
| These scripts are categorized into four .js files for convenient separate execution. |
Contributor
There was a problem hiding this comment.
pls add a high level schematic description of how it works as a sequence of steps like
- provide/generate ABIs and bytecodes of the contracts you want to verify
- provide contracts addresses
- run comparator script on a blockchain (provide as parameter) to get the list of contracts which ABIs correspond to the deployed contracts meaning that they will be successfully verified in the blockchain explorers
Contributor
There was a problem hiding this comment.
btw can it be extended with automatic verifier? :)
tjcloa
reviewed
Jun 8, 2022
Contributor
tjcloa
left a comment
tjcloa
left a comment
There was a problem hiding this comment.
pls see inline comments
also pls run the README.md text through grammarly or similar to tackle typos
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Links to:
Need for this PR
Description how it works
Script to help to predict if a bytecode in a deployed contract will correspond to the locally compiled bytecode.