arc.bend checks

raw source on the hub · import 0x9f92cb8772365b4bb8ff68d6c9c517e9/arc.bend as Arc

1 import

import Base

Types

type NodeRole source · line 12 · raw

Data

---- vocabulary ---- UserDevice: a user's own device. Server: a machine the project runs. Overlay: the private (overlay) network between them. Outside: someone else's servers.

UserDevice
```
NodeRole
```
Server
```
NodeRole
```
Overlay
```
NodeRole
```
Outside
```
NodeRole
```

type Node source · line 18 · raw

Data

Node

@key:String -> @name:String -> @role:NodeRole -> Node

type ContainerKind source · line 28 · raw

Data

What a container is. The list is closed: something that is none of these is not a container. Client: the app, on the user's device. The private overlay is a node, not a container. DataApi: answers queries on records and changes them. Harness: an agent harness, the loop around a model (tools, context, threads), driven over its remote-control API. Proxy: forwards connections to another container, adding what it lacks, such as TLS or authentication. ModelApi: answers model calls. Cli: a command a person runs. Worker: has no API of its own; it only moves data between data APIs, so it is the first thing to fold into a data API's own actions.

Client
```
ContainerKind
```
DataApi
```
ContainerKind
```
Harness
```
ContainerKind
```
Proxy
```
ContainerKind
```
ModelApi
```
ContainerKind
```
Cli
```
ContainerKind
```
Worker
```
ContainerKind
```

type Owner source · line 38 · raw

Data

Whether the project builds and runs it, or uses it as it is.

Ours
```
Owner
```
Theirs
```
Owner
```

type Exposure source · line 43 · raw

Data

Who can reach it: its own machine (127.0.0.1), the local network, the overlay, the device it is on, anyone.

Local
```
Exposure
```
Lan
```
Exposure
```
Tailnet
```
Exposure
```
Device
```
Exposure
```
Public
```
Exposure
```

type Cap source · line 52 · raw

Data

What a container provides. Hosting is serving the app itself (its HTML and scripts); a data API may also host the app only while it is private (shared_hosting_ok).

Hosting
```
Cap
```
PrivateHosting
```
Cap
```
Realtime
```
Cap
```
BlobStore
```
Cap
```

type Lang source · line 58 · raw

Data

Bend
```
Lang
```
C
```
Lang
```
Rust
```
Lang
```
TypeScript
```
Lang
```
JavaScript
```
Lang
```
Python
```
Lang
```
Opaque
```
Lang
```

type Container source · line 67 · raw

Data

Container

@key:String -> @name:String -> @kind:ContainerKind -> @owner:Owner -> @on:String -> @exposure:Exposure -> @caps:List<&2, Cap> -> @technology:List<&2, String> -> Container

type Part source · line 70 · raw

Data

Part

@key:String -> @name:String -> @lang:Lang -> @in:String -> Part

type Link source · line 74 · raw

Data

A talks-to edge between two containers or parts, by key.

Link

@src:String -> @dst:String -> @label:String -> @live:Bool -> Link

type System source · line 77 · raw

Data

System

@nodes:List<&2, Node> -> @containers:List<&2, Container> -> @parts:List<&2, Part> -> @links:List<&2, Link> -> System

Definitions

def nodes source · line 81 · raw

@s:System -> List<&2, Node>

---- access ----

def containers source · line 86 · raw

@s:System -> List<&2, Container>

def parts source · line 91 · raw

@s:System -> List<&2, Part>

def links source · line 96 · raw

@s:System -> List<&2, Link>

def nkey source · line 101 · raw

@n:Node -> String

def ckey source · line 106 · raw

@c:Container -> String

def con source · line 111 · raw

@c:Container -> String

def caps source · line 116 · raw

@c:Container -> List<&2, Cap>

def pkey source · line 121 · raw

@p:Part -> String

def pin source · line 126 · raw

@p:Part -> String

def nkeys source · line 131 · raw

@xs:List<&2, Node> -> List<&2, String>

def ckeys source · line 138 · raw

@xs:List<&2, Container> -> List<&2, String>

def pkeys source · line 145 · raw

@xs:List<&2, Part> -> List<&2, String>

def keys source · line 153 · raw

@+s:System -> List<&2, String>

Keys links may name: containers and parts.

def is_server source · line 157 · raw

@r:NodeRole -> Bool

---- predicates on the vocabulary ----

def is_outside source · line 164 · raw

@r:NodeRole -> Bool

def is_device source · line 171 · raw

@r:NodeRole -> Bool

def is_overlay source · line 178 · raw

@r:NodeRole -> Bool

def one_if source · line 185 · raw

@b:Bool -> Nat

def overlay_nodes.go source · line 192 · raw

@xs:List<&2, Node> -> Nat

def overlay_nodes source · line 202 · raw

@+s:System -> Nat

Private access is represented by exactly one Overlay node.

def is_client source · line 205 · raw

@k:ContainerKind -> Bool

def is_data_api source · line 212 · raw

@k:ContainerKind -> Bool

def is_ours source · line 219 · raw

@o:Owner -> Bool

def is_local source · line 226 · raw

@e:Exposure -> Bool

def is_tailnet source · line 233 · raw

@e:Exposure -> Bool

def is_rust source · line 240 · raw

@l:Lang -> Bool

def str_eq source · line 248 · raw

@a:String -> @b:String -> Bool

---- keys, like foreign keys ----

def has source · line 251 · raw

@+s:String -> @xs:List<&2, String> -> Bool

def pick_str source · line 258 · raw

@c:Bool -> @a:String -> @b:String -> String

def distinct_keys source · line 266 · raw

@xs:List<&2, String> -> Bool

No key names two things.

def all_in source · line 274 · raw

@xs:List<&2, String> -> @+ks:List<&2, String> -> Bool

Every key in xs names something in ks.

def part_ins source · line 281 · raw

@xs:List<&2, Part> -> List<&2, String>

def container_ons source · line 288 · raw

@xs:List<&2, Container> -> List<&2, String>

def link_ends source · line 295 · raw

@xs:List<&2, Link> -> List<&2, String>

def well_formed source · line 306 · raw

@+s:System -> Bool

The system is well formed: node keys and container/part keys are unique, every container is on a node, every part in a container, and every link joins two things that exist.

def part_home source · line 313 · raw

@+k:String -> @xs:List<&2, Part> -> String

---- looking things up ----

def home source · line 321 · raw

@+k:String -> @+s:System -> String

The container a key belongs to: itself, or the one its part sits in.

def none source · line 324 · raw

Container

def pick_c source · line 327 · raw

@hit:Bool -> @c:Container -> @other:Container -> Container

def container source · line 335 · raw

@+k:String -> @xs:List<&2, Container> -> Container

The container with key k (an empty one when k is unknown; well_formed rules that out).

def pick_r source · line 342 · raw

@hit:Bool -> @r:NodeRole -> @other:NodeRole -> NodeRole

def node_role source · line 349 · raw

@+k:String -> @xs:List<&2, Node> -> NodeRole

def node_of source · line 359 · raw

@+k:String -> @+s:System -> String

The node a container or part runs on, and its role.

def role_of source · line 362 · raw

@+k:String -> @+s:System -> NodeRole

def container_exposure source · line 365 · raw

@c:Container -> Exposure

def exposure_of source · line 370 · raw

@+k:String -> @+s:System -> Exposure

def private_ok source · line 375 · raw

@c:Container -> @+ns:List<&2, Node> -> Bool

---- where it runs ---- On a server, everything is reachable only from the server itself or over the overlay.

def all_private source · line 380 · raw

@xs:List<&2, Container> -> @+ns:List<&2, Node> -> Bool

def servers_private source · line 387 · raw

@+s:System -> Bool

def devices_via_network.go source · line 391 · raw

@xs:List<&2, Link> -> @+s:System -> Bool

A device reaches a server over the overlay only when the destination is exposed to the tailnet.

def devices_via_network source · line 401 · raw

@+s:System -> Bool

def is_cap source · line 405 · raw

@want:Cap -> @c:Cap -> Bool

---- what it is: minimality, every capability provided exactly once ----

def count_in source · line 418 · raw

@+want:Cap -> @cs:List<&2, Cap> -> Nat

def direct source · line 425 · raw

@+want:Cap -> @xs:List<&2, Container> -> Nat

def tailnet_hosting.go source · line 432 · raw

@xs:List<&2, Container> -> Nat

def tailnet_hosting source · line 442 · raw

@+s:System -> Nat

How many containers host the app at Tailnet exposure.

def provided source · line 446 · raw

@want:Cap -> @+s:System -> Nat

How many containers provide want. One tailnet host plus one overlay composes private hosting.

def tailnet_data_apis.go source · line 453 · raw

@xs:List<&2, Container> -> Nat

def tailnet_data_apis source · line 463 · raw

@+s:System -> Nat

The data APIs the overlay reaches: the client's data API. Local and outside ones are its sources.

def own_data_apis.go source · line 466 · raw

@xs:List<&2, Container> -> @+ns:List<&2, Node> -> Nat

def own_data_apis source · line 476 · raw

@+s:System -> Nat

The system's own data APIs: those not on someone else's servers. "Exactly one" means one store.

def shared_hosting_ok source · line 480 · raw

@c:Container -> Bool

A data API may also host the app only while it is private.

def shared_hosting_private.go source · line 485 · raw

@xs:List<&2, Container> -> Bool

def shared_hosting_private source · line 492 · raw

@+s:System -> Bool

def backend source · line 496 · raw

@c:Container -> Bool

---- a goal: every part of our own non-client containers is Rust ----

def rust_ok source · line 501 · raw

@p:Part -> @+s:System -> Bool

def all_rust.go source · line 506 · raw

@xs:List<&2, Part> -> @+s:System -> Bool

def all_rust source · line 513 · raw

@+s:System -> Bool

def container_ours source · line 517 · raw

@c:Container -> Bool

Every modeled part belongs to a container we build; someone else's program is a black box.

def parts_ours.go source · line 522 · raw

@xs:List<&2, Part> -> @+s:System -> Bool

def parts_ours source · line 529 · raw

@+s:System -> Bool

def path source · line 533 · raw

@+k:String -> @+s:System -> String

---- the diagram (D2): nodes as boxes, containers inside their node, parts inside their container ----

def node_box source · line 536 · raw

@n:Node -> String

def node_boxes source · line 545 · raw

@xs:List<&2, Node> -> String

def technology_label source · line 552 · raw

@xs:List<&2, String> -> String

def container_box source · line 559 · raw

@c:Container -> String

def container_boxes source · line 564 · raw

@xs:List<&2, Container> -> String

def part_box source · line 571 · raw

@p:Part -> @+s:System -> String

def part_boxes source · line 576 · raw

@xs:List<&2, Part> -> @+s:System -> String

def style source · line 583 · raw

@live:Bool -> String

def edges source · line 590 · raw

@xs:List<&2, Link> -> @+s:System -> String

def d2 source · line 599 · raw

@+s:System -> String