Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roaldnefs/supply-chain

Seafood Supply Chain is a DApp seafood supply chain solution backed by the Ethereum platform. The smart contracts manage specific user permission controls as well as contracts that track and verify a product's authenticity.
https://github.com/roaldnefs/supply-chain

dapp ethereum supply-chain

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/roaldnefs/supply-chain
Owner: roaldnefs
License: mit
Created: 2021-07-26T17:34:54.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-08-11T11:36:32.000Z (over 3 years ago)
Last Synced: 2024-12-22T11:24:37.667Z (about 1 month ago)
Topics: dapp, ethereum, supply-chain
Language: JavaScript
Homepage:
Size: 1.36 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Seafood Supply Chain

Seafood Supply Chain is a DApp seafood supply chain solution backed by the Ethereum platform. The smart contracts manage specific user permission controls as well as contracts that track and verify a product's authenticity.

Quick Start »

Report Bug
·
Request Feature

## Introduction
Seafood Supply Chain is a DApp supply chain solution backed by the Ethereum platform. The smart contracts manage specific user permission controls as well as contracts that track and verify a product's authenticity.

| ⚠️ **Notice**: For development purposes only! |
| --- |

## Prerequisites
Before running the Supply Chain project make sure the following dependencies are installed:

* Truffle v5.4.0 (core: 5.4.0)
* Solidity v0.8.6 (solc-js)
* Node v16.4.2
* Web3.js v1.2.4

## Quick Start
Use the following command to deploy the smart contracts to a local blockchain, run the tests and launch the DApp. Start by cloning the repository:

```
git clone https://github.com/roaldnefs/supply-chain.git
cd supply-chain
```

After installing all the [prerequisites](#prerequisites) run the following commands to install the required NPM packages:

```
npm install
```

Launch Ganache to start a local Ethereum blockchain for development and testing purposes:

```
ganache-cli
```

Compile the smart contracts by running the following command:

```
truffle compile
```

After the compiling the smart contracts they can be migrated to the locally running blockchain:

```
truffle migrate
```

Run the included tests:

```
npm run test
```

Launch the DApp using the following command:

```
npm run dapp
```

You should now be able to interact with the DApp via: [http://localhost:8080](http://localhost:8080).

## Deployed to Rinkeby
The smart contracts have been deployed to the Rinkeby Testnet Network. The information of the _SupplyChain_ contract is listed below:

**Transaction ID:** [0x097ef453cd06d31417a6e7b21a48721c0f11a13ad481d921c5f2fa508efab71c](https://rinkeby.etherscan.io/tx/0x097ef453cd06d31417a6e7b21a48721c0f11a13ad481d921c5f2fa508efab71c)

**Contract address:** [0x1Bb4D68246e362D70f0168f7250B19552a2b4e08](https://rinkeby.etherscan.io/address/0x1bb4d68246e362d70f0168f7250b19552a2b4e08)

## Libraries
The project adopted the following libraries:

* **@truffle/hdwallet-provider:** HD Wallet-enabled Web3 provider. Use it to sign transactions for addresses derived from a 12 or 24 word mnemonic.
* **truffle-assertion:** additional assertions and utilities for testing Ethereum smart contracts in Truffle unit tests.

## IPFS
Although IPFS isn't being used in the project, it could be used to store the product images and host the frontend of the DApp.

## Design
The **Seafood Supply Chain** is based upon the UML diagrams showed below.

### Activity Diagram
![Activity diagram of the Seafood Supply Chain](diagrams/activity.png?raw=true "Activity diagram of the Seafood Supply Chain")

### Sequence Diagram
![Sequence diagram of the Seafood Supply Chain](diagrams/sequence.png?raw=true "Sequence diagram of the Seafood Supply Chain")

### State Diagram
![State diagram of the Seafood Supply Chain](diagrams/state.png?raw=true "State diagram of the Seafood Supply Chain")

### Class Diagram
![Class diagram of the Seafood Supply Chain](diagrams/class.png?raw=true "Class diagram of the Seafood Supply Chain")

## Acknowledgment
The project is heavily based upon [nd1309-Project-6b-Example-Template](https://github.com/udacity/nd1309-Project-6b-Example-Template), with the modified work by [Roald Nefs](https://github.com/roaldnefs) as part of the [Udacity Blockchain Developer Nanodegree Program](https://www.udacity.com/course/blockchain-developer-nanodegree--nd1309).