matiru

Blockchain-Based Supply Chain Transparency for Agricultural Produce
git clone https://github.com/maydayv7/matiru

MODEL.md (3703B)

Rendered

Roles

  1. Farmer
  2. Distributor
  3. Retailer
  4. Consumer
  5. Inspector

Chaincode Functions

Produce Lifecycle

  1. registerProduce(farmerId, details) -> Only Farmer

  2. Creates a new 'Produce' asset

  3. Adds it to 'actionHistory' and farmer's 'registeredProduce'

  4. Creates a "REGISTER" 'actionItem'

  5. updateLocation(produceId, actorId, inTransit/newLocation) -> Only Farmer/Distributor/Retailer

  6. Changes 'currentLocation' or 'status' to "In Transit"

  7. Adds "MOVE" 'actionItem'

  8. markAsUnavailable(produceId, actorId, reason, newStatus) -> Only Farmer/Distributor/Retailer/Inspector

  9. Mark 'isAvailable' as false and set 'notAvailableReason' to reason

  10. Adds "REMOVED" actionItem

  11. inspectProduce(produceId, inspectorId, qualityUpdate) -> Only Inspector

  12. Updates 'quality'/'expiryDate'

  13. Adds an "INSPECT" 'actionItem'

  14. Calls markAsUnavailable if asset fails inspection

  15. updateDetails(produceId, actorId, details) -> Only 'currentOwner'

  16. Updates 'pricePerUnit', 'storageConditions'

  17. Adds "UPDATED" actionItem

  18. splitProduce(produceId, qty, OwnerId) -> Only 'currentOwner'

  19. Creates new assets and sets 'parentID'

  20. Updates parent 'qty' and sets 'children'

  21. Adds a "SPLIT" 'actionItem'

  22. transferOwnership(produceId, newOwnerId, qty, salePrice) -> Only 'currentOwner'

  23. Verifies if asset is available

  24. Full or partial transfer -> Calls splitBatch if partial
  25. Updates 'saleHistory' and 'actionHistory', and fields in roles

  26. Adds a "SALE" 'actionItem'

  27. recordPayment(produceId, transactionId, paymentStatus)

  28. Update 'paymentStatus', 'paymentMethod', 'paymentRef'

  29. Links off-chain payment confirmation (UPI/BankRef)

Querying

  1. getProduceById(produceId)

  2. Returns current state

  3. getProduceByOwner(ownerId)

  4. Lists all assets owned by a role

Governance

  1. registerUser(role, details) -> Accept user by vote

  2. Registers Farmer/Distributor/Retailer/Inspector/Consumer

  3. getUserDetails(userId)

  4. Returns profile

  5. updateUser(userId, role, details)

  6. Updates user details

Schema

Produce

id:
parentId: null if original batch, otherwise reference to parent batch
children: null or [childIds]

qty:
qtyUnit: KG/Number

pricePerUnit: Asking Price
totalPrice: pricePerUnit * qty

currentOwner:
currentLocation:
actionHistory: ['actionItem']
saleHistory: ['transaction']

cropType:
harvestDate:
quality:
expiryDate:
storageConditions: [Cold Storage, High Temperature, Ambient etc.]

status: "Harvested"/"In Transit"/"Retail"/"Missing"/"Failed Inspection"/"Removed"
isAvailable: true/false -> false if asset is not available due to 'notAvailableReason'
notAvailableReason: If asset is expired/missing/fails inspection/sold to consumer

actionItem

Order by 'timestamp'

timestamp:
action: "REGISTER"/"UPDATED"/"MOVE"/"SPLIT"/"SALE"/"INSPECT"/"REMOVED"
currentLocation:
currentOwner:

transaction

Order by 'timestamp'

timestamp:
prevOwner:
newOwner:
salePrice: Total amount paid

qtyBought:
newId: If a new asset was created

paymentStatus:
paymentMethod:
paymentRef:

Farmer

role: "Farmer"
id:
name:
location:
walletId: For Payments
registeredProduce: [produceIds]
certification: ["Organic", "Fair Trade" etc]

Distributor

role: "Distributor"
id:
name:
location:
walletId:
ownedProduce: [produceIds]

Retailer

role: "Retailer"
id:
name:
shopLocation:
walletId:
inventory: [produceIds]

Inspector

role: "Inspector"
id:
name:
authority: "Govt"/"Private"/"NGO"

Consumer

role: "Consumer"
id:

We don't include any details of a particular consumer to protect their privacy, but at the same time they will be able to access all the information about the asset


Code

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# Roles

1. Farmer
2. Distributor
3. Retailer
4. Consumer
5. Inspector

# Chaincode Functions

### Produce Lifecycle

1. registerProduce(farmerId, details) -> Only Farmer

- Creates a new 'Produce' asset
- Adds it to 'actionHistory' and farmer's 'registeredProduce'
- Creates a "REGISTER" 'actionItem'

2. updateLocation(produceId, actorId, inTransit/newLocation) -> Only Farmer/Distributor/Retailer

- Changes 'currentLocation' or 'status' to "In Transit"
- Adds "MOVE" 'actionItem'

3. markAsUnavailable(produceId, actorId, reason, newStatus) -> Only Farmer/Distributor/Retailer/Inspector

- Mark 'isAvailable' as false and set 'notAvailableReason' to reason
- Adds "REMOVED" actionItem

4. inspectProduce(produceId, inspectorId, qualityUpdate) -> Only Inspector

- Updates 'quality'/'expiryDate'
- Adds an "INSPECT" 'actionItem'
- Calls `markAsUnavailable` if asset fails inspection

5. updateDetails(produceId, actorId, details) -> Only 'currentOwner'

- Updates 'pricePerUnit', 'storageConditions'
- Adds "UPDATED" actionItem

6. splitProduce(produceId, qty, OwnerId) -> Only 'currentOwner'

- Creates new assets and sets 'parentID'
- Updates parent 'qty' and sets 'children'
- Adds a "SPLIT" 'actionItem'

7. transferOwnership(produceId, newOwnerId, qty, salePrice) -> Only 'currentOwner'

- Verifies if asset is available
- Full or partial transfer -> Calls `splitBatch` if partial
- Updates 'saleHistory' and 'actionHistory', and fields in roles
- Adds a "SALE" 'actionItem'

8. recordPayment(produceId, transactionId, paymentStatus)

- Update 'paymentStatus', 'paymentMethod', 'paymentRef'
- Links off-chain payment confirmation (UPI/BankRef)

## Querying

1. getProduceById(produceId)

- Returns current state

2. getProduceByOwner(ownerId)

- Lists all assets owned by a role

## Governance

1. registerUser(role, details) -> Accept user by vote

- Registers Farmer/Distributor/Retailer/Inspector/Consumer

2. getUserDetails(userId)

- Returns profile

3. updateUser(userId, role, details)

- Updates user details

# Schema

## Produce

```
id:
parentId: null if original batch, otherwise reference to parent batch
children: null or [childIds]

qty:
qtyUnit: KG/Number

pricePerUnit: Asking Price
totalPrice: pricePerUnit * qty

currentOwner:
currentLocation:
actionHistory: ['actionItem']
saleHistory: ['transaction']

cropType:
harvestDate:
quality:
expiryDate:
storageConditions: [Cold Storage, High Temperature, Ambient etc.]

status: "Harvested"/"In Transit"/"Retail"/"Missing"/"Failed Inspection"/"Removed"
isAvailable: true/false -> false if asset is not available due to 'notAvailableReason'
notAvailableReason: If asset is expired/missing/fails inspection/sold to consumer
```

### actionItem

Order by 'timestamp'

```
timestamp:
action: "REGISTER"/"UPDATED"/"MOVE"/"SPLIT"/"SALE"/"INSPECT"/"REMOVED"
currentLocation:
currentOwner:
```

### transaction

Order by 'timestamp'

```
timestamp:
prevOwner:
newOwner:
salePrice: Total amount paid

qtyBought:
newId: If a new asset was created

paymentStatus:
paymentMethod:
paymentRef:
```

## Farmer

```
role: "Farmer"
id:
name:
location:
walletId: For Payments
registeredProduce: [produceIds]
certification: ["Organic", "Fair Trade" etc]
```

## Distributor

```
role: "Distributor"
id:
name:
location:
walletId:
ownedProduce: [produceIds]
```

## Retailer

```
role: "Retailer"
id:
name:
shopLocation:
walletId:
inventory: [produceIds]
```

## Inspector

```
role: "Inspector"
id:
name:
authority: "Govt"/"Private"/"NGO"
```

## Consumer

```
role: "Consumer"
id:
```

We don't include any details of a particular consumer to protect their privacy, but at the same time they will be able to access all the information about the asset