You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/concepts/reward-programs.rst
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,8 +144,10 @@ Requirements
144
144
- Requirement
145
145
* - **Availability**
146
146
- The node must pass the same tests that :ref:`supernodes <supernode-program>` do, at least during **95%** of the time the **first year**.
147
+
* - **Grace period**
148
+
- Availability tests are allowed to fail **the first 12 days**.
147
149
148
-
**Availability tests will start 24 hours after Symbol's launch**.
150
+
However, the node must be **online within 24 hours of Symbol's launch**.
149
151
* - **Bonded Deposit**
150
152
- At least **500'000** |networkcurrency| must be staked on the node during the whole period.
151
153
* - **Maximum nodes**
@@ -192,8 +194,10 @@ Requirements
192
194
- Requirement
193
195
* - **Availability**
194
196
- Both NIS1 and Symbol nodes must pass the same tests that :ref:`supernodes <supernode-program>` do, at least during **95%** of the time the first **18 months**.
197
+
* - **Grace period**
198
+
- Availability tests are allowed to fail **the first 12 days**.
195
199
196
-
**Availability tests will start 24 hours after Symbol's launch**.
200
+
However, the node must be **online within 24 hours of Symbol's launch**.
197
201
* - **Bonded Deposit**
198
202
- At least **250'000** |networkcurrency| must be staked on the |codename| node during the whole period.
Copy file name to clipboardExpand all lines: source/getting-started/ready-for-symbol-launch.rst
+64-32Lines changed: 64 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
Getting your node ready for Symbol launch
3
3
#########################################
4
4
5
-
This guide shows the steps required to have your node **ready for action**, on |codename|'s launch day. This is important for node owners wanting to benefit from some of the :doc:`Reward Programs <../concepts/reward-programs>`.
5
+
This guide shows the steps required to have your node **ready for action**, during |codename|'s first days. This is important for node owners wanting to benefit from some of the :doc:`Reward Programs <../concepts/reward-programs>`.
6
6
7
-
If you are not planning to run **your own Symbol node**, or do not need to have it running **the day Symbol launches**, you do not need to worry about this guide.
7
+
If you are not planning to run **your own Symbol node**, or to enroll in the :ref:`Early Adoption <early-adoption-node-program>` or :ref:`Ecosystem <ecosystem-node-program>` reward programs, you do not need to worry about this guide.
8
8
9
9
************
10
10
Introduction
@@ -23,9 +23,9 @@ This guide explains:
23
23
Snapshot and launch
24
24
===================
25
25
26
-
As you should be well aware by now, |codename|'s launch will happen in two phases.
26
+
As you should be well aware by now, |codename|'s launch is happenning in two phases.
27
27
28
-
1. **Snapshot**: When the NIS1 chain reaches block height 3'105'500 a **snapshot** of the contents of all NIS1 accounts will be taken. `This is expected to happen on 12 March 2021, at around 03:50 UTC <https://nem.io/#symbol-countdown>`__.
28
+
1. **Snapshot**: When the NIS1 chain reached block height 3'105'500 a **snapshot** of the contents of all NIS1 accounts was taken.
29
29
30
30
2. **Launch**: Afterwards, on March 15th (exact time to be determined), the new |codename| network will **launch** meaning that the nodes managed by NEM Group will be brought online and they will start adding blocks to the shinny new |codename| blockchain.
31
31
@@ -35,23 +35,44 @@ These two concepts are used throughout this guide.
35
35
Enrolling
36
36
*********
37
37
38
-
If you want to participate in either the :ref:`early-adoption-node-program` or the :ref:`ecosystem-node-program` you need to enroll in them **before the snapshot**. This section explains how to do this.
38
+
.. warning:: Enrollment to the :ref:`Early Adoption <early-adoption-node-program>` and :ref:`Ecosystem <ecosystem-node-program>` reward programs is now **closed**.
39
39
40
-
If you are interested only in the :ref:`supernode-program` or the :ref:`voting-node-program` (or if you are not interested in any of the reward programs) you don't need to enroll beforehand so you can skip this section and jump to :ref:`getting-ready-launching-your-node`.
40
+
If you wanted to participate in either of these programs you needed to enroll in them **before the snapshot**. This section explains how to **update your node information**, as there is a **12-day grace period** to have the node fully configured and functional.
41
+
42
+
If you are interested only in the :ref:`supernode-program` or the :ref:`voting-node-program` (or if you are not interested in any of the reward programs) you didn't need to enroll beforehand so you can skip this section and jump to :ref:`getting-ready-launching-your-node`.
41
43
42
44
.. _getting-ready-prerequisites:
43
45
44
46
Prerequisites
45
47
=============
46
48
47
-
- You must have a `NIS1 <https://nemplatform.com/>`__ account. `NIS1 <https://nemplatform.com/>`__ is NEM's current blockchain, which is used in this process to **register all requests** before |codename|'s launch. The easiest way to create an account is through the `NEM Desktop Client <https://nemplatform.com/wallets/#desktop>`__ (also known as the **NEM Nano Wallet**) and click the ``SIGN UP`` button at the top-right.
49
+
Since you are already enrolled in one of the Reward Programs, you should already have:
50
+
51
+
- An **opted-in** `NIS1 <https://nemplatform.com/>`__ account, that held at least **10'000 XEMs** at the snapshot block height (3'105'500).
52
+
- A Paper Wallet with the information of your new Symbol account, obtained during opt-in.
53
+
- Sent an enrollment request before the snapshot.
54
+
55
+
.. _getting-ready-grace-period:
56
+
57
+
Grace period
58
+
============
59
+
60
+
.. warning:: All nodes that enrolled in either the :ref:`Early Adoption <early-adoption-node-program>` or :ref:`Ecosystem <ecosystem-node-program>` reward programs are expected to be **online** within 24 hours of |codename|'s launch.
48
61
49
-
- Your NIS1 account must be **opted-in**. The `opt-in process <https://nemplatform.com/symbol-migration/#acc-tb_mrzh282-5>`__ creates a new |codename| account that will receive a copy of the NIS1 account's **tokens** once |codename| launches. Again, the easiest way to do this is through the **Nano Wallet's opt-in module** (Click on the ``Services`` tab and select ``Symbol Opt In``).
62
+
However, there is a **12-day grace period** (until March 27th) during which:
50
63
51
-
- Make sure you obtain a **Paper Wallet** for the new |codename| account, or, at least, take note of the **mnemonic phrase**.
52
-
- Do not opt-in the **VRF keys**, the process has changed and they are registered post-launch now (there is no problem if you already opted them in).
64
+
- The node **availability test** are allowed to fail (These are the same tests as for the :ref:`supernode-program`).
65
+
- Your **enrollment information** can be updated in case you made a mistake.
53
66
54
-
- Your NIS1 account must hold at least **10'000 XEMs** at the snapshot block height (3'105'500). :ref:`Only accounts holding this amount of XYMs can harvest <account_eligibility>` on the |codename| network so only accounts holding this amount at the snapshot can benefit from the Reward Programs.
67
+
The rest of this section is a reminder of how to submit the enrollment request.
68
+
69
+
Updating the request
70
+
====================
71
+
72
+
You can update your enrollment information as many times as you need by:
73
+
74
+
- **Sending another NIS1 transaction** (as described below) **from the same account** as you did initially.
75
+
- Tell `NEM's Telegram Help Desk <https://t.me/nemhelpdesk>`__ about the update.
55
76
56
77
Enrollment request
57
78
==================
@@ -91,13 +112,23 @@ Detailed instructions for the Nano Wallet follow, but this is the summary:
91
112
92
113
Replace ``SYMBOL_ACCOUNT_PUBLIC_KEY`` with the **public key** of the new |codename| account you received when you opted-in. **Read the next subsection to know how to obtain it**.
93
114
94
-
Replace ``SYMBOL_NODE_HOST`` with the public host (hostname or IP address) of your **Symbol node**. If you don't know it yet, you can leave it blank and **send another transaction during the first 24 hours after launch**. The new host will be used.
115
+
Replace ``SYMBOL_NODE_HOST`` with the public host (hostname or IP address) of your **Symbol node**.
95
116
96
117
Replace ``NIS1_NODE_HOST`` with the public host (hostname or IP address) of a **NIS1 node** you own (only for the Ecosystem program).
97
118
98
119
.. note::
99
120
100
-
If you are not planning to use the standard port for the monitoring agent (7880) you can add an ``"ap":PORT_NUMBER`` line to the registration message.
121
+
If you are not using the standard port for the monitoring agent (7880) you can add an ``"ap":PORT_NUMBER`` line to the registration message. For example:
122
+
123
+
.. code-block:: json
124
+
125
+
{
126
+
"type":10,
127
+
"p":"earlyadoption",
128
+
"d":"SYMBOL_ACCOUNT_PUBLIC_KEY",
129
+
"sh":"SYMBOL_NODE_HOST",
130
+
"ap":7881
131
+
}
101
132
102
133
.. _getting-ready-node-public-key:
103
134
@@ -162,7 +193,7 @@ Obviously the wallet will not be **fully operative** until |codename| launches,
162
193
:class:with-shadow
163
194
:target:/_images/mnemonic-to-pubkey-wallet-5.png
164
195
165
-
7. You will be taken to the wallet's **main screen**. Do not worry about the balance shown as the snapshot hasn't taken place yet. Select the ``Accounts`` tab on the left:
196
+
7. You will be taken to the wallet's **main screen** (The balance shown might not be accurate until |codename| launches). Select the ``Accounts`` tab on the left:
@@ -196,7 +227,7 @@ Obviously the wallet will not be **fully operative** until |codename| launches,
196
227
:class:with-shadow
197
228
:target:/_images/mnemonic-to-pubkey-wallet-9.png
198
229
199
-
This hexadecimal string (64-characters long) is the |codename| account's private key that you need to configure your node in the next section. **Paste the key into a temporary file for later use**.
230
+
This hexadecimal string (64-characters long) is the |codename| account's **private key** that you need to configure your node in the next section. **Paste the key into a temporary file for later use**.
200
231
201
232
Send the transaction
202
233
====================
@@ -212,7 +243,7 @@ Your enrollment message should now look something like this (depending on the ch
212
243
"sh":"my-symbol-node.com"
213
244
}
214
245
215
-
Remember that **if you don't know your host name yet**, you can leave it blank (``"sh":""``) and send another transaction during the first 24 hours after launch to update it.
246
+
Remember that **if you don't know your host name yet**, you can leave it blank (``"sh":""``) and send another transaction during the grace period to update it.
216
247
217
248
.. note:: Paste the message into a `JSON Validator <https://jsonformatter.curiousconcept.com>`__ to ensure it is correctly formatted.
218
249
@@ -225,7 +256,7 @@ This is how the Nano Wallet looks like after you fire it up:
@@ -241,31 +272,27 @@ Click on the **LOGIN** button at the top-right and then follow these instruction
241
272
242
273
Once the transaction is announced and accepted, **your enrollment is complete**.
243
274
244
-
The next section explains how to setup your node so that it is ready to harvest on day one, as required by the Early Adoption and Ecosystem programs.
275
+
.. note:: Don't forget to tell `NEM's Telegram Help Desk <https://t.me/nemhelpdesk>`__ about the update!.
276
+
277
+
The next section explains how to setup your node so that it is ready to harvest as soon as possible, as required by the Early Adoption and Ecosystem programs.
245
278
246
279
.. _getting-ready-launching-your-node:
247
280
248
281
*******************
249
282
Launching your node
250
283
*******************
251
284
252
-
Nodes can register as :doc:`harvester <../guides/harvesting/index>`, :ref:`supernodes <supernode-program>` or :ref:`voting nodes <voting-node-program>` **at any time**.
253
-
254
-
**However**, to participate in either the :ref:`early-adoption-node-program` or the :ref:`ecosystem-node-program` your node needs to become online during **the first 24 hours after Symbol's launch**.
285
+
Nodes can register as :doc:`harvesters <../guides/harvesting/index>`, :ref:`supernodes <supernode-program>` or :ref:`voting nodes <voting-node-program>` **at any time**.
255
286
256
-
More specifically, **before the Symbol blockchain reaches block 2880**.
287
+
**However**, to participate in either the :ref:`early-adoption-node-program` or the :ref:`ecosystem-node-program` your node needs to:
257
288
258
-
This section explains how to start your node **during the first day after the launch**, either **using Symbol Bootstrap** or **manually**.
289
+
- Become online during **the first 24 hours after Symbol's launch**.
290
+
- Start passing all **availability tests** during the `grace period <getting-ready-grace-period>`_.
259
291
260
-
.. warning:: Follow these instructions only after |codename|'s launch.
261
-
262
-
Using symbol-bootstrap
263
-
======================
292
+
This section explains how to start your node **once the Symbol network is up and running**, using the Symbol Bootstrap tool.
264
293
265
294
1. **Install the latest version** using the method described in :doc:`../guides/network/using-symbol-bootstrap`.
266
295
267
-
The day |codename| launches, a new version of Symbol Bootstrap will be made available containing the necessary configuration to connect to the new network.
268
-
269
296
2. **Create a custom preset file**.
270
297
271
298
You need to create a :ref:`custom preset file <symbol-bootstrap-presets>` for Symbol Bootstrap so it **uses the account you opted-in** instead of creating a new one.
@@ -314,9 +341,14 @@ Using symbol-bootstrap
314
341
315
342
.. code-block:: bash
316
343
317
-
symbol-bootstrap link --useKnownRestGateways
344
+
symbol-bootstrap link
318
345
319
346
This will announce a few link transactions (there's a :doc:`fee <../concepts/fees>` involved) and your node will become fully configured.
320
347
321
-
Manually
322
-
========
348
+
************
349
+
Verification
350
+
************
351
+
352
+
Browse to `Symbol Explorer <http://explorer.symbolblockchain.io/>`__, locate your node, and check that all information is correct.
353
+
354
+
You should be able to see a lot of information (including the node's name and URL, for example), and, if it is enrolled in any reward program, a special card stating the program's name and the latest availability test results.
0 commit comments