Skip to content

Commit

Permalink
Merge pull request #74 from uqbar-dao/wit-/-net-edits
Browse files Browse the repository at this point in the history
small edits
  • Loading branch information
edgaruncentered authored Jan 18, 2024
2 parents 322e642 + f399c03 commit 3189d3a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
6 changes: 3 additions & 3 deletions src/apis/kinode_wit.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Throughout this book, readers will see references to [WIT](https://component-model.bytecodealliance.org/design/wit.html), the [WebAssembly Component Model](https://github.com/WebAssembly/component-model).
WIT, or Wasm Interface Type, is a language for describing the types and functions that are available to a WebAssembly module.
In conjunction with the Component Model itself, WIT allows for the creation of WebAssembly modules that can be used as components in a larger system.
This standard has been under development for many years, and while still under construction, it's the perfect tool for building an operating-system-like environment for apps built in Wasm.
This standard has been under development for many years, and while still under construction, it's the perfect tool for building an operating-system-like environment for Wasm apps.

Kinode OS uses WIT to present a standard interface for Kinode processes.
This interface is a set of types and functions that are available to all processes.
Expand All @@ -15,9 +15,9 @@ To see exactly how to use WIT to write Kinode processes, see the [My First App](

To see `kinode.wit` for itself, see the [file in the GitHub repo](https://github.com/uqbar-dao/kinode-wit/blob/master/kinode.wit).
Since this interface applies to all processes, it's one of the places in the OS where breaking changes are most likely to make an impact.
To that end, the version of the WIT file that a process uses must be compatible with the version of Kinode OS that it's running on.
To that end, the version of the WIT file that a process uses must be compatible with the version of Kinode OS on which it runs.
We intend to achieve perfect backwards compatibility upon first major release (1.0.0) of the OS and the WIT file.
After that point, since processes signal the version of the WIT file they use, subsequent updates can be made without breaking existing processes needing to change the version they use.
After that point, since processes signal the version of the WIT file they use, subsequent updates can be made without breaking existing processes or needing to change the version they use.

## Types

Expand Down
2 changes: 1 addition & 1 deletion src/apis/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The received `Request`s are handled in one of three ways:
- If the `source.node` is our domain, but the `target.node` is not, the message is sent to the target using the [networking protocol](../networking_protocol.md) implementation.

Let's look at `NetActions`. Note that this message type can be received from remote or local processes.
Different implementations of the networking protocol may reject actions depending on whether they were instigated locally or remotely, and also discriminate on what remote node sent the action.
Different implementations of the networking protocol may reject actions depending on whether they were instigated locally or remotely, and also discriminate on which remote node sent the action.
This is, for example, where a router would choose whether or not to perform routing for a specific node<>node connection.

```rust
Expand Down
1 change: 0 additions & 1 deletion src/apis/uqbar_wit.md

This file was deleted.

0 comments on commit 3189d3a

Please sign in to comment.