Mining Guide for RecordsKeeper Blockchain on Mac

The following document helps the users to initiate mining the RecordsKeeper blockchain on a Mac operating system. All the commands and processes displayed in this document have been tested and created on Mac OS X 10.12 and above. The detailed overview to start mining for RecordsKeeper blockchain is as follows:

System Requirements

  • Mac: 64-bit, supports OS X 10.12 (we hope to support earlier versions soon).
  • 512 MB of RAM
  • 1 GB of disk space

Installing RecordsKeeper on Mac OS:

First, install these dependencies by executing the following commands:

Install XCode and XCode command line tools
Install git from git-scm
Install brew (follow instructions on brew.sh)
brew install autoconf automake berkeley-db4 libtool [email protected] openssl pkg-config rename
brew link [email protected] --force

To download the executable directly from the browser click here .

Unzip the zip file and then move to the location of the downloaded files and run the following commands from your terminal:

cd recordskeeper-mac-osx-1.0.0
mv rkd rk-cli rk-util /usr/local/bin

Moving the RecordsKeeper files to the bin directory makes them easily accessible from the command line anywhere.

Note

  • If you get an error, then run the above commands using “sudo” for root privileges
  • Use exit command (to return to your regular user)
  • Mac users move directly to the connecting-rk section

Connecting to RecordsKeeper Blockchain on Mac

The RecordsKeeper Testnet blockchain is available for users to develop and deploy applications on the RecordsKeeper blockchain. XRK Testnet tokens do not hold any value and are only available for testing. You can earn XRK tokens from RecordsKeeper Mainnet mining.

Now, to connect to the RecordsKeeper blockchain, run the following command from the terminal:

RecordsKeeper Testnet

./rkd [email protected]:8379

RecordsKeeper Mainnet

./rkd [email protected]:7895

This command will initialize your node.

And, if you want your connection to remain active as a background process, then run this command:

RecordsKeeper Testnet

./rkd [email protected]:8379 -daemon

RecordsKeeper Mainnet

./rkd [email protected]:7895 -daemon

In case of an error message like this:

Warning

Error: Couldn’t initialize permission database for blockchain recordskeeper. Probably rkd for this blockchain is already running. Exiting…

First, kill the daemon process, and then try connecting to the RecordsKeeper blockchain again. If the problem persists, restart your computer and then repeat the whole process of connecting to the RecordsKeeper blockchain again.

Note

*Mac users now go to the mining-permissions section

Mining Permissions

Connecting RecordsKeeper on Mac

You will see the following message on your Mac command line terminal after you execute the command to connect to the RecordsKeeper blockchain.

_images/MacRKD.png

RecordsKeeper Permissions

RecordsKeeper Testnet

The mining for RecordsKeeper Testnet is open to everyone, so when you connect to the RecordsKeeper Testnet, you will receive all the permissions for your default address

RecordsKeeper Mainnet

For Mainnet, when your node gets connected, you will receive the permissions to connect, send, and receive. Now, look for your default XRK address from the command given below, which will display your node’s wallet address. This address is your “default XRK address” or “public address” of the RecordsKeeper blockchain in which you will receive XRK tokens. To check the address, run the following command:

./rk-cli recordskeeper getaddresses

Submit the following to receive Mining Permissions for RecordsKeeper Mainnet.

Note

Copy the above generated address and send it to us here .

Only after the RecordsKeeper team grant mining permissions to your node address will you be able to mine XRK tokens into your default address.

To retrieve the private key for your node address, run this command:

./rk-cli recordskeeper dumpprivkey {default_XRK_address}

Note

Please store this private key safely. Losing it will result in the loss of XRK tokens.

After completing the above process, you can check for your node’s information (best block and synced block) by running the following commands:

./rk-cli recordskeeper getinfo
./rk-cli recordskeeper getblockchaininfo

Your node will sync with the best block, and then your node can start mining and your balance will get updated with the mined XRK tokens.

In case you have entered the wrong IP address, then it will report this error:

Warning

Error: Couldn’t initialize permission database for blockchain recordskeeper. Probably rkd for this blockchain is already running. Exiting…

Please check the IP address and port properly to connect to the RecordsKeeper blockchain.

Note

If you have already created a wallet address and you want to add it as your miner address, then run this command from the command line terminal:

./rk-cli recordskeeper importprivkey {private_key}

Connecting to RecordsKeeper Blockchain after Permissions

Once the permissions for RecordsKeeper Mainnet have been granted, you can directly connect to the RecordsKeeper chain and see your mining progress. You can run the following commands to connect to the RecordsKeeper blockchain and view the mining address.

As the IP configuration was already stored with you when you initiated the connection, you can directly run the following command:

rkd recordskeeper -daemon
_static/MacRKAfterMining.jpg

You can run the getinfo command or getaddressbalances command to see the balance in your node or the node address.

rk-cli recordskeeper getinfo
_static/MacGetInfoMining.jpg

Note

You can view your balances in the balance output of the getinfo command.

OR

rk-cli recordskeeper getaddressbalances <Your Node Address Given for Mining>
_static/MacAddressBalancesAfterMining.jpg

Note

Please do not use the address specified above. This address is only available for the demo purpose.

Stopping Blockchain

RecordsKeeper Mainnet

If you want to stop your RecordsKeeper node, you can use the following command from your command line terminal:

./rk-cli recordskeeper stop

RecordsKeeper Testnet

If you want to stop your RecordsKeeper-test blockchain node, you can use the following command from your command line terminal:

./rk-cli recordskeeper-test stop