Skip to content

Commit

Permalink
update-verifier: merge repo into orb-software
Browse files Browse the repository at this point in the history
  • Loading branch information
@TheButlah
TheButlah committed Sep 7, 2024
2 parents 7eb9dd9 + 71f2c96 commit fdd3074
Show file tree
Hide file tree
Showing 67 changed files with 12,842 additions and 0 deletions.
70 changes: 70 additions & 0 deletions update-verifier/Cargo.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
[package]
name = "orb-update-verifier"
version = "0.2.1"
authors = [
"Mark Eder <56895722+mrkdir@users.noreply.github.com>",
]
edition = "2021"
license = "MIT OR (Apache-2.0 WITH LLVM-exception)"
description = """
Checks general system health and manages the slot and rootfs state of the Orb.
"""

[dependencies]
eyre = "0.6.8"
flume = "0.11.0"
jod-thread = "0.1.2"
libc = "0.2.137"
polling = "2.2.0"
prost = "0.12.4"
tap = "1.0.1"
tracing = "0.1.37"
tracing-journald = "0.3.0"
tracing-subscriber = { version = "0.3.16", features = ["env-filter"] }
thiserror = "1.0.37"
zbus = "4.1.2"
zbus_systemd = { version = "0.0.16", features = ["login1"] }
semver = "1.0.22"
log = "0.4.18"

[dependencies.reqwest]
version = "0.11.4"
default-features = false
features = ["blocking", "json"]

[dependencies.orb-slot-ctrl]
git = "https://github.com/worldcoin/orb-software"
rev = "7eb9dd9ce0bc92269b21815d11943ad452860bf7"

[dependencies.can]
package = "can-rs"
git = "https://github.com/worldcoin/orb-software"
rev = "7eb9dd9ce0bc92269b21815d11943ad452860bf7"

[dependencies.orb-messages]
git = "https://github.com/worldcoin/orb-messages"
rev = "449bb1c73af41334e5dc44e12f6200d315aaa9d2"

[dev-dependencies]
serde = { version = "1.0.147", features = ["derive"] }
# isahc = { version = "1.7", features = ["static-ssl"] }
httpmock = "0.6.7"
serde_json = "1.0.94"
prost-build = "0.12.4"

[package.metadata.deb]
maintainer-scripts = "debian/"
assets = [
["target/release/orb-update-verifier", "/usr/local/bin/", "755"]
]
systemd-units = [
{ unit-name = "worldcoin-update-verifier" },
]

# What we use when producing artifacts to distribute
[profile.artifact]
inherits = "release"
lto = true
strip = true
debug = false

49 changes: 49 additions & 0 deletions update-verifier/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# orb-update-verifier
Checks general system health and manages the slot and rootfs state of the Orb.
It is designed to run as systemd oneshot service that will run once on boot.

## Systemd and integration
The systemd service configuration can be found in `debpkg/lib/systemd/system/worldcoin-update-verifier.service` and
will be packaged together with the binary in CI.

## Building

### Prerequisites
+ `rustup`: `1.25.2` (tested with 1.25, might work with older versions)
+ `rustc`: `1.67.0`
+ `ziglang`: `0.10.1`

Using Arch Linux as an example, you can install `ziglang` and `rustup` using pacman, and in turn
get the most recent version of `rustc`:

```sh
$ sudo pacman -S zig rustup
$ rustup install stable
```

```sh
$ brew install zig rustup-init
$ rustup-init
```

The easiest way to cross-compile for the orb is to use `cargo-zigbuild`, which
in turn relies on ziglang's tooling to act as a linker.

```sh
$ rustup target add aarch64-unknown-linux-gnu
$ cargo install cargo-zigbuild
```

### Compiling

```sh
$ cargo zigbuild --release --target aarch64-unknown-linux-gnu.2.27
```

### Testing

Health test can be forced by setting environment variable `UPDATE_VERIFIER_DRY_RUN`.

```sh
$ sudo UPDATE_VERIFIER_DRY_RUN="1" ./update-verifier
```
15 changes: 15 additions & 0 deletions update-verifier/debian/orb-update-verifier.worldcoin-update-verifier.service
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[Unit]
Description=Worldcoin Update Verifier Service.
After=teleport.service
StartLimitInterval=0

[Service]
Type=oneshot
User=root
ExecStart=/usr/local/bin/update-verifier
Restart=on-failure
RestartSec=10s
SyslogIdentifier=worldcoin-update-verifier

[Install]
WantedBy=multi-user.target
1 change: 1 addition & 0 deletions update-verifier/docs/book/.nojekyll
View file
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.
236 changes: 236 additions & 0 deletions update-verifier/docs/book/404.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
<!DOCTYPE HTML>
<html lang="en" class="rust" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Page not found - orb-software</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 class="sidebar-visible no-js">
<div id="body-container">
<!-- Provide site root to javascript -->
<script>
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "rust";
</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('rust')
html.classList.add(theme);
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
</script>

<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">

<!-- Hide / unhide sidebar before it is displayed -->
<script>
var body = document.querySelector('body');
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.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="introduction.html">Introduction</a></li><li class="chapter-item expanded "><a href="first-time-setup.html">First Time Setup</a></li><li class="chapter-item expanded "><a href="development.html">Developing Code</a></li><li class="chapter-item expanded "><a href="open-source.html">How we do Open Source</a></li><li class="chapter-item expanded "><a href="hil/index.html">Hardware In The Loop</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="hil/cli.html">Orb-HIL CLI</a></li><li class="chapter-item expanded "><a href="hil/nixos-setup.html">Setting Up NixOS</a></li><li class="chapter-item expanded "><a href="hil/hardware-setup.html">Hardware Setup</a></li></ol></li><li class="chapter-item expanded "><a href="components/index.html">Software Components</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="components/orb-core/index.html">Orb Core</a></li></ol></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</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">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<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">orb-software</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>

</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>

<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



<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 -->
<script src="mermaid.min.js"></script>
<script src="mermaid-init.js"></script>


</div>
</body>
</html>
4 changes: 4 additions & 0 deletions update-verifier/docs/book/FontAwesome/css/font-awesome.css
View file

Large diffs are not rendered by default.

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

0 comments on commit fdd3074

Please sign in to comment.