README.md

FoodPrint

FoodPrint is a digital, blockchain-enabled, farm-to-fork (fresh produce) supply chain platform for smallholder farmers, primarily in developing countries. FoodPrint is designed to:

• Simplify production and harvest data collection for smallholder farmers.
• Directly connect them to market opportunities - including but not limited to intermediaries such as markets and retailers, as well as consumers.
• Provide them with access to blockchain-based financial and transactional services.

Overview

FoodPrint has 5 types of users:

• Super User Admin

The Super User is responsible for setting up the infrastructure and system configuration.

• System Admin

The System Admin is responsible for the day-to-day running of the platform, providing user support (on-boarding and operations) and basic configuration.

• Farmer

The Farmer is responsible for capturing produce data at harvest time onto FoodPrint. The Farmer also transports the produce to the Market as per order from Market Admin.

• Intermediary e.g. Wholesaler, Retailers, Farmers Market Admin etc

The Intermediary is responsible for receiving produce from the Farmer and capturing the relevant data onto FoodPrint.

• Consumer

The consumer is the final actor in a food supply chain. They purchase fresh produce from an intermediary. The consumer can scan a barcode associated with produce and view the verified produce information and supply chain stories i.e. view information on the produce they are buying, it's source and journey, hence from farm-to-fork. Android versions 8 & 9 and iOS versions 11 & 12 can automatically scan QR codes using the camera app.

Documentation

TODO

Installation (Development Environment)

In order to run FoodPrint, an environment with the following is required:

• Node.js
• Truffle Framework
• Web3.js
• Bootstrap
• MySQL
• MetaMask (MetaMask is an extension for accessing Ethereum enabled distributed applications, or "Dapps" in your browser! The extension injects the Ethereum web3 API into every website's javascript context, so that dapps can read from the blockchain.)

1. Install Truffle globally. Truffle is the most popular smart contract development, testing, and deployment framework.

$npm install -g truffle 

2. Install node dependencies.

$npm install

3. Start Ganache and Create a Workspace (or open an existing one).

4. Confirm FoodPrint smart contract compiles successfully.

$truffle compile

5. Run tests for FoodPrint smart contract.

$truffe test
$truffle test --network development

4. Deploy FoodPrint smart contract to Ganache (assumes Ganache is running).

truffle migrate will run all migrations located within your project's migrations directory. If your migrations were previously run successfully, truffle migrate will start execution from the last migration that was run, running only newly created migrations. If no new migrations exists, truffle migrate won't perform any action at all.

$truffle migrate

The --reset flag will force to run all your migrations scripts again. Compiling if some of the contracts have changed. You have to pay gas for the whole migration again.

$truffle migrate --reset

The --all flag will force to recompile all your contracts. Even if they didn't change. It is more time compiling all your contracts, and after that it will have to run all your deploying scripts again.

$truffle migrate --compile-all --reset

If for some reason truffle fails to acknowledge a contract was modified and will not compile it again, delete the build/ directory. This will force a recompilation of all your contracts and running all your deploy scripts again.

5. Update truffle-config.js development network with NetworkID, Host and Port values from your local Blockchain in Ganache.

6. Create a MySQL database

run dbxml/foodprintDB.sql

7. Populate the MySQL database

run dbxml/FoodPrintSchemaDump20210814.sql (previuously used foodprintDB_schema.sql but now out of date)

8. Create a database configuration file in the root folder - dbconfig.json and populate with updated json config as below

{
  "db_pool": {
        "host"      : <HOSTNAME>,
        "user"      : <USERNAME>,
        "password"  : <PASSWORD>,
        "database"  : <DATABASENAME>
    },
  "development": {
    "username": <USERNAME>,
    "password": <PASSWORD>,
    "database": <DATABASENAME>,
    "host": <HOSTNAME>,
    "dialect": "mysql"
  },
  "test": {
    "username": <USERNAME>,
    "password": <PASSWORD>,
    "database": <DATABASENAME>,
    "host": <HOSTNAME>,
    "dialect": "mysql"
  },
  "production": {
    "username": <USERNAME>,
    "password": <PASSWORD>,
    "database": <DATABASENAME>,
    "host": <HOSTNAME>,
    "dialect": "mysql"
  }
}

9. Create a .env file in the root directory of your project. Add environment-specific variables on new lines in the form of NAME=VALUE. For example

NODE_ENV=staging
APP_NAME=custom environment app
DB_HOST=localhost
DB_USER=root
DB_PASS=s1mpl3
EMAIL_ADDRESS=GMAIL_EMAIL_ADDRESS
EMAIL_PASSWORD=GMAIL_EMAIL_PASSWORD

You can then access the variables in your code using process.env e.g. console.log(process.env.APP_ENV)

10. Start the web server (Express) and navigate to http://localhost:3000/ in your browser.

$npm run dev

Generating Models from an existing database with Sequelize Auto

For convenience Sequelize Auto provides a programmatic api that can be used in the generation of models in addition to their cli. You can use the convenience script src/js/sequelise_auto_export.js to generate required models by supplying the table names in the tables section of the options object. The script establishes a connection to the database using the config data specified in step 8.

Execute the command below within src/js to generate the models for the specified tables:

node sequelise_auto_export.js

The generated models can be found in ./models

Deploy to Rinkeby Ethereum test network

1. Create infura project at https://infura.io (Infura gives you access to test network). This project will give you an ID that you will use in truffle-config.js infura means you do not have to sync an ether node or rinkeby node to deploy directly.

2. Connect your MetaMask wallet to Rinkeby network

3. Get test ether from https://faucet.rinkeby.io/ (you will need to create an Ethereum rinkeby wallet on MetaMask then use the address on twitter). e.g. 0x4B67D20a4F27d248aF0462C23F8C193f073517FB

4. Update truffle-config.js with rinkeby. This will deploy from the metamask accounts, by default account 0 so specify which one you want.

5. Deploy to rinkeby.

$truffle migrate --network rinkeby --compile-all --reset

5. Check contract on Ethereum testnet blockchain explorer i.e. rinkeby etherscan https://rinkeby.etherscan.io

Deploy to a Mumbai Matic test network

1. Add mumbai network details to truffle-config.js i.e. https://rpc-mumbai.matic.today

2. Connect your MetaMask wallet to Mumbai network (https://rpc-mumbai.matic.today)

3. Get a test MATIC token from Matic faucet https://faucet.matic.network (otherwise deploy will fail). Deploy by default is from your first MetaMask account so this is the one you want to fund.

4. Deploy to MATIC.

$truffle migrate --network mumbai

5. Check contract on Matic's testnet blockchain explorer i.e. Polygon PoS Chain Testnet Explorer (mumbai polygonscan) https://mumbai.polygonscan.com/

Production Deployment

1. To deploy to a production server, first bundle and uglify then deploy

$npm run build
$npm run start

Other

• Access deployed contract from CLI (V1)

$ truffle console
$ TheProduct.deployed().then(function(instance) { app = instance })
$ app.noHarvests()

• Access deployed contract from CLI (V2) after adding a sample Harvest entry and then using the resulting Harvest ID e.g. c6e301b9-aceb-498f-a63e-2503091f0ab0

$ truffle console
$ TheProductV2.deployed().then(function(instance) { app = instance })
$ app.getHarvestSubmissionsCount()
$ let harvest_logid = "c6e301b9-aceb-498f-a63e-2503091f0ab0"
$ app.getHarvestSubmitterAddress(harvest_logid)
$ let harvest=app.getHarvestSubmission(harvest_logid)
$ harvest
$ let harvestDetail=app.getHarvestSubmissionDetail(harvest_logid)
$ harvestDetail

$ let storage_logid = "51a84fb0-154f-416b-a333-4cc5725b60d1"
$ app.getStorageSubmitterAddress(storage_logid)
$ let storage=app.getStorageSubmission(storage_logid)
$ storage

• To see the list of contracts already deployed and their corresponding networks

$truffle networks [--clean]

• To add a new migration

$touch 2_deploy_contract.js

• Generate test UUID's from command line (i.e. server side).

$node
>const uuidv4 = require('uuid/v4')
>uuidv4()

• Generate test QRCode's from command line (i.e. server side).

$node
>var QRCode = require('qrcode');
>let produceUrl = "http://www.google.com";
>let supplier = "supplier";
>let produce = "Storage";
>var res2 = await QRCode.toDataURL(produceUrl);
>res2

• Flatten Smart Contract

$npm install  truffle-flattener -g
$truffle-flattener ./contracts/productv2.sol > ./productv2Flattened.sol

• Verify smart contract on Ethereum Testnet (Verify using Compiler Type: SINGLE FILE / CONCATENANTED METHOD )

$pbcopy < productv2Flattened.sol
https://rinkeby.etherscan.io/verifyContract?a=0x000000000000000000 (replace with contract address)

• Verify smart contract on Matic Testnet (Verify using Compiler Type: SINGLE FILE / CONCATENANTED METHOD )

https://mumbai.polygonscan.com/verifyContract

• Generate UML Class diagram for smart contract (sol2uml)

https://rinkeby.etherscan.io/viewsvg?t=1&a=0x000000000000000000 (replace with contract address, contract should be verified)

Contract details

Initial contract was deployed at Ethereum Testnet (rinkeby) at address https://rinkeby.etherscan.io/address/0xfC4d26073650887069dFa7Da686A491535ab8Fd4.

Latest contract is deployed on Matic Testnet (mumbai) at address https://mumbai.polygonscan.com/address/0x650168110ADa1f089D443904c6759b7349576A0d

Supported Browsers

IE / Edge	Firefox	Chrome	Safari	iOS Safari	Samsung	Opera
IE11, Edge	Supported	Supported	Supported	Supported	Supported	Supported