Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

feat: add api boundary nodes to state tree #248

Merged
Changes from 22 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
73bf472
add api boundary nodes
nikolay-komarevskiy Nov 6, 2023
53169bf
Update spec/index.md
nikolay-komarevskiy Nov 6, 2023
af82f21
Update spec/index.md
nikolay-komarevskiy Nov 6, 2023
2e9413e
Update spec/index.md
nikolay-komarevskiy Nov 6, 2023
338455c
Update spec/index.md
nikolay-komarevskiy Nov 6, 2023
a143caf
extend with pub_key and ip addresses
nikolay-komarevskiy Nov 13, 2023
6519cb5
Update spec/index.md
nikolay-komarevskiy Nov 20, 2023
f627277
Update spec/index.md
nikolay-komarevskiy Dec 15, 2023
e724cbe
Update spec/index.md
nikolay-komarevskiy Dec 15, 2023
84bb693
docs: add comment about empty ipv4_address
nikolay-komarevskiy Feb 1, 2024
6c16a13
docs: correct comment
nikolay-komarevskiy Feb 1, 2024
bcc241d
Update spec/index.md
nikolay-komarevskiy Feb 1, 2024
03064ea
doc: add missing descriptions
nikolay-komarevskiy Feb 1, 2024
c727bab
Update spec/index.md
mraszyk Feb 2, 2024
2904bac
Update spec/index.md
nikolay-komarevskiy Feb 2, 2024
52b9337
Update spec/index.md
nikolay-komarevskiy Feb 2, 2024
20f6476
Update spec/index.md
nikolay-komarevskiy Feb 2, 2024
4131295
Update spec/index.md
nikolay-komarevskiy Feb 2, 2024
939a70e
Update spec/index.md
nikolay-komarevskiy Feb 2, 2024
f85f54f
Update spec/index.md
mraszyk Feb 8, 2024
2c978cd
Update spec/index.md
mraszyk Feb 8, 2024
72e66a4
Merge branch 'master' into add-api-boundary-nodes-to-state-tree
nikolay-komarevskiy Mar 6, 2024
c90bc27
docs: update changelog
nikolay-komarevskiy Mar 6, 2024
a8ffd86
docs: update changelog
nikolay-komarevskiy Mar 6, 2024
8a76e48
Update spec/_attachments/interface-spec-changelog.md
nikolay-komarevskiy Mar 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions spec/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,26 @@ This section specifies the publicly relevant paths in the tree.

All partial state trees include a timestamp, indicating the time at which the state is current.

### Api boundary nodes information {#state-tree-api-bn}

The state tree contains information about all API boundary nodes (the source of truth for these API boundary node records is stored in the NNS registry canister).

- `/api_boundary_nodes/<node_id>/domain` (text)

Domain name associated with a node. All domains are unique across nodes.
Example: `api-bn1.example.com`.

- `/api_boundary_nodes/<node_id>/ipv4_address` (text)
mraszyk marked this conversation as resolved.
Show resolved Hide resolved
nikolay-komarevskiy marked this conversation as resolved.
Show resolved Hide resolved

Public IPv4 address of a node in the dotted-decimal notation.
If no `ipv4_address` is available for the corresponding node, then this path does not exist.
Example: `192.168.10.150`.

- `/api_boundary_nodes/<node_id>/ipv6_address` (text)
mraszyk marked this conversation as resolved.
Show resolved Hide resolved
nikolay-komarevskiy marked this conversation as resolved.
Show resolved Hide resolved

Public IPv6 address of a node in the hexadecimal notation with colons.
Example: `3002:0bd6:0000:0000:0000:ee00:0033:6778`.

### Subnet information {#state-tree-subnet}
nikolay-komarevskiy marked this conversation as resolved.
Show resolved Hide resolved

The state tree contains information about the topology of the Internet Computer.
Expand Down Expand Up @@ -700,6 +720,8 @@ All requested paths must have the following form:

- `/time`. Can always be requested.

- `/api_boundary_nodes`, `/api_boundary_nodes/<node_id>`, `/api_boundary_nodes/<node_id>/domain`, `/api_boundary_nodes/<node_id>/ipv4_address`, `/api_boundary_nodes/<node_id>/ipv6_address`. Can always be requested.
mraszyk marked this conversation as resolved.
Show resolved Hide resolved

- `/subnet`, `/subnet/<subnet_id>`, `/subnet/<subnet_id>/public_key`, `/subnet/<subnet_id>/canister_ranges`, `/subnet/<subnet_id>/metrics`, `/subnet/<subnet_id>/node`, `/subnet/<subnet_id>/node/<node_id>`, `/subnet/<subnet_id>/node/<node_id>/public_key`. Can always be requested.

- `/request_status/<request_id>`, `/request_status/<request_id>/status`, `/request_status/<request_id>/reply`, `/request_status/<request_id>/reject_code`, `/request_status/<request_id>/reject_message`, `/request_status/<request_id>/error_code`. Can be requested if no path with such a prefix exists in the state tree or
Expand Down