Skip to content

Commit

Permalink
root
Browse files Browse the repository at this point in the history
  • Loading branch information
@hinto-janai
hinto-janai committed Nov 30, 2023
0 parents commit 6a6d892
Show file tree
Hide file tree
Showing 188 changed files with 12,815 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# This clippys, docs, tests, builds.

name: CI

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
workflow_dispatch:

env:
CARGO_TERM_COLOR: always
RUST_BACKTRACE: "full"

jobs:
ci:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive

- name: Spell Check
uses: crate-ci/typos@master

- name: Install mdBook
run: cargo install mdbook

- name: Build
run: mdbook build

- name: Archive
uses: actions/upload-artifact@v3
with:
name: docs
path: docs
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 hinto-janai

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<div align="center">

<img src="src/img/banner_1920_640.png" width="100%"/>

[Cold wallet](https://en.wikipedia.org/wiki/Cryptocurrency_wallet#Cold_storage) guide for [Monero](https://getmonero.org)

![CI](https://github.com/hinto-janai/malvarma/actions/workflows/ci.yml/badge.svg)

</div>

## Contributing
The text sources are regular markdown files located in [`src/`](src).

This get compiled into HTML/JS/CSS with [`mdbook`](https://github.com/rust-lang/mdBook) into [`docs/`](docs), which are the files directly served by https://malvarma.org.

To build & test, install [`mdbook`](https://rust-lang.github.io/mdBook) and run:
```bash
mdbook build
```
at the repo root.

The files should be placed in `docs/` with an `index.html`.

Do not submit PRs with a pre-built `docs/` folder, only make changes to `src/`.

This guide should mostly be a list of instructions on setting up a cold wallet with sane defaults.

Detailed commentary, terminology, and tradeoffs are withheld on purpose - this guide should be as simple/practical as possible.
15 changes: 15 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[book]
authors = ["hinto-janai"]
language = "en"
multilingual = false
src = "src"
title = "Malvarma"

[build]
build-dir = "docs"

[output.html]
default-theme = "ayu"
preferred-dark-theme = "ayu"
git-repository-url = "https://github.com/hinto-janai/malvarma"
cname = "malvarma.org"
1 change: 1 addition & 0 deletions docs/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This file makes sure that Github Pages doesn't process mdBook's output.
214 changes: 214 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
<!DOCTYPE HTML>
<html lang="en" class="sidebar-visible no-js ayu">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Page not found - Malvarma</title>
<base href="/">


<!-- Custom HTML head -->

<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />

<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">

<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">

<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">

<!-- Custom theme stylesheets -->

</head>
<body>
<div id="body-container">
<!-- Provide site root to javascript -->
<script>
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "ayu" : "ayu";
</script>

<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');

if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}

if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>

<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('ayu')
html.classList.add(theme);
html.classList.add('js');
</script>

<!-- Hide / unhide sidebar before it is displayed -->
<script>
var html = document.querySelector('html');
var sidebar = null;
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded "><a href="intro.html"><strong aria-hidden="true">1.</strong> Intro</a></li><li class="chapter-item expanded "><a href="before_we_start/before_we_start.html"><strong aria-hidden="true">2.</strong> ⛔️ Before we start</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="before_we_start/what_you_need.html"><strong aria-hidden="true">2.1.</strong> What you need</a></li><li class="chapter-item expanded "><a href="before_we_start/what_things_mean.html"><strong aria-hidden="true">2.2.</strong> What things mean</a></li></ol></li><li class="chapter-item expanded "><a href="cold_wallet/cold_wallet.html"><strong aria-hidden="true">3.</strong> ❄️ Cold wallet</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="cold_wallet/prepare_the_software.html"><strong aria-hidden="true">3.1.</strong> Prepare the software</a></li><li class="chapter-item expanded "><a href="cold_wallet/prepare_the_hardware.html"><strong aria-hidden="true">3.2.</strong> Prepare the hardware</a></li><li class="chapter-item expanded "><a href="cold_wallet/create_the_cold_wallet.html"><strong aria-hidden="true">3.3.</strong> Create the cold wallet</a></li><li class="chapter-item expanded "><a href="cold_wallet/create_the_view_wallet.html"><strong aria-hidden="true">3.4.</strong> Create the view wallet</a></li></ol></li><li class="chapter-item expanded "><a href="transactions/transactions.html"><strong aria-hidden="true">4.</strong> 💵 Transactions</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="transactions/create_a_transaction.html"><strong aria-hidden="true">4.1.</strong> Create a transaction</a></li><li class="chapter-item expanded "><a href="transactions/sign_the_transaction.html"><strong aria-hidden="true">4.2.</strong> Sign the transaction</a></li><li class="chapter-item expanded "><a href="transactions/broadcast_the_transaction.html"><strong aria-hidden="true">4.3.</strong> Broadcast the transaction</a></li><li class="chapter-item expanded "><a href="transactions/outputs.html"><strong aria-hidden="true">4.4.</strong> Outputs</a></li></ol></li><li class="chapter-item expanded "><a href="maintenance/maintenance.html"><strong aria-hidden="true">5.</strong> 🔨 Maintenance</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="maintenance/upgrading_the_wallet.html"><strong aria-hidden="true">5.1.</strong> Upgrading the wallet</a></li><li class="chapter-item expanded "><a href="maintenance/restoring_the_cold_wallet.html"><strong aria-hidden="true">5.2.</strong> Restoring the cold wallet</a></li><li class="chapter-item expanded "><a href="maintenance/restoring_the_view_wallet.html"><strong aria-hidden="true">5.3.</strong> Restoring the view wallet</a></li></ol></li><li class="chapter-item expanded "><a href="optional/optional.html"><strong aria-hidden="true">6.</strong> ⚠️ "Optional"</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="optional/backup_the_cold_wallet.html"><strong aria-hidden="true">6.1.</strong> Backup the cold wallet</a></li><li class="chapter-item expanded "><a href="optional/physical_security.html"><strong aria-hidden="true">6.2.</strong> Physical security</a></li></ol></li><li class="chapter-item expanded "><a href="end.html"><strong aria-hidden="true">7.</strong> End</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>

<!-- Track and set sidebar scroll position -->
<script>
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
</script>

<div id="page-wrapper" class="page-wrapper">

<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</button>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>

<h1 class="menu-title">Malvarma</h1>

<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/hinto-janai/malvarma" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>

</div>
</div>

<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>

<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>

<div id="content" class="content">
<main>
<h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->


<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">

</nav>

</div>




<script>
window.playground_copyable = true;
</script>


<script src="elasticlunr.min.js"></script>
<script src="mark.min.js"></script>
<script src="searcher.js"></script>

<script src="clipboard.min.js"></script>
<script src="highlight.js"></script>
<script src="book.js"></script>

<!-- Custom JS scripts -->


</div>
</body>
</html>
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
malvarma.org
4 changes: 4 additions & 0 deletions docs/FontAwesome/css/font-awesome.css

Large diffs are not rendered by default.

Binary file added docs/FontAwesome/fonts/FontAwesome.ttf
Binary file not shown.
Binary file added docs/FontAwesome/fonts/fontawesome-webfont.eot
Binary file not shown.
Loading

0 comments on commit 6a6d892

Please sign in to comment.