socialweb.computer

Request and provide VMs on an atproto compute market.

lexicons and xrpc

lexicon

com.fedproxy.temp.xrpc.alias

object

A custom-domain claim: a frame a subscriber sends on its com.fedproxy.temp.xrpc.subscribe socket, as a JSON text frame whose $type is com.fedproxy.temp.xrpc.alias, asking the relay to serve each listed host as that subscriber. The relay answers with one #result (none when hosts is empty). A host is accepted when it is a DNS name (letters, digits and hyphens, at least one dot, at most 253 characters, not an IP address), inside the relay's allowed hosts, not the relay's own hostname or under one of its subscriber bases, not claimed by another live subscriber, and its TXT record _xrpc.<host> holds the subscriber's did:key or its subscriber host <did label>.<relay hostname> (looked up with a 5 s timeout, cached for 1 min). A subscriber holds at most 16 aliases, and at most 16 distinct hosts of one frame are looked at; its aliases are dropped when it disconnects or a new connection of the same DID replaces it. Without an alias, a host whose _xrpc TXT record names a live subscriber is still served as that subscriber.

definitions: #result

fieldtypedescription
hosts *array of string
The host names to claim; each is trimmed, lowercased, stripped of a port, brackets and a trailing dot, and duplicates are skipped.

#result object

The relay's answer to one alias frame, sent on the same socket as a JSON text frame whose $type is com.fedproxy.temp.xrpc.alias#result.

fieldtypedescription
accepted *array of string
The normalized hosts now served as this subscriber (including ones it already held).
rejected *unknown
An object of normalized host to the reason it was refused: too many hosts in one frame, invalid hostname, host not allowed, reserved host, subscriber is gone, claimed by another subscriber, alias limit reached, alias lookup failed, or no matching _xrpc.<host> TXT record.

used in

no page of these docs names it yet.

raw schema: lexicons/com/fedproxy/temp/xrpc/alias.json
{
  "lexicon": 1,
  "id": "com.fedproxy.temp.xrpc.alias",
  "defs": {
    "main": {
      "type": "object",
      "description": "A custom-domain claim: a frame a subscriber sends on its com.fedproxy.temp.xrpc.subscribe socket, as a JSON text frame whose $type is com.fedproxy.temp.xrpc.alias, asking the relay to serve each listed host as that subscriber. The relay answers with one #result (none when hosts is empty). A host is accepted when it is a DNS name (letters, digits and hyphens, at least one dot, at most 253 characters, not an IP address), inside the relay's allowed hosts, not the relay's own hostname or under one of its subscriber bases, not claimed by another live subscriber, and its TXT record _xrpc.<host> holds the subscriber's did:key or its subscriber host <did label>.<relay hostname> (looked up with a 5 s timeout, cached for 1 min). A subscriber holds at most 16 aliases, and at most 16 distinct hosts of one frame are looked at; its aliases are dropped when it disconnects or a new connection of the same DID replaces it. Without an alias, a host whose _xrpc TXT record names a live subscriber is still served as that subscriber.",
      "required": [
        "hosts"
      ],
      "properties": {
        "hosts": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The host names to claim; each is trimmed, lowercased, stripped of a port, brackets and a trailing dot, and duplicates are skipped."
        }
      }
    },
    "result": {
      "type": "object",
      "description": "The relay's answer to one alias frame, sent on the same socket as a JSON text frame whose $type is com.fedproxy.temp.xrpc.alias#result.",
      "required": [
        "accepted",
        "rejected"
      ],
      "properties": {
        "accepted": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The normalized hosts now served as this subscriber (including ones it already held)."
        },
        "rejected": {
          "type": "unknown",
          "description": "An object of normalized host to the reason it was refused: too many hosts in one frame, invalid hostname, host not allowed, reserved host, subscriber is gone, claimed by another subscriber, alias limit reached, alias lookup failed, or no matching _xrpc.<host> TXT record."
        }
      }
    }
  }
}