xiaoyifan / pearl-supply-chain

Udacity Blockchain Developer Nanodegree Program - Project 7: Ethereum DApp for Tracking Items through Supply Chain

Udacity Blockchain Developer Nanodegree Program - Project 7: Ethereum DApp for Tracking Items through Supply Chain

This project implements a Pearl Supply Chain. See the following links for information on cultured pearls and oyster farming:

• https://en.m.wikipedia.org/wiki/Cultured_pearl
• https://en.m.wikipedia.org/wiki/Oyster_farming
• https://www.thepearlsource.com/blog/about-akoya-pearls/akoya-oysters-cultivation-work/

The Ethereum DApp demonstrates a Pearl Supply Chain flow between a seller and buyer. The user story is similar to any commonly used supply chain process. A seller can add items to the inventory system stored in the blockchain. A buyer can purchase such items from the inventory system. Additionally a seller can mark an item as shipped, and similarly a buyer can mark an item as received.

UML diagrams

The diagrams folder contains the UML diagrams for the supply chain.

Activity diagram

Sequence diagram

State diagram

Classes diagram

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Please make sure you've already installed ganache-cli, Truffle and enabled the MetaMask extension in your browser.

Installing

Clone this repository and install all requisite npm packages (as listed in package.json):

npm install

Launch Ganache:

ganache-cli -m "spirit supply whale amount human item harsh scare congress discover talent hamster"

Your terminal should look something like this:

In a separate terminal window, compile the smart contracts:

truffle compile

Your terminal should look something like this:

This will create the smart contract artifacts in folder build/contracts.

Migrate smart contracts to the locally running blockchain, ganache-cli:

truffle migrate

Your terminal should look something like this:

Test smart contracts:

truffle test

All 11 tests should pass.

In a separate terminal window, launch the DApp:

npm run dev

Your terminal should look something like this:

Testing the DApp in the browser

Go to http://localhost:3000/ to open the DApp in the browser:

Import the following ganache-cli accounts into MetaMask:

• Contract Owner
  • accounts[0]: 0x27d8d15cbc94527cadf5ec14b69519ae23288b95
• Pearl Farmer
  • accounts[1]: 0x018c2dabef4904ecbd7118350a0c54dbeae3549a
• Distributor
  • accounts[2]: 0xce5144391b4ab80668965f2cc4f2cc102380ef0a
• Retailer
  • accounts[3]: 0x460c31107dd048e34971e57da2f99f659add4f02
• Consumer
  • accounts[4]: 0xd37b7b8c62be2fdde8daa9816483aebdbd356088

You have to use the accounts' private keys to do so. Now connect to the Contract Owner account and register the other accounts in the DApp:

The transaction history should look like this:

FarmerAdded - 0x180b83da33fbcebfdddca581c31e6dbbff466834904d08642a4615601998ab1c
DistributorAdded - 0xae1cc116e23d62a226074885408c0f03b99c1df1cb615daf27454e460a1d9555
RetailerAdded - 0x35f69a18fae180d5545e458e855931ab566a6c9048919dafb3109d23cf6bbdfe
ConsumerAdded - 0xf80b2e21944206079eff0f736cf8d48060531dc881171997e26d2031d3c7c71e

Now select the Pearl Farmer account in MetaMask to harvest, process, pack and put the pearls up for sale:

Afterwards, select the Distributor account in MetaMask to buy the pearls. Back with the Farmer account, you can now ship the pearls. With the Retailer account, you can then receive the pearls. And finally with the Consumer account, the pearls can be purchased.

The transaction history should look like this now:

FarmerAdded - 0x180b83da33fbcebfdddca581c31e6dbbff466834904d08642a4615601998ab1c
DistributorAdded - 0xae1cc116e23d62a226074885408c0f03b99c1df1cb615daf27454e460a1d9555
RetailerAdded - 0x35f69a18fae180d5545e458e855931ab566a6c9048919dafb3109d23cf6bbdfe
ConsumerAdded - 0xf80b2e21944206079eff0f736cf8d48060531dc881171997e26d2031d3c7c71e
Harvested - 0x546bc513360f4f203d020211f3066328723b7e2b579afbfe676e5ad264c23235
Processed - 0xb4edf072fbcd4a852a21cfb61f246c63fb9eec6e6ef49c61f25c5e7886c74ee8
Packed - 0x5dafead1d1e5d7bace33494de7bfaa5d98928e8667e794469cd84c222dc7aab3
ForSale - 0x229d2f80621ab17c133fdc9c36d122a78c14b5438e79f79733bbaf1252c450e3
Sold - 0x5d634376ba265a78de638698e75450ee18c590cfbc9d8af7eab0940a633b3eb6
Shipped - 0xf0d46fddb8ad7e685d525df1eb674bf67c1a3704124778abb56f6b3e4885ac3d
Received - 0x839ad07ffce331f32b3b289f7729ede17c64aa6fd3397e13e96bce9b74486fd6
Purchased - 0x0d170d901916c53caaec935b47e3af6db1d5ba9aee9e0f3ae108c7534a74a5f3

Deploy smart contract on a public test network (Rinkeby)

The smart contract is deployed on the Ethereum Rinkeby test network:

• Transaction ID: 0x249331471a3aa5d275049cc1aae29d45449cd1ebfbc7404fd33e198d5e8cebed
• Contract address: 0xc099d8128f57f4b02d2d4aa9d8d2678a119db26f

[thom@marvin project-7]$ truffle migrate -f 2 --network rinkeby --reset --compile-all
Compiling ./contracts/Migrations.sol...
Compiling ./contracts/PearlAccessControl/ConsumerRole.sol...
Compiling ./contracts/PearlAccessControl/DistributorRole.sol...
Compiling ./contracts/PearlAccessControl/PearlFarmerRole.sol...
Compiling ./contracts/PearlAccessControl/RetailerRole.sol...
Compiling ./contracts/PearlAccessControl/Roles.sol...
Compiling ./contracts/PearlBase/SupplyChain.sol...
Compiling ./contracts/PearlCore/Ownable.sol...
Writing artifacts to ./build/contracts

Using network 'rinkeby'.

Running migration: 2_deploy_contracts.js
  Deploying PearlFarmerRole...
  ... 0x9d46b1ed4233d03ee17a5c51170e773cc898f35e8e72cfdf62ed233a76379c48
  PearlFarmerRole: 0x770af6ae70c6b91fbece99248ed02e11f7e1c46d
  Deploying DistributorRole...
  ... 0x32e3b2017cdaa0be35360b942c20b32b74924da151bd9a7c9b247f6e1d24ce03
  DistributorRole: 0x4e3ccf23416fce6a281a72f965f8cf822035557a
  Deploying RetailerRole...
  ... 0x81bfe536f2d28b98f5de2c8fc225c2098c5ea67626650e2d995173c42a0e9cde
  RetailerRole: 0xfcdec3967b916db509d041166ae6960354c163c5
  Deploying ConsumerRole...
  ... 0xc9cb791b0b767099e74c12a77def9f6087cfc6914450f94a8e7bf63bf30e7309
  ConsumerRole: 0x7b2d8a2c961982dffb8402ec6770a6f4e593d9c4
  Deploying SupplyChain...
  ... 0x249331471a3aa5d275049cc1aae29d45449cd1ebfbc7404fd33e198d5e8cebed
  SupplyChain: 0xc099d8128f57f4b02d2d4aa9d8d2678a119db26f
Saving artifacts...

You can view the contract in Etherscan.

Requirements

Graded according to the Project Rubric.

Built With

• Ethereum - Ethereum is a decentralized platform that runs smart contracts
• Truffle Framework - Truffle is the most popular development framework for Ethereum with a mission to make your life a whole lot easier.

Versions

• Truffle v4.1.14 (core: 4.1.14)
• Solidity v0.4.24 (solc-js)
• Web3 v1.0.0-beta.55
• Node v10.15.3

License

• MIT license
• Copyright 2019 © Thomas Weibel.