Merge branch 'develop' into feature/3-3-software-requirements

assets/code/orbit-db-identity.js

@@ -0,0 +1,12 @@
+{
+   _id: '<the ID of the external identity>',
+   // Auto-generated by OrbitDB
+   _publicKey: '<signing key used to sign OrbitDB entries>',
+   signatures: {
+     //Allows the owner of id to prove they own the private key associated with publicKey
+     id: '<signature of _id signed using publicKey>',
+     //This links the two ids
+     publicKey: '<signature of signatures.id + _publicKey using _id>'
+   },
+   type: 'orbitdb'
+}

bibliography/references.bib

@@ -24,8 +24,7 @@
 
 @article{2.5-bitcoin,
 	author = {Nakamoto, Satoshi},
-	year = {2009},
-	month = {03},
+	date = {2008-10-31},
 	title = {Bitcoin: A Peer-to-Peer Electronic Cash System},
 	journal = {Cryptography Mailing list at https://metzdowd.com}
 }

chapters/2.theoretical-background/2.8.orbit-db.tex

@@ -6,7 +6,7 @@
 	\caption{OrbitDB logo}
 \end{figure}
 
-Η OrbitDB είναι μία P2P βάση δεδομένων ανοιχτού κώδικα. Χρησιμοποιεί το IPFS για την αποθήκευση των δεδομένων και το IPFS Pubsub για τον αυτόματο συγχρονισμό των βάσεων δεδομένων μεταξύ των peers. Είναι μία τελικά συνεπής (eventually consistent) και χρησιμοποιεί CRDTs (Conflict-Free Replicated Data Types) για συγχωνεύσεις βάσεων δεδομένων χωρίς συγκρούσεις, πράγμα που την καθιστά εξαιρετική επιλογή για DApps και offline-first web applications.\cite{2.8-orbitdb}
+Η OrbitDB είναι μία P2P βάση δεδομένων ανοιχτού κώδικα. Χρησιμοποιεί το IPFS για την αποθήκευση των δεδομένων και το IPFS Pubsub για τον αυτόματο συγχρονισμό των βάσεων δεδομένων μεταξύ των peers. Είναι τελικά συνεπής (eventually consistent) και χρησιμοποιεί CRDTs (Conflict-Free Replicated Data Types) για συγχωνεύσεις βάσεων δεδομένων χωρίς συγκρούσεις, πράγμα που την καθιστά εξαιρετική επιλογή για DApps και offline-first web applications.\cite{2.8-orbitdb}
 
 Κάποια Βασικά χαρακτηριστικά της είναι τα εξής:
 \begin{itemize}
@@ -22,16 +22,15 @@
 	
 	Όλα τα stores υλοποιούνται πάνω στο \texttt{ipfs-log}, μία αμετάβλητη, operation-based CRDT για κατανεμημένα συστήματα, ενώ υπάρχει και η δυνατότητα δημιουργίας προσαρμοσμένων stores ανάλογα με την περίπτωση.
 	
-	\item \textbf{Address}: Κάθε βάση δεδομένων λαμβάνει κατά τη δημιουργία της μία διεύθυνση της μορφής: \texttt{/orbitdb/CID/DATABASE\_NAME}, όπου CID είναι το IPFS multihash του μανιφέστου της, ενώ το DATABASE\_NAME είναι το όνομα της βάσης\cite{2.8-orbitdb-guide}. Το μανιφέστο είναι ένα IPFS object που περιέχει πληροφορίες της βάσης όπως το όνομα, τον τύπο και έναν δείκτη στον ελεγκτή πρόσβασης (access controller).
+	\item \textbf{Address}: Κάθε βάση δεδομένων λαμβάνει κατά τη δημιουργία της μία διεύθυνση της μορφής: \texttt{\\/orbitdb/CID/DATABASE\_NAME}, όπου CID είναι το IPFS multihash του μανιφέστου της και DATABASE\_NAME το όνομα της βάσης\cite{2.8-orbitdb-guide}. Το μανιφέστο είναι ένα IPFS object που περιέχει πληροφορίες της βάσης όπως το όνομα, τον τύπο και έναν δείκτη στον ελεγκτή πρόσβασης (access controller).
 	
 	\item \textbf{Identity}: Κάθε φορά που προστίθεται μία εγγραφή στη βάση υπογράφεται από τον δημιουργό της, ο οποίος προσδιορίζεται από μία ταυτότητα (identity). Το Identity object, πέρα από τον προεπιλεγμένο τρόπο λειτουργίας, μπορεί να προσαρμοστεί έτσι ώστε να συνδέεται με κάποιο εξωτερικό αναγνωριστικό.
 	Η μορφή του έχει ως εξής (βλ. και  \url{https://github.com/orbitdb/orbit-db-identity-provider}):
 	
-	\begin{figure}[H]
-		\centering
-		\includegraphics[width=12cm]{assets/figures/orbitdb-identity.png}
+	\begin{enumitemcenteredfigure}
+		\simplelisting[width=15cm]{orbit-db-identity.js}
 		\caption{OrbitDB Identity}
-	\end{figure}
+	\end{enumitemcenteredfigure}
 
-	\item \textbf{Access Control}: Κατά τη δημιουργία μίας βάσης μπορούν να οριστούν όσοι θα έχουν δικαίωμα να γράψουν σε αυτήν μέσω ενός ελεγκτή πρόσβασης (access controller). Ο ελεγκτής θα περιλαμβάνει τα public keys τους, τα οποία μπορούν να ανακτηθούν από το identity του καθενός. Από προεπιλογή και αν δεν ορίζεται διαφορετικά, δίνεται πρόσβαση εγγραφής μόνο στον δημιουργό της βάσης.
+	\item \textbf{Access Control}: Κατά τη δημιουργία μίας βάσης μπορούν να οριστούν όσοι θα έχουν δικαίωμα να γράψουν σε αυτή μέσω ενός ελεγκτή πρόσβασης (access controller). Ο ελεγκτής θα περιλαμβάνει τα public keys τους, τα οποία μπορούν να ανακτηθούν από το identity του καθενός. Από προεπιλογή και αν δεν ορίζεται διαφορετικά, δίνεται πρόσβαση εγγραφής μόνο στον δημιουργό της βάσης.
 \end{itemize}

chapters/3.application-design/3.3.software-requirements.tex

@@ -33,7 +33,7 @@
 
 	\sysReqItem
 		{Ο εγγεγραμμένος χρήστης πρέπει να μπορεί να δημιουργεί μηνύματα (posts).}
-		{Ο εγγεγραμμένος χρήστης πρέπει να μπορεί να δημιουργεί μηνύματα (posts) στο θέμα που επιθυμεί. Αυτό επιτυγχάνεται συμπληρώνοντας το πεδίο νέου μηνύματος στην οθόνη του θέματος, πατώντας το κουμπί "Post" και επιβεβαιώνοντας τη συναλλαγή στο Ethereum.}
+		{Ο εγγεγραμμένος χρήστης πρέπει να μπορεί να δημιουργεί μηνύματα στο θέμα που επιθυμεί. Αυτό επιτυγχάνεται συμπληρώνοντας το πεδίο νέου μηνύματος στην οθόνη του θέματος, πατώντας το κουμπί "Post" και επιβεβαιώνοντας τη συναλλαγή στο Ethereum.}
 		{?}{TODO}
 		{?}{TODO}
 

custom-commands/custom-enumitem.tex

@@ -0,0 +1,13 @@
+% Centered figure inside an item list
+\newenvironment{enumitemcenteredfigure}
+{
+	\begin{minipage}{\linewidth}
+		\centering
+		\begin{figure}[H]
+			\centering
+		}
+		{
+		\end{figure}
+	\end{minipage}
+	\medskip
+}

custom-commands/custom-listings.tex

@@ -0,0 +1,10 @@
+\newtcbinputlisting{\simplelisting}[2][]{
+	listing file={assets/code/#2},
+	title={},
+	listing only,
+	boxrule=1pt,
+	minted language=javascript,
+	minted style=default,
+	minted options={breaklines, breaksymbol={}},
+	#1
+}

packages.tex

@@ -20,22 +20,28 @@
 \usepackage{custom-packages/greek-enumerate}	% Greek enumeration for ordered item lists
 \usepackage{float}								% For \begin{figure}[H]
 \usepackage[font={footnotesize, it}]{caption}	% For captions under figures
-\usepackage{csquotes}							%TODO: unused atm (remove?)
+\usepackage [autostyle]{csquotes}
 \usepackage{listings}							%TODO: unused atm (remove?)
 \usepackage{tabularx}							% Support for break lines inside table cells
 \usepackage{booktabs}							% Useful table styling commands
+\usepackage{minted}	% Source code highlighting (make sure to add -shell-escape flag!)
+\usepackage{tcolorbox}	% Colored boxes
+\tcbuselibrary{minted}	% Make tcolorbox work with minted
 
 % --- Bibliography ---
-\usepackage[sorting=none]{biblatex}	% Make sure to have biber as default bibliography tool (e.g. in Texstudio's build configuration)
+\usepackage[sorting=none]{biblatex}
 
 % --- Custom commands ---
 \input{custom-commands/custom-title-page}
 \input{custom-commands/custom-lists}
+\input{custom-commands/custom-listings}
+\input{custom-commands/custom-enumitem}
 \input{custom-commands/srs-commands}
 \input{custom-commands/use-case-commands}
 
 % --- Custom styles ---
 \renewcommand{\arraystretch}{1.2}	% Streches the table row height so text is not crammed between the lines
+\MakeOuterQuote{"}	% For csquotes package
 
 % Hyphenations
 \input{misc/hyphenations}