In Solidity versions 0.8 and above, overflow and underflow checking is enabled by default. However, this checking does not apply to conversions between integer types, including data-type conversions.As a result, conversions can lead to overflow without triggering a revert.Allow us to demonstrate this issue:To assist you in getting started promptly, we have already prepared a repository showcasing this vulnerability. Let's begin by making a copy of the repository.<h3>Step 1: Cloning the Tutorial Repo</h3>1.1 Forking the Tutorial Repository:<ul><li>Visit our&nbsp;<a href="https://github.com/BuildBearLabs/Tutorials">Tutorial Repository</a>&nbsp;and click the "Fork" button to duplicate the repository into your own account. Please wait until the forking process is complete before proceeding.</li></ul>1.2 Cloning the repository locally:<ul><li>Go to your forked repository on GitHub.</li><li>Click the "Code" button and copy the URL provided (either HTTPS or SSH).</li><li>Open your terminal or Git Bash.</li><li>Navigate to the directory where you want to place the cloned repository.</li><li>Use the following command to clone the repository:</li></ul><pre><code class="language-typescript">git clone &lt;paste the copied URL here&gt;</code></pre><ul><li>Wait for the cloning process to finish. Once completed, you should see a new directory with the repository's name in the chosen directory.</li><li>To access the cloned repository, use the command&nbsp;<code>cd &lt;Name of the cloned Repo&gt;</code>, and then navigate to the DownCastingError folder by executing&nbsp;<code>cd DownCastingError</code>.</li></ul><h3>Step 2: Let's walk through the contracts.</h3>2.1 <code>unsafeDownCasting.sol</code> Contract<figure class="image image_resized" style="width:58.78%;"><img src="https://strapi.buildbear.io/uploads/carbon_17_1_cb40014242.png" alt="carbon (17) (1).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_carbon_17_1_cb40014242.png 245w,https://strapi.buildbear.io/uploads/small_carbon_17_1_cb40014242.png 500w,https://strapi.buildbear.io/uploads/medium_carbon_17_1_cb40014242.png 750w,https://strapi.buildbear.io/uploads/large_carbon_17_1_cb40014242.png 1000w," sizes="100vw"></figure>Here's a breakdown of the code:<ol style="list-style-type:decimal;"><li>The SPDX-License-Identifier specifies the license under which the contract is released. In this case, it's the MIT license.</li><li>The <code>pragma solidity ^0.8.15;</code> statement defines the version of the Solidity compiler that should be used. This contract requires Solidity version 0.8.15 or higher.</li><li>The contract is named <code>unsafeDownCasting</code>. It has a state variable named <code>LuckyNumber</code> of type <code>uint</code>, which will store the lucky number.</li><li>The <code>setLuckyNumber</code> function is a public function that takes a <code>uint256</code> parameter named <code>amount</code>. It is used to set the lucky number. Inside this function, the <code>amount</code> value is downcasted to a <code>uint8</code> using the <code>uint8(amount)</code> syntax. This downcasting operation can lead to unexpected results if the <code>amount</code> value is greater than the maximum value of <code>uint8</code>, which is 255. If the <code>amount</code> exceeds this value, only the least significant 8 bits will be stored in the <code>number</code> variable, discarding any overflowed bits. This can result in a loss of data and incorrect behavior.</li><li>The downcasted <code>number</code> value is then assigned to the <code>LuckyNumber</code> state variable.</li><li>The <code>getLuckyNumber</code> function is a public view function that returns the current value of the <code>LuckyNumber</code> variable. It allows other contracts or external entities to retrieve the lucky number without modifying the contract's state.</li></ol>2.2 <code>safeDownCasting.sol</code> Contract<figure class="image image_resized" style="width:58.27%;"><img src="https://strapi.buildbear.io/uploads/carbon_18_1_e83e8eee7f.png" alt="carbon (18) (1).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_carbon_18_1_e83e8eee7f.png 245w,https://strapi.buildbear.io/uploads/small_carbon_18_1_e83e8eee7f.png 500w,https://strapi.buildbear.io/uploads/medium_carbon_18_1_e83e8eee7f.png 750w,https://strapi.buildbear.io/uploads/large_carbon_18_1_e83e8eee7f.png 1000w," sizes="100vw"></figure><ol style="list-style-type:decimal;"><li>The contract imports the <code>SafeCast</code> library from the OpenZeppelin contracts. This library provides safe downcasting functionality.</li><li>The <code>using SafeCast for uint256;</code> statement allows the contract to use the SafeCast library for type <code>uint256</code>.</li><li>The <code>setLuckyNumber</code> function is a public function that takes a <code>uint256</code> parameter named <code>_amount</code>. It is used to set the lucky number. Inside this function, the <code>_amount</code> value is safely downcasted to <code>uint8</code> using the <code>toUint8()</code> function from the SafeCast library. If the <code>_amount</code> value is greater than the maximum value of <code>uint8</code>, the downcast will revert, ensuring that only valid downcasts are performed. The resulting <code>uint8</code> value is then assigned to the <code>LuckyNumber</code> state variable.</li></ol>Let’s deploy these contracts and see the vulnerability in action.<h3>Step 3: Setting up the Infrastructure for Deploying the Smart Contract</h3>3.1. Visit the&nbsp;<a href="https://buildbear.io/">BuildBear App</a>. ( Well we can deploy this contract on the local Hardhat node, But we will be Using BuildBear, you can understand the Reason by the end of this Tutorial).3.2. Create your Private Testnet. You have the option to either fork from the Mainnets or create a new testnet from scratch, using Mainnet as the base. Forking from the Ethereum Mainnet allows us to conveniently utilize existing NFTs and tokens.<figure class="image image_resized" style="width:47.05%;"><img src="https://strapi.buildbear.io/uploads/Untitled_16_a65da26990.png" alt="Untitled (16).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_16_a65da26990.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_16_a65da26990.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_16_a65da26990.png 750w,https://strapi.buildbear.io/uploads/large_Untitled_16_a65da26990.png 1000w," sizes="100vw"></figure>3.3. Add your Private Testnet to your MetaMask wallet by using the “Add to Metamask” button:<figure class="image image_resized" style="width:47.75%;"><img src="https://strapi.buildbear.io/uploads/Untitled_17_6fb0e82702.png" alt="Untitled (17).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_17_6fb0e82702.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_17_6fb0e82702.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_17_6fb0e82702.png 750w,https://strapi.buildbear.io/uploads/large_Untitled_17_6fb0e82702.png 1000w," sizes="100vw"></figure><h3>Step 4: Deploying the Smart Contract</h3>To begin, execute the following command to install the necessary packages:<pre><code class="language-typescript">npm install</code></pre>4.1 Update the&nbsp;<code>hardhat.config.js</code>&nbsp;file:<ul><li>Go to your Dashboard and click on "verify contract".</li></ul><figure class="image image_resized" style="width:47.99%;"><img src="https://strapi.buildbear.io/uploads/Untitled_18_3716ff3281.png" alt="Untitled (18).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_18_3716ff3281.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_18_3716ff3281.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_18_3716ff3281.png 750w,https://strapi.buildbear.io/uploads/large_Untitled_18_3716ff3281.png 1000w," sizes="100vw"></figure><figure class="image image_resized" style="width:46.12%;"><img src="https://strapi.buildbear.io/uploads/Untitled_19_8431c93373.png" alt="Untitled (19).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_19_8431c93373.png 184w,https://strapi.buildbear.io/uploads/small_Untitled_19_8431c93373.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_19_8431c93373.png 750w," sizes="100vw"></figure><ul><li>Copy the BuildBear and Etherscan objects, and update the&nbsp;<code>hardhat.config.js</code>&nbsp;file with the new values.</li></ul>4.2 To deploy the <code>safeDownCasting.sol</code> and <code>unsafeDownCasting.sol</code> &nbsp;smart contracts run the following command:&nbsp;<code>npx hardhat deploy</code>. This will execute the deployment scripts located in the&nbsp;<code>deploy</code>&nbsp;folder and save the deployment details, including the ABI and Contract address, in the&nbsp;<code>deployments</code>&nbsp;folder.<figure class="image image_resized" style="width:62.56%;"><img src="https://strapi.buildbear.io/uploads/Untitled_81_cf0b10d323.png" alt="Untitled (81).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_81_cf0b10d323.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_81_cf0b10d323.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_81_cf0b10d323.png 750w,https://strapi.buildbear.io/uploads/large_Untitled_81_cf0b10d323.png 1000w," sizes="100vw"></figure>4.3 Testing the VulnerabilityAs we are using BuildBear, we can conveniently interact with the contracts directly from the explorer, eliminating the need to write a script.Click on "Open Faucet" on the dashboard and connect your wallet to mint Native tokens. With BuildBear, we have our own Faucet, so we don't have to bug tokens as we do when we use public Testnests.Click on the link provided in the terminal of the <code>unsafeDownCasting</code> contract. You will be taken to the Contract page. Proceed to the "Write Contract" section.<figure class="image image_resized" style="width:57.78%;"><img src="https://strapi.buildbear.io/uploads/Untitled_82_bb0d42012d.png" alt="Untitled (82).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_82_bb0d42012d.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_82_bb0d42012d.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_82_bb0d42012d.png 750w,https://strapi.buildbear.io/uploads/large_Untitled_82_bb0d42012d.png 1000w," sizes="100vw"></figure>Click on "Connect to Web3". Now the explorer is connected to your wallet. Enter any number larger than 255 and click on "Write" to sign the transaction on MetaMask.<figure class="image image_resized" style="width:58.95%;"><img src="https://strapi.buildbear.io/uploads/Untitled_83_6b00a7529d.png" alt="Untitled (83).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_83_6b00a7529d.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_83_6b00a7529d.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_83_6b00a7529d.png 750w," sizes="100vw"></figure>Now move to the "Read Contract" section. You will notice that the lucky number is 44. Since the maximum value that can be represented by a <code>uint8</code> is 255, the downcast operation causes an overflow. In Solidity, when an overflow occurs during an arithmetic operation, the value "wraps around" and starts from the minimum value of the data type. In this case, the least significant 8 bits of 300 (which is 44 in binary) will be stored in the <code>number</code> variable.As a result, the <code>LuckyNumber</code> state variable will be assigned the value of 44.<figure class="image image_resized" style="width:55.68%;"><img src="https://strapi.buildbear.io/uploads/Untitled_84_176ac55262.png" alt="Untitled (84).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_84_176ac55262.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_84_176ac55262.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_84_176ac55262.png 750w," sizes="100vw"></figure>4.4 Testing the Contract with SafeCast Library.Now move to the explorer page of the safeDownCasting Contract from the link proved in the Terminal, Connect the wallet and enter 300 and click on write, as you can see the Transaction has failed. Click on “View Transaction”, As you can see the Transaction has failed with reason <code>SafeCast: value doesn't fit in 8 bits,</code> this is because the SafeCast function is checking whether the integer is less than uint8 before converting it to uint8.<figure class="image image_resized" style="width:61.98%;"><img src="https://strapi.buildbear.io/uploads/Untitled_85_64b3feea09.png" alt="Untitled (85).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_85_64b3feea09.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_85_64b3feea09.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_85_64b3feea09.png 750w," sizes="100vw"></figure><figure class="image image_resized" style="width:66.29%;"><img src="https://strapi.buildbear.io/uploads/Untitled_86_a38562cdeb.png" alt="Untitled (86).png" srcset="https://strapi.buildbear.io/uploads/thumbnail_Untitled_86_a38562cdeb.png 245w,https://strapi.buildbear.io/uploads/small_Untitled_86_a38562cdeb.png 500w,https://strapi.buildbear.io/uploads/medium_Untitled_86_a38562cdeb.png 750w,https://strapi.buildbear.io/uploads/large_Untitled_86_a38562cdeb.png 1000w," sizes="100vw"></figure>🎉 We have successfully mitigated the DownCasting Vulnerability using the SafeCast library from the OpenZeppelin contracts.If you support our efforts, please follow us on&nbsp;<a href="https://twitter.com/_BuildBear">Twitter</a>&nbsp;and&nbsp;<a href="https://www.linkedin.com/company/build-bear/">LinkedIn</a>. If you haven't already, we invite you to join our Telegram group by clicking&nbsp;<a href="https://t.me/+6mjOnBFUR9xjN2U1">here</a>.Github Repo :&nbsp;<a href="https://github.com/BuildBearLabs/Tutorials">Buildbear Tutorials</a>About BuildBear:BuildBear offers developers a convenient platform to create a customized Private Testnet network for testing their DApps. With the ability to fork EVM chains, developers can create a private network tailored to their needs.<blockquote>Use&nbsp;<a href="http://BuildBear.io">BuildBear.io</a>&nbsp;and create Your Private Testnet Now!</blockquote>

Integer Downcasting Vulnerability: Demonstration and Effective Fix

Let’s get started then, Shall we?

Let’s get started then, Shall we?

Test DApps at Scale.