README ¶
Getting Started
Requirements
- Create a Coiin Console account
Register Independent Signer From an Installer (Easy Install)
-
Download the latest release of the Raiinmaker Network Validator installer for your OS.
- Note: macOS users should download the file ending in .dmg, while Windows users should download the file ending in .exe
-
Run the installer.
- If you don't see your Public Key after running the installer, try running it again.
- If you don't see your Public Key after running the installer, try running it again.
-
Paste the Public Key from the installer into the Validation Nodes page of the Coiin Console and click Register Node.
- This will associate your Public Key with your Coiin Console account to ensure you get rewarded for mining NVL blocks.
- Lose track of your Public Key? No problem, just the installer again and choose the "Copy your Public Key to the clipboard" option.
-
You're done! The independent signer script will quietly run in the background every 30 minutes to look for new NVL blocks to sign with your Public Key. No need to keep app open.
Register Independent Signer From a Command Line Interface (Technical)
- Download the latest release of the Independent-Signer script for your OS, then follow the instructions below.
Windows
Windows Installation Instructions
-
From the terminal, navigate to the folder where you downloaded the file and execute the independent signer script. The first time will generate a new signing key. Once the new signing key is generated, the Public Key will be printed to the terminal. Copy the Public Key.
-
Navigate to the Register an Independent Node section on the Network Validation Layer Nodes page of the Coiin Console. Paste the Public Key printed in the terminal window from Step 1 into the "Enter Public Key" text box and click the "Register Node" button.
-
After the signing key is generated and the public key is saved to your Coiin Console account, you can run
independent-signer
from the terminal at any time to sign the latest NVL Proxy block and post it to the NVL Proxy.- Note: to make this easy, it is recommended to set up a cron job to execute the
independent-signer
script once every 30 minutes.
- Note: to make this easy, it is recommended to set up a cron job to execute the
Your Public and Signing Keys are saved in:
C:\Users\<Username>\AppData\Roaming\coiin\nvl\independent-signer
Linux and macOS
Linux and macOS Installation Instructions
-
From a web browser, download the Independent Signer script by navigating to: https://github.com/Coiin-Blockchain/nvl-independent-signer/releases
- Select the script for your computer, e.g. independent-signer_darwin_amd64 for macOS users or _independent-signer_linux_amd64 for Linux users
- Save this to a preferred location where it won’t be deleted.
-
Open a new Terminal window (Terminal can be found in the Applications > Utilities folder)
-
Navigate to the directory where you saved the script by typing
cd [the_filepath_you_saved_the_script_to]
-
Or if you're unsure of where to locate the file path you can simply drag and drop the file onto the Terminal and the file path will be shown.
-
Execute the script by typing the filename and pressing return, e.g.
independent-signer_darwin_amd64
-
Note: if you receive an error, you may need to re-permission the script as an executable file by typing:
chmod +x independent-signer_darwin_amd64
and then continue by re-executing step 2a.
-
Or on macOS, you may need to allow the file to be opened by selecting the Apple menu > System Settings, then click Privacy & Security in the sidebar. (You may need to scroll down.) Open Privacy & Security settings. Go to Security, click the pop-up menu next to “Allow applications downloaded from,” then choose the sources from which you’ll allow software to be installed:
-
-
The script will run, generating a Public Key, and will attempt to sign an NVL block, but will fail - that’s ok! You’ll fix that in just a moment by registering your Public Key to your Coiin Console account. For now, just copy the Public Key generated by the script.
-
-
From a web browser, log into the Coiin Console by navigating to: https://coiin.ai/
- Navigate to the Validation Nodes page from the menu
- Under Independent Node Status, paste the Public Key value from your Terminal window into the field “Enter Public Key (generated from NVL script)”
- Click the Register Node button, accept the Terms of Use, and you should see the Node Identity status update to Registered.
-
You’re almost done! Now you just need to run a cron job so that the Independent Signer script automatically runs every 30 minutes and signs each new block created by the NVL. Navigate back to your Terminal window from earlier.
-
Type this command:
crontab -e
-
This will open the cron editor. Now type (shift i), to enter insert mode or vim editor where you can then type the command:
*/30 * * * * [the_filepath_you_saved_the_script_to]
Or if you're unsure of where to locate the file path you can simply drag and drop the file onto the Terminal and the file path will be shown. Make sure you use a space between the last asterisk and file name when you drop the file in.
-
If you're not in command mode (where you can type commands directly into vim), press the Esc key on your keyboard. This ensures you're in command mode. Type the following and press return to save and close the cron editor
:wq
(The :wq command is a combination of two commands: :w (which saves the changes) and :q (which quits the editor).
-
-
That’s it! Now your computer will run the Independent Signer script every 30 minutes, fetching and signing the most recent NVL block from the Coiin blockchain. You can see the latest block that was signed on your coiin console account.
Note: if you lose access to your Coiin Console account and need to reset your password, you will also need to re-register your independent node by first clearing the contents of ~/.config/coiin/nvl/independent-signer and return to Step 2 of the process above to create a new Public Key for your Independent node.
To verify if your crontab is functioning, type this command:
crontab -l
It should read something similar to:
*30/* * * * /Users/~/[the_filepath_you_saved_the_script_to]/independent-signer_darwin_amd64
Your Public and Signing Keys are saved in:
# Linux/Mac
~/.config/coiin/nvl/independent-signer
Build from source
Requirements
Clone source code
mkdir ~/go/src/github.com/Coiin-Blockchain
cd ~/go/src/github.com/Coiin-Blockchain
git clone https://github.com/Coiin-Blockchain/nvl-independent-signer.git
Build cd ~/go/src/github.com/Coiin-Blockchain/nvl-independent-signer go mod tidy go build
Run go run main.go
Copy the Public Key and paste it in the Independent Node Status, in Coiin Console.
Support
Documentation ¶
There is no documentation for this package.