Ledger

Git Source

Inherits: Supplier, Transporter, Manufacturer, Wholesaler, Distributor, FinalConsumer

Author: Tinotenda Joe

The contract's core is a 'Tokenized Shared Ledger' that logs every transaction and interaction in the supply chain. This ledger provides an immutable, transparent, and verifiable record of the entire process, from the supplier to the consumer.

The contract can connect with existing off-chain, legacy supply chain systems. It incorporates both on and off-chain security measures to protect sensitive data while maintaining its transparent and traceable nature .

This contract models multiple roles within the supply chain: Supplier, Transporter, Manufacturer, Wholesaler, Distributor, and Consumer. Each role is tied to a unique address and has role-specific functions.

The contract integrates the Industrial Internet of Things (IIOT) for real-time data monitoring and recording at various stages of the supply chain. .

State Variables

Owner

Owner of the contract

address public Owner;

userInfo

Mapping from address to userData

mapping(address => userData) public userInfo;

Functions

constructor

constructor();

onlyOwner

Ensures that only the owner can call the function

modifier onlyOwner();

checkUser

Validates handed-over users

modifier checkUser(address addr);

registerUser

Registers a user with a given name, location, role, and address. Can only be executed by the owner of the contract. Emits a UserRegister event after successful registration.

function registerUser(bytes32 name, string[] memory loc, uint256 role, address _userAddr) external onlyOwner;

Parameters

changeUserRole

Allows the owner to change the role of a user.

function changeUserRole(uint256 _role, address _addr) external onlyOwner returns (string memory);

Parameters

Returns

getUserInfo

Allows the owner to get the user information of the given address.

function getUserInfo(address _address) external view onlyOwner returns (userData memory);

Parameters

Returns

supplierCreatesRawPackage

Creates a package of raw material

Can only be executed by a supplier

function supplierCreatesRawPackage(
    bytes32 _description,
    uint256 _quantity,
    address _transporterAddr,
    address _manufacturerAddr
) external;

Parameters

supplierGetPackageCount

Returns the count of packages created by the supplier

Can only be executed by a supplier

function supplierGetPackageCount() external view returns (uint256);

Returns

supplierGetRawMaterialAddresses

Returns the addresses of all packages created by the supplier

Can only be executed by a supplier

function supplierGetRawMaterialAddresses() external view returns (address[] memory);

Returns

transporterHandlePackage

Handles the package by the transporter

Can only be executed by a transporter

function transporterHandlePackage(address _address, uint256 transporterType, address cid) external;

Parameters

manufacturerReceivedRawMaterials

Handles the receipt of raw materials by the manufacturer

Can only be executed by a manufacturer

function manufacturerReceivedRawMaterials(address _addr) external;

Parameters

manufacturerCreatesNewCommodity

Creates a new commodity by the manufacturer

Can only be executed by a manufacturer

function manufacturerCreatesNewCommodity(
    bytes32 _description,
    address[] memory _rawAddr,
    uint256 _quantity,
    address[] memory _transporterAddr,
    address _receiverAddr,
    uint256 RcvrType
) external returns (string memory);

Parameters

Returns

wholesalerReceivedCommodity

Handles the receipt of a commodity by the wholesaler

Can only be executed by a wholesaler or a distributor

function wholesalerReceivedCommodity(address _address) external;

Parameters

transferCommodityW_D

Transfers a commodity from a wholesaler to a distributor

Can only be executed by a wholesaler or the current owner of the package

function transferCommodityW_D(address _address, address transporter, address receiver) external;

Parameters

getBatchIdByIndexWD

Returns the batch id by index for a wholesaler

Can only be executed by a wholesaler

function getBatchIdByIndexWD(uint256 index) external view returns (address packageID);

Parameters

Returns

getSubContractWD

Returns the sub contract for a wholesaler

Can only be executed by a wholesaler

function getSubContractWD(address _address) external view returns (address SubContractWD);

Parameters

Returns

distributorReceivedCommodity

This function is called when a distributor receives a commodity

Only a distributor or the current owner of the package can call this function

function distributorReceivedCommodity(address _address, address cid) external;

Parameters

distributorTransferCommoditytoFinalConsumer

This function transfers a commodity from a distributor to a final consumer

Only a distributor or the current owner of the package can call this function

function distributorTransferCommoditytoFinalConsumer(address _address, address transporter, address receiver)
    external;

Parameters

getBatchesCountDC

This function returns the count of batches for a distributor

Only a distributor can call this function

function getBatchesCountDC() external view returns (uint256 count);

Returns

getBatchIdByIndexDC

This function returns the batch id by index for a distributor

Only a distributor can call this function

function getBatchIdByIndexDC(uint256 index) external view returns (address packageID);

Parameters

Returns

getSubContractDC

This function returns the sub contract for a distributor

function getSubContractDC(address _address) external view returns (address SubContractDP);

Parameters

Returns

consumerReceivedCommodity

This function is called when a consumer receives a commodity

Only a consumer can call this function

function consumerReceivedCommodity(address _address, address cid) external;

Parameters

updateStatus

This function updates the status of a commodity

Only the consumer or the current owner of the package can call this function

function updateStatus(address _address, uint256 Status) external;

Parameters

getBatchesCountC

This function returns the count of batches for a consumer

Only a wholesaler or the current owner of the package can call this function

function getBatchesCountC() external view returns (uint256 count);

Returns

getBatchIdByIndexC

This function returns the batch id by index for a consumer

Only a wholesaler or the current owner of the package can call this function

function getBatchIdByIndexC(uint256 index) external view returns (address _address);

Parameters

Returns

verify

This function verifies a signature

function verify(address p, bytes32 hash, uint8 v, bytes32 r, bytes32 s) external pure returns (bool);

Parameters

Returns

Events

UserRegister

Events to make the smart contract interaction transparent

event UserRegister(address indexed _address, bytes32 name);

buyEvent

event buyEvent(address buyer, address seller, address packageAddr, bytes32 signature, uint256 indexed now);

respondEvent

event respondEvent(address buyer, address seller, address packageAddr, bytes32 signature, uint256 indexed now);

sendEvent

event sendEvent(address seller, address buyer, address packageAddr, bytes32 signature, uint256 indexed now);

receivedEvent

event receivedEvent(address buyer, address seller, address packageAddr, bytes32 signature, uint256 indexed now);

Structs

userData

Struct to define a user

struct userData {
    bytes32 name;
    string[] userLoc;
    roles role;
    address userAddr;
}

Enums

roles

Enum which defines the different actors in the system

enum roles {
    noRole,
    supplier,
    transporter,
    manufacturer,
    wholesaler,
    distributor,
    consumer
}