1. Σφούνης Δημήτρης ( dsfounis@bluechain.tech)

https://bluechain.tech#our-team https://dsfounis.com

2. Σταμέλος Ιωάννης ( stamelos@csd.auth.gr)

https://www.csd.auth.gr/member/stamelos-ioannis/ https://stamelos.webpages.auth.gr/

Περιεχόμενα:

Υπενθυμίζουμε ότι οι τελευταίες εκδόσεις όλων των Έξυπνων Συμβολαίων του Bluechain SSI μπορούν πάντα να βρεθούν (και να σχολιαστούν!) στο δημόσιο GitHub directory μας: 🐈 Όλα τα τελευταία νέα του project: Bluechain Self Sovereign Identity διατηρούνται στη σελίδα μας: 🌊

1. Smart Contract: PassportManager

To PassportManager contract είναι το κύριο Έξυπνο Συμβόλαιο του συστήματος BluechainSSI. Ενσωματώνει όλες τις κύριες και βοηθητικές λειτουργίες που περιγράφησαν κατά το Reference της προηγούμενης ενότητας (). Συνάμα, περιέχει εκτενή σχολιασμό μέσα στον ίδιο τον κώδικα ώστε να ενισχύεται η ανοικτότητα και η κατανοητικότητά του προς τον προγραμματιστή-αναγνώστη.

2. Smart Contract: Migrations

To Migrations contract και γενικά η λογική των "migrations over redeployments" αποτελεί εσωτερική σχεδιαστική επιλογή του ίδιου του Truffle. Στην ουσία, είναι τρόπος του Truffle να "βοηθάει" το σύστημά μας με το να κρατά ιστορικό των εκδόσεων του Bluechain SSI που έχουν ενεργοποιηθεί πάνω στο blockchain, και να αποφεύγει να ξανα-ενεργοποιεί κάτι όμοιο που ήδη έχει ξαναενεργοποιηθεί στο παρελθόν (σώζοντάς μας, έτσι, deployment costs).

Βρίσκουμε ελάχιστη χρησιμότητα σε αυτήν την αρχιτεκτονική. Μάλιστα, η Ομάδα μας αντιπαραθέτει τα πλεονεκτήματα που προσφέρει η χρήση Migrations με τα μειονεκτήματα του structure & debugging clutter που δημιουργούνται στο σύστημα μας, εξ'αιτίας αυτής. Πολλές φορές κατά την υλοποίηση του συστήματος χρειάστηκε να δαπανήσουμε περισσότερο χρόνο πάνω από τα logs μας, για να καταλάβουμε τί είναι irrelevant Migrations functionality και τι πραγματικά αφορούσε το PassportManager contract μας.

Για πληρότητα, ωστόσο, παραθέτουμε το smart contract και εδώ. Το συμβόλαιο είναι άρρηκτα συνδεδεμένο με τα migrations .js files στο directory ./migrations, όπου κρατείται στην ουσία το ιστορικό των μεταβολών και των ενεργοποιήσων των έξυπνων συμβολαίων του συστήματός μας.

Λίστα δομών και μεθόδων:

1. struct Passport

2. mapping user_passports & mapping user_passports_LUT

3. event PassportInitialized, AddedIDFileToPassport, Voted

4. function hasInitializedPassport

5. function initPassport

6. function addIDFileToPassport

7. function voteForDocInPassport

8. function PassportExists

9. function DocExistsInPassport

1. struct Passport

Αποτελεί βασική δομή αποτύπωσης ενός Διαβατηρίου, γεμάτο με έγγραφα Ταυτοποίησης, και που ανήκει/διαχειρίζεται από έναν Χρήστη. Περιέχει τις εξής μεταβλητές:

• string flair_name: Ένα βοηθητικό ψευδώνυμο για το εκάστοτε Passport object. Δεν είναι απαραίτητο να συμπληρωθεί. Εν αρχή, λαμβάνει ψευδώνυμο ίδιο με το όνομα του Χρήστη.

• address controller: Ο διαχειριστής του Διαβατηρίου, που έχει δικαιώματα αλλαγών πάνω του. Αποτυπώνεται ως blockchain address (διεύθυνση του Χρήστη). Εν αρχή, θέτεται να δείχνει στον αρχικό δημιουργό του Διαβατηρίου. Αν και αυτό συνήθως παραμένει έτσι κατά τη λειτουργία του Bluechain SSI, δίνουμε την δυνατότητα να παρέλθει ο έλεγχος σε άλλο Χρήστη.

• mapping(bytes32 => uint) identity_files: Ένα hashmap array που περιέχει όλα τα σχετικά με το συγκεκριμένο Διαβατήριο Έγγραφα Ταυτοποίησης. Το (key, value) ζευγάρι σε κάθε θέση είναι μορφής bytes32 (32 byte string, επίτηδες έτσι ώστε να μπορεί να φιλοξενήσει SoliditySha3()output του Web3 library, keccak256 outputs, ή ακόμα και απλά sha3-256 checksums ενός εγγράφου) σε uint (unsigned integer, όπου αποθηκεύεται ως ένας απλός ακέραιος αριθμός το trust score ενός εγγράφου.

• mapping(bytes32 => bytes32) identity_files_LUT: Βοηθητικό hashmap array που δρα ως Lookup Table (LUT) stην προηγούμενη δομή identity_files. Τα hashmaps δεν επιτρέπουν αναζήτηση/iteration των keys τους, έτσι η λύση είναι να χρησιμοποιούμε δύο δομές δεδομένων, πλάι-πλάι: ένα hashmap και ένα hashmap LUT για την αναζήτηση των "γεμισμένων" ζευγαριών του πρώτου.

• Οι επιπρόσθετες δομές για γρήγορη Ο(1) αναζήτηση, καθώς και οι λίστες για delegates (εκπροσώπους) παραμένουν αδρανείς προς το παρόν στην έκδοση 0.3.0, για οικονομία πόρων κατά τη χρήση του συστήματος.

2. mapping user_passports & mapping user_passports_LUT

H κύρια βάση δεδομένων Διαβατηρίων & Ταυτοτήτων των Χρηστών στο σύστημά μας. Σε αυτή τη δομή δεδομένων έγγειται η "καρδία" του έξυπνου συμβολαίου (smart contract) του Bluechain SSI. Αποθηκεύει και αντιστοιχίζει διευθύνσεις/πορτοφόλια Χρηστών σε ενεργά Διαβατήρια, που περιέχουν έγγραφα Ταυτοποίησης και Ισχυρισμών (Claims).

Τύπος: mapping (hashmap) ζευγαριών μορφής <address → struct Passport>

3. event PassportInitialized, AddedIDFileToPassport, Voted

Τα events (συμβάντα) είναι διευκολύνσεις ώστε να αφήνουν ιστορικό (logs) των πράξεών τους τα smart contracts, προς το "γενικό", non-blockchain internet. Τα πυροδοτούμε και τα στέλνουμε σε κατάλληλα σημεία στον κώδικα του συστήματος του Bluechain SSI, συνήθως ακριβώς όταν έχει ολοκληρωθεί μια λειτουργία, ώστε να σημάνουμε την επιτυχή της εκτέλεση. Έτσι, τα events που χτίζουμε και εκπέμπουμε, ανά τον κώδικα, είναι τρία (3):

• event PassportInitialized, όταν αρχικοποιείται επιτυχώς ένα νέο Διαβατήριο, έπειτα από request νέου Χρήστη. Μαζί, εκπέμπουμε το αναγνωριστικό του νέου Διαβατηρίου και ποιος (ποια διεύθυνση) το ζήτησε.

• event AddedIDFileToPassport, όταν προστίθεται επιτυχώς ένα Έγγραφο Ταυτοποίησης σε υπάρχον Διαβατήριο κάποιου Χρήστη. Μαζί, εκπέμπουμε το αναγνωριστικό του Διαβατηρίου όπου μόλις προστέθηκε το Έγγραφο, και το ίδιο το fingerprint του Εγγράφου.

• event Voted, όταν ένας Χρήστης ψηφίζει για την αύξηση του σκορ εμπιστοσύνης (trust score) ενός Εγγράφου σε Διαβατήριο κάποιου άλλου Χρήστη. Μαζί, εκπέμπουμε το αναγνωριστικό του Διαβατηρίου στο οποίο μόλις επιδράσαμε, και ποιος (ποια διεύθυνση) έριξε την ψήφο εμπιστοσύνης.

Τύπος: event, που πυροδοτείται μέσα από τον κώδικα του έξυπνου συμβολαίου και μπορεί να ανιχνευθεί από οποιοδήποτε online πρόγραμμα που κοιτάει προς το blockchain του Bluechain SSI.

4. function hasInitializedPassport

Λειτουργία: Βοηθητική, ελέγχει αν ένας Χρήστης έχει όντως ένα ενεργό, αρχικοποιημένο Διαβατήριο.

Παράμετροι: address addr, η διεύθυνση/πορτοφόλι του Χρήστη τον οποίο ελέγχουμε.

Επιστρεπτέες τιμές: bool true ή false ανάλογα με το αν ο Χρήστης έχει ενεργό Διαβατήριο.

Τύπος: Συνάρτηση τύπου view, που σημαίνει ότι δεν απαιτεί αλλαγή του εσωτερικού αποθηκευτικού χώρου του smart contract, κι έτσι μπορεί να εκτελεστεί δωρεάν (zero gas fee).

5. function initPassport

Λειτουργία: Εκκινεί και αρχικοποιεί ένα ενεργό, κενό Διαβατήριο για έναν Χρήστη.

Παράμετροι: string memory nickname, ένα βοηθητικό ψευδώνυμο/identifier του Διαβατηρίου, για εύκολη αναζήτση και αναγνώριση από τους Χρήστες.

Επιστρεπτέες τιμές: Πλειάδα 2-διαστάσεων, tuple (string, address) όπου περιέχει το ψευδώνυμο του Διαβατηρίου που μόλις χρησιμοποιήθηκε, καθώς και την διεύθυνση/πορτοφόλι του Χρήστη που το δημιούργησε.

Τύπος: Κανονική συνάρτηση. Προκαλεί αλλαγές στον αποθηκευτικό χώρο του smart contract, κι έτσι η εκτέλεσή της φέρει κόστος (gas fee = gas_price * gas_limit).

6. function addIDFileToPassport

Λειτουργία: Προσθέτει ένα νέο Έγγραφο Ταυτοποίησης σε ένα ενεργό Διαβατήριο του Χρήστη.

Παράμετροι:

• address passport_id, η διεύθυνση/αναγνωριστικό του Διαβατηρίου στο οποίο θα προσθέσουμε το νέο Έγγραφο Ταυτοποίησης

• bytes32 id_file, το fingerprint του Εγγράφου. Η συνάρτηση δέχεται οποιοδήποτε document digest/fingerprint των 32 byte (256 bit) — η μέθοδος που χρησιμοποίησε η Ομάδα μας και προτείνουμε, για την παραγωγή ισχυρών document fingerprints προς εισαγωγή στο Bluechain SSI, είναι ο KECCAK algorithm σε spec SHA3-256 .

Επιστρεπτέες τιμές: Πλειάδα 3-διαστάσεων, tuple (address, bytes32, uint) όπου η 1η συνιστώσα (address) είναι η διεύθυνση του Χρήστη και Διαχειριστή του Διαβατηρίου που μόλις πρόσθεσε το Έγγραφο, η 2η (bytes32) είναι το fingerprint του Εγγράφου που μόλις προστέθηκε, και η 3η (uint) είναι το trust score του νεοεισηχθέντος Εγγράφου — θα πρέπει να είναι 1!

Τύπος: Κανονική συνάρτηση. Προκαλεί αλλαγές στον αποθηκευτικό χώρο του smart contract, κι έτσι η εκτέλεσή της φέρει κόστος (gas fee = gas_price * gas_limit).

7. function voteForDocInPassport

Λειτουργία: Εντοπίζει ένα συγκεκριμένο Έγγραφο Ταυτοποίησης στο δοθέν αναγνωριστικό Διαβατηρίου, και αυξάνει το σκορ εμπιστόσυνης (trust score) του Εγγράφου κατά +1. Εκτελείται απαραιτήτως από Χρήστη διαφορετικό του ιδιοκτήτη του Διαβατηρίου.

Παράμετροι:

• address passport_id, η διεύθυνση/αναγνωριστικό του Διαβατηρίου στο οποίο θα ψάξουμε για το Έγγραφο Ταυτοποίησης.

• bytes32 doc_id, το fingerprint του Εγγράφου που θα αναζητήσουμε στο προηγούμενο Διαβατήριο και του οποίου το trust score θα αυξήσουμε με +1, διά "ψήφου εμπιστοσύνης". Υπακούει στο ίδιο cryptography standard (KECCAK256) όπως και η function addIDFileToPassport.

Επιστρεπτέες τιμές: Πλειάδα 3-διαστάσεων, tuple (address, bytes32, uint) όπου η 1η συνιστώσα (address) είναι η διεύθυνση του Χρήστη που μόλις ψήφισε μέσω της συνάρτησης, η 2η (bytes32) είναι το fingerprint του Εγγράφου που μόλις ψηφίστηκε θετικά, και η 3η (uint) είναι το trust score του Εγγράφου πλέον — θα πρέπει να είναι άνω του 1!

Τύπος: Κανονική συνάρτηση. Προκαλεί αλλαγές στον αποθηκευτικό χώρο του smart contract, κι έτσι η εκτέλεσή της φέρει κόστος (gas fee = gas_price * gas_limit).

8. function PassportExists

Λειτουργία: Βοηθητική, ελέγχει αν ένα Διαβατήριο υπάρχει (είναι ενεργό, έχει αρχικοποιηθεί) ή όχι.

Παράμετροι: address passport_id, η διεύθυνση/αναγνωριστικό του Διαβατηρίου.

Επιστρεπτέες τιμές: bool true ή false ανάλογα με το αν το Διαβατήριο υπάρχει.

Τύπος: Συνάρτηση τύπου view, που σημαίνει ότι δεν απαιτεί αλλαγή του εσωτερικού αποθηκευτικού χώρου του smart contract, κι έτσι μπορεί να εκτελεστεί δωρεάν (zero gas fee).

9. function DocExistsInPassport

Λειτουργία: Βοηθητική, ελέγχει αν ένα Έγγραφο Ταυτοποίησης υπάρχει σε ένα ενεργό Διαβατήριο κάποιου Χρήστη.

Παράμετροι:

1. Passport storage p, η δομή Passport, έτοιμα δοσμένη, μέσα στην οποία θα αναζητήσουμε το Έγγραφο.

2. bytes32 doc_id, το fingerprint του Εγγράφου που θα αναζητήσουμε μέσα στο Διαβατήριο p. Ξανά, είναι της ίδιας μορφής (KECCAK, 256 bits) όπως και στην function addIDFileToPassport.

Επιστρεπτέες τιμές: bool true ή false ανάλογα με το αν το Έγγραφο υπάρχει μέσα στο δοθέν Διαβατήριο.

Τύπος: Συνάρτηση τύπου view, που σημαίνει ότι δεν απαιτεί αλλαγή του εσωτερικού αποθηκευτικού χώρου του smart contract, κι έτσι μπορεί να εκτελεστεί δωρεάν (zero gas fee).

Ατομικές δοκιμές (Unit tests)

Η σουίτα λογισμικού του Bluechain SSI συνοδεύεται από μια πλειάδα unit tests για να επιτυγχάνεται η διαρκής ορθότητα του κώδικα. Σκοπός των unit tests είναι οι βασικές λειτουργίες του συστήματος να συνεχίζουν να λειτουργούν ορθά και με τον ίδιο τρόπο, καθ'όσο αυτό αναπτύσσεται και επεκτείνεται πέραν της έκδοσης 0.3.0 (όπου βρισκόμαστε τώρα).

Συμπεριλαμβάνουμε 4 unit tests (μορφής it()) σε μορφή Javascript Promise. Καθένα από αυτά, έχει φτιαχτεί για να ελέγχει ενδελεχώς μία εκ των 4 βασικών λειτουργιών του Bluechain (βλέπε επόμενη ενότητα - 📕 Αναλυτική λίστα μεθόδων & μεταβλητών (Reference))

const PassportManager = artifacts.require("PassportManager");

contract("Bluechain SSI PassportManager test-suite Alpha", accounts => {
    it("should initialize a new passport linked with the current user's address", () => {
        let this_address = accounts[0];
        let this_nickname = "John Doe";
        let meta;
        
    return PassportManager.deployed()
        .then(instance => {
            meta = instance;
            console.log("Test1 on PassportManager address: " + meta.address);
            return meta.initPassport.call(this_nickname);
        })
        .then(returned_tuple => {
            //console.log(returned_tuple[0]);
            //console.log(returned_tuple[1]);
            assert.equal(returned_tuple[0], this_nickname, "Nickname, passed and returned by PassportManager.initPassport(), should match!");
            assert.equal(returned_tuple[1], this_address, "Controller address, passed and returned by PassportManager.initPassport(), should match!");
            //If we're here, it means the previous call() has succeeded. Now,
            //let's take things up a notch and let's actually send a transaction that changes the state of the blockchain.
            //Remember: We can't check for return values with a transaction, we have to debug the tx id manually.
            //#NOTE: We passed an extra parameter here. For more info on this special parameter object, check out:
            //https://www.trufflesuite.com/docs/truffle/getting-started/interacting-with-your-contracts#making-a-transaction
            const result = meta.initPassport.sendTransaction(this_nickname, {from: accounts[0]});
            result.on('transactionHash', (hash) => {
                console.log('TxHash', hash);
            });
            return result;
        })
        .then(result => {
            //#NOTE: This is a hacky solution at ensuring Ganache has had time to process the tx.
            console.log("Test 1 should've succeeded!");
        });
    });
    
    it("should successfully initialize a 2nd passport linked with accounts[1].", () => {
        let this_address = accounts[1];
        let this_nickname = "Theocharis Iordanidis";
        let meta;
    
    return PassportManager.deployed()
        .then(instance => {
            meta = instance;
            console.log("Test2 on PassportManager address: " + meta.address);
            return meta.initPassport.call(this_nickname, {from: accounts[1]});
        })
        .then(returned_tuple => {
            //console.log(returned_tuple[0]);
            //console.log(returned_tuple[1]);
            assert.equal(returned_tuple[0], this_nickname, "Nickname, passed and returned by PassportManager.initPassport(), should match!");
            assert.equal(returned_tuple[1], this_address, "Controller address, passed and returned by PassportManager.initPassport(), should match!");
            //If we're here, it means the previous call() has succeeded. Now,
            //let's take things up a notch and let's actually send a transaction that changes the state of the blockchain.
            //Remember: We can't check for return values with a transaction, we have to debug the tx id manually.
            //#NOTE: We passed an extra parameter here. For more info on this special parameter object, check out:
            //https://www.trufflesuite.com/docs/truffle/getting-started/interacting-with-your-contracts#making-a-transaction
            const result = meta.initPassport.sendTransaction(this_nickname, {from: accounts[1]});
            result.on('transactionHash', (hash) => {
                console.log('TxHash', hash);
            });
            return result;
        })
        .then(result => {
            //#NOTE: This is a hacky solution at ensuring Ganache has had time to process the tx.
            console.log("Test 2 should've succeeded!");
        });
    });
    
    it("should add an identity file sha256 hash to a controlled passport", () => {
        let this_address = accounts[0];
        let doc_hash = "0x21f3a9de43f07d855f49b946a10c30df432e8af95311435f77daf894216dcd41";
        let meta;
        
    return PassportManager.deployed()
        .then(instance => {
            meta = instance;
            console.log("Test3 on PassportManager address: " + meta.address);
            return meta.addIDFileToPassport.call(this_address, doc_hash);
        })
        .then(returned_tuple => {
            assert.equal(returned_tuple[0], this_address, "Passport controller, passed and returned by PassportManager.addIDFileToPassport(), should match!");
            assert.equal(returned_tuple[1], doc_hash, "Document hash (bytes32), passed and returned by PassportManager.addIDFileToPassport(), should match!");
            assert.equal(returned_tuple[2], 1, "Trust score of newly added doc_hash should be 1!");
            console.log(returned_tuple);
            //Now let's actually pass a concrete, actuallly persistent transaction instead of a call.
            const result = meta.addIDFileToPassport.sendTransaction(this_address, doc_hash, {from: accounts[0]});
            result.on('transactionHash', (hash) => {
                console.log('TxHash', hash);
            });
            return result;
        })
        .then(result => {
            //#NOTE: This is a hacky solution at ensuring Ganache has had time to process the tx.
            console.log("Test 3 should've succeeded!");
        });
    });
    
    it("should add +1 to the trust score of a doc in a passport", () => {
        let this_address = accounts[1];
        let passport_address = accounts[0];
        let doc_hash = "0x21f3a9de43f07d855f49b946a10c30df432e8af95311435f77daf894216dcd41";
        let meta;
        
    return PassportManager.deployed()
        .then(instance => {
            meta = instance;
            console.log("Test4 on PassportManager address: " + meta.address);
            return meta.voteForDocInPassport.call(passport_address, doc_hash, {from: this_address});
        })
        .then(returned_tuple => {
            assert.equal(returned_tuple[0], passport_address, "Passport ID address, passed and returned by PassportManager.voteForDocInPassport(), should match!");
            assert.equal(returned_tuple[1], doc_hash, "Document hash (bytes32), passed and returned by PassportManager.voteForDocInPassport(), should match!");
            assert.equal(returned_tuple[2], 2, "Trust score of doc_id should have been raised to 2!");
            console.log(returned_tuple);
            //Now let's actually pass a concrete, actuallly persistent transaction instead of a call.
            const result = meta.voteForDocInPassport.sendTransaction(passport_address, doc_hash, {from: this_address});
            result.on('transactionHash', (hash) => {
                console.log('TxHash', hash);
            });
            return result;
        })
        .then(result => {
            //#NOTE: This is a hacky solution at ensuring Ganache has had time to process the tx.
            console.log("Test 4 should've succeeded!");
        });
    });
      
  /*it("return false", () => {
    assert(0==1);
  });
  */
  
});

Εκτέλεση της σουίτας δοκιμών (test suite)

Τρέξτε όλα τα παρόντα tests πολύ απλά, με την εντολή:

$ truffle test

Και αναμένουμε ως output τα αποτελέσματα των validity & performance tests:

Using network 'development'.


Compiling your contracts...
===========================
> Everything is up to date, there is nothing to compile.

PassportManager contract deployed at address: 0xC6DAa380707E13829700EF40Ad7fE6f2A7297FcF


  Contract: PassportManager testsuite Alpha
Test1 on PassportManager address: 0xC6DAa380707E13829700EF40Ad7fE6f2A7297FcF
TxHash 0x550509d1fea429e23c56745d14f6790bcc5b2389dd3a55aaf85303d1ded33d05
Test 1 should've succeeded!
    ✓ should initialize a new passport linked with the current user's address (404ms)
Test2 on PassportManager address: 0xC6DAa380707E13829700EF40Ad7fE6f2A7297FcF
TxHash 0x14cfae455ddb0d6161374f43f84e72df5ba3e10e42068e0a0d150f66390df2b8
Test 2 should've succeeded!
    ✓ should successfully initialize a 2nd passport linked with accounts[1]. (223ms)
Test3 on PassportManager address: 0xC6DAa380707E13829700EF40Ad7fE6f2A7297FcF
Result {
  '0': '0x4c8C46E0269C7882A2427eF282a426eBb9716767',
  '1': '0x21f3a9de43f07d855f49b946a10c30df432e8af95311435f77daf894216dcd41',
  '2': BN {
    negative: 0,
    words: [ 1, <1 empty item> ],
    length: 1,
    red: null
  }
}
TxHash 0x013ae2f108056fee7d2bc5882ea63e7a6b5f923925060029b495aad0894f9d74
Test 3 should've succeeded!
    ✓ should add an identity file sha256 hash to a controlled passport (210ms)
Test4 on PassportManager address: 0xC6DAa380707E13829700EF40Ad7fE6f2A7297FcF
Result {
  '0': '0x4c8C46E0269C7882A2427eF282a426eBb9716767',
  '1': '0x21f3a9de43f07d855f49b946a10c30df432e8af95311435f77daf894216dcd41',
  '2': BN {
    negative: 0,
    words: [ 2, <1 empty item> ],
    length: 1,
    red: null
  }
}
TxHash 0x6b5031a08041859f969da7babbae59747d5bf997b00c1724920f3fdc0e3fb9e9
Test 4 should've succeeded!
    ✓ should add +1 to the trust score of a doc in a passport (158ms)


  4 passing (1s)

Η αποδοτικότητα σε χρόνο των συναλλαγών του Bluechain SSI κυμαίνεται γύρω στα ~250milliseconds και εμφανίζει ολικά ακρότατα των 425ms (κατά τις πιο "βαριές" λειτουργίες δημιουργίας νέας Ταυτότητας Χρήστη ή εισαγωγής νέων εγγράφων πιστοποίησης).

Α. Σύνολο εργαλείων που απαιτούνται (development stack)

1. NodeJS (v10.x++) https://nodejs.org/en/

2. npm (v7.x++) https://www.npmjs.com/get-npm

3. Solidity compiler (v0.8.x++) https://docs.soliditylang.org/en/v0.8.4/installing-solidity.html

4. Truffle Development Environment https://www.trufflesuite.com/truffle https://github.com/trufflesuite/truffle

5. Ganache for Ethereum https://www.trufflesuite.com/ganache https://github.com/trufflesuite/ganache

B. Τοπική εγκατάσταση (git cloning) του Bluechain Identity

Το έργο μας, σε όλες τις εκδόσεις του και ακόμα κι όσο αναπτύσσεται, διατηρείται στο εξής εναποθετήριο (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:

B1. Mέσω HTTPS:

git clone https://github.com/d-sfounis/bluechain_SSI.git

B2. Mέσω SSH:

git clone git@github.com:d-sfounis/bluechain_SSI.git

Εισαγωγή

Το έργο "Bluechain Self Sovereign Identity for e-Health - Σύστημα Αυτοκυβερνούμενης Ταυτοποίησης βασισμένο σε τεχνολογίες blockchain" είναι ερευνητικό project καινοτόμας τεχνογνωσίας, αναμεταξύ του Αριστοτελείου Πανεπιστημίου Θεσσαλονίκης (τμ. Πληροφορικής) και της Γνώμων Πληροφορικής ΑΕ, και συγχρηματοδοτείται από το πρόγραμμα "ΚΟΥΠΟΝΙΑ ΚΑΙΝΟΤΟΜΙΑΣ 2021" του ΚΕΠΑ ΑΝΕΜ (ΕΣΠΑ Κεντρικής Μακεδονίας).

Το παρόν τεχνικό εγχειρίδιο χρήσης αφορά τον κώδικα που αναπτύχθηκε κατά τα παραδοτέα 2 και 3 του έργου, και αποσκοπεί στην τεκμηρίωση και τη διευκόλυνση χρήσης του αναπτυγμένου λογισμικού από τους χρήστες του.

Υπενθυμίζουμε ότι όλα τα παραδοτέα 1, 2, 3 του έργου καθώς και οι συνοδευτικές μελέτες και τεχνικές εκθέσεις, διατίθενται ανοικτά και ελεύθερα ως Ελεύθερο Λογισμικό (Free Open Source Software) κάτω από άδεια χρήσης GNU GPL v3.0.

Περιεχόμενα

1. 🏗️ Εγκατάσταση & Χρήση του Bluechain SSI

   1. 🛠️ Λειτουργία του Bluechain SSI

   2. ⛑️ Ατομικές δοκιμές (unit tests) & επιδόσεις (performance)

2. 📕 Αναλυτική λίστα μεταβλητών και μεθόδων (Reference)

   1. 💻 Παράρτημα: ο κώδικας των Έξυπνων Συμβολαίων του Bluechain SSI

3. 👓 Ομάδα Ανάπτυξης έργου — Επικοινωνία

Βήμα 1: Έναρξη Ganache

Το Bluechain SSI χρειάζεται να συνδεθεί σε ένα "ζωντανό" Ethereum blockchain network, αφού πάνω σε αυτό λειτουργεί.

Η πιο εύκολη λύση για αυτό είναι ένα local Ethereum network μέσω Ganache (το εγκαταστήσαμε στο προηγούμενο βήμα - Εγκατάσταση και Xρήση του Bluechain SSI). Το 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 κατεβασμένο:

$ chmod +x ganache-2.5.4-linux-x86_64.AppImage

Έπειτα εκκινήστε το Ganache απλά με:

$ ./ganache-2.5.4-linux-x86_64.AppImage

Δημιουργήστε ένα νέο blockchain workspace τύπου Ethereum μέσω του δεξιού βέλους (το Bluechain SSI δεν είναι ακόμη συμβατό με R3 Corda, κατά την τωρινή του υλοποίηση (v0.2):

2. Έναρξη και χρήση Bluechain SSI μέσω Truffle

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:

module.exports = {
  
  /* 
  * Εφιστούμε την προσοχή μας εδώ!
  */
  networks: {
    development: {
      host: "127.0.0.1",     // Localhost (default: none)
      port: 7545,            // Standard Ethereum port (default: none)
      network_id: "5777",       // Any network (default: none)
    },
  },

  mocha: {
  },

  compilers: {
    solc: {
      version: "0.8.2",    // Fetch exact version from solc-bin (default: truffle's version)
    }
  }
}

Όλο αυτό αποτελεί ένα πολύ bare bones setup, αλλά μας είναι αρκετό προς το παρόν.

Στη συνέχεια, πάλι στο home directory του project και με ανοικτό το Ganache, τρέχουμε:

$ truffle compile --all
$ truffle migrate --reset

Όλα έτοιμα! Αν όλα πήγαν καλά, το Truffle έκανε deploy το Smart Contract σύστημα του Bluechain SSI, και είναι έτοιμο προς χρήση: Να δεχθεί requests, να δεχθεί διαβατήρια και έγγραφα χρηστών, να επαληθεύσει την εγκυρότητα υπαρχόντων εγγράφων και Ισχυρισμών (Claims).

$ truffle compile --all

Compiling your contracts...
===========================
> Compiling ./contracts/Migrations.sol
> Compiling ./contracts/PassportManager.sol
> Artifacts written to /home/dimitris/Documents/Code/Bluechain_SSI_Truffle/bluechain_ssi/build/contracts
> Compiled successfully using:
   - solc: 0.8.2+commit.661d1103.Emscripten.clang

$ truffle migrate --reset

Compiling your contracts...
===========================
> Everything is up to date, there is nothing to compile.



Starting migrations...
======================
> Network name:    'development'
> Network id:      5777
> Block gas limit: 6721975 (0x6691b7)


1_initial_migration.js
======================

   Replacing 'Migrations'
   ----------------------
   > transaction hash:    0x4c95c2ef66121f10b67aed6429f8124527f6cba7fa99a321c7f00a6f5da0f605
   > Blocks: 0            Seconds: 0
   > contract address:    0x4dEcd29fc37dd3124b30f7412e9a16B910cfd79f
   > block number:        995
   > block timestamp:     1620854844
   > account:             0x4c8C46E0269C7882A2427eF282a426eBb9716767
   > balance:             95.11712696
   > gas used:            246904 (0x3c478)
   > gas price:           20 gwei
   > value sent:          0 ETH
   > total cost:          0.00493808 ETH


   > Saving migration to chain.
   > Saving artifacts
   -------------------------------------
   > Total cost:          0.00493808 ETH


2_deploy_contracts.js
=====================

   Replacing 'PassportManager'
   ---------------------------
   > transaction hash:    0x48f73ad6d3ea9537dcdaaaeeaa6aec4d17b068056340bf75c5009ba5d4838a92
   > Blocks: 0            Seconds: 0
   > contract address:    0xCcd04bB0b4beb0A544311c6ce1cE324Ff6c049EE
   > block number:        997
   > block timestamp:     1620854845
   > account:             0x4c8C46E0269C7882A2427eF282a426eBb9716767
   > balance:             95.09212666
   > gas used:            1207502 (0x126cce)
   > gas price:           20 gwei
   > value sent:          0 ETH
   > total cost:          0.02415004 ETH

PassportManager contract deployed at address: 0xCcd04bB0b4beb0A544311c6ce1cE324Ff6c049EE

   > Saving migration to chain.
   > Saving artifacts
   -------------------------------------
   > Total cost:          0.02415004 ETH


Summary
=======
> Total deployments:   2
> Final cost:          0.02908812 ETH