NodeJS (v10.x++) https://nodejs.org/en/
npm (v7.x++) https://www.npmjs.com/get-npm
Solidity compiler (v0.8.x++) https://docs.soliditylang.org/en/v0.8.4/installing-solidity.html
Truffle Development Environment https://www.trufflesuite.com/truffle https://github.com/trufflesuite/truffle
Ganache for Ethereum https://www.trufflesuite.com/ganache https://github.com/trufflesuite/ganache
Το έργο μας, σε όλες τις εκδόσεις του και ακόμα κι όσο αναπτύσσεται, διατηρείται στο εξής εναποθετήριο (repository): https://github.com/d-sfounis/bluechain_SSI Είναι λογισμικό Ανοικτού Κώδικα (Open Source), συμμορφώνεται στα πρότυπα της Ανοικτά Διαθέσιμης Επιστήμης (Open Science) κατά ΕΕ, και παραμένει και διαθέσιμο προς κάθε Πολίτη.
Η τελευταία έκδοση του συστήματος Bluechain SSI είναι η v0.3.0 (Μάιος 2021).
Για το local git cloning του λογισμικού, χρησιμοποιείστε είτε το ίδιο το GUI της πλατφόρμας του GitHub, είτε μέσω HTTPS, είτε μέσω SSH:
Και στις δύο περιπτώσεις, θα χαρούμε να λάβουμε σχόλια, ερωτήσεις ή προτάσεις αλλαγής επί του κώδικα. Είστε ευπρόσδεκτοι να υποβάλλετε pull requests από τα τοπικά σας repositories, στο main branch του Bluechain SSI :-)
Το Bluechain SSI χρειάζεται να συνδεθεί σε ένα "ζωντανό" Ethereum blockchain network, αφού πάνω σε αυτό λειτουργεί.
Η πιο εύκολη λύση για αυτό είναι ένα local Ethereum network μέσω Ganache (το εγκαταστήσαμε στο προηγούμενο βήμα - ). Το Ganache μπορεί να ρυθμιστεί ώστε να κοιτάει σε local ETH network (φτιαγμένο ως ειδικό instance αποκλειστικά και μόνο στο μηχάνημά σας), ή σε live ETH networks (Ethereum Mainnet, Testnets Ropsten, Koeva, Rinkeby, Goerli) ή ακόμα και το Binance Smart Network (αφού αυτό είναι 1:1 clone του Ethereum).
Συστήνουμε: Local Ethereum instance ή Ropsten testnet. Το σύστημα Bluechain Identity ΔΕΝ έχει βελτιστοποιηθεί ως προς την οικονομική του λειτουργία ώστε να μπορούμε να προτείνουμε την χρήση σε mainnet.
Έχοντας λοιπόν το .AppImage του Ganache κατεβασμένο:
Έπειτα εκκινήστε το Ganache απλά με:
Το ξεκίνημα του Ganache πριν από οποιαδήποτε χρήση του Bluechain SSI είναι απαραίτητο, εκτός αν διαδράτε με το σύστημα τελείως εξωτερικά, μέσω του ίδιου του Ethereum blockchain και των RPC APIs του.
Μπορείτε επίσης να ρυθμίσετε το truffle να κοιτάει απευθείας πάνω στο blockchain, μέσω του truffle-config.js
που περιλαμβάνεται στο πακέτο του κώδικα!
Δημιουργήστε ένα νέο blockchain workspace τύπου Ethereum μέσω του δεξιού βέλους (το Bluechain SSI δεν είναι ακόμη συμβατό με R3 Corda, κατά την τωρινή του υλοποίηση (v0.2):
To Truffle αποτελεί το development environment του Bluechain SSI. Παρέχει συγκεντρωτικά: compiler, debugger, logging console και εύκολα/γρήγορα configs, όλα μαζί. Επίσης παρέχει ένα βασικό virtual blockchain πάνω στο οποίο μπορούμε να τρέξουμε tests και migrations (deployments, αλλά το truffle επιλέγει να τα ονομάζει έτσι). ΔΕΝ χρησιμοποιούμε το virtual development blockchain που εμπεριέχει το truffle, αφού έχουμε το Ganache το οποίο προσφέρει ένα καλύτερο και ρεαλιστικότερο περιβάλλον μετρήσεων και performance testing.
Αρχικά, πρέπει να σιγουρέψουμε ότι το Truffle κοιτάει προς το Ganache local blockchain μας. Σε ενεργό Ganache, για να δούμε από που "ακούει" ο server: ⚙️ Config → SERVER tab, και βλέπουμε το configuration.
Έπειτα, στο home directory του κατεβασμένου (cloned) Bluechain SSI, σετάρουμε το truffle-config.js
:
Όλο αυτό αποτελεί ένα πολύ bare bones setup, αλλά μας είναι αρκετό προς το παρόν.
Στη συνέχεια, πάλι στο home directory του project και με ανοικτό το Ganache, τρέχουμε:
Όλα έτοιμα! Αν όλα πήγαν καλά, το Truffle έκανε deploy το Smart Contract σύστημα του Bluechain SSI, και είναι έτοιμο προς χρήση: Να δεχθεί requests, να δεχθεί διαβατήρια και έγγραφα χρηστών, να επαληθεύσει την εγκυρότητα υπαρχόντων εγγράφων και Ισχυρισμών (Claims).
Δώστε ιδιαίτερη σημασία στο logging του Truffle, ιδιαίτερα στο δικό μας custom πεδίο: PassportManager contract deployed at address: ...
— είναι η διεύθυνση στην οποία κατοικεί το Smart Contract μας, και μέσω της οποίας θα διαδρούμε με το σύστημα του Bluechain SSI.
Παρατηρήστε επίσης ότι ένα μικροποσό Ethereum αφαιρέθηκε από ένα από τα πορτοφόλια-διευθύνσεις σας (wallet addresses) στο Ganache. Αυτό αποτυπώνει το deployment cost του συστήματος, και παραμένει ακριβώς το ίδιο και στα live Ethereum chains.
Η σουίτα λογισμικού του Bluechain SSI συνοδεύεται από μια πλειάδα unit tests για να επιτυγχάνεται η διαρκής ορθότητα του κώδικα. Σκοπός των unit tests είναι οι βασικές λειτουργίες του συστήματος να συνεχίζουν να λειτουργούν ορθά και με τον ίδιο τρόπο, καθ'όσο αυτό αναπτύσσεται και επεκτείνεται πέραν της έκδοσης 0.3.0 (όπου βρισκόμαστε τώρα).
Συμπεριλαμβάνουμε 4 unit tests (μορφής it()
) σε μορφή Javascript Promise.
Καθένα από αυτά, έχει φτιαχτεί για να ελέγχει ενδελεχώς μία εκ των 4 βασικών λειτουργιών του Bluechain (βλέπε επόμενη ενότητα - 📕 Αναλυτική λίστα μεθόδων & μεταβλητών (Reference))
Στις τελευταίες εκδόσεις της Truffle, πλέον προτείνεται η δομή async/await έναντι των Promises. Είναι στα σύντομα μελλοντικά μας πλάνα να μεταπηδήσουμε τα unit tests σε αυτή τη μορφή, μιας και προσφέρουν περισσότερο έλεγχο επί της αλληλουχίας και της σειριακότητας των συναλλαγών στο σύστημα.
Τρέξτε όλα τα παρόντα tests πολύ απλά, με την εντολή:
Για ευκολία, προσφέρουμε άλλη μια εντολή για testing με maximum logging verbosity. Χρησιμοποιήστε την σε καταστάσεις που απαιτείται ενδελεχής έλεγχος του συστήματος:
$ truffle test_everything
Και αναμένουμε ως output τα αποτελέσματα των validity & performance tests:
Η αποδοτικότητα σε χρόνο των συναλλαγών του Bluechain SSI κυμαίνεται γύρω στα ~250milliseconds και εμφανίζει ολικά ακρότατα των 425ms (κατά τις πιο "βαριές" λειτουργίες δημιουργίας νέας Ταυτότητας Χρήστη ή εισαγωγής νέων εγγράφων πιστοποίησης).