Node Deployment config.ini

From Internet Computer Wiki
Revision as of 17:33, 19 December 2024 by Sat (talk | contribs) (→‎Possible Values)
Jump to: navigation, search

node_reward_type Documentation

The node_reward_type parameter in the config.ini file indicates the specific node type for which the node operator expects to receive rewards. This value must correspond to a recognized and community-approved node type defined in the Network Nervous System (NNS).

What is node_reward_type?

  • It specifies the node’s reward category.
  • The chosen type must be compatible with the configurations listed in the NNS node rewards table.
  • Common examples include: type1, type1.1, type3, type3.1, etc.

How to Determine Your node_reward_type

1. Use the ic-admin CLI tool to inspect your node operator configuration. For example:

ic-admin --nns-url https://ic0.app get-node-operator <your_node_operator_id>

2. In the output, look for the `rewardable_nodes` field. It might look like:

rewardable_nodes: {"type1": 28}

This means type1 is a valid and approved node type for your account.

3. If multiple types are listed, select the one that best matches your node’s intended reward category.

Example invocation with ic-admin:

❯ ic-admin --nns-url https://ic0.app get-node-operator c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae
Using NNS URLs: ["https://ic0.app/"]
Fetching the most recent value for key: node_operator_record_c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae
Most recent version is 44799. Value:
NodeOperator { node_operator_principal_id: c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae, node_allowance: 3, node_provider_principal_id: i7dto-bgkj2-xo5dx-cyrb7-zkk5y-q46eh-gz6iq-qkgyc-w4qte-scgtb-6ae, dc_id: "bu1", rewardable_nodes: {"type0": 0, "type1": 28}, ipv6: None }

Alternatively, you can obtain the node_reward_type that is already set in the registry for the particular DC by using the dre tool. For instance:

dre registry --filter=dc_id=<dc_id>

to get the node operator record associated with the DC. Please replace `<dc_id>` with your DC, e.g. `bu1`.

Possible Values

The NNS Registry configuration determines which types are valid. Examples:

  • node_reward_type=type1
  • node_reward_type=type1.1
  • node_reward_type=type3
  • node_reward_type=type3.1

The set of valid types may change as the community updates NNS configurations. You may get the entire latest reward table list by running:

 ic-admin --nns-urls https://ic0.app get-rewards-table

Or for the particular Node Operator record with:

 ic-admin --nns-url https://ic0.app get-node-operator <node-operator-id>

If you do not set node_reward_type

If node_reward_type is empty, you should not expect to get rewards for the node, after March 2025.

Default value

If left unset or set to an invalid value, the node registration may fail or may succeed but you may not get rewards for the node.

Best Practices

  • Ensure node_reward_type in config.ini matches a type listed under rewardable_nodes for your operator ID.
  • Check the node reward settings for the node operator in case of any problems
  • Check the node reward type at any time by invoking:
 ic-admin --nns-url https://ic0.app get-node <node-id>