commit 5d21afe9d1fe30a75b2bbfd442bc161d0b1d97a0
parent 3f25042d09d446ae56799baceae88be8fcab07f1
Author: Joel-Haeberli <haebu@rubigen.ch>
Date: Thu, 6 Jun 2024 10:29:41 +0200
docs: structure
Diffstat:
5 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/docs/content/architecture/c2ec.tex b/docs/content/architecture/c2ec.tex
@@ -63,13 +63,13 @@ Fees are an important aspect of the withdrawal flow using established payment se
Withdrawals by the wallet with a C2EC are based on withdrawal operations which register a reserve public key at the C2EC component. The provider must first create a unique identifier for the withdrawal operation (the \texttt{WOPID}) to interact with the withdrawal operation (as described in \autoref{sec-architecture-c2ec-terminals-api}) and eventually withdraw digital cash using the wallet. The withdrawal operation API is an implementation of the \textit{Bank Integration API} \cite{taler-bank-integration-api}.
-\subsection{Taler Wirewatch Gateway API}
+\subsubsection{Taler Wire-Gateway API}
-The Taler Wirewatch Gateway API \cite{taler-wire-gateway-api} must be implemented in order to capture incoming transactions and allow the withdrawal of digital cash. The specification of the Taler Wirewatch Gateway can be found in the official Taler documentation \cite{taler-wire-gateway-api}.
+The Taler Wire-Gateway API \cite{taler-wire-gateway-api} must be implemented in order to capture incoming transactions and allow the withdrawal of digital cash. The specification of the Taler Wire-Gateway API can be found in the official Taler documentation \cite{taler-wire-gateway-api}.
-The Wirewatch Gateway helps the Exchange communicate with the C2EC component using the API. It helps the Exchange to fetch guarantees, that a certain transaction went through and that the reserve can be created and withdrawn. This will help C2EC to capture the transaction of the Terminal Backend to the Exchange's account and therefore allow the withdrawal by the customer. The Wirewatch Gateway API is implemented as part of C2EC. When the Wirewatch Gateway can get the proof, that a transaction was successfully processed, the Exchange will create a reserve with the corresponding reserve public key.
+The Wire-Gateway API enables the Exchange to communicate with the C2EC component using the API. The Exchange fetchs final withdrawals. The finality is guaranteed by C2EC by confirming the payment at the terminal backend. The Wire-Gateway API is implemented as part of C2EC. When the Exchange's wire watch process loads a confirmed withdrawal, the transaction was successfully processed. The Exchange will create a reserve with the corresponding reserve public key which can then be withdrawn by the wallet with the corresponding reserve private key.
-The Wire Gateway API of C2EC does not implement the testing endpoint \textit{/admin/add-incoming}. The endoint will respond with HTTP status code 501 (not implemented).
+The Wire-Gateway API of C2EC does not implement the testing endpoint \textit{/admin/add-incoming}. The endoint will respond with HTTP status code 501 (not implemented).
\subsection{C2EC Entities}
\label{sec-architecture-entities}
diff --git a/docs/content/implementation/a-bank-integration-api.tex b/docs/content/implementation/a-bank-integration-api.tex
@@ -12,12 +12,12 @@ Namely this are the following endpoints:
\item POST /withdrawal-operation/[WOPID]/abort
\end{itemize}
-\begin{figure}[h]
- \centering
- \includegraphics[width=0.7\textwidth]{pictures/diagrams/bank-integration-api.png}
- \caption{Bank-Integration API endpoints}
- \label{fig-diagram-bank-integration-api-sequence}
-\end{figure}
+% \begin{figure}[h]
+% \centering
+% \includegraphics[width=0.7\textwidth]{pictures/diagrams/bank-integration-api.png}
+% \caption{Bank-Integration API endpoints}
+% \label{fig-diagram-bank-integration-api-sequence}
+% \end{figure}
\textbf{Configuration (/config)}
diff --git a/docs/content/implementation/a-terminal-api.tex b/docs/content/implementation/a-terminal-api.tex
@@ -14,12 +14,12 @@ The C2EC Terminals API implements following endpoints:
The C2EC component does not implement the \texttt{/quotas/*} endpoints, since those are not relevant for the withdrawal using a payment terminal. Quotas are possibly checked by the payment service provider.
-\begin{figure}[h]
- \centering
- \includegraphics[width=0.7\textwidth]{pictures/diagrams/terminals-api.png}
- \caption{Terminals API endpoints}
- \label{fig-diagram-terminals-api-sequence}
-\end{figure}
+% \begin{figure}[h]
+% \centering
+% \includegraphics[width=0.7\textwidth]{pictures/diagrams/terminals-api.png}
+% \caption{Terminals API endpoints}
+% \label{fig-diagram-terminals-api-sequence}
+% \end{figure}
\textbf{Configuration (/config)}
diff --git a/docs/content/implementation/a-wire-gateway-api.tex b/docs/content/implementation/a-wire-gateway-api.tex
@@ -12,12 +12,12 @@ Following endpoints are implemented by the wire gateway API implementation:
\item GET /history/outgoing
\end{itemize}
-\begin{figure}[h]
- \centering
- \includegraphics[width=0.7\textwidth]{pictures/diagrams/wire-gateway-api.png}
- \caption{Wire-Gateway API endpoints}
- \label{fig-diagram-wire-gateway-api-sequence}
-\end{figure}
+% \begin{figure}[h]
+% \centering
+% \includegraphics[width=0.7\textwidth]{pictures/diagrams/wire-gateway-api.png}
+% \caption{Wire-Gateway API endpoints}
+% \label{fig-diagram-wire-gateway-api-sequence}
+% \end{figure}
\textbf{Configuration (/config)}
diff --git a/docs/thesis.pdf b/docs/thesis.pdf
Binary files differ.
