1 of 3

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

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

NodeJS (v10.x++) https://nodejs.org/en/
npm (v7.x++)
Solidity compiler (v0.8.x++)
Truffle Development Environment
Ganache for Ethereum

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

Το έργο μας, σε όλες τις εκδόσεις του και ακόμα κι όσο αναπτύσσεται, διατηρείται στο εξής εναποθετήριο (repository): Είναι λογισμικό Ανοικτού Κώδικα (Open Source), συμμορφώνεται στα πρότυπα της Ανοικτά Διαθέσιμης Επιστήμης (Open Science) κατά ΕΕ, και παραμένει και διαθέσιμο προς κάθε Πολίτη.

Η τελευταία έκδοση του συστήματος Bluechain SSI είναι η v0.3.0 (Μάιος 2021).

Για το local git cloning του λογισμικού, χρησιμοποιείστε είτε το ίδιο το GUI της πλατφόρμας του GitHub, είτε μέσω HTTPS, είτε μέσω SSH:

B1. Mέσω HTTPS:

B2. Mέσω SSH:

Και στις δύο περιπτώσεις, θα χαρούμε να λάβουμε σχόλια, ερωτήσεις ή προτάσεις αλλαγής επί του κώδικα. Είστε ευπρόσδεκτοι να υποβάλλετε pull requests από τα τοπικά σας repositories, στο main branch του Bluechain SSI :-)

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

Βήμα 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 κατεβασμένο:

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

Το ξεκίνημα του Ganache πριν από οποιαδήποτε χρήση του Bluechain SSI είναι απαραίτητο, εκτός αν διαδράτε με το σύστημα τελείως εξωτερικά, μέσω του ίδιου του Ethereum blockchain και των RPC APIs του. Μπορείτε επίσης να ρυθμίσετε το truffle να κοιτάει απευθείας πάνω στο blockchain, μέσω του truffle-config.js που περιλαμβάνεται στο πακέτο του κώδικα!

Δημιουργήστε ένα νέο 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:

Όλο αυτό αποτελεί ένα πολύ 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.

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

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

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

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

Στις τελευταίες εκδόσεις της Truffle, πλέον προτείνεται η δομή async/await έναντι των Promises. Είναι στα σύντομα μελλοντικά μας πλάνα να μεταπηδήσουμε τα unit tests σε αυτή τη μορφή, μιας και προσφέρουν περισσότερο έλεγχο επί της αλληλουχίας και της σειριακότητας των συναλλαγών στο σύστημα.

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

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

Για ευκολία, προσφέρουμε άλλη μια εντολή για testing με maximum logging verbosity. Χρησιμοποιήστε την σε καταστάσεις που απαιτείται ενδελεχής έλεγχος του συστήματος: $ truffle test_everything

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

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

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

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

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

Έχοντας λοιπόν το .AppImage του Ganache κατεβασμένο:

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

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

Έπειτα, στο home directory του κατεβασμένου (cloned) Bluechain SSI, σετάρουμε το truffle-config.js:

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

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

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

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

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

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

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

tests/test_initPassport.js

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);
  });
  */
  
});

tests/test_initPassport.js

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);
  });
  */
  
});

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

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

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

hashtagB1. Mέσω HTTPS:

hashtagB2. Mέσω SSH:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

hashtagB1. Mέσω HTTPS:

hashtagB2. Mέσω SSH:

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

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

B1. Mέσω HTTPS:

B2. Mέσω SSH:

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

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

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

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

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

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

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

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

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

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

B1. Mέσω HTTPS:

B2. Mέσω SSH: