Internet Computer Wiki - User contributions [en]

Node Provider Onboarding

2023-07-14T17:03:03Z

NoviSystems: Include instructions to add file hash to proposal. This is now required or the proposal will be voted NO by the DFINITY Foundation trusted neurons.

Learn how to be accepted by the NNS as a Node Provider and onboard your nodes to the IC.

== Requirements ==

* [[Node Provider Machine Hardware Guide]]
* [[Node Provider Networking Guide]]
* [https://www.ledger.com/ Hardware wallet]
* [https://shop.nitrokey.com/shop/product/nkhs2-nitrokey-hsm-2-7/ NitroKey HSM] (Optional, legacy—not recommended)
* 11 ICP (10 of which are to be staked for the NNS proposal deposit)
* Basic understanding of [[Neurons 101|neurons]], [https://internetcomputer.org/docs/current/tokenomics/nns/nns-staking-voting-rewards staking], and [[Governance of the Internet Computer|governance]] proposals. For instance, understanding what it means to stake a neuron for 8 years.

'''Note:''' Please allocate at least 0.5 day for going through the Node Provider NNS registration (steps 1-11). It may even take a couple of days, depending on how quickly the community votes on your NNS proposals. 

Once the Node Provider NNS registration is complete, you can move on to '''step 12: Onboard nodes'''. This step involves you going to the DC and onboarding your nodes. It is much quicker than the Node Provider NNS registration (estimate to spend ~15 minutes per machine). Also, multiple machines can be brought up in parallel.

'''Note that the following steps do not need to be performed on the node machine itself.''' You can complete them on your personal laptop.

== 1. Install the required tools ==
===''' A. Install ic-admin '''===

<code>ic-admin</code> is the tool used to create and submit NNS proposals.

==== MacOS ====
# Retrieve the file <syntaxhighlight lang="shell">
$ curl "https://download.dfinity.systems/ic/7445081734e6d896d090295967d50710975c4f25/openssl-static-binaries/x86_64-darwin/ic-admin.gz" -o - | gunzip > ./ic-admin
$ chmod +x ./ic-admin
</syntaxhighlight>
# Verify the binary <syntaxhighlight lang="shell">
$ diff <(shasum -a 256 ./ic-admin | cut -d' ' -f1) <(echo 3f75026d2f28f171068e332a42c82a2795c93fbf5ab351baef30b30eb901cdba) && echo "ic-admin checksum matches" || echo "***ERROR***: ic-admin checksum does not match"
</syntaxhighlight>

==== Linux ====
NOTE: The instructions below have been tested with the Ubuntu 20.04 release.
# Retrieve the file <syntaxhighlight lang="shell">
$ curl "https://download.dfinity.systems/ic/7445081734e6d896d090295967d50710975c4f25/openssl-static-binaries/x86_64-linux/ic-admin.gz" -o - | gunzip > ./ic-admin
$ chmod +x ./ic-admin
</syntaxhighlight>
# Verify the binary <syntaxhighlight lang="shell">
$ diff <(shasum -a 256 ./ic-admin | cut -d' ' -f1) <(echo e29bb9cc462e800b8b960ad49c412e5f5fdbb5ae2ae9fde0c13058422ba32802) && echo "ic-admin checksum matches" || echo "***ERROR***: ic-admin checksum does not match"
</syntaxhighlight>

===''' B. Install dfx '''===

#<code>dfx</code> is used to generate neuron hotkeys, among other things <syntaxhighlight lang="shell">
$ sh -ci "$(curl -fsSL https://smartcontracts.org/install.sh)"

</syntaxhighlight>
#Verify that dfx is up to date. <syntaxhighlight lang="shell">
$ export PATH=$HOME/bin:$PATH
$ dfx upgrade
$ dfx --version
</syntaxhighlight>

==2. Create Node Provider hotkey ==

#Create an identity for the Node Provider '''Hotkey''' <syntaxhighlight lang="shell">
$ dfx identity new --storage-mode=plaintext node-provider-hotkey

Created identity: "node-provider-hotkey".

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

xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
# example node-provider-hotkey: wuyst-x5tpn-g5wri-mp3ps-vjtba-de3xs-w5xgb-crvek-tucbe-o5rqi-mae

</syntaxhighlight>'''You will need the Node Provider hotkey in the next steps.''' Note: you may be prompted to enter a passphrase when creating your identity and accessing your identity principal. Take note of the passphrase you choose.

'''Note:''' The Node Provider hotkey is NOT the Node Provider principal. This is the hotkey that is used for the NNS proposal submissions only.

== 3. Setup your hardware wallet==

# Setup your hardware wallet: https://medium.com/dfinity/integrating-ledger-nano-with-the-nns-front-end-dapp-user-manual-9c5600925e16

==4. Create and Manage Neuron via NNS Frontend Dapp and Internet Identity==

#Send at least 11 ICPs to your hardware wallet address.
#Navigate to Neurons tab and create a Neuron by staking at least 10 ICP from your hardware wallet. Staking more ICP works as well, but 10 is the minimum.
#IMPORTANT! Confirm the transaction on your hardware wallet.
#:[[File:-docs-stake_neuron_1.png|1024px|stake neuron]]
#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]]
#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|480px|neuron id]]
#You will now see a Neuron listed with its ID. Copy the Neuron ID, since you will need it in the next steps to place the necessary proposals.
#:[[File:Neuron id.png|1024px]]

==5. Add hotkeys==

#Select the Neuron you just created to open Neuron management view and press “Add hotkey” button.
#:[[File:Hotkey 1.png|873x873px]]
# A dialog will pop up where you can enter the hotkey you generated in step 2.1 (output from command <code>dfx --identity node-provider-hotkey identity get-principal</code>). This will allow you to submit NNS proposals using <code>ic-admin</code> and will not be used for anything else. 
#:Press the '''confirm''' button and confirm the transactions on your hardware wallet. 
#:[[File:Hotkey 2.png|899x899px]]
#Get the Ledger Hardware Wallet Principal Id: Navigate back to ICP page and select your Ledger hardware wallet account. You will need to use this Ledger Hardware Wallet principal as the Node Provider principal in order to get the rewards directly into the secure hardware wallet.
#:[[File:Node provider principal 1.png|1024px]]
#:[[File:Node provider principal 2.png|800px]]
#Copy and save this Node Provider principal by clicking on the copy icon after the principal id. You'll need it in the next steps. <syntaxhighlight lang="shell">
$ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
# Input ledger Hardware Wallet principal, from the NNS FrontEnd dapp https://nns.ic0.app/

# example: $ NODE_PROVIDER_PRINCIPAL=fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae
</syntaxhighlight>

==6. Choose onboarding path (HSM vs no HSM)==
Onboarding '''without''' a NitroKey HSM is the recommended onboarding path. If you will not be using a NitroKey HSM, continue to the next step.

If the legacy procedure is necessary, follow the [[NitroKey HSM onboarding instructions]] and '''return to step 9.'''

==7. Setup the Node Operator keys ==
#'''''Ensure dfx is at least version 0.14.''''' Node Operator keys created with older versions of dfx '''will fail to join the IC'''. Run:<syntaxhighlight lang="bash">
$ dfx upgrade
$ dfx --version
</syntaxhighlight>
#Create a new principal with dfx:<syntaxhighlight lang="shell">
$ dfx identity new --storage-mode=plaintext node_operator
</syntaxhighlight>
#Confirm <code>node_operator</code> identity was created successfully:<syntaxhighlight lang="shell">
$ dfx identity list
</syntaxhighlight>This list ''should'' contain <code>node_operator</code>.
#Copy new key to a known location:<syntaxhighlight lang="shell">
$ cp ~/.config/dfx/identity/node_operator/identity.pem ./node_operator_private_key.pem
</syntaxhighlight>
#Check the contents of the <code>node_operator_private_key.pem</code> file and double check that it contains the following contents. It is imperative that the first line has <code>-----BEGIN EC PRIVATE KEY-----</code>. If it does not, make sure you use the latest <code>dfx</code> version and that you followed the instructions precisely.<syntaxhighlight lang="shell">
❯ cat ./node_operator_private_key.pem
-----BEGIN EC PRIVATE KEY-----
[3 lines of base64 encoded private key, e.g. n2Nhp68YcQpuS0u96r...]
-----END EC PRIVATE KEY-----
</syntaxhighlight>

==8. Get the node operator principal==

#Get the principal:<syntaxhighlight lang="shell">
$ NODE_OPERATOR_PRINCIPAL=$(dfx --identity node_operator identity get-principal)
$ echo $NODE_OPERATOR_PRINCIPAL

uqquy-76uhn-2mys5-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
</syntaxhighlight>
'''You will need the node operator principal in the next steps.'''

==9. Register your Node Provider principal to the network==
In the next codeblock:
*Replace the <code>NODE_PROVIDER_NAME</code> value with the name of the entity that will provide the nodes.
*Replace the <code>NODE_PROVIDER_PRINCIPAL</code> value with the Ledger Hardware Wallet principal that you got from the NNS Frontend DAPP (step 5.4)
*Replace the <code>NEURON_ID</code> value with your neuron ID from the NNS Frontend Dapp (step 4.6)

*'''''IMPORTANT:''''' Please make sure that you also update the <code>--summary</code> and include a link to the forum discussion, your company's web page, and/or to another place that can convince the voting community that you are making a legitimate request. You must also include the file hash for the self declaration and proof of identity documents, or the proposal will be rejected. This way you will avoid the community voting NO to your proposal and you losing your staked ICPs.

#Create the Proposal <syntaxhighlight lang="shell">
$ NODE_PROVIDER_NAME="My Company"
$ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
$ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
$ ./ic-admin \
--nns-url https://ic0.app \
-s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
propose-to-add-or-remove-node-provider add \
--proposer $NEURON_ID \
--proposal-title "Register a node provider '${NODE_PROVIDER_NAME}'" \
--summary "Register a node provider '${NODE_PROVIDER_NAME}', in line with the announcement and discussion at <https://forum.dfinity.org/t/...>. The self-declaration documentation is available at <https://wiki.internetcomputer.org/wiki/...> with SHA256 hash <SHA256>." \
--node-provider-pid "$NODE_PROVIDER_PRINCIPAL"
</syntaxhighlight>
#Find the proposal on https://dashboard.internetcomputer.org/governance and '''wait until it is executed before proceeding to next step.'''

==10. Register your datacenter to the network (if necessary)==
#Search for your data center on https://dashboard.internetcomputer.org/centers.
#*If you found the datacenter that is hosting your nodes, remember its ID, and skip the following section. Otherwise, proceed with the registration of a new DC record.
#:[[File:dc_id.png|1041x1041px|alt=]]
===Create a data center record for a new DC===
In the next block of code:
*Replace the <code>NEURON_ID</code> value with your neuron ID from the NNS Frontend Dapp (step 4.6)
*Replace the JSON fields from the <code>–data-centers-to-add</code> argument and their corresponding values in <code>--summary</code>:
**<code>"id"</code> represents the city that your datacenter is in and is formulated as a combination of two letters representing the city 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. Examples:
***dl1 (Dallas, no IDs with “dl” prefix)
***zh10 (Zurich, numbers 0-9 are already registered)
**:[[File:dc_id.png|1024px]]
**<code>"region"</code> 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. Examples:
***North America,US,Florida
***Europe,DE,Bavaria
***Asia,SG,Singapore
**:[[File:datacenter_region.png|1024px]]
**<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:datacenter_owner.png|1024px]]
**<code>"gps"</code> GPS coordinates.
***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:maps.png|310x310px|alt=Getting GPS coordinates|Getting GPS coordinates]]

#Create the proposal: <syntaxhighlight lang="shell">
$ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
$ ./ic-admin \
--nns-url https://ic0.app \
-s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
propose-to-add-or-remove-data-centers \
--summary "Register a Flexential datacenter as dl1 in North America,US,Texas" \
--skip-confirmation \
--proposer $NEURON_ID \
--data-centers-to-add '{
"id": "dl1",
"region": "North America,US,Texas",
"owner": "Flexential",
"gps": [
33.00803, -96.66614
]
}'
</syntaxhighlight>'''Remember to replace all the values of both the arguments <code>–data-centers-to-add</code> and <code>--summary</code>'''
#Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it's executed before proceeding to next step.

==11. Create a node operator record==
In the next codeblock:
*Replace the <code>NEURON_ID</code> value with your neuron ID from the NNS Frontend Dapp (step 4.6).
*Replace the <code>NODE_PROVIDER_PRINCIPAL</code> value with the Ledger Hardware Wallet principal that you got from the NNS Frontend DAPP (step 5.4).
*Replace the <code>NODE_OPERATOR_PRINCIPAL</code> value with your node operator principal (step 8.1).
*Replace the <code>NODE_PROVIDER_NAME</code> value with the name of the entity that will provide the nodes.
*Replace the <code>NODE_ALLOWANCE</code> variable value with number of nodes you are providing.
* Replace the <code>DC_ID</code> variable value with id of your datacenter.

# Create the proposal: <syntaxhighlight lang="shell">
$ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
$ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
$ NODE_OPERATOR_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
$ NODE_PROVIDER_NAME="My Company"
$ NODE_ALLOWANCE=8
$ DC_ID=dl1

$ ./ic-admin \
--nns-url https://ic0.app \
-s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
propose-to-add-node-operator \
$NODE_PROVIDER_PRINCIPAL \
--summary "Node provider '$NODE_PROVIDER_NAME' is adding $NODE_ALLOWANCE nodes in the $DC_ID data center" \
--proposer $NEURON_ID \
--node-operator-principal-id $NODE_OPERATOR_PRINCIPAL \
--node-allowance $NODE_ALLOWANCE \
--dc-id $DC_ID
</syntaxhighlight>
#Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it's executed before proceeding to next step.

==12. Onboard nodes==

# Follow the instructions to onboard new nodes:
#*Gen2 - For NP's onboarding in 2023 and later
#**[[IC-OS Installation Runbook]]
#*Gen1 - For NP's participating in the IC before 2023
#**[[IC OS Installation Runbook - PowerEdge R6525]]
#**[[IC OS Installation Runbook - Supermicro]]

Node Provider Self-declaration

2023-07-06T11:22:30Z

NoviSystems: Change proposal instruction link to the correct page

''This page is work in progress''

This page describes the Node Provider self-declaration process and provides the necessary templates. This process and templates are currently in a draft state and discussed by the community (see forum post). Once the NNS has decided on the expected format, the post and this page will be updated to reflect the NNS decision.

== Motivation ==

In a fully decentralized network, onboarding of a Node Provider is managed entirely by the Network Nervous Systems (NNS). This means that anybody who wants to become a Node Provider needs to submit a proposal that will be voted upon by the community. The main question for the community is: how to decide whether to accept or reject a new Node Provider into the network?

Ultimately, it’s the Node Providers responsibility to convince the community to adopt their proposal to be added as a new Node Provider. With the self-declaration, the Node Provider shall:

* Establish their identity
* Make a statement of good intent

This way, the community will have sufficient information to vote on the Node Provider's onboarding proposal.

== Documents and Templates ==

Before submitting a proposal to become a new Node Provider, the Node Provider shall prepare two kinds of documents. The documents should be delivered as a pdf document, digitally signed.

=== (1) Self-declaration ===

(A) Statement of identity

Entity name: __________________________________________________

Official address and location: _____________________________________

Country: ______________________________________________________

Chamber of Commerce Nr: _______________________________________

(B) Statement of provision of node machines

I hereby guarantee that I shall provide node machines in accordance with the required Hardware Configuration for running the IC Network, as described on the IC wiki (see [[Node Provider Machine Hardware Guide]]).

(C) Statement of good intent

I guarantee to the world that I shall honestly operate the node machines I provide, and that should I behave dishonestly, for example by deliberately interfering with my node machine(s) to prevent them correctly processing ICP protocol messages, in collusion with others or alone, that I will be liable to users of the network, and to other node providers, for any damages caused.

I further declare I am aware that any deliberate interference with a node machine, which causes it to incorrectly process ICP protocol messages, represents a misuse of that hardware, and of any hardware it interacts with, and that in some jurisdictions, that may constitute a crime.

Signature of representatives

___________________

___________________

___________________

=== (2) Identity Proof ===

The Node Provider shall provide proof that the identity(ies) listed in the self-declaration exist in the real world. The proof can be any document that sufficiently proves the identity of the signers of the self-declaration to the community.

== Process ==

Initially, the process is quite manual. Over time, it shall be automated and for convenience be incorporated into dApps running on the IC. For now:

<ol style="list-style-type: decimal;">
<li><blockquote>'''Preparation:''' The Node Provider prepares

* The two kinds of documents listed above in a format that is widely available, e.g. PDF</blockquote>
<ul>
<li><blockquote>Creates a compressed file, e.g. zip file, including these documents and computes the hash.</blockquote></li></ul>
</li>
<li><blockquote>'''Publication:''' The Node Provider uploads the documents to the wikipage [[Node Provider Self Declarations]].</blockquote></li>
<li><blockquote>'''Proposal submission:''' The Node Provider submits a proposal to the NNS asking to be accepted to the network.</blockquote>
<ul>
<li><blockquote>The technical instructions are provided on the [[Node Provider Onboarding]] page.</blockquote></li>
<li><blockquote>The summary of the proposal shall point to the published file (step 2) and list the hash (step 1).</blockquote></li></ul>
</li>
<li><blockquote>'''NNS vote:''' It’s now up to the NNS community to check whether the provided information matches the community’s expectations and to vote on the proposal.</blockquote></li></ol>

Node Provider Self Declarations

2023-06-27T20:56:06Z

NoviSystems: Add node provider self-declaration for NoviSystems, LLC

==== Node Provider Self Declarations ====
[[Marc Johnson]]

[[George Bassadone]]

[[Geodd Pvt Ltd]]

[[Rivram Inc]]

[[InfoObjects Inc]]

[[Zaboo d.o.o.]]

[[Zondax AG]]

[[PindarTechnologyLimited]]

[[Karel Frank]]

[[Icaria_Systems_Pty_Ltd]]

[[Lukas Helebrandt]]

[[Exaion]]

[[User:James Wang|HashQuark]]

[[Marvelous Web3]]

[[HoneyComb Capital]]

[[Ludens LLC]]

[[NoviSystems|NoviSystems, LLC]]

NoviSystems

2023-06-27T20:54:47Z

NoviSystems: Add self-declaration document link

== NoviSystems, LLC Self-Declaration ==
The self-declaration document can be found here: [[:File:Novisystems self-declaration.pdf|File:Novisystems self-declaration.pdf]]

The SHA256 hash of the linked PDF is c3d8ef713908aa1cc170fb07ff402c424ea7b44658a1c9845062c83d2a142506.

==Identity Proof==

Company information can be verified by searching the NYS business entity database for "NoviSystems, LLC."

[https://apps.dos.ny.gov/publicInquiry/ Corporation and Business Entity Search Database]

File:Novisystems self-declaration.pdf

2023-06-24T16:33:20Z

NoviSystems:

Novisystems self-declaration, sha256: c3d8ef713908aa1cc170fb07ff402c424ea7b44658a1c9845062c83d2a142506

File:Novisystems-self-declaration.pdf

2023-06-23T18:34:16Z

NoviSystems:

NoviSystems self-declaration documentation

NoviSystems

2023-06-23T18:32:36Z

NoviSystems: Created page with " ==Identity Proof== Company information can be verified by searching the NYS business entity database: [https://apps.dos.ny.gov/publicInquiry/ Corporation and Business Enti..."

==Identity Proof==

Company information can be verified by searching the NYS business entity database:

[https://apps.dos.ny.gov/publicInquiry/ Corporation and Business Entity Search Database]