summaryrefslogtreecommitdiffstats
path: root/doc/paper/main.tex
blob: 7789f02e9e9ebb1c2638fba1cc8da1616675b784 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
\documentclass[conference]{IEEEtran}
\IEEEoverridecommandlockouts
% The preceding line is only needed to identify funding in the first footnote. If that is unneeded, please comment it out.
\usepackage{cite}
\usepackage{amsmath,amssymb,amsfonts}
\usepackage{algorithmic}
\usepackage{graphicx}
\usepackage{textcomp}
\usepackage{xcolor}
\usepackage{url}
\def\BibTeX{{\rm B\kern-.05em{\sc i\kern-.025em b}\kern-.08em
    T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX}}
\begin{document}

\title{How to implement a distributed social network using IPFS}

\author{\IEEEauthorblockN{Matthias Beyer}
\IEEEauthorblockA{Tübingen, Germany \\
mail@beyermatthias.de}
}

\maketitle

\begin{abstract}
    This document describes how one can implement a distributed social network
    or publishing platform using the IPFS\cite{ipfsbennet}, \cite{ipfsio} and related technologies.
    It proposes a block data format for a blockchain and conceptual ideas for
    implementing "profiles" upon this data format.
    It also describes profile discovery algorithms and lays out problems with
    trust and how they could be approached.
    Finally, it proposes an architecture how a client for such a social network
    could be implemented, focusing on reusability of components to be able to
    make them available to a broader audience, for example for federated caching
    or even embedded usage.
\end{abstract}

\begin{IEEEkeywords}
\end{IEEEkeywords}

\section{Introduction}
% Intro about the general idea

\section{Data types}
% Intro about the data types required for building the blockchain

The implementation of an IPFS-based social network would be based on a DAG of
blocks of data.
Each DAG would resemble a "profile" in the social network.
A "profile", though, would not necessarily be bound to a person, but would
represent a unique identity.
Embedded ("smart") devices or automated tools (bots) posting to a profile without
human interaction could be possible and are imaginable.

Because distribution and availability is curcial, two "layers" of blocks should
be considered:

\begin{itemize}
    \item A more general "block", implementing nothing more than the chain and
        some minimal meta data, e.g. a format version and a, and a pointer to
        the actual "metadata block"
    \item A "metadata block", holding all the information about the profile,
        the content and other valuable metadata, such as timestamps, a mimetype
        of the content linked and, of course, a link to the actual content
\end{itemize}

The third data type required for implementing a block would be holding the data
itself.
Thus, it would be only a stream of bytes - which would be added to IPFS
directly.

In the following chapters, details of the individual types are layed out.
For simplicity, JSON is used for examples of objects of the layed out
types.


\subsection{Block}
% What a "block" is used for and what data it holds
% - metadata pointer

\subsection{Metadata-Block}
% What a "metadata-block" is used for and what data it holds
% - mime
% - timestamp
% - IPNS List
% - content
%   - content pointer
%   - references to other blocks


\subsection{Content}
% What a "content" object is (and what it is not)

\subsection{Data format}
% Short note about possible data formats



\section{Profiles}
% How profiles are implemented on top of the data types

\subsection{Multi-device support}
% How multi-device support for a profile is implemented using IPNS

\subsection{Device "Authorization"}
% How devices are authorized to post to a profile

\subsection{Device "De-authorization"}
% How devices are de-authorized from posting to a profile


\section{Posts}
% what a post is

\subsection{Post types}
% What kinds of posts exist

\subsection{Comments}
% How comments on posts could be implemented


\section{Traversing Chains and profile discovery}
% What needs to be done for traversing a block chain and discover a profile

\subsection{Profile fetching}
% How profiles are fetched

\subsection{Trusting a chain}
% How a chain can be trusted



\section{Possibilities for Optimization}
% Possibilities how the block chain model could be optimized


\section{Implementation}
% Intro for architecture description

\subsection{Architecture}
% Description of the general architecture

\subsection{Backend}
% Interfacing with IPFS and providing an abstraction to
% interact with "blocks" and "profiles", using either
% - a REST interface to be run as a (possibly network-local) server, or
% - a library API for embedding into a "fat" application


\subsection{Middleware}
% Middleware library, providing
% - interfaces for working with a backend (either REST or library)
% - public-private-key crypto interfaces for IPNS name publishing

% Itself providing either a REST interface via a webserver or
% a library API for embedding into a "fat" application


\subsection{Frontend}
% Frontend implementation, abstract over the middleware implementation, which
% needs to be trusted.
%
% A frontend impl could be started on a embedded device where no public-private
% key crypto is possible, so the middleware runs on a better-suited device
%
% The frontend could also embedd the middleware and implement a desktop client
% using a CLI, TUI, GUI or WUI.


\section{Future work}
% What could be implemented on top of this idea

\section*{Acknowledgment}

\section*{References}

\begin{thebibliography}{00}
\bibitem{ipfsbennet} J. Bennet, IPFS - Content Addressed, Versioned, P2P File System(DRAFT 3)
\bibitem{ipfsio} \url{https://docs.ipfs.io/}
\end{thebibliography}
\end{document}