View source for Node Deployment config.ini

= node_reward_type Documentation =

The '''node_reward_type''' parameter in the <code>config.ini</code> 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: <code>type1</code>, <code>type1.1</code>, <code>type3</code>, <code>type3.1</code>, etc.

== How to Determine Your node_reward_type ==
1. Use the <code>ic-admin</code> CLI tool to inspect your node operator configuration. For example:
   <pre>ic-admin --nns-url https://ic0.app get-node-operator &lt;your_node_operator_id&gt;</pre>
2. In the output, look for the `rewardable_nodes` field. It might look like:
   <pre>rewardable_nodes: {"type1": 28}</pre>
This means <code>type1</code> 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 <code>ic-admin</code>:
<syntaxhighlight lang="bash">
❯ 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 }
</syntaxhighlight>

Alternatively, you can obtain the node_reward_type that is already set in the registry for the particular DC by using the [https://dfinity.github.io/dre/getting-started.html dre tool]. For instance:

<syntaxhighlight lang="bash">
dre registry --filter=dc_id=<dc_id>
</syntaxhighlight> 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:
* <code>node_reward_type=type1</code>
*<code>node_reward_type=t</code><code>ype1.1</code>
*<code>node_reward_type=</code><code>type3</code>
*<code>node_reward_type=</code><code>type3.1</code>
  
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 <code>node_reward_type</code> 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 <code>node_reward_type</code> in <code>config.ini</code> matches a type listed under <code>rewardable_nodes</code> 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>