Skip to content

Commit

Permalink
Merge pull request #55 from welldonestudio/feature/veriwell
Browse files Browse the repository at this point in the history
feeat: veriwell docs
  • Loading branch information
markjung96 authored Dec 6, 2024
2 parents 1610240 + 10c5176 commit 0cb689b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/veriwell/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ keywords: [Multi chain contract, smart contracts]

Developers need to know the contract's address or deployment hash. Additionally, they must be aware of the OS and compiler version used during deployment. Depending on the programming language of the contract, the compilation process may or may not depend on the OS. For example, Arbitrum's Stylus generates different bytecode depending on the OS used during compilation. Similarly, compiler versions can affect compatibility; certain functions may be backward-compatible with earlier versions, while others may not.

As a result, if the OS and compiler versions differ between deployment and verification, successful verification may still be possible in some cases. However, in other scenarios, the verification process might fail without a matching environment. Therefore, developers must know the OS or compiler versions used during deployment to replicate the same build and compilation environment, ensuring successful verification.
As a result, if the OS and compiler versions differ between deployment and verification, successful verification may still be possible in some cases. However, in other scenarios, the verification process might fail without a matching environment. **Therefore, developers must know the OS or compiler versions used during deployment to replicate the same build and compilation environment, ensuring successful verification.**

Once the contract address or hash and the deployment environment are configured, developers can upload the code for compilation. The code is compiled according to the specified environment, and if the compiled output matches the on-chain code, the contract is verified successfully.

### User

No preparation is required. Simply access the (VeriWell)[https://veriwell.dev/] website and input the the address of the contract and the source code zip file you wish to verify. If the contract is verified, you will be redirected to a results page where you can review the contract's code along with explanations provided by AI support about the code's functionality.
No preparation is required. Simply access the [VeriWell](https://veriwell.dev) website and input the the address of the contract and the source code zip file you wish to verify. If the contract is verified, you will be redirected to a results page where you can review the contract's code along with explanations provided by AI support about the code's functionality.

Additionally, by connecting your wallet, you can directly interact with the contract. When creating transactions, you can rely on the AI Code Assistance to ensure you fully understand the code's purpose and functionality before executing any actions. However, remember that AI code assistance serves as a reference tool and is not yet fully reliable. Its capabilities are continuously being enhanced, but users should exercise caution and perform their own assessments.
Additionally, by connecting your wallet, you can directly interact with the contract. When creating transactions, you can rely on the AI Code Assistance to ensure you fully understand the code's purpose and functionality before executing any actions. **However, remember that AI code assistance serves as a reference tool and is not yet fully reliable. Its capabilities are continuously being enhanced, but users should exercise caution and perform their own assessments.**
2 changes: 1 addition & 1 deletion docs/veriwell/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The process of verifying smart contracts is highly cumbersome, and even when con

Smart contract verification begins by comparing the on-chain contract code with the off-chain source code. This involves compiling the off-chain code into bytecode and comparing it with the bytecode of the deployed on-chain contract. While this fundamental framework is consistent, the verification process varies depending on the programming languages used by different blockchains. This creates a significant burden for developers working in multi-chain environments, often leading to incomplete or skipped verification processes.

VeriWell is a web-based verification platform designed to allow developers to verify their contracts seamlessly within tailored environments. Developers can replicate the deployment environment on VeriWell, input the address or hash of their contract, upload the code, and proceed with the verification process. VeriWell's goal is to support all environments, ensuring comprehensive verification regardless of the developer's setup. To this end, VeriWell supports both development environments and multi-chain deployments. Currently, it supports chains within the EVM ecosystem, such as Ethereum and Arbitrum, with plans to expand to non-EVM blockchains and additional networks. Developers can select their operating system (e.g., macOS, Linux), the blockchain where their contract is deployed, and the compiler version to target their desired environment for verification.
[VeriWell](https://www.veriwell.dev/) is a web-based verification platform designed to allow developers to verify their contracts seamlessly within tailored environments. Developers can replicate the deployment environment on VeriWell, input the address or hash of their contract, upload the code, and proceed with the verification process. VeriWell's goal is to support all environments, ensuring comprehensive verification regardless of the developer's setup. To this end, VeriWell supports both development environments and multi-chain deployments. Currently, it supports chains within the EVM ecosystem, such as Ethereum and Arbitrum, with plans to expand to non-EVM blockchains and additional networks. Developers can select their operating system (e.g., macOS, Linux), the blockchain where their contract is deployed, and the compiler version to target their desired environment for verification.

Once the code is verified, users can access the verification status anytime and anywhere through the web interface. While developers handle the code verification on VeriWell, the individuals reviewing verified contracts are often non-developers. These users typically interact with the contract to manage their assets and need assurance of its safety. Since many of them lack coding knowledge, VeriWell provides an AI Code Assistance feature. This AI tool offers a comprehensive explanation of the code and analyzes potential vulnerabilities, enabling even non-technical users to understand the contract and assess its risks. Additionally, VeriWell allows users to interact directly with the contract. Before executing a transaction, users can inspect the functionality of the contract they are engaging with and view explanations from the AI assistant.

Expand Down
1 change: 0 additions & 1 deletion src/components/Banner/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ function Banner() {
}}
/>
</Box>
{/* iframe here */}
</Box>
<Chip
label="New"
Expand Down

0 comments on commit 0cb689b

Please sign in to comment.