= Becoming a Node Provider =

To participate in the Internet Computer network as a [[TODO:%20link|Node Provider]] and receive the rewards for supporting the network.


== Requirements ==

* [https://support.internetcomputer.org/hc/en-us/articles/4402245887764-What-are-the-Hardware-Requirements-to-be-a-Node-Provider- Node Hardware]
* [https://www.ledger.com/ Hardware wallet]
* [https://shop.nitrokey.com/shop/product/nkhs2-nitrokey-hsm-2-7 NitroKey HSM]


== Setup ==

<ol style="list-style-type: decimal;">
<li>Install the required tools
<ol style="list-style-type: decimal;">
<li><code>ic-admin</code> to enable you to create proposals
MacOS:
<ol style="list-style-type: decimal;">
<li>Download ic-admin
<syntaxhighlight lang="shell">$ curl "https://download.dfinity.systems/blessed/ic/0ef2aebde4ff735a1a93efa342dcf966b6df5061/nix-release/x86_64-darwin/ic-admin.gz" -o - | gunzip > ./ic-admin
$ chmod +x ./ic-admin</syntaxhighlight></li>
<li>Verify the binary
<syntaxhighlight lang="shell">$ diff <(sha256sum ./ic-admin | cut -d' ' -f1) <(echo da20f751b705de5a75a370fa9d2c5f09e553abaa8893692104fb260b247d336d)</syntaxhighlight></li>
<li>Verify the version
<syntaxhighlight lang="shell">$ ./ic-admin --version

ic-admin 1.0</syntaxhighlight></li></ol>

Linux:
<ol style="list-style-type: decimal;">
<li>Download ic-admin (TODO: change to same version as above and update sha256sum)
<syntaxhighlight lang="shell">$ curl "https://download.dfinity.systems/blessed/ic/0ef2aebde4ff735a1a93efa342dcf966b6df5061/release/ic-admin.gz" -o - | gunzip > ./ic-admin
$ chmod +x ./ic-admin</syntaxhighlight></li>
<li>Verify the binary
<syntaxhighlight lang="shell">diff <(sha256sum ./ic-admin | cut -d' ' -f1) <(echo c5bf9996dd009d1eeb22c59f77ee881d4044cd8c8a040204bfc95a9b21f085f2)</syntaxhighlight></li>
<li>Verify that the version is 1.0 or greater
<syntaxhighlight lang="shell">$ ./ic-admin --version

ic-admin 1.0</syntaxhighlight></li></ol>
</li>
<li><code>dfx</code> to enable you to generate a neuron hotkey
<ol style="list-style-type: decimal;">
<li>Install dfx
<syntaxhighlight lang="shell">$ sh -ci "$(curl -fsSL https://sdk.dfinity.org/install.sh)"</syntaxhighlight></li>
<li>Verify that the version is 0.8.1 or greater
<syntaxhighlight lang="shell">$ dfx --version

dfx 0.8.1</syntaxhighlight></li></ol>
</li></ol>
</li>
<li>Create a wallet hotkey principal
<syntaxhighlight lang="shell">$ dfx identity new node-provider-hotkey

Creating identity: "node-provider-hotkey".
Created identity: "node-provider-hotkey".

$ dfx --identity node-provider-hotkey identity get-principal

wuyst-x5tpn-g5wri-mp3ps-vjtba-de3xs-w5xgb-crvek-tucbe-o5rqi-mae</syntaxhighlight></li>
<li>Create and Manage Neuron via NNS Dapp and Internet Identity
<ol style="list-style-type: decimal;">
<li>Setup your hardware wallet: https://medium.com/dfinity/integrating-ledger-nano-with-the-nns-front-end-dapp-user-manual-9c5600925e16</li>
<li>Send at least 2 ICPs to the hardware wallet address.</li>
<li>Create a neuron
<ol style="list-style-type: decimal;">
<li>Navigate to Neurons tab and create a Neuron by staking 1 ICP from your hardware wallet, and confirming the transaction on your hardware wallet.
[[File:-docs-stake_neuron_1.png|1024px|stake neuron]]</li>

<li>After the neuron has been created successfully, confirm to add NNS Dapp as hotkey in the dialogue and on your hardware wallet, and close the dialog after the action completes. [[File:-docs-stake_neuron_2.png|1024px|neuron id]]</li>
<li>Set the dissolve delay to at least 6 months, and confirm the choice in the dialogue and on your hardware wallet. After the action completes, you can close the "Follow Neurons"
[[File:dissolve_delay.png|1024px|neuron id]]</li>
<li>You will now see a neuron listed with its ID. You’ll need the neuron ID in the next steps to place the necessary proposals. [[File:dissolve_delay.png|1024px|neuron id]]</li></ol>
</li>
<li>Add a hotkey
<ol style="list-style-type: decimal;">
<li>Select the neuron you just created to open neuron management view and press “Add hotkey” button. [[File:/docs/hotkey_1.png|add hotkey button]]</li>
<li>A dialog will pop up where you can enter the principal you generated in step 2.2. Press the confirm button and confirm the transactions on your hardware wallet. [[File:/docs/hotkey_2.png|confirm hotkey]]</li></ol>
</li>
<li>Get the hardware principal id
<ol style="list-style-type: decimal;">
<li>Navigate back to ICP page and select your hardware wallet account. [[File:/docs/node_provider_principal_1.png|hardware wallet account]]</li>
<li>Here you can get your node provider principal by clicking on the copy icon after the principal id. You’ll need it in the next steps. [[File:/docs/node_provider_principal_2.png|hardware wallet account]]</li></ol>
</li></ol>
</li>
<li>Configure your HSM
<ol style="list-style-type: decimal;">
<li>Install the necessary tools:
MacOS:
<ol style="list-style-type: decimal;">
<li>Download this OpenSC binary: https://github.com/OpenSC/OpenSC/releases/download/0.22.0/OpenSC-0.22.0.dmg</li>
<li>Double click the DMG image that you downloaded and then double click the OpenSC PKG file.</li>
<li>If your system doesn’t allow the installation software from an unidentified developer please follow these steps or contact your system administrator:
<ol style="list-style-type: decimal;">
<li>Choose the Apple menu > System Preferences > click Security and Privacy.</li>
<li>Click the lock Icon to unlock it, then enter an administrator name and password.</li>
<li>Ensure that you’re on the tab named “General”.</li>
<li>You should see the OpenSC app and you should be able to enable its installation by choosing “Open anyway”.</li></ol>
</li>
<li>Click continue and install until the installation is complete.</li></ol>

Linux:
<ol style="list-style-type: decimal;">
<li>Install pcscd and opensc
<syntaxhighlight lang="shell">sudo apt install pcscd opensc</syntaxhighlight></li></ol>
</li>
<li>Setup the HSM
<ol style="list-style-type: decimal;">
<li>Initialize the HSM
<syntaxhighlight lang="shell">sc-hsm-tool --initialize --so-pin 3537363231383830 --pin 648219</syntaxhighlight></li>
<li>Change the HSM so pin
<syntaxhighlight lang="shell">pkcs11-tool --login --login-type so --so-pin 3537363231383830 --change-pin</syntaxhighlight></li>
<li>Create a keypair on the HSM. Enter the default pin 648219 when prompted.
<syntaxhighlight lang="shell">pkcs11-tool -k --key-type EC:prime256v1 --login -d 01</syntaxhighlight></li></ol>
</li>
<li>Get the node operator principal
<ol style="list-style-type: decimal;">
<li>Configure dfx identity (skip this step if you already configured it for an other HSM).
<blockquote>Warning: Depending on your installation, the path to the <code>--hsm-pkcs11-lib-path</code> might be different. You can locate it with the following command:
<syntaxhighlight lang="shell">find / -name opensc-pkcs11.so 2> /dev/null</syntaxhighlight></blockquote>
MacOS:
<syntaxhighlight lang="shell">dfx identity new hsm --hsm-key-id 01 --hsm-pkcs11-lib-path /Library/OpenSC/lib/opensc-pkcs11.so</syntaxhighlight>
Linux:
<syntaxhighlight lang="shell">dfx identity new hsm --hsm-key-id 01 --hsm-pkcs11-lib-path /usr/lib/x86_64-linux-gnu/opensc-pkcs11.so</syntaxhighlight></li>
<li>Get the principal. Enter the default pin 648219 when prompted.
<syntaxhighlight lang="shell">$ echo -n PIN:; read -s DFX_HSM_PIN; export DFX_HSM_PIN; echo; dfx --identity hsm identity get-principal; unset DFX_HSM_PIN

PIN:
uqquy-76uhn-2mys5-xa3j3-oynfv-rrorc-pygn7-dldbd-4dr6n-lbhz7-zqe</syntaxhighlight></li></ol>
</li></ol>
</li>
<li>Register your NP principal to the network
Replace the <code>--proposer</code> argument value with your neuron ID from step 3.1.3., <code>--node-provider-pid</code> with your NP principal from step 3.5.2, and ‘My Company’, with the name of the entity that will provide the nodes.
<syntaxhighlight lang="shell">NODE_PROVIDER_NAME="My Company"
./ic-admin \
--nns-url https://nns.ic0.app \
-s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
propose-to-add-or-remove-node-provider add \
--proposer 13419667327548602649 \
--title "Register '${NODE_PROVIDER_NAME}' node provider" \
--summary "Register a node provider for '${NODE_PROVIDER_NAME}'" \
--node-provider-pid "fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae"</syntaxhighlight>
Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it’s executed before proceeding to next step.</li>
<li>Ensure that your datacenter is registered in the network
<ol style="list-style-type: decimal;">
<li>Search for your data center on https://dashboard.internetcomputer.org/centers. If you found the datacenter that’s hosting your nodes, remember its ID, and skip to step 7. Otherwise, proceed to the next step. [[File:/docs/dc_id.png|dc id]]</li>
<li>Create a data center record
Replace the <code>--proposer</code> argument value with your neuron ID from step 3.1.3. and JSON fields from –data-centers-to-add argument with:
 <code>"id"</code>
The ID should be combination of two letters representing a city that your datacenter is in, and an incrementing number. Search data center IDs on https://dashboard.internetcomputer.org, and find a combination of two letters and a number that’s not yet registered. [[File:/docs/dc_id.png|dc id]]
 Examples:
<ul>
<li>dl1 (Dallas, no IDs with “dl” prefix)</li>
<li>zh10 (Zurich, numbers 0-9 are already registered)</li></ul>

 <code>"region"</code>
Region represents the local region of a datacenter and is formulated as a three-part string divided by commas. The three parts making the string are continent, country code, and region, in the given order. [[File:/docs/datacenter_region.png|datacenter region]]
 Examples:
<ul>
<li>North America,US,Florida</li>
<li>Europe,DE,Bavaria</li>
<li>Asia,SG,Singapore</li></ul>

 <code>"owner"</code> The entity that provides your datacenter facilities. Search https://dashboard.internetcomputer.org for existing data center providers. If there’s match, make sure you use the same exact some name for your datacenter. Otherwise, name the data center owner to your best knowledge. [[File:/docs/datacenter_owner.png|datacenter owner]]
 <code>"gps"</code>
Find your datacenter on https://www.google.com/maps/. Right click on location, and select the GPS coordinates (first item in the menu) in order to copy them.
[[File:/docs/maps.png|thumb|none|alt=Getting GPS coordinates|Getting GPS coordinates]]

<syntaxhighlight lang="shell">$ ./ic-admin \
--nns-url https://nns.ic0.app \
-s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
propose-to-add-or-remove-data-centers \
--skip-confirmation \
--proposer 13419667327548602649 \
--data-centers-to-add '{
"id": "dl1",
"region": "North America,US,Texas",
"owner": "Flexential",
"gps": [
33.00803, -96.66614
]
}'</syntaxhighlight>
Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it’s executed before proceeding to next step.</li></ol>
</li>
<li>Create a node operator record
Replace the <code>--proposer</code> argument value with your neuron ID from step 3.1.3., <code>--dc-id</code> argument with id of your datacenter from step 6, <code>--node-allowance</code> argument with number of nodes you’re providing, <code>--node-operator-principal-id</code> argument with the principal from step 4.3.2, and the first positional argument (<code>fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae</code>) with your node provider principal from step 3.5.2.
<syntaxhighlight lang="shell">$ ./ic-admin \
--nns-url https://nns.ic0.app \
-s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
propose-to-add-node-operator \
fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae \
--proposer 13419667327548602649 \
--node-operator-principal-id uqquy-76uhn-2mys5-xa3j3-oynfv-rrorc-pygn7-dldbd-4dr6n-lbhz7-zqe \
--node-allowance 28 \
--dc-id dl2</syntaxhighlight>
Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it’s executed before proceeding to next step.</li>
<li>Configure firewall rules
Replace the <code>PROPOSER</code> variable value with your neuron ID from step 3.1.3., <code>NODES_IPV6_PREFIX</code> variable value with IPv6 prefix of the network of your nodes, <code>NODE_OPERATOR_PRINCIPAL</code> variable value with the principal from step 4.3.2.
<syntaxhighlight lang="shell">PROPOSER=13419667327548602649
NODES_IPV6_PREFIX=2001:4d78:700:10a::/64
NODE_OPERATOR_PRINCIPAL=uqquy-76uhn-2mys5-xa3j3-oynfv-rrorc-pygn7-dldbd-4dr6n-lbhz7-zqe

NFTABLES=$(./ic-admin --nns-url "https://nns.ic0.app" get-firewall-config | grep "firewall_config" | cut -d':' -f2 | cut -c2- | rev | cut -c2- | rev | xargs printf)
IPV6_PREFIXES=$(./ic-admin --nns-url "https://nns.ic0.app" get-firewall-config | tr -d '\n' | grep -oE 'ipv6_prefixes: \[[^]]+' | cut -d'[' -f2 | tr -d '"' | tr -d ' ' | tr -d '\n'; echo $NODES_IPV6_PREFIX)

./ic-admin \
--nns-url https://nns.ic0.app \
-s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
propose-to-set-firewall-config \
--proposer $PROPOSER \
--summary "Set the firewall rules for node operator ${NODE_OPERATOR_PRINCIPAL}" \
<(echo $NFTABLES) \
- \
$IPV6_PREFIXES</syntaxhighlight>
Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it’s executed before proceeding to next step.</li>
<li>Onboard nodes
<ol style="list-style-type: decimal;">
<li>Follow the instructions to [[TODO:%20link%20to%20the%20new%20wiki%20page%20which%20will%20have%20contents%20of%20these%20two%20docs:%20https://docs.google.com/presentation/d/1H6J3LKkgphKC_GRrBrltEsbWSA3kJcTfkzRt9sTovkc/edit,%20https://docs.google.com/presentation/d/1FSzh_eHIDd0w-YCRfEQSTlfoSSut3IIVoZgj-eiT8Bs|onboard new nodes]].</li>
<li>Verify that all the nodes were successfully onboarded by checking their status on the dashboard is set to either “Up” or “Unassigned”. You can find all your nodes by entering your node provider principal from step 3.5.2. in the search bar. [[File:/docs/onboarded_nodes.png|onboarded nodes]]</li></ol>
</li>
<li>Set the reward configuration for your nodes
Replace the <code>--proposer</code> argument value with your neuron ID from step 3.1.3., <code>--node-operator-id</code> argument with the principal from step 4.3.2, <code><NODE_X_PRINCIPAL></code> placeholders with your node principals from step 9.2., and <code><number-of-nodes></code> placeholder with the number of nodes you listed.
<pre>$ ./ic-admin \
--nns-url https://nns.ic0.app \
-s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
propose-to-update-node-operator-config \
--proposer 13419667327548602649 \
--summary "Set rewards for the following nodes:

* <NODE_1_PRINCIPAL>
* <NODE_2_PRINCIPAL>
* ...
" \
--node-operator-id uqquy-76uhn-2mys5-xa3j3-oynfv-rrorc-pygn7-dldbd-4dr6n-lbhz7-zqe \
--rewardable-nodes '{"type0": <number-of-nodes>}'</pre></li></ol>