INATrace

Open-source blockchain-based track and trace system for an agricultural commodities (such as coffee) supply chain run. It provides transparency and creation of trust through digitalization of supply chains, connects every actor along the supply chain, assures quality and fair pricing.

Project is composed from 3 parts:

INATrace 2

This new major release includes new functionalities, refactorings, optimizations and bugfixes. The most important additions and changes are:

Added support for generic value chains. Different value chains with it's specific settings can now be configured in the system.
Multi-tenant system support.
Reorganized the content in the Product section. This section now includes only the content that is related to a product.
Introduced a new section "Company". This section includes all the content that is related with the company's work process within the value chain.
The configuration of farmers and collectors is decoupled from the product, and it's part of the Company section.
Added support for importing farmers from a provided Excel file.
The company customers are now decoupled from the Stakeholders in the product section and are configured as part of the Company section.
The configuration of facilities and processing actions is now part of the company's profile.
The semi-products configuration is now part of the system settings instead of the product section.
Reorganized the content of the Value chain tab inside the Stakeholders section. The Value chain now includes new company roles. Added is also a section for product admin companies.
Added support for defining Processing evidence fields in the system settings.
Translation for facilities, processing actions, semi-products and processing evidence types and fields can be provided in the system as part of it's definition.
Added support for currencies in the system. The enabled currencies can be selected in the system settings. These currencies then appear as select options in various parts of the system where the user is expected to select a currency.
Added exchange rates for the enabled currencies that are synced on a daily basis. The currencies data is provided by the https://exchangeratesapi.io/ API.
The product section now includes Final products. Final products represent the output of a final processing. The final products can be configured by the product admin company.
When placing customer order, now we select a final product instead of a sellable semi-product.
Added support for new types of processing actions.
Added support for bulk purchases for semi-products.
Various changes and addition of new functionalities for purchases, processing and payments.

Coffee network

Based on GIT repositories

Documentation

APIs

Most common API used:

Insert or update facility POST /chain-api/data/facility

request {
  "docType": "string",
  "_id": "string",
  "_rev": "string",
  "created": "string",
  "lastChange": "string",
  "userCreatedId": "string",
  "userChangedId": "string",
  "name": "string",
  "organizationId": "string",
  "facilityType": ChainFacilityType,
  "isCollectionFacility": true,
  "isPublic": true,
  "location": ChainLocation,
  "semiProducts": [
    ChainSemiProduct
  ],
  "semiProductIds": [
    "string"
  ],
  "semiProductPrices": [
    ChainSemiProductPrice
  ]
}

Insert or update payment POST /chain-api/data/payment

request {
  "docType": "string",
  "_id": "string",
  "_rev": "string",
  "created": "string",
  "lastChange": "string",
  "userCreatedId": "string",
  "userChangedId": "string",
  "formalCreationTime": "string",
  "currency": "string",
  "amount": 0,
  "amountPaidToTheCollector": 0,
  "stockOrderId": "string",
  "orderId": "string",
  "transactionIds": [
    "string"
  ],
  "payingOrganizationId": "string",
  "recipientOrganizationId": "string",
  "recipientUserCustomerId": "string",
  "representativeOfRecipientOrganizationId": "string",
  "representativeOfRecipientUserCustomerId": "string",
  "recipientCompanyCustomerId": "string",
  "receiptNumber": "string",
  "receiptDocument": ChainFileInfo,
  "bankTransferId": "string",
  "paymentConfirmedByUser": "string",
  "paymentConfirmedByOrganization": "string",
  "paymentConfirmedAtTime": "string",
  "payingOrganization": ChainOrganization,
  "recipientOrganization": ChainOrganization,
  "recipientUserCustomer": ChainUserCustomer,
  "recipientCompanyCustomer": ChainUserCustomer,
  "bankTransfer": ChainBulkPayment,
  "representativeOfRecipientOrganization": ChainOrganization,
  "representativeOfRecipientUserCustomer": ChainUserCustomer,
  "queryFacilityName": "string",
  "queryPurchaseOrderName": "string",
  "queryProducerUserCustomerName": "string",
  "preferredWayOfPayment": "string",
  "productionDate": "string"
}

Insert or update transaction POST /chain-api/data/transaction

request {
  "docType": "string",
  "_id": "string",
  "_rev": "string",
  "created": "string",
  "lastChange": "string",
  "userCreatedId": "string",
  "userChangedId": "string",
  "organizationId": "string",
  "initiatorUserId": "string",
  "sourceStockOrderId": "string",
  "targetStockOrderId": "string",
  "semiProductId": "string",
  "sourceFacilityId": "string",
  "targetFacilityId": "string",
  "isProcessing": true,
  "actionType": ChainActionType,
  "shippmentId": "string",
  "inputMeasureUnitType": ChainMeasureUnitType,
  "inputQuantity": 0,
  "outputMeasureUnitType": ChainMeasureUnitType,
  "outputQuantity": 0,
  "pricePerUnit": 0,
  "currency": "string",
  "gradeAbbreviationId": "string",
  "rejectComment": "string",
  "gradeAbbreviation": ChainGradeAbbreviation,
  "sourceFacility": ChainFacility,
  "targetFacility": ChainFacility,
  "semiProduct": ChainSemiProduct,
  "sourceStockOrder": ChainStockOrder
}

Insert or update semi-product POST /chain-api/data/semi-product

request {
  "docType": "string",
  "_id": "string",
  "_rev": "string",
  "created": "string",
  "lastChange": "string",
  "userCreatedId": "string",
  "userChangedId": "string",
  "productId": "string",
  "name": "string",
  "description": "string",
  "measurementUnitType": ChainMeasureUnitType,
  "isSKU": true,
  "isBuyable": true,
  "isSKUEndCustomer": true
}

Insert or update stock order POST /chain-api/data/stock-order

request {
  "docType": "string",
  "_id": "string",
  "_rev": "string",
  "created": "string",
  "lastChange": "string",
  "userCreatedId": "string",
  "userChangedId": "string",
  "formalCreationTime": "string",
  "identifier": "string",
  "creatorId": "string",
  "representativeOfProducerUserCustomerId": "string",
  "producerUserCustomerId": "string",
  "productionLocation": ChainLocation,
  "certificates": [
    ChainCertification
  ],
  "consumerCompanyCustomerId": "string",
  "semiProductId": "string",
  "facilityId": "string",
  "organizationId": "string",
  "totalQuantity": 0,
  "fullfilledQuantity": 0,
  "availableQuantity": 0,
  "productionDate": "string",
  "expiryDate": "string",
  "estimatedDeliveryDate": "string",
  "deliveryTime": "string",
  "orderId": "string",
  "globalOrderId": "string",
  "documentRequirements": ChainDocumentRequirementList,
  "pricePerUnit": 0,
  "salesPricePerUnit": 0,
  "currency": "string",
  "salesCurrency": "string",
  "isPurchaseOrder": true,
  "gradeAbbreviationId": "string",
  "internalLotNumber": "string",
  "lotNumber": "string",
  "screenSize": "string",
  "comments": "string",
  "actionType": ChainActionType,
  "womenShare": 0,
  "cost": 0,
  "paid": 0,
  "balance": 0,
  "semiProduct": ChainSemiProduct,
  "facility": ChainFacility,
  "representativeOfProducerUserCustomer": ChainUserCustomer,
  "producerUserCustomer": ChainUserCustomer,
  "inputTransactions": [
    ChainTransaction
  ],
  "outputTransactions": [
    ChainTransaction
  ],
  "lotLabel": "string",
  "startOfDrying": "string",
  "clientId": 0,
  "flavourProfile": "string",
  "processingActionId": "string",
  "processingAction": ChainProcessingAction,
  "gradeAbbreviation": ChainGradeAbbreviation,
  "processingOrderId": "string",
  "processingOrder": ChainProcessingOrder,
  "consumerCompanyCustomer": ChainCompanyCustomer,
  "client": ChainOrganization,
  "sacNumber": 0,
  "triggerOrderIds": [
    "string"
  ],
  "quoteFacilityId": "string",
  "quoteOrganizationId": "string",
  "inputOrders": [
    ChainStockOrder
  ],
  "pricePerUnitForOwner": 0,
  "pricePerUnitForBuyer": 0,
  "exchangeRateAtBuyer": 0,
  "pricePerUnitForEndCustomer": 0,
  "exchangeRateAtEndCustomer": 0,
  "cuppingResult": "string",
  "cuppingGrade": "string",
  "cuppingFlavour": "string",
  "roastingDate": "string",
  "roastingProfile": "string",
  "shipperDetails": "string",
  "carrierDetails": "string",
  "portOfLoading": "string",
  "portOfDischarge": "string",
  "locationOfEndDelivery": "string",
  "dateOfEndDelivery": "string",
  "requiredWomensCoffee": true,
  "requiredQuality": ChainGradeAbbreviation,
  "requiredQualityId": "string",
  "shippedAtDateFromOriginPort": "string",
  "arrivedAtDateToDestinationPort": "string",
  "productOrder": ChainProductOrder,
  "triggerOrders": [
    ChainStockOrder
  ],
  "triggeredOrders": [
    ChainStockOrder
  ],
  "quoteFacility": ChainFacility,
  "quoteOrganization": ChainOrganization,
  "organization": ChainOrganization
}

Response is structured in following way: It always contains attribute status. If response is successful, then status is equal to 'OK' and appropriate response can be found under data attribute. If response is unsuccessful (see above link for other statuses), then errorMessage attribute is returned.

Example of successful and unsuccessful response

{
"status": "OK",
  "data": {
    "id": 4,
    "email": "example@example.com",
    "name": "Example",
    "surname": "Example",
    "status": "ACTIVE",
    "role": "ADMIN",
    "actions": [
      "VIEW_USER_PROFILE",
      "UPDATE_USER_PROFILE"
    ],
    "companyIds": [
	1
    ]
  }
}

{
  "status": "AUTH_ERROR",
  "errorMessage": "Invalid credentials"
}

Other APIs can be found here

Database entities are listed here

Getting started

Use Getting started documentation above
Add bin folder from fabric-samples to PATH environment variable.

Configuration of a network

Organizations
- Coop
- Analytics
Ordering organizations
- 1 ordering node
1 channel
each organization:
- 1 peer
1x CouchDB per peer

Actions

Initializing the network

First time (only once):

Remove tmp_data (if exists)

cd artifacts/channel
./create-artifacts.sh

cd ..
docker-compose up -d
cd ..
./createChannel.sh

Stopping the network

cd artifacts
docker-compose down

Checking situation on a peer

Enter the peer container

Find name of the container using docker ps
docker exec -it <name> sh

List channels:

peer channel list
Check last lines (skip verbose log)

Exit the container:

exit

Persistance

For test deployment to be persistant folders from host have to mounted on peer, orderer and couchdb containers

Test development

See folder chaincode-docker-devmode.

Contribution

Project INATrace welcomes contribution from everyone. See CONTRIBUTING.md for help getting started.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

INATrace/coffee-network