Modify Readme #11
Modify Readme #11
Conversation
nivcertora
requested review from
yoav-el-certora,
AsafHochstadtCertora and
itay-certora
github-actions
bot
force-pushed
the
niv/New-Readme
branch
2 times, most recently
from
a64302a to
bbb8e73
Compare
github-actions
bot
force-pushed
the
niv/New-Readme
branch
from
bbb8e73 to
7662779
Compare
nivcertora
force-pushed
the
niv/New-Readme
branch
from
7662779 to
44419a9
Compare
github-actions
bot
force-pushed
the
niv/New-Readme
branch
from
4c7db88 to
da09b42
Compare
README.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # ProposalTools | |||
|
|
|||
| ProposalTools is a Python-based utility designed to fetch and compare smart contract source codes. It helps users identify and analyze differences between local and remote versions of smart contract code. | |||
| ProposalTools is an open-source Python utility designed to fetch and compare smart contract source codes. It helps users identify and analyze differences between local and remote versions of smart contract code, making it easier to review changes and ensure code integrity. | |||
There was a problem hiding this comment.
@itay-certora Can you please provide more information from a user perspective?
Maybe more details to someone who is not 100% familiar with proposal reviews?
There was a problem hiding this comment.
There was a problem hiding this comment.
ProposalTools is an open-source Python utility that simplifies the verification of smart contracts deployed on the blockchain. It works by fetching the smart contract code directly from the blockchain and comparing it to the official code provided by developers or customers in their GitHub repositories. This process ensures that the code running on the blockchain exactly matches the intended code, helping to detect any unauthorized changes or discrepancies and maintaining the integrity and trustworthiness of the deployed contracts.
For users involved in reviewing governance proposals, ProposalTools streamlines the process by automating tasks like searching for specific elements within the contract code—such as ChainLink addresses—making it easier to review and understand the contract’s functionality without manually sifting through the code. This aids in confidently assessing proposals and contributes to maintaining the security of the blockchain network.
If you’re unfamiliar with governance proposals: They are formal suggestions made by community members or stakeholders to introduce changes or improvements to a blockchain network’s protocols, smart contracts, or policies. These proposals require thorough review to ensure they are secure and beneficial to the network.
There was a problem hiding this comment.
Perhaps add something like this: ProposalTools allows users to pull the smart contract code that is deployed on-chain and compare it to the version stored in the customer's official repositories. This ensures there are no discrepancies between the two versions, which is critical because any unintended changes or errors in smart contracts could lead to vulnerabilities or operational issues.
There was a problem hiding this comment.
What do you think about this paragraph?
ProposalTools is an open-source Python utility designed to verify the integrity of smart contracts deployed on blockchains. It fetches contract code directly from the blockchain and compares it with the official version provided by developers or customers in their GitHub repositories. This process helps identify discrepancies between the on-chain and official code, ensuring the contract deployed on the blockchain matches the intended version. By automating code comparison and streamlining the review of governance proposals, ProposalTools enhances the security and trustworthiness of smart contracts, helping users quickly detect unauthorized changes or errors.
github-actions
bot
force-pushed
the
niv/New-Readme
branch
from
c05c365 to
84295eb
Compare
github-actions
bot
force-pushed
the
niv/New-Readme
branch
from
84295eb to
5788465
Compare
No description provided.