updated: readme, contract improvements, ci pipeline tests

Author: Salmandabbakuti

.github/workflows/e2e.yml

@@ -0,0 +1,64 @@
+name: e2e-test
+
+on:
+  push:
+    branches: [main, develop, "feat/*"]
+  pull_request:
+    branches: [main, develop, "feat/*"]
+
+jobs:
+  nodejs-step:
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+        os: [macos-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      # - name: Install Windows Build Tools (if needed)
+      #   if: matrix.os == 'windows-latest'
+      #   run: |
+      #     npm install -g windows-build-tools
+      - name: Install Node.js dependencies
+        run: npm install
+      - name: Compile contract
+        run: npx hardhat compile
+      - name: Start local blockchain
+        run: npx hardhat node & sleep 5
+
+  python-step:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        os: [macos-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Python dependencies
+        run: pip install -r requirements.txt
+      # - name: Start App
+      #   run: python app.py & sleep 5
+      # Add your testing steps here
+      # - name: Simulate GPIO 14 ON request
+      #   run: |
+      #     if [[ "${matrix.os}" == "windows-latest" ]]; then
+      #       curl http://localhost:8000/fourteen/on
+      #     else
+      #       curl http://host.docker.internal:8000/fourteen/on
+      #     fi

.github/workflows/pythonapp.yml

@@ -1,32 +1,72 @@
-## IoT-and-Blockchain
+# IoT-and-Blockchain
 
-- [Demonstration Article](https://link.medium.com/TcNvHHZoY1)
+A simple IoT and Blockchain based application to demonstrate the use of blockchain in IoT.
 
-##### Quick Demo
->Note: *Windows Build Tools is required to install web3. Install through Powershell(Admin) if not installed already*
+## Getting Started
 
-```
+### Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/)
+- [Python](https://www.python.org/downloads/)
+- Windows 8+ or MacOS X
+
+> Note: _Windows Build Tools is required to install web3. Install through Powershell(Admin) if not installed already_
+
+```bash
 npm install -g windows-build-tools
 ```
 
+### Steps
+
+Before starting with app, you need to compile the smart contract and start a local blockchain. Follow the steps below to do so:
+
+1. Install required dependencies:
+
+```bash
+npm install
+```
+
+2. Start a local blockchain using Hardhat:
 
+```bash
+npx hardhat node
 ```
-git clone https://github.com/Salmandabbakuti/IoT-and-Blockchain.git
-cd IoT-and-Blockchain
-yarn install
-yarn start-node # local testnet for deployments
-yarn compile # compile contract
-yarn deploy # deploy contract
 
+3. Compile contract in a separate terminal:
+
+```bash
+npx hardhat compile
+```
+
+4. Install python dependencies and start the app:
+
+```bash
 pip install -r requirements.txt
-python app.py # run app: open localhost:8000
+
+python app.py
 ```
 
-<img align="center" src="https://github.com/Salmandabbakuti/IoT-and-Blockchain/blob/master/assets/screen.png" width="90%">
+Open http://localhost:8000 in your browser to see the app and Interact with the IoT device.
+
+### Demo
+
+![screen](https://github.com/Salmandabbakuti/IoT-and-Blockchain/assets/29351207/4e684842-095e-4472-85fc-5621295ce6a3)
+
+## Built With
+
+- [Flask](https://flask.palletsprojects.com/en/1.1.x/) - The web framework used for the backend
+- [Web3.py](https://web3py.readthedocs.io/en/stable/) - Python library for interacting with Ethereum blockchain
+- [Hardhat](https://hardhat.org/) - Ethereum development environment for compiling, testing, deploying, and interacting with smart contracts
+- [Solidity](https://docs.soliditylang.org/en/v0.8.4/) - Ethereum's smart contract programming language
+- [GPIO Simulator](https://pypi.org/project/GPIOSimulator/) - Python library for simulating GPIO pins
+- [RPi.GPIO](https://pypi.org/project/RPi.GPIO/) - Python library for accessing GPIO pins on Raspberry Pi
+
+## Safety
 
+This is experimental software and subject to change over time.
 
- ##### Author   
+This is a proof of concept and is not ready for production use. It is not audited and has not been tested for security. Use at your own risk. I do not give any warranties and will not be liable for any loss incurred through any use of this codebase.
 
-##### :wave: [Salman Dabbakuti](https://salmandabbakuti.github.io)
+## License
 
-<a href="https://www.buymeacoffee.com/Salmandabbakuti" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>    
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

README.md

@@ -25,13 +25,13 @@
 contract = w3.eth.contract(abi=abi, bytecode=bytecode)
 
 # Get transaction hash from deployed contract
-tx_hash = contract.constructor().transact({'from': w3.eth.accounts[0], 'gas': 410000})
+tx_hash = contract.constructor().transact()
 
 # Get tx receipt to get contract address
 tx_receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
 
 # Deployed Contract instance
-contract_instance = w3.eth.contract(abi=abi, address=tx_receipt.contractAddress)
+contract_instance = w3.eth.contract(address=tx_receipt.contractAddress, abi=abi, )
 
 #Control Interface
 for i in pinList:
@@ -43,77 +43,77 @@
 def index():
     return render_template('index.html')
 
-@app.route("/<pin>/<action>")
-def control(pin, action):
+@app.route("/<pin_id>/<action>")
+def set_pin_status(pin_id, action):
     #Actuator configuration
-    if pin=='fourteen':
-        actuator=14
-    elif pin=='fifteen':
-        actuator=15
-    elif pin=='eighteen':
-        actuator=18
-    elif pin=='twentythree':
-        actuator=23
-    elif pin=='twentyfour':
-        actuator=24
-    elif pin=='twentyfive':
-        actuator=25
-    elif pin=='eight':
-        actuator=8
-    elif pin=='seven':
-        actuator=7
-    elif pin=='twelve':
-        actuator=12
-    elif pin=='sixteen':
-        actuator=16
-    elif pin=='twenty':
-        actuator=20
-    elif pin=='twentyone':
-        actuator=21
-    elif pin=='two':
-        actuator=2
-    elif pin=='three':
-        actuator=3
-    elif pin=='four':
-        actuator=4
-    elif pin=='seventeen':
-        actuator=17
-    elif pin=='twentyseven':
-        actuator=27
-    elif pin=='twentytwo':
-        actuator=22
-    elif pin=='ten':
-        actuator=10
-    elif pin=='nine':
-        actuator=9
-    elif pin=='eleven':
-        actuator=11
-    elif pin=='five':
-        actuator=5
-    elif pin=='six':
-        actuator=6
-    elif pin=='thirteen':
-        actuator=13
-    elif pin=='nineteen':
-        actuator=19
-    elif pin=='twentysix':
-        actuator=26
+    if pin_id=='fourteen':
+        pin_number=14
+    elif pin_id=='fifteen':
+        pin_number=15
+    elif pin_id=='eighteen':
+        pin_number=18
+    elif pin_id=='twentythree':
+        pin_number=23
+    elif pin_id=='twentyfour':
+        pin_number=24
+    elif pin_id=='twentyfive':
+        pin_number=25
+    elif pin_id=='eight':
+        pin_number=8
+    elif pin_id=='seven':
+        pin_number=7
+    elif pin_id=='twelve':
+        pin_number=12
+    elif pin_id=='sixteen':
+        pin_number=16
+    elif pin_id=='twenty':
+        pin_number=20
+    elif pin_id=='twentyone':
+        pin_number=21
+    elif pin_id=='two':
+        pin_number=2
+    elif pin_id=='three':
+        pin_number=3
+    elif pin_id=='four':
+        pin_number=4
+    elif pin_id=='seventeen':
+        pin_number=17
+    elif pin_id=='twentyseven':
+        pin_number=27
+    elif pin_id=='twentytwo':
+        pin_number=22
+    elif pin_id=='ten':
+        pin_number=10
+    elif pin_id=='nine':
+        pin_number=9
+    elif pin_id=='eleven':
+        pin_number=11
+    elif pin_id=='five':
+        pin_number=5
+    elif pin_id=='six':
+        pin_number=6
+    elif pin_id=='thirteen':
+        pin_number=13
+    elif pin_id=='nineteen':
+        pin_number=19
+    elif pin_id=='twentysix':
+        pin_number=26
     else:
         return render_template('index.html')
 
     #Control interface
     if action=='on':
-         is_active = True
+         pin_status = 1
     else:
-        is_active = False
-    tx_hash = contract_instance.functions.controlPin(actuator, is_active).transact({'from': w3.eth.accounts[0]})
+        pin_status = 0
+    tx_hash = contract_instance.functions.setPinStatus(pin_number, pin_status).transact({'from': w3.eth.accounts[0]})
     print('Transaction submitted:', tx_hash.hex())
-    pin_status = format(contract_instance.functions.pinStatus(actuator).call())
-    print(f'Pin {actuator} status changed to {pin_status}')
-    if pin_status == 'True':
-        GPIO.output(actuator,GPIO.HIGH)
+    pin_status = format(contract_instance.functions.pinStatus(pin_number).call())
+    print(f'Pin {pin_number} status changed to {pin_status}')
+    if pin_status == "1":
+        GPIO.output(pin_number,GPIO.HIGH)
     else:
-        GPIO.output(actuator,GPIO.LOW)
+        GPIO.output(pin_number,GPIO.LOW)
 
     return render_template('index.html')
 

app.py

@@ -8,10 +8,14 @@ contract PinController {
         owner = msg.sender;
     }
 
-    mapping(uint8 => bool) public pinStatus;
+    enum PinStatus {
+        Off,
+        On
+    }
+    mapping(uint8 => PinStatus) public pinStatus;
 
-    function controlPin(uint8 _pin, bool _isActive) public {
+    function setPinStatus(uint8 _pin, PinStatus _pinStatus) public {
         require(msg.sender == owner);
-        pinStatus[_pin] = _isActive;
+        pinStatus[_pin] = _pinStatus;
     }
 }

assets/screen.png

@@ -1,42 +1,3 @@
-require("@nomiclabs/hardhat-ethers");
-
-// This is a sample Hardhat task. To learn how to create your own go to
-// https://hardhat.org/guides/create-task.html
-task("hello", "Prints Hello World", () => console.log("Hello World!"));
-
-task("deploy", "Deploys Contract", async () => {
-  const contractFactory = await ethers.getContractFactory("PinController");
-  const contract = await contractFactory.deploy();
-  await contract.deployed();
-  console.log("contract deployed to:", contract.address);
-});
-
 module.exports = {
-  defaultNetwork: "local",
-  networks: {
-    hardhat: {
-      chainId: 1337
-    },
-    local: {
-      url: "http://127.0.0.1:8545",
-    }
-  },
-  solidity: {
-    version: "0.8.13",
-    settings: {
-      optimizer: {
-        enabled: true,
-        runs: 200
-      }
-    }
-  },
-  paths: {
-    sources: "./contracts",
-    tests: "./test",
-    cache: "./cache",
-    artifacts: "./artifacts"
-  },
-  mocha: {
-    timeout: 20000
-  }
-}
+  solidity: "0.8.13",
+};