Skip to content

Commit

Permalink
fix: broken formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@CjS77
CjS77 committed Nov 29, 2023
1 parent 90b3853 commit 3323d92
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 62 deletions.
141 changes: 89 additions & 52 deletions _updates/2023-11-09-update-122.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,23 @@ subtitle: "Getting up and running with MinoTari"
class: subpage
---

A lot has changed with MinoTari since the first testnet launch in 2020. Here is an updated install guide on how to get up and running with MinoTari.
A lot has changed with MinoTari since the first testnet launch in 2020. Here is an updated install guide on how to get
up and running with MinoTari.

# Install the Minotari Aurora Wallet
## Install the Minotari Aurora Wallet

Tari Aurora available on the [Apple App](https://apps.apple.com/us/app/tari-aurora/id1503654828) and [Google Play](https://play.google.com/store/apps/details?id=com.tari.android.wallet&hl=en&gl=US) stores.
Tari Aurora available on the [Apple App](https://apps.apple.com/us/app/tari-aurora/id1503654828)
and [Google Play](https://play.google.com/store/apps/details?id=com.tari.android.wallet&hl=en&gl=US) stores.

# Install the MinoTari Suite

# Install the MinoTari Suite
## Prerequisites
It is recommended to run Tari through Tor. Tor hides your IP address from network peers, making punching through NATs and firewalls much easier.

It is recommended to run Tari through Tor. Tor hides your IP address from network peers, making punching through NATs
and firewalls much easier.

## Install Tor

Open a terminal and execute the following commands:

### OSX:
Expand All @@ -43,23 +49,28 @@ sudo apt update && sudo apt install -y tor
```

### Windows:

Nothing to do here - this is done automatically when the Windows installer is run.

## Install the MinoTari Binaries

Head to the downloads page of the [Tari Website](https://www.tari.com/downloads/) to get the latest binaries before starting.
Head to the downloads page of the [Tari Website](https://www.tari.com/downloads/) to get the latest binaries before
starting.

### OSX / Linux:

Download the latest version for your operating system and extract the archive into a folder on your machine.

### Windows:

Download the installer (tari_suite-...-windows-x64-installer.exe) and execute it; this will guide you through the setup and install all dependencies. Just double-click the installer and accept all the default prompts. Binaries are available to download, but the recommended way for Windows is the installer.
Download the installer (tari_suite-...-windows-x64-installer.exe) and execute it; this will guide you through the setup
and install all dependencies. Just double-click the installer and accept all the default prompts. Binaries are available
to download, but the recommended way for Windows is the installer.

## Install RandomX

This is only applicable if you plan to do Monero merge mining. Tari uses XMRig for merge mining and it can be downloaded from their [website](https://xmrig.com/download).
This is only applicable if you plan to do Monero merge mining. Tari uses XMRig for merge mining and it can be downloaded
from their [website](https://xmrig.com/download).

### OSX / Linux (Redhat) / Linux (Debian/Ubuntu):

Expand All @@ -69,15 +80,16 @@ Download and install XMRig for your operating system.

Nothing to do here - this is done automatically when the Windows installer is run.

# Runtime
## Runtime

## Start the Applications

The executables are run by executing the application in a terminal or clicking/double-clicking on the executable, depending on your operating system. The MinoTari base node and console wallet applications must be run and exited to create the initial identities and configs.
The executables are run by executing the application in a terminal or clicking/double-clicking on the executable,
depending on your operating system. The MinoTari base node and console wallet applications must be run and exited to
create the initial identities and configs.

### OSX / Linux (Redhat) / Linux (Debian/Ubuntu):


Start by running Tor in a terminal:

```console
Expand All @@ -95,13 +107,16 @@ The MinoTari base node and console wallet applications must each be run from whe
Start the base node in a separate terminal and follow the onscreen instructions.
Start the console wallet in a separate terminal and follow the onscreen instructions.

The wallet should ask to connect to your own base node. It is preferred to run this way, but if not the wallet will make a connection to one of the seed nodes.
The wallet should ask to connect to your own base node. It is preferred to run this way, but if not the wallet will make
a connection to one of the seed nodes.

### Windows:

The Tari applications will be located in the folder you selected during installation and can be run by double-clicking the various shortcuts.
The Tari applications will be located in the folder you selected during installation and can be run by double-clicking
the various shortcuts.

Start the base node, but wait for it to fully start, as Tor will be started automatically and when it is running the application will start. Follow the onscreen instructions.
Start the base node, but wait for it to fully start, as Tor will be started automatically and when it is running the
application will start. Follow the onscreen instructions.

When Tor is fully started; you must see this message:

Expand All @@ -124,70 +139,88 @@ Ctrl-C

Exit the console wallet by pressing `F10` or `ctrl-c`.

# Edit the Configuration for Your Purpose
## Edit the Configuration for Your Purpose

Sometimes it's required to edit the configs to allow us to accomplish other things for example mining.
Sometimes it's required to edit the configs to allow us to accomplish other things for example mining.
These files can be edited by opening up the config.toml file in any text editor and to make the required changes.

The default location of the configuration file:

OSX: `~/.tari/stagenet/config/config.toml`
Linux: `~/.tari/stagenet/config/config.toml`
Windows: `C:\Users\{username}\.tari-testnet\config\config.toml`
OSX: `~/.tari/stagenet/config/config.toml`
Linux: `~/.tari/stagenet/config/config.toml`
Windows: `C:\Users\{username}\.tari-testnet\config\config.toml`

# To Enable Mining (SHA-3X and Monero Merge Mining)
## To Enable Mining (SHA-3X and Monero Merge Mining)

## Enable required gRPC methods
To ensure better privacy, the base node will by default deny any method that will leak information about the running state of the node. The miner needs some of this information so we have to enable it.
### Enable required gRPC methods

In the config file, enable the following gRPC methods in the [base_node] section (look for the `grpc_server_deny_methods` entry)
"get_version",
"check_for_updates",
"get_sync_info",
"get_sync_progress",
"get_tip_info",
"identify",
"get_network_status",
To ensure better privacy, the base node will by default deny any method that will leak information about the running
state of the node. The miner needs some of this information so we have to enable it.

by adding a `#` in front of them.
In the config file, enable the following gRPC methods in the [base_node] section (look for
the `grpc_server_deny_methods` entry)
"get_version",
"check_for_updates",
"get_sync_info",
"get_sync_progress",
"get_tip_info",
"identify",
"get_network_status",

## Enable gRPC for the wallet: The wallet by default does not run its gRPC server, so this needs to be enabled. Run the wallet with –enable_grpc or go to the config file and enable gRPC by setting grpc_enabled = true under the [wallet] section.
by adding a `#` in front of them.

## Run the miner: Run minotari_miner to start the miner with both the base node and wallet running.
### Enable gRPC for the wallet

## SHA-3X Specific Settings
The wallet by default does not run its gRPC server, so this needs to be enabled. Run the wallet with –enable_grpc or go
to the config file and enable gRPC by setting grpc_enabled = true under the [wallet] section.

The SHA-3X-specific settings can be found in the [miner] section. The default settings there will be correct for you to start mining. These settings can be used to fine-tune the parameters.
### Run the miner:

## RandomX/Monero Merge Mining Specific Settings
Run minotari_miner to start the miner with both the base node and wallet running.

The RandomX-specific settings can be found in the [merge_mining_proxy] section. The default configuration is set for the Monero stagenet network, but you may want to enable the mainnet network.
### SHA-3X Specific Settings

The SHA-3X-specific settings can be found in the [miner] section. The default settings there will be correct for you to
start mining. These settings can be used to fine-tune the parameters.

### RandomX/Monero Merge Mining Specific Settings

The RandomX-specific settings can be found in the [merge_mining_proxy] section. The default configuration is set for the
Monero stagenet network, but you may want to enable the mainnet network.

## Other Settings

Other settings can also be enabled or disabled as required, but take care when changing anything else! The default settings will work.
Other settings can also be enabled or disabled as required, but take care when changing anything else! The default
settings will work.

# Consecutive Runs
## OSX / Linux:
Make sure tor is running, then run the binaries.
### OSX / Linux:

## Windows:
Run the binaries. The binaries created by the installer will start tor for you.
Make sure tor is running, then run the binaries.

# Mining
### Windows:

Run the binaries. The binaries created by the installer will start tor for you.

## Mining

To perform mining with MinoTari, we need to run a base node and a console wallet, so ensure those are running.
## SHA-3X mining
To do mining through SHA-3 using what Tari calls SHA-3X (triple sha3_256 hash) simply run the minotari_miner to start mining.

## Monero Merge Mining
### SHA-3X mining

To do mining through SHA-3 using what Tari calls SHA-3X (triple sha3_256 hash) simply run the minotari_miner to start
mining.

With Monero merge mining, we need to run the merge mining proxy (minotari_merge_mining_proxy) and RandomX. You will also need a Monero wallet address for the Monero network you want to use.
### Monero Merge Mining

With Monero merge mining, we need to run the merge mining proxy (minotari_merge_mining_proxy) and RandomX. You will also
need a Monero wallet address for the Monero network you want to use.

A public stagenet address you can use can be found here:

```console
55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt
```

A public mainnet address you can use can be found here:

```console
Expand All @@ -198,7 +231,9 @@ A public mainnet address you can use can be found here:

###OSX / Linux:

Edit the `config.json` file in your XMRig install folder, and remember to add your own respective Monero wallet address or select one from above.
Edit the `config.json` file in your XMRig install folder, and remember to add your own respective Monero wallet address
or select one from above.

```console
{
"autosave": true,
Expand All @@ -218,7 +253,8 @@ Edit the `config.json` file in your XMRig install folder, and remember to add yo

### Windows:

Nothing to do here for Stagenet - this is done automatically when the Windows installer is run, however, if you want to run mainnet, do the following:
Nothing to do here for Stagenet - this is done automatically when the Windows installer is run, however, if you want to
run mainnet, do the following:

Edit `config\xmrig_config_example_mainnet.json` to add your own Monero mainnet wallet address or select the one above.

Expand Down Expand Up @@ -254,8 +290,9 @@ Open a terminal at the XMRig installation location and execute the following:

Double-click the shortcut or start it via the Windows menu (`Tari Testnet`).

# More information
## More information

This is a very limited quick guide to get started with MinoTari, and only shows the basic settings. More detail is available on the [github page](https://github.com/tari-project/tari).
This is a very limited quick guide to get started with MinoTari, and only shows the basic settings. More detail is
available on the [github page](https://github.com/tari-project/tari).


30 changes: 20 additions & 10 deletions _updates/2023-11-29-update-123.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,35 @@ date: 2023-11-29
author: stringhandler
thumbnail: update-background.jpg
title: Progress Update on Tari
subtitle:
class: subpage
---

It's been a while since we last updated you on the progress of the Tari Second Layer. Here are some key developments we've been working on:
It's been a while since we last updated you on the progress of the Tari Second Layer. Here are some key developments
we've been working on:

# Enhancing Cross Shard Transaction Reliability
## Enhancing Cross Shard Transaction Reliability


Tari's Cerberus implementation efficiently manages cross-shard transactions, but our focus has been on exploring reliable broadcast mechanisms. These efforts aim to ensure seamless information transfer across shards without any loss. Within each shard, the committee utilizes Hotstuff. While Hotstuff comes with intrinsic tools for detecting missing messages, these are not available for
sending between shards. For those seeking in-depth information on how we're solving this, more details are available in the [RFC](https://github.com/tari-project/rfcs/pull/112).
Tari's Cerberus implementation efficiently manages cross-shard transactions, but our focus has been on exploring
reliable broadcast mechanisms. These efforts aim to ensure seamless information transfer across shards without any loss.
Within each shard, the committee utilizes Hotstuff. While Hotstuff comes with intrinsic tools for detecting missing
messages, these are not available for
sending between shards. For those seeking in-depth information on how we're solving this, more details are available in
the [RFC](https://github.com/tari-project/rfcs/pull/112).

# Testing Registration and Consensus on Igor
## Testing Registration and Consensus on Igor

We're using the `igor` testnet to register Validator Nodes and Code Templates. Currently, we're operating a single validator, but the network is open for registering and testing templates. To minimize disruption for other users, we suggest holding off on registering a validator node for now. Should you wish to contribute to testing this aspect, please reach out to us via Discord or Telegram.
We're using the `igor` testnet to register Validator Nodes and Code Templates. Currently, we're operating a single
validator, but the network is open for registering and testing templates. To minimize disruption for other users, we
suggest holding off on registering a validator node for now. Should you wish to contribute to testing this aspect,
please reach out to us via Discord or Telegram.

Otherwise, feel free to register Code Templates and test them out. If you are, we'd love to know about it.

## Awesome Tari Page

# Awesome Tari Page

A curated [List of Awesome Projects on Tari](https://github.com/tari-project/awesome-tari) is now available. Are you engaged in a fascinating project on Tari? Feel free to submit a PR with a link to your work. Furthermore, if you're searching for ways to get involved, this serves as an excellent starting point to explore and contribute to ongoing projects.
A curated [List of Awesome Projects on Tari](https://github.com/tari-project/awesome-tari) is now available. Are you
engaged in a fascinating project on Tari? Feel free to submit a PR with a link to your work. Furthermore, if you're
searching for ways to get involved, this serves as an excellent starting point to explore and contribute to ongoing
projects.

0 comments on commit 3323d92

Please sign in to comment.