diff --git a/README.md b/README.md index bfe9632..45cba63 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,7 @@ nix build In a nix shell (`nix develop` or using `nix-direnv`) you can type check: ```sh -cd hydra-protocol -agda Hydra/Protocol/Main.lagda +agda src/Hydra/Protocol/Main.lagda ``` or build the PDF iteratively: diff --git a/Shakefile.hs b/Shakefile.hs index 13d88fc..430c9c4 100644 --- a/Shakefile.hs +++ b/Shakefile.hs @@ -13,10 +13,10 @@ main = shakeArgs shakeOptions{shakeFiles="_build"} $ do removeFilesAfter "_build" ["//*"] "_build/hydra-spec" <.> "pdf" %> \out -> do - assets <- getDirectoryFiles "hydra-protocol" ["//*.sty", "Hydra/Protocol/Figures/*.pdf", "//*.bib", "//*.ttf"] + assets <- getDirectoryFiles "src" ["//*.sty", "Hydra/Protocol/Figures/*.pdf", "//*.bib", "//*.ttf"] need ["_build/latex" c | c <- assets] - srcs <- getDirectoryFiles "hydra-protocol" ["//*.lagda", "//*.tex"] + srcs <- getDirectoryFiles "src" ["//*.lagda", "//*.tex"] need ["_build/latex" c -<.> "tex" | c <- srcs] cmd_ (Cwd "_build/latex") "latexmk -xelatex -shell-escape -halt-on-error Hydra/Protocol/Main.tex" @@ -25,17 +25,17 @@ main = shakeArgs shakeOptions{shakeFiles="_build"} $ do -- Copy assets forM ["sty", "pdf", "bib", "ttf"] $ \ext -> ("_build/latex//*." <> ext) %> \out -> do - let src = "hydra-protocol" dropDirectory1 (dropDirectory1 out) + let src = "src" dropDirectory1 (dropDirectory1 out) copyFile' src out -- Copy or compile from lagda files "_build/latex//*.tex" %> \out -> do - let src = "hydra-protocol" dropDirectory1 (dropDirectory1 out) + let src = "src" dropDirectory1 (dropDirectory1 out) b <- doesFileExist src if b then do need [src] copyFile' src out else do - let src = "hydra-protocol" dropDirectory1 (dropDirectory1 (out -<.> "lagda")) + let src = "src" dropDirectory1 (dropDirectory1 (out -<.> "lagda")) need [src] - cmd_ $ "agda -i hydra-protocol -l formal-ledger --transliterate --latex --latex-dir _build/latex " <> src + cmd_ $ "agda --transliterate --latex --latex-dir _build/latex " <> src diff --git a/hydra-protocol/hydra-protocol.agda-lib b/hydra-protocol.agda-lib similarity index 89% rename from hydra-protocol/hydra-protocol.agda-lib rename to hydra-protocol.agda-lib index 6210a9a..65c9e87 100644 --- a/hydra-protocol/hydra-protocol.agda-lib +++ b/hydra-protocol.agda-lib @@ -4,4 +4,4 @@ depend: standard-library standard-library-classes standard-library-meta -include: . +include: src diff --git a/hydra-protocol/Hydra/Protocol/Figures/SM-abort.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/SM-abort.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/SM-abort.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/SM-abort.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/SM-close.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/SM-close.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/SM-close.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/SM-close.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/SM-collect.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/SM-collect.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/SM-collect.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/SM-collect.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/SM-contest.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/SM-contest.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/SM-contest.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/SM-contest.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/SM-fanout.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/SM-fanout.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/SM-fanout.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/SM-fanout.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/SM-init-commit.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/SM-init-commit.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/SM-init-commit.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/SM-init-commit.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/SM_States_Basic.tex b/src/hydra-protocol/Hydra/Protocol/Figures/SM_States_Basic.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/SM_States_Basic.tex rename to src/hydra-protocol/Hydra/Protocol/Figures/SM_States_Basic.tex diff --git a/hydra-protocol/Hydra/Protocol/Figures/abortTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/abortTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/abortTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/abortTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/closeTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/closeTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/closeTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/closeTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/collectComTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/collectComTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/collectComTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/collectComTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/commitTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/commitTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/commitTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/commitTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/contestTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/contestTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/contestTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/contestTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/decrementTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/decrementTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/decrementTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/decrementTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/fanoutTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/fanoutTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/fanoutTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/fanoutTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/fig_offchain_prot.tex b/src/hydra-protocol/Hydra/Protocol/Figures/fig_offchain_prot.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/fig_offchain_prot.tex rename to src/hydra-protocol/Hydra/Protocol/Figures/fig_offchain_prot.tex diff --git a/hydra-protocol/Hydra/Protocol/Figures/incrementTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/incrementTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/incrementTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/incrementTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/initTx.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/initTx.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/initTx.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/initTx.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/state-transition_cropped.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/state-transition_cropped.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/state-transition_cropped.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/state-transition_cropped.pdf diff --git a/hydra-protocol/Hydra/Protocol/Figures/utxo-graph.pdf b/src/hydra-protocol/Hydra/Protocol/Figures/utxo-graph.pdf similarity index 100% rename from hydra-protocol/Hydra/Protocol/Figures/utxo-graph.pdf rename to src/hydra-protocol/Hydra/Protocol/Figures/utxo-graph.pdf diff --git a/hydra-protocol/Hydra/Protocol/Introduction.tex b/src/hydra-protocol/Hydra/Protocol/Introduction.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/Introduction.tex rename to src/hydra-protocol/Hydra/Protocol/Introduction.tex diff --git a/hydra-protocol/Hydra/Protocol/Main.lagda b/src/hydra-protocol/Hydra/Protocol/Main.lagda similarity index 100% rename from hydra-protocol/Hydra/Protocol/Main.lagda rename to src/hydra-protocol/Hydra/Protocol/Main.lagda diff --git a/hydra-protocol/Hydra/Protocol/OffChain.tex b/src/hydra-protocol/Hydra/Protocol/OffChain.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/OffChain.tex rename to src/hydra-protocol/Hydra/Protocol/OffChain.tex diff --git a/hydra-protocol/Hydra/Protocol/OnChain.tex b/src/hydra-protocol/Hydra/Protocol/OnChain.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/OnChain.tex rename to src/hydra-protocol/Hydra/Protocol/OnChain.tex diff --git a/hydra-protocol/Hydra/Protocol/Overview.tex b/src/hydra-protocol/Hydra/Protocol/Overview.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/Overview.tex rename to src/hydra-protocol/Hydra/Protocol/Overview.tex diff --git a/hydra-protocol/Hydra/Protocol/Preliminaries.tex b/src/hydra-protocol/Hydra/Protocol/Preliminaries.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/Preliminaries.tex rename to src/hydra-protocol/Hydra/Protocol/Preliminaries.tex diff --git a/hydra-protocol/Hydra/Protocol/Security.tex b/src/hydra-protocol/Hydra/Protocol/Security.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/Security.tex rename to src/hydra-protocol/Hydra/Protocol/Security.tex diff --git a/hydra-protocol/Hydra/Protocol/Setup.tex b/src/hydra-protocol/Hydra/Protocol/Setup.tex similarity index 100% rename from hydra-protocol/Hydra/Protocol/Setup.tex rename to src/hydra-protocol/Hydra/Protocol/Setup.tex diff --git a/hydra-protocol/Hydra/Protocol/Throwaway.lagda b/src/hydra-protocol/Hydra/Protocol/Throwaway.lagda similarity index 100% rename from hydra-protocol/Hydra/Protocol/Throwaway.lagda rename to src/hydra-protocol/Hydra/Protocol/Throwaway.lagda diff --git a/hydra-protocol/fonts/StrippedJuliaMono-Black.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-Black.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-Black.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-Black.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-BlackItalic.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-BlackItalic.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-BlackItalic.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-BlackItalic.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-Bold.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-Bold.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-Bold.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-Bold.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-BoldItalic.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-BoldItalic.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-BoldItalic.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-BoldItalic.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-BoldLatin.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-BoldLatin.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-BoldLatin.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-BoldLatin.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-ExtraBold.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-ExtraBold.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-ExtraBold.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-ExtraBold.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-ExtraBoldItalic.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-ExtraBoldItalic.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-ExtraBoldItalic.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-ExtraBoldItalic.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-Light.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-Light.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-Light.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-Light.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-LightItalic.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-LightItalic.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-LightItalic.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-LightItalic.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-Medium.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-Medium.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-Medium.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-Medium.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-MediumItalic.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-MediumItalic.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-MediumItalic.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-MediumItalic.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-Regular.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-Regular.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-Regular.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-Regular.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-RegularItalic.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-RegularItalic.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-RegularItalic.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-RegularItalic.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-RegularLatin.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-RegularLatin.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-RegularLatin.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-RegularLatin.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-SemiBold.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-SemiBold.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-SemiBold.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-SemiBold.ttf diff --git a/hydra-protocol/fonts/StrippedJuliaMono-SemiBoldItalic.ttf b/src/hydra-protocol/fonts/StrippedJuliaMono-SemiBoldItalic.ttf similarity index 100% rename from hydra-protocol/fonts/StrippedJuliaMono-SemiBoldItalic.ttf rename to src/hydra-protocol/fonts/StrippedJuliaMono-SemiBoldItalic.ttf diff --git a/hydra-protocol/macros.tex b/src/hydra-protocol/macros.tex similarity index 100% rename from hydra-protocol/macros.tex rename to src/hydra-protocol/macros.tex diff --git a/hydra-protocol/preamble.tex b/src/hydra-protocol/preamble.tex similarity index 100% rename from hydra-protocol/preamble.tex rename to src/hydra-protocol/preamble.tex diff --git a/hydra-protocol/short.bib b/src/hydra-protocol/short.bib similarity index 100% rename from hydra-protocol/short.bib rename to src/hydra-protocol/short.bib