package registry.subnet.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Contains the initial DKG transcripts for the subnet and materials to construct a base CUP (i.e. a CUP with no dependencies on previous CUPs or blocks). Such CUP materials can be used to construct the genesis CUP or a recovery CUP in the event of a subnet stall.

• optional InitialNiDkgTranscriptRecord initial_ni_dkg_transcript_low_threshold = 1

  Initial non-interactive low-threshold DKG transcript

• optional InitialNiDkgTranscriptRecord initial_ni_dkg_transcript_high_threshold = 2

  Initial non-interactive high-threshold DKG transcript

• uint64 height = 3

  The blockchain height that the CUP should have

• uint64 time = 4

  Block time for the CUP's block

• bytes state_hash = 5

  The hash of the state that the subnet should use

• optional RegistryStoreUri registry_store_uri = 6

  A uri from which data to replace the registry local store should be downloaded

Per subnet P2P configuration Note: protoc is mangling the name P2PConfig to P2pConfig

Used in: SubnetRecord

• uint32 quadruples_to_create_in_advance = 1

  Number of quadruples to create in advance.

Per subnet config for advert distribution.

Used in: GossipConfig

• uint32 best_effort_percentage = 1

  The subset of peers to broadcast to, specified in percentage. This is only used when the P2P clients mark the advert as requiring best effort distribution. In future, this fixed percentage could be replaced by dynamic computation of the distribution set size, as a function of subnet size. 0 < best_effort_percentage <= 100

Per subnet P2P configuration Note: protoc is mangling the name P2PConfig to P2pConfig

Used in: SubnetRecord

• uint32 max_artifact_streams_per_peer = 1

  max outstanding request per peer MIN/DEFAULT/MAX 1/20/200

• uint32 max_chunk_wait_ms = 2

  timeout for a outstanding request 3_000/15_000/180_000

• uint32 max_duplicity = 3

  max duplicate requests in underutilized networks 1/28/6000

• uint32 max_chunk_size = 4

  maximum chunk size supported on this subnet 1024/4096/131_072

• uint32 receive_check_cache_size = 5

  history size for receive check 1_000/5_000/30_000

• uint32 pfn_evaluation_period_ms = 6

  period for re evaluating the priority function. 1_000/3_000/30_000

• uint32 registry_poll_period_ms = 7

  period for polling the registry for updates 1_000/3_000/30_000

• uint32 retransmission_request_ms = 8

  period for sending a retransmission request

• optional GossipAdvertConfig advert_config = 10

  config for advert distribution. If this field is not specified, the feature is turned off.

Initial non-interactive DKG transcript record

Used in: CatchUpPackageContents

• optional types.v1.NiDkgId id = 1

• uint32 threshold = 2

• repeated bytes committee = 3

• uint64 registry_version = 4

• bytes internal_csp_transcript = 5

Used in: CatchUpPackageContents

• string uri = 1

  / The uri at which the registry store data should be retrieved. The data / must be provided as gzipped tar archive

• string hash = 2

  / A SHA-256, hex encoded hash of the contents of the data stored at the / provided URI

• uint64 registry_version = 3

  / The registry version that should be used for the catch up package contents

Used in: SubnetRecord

• bool ecdsa_signatures = 1

  This feature flag controls, whether canisters of this subnet are capable of issuing threshold ecdsa signatures.

• bool canister_sandboxing = 2

  This feature flag controls whether canister execution happens in sandboxed process or not. It is disabled by default.

• bool http_requests = 3

  This feature flag controls whether canisters of this subnet are capable of performing http(s) requests to the web2.

A list of subnet ids of all subnets present in this instance of the IC.

• repeated bytes subnets = 2

A subnet: A logical group of nodes that run consensus

• repeated bytes membership = 3

• uint64 max_ingress_bytes_per_message = 5

  Maximum amount of bytes per message. This is a hard cap, which means ingress messages greater than the limit will be dropped.

• uint64 unit_delay_millis = 7

  Unit delay for blockmaker (in milliseconds).

• uint64 initial_notary_delay_millis = 8

  Initial delay for notary (in milliseconds), to give time to rank-0 block propagation.

• string replica_version_id = 9

  ID of the Replica version to run

• uint64 dkg_interval_length = 10

  The length of all DKG intervals. The DKG interval length is the number of rounds following the DKG summary.

• optional GossipConfig gossip_config = 13

  Gossip Config

• bool start_as_nns = 14

  If set to yes, the subnet starts as a (new) NNS

• SubnetType subnet_type = 15

  The type of subnet.

• uint64 dkg_dealings_per_block = 16

  The upper bound for the number of dealings we allow in a block.

• bool is_halted = 17

  If `true`, the subnet will be halted: it will no longer create or execute blocks.

• uint64 max_ingress_messages_per_block = 18

  Max number of ingress messages per block.

• uint64 max_block_payload_size = 19

  The maximum combined size of the ingress and xnet messages that fit into a block.

• uint64 max_instructions_per_message = 20

  The maximum number of instructions a message can execute. See the comments in `subnet_config.rs` for more details.

• uint64 max_instructions_per_round = 21

  The maximum number of instructions a round can execute. See the comments in `subnet_config.rs` for more details.

• uint64 max_instructions_per_install_code = 22

  The maximum number of instructions an `install_code` message can execute. See the comments in `subnet_config.rs` for more details.

• optional SubnetFeatures features = 23

  Information on whether a feature is supported by this subnet.

• uint64 max_number_of_canisters = 24

  The number of canisters allowed to be created on this subnet. A value of 0 is equivalent to setting no limit. This also provides an easy way to maintain compatibility of different versions of replica and registry.

• repeated string ssh_readonly_access = 25

  The list of public keys whose owners have "readonly" SSH access to all replicas on this subnet, in case it is necessary to perform subnet recovery.

• repeated string ssh_backup_access = 26

  The list of public keys whose owners have "backup" SSH access to nodes on the NNS subnet to make sure the NNS can be backed up.

• optional EcdsaConfig ecdsa_config = 27

  ECDSA Config

Represents the type of subnet. Subnets of different type might exhibit different behavior, e.g. being more restrictive in what operations are allowed or privileged compared to other subnet types.

Used in: SubnetRecord

• SUBNET_TYPE_UNSPECIFIED = 0

• SUBNET_TYPE_APPLICATION = 1

  A normal subnet where no restrictions are applied.

• SUBNET_TYPE_SYSTEM = 2

  A more privileged subnet where certain restrictions are applied, like not charging for cycles or restricting who can create and install canisters on it.

• SUBNET_TYPE_VERIFIED_APPLICATION = 4

  A subnet type that is like application subnets but can have some additional features.