Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(whitepaper): fix whitepaper.yml #281

Merged
merged 12 commits into from
Nov 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/whitepaper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@ jobs:
uses: xu-cheng/latex-action@v2
with:
working_directory: ./packages/whitepaper
pre_compile: pdflatex -interaction=errorstopmode -halt-on-error main.tex && (bibtex main || true)
root_file: main.tex

- name: Rename
working-directory: ./packages/whitepaper
run: mkdir -p build && mv main.pdf build/taiko-whitepaper.pdf
run: rm -rf build/ && mkdir build && mv main.pdf build/taiko-whitepaper.pdf

- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,5 @@ dist

# vscode
.vscode/

.pdf
4 changes: 3 additions & 1 deletion packages/whitepaper/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
build/
build/
*.pdf
temp.*
11 changes: 7 additions & 4 deletions packages/whitepaper/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ then
exit 1
fi

rm -rf build
mkdir -p build
pdflatex -output-directory=build -interaction=errorstopmode -halt-on-error main.tex
mv build/main.pdf build/taiko-whitepaper.pdf
rm -rf temp.*
rm -rf main.pdf
cp main.tex temp.tex
pdflatex -interaction=errorstopmode -halt-on-error temp.tex && (bibtex temp || true)
pdflatex -interaction=errorstopmode -halt-on-error temp.tex
mv temp.pdf main.pdf
rm -rf temp.*
8 changes: 5 additions & 3 deletions packages/whitepaper/main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
\usepackage[a4paper,width=170mm,top=18mm,bottom=22mm,includeheadfoot]{geometry}
\usepackage{booktabs}
\usepackage{nicefrac}
\usepackage{datetime2}
\usepackage{array}
\usepackage{verbatim}
\usepackage{caption}
Expand Down Expand Up @@ -63,12 +64,12 @@
\newcommand*\eg{e.g.\@\xspace}
\newcommand*\Eg{e.g.\@\xspace}
\newcommand*\ie{i.e.\@\xspace}
\newcommand{\thedate}{October 6, 2022}
\date{\today}

%\renewcommand{\itemhook}{\setlength{\topsep}{0pt} \setlength{\itemsep}{0pt}\setlength{\leftmargin}{15pt}}

\title[TAIKO: A Type-1 Ethereum ZK-Rollup\\ \smaller
\textbf{{1.2.0}}]{TAIKO: A Type-1 Ethereum ZK-Rollup \\ \smaller \textbf{{1.2.0 (\thedate)}}}
\textbf{{1.2.1}}]{TAIKO: A Type-1 Ethereum ZK-Rollup \\ \smaller \textbf{{1.2.1 (\today)}}}

\author{Taiko Labs ([email protected])}

Expand Down Expand Up @@ -410,7 +411,8 @@ \section{Cross-Chain Communication}\label{sec:bridges}

On Ethereum, the \underline{TaikoL1} contract persists the height and hash of the L2 blocks. On Taiko, the anchor function in the \emph{\underline{TaikoL2}} contract is used to persist the height and block hash of the previous Ethereum block (from when the L2 block was proposed), as well as the previous L2 block hash (which allows L2 smart contracts to easily fetch the full history of L2 block hashes).

\subsection{Ether on L2}\label{eth-bridge}
\subsection{Ether on L2}
\label{eth-bridge}
The Taiko Ether bridge will allow users to bridge Ether from and to Taiko. $2^{128}$ Ether is minted to a special vault contract called the \underline{TokenVault} in the genesis block. When a user deposits Ether to L2, the same amount of Ether will be transferred from the \underline{TokenVault} to the user on L2. When a user withdraws some Ether from L2, Ether on L2 will be transferred back to \underline{TokenVault} (no L2 Ether will ever be burnt).

A small amount of Ether will also be minted to a few EOAs to bootstrap the L2 network, otherwise nobody would be able to transact. To make sure the Ether bridge is solvent, a corresponding amount of Ether will be deposited to the Ether bridge on L1.
Expand Down