Merge pull request #74 from kinode-dao/develop

Develop 0.7.1

Author: dr-frmr

.github/workflows/publish.yml

@@ -44,7 +44,7 @@
 #       #    published.
 #       #
 #       # We *could* pass through `--no-verify` so `cargo` doesn't build the crate before publishing,
-#       # which is reasonable, since this job only runs after the Linux, Windows, and WASM builds
+#       # which is reasonable, since this job only runs after the Linux, Windows, and Wasm builds
 #       # have passed.
 #       - name: "cargo release publish"
 #         run: |-

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "kinode_process_lib"
 description = "A library for writing Kinode processes in Rust."
-version = "0.7.0"
+version = "0.7.1"
 edition = "2021"
 license-file = "LICENSE"
 homepage = "https://kinode.org"

Cargo.toml

@@ -0,0 +1,28 @@
+use crate::Request;
+
+/// Add a new icon and/or widget to the Kinode homepage. Note that the process calling this
+/// function must have the `homepage:homepage:sys` messaging capability.
+///
+/// An icon must be a base64 encoded SVG.
+///
+/// A path will be automatically placed underneath the namespace of the process. For example,
+/// if the process is named `my:process:pkg`, and the path given is `/mypath`, the full path
+/// will be `my:process:pkg/mypath`.
+///
+/// A widget should be HTML: it will be displayed in an iframe.
+pub fn add_to_homepage(label: &str, icon: Option<&str>, path: Option<&str>, widget: Option<&str>) {
+    Request::to(("our", "homepage", "homepage", "sys"))
+        .body(
+            serde_json::json!({
+                "Add": {
+                    "label": label,
+                    "icon": icon,
+                    "path": path,
+                    "widget": widget
+                }
+            })
+            .to_string(),
+        )
+        .send()
+        .unwrap();
+}

src/homepage.rs

@@ -15,7 +15,7 @@ use thiserror::Error;
 // these types are a copy of the types used in http module of runtime.
 //
 
-/// HTTP Request type that can be shared over WASM boundary to apps.
+/// HTTP Request type that can be shared over Wasm boundary to apps.
 /// This is the one you receive from the `http_server:distro:sys` service.
 #[derive(Debug, Serialize, Deserialize)]
 pub enum HttpServerRequest {
@@ -51,7 +51,7 @@ pub struct IncomingHttpRequest {
     // BODY is stored in the lazy_load_blob, as bytes
 }
 
-/// HTTP Response type that can be shared over WASM boundary to apps.
+/// HTTP Response type that can be shared over Wasm boundary to apps.
 /// Respond to [`IncomingHttpRequest`] with this type.
 #[derive(Debug, Serialize, Deserialize)]
 pub struct HttpResponse {
@@ -287,7 +287,7 @@ impl IncomingHttpRequest {
     }
 }
 
-/// Request type that can be shared over WASM boundary to apps.
+/// Request type that can be shared over Wasm boundary to apps.
 /// This is the one you send to the `http_client:distro:sys` service.
 #[derive(Debug, Serialize, Deserialize)]
 pub enum HttpClientAction {
@@ -306,7 +306,7 @@ pub enum HttpClientAction {
     },
 }
 
-/// HTTP Request type that can be shared over WASM boundary to apps.
+/// HTTP Request type that can be shared over Wasm boundary to apps.
 /// This is the one you send to the `http_client:distro:sys` service.
 #[derive(Debug, Serialize, Deserialize)]
 pub struct OutgoingHttpRequest {
@@ -318,7 +318,7 @@ pub struct OutgoingHttpRequest {
     // TIMEOUT is stored in the message expect_response
 }
 
-/// WebSocket Client Request type that can be shared over WASM boundary to apps.
+/// WebSocket Client Request type that can be shared over Wasm boundary to apps.
 /// This comes from an open websocket client connection in the `http_client:distro:sys` service.
 #[derive(Debug, Serialize, Deserialize)]
 pub enum HttpClientRequest {
@@ -331,7 +331,7 @@ pub enum HttpClientRequest {
     },
 }
 
-/// HTTP Client Response type that can be shared over WASM boundary to apps.
+/// HTTP Client Response type that can be shared over Wasm boundary to apps.
 /// This is the one you receive from the `http_client:distro:sys` service.
 #[derive(Debug, Serialize, Deserialize)]
 pub enum HttpClientResponse {

src/http.rs

@@ -1,4 +1,4 @@
-//! kinode process standard library for Rust compiled to WASM
+//! Kinode process standard library for Rust compiled to Wasm
 //! Must be used in context of bindings generated by `kinode.wit`.
 //!
 //! This library provides a set of functions for interacting with the kinode
@@ -24,6 +24,11 @@ wit_bindgen::generate!({
 
 /// Interact with the eth provider module.
 pub mod eth;
+/// Interact with the system homepage.
+///
+/// Note that your process must have the capability to message
+/// `homepage:homepage:sys` to use this module.
+pub mod homepage;
 /// Interact with the HTTP server and client modules.
 /// Contains types from the `http` crate to use as well.
 pub mod http;
@@ -43,27 +48,19 @@ pub mod timer;
 /// Interact with the virtual filesystem
 pub mod vfs;
 
-// Types
-
-mod package_id;
-pub use package_id::PackageId;
-mod process_id;
-pub use process_id::{ProcessId, ProcessIdParseError};
-mod address;
-pub use address::{Address, AddressParseError};
-mod request;
-pub use request::Request;
-mod response;
-pub use response::Response;
-mod message;
-use message::wit_message_to_message;
-pub use message::{Message, SendError, SendErrorKind};
-mod on_exit;
-pub use on_exit::OnExit;
-mod capability;
-pub use capability::Capability;
-mod lazy_load_blob;
-pub use lazy_load_blob::LazyLoadBlob;
+mod types;
+pub use types::{
+    address::{Address, AddressParseError},
+    capability::Capability,
+    lazy_load_blob::LazyLoadBlob,
+    message::wit_message_to_message,
+    message::{Message, SendError, SendErrorKind},
+    on_exit::OnExit,
+    package_id::PackageId,
+    process_id::{ProcessId, ProcessIdParseError},
+    request::Request,
+    response::Response,
+};
 
 /// Implement the wit-bindgen specific code that the kernel uses to hook into
 /// a process. Write an `init(our: Address)` function and call it with this.
@@ -221,7 +218,7 @@ pub fn get_capability(our: &Address, params: &str) -> Option<Capability> {
         .cloned()
 }
 
-/// get the next message body from the message queue, or propagate the error
+/// Get the next message body from the message queue, or propagate the error
 pub fn await_next_message_body() -> Result<Vec<u8>, SendError> {
     match await_message() {
         Ok(msg) => Ok(msg.body().to_vec()),

src/lib.rs

@@ -122,3 +122,50 @@ where
             valid
         })
 }
+
+/// take a DNSwire-formatted node ID from chain and convert it to a String
+pub fn dnswire_decode(wire_format_bytes: &[u8]) -> Result<String, DnsDecodeError> {
+    let mut i = 0;
+    let mut result = Vec::new();
+
+    while i < wire_format_bytes.len() {
+        let len = wire_format_bytes[i] as usize;
+        if len == 0 {
+            break;
+        }
+        let end = i + len + 1;
+        let mut span = match wire_format_bytes.get(i + 1..end) {
+            Some(span) => span.to_vec(),
+            None => return Err(DnsDecodeError::FormatError),
+        };
+        span.push('.' as u8);
+        result.push(span);
+        i = end;
+    }
+
+    let flat: Vec<_> = result.into_iter().flatten().collect();
+
+    let name = String::from_utf8(flat).map_err(|e| DnsDecodeError::Utf8Error(e))?;
+
+    // Remove the trailing '.' if it exists (it should always exist)
+    if name.ends_with('.') {
+        Ok(name[0..name.len() - 1].to_string())
+    } else {
+        Ok(name)
+    }
+}
+
+#[derive(Clone, Debug, thiserror::Error)]
+pub enum DnsDecodeError {
+    Utf8Error(std::string::FromUtf8Error),
+    FormatError,
+}
+
+impl std::fmt::Display for DnsDecodeError {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+        match self {
+            DnsDecodeError::Utf8Error(e) => write!(f, "UTF-8 error: {}", e),
+            DnsDecodeError::FormatError => write!(f, "Format error"),
+        }
+    }
+}