From db5731f5f76af4626bb9feeea3ba88ca7032f552 Mon Sep 17 00:00:00 2001 From: hosted-fornet Date: Mon, 30 Dec 2024 15:48:38 -0800 Subject: [PATCH 1/8] fix http_server_and_client page & links --- src/SUMMARY.md | 2 +- src/system/process/extensions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index f0c3aa0e..ee8feea6 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -15,7 +15,7 @@ - [Extensions](./system/process/extensions.md) - [WIT APIs](./system/process/wit_apis.md) - [Networking Protocol](./system/networking_protocol.md) - - [HTTP Server & Client](./system/http-server_and_client.md) + - [HTTP Server & Client](./system/http_server_and_client.md) - [Read+Write to Chain](./system/read_and_write_to_chain.md) - [Files](./system/files.md) - [Databases](./system/databases.md) diff --git a/src/system/process/extensions.md b/src/system/process/extensions.md index 2f00e583..3f04e33e 100644 --- a/src/system/process/extensions.md +++ b/src/system/process/extensions.md @@ -42,7 +42,7 @@ The [examples below](#examples) show some more working extensions. The process [binds a WebSocket](#bind-an-extension-websocket), so Kinode acts as the WebSocket server. The extension acts as a client, connecting to the WebSocket served by the Kinode process. -The process sends [`HttpServerAction::WebSocketExtPushOutgoing`](https://docs.rs/kinode_process_lib/0.9.6/kinode_process_lib/http/server/enum.HttpServerAction.html#variant.WebSocketExtPushOutgoing) Requests to the `http-server`(look [here](../http-server_and_client.md) and [here](../..//apis/http_server.md)) to communicate with the extension (see the `enum` defined at the bottom of this section). +The process sends [`HttpServerAction::WebSocketExtPushOutgoing`](https://docs.rs/kinode_process_lib/0.9.6/kinode_process_lib/http/server/enum.HttpServerAction.html#variant.WebSocketExtPushOutgoing) Requests to the `http-server`(look [here](../http_server_and_client.md) and [here](../..//apis/http_server.md)) to communicate with the extension (see the `enum` defined at the bottom of this section). Table 1: `HttpServerAction::WebSocketExtPushOutgoing` Inputs From 56810344fa8dae4857d0e6d1f20a9583b81df1be Mon Sep 17 00:00:00 2001 From: hosted-fornet Date: Mon, 30 Dec 2024 15:48:55 -0800 Subject: [PATCH 2/8] update getting_started/login --- src/getting_started/login.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/getting_started/login.md b/src/getting_started/login.md index 91f91fd3..2d60cf77 100644 --- a/src/getting_started/login.md +++ b/src/getting_started/login.md @@ -14,10 +14,6 @@ Print out the arguments expected by the binary: ``` $ ./kinode --help - -DOCKER_BUILD_IMAGE_VERSION: none -PACKAGES_ZIP_HASH: 9558ea0e2180aea1afc69cbf055a4da14c51cea67fbff9cfb847533caef301fd - A General Purpose Sovereign Cloud Computing Platform Usage: kinode [OPTIONS] @@ -54,6 +50,8 @@ Options: Maximum number of passthroughs serve as a router (default 0) --soft-ulimit Enforce a static maximum number of file descriptors (default fetched from system) + --process-verbosity + ProcessId: verbosity JSON object [default: ] -h, --help Print help -V, --version @@ -68,6 +66,8 @@ If no `--port` flag is supplied, Kinode will bind to `8080` if it is available,
OPTIONAL: Acquiring an RPC API Key +### Acquiring an RPC API Key + Create a new "app" on [Alchemy](https://dashboard.alchemy.com/apps) for Optimism Mainnet. ![Alchemy Create App](../assets/alchemy-create-app.png) From 638e65bc886744d78ce66c096687786f273dfe44 Mon Sep 17 00:00:00 2001 From: hosted-fornet Date: Mon, 30 Dec 2024 15:49:12 -0800 Subject: [PATCH 3/8] correct "kimap safe" specification --- src/system/process/processes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/system/process/processes.md b/src/system/process/processes.md index 52f34c8d..795bbf92 100644 --- a/src/system/process/processes.md +++ b/src/system/process/processes.md @@ -7,9 +7,9 @@ The Kinode runtime handles message-passing between processes, plus the startup a This section describes the message design as it relates to processes. Each process instance has a globally unique identifier, or `Address`, composed of four elements. -- the publisher's node (containing a-z, A-Z, 0-9, `-`, and `.`) -- the package name (containing a-z, A-Z, 0-9, and `-`) -- the process name (containing a-z, A-Z, 0-9, and `-`). +- the publisher's node (containing a-z, 0-9, `-`, and `.`) +- the package name (containing a-z, 0-9, and `-`) +- the process name (containing a-z, 0-9, and `-`). This may be a developer-selected string or a randomly-generated number as string. - the node the process is running on (often your node: `our` for short). From 368e349a1be4cefe54a55d461b990ca2340066ea Mon Sep 17 00:00:00 2001 From: hosted-fornet Date: Mon, 30 Dec 2024 16:01:30 -0800 Subject: [PATCH 4/8] fix kimap safety: no caps! --- src/cookbook/file_transfer_ui.md | 2 +- src/kit/new.md | 12 ++++++------ src/my_first_app/chapter_1.md | 10 +++++----- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/cookbook/file_transfer_ui.md b/src/cookbook/file_transfer_ui.md index 9f33aa43..dc3406f6 100644 --- a/src/cookbook/file_transfer_ui.md +++ b/src/cookbook/file_transfer_ui.md @@ -611,7 +611,7 @@ const SearchFiles = function() { const handleSearch = () => { if (!searchTerm) return alert('Please enter a node name.'); - if (!searchTerm.match(/^[a-zA-Z0-9-]+\.os$/)) return alert('Invalid node name.'); + if (!searchTerm.match(/^[a-z0-9-]+\.os$/)) return alert('Invalid node name.'); try { fetch(`${import.meta.env.BASE_URL}/files?node=${searchTerm}`, { method: 'GET', diff --git a/src/kit/new.md b/src/kit/new.md index 8f21b43e..7ba86e67 100644 --- a/src/kit/new.md +++ b/src/kit/new.md @@ -10,7 +10,7 @@ kit new foo creates the default template (a Rust chat app with no UI) in the `foo/` directory. -The package name must be "Kimap-safe": contain only a-z, A-Z, 0-9, and `-`. +The package name must be "Kimap-safe": contain only a-z, 0-9, and `-`. ## Example Usage @@ -54,11 +54,11 @@ Create a Kinode template package Usage: kit new [OPTIONS] Arguments: - Path to create template directory at (must contain only a-z, A-Z, 0-9, `-`) + Path to create template directory at (must contain only a-z, 0-9, `-`) Options: - -a, --package Name of the package (must contain only a-z, A-Z, 0-9, `-`) [default: DIR] - -u, --publisher Name of the publisher (must contain only a-z, A-Z, 0-9, `-`, `.`) [default: template.os] + -a, --package Name of the package (must contain only a-z, 0-9, `-`) [default: DIR] + -u, --publisher Name of the publisher (must contain only a-z, 0-9, `-`, `.`) [default: template.os] -l, --language Programming language of the template [default: rust] [possible values: rust] -t, --template