base on The Tari protocol [](https://coveralls.io/github/tari-project/tari?branch=development) # The Tari protocol A number of applications have been developed by the Tari community to implement the Tari protocol. These are: - Minotari Base Node - Minotari Wallet - Minotari Miner - Minotari Merge Mining Proxy - Minotari Aurora wallets for Android and iOS Only the first four applications will be discussed in this README (see [wallet-android](https://github.com/tari-project/wallet-android) and [wallet-ios](https://github.com/tari-project/wallet-ios) for mobile wallets' repos). ## Developers Want to contribute? Start by reading the [Contributing Guide](Contributing.md) and the [Reviewing Guide](docs/src/reviewing_guide.md). ## Installing using binaries ### Versions The recommended running versions of each network are: | Network | Version | |-----------|-------------| | Mainnet | 4.4.1 | | Nextnet | 4.4.1-rc.0 | | Esmeralda | 4.4.1-pre.0 | For more detail about versioning, see [Release Ideology](https://github.com/tari-project/tari/blob/development/docs/src/branching_releases.md). ### Running test Tests can be run by install Nextest with the following command: ```bash cargo install cargo-nextest ``` Then run the tests with: ```bash cargo +nightly ci-test ``` ### Download [Download binaries](https://tari.com/downloads/) from [tari.com](https://www.tari.com/). This is the easiest way to run a Tari node, but you're essentially trusting the person that built and uploaded them that nothing untoward has happened. Hashes of the binaries are available alongside the downloads. You can get the hash of your download by opening a terminal or command prompt and running the following: (\*nix) shasum -a256 <PATH_TO_BINARY_INSTALL_FILE> (Windows) certUtil -hashfile <PATH_TO_BINARY_INSTALL_FILE> SHA256 If the result doesn't match the published hash, don't run the binary. Note that this only checks that your binary was downloaded correctly; it cannot detect if the binary was replaced by a bad actor. If you need to ensure that your binary matches the source, see [Building from source](#building-from-source) below. ### Install After you have downloaded the binaries, you need to install them. This is easy to do, and works as follows: #### On \*Nix Assuming you want to install the Tari applications into your home folder, run the following: cd ~ tar -xf <PATH_TO_BINARY_INSTALL_FILE> After this, the Tari applications will be located in `~/tari_esmeralda_testnet` with a selection of soft links to run them. #### On Windows Just double-click the installer and accept all the default prompts. The Tari applications will be located in the folder you selected during installation, and can be run by double-clicking the various shortcuts or via the Windows menu (`Tari Testnet`). ### Runtime links #### Use the one-click miner Execute the `start_all` soft link/shortcut; this will start everything you need depending on the choices you make when prompted: - Tor services started by default - Minotari Base Node, or - Minotari Base Node & Minotari Wallet, or - Minotari Base Node & Minotari Wallet & Minotari Miner, or - Minotari Base Node & Minotari Wallet & Minotari Merge Mining Proxy & XMRig #### Start all applications individually - Execute the `start_minotari_node` soft link/shortcut; this will also start the Tor services if not running already that needs to be running before the base node can run (do not close the Tor console). - Execute the `start_minotari_console_wallet` soft link/shortcut; this will also start the Tor services that needs to be running before the base node can run (do not close the Tor console). **Note**: The Tor console will output `[notice] Bootstrapped 100% (done): Done` when the Tor services have fully started. - Depending on your choice of mining: - SHA3 standalone mining - Execute the `start_minotari_miner` soft link/shortcut. - Merge mining with Monero - Execute the `start_minotari_merge_mining_proxy` soft link/shortcut. - Execute the `start_xmrig` shortcut. ## Building from source To build the Minotari codebase from source, there are a few dependencies you need to have installed. ### Install development packages First you'll need to make sure you have a full development environment set up: #### (macOS) ``` brew update brew install coreutils tor openssl \ cmake make libtool autoconf automake protobuf ``` #### (Ubuntu 18.04, including WSL-2 on Windows) ``` sudo apt-get update sudo apt-get -y install openssl libssl-dev pkg-config libsqlite3-dev clang git cmake libc++-dev libc++abi-dev libprotobuf-dev protobuf-compiler libncurses5-dev libncursesw5-dev sudo apt-get install -y wget apt-transport-https sudo wget -q "https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb" sudo dpkg -i packages-microsoft-prod.deb sudo apt-get update sudo add-apt-repository universe sudo apt-get install -y powershell ``` #### (Windows) Please follow the instructions [located here](https://github.com/tari-project/tari/blob/development/buildtools/windows-dev-environment-notes.md) for instructions on setting up your build environment in Windows. ### Build Grab a cup of coffee and begin the Tari build. (\*nix) cd tari cargo build --release (Windows) This is similar to building in Ubuntu, except the Microsoft Visual Studio environment must be sourced. Open the appropriate _x64\x86 Native Tools Command Prompt for VS 2019_, and in your main Tari directory perform the build, which will create the executable inside your `%USERPROFILE%\Code\tari\target\release` directory: cd %USERPROFILE%\Code\tari cargo build --release A successful build should output something like this: ``` Compiling minotari_wallet v0.0.9 (.../tari/base_layer/wallet) Compiling minotari_wallet_ffi v0.0.9 (.../tari/base_layer/wallet_ffi) Compiling minotari_node v0.0.9 (.../tari/applications/minotari_node) Finished release [optimized] target(s) in 12m 24s ``` Compiled executables can be found at these paths:: ./target/release/minotari_node ./target/release/minotari_console_wallet ./target/release/minotari_merge_mining_proxy ./target/release/minotari_miner Alternatively, `cargo` can build and install the executable into `~/.cargo/bin` (`%USERPROFILE%\.cargo\bin` on Windows), so it will be executable from anywhere on your system: cargo install --path=applications/minotari_node --force cargo install --path=applications/minotari_console_wallet --force cargo install --path=applications/minotari_merge_mining_proxy --force cargo install --path=applications/minotari_miner --force --- Alternatively, `cargo` can build and install the executable into `%USERPROFILE%\.cargo\bin`, so it will be executable from anywhere on your system: cargo install --path=applications/minotari_node --force cargo install --path=applications/minotari_console_wallet --force cargo install --path=applications/minotari_merge_mining_proxy --force cargo install --path=applications/minotari_miner --force ### Run The executables will either be inside your `~/tari/target/release` (on Linux) or `%USERPROFILE%\Code\tari\target\release` (on Windows) directory, or alternatively, inside your `~/.cargo/bin` (on Linux) `%USERPROFILE%\.cargo\bin` (on Windows) directory, depending on the build choice above, and must be run from the command line. If the former build method was used, you can run it from that directory, or you more likely want to copy it somewhere more convenient. Make sure to start the Tor service `%USERPROFILE%\Code\tari\applications\minotari_node\windows\start_tor.lnk` if running on Windows. Tor is included in the binary if running on Linux or Mac. Running+: minotari_node minotari_console_wallet minotari_merge_mining_proxy minotari_miner Alternatively, you can run the Tari applications from your source directory using `cargo`, and just omit the `--release` flag if you want to run in debug mode: cargo run --bin minotari_node --release cargo run --bin minotari_merge_mining_proxy --release cargo run --bin minotari_console_wallet --release cargo run --bin minotari_miner --release Using all the default options, the blockchain database, wallet database, console wallet database, log files and all configuration files will be created in the `~/.tari` (on Linux) or `%USERPROFILE%\.tari` (on Windows) directory. Alternatively, by specifying `--base-path <base-path>` on the command line as well, all of this will be created in that directory. ## Advanced build configurations - Vagrant: See [Building with Vagrant](https://github.com/tari-project/tari/issues/1407), using Vagrant to build and run a basenode, as cleanly as possible. ## Using Docker ### Running the base node with a Docker image Minotari Base Node Docker images can be found at https://quay.io/repository/tarilabs/minotari_node Using `docker-compose.yaml`: ``` version: "3" services: minotari_node: image: quay.io/tarilabs/minotari_node:latest-nextnet restart: unless-stopped volumes: - ./data:/root/.tari # These 2 params are required for an interactive docker-compose session stdin_open: true tty: true expose: - 18142 ports: - "18142:18142" ``` Then run `docker-compose up -d` to start your docker service. Check the running state with `docker-compose ps`: ``` Name Command State Ports ------------------------------------------------------------------ tbn_minotari_node_1 start.sh Up 0.0.0.0:18142->18142/tcp ``` To connect to the console, use `docker ps` to get the container ID to which to attach the `minotari_node`` in Docker: ``` CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 73427509a4bb quay.io/tarilabs/minotari_node:v0.5.4 "start.sh" 45 minutes ago Up 26 minutes 0.0.0.0:18142->18142/tcp tbn_minotari_node_1 ``` With the container ID `73427509a4bb`, connect to the `minotari_node` console using `docker attach 73427509a4bb`: ``` >> help Available commands are: help, version, get-chain-metadata, list-peers, reset-offline-peers, ban-peer, unban-peer, list-connections, list-headers, check-db, calc-timing, discover-peer, get-block, search-utxo, search-kernel, search-stxo, get-mempool-stats, get-mempool-state, whoami, get-state-info, quit, exit >> get-chain-metadata Height of longest chain : 5228 Geometric mean of longest chain : 5892870 Best block : 2c4f92854b2160324b8afebaa476b39be4004d2a7a19c69dd2d4e4da257bfee2 Pruning horizon : 0 Effective pruned height : 0 >> get-state-info Current state machine state: Synchronizing blocks: Syncing from the following peers: 510c83279adc7cb7d7dda0aa07 Syncing 5229/5233 ``` --- ## Mining The Tari protocol supports hybrid mining; stand-alone or pooled SHA3 mining using the Minotari Miner or merged mining with Monero using the Minotari Merge Mining Proxy in conjunction with XMRig (RandomX-based mining). Blocks to be won by standalone and pooled SHA3 mining have been apportioned to approximately 50% and with Monero merged mining to approximately 50%. This apportionment is deeply baked into the Tari protocol and part of the consensus rules. The 50/50 split is determined by slightly different block target times for each algorithm, that when combined will give an average block time of approximately 120 seconds. Each mining algorithm makes use of Linear Weighted Moving Average (LWMA) maths to gracefully adjust the target difficulties to adhere to the respective target block times. Any block won by either mining algorithm will be accepted, and when there is a tie, a geometric mean calculation will be used to decide the winner. This system is completely fair without any additional empirical meddling to try force a certain outcome. ### Tari SHA3 mining In order to perform SHA3 mining with Tari, the following applications are needed: - A Minotari Base Node [_to supply blockchain metadata information_]; - A Minotari Wallet [_to collect the Minotari block rewards (coinbase transactions)_]; - A Minotari Miner [_to perform the mining_]; In order to perform pooled SHA3 mining with Tari, the following applications are needed: - For a pool operator: - A Minotari Base Node [_to supply blockchain metadata information_]; - A Minotari Wallet [_to collect the Minotari block rewards (coinbase transactions)_]; - Miningcore [_pool software supporting various cryptocurrencies, configured for Tari_] - For a miner: - A Minotari Wallet [_to collect the share rewards (pool payouts)_]; - A Minotari Miner [_to perform the mining_]; #### Runtime prerequisites The Minotari Base Node, Minotari Wallet and Minotari Miner can all run in the same directory. By performing the default installation as described in [Installing using binaries](#installing-using-binaries), all these applications will be available. For MiningCore see the [Linux](https://github.com/tari-project/miningcore/#building-on-debianubuntu) and [Windows](https://github.com/tari-project/miningcore/#building-on-windows) build instructions. #### Configuration prerequisites The configuration prerequisites are the same for all four Tari applications. After performing a [default installation](#installing-using-binaries), locate the main configuration file (`config.toml`), which will be created in the `~/tari_esmeralda_testnet/config` (on Linux) or `%USERPROFILE%\.tari-testnet\config` (on Windows) directory. With the main configuration file, in addition to the settings already present, the following must also be enabled for the Minotari Base Node and the Minotari Wallet, if they are not enabled already. Under sections **`base_node.esmeralda`** and **`wallet`** respectively: ``` [wallet] grpc_address = "http://127.0.0.1:18143" ``` ``` [base_node.esmeralda] transport = "tor" allow_test_addresses = false grpc_enabled = true grpc_base_node_address = "http://127.0.0.1:18142" ``` For the Minotari Miner there are some additional settings under section **`miner`** that can be changed: - For SHA3 Mining: ``` [miner] # Number of mining threads # Default: number of logical CPU cores #num_mining_threads=8 # GRPC address of base node # Default: value from `base_node.grpc_base_node_address` #base_node_grpc_address = "http://127.0.0.1:18142" # GRPC address of console wallet # Default: value from `wallet.grpc_address` #wallet_grpc_address = "http://127.0.0.1:18143" # Start mining only when base node is bootstrapped # and current block height is on the tip of network # Default: true #mine_on_tip_only=true # Will check tip with node every N seconds and restart mining # if height already taken and option `mine_on_tip_only` is set # to true # Default: 30 seconds #validate_tip_timeout_sec=30 ``` Uncomment `mining_pool_address` and `mining_wallet_address`. Adjust the values to your intended configuration. `mining_worker_name` is an optional configuration field allowing you to name your worker. #### Perform SHA3 mining - For SHA3 mining: Tor and the required Tari applications must be started and preferably in this order: - Tor(windows only): - Windows: `Start Tor Serviecs` menu item or `start_tor` shortcut in the Tari installation folder. - Tari Base Node: - Linux/OSX: As per [Runtime links](#runtime-links). - Windows: As per [Runtime links](#runtime-links) or `Start Base Node` menu item or `start_minotari_node` shortcut in the Tari installation folder. - Tari Console Wallet: - Linux/OSX: As per [Runtime links](#runtime-links). - Windows: As per [Runtime links](#runtime-links) or `Start Console Wallet` menu item or `start_tari_console_wallet` shortcut in the Tari installation folder. - Tari Miner: - Linux/OSX: As per [Runtime links](#runtime-links). - Windows: As per [Runtime links](#runtime-links) or `Start Miner` menu item or `start_tari_miner` shortcut in the Tari installation folder. Look out for the following types of messages on the Tari Miner console to confirm that it is connected properly and performing mining: ``` 2021-02-26 11:24:23.604202000 [minotari_miner] INFO Connecting to base node at http://127.0.0.1:18151 2021-02-26 11:24:23.606260800 [minotari_miner] INFO Connecting to wallet at http://127.0.0.1:18161 2021-02-26 11:24:23.721890400 [minotari_miner::miner] INFO Mining thread 0 started 2021-02-26 11:24:23.722287800 [minotari_miner::miner] INFO Mining thread 1 started 2021-02-26 11:24:23.722505500 [minotari_miner::miner] INFO Mining thread 2 started 2021-02-26 11:28:19.687855700 [minotari_miner::miner] INFO Mining thread 2 stopped 2021-02-26 11:28:19.688251200 [minotari_miner] INFO Miner 2 found block header BlockHeader { hash: [...], version: 1, height: 8493, prev_hash: [...], timestamp: Some(Timestamp { seconds: 1614331698, nanos: 0 }), output_mr: [...], witness_mr: [...], total_kernel_offset: [...], nonce: 8415580256943728281, pow: Some(ProofOfWork { pow_algo: 2, pow_data: [] }), kernel_mmr_size: 24983, output_mmr_size: 125474 } with difficulty 7316856839 ``` ### Tari merge mining In order to perform merge mining with Tari, the following applications are needed: - A Minotari Base Node [_to supply blockchain metadata information_]; - A Minotari Wallet [_to collect the Tari block rewards (coinbase transactions)_]; - A Minotari Merge Mining Proxy [_to enable communication between all applications_]; - XMRig [_to perform the mining_]; - Monero wallet (specifically a stagenet wallet address during testnet; the one provided can be used, or a custom one can be set up) [_to collect Monero block rewards (coinbase transactions)_]. The Minotari Merge Mining Proxy will be the communication gateway between all these applications and will coordinate all activities. It will also submit finalized Minotari and Monero blocks to the respective networks when RandomX is solved at the respective difficulties. #### Runtime prerequisites The Minotari Base Node, Minotari Wallet and Minotari Merge Mining Proxy can all run in the same directory, whereas XMRig will run in its own directory. By performing the default installation as described in [Installing using binaries](#installing-using-binaries), all these applications will be available. XMRig can also be build from sources. If that is your preference, follow these instructions: <https://xmrig.com/docs/miner/>. #### Configuration prerequisites ##### Minotari applications The configuration prerequisites are the same for all three Minotari applications. After performing a [default installation](#installing-using-binaries), locate the main configuration file (`config.toml`), which will be created in the `~/tari_esmeralda_testnet/config` (on Linux) or `%USERPROFILE%\.tari-testnet\config` (on Windows) directory. With the main configuration file, in addition to the settings already present, the following must also be enabled if they are not enabled already: - For the Minotari Base Node and the Minotari Wallet, under sections **`base_node.esmeralda`** and **`wallet`** respectively ``` [wallet] grpc_address = "http://127.0.0.1:18143" ``` ``` [base_node.esmeralda] transpo*_r_*t = "tor" allow_test_addresses = false base_node_grpc_address = "http://127.0.0.1:18142" ``` Depending on if you are using solo mining or self-select mining, you will use one of the following: ###### Solo mining - For the Minotari Merge Mining Proxy, under section **`merge_mining_proxy`** ``` [merge_mining_proxy] monerod_url = [ # stagenet "http://stagenet.xmr-tw.org:38081", "http://stagenet.community.xmr.to:38081", "http://monero-stagenet.exan.tech:38081", "http://xmr-lux.boldsuck.org:38081", "http://singapore.node.xmr.pm:38081", ] proxy_host_address = "127.0.0.1:18081" proxy_submit_to_origin = true monerod_use_auth = false monerod_username = "" monerod_password = "" ``` ###### Self-Select mining - For the Minotari Merge Mining Proxy, under section **`merge_mining_proxy`** ``` [merge_mining_proxy] monerod_url = [ # stagenet "http://stagenet.xmr-tw.org:38081", "http://stagenet.community.xmr.to:38081", "http://monero-stagenet.exan.tech:38081", "http://xmr-lux.boldsuck.org:38081", "http://singapore.node.xmr.pm:38081", ] proxy_host_address = "127.0.0.1:18081" proxy_submit_to_origin = false monerod_use_auth = false monerod_username = "" monerod_password = "" ``` **Note:** The ports `18081`, `18142` and `18143` shown in the example above should not be in use by other processes. If they are, choose different ports. You will need to update the ports in the steps below as well. The `monerod_url` set must contain valid addresses (`host:port`) for `monerod` that is running Monero mainnet (e.g. `["http://18.132.124.81:18081"]`) or stagenet (e.g. `["http://monero-stagenet.exan.tech:38081"]`), which can be a public node or local instance. To test if the `monerod_url` address is working properly, try to paste `host:port/get_height` in an internet browser, for example: ``` http://18.132.124.81:18081/get_height ``` A typical response would be: ``` { "hash": "ce32dd0a6e3220d57c368f2cd01e5980a9b4d70f02b27274d67142d5b26cb4d6", "height": 2277206, "status": "OK", "untrusted": false } ``` _**Note:** A guide to setting up a local Monero stagenet on Linux can be found [here](https://github.com/tari-project/tari/blob/development/applications/minotari_merge_mining_proxy/monero_stagenet_setup.md)._ ##### XMRig configuration The XMRig configuration must be prepared for either solo or pool merged mining with Monero. It is advisable to use a configuration file for XMRig as this offers more flexibility, otherwise, the configuration parameters can be passed in via the command line upon runtime. **Notes:** - Monero mainnet and stagenet wallet addresses can only be used with the corresponding network. The `monerod_url` configuration setting (see [Minotari applications](#minotari-applications)) must also correspond to the chosen network. - For the solo mining configuration, Monero doesn't currently support requesting templates to mine on with the address being a subaddress. It is possible to do with the self-select configuration since the template is requested by the miner with the wallet address of the pool. ###### Solo-mining The [XMRig configuration wizard](https://xmrig.com/wizard) can be used to create a solo mining configuration file in JSON format: - Start -> `+ New configuration` - Pools -> `+ Add daemon` - With `Add new daemon for Solo mining`, complete the required information, then `+ Add daemon`: - `Host`, `Port`: This must correspond to the `proxy_host_address` in the Tari configuration file. - `Secure connection (TLS)`: Uncheck. - `Coin`: Monero. - `Wallet address`: This must be your own stagenet or mainnet wallet address, or you can use these donation addresses: - Public stagenet address at https://coin.fyi/news/monero/stagenet-wallet-8jyt89#! `55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt` - Mainnet address `<Enter your own mainnet wallet address here>` - Backends -> Select `CPU` (`OpenCL` or `CUDA` also possible depending on your computer hardware). - Misc -> With `Donate`, type in your preference. - Result -> With `Config file`, copy or download, than save as `config.json`. Using the public stagenet wallet address above, the resulting configuration file should look like this: ``` { "autosave": true, "cpu": true, "opencl": false, "cuda": false, "pools": [ { "coin": "monero", "url": "127.0.0.1:18081", "user": "55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt", "tls": false, "daemon": true } ] } ``` ###### Pool mining with Self-Select For pool mining, the configuration file obtained from the [XMRig configuration wizard](https://xmrig.com/wizard) must be augmented with Tari specific settings. Using the wizard, create the following: - Start -> `+ New configuration` - Pools -> `+ Add pool` -> `Custom pool` - With `Add new custom pool`, complete the required information, then `+ Add pool`: - `Host`, `Port`: This must be for a Monero mainnet mining pool that supports the `self-select`. - `Secure connection (TLS)`: Check/Uncheck (based on the pool requirements). - `keepalive`: Check. - `nicehash`: Uncheck. - `User`: This must be your own mainnet wallet address, or you can use this address to donate to Monero: - Public mainnet address at https://www.getmonero.org/get-started/contributing/ `888tNkZrPN6JsEgekjMnABU4TBzc2Dt29EPAvkRxbANsAnjyPbb3iQ1YBRk1UXcdRsiKc9dhwMVgN5S9cQUiyoogDavup3H` - `Password`: A custom field that could be your wallet name or some other pool settings. - `Coin`: Monero. - `Algorithm`: rx/0. - Backends -> Select `CPU` (`OpenCL` or `CUDA` also possible depending on your computer hardware). - Misc -> With `Donate`, type in your preference. - Result -> With `Config file`, copy or download, than save as `config.json`. - Add custom entries for `"self-select": "127.0.0.1:18081"` and `"submit-to-origin": true` in the `"pools"` section. Mining pool `cryptonote.social` requires you to add a personalized handle to the wallet address so that you can query your own pool statistics, separated by a full stop, i.e. `<YOUR WALLET ADDRESS>.<pool specific user name>`. For demonstration purposes, `donatemonero` has been associated with the public mainnet wallet address above. If you go to <https://cryptonote.social/xmr> and enter `donatemonero` in the `Username:` text box you will see some merge mining activity for that address. The configuration file used for this exercise is shown below: ``` { "autosave": true, "cpu": true, "opencl": false, "cuda": false, "pools": [ { "coin": "monero", "algo": "rx/0", "url": "cryptonote.social:5555", "user": "888tNkZrPN6JsEgekjMnABU4TBzc2Dt29EPAvkRxbANsAnjyPbb3iQ1YBRk1UXcdRsiKc9dhwMVgN5S9cQUiyoogDavup3H.donatemonero", "pass": "start_diff=220000;payment_scheme=pprop;donate=0.5", "tls": false, "keepalive": true, "nicehash": false, "self-select": "127.0.0.1:18081", "submit-to-origin": true } ] } ``` #### Perform merge mining Tor and the required Minotari applications must be started, preferably in this order: - Tor(windows only): - Windows: `Start Tor Serviecs` menu item or `start_tor` shortcut in the Tari installation folder. - Tari Base Node: - Linux/OSX: As per [Runtime links](#runtime-links). - Windows: As per [Runtime links](#runtime-links) or `Start Base Node` menu item or `start_minotari_node` shortcut in the Tari installation folder. - Tari Console Wallet: - Linux/OSX: As per [Runtime links](#runtime-links). - Windows: As per [Runtime links](#runtime-links) or `Start Console Wallet` menu item or `start_minotari_console_wallet` shortcut in the Tari installation folder. - Tari Merge Mining Proxy: - Linux/OSX: As per [Runtime links](#runtime-links). - Windows: As per [Runtime links](#runtime-links) or `Start Merge Mining Proxy` menu item or `start_minotari_merge_mining_proxy` shortcut in the Tari installation folder. In addition, select one of the merge mining options as outlined in solo or pool mining in the next paragraphs. ##### Solo merged mining with Monero This paragraph is applicable to solo mining Monero on mainnet or stagenet and solo mining Tari on testnet. Solo merged mining with Monero is supported using the `daemon` option. ###### Merge Mining Proxy configuration As mentioned previously, the `monerod_url` field in the `config.toml` should be enabled for the corresponding mainnet or stagenet network Monero wallet address: ``` # URL to monerod monerod_url = [ # mainnet "http://18.132.124.81:18081", "http://xmr.support:18081", "http://node1.xmr-tw.org:18081", "http://xmr.nthrow.nyc:18081", ] monerod_url = [ # stagenet "http://stagenet.xmr-tw.org:38081", "http://stagenet.community.xmr.to:38081", "http://monero-stagenet.exan.tech:38081", "http://xmr-lux.boldsuck.org:38081", "http://singapore.node.xmr.pm:38081", ] ``` ###### Runtime Ensure the `config.json` configuration file discussed in [Solo mining](#solo-mining) is copied to the XMRig build or install folder, then start XMRig: - Linux/OSX: Execute `./xmrig` in the XMRig build or install folder. - Windows: Execute `xmrig` in the XMRig build or install folder, or `Start XMRig` menu item or `start_xmrig` shortcut in the Tari installation folder. **Note**: On modern Windows versions, coin mining software is blocked by default, for example by Windows Defender. Ensure that these processes are allowed to run when challenged: - `PUA:Win32/CoinMiner` - `PUA:Win64/CoinMiner` - `App:XMRigMiner` Look out for the following outputs in the XMRig console to confirm that it is connected to the Merge Mining Proxy and accepting jobs: ``` * POOL #1 127.0.0.1:18081 coin monero ``` ``` [2021-01-21 12:10:18.960] net use daemon 127.0.0.1:18081 127.0.0.1 [2021-01-21 12:10:18.960] net new job from 127.0.0.1:18081 diff 286811 algo rx/0 height 756669 [2021-01-21 12:10:56.730] cpu rejected (0/1) diff 286811 "Block not accepted" (656 ms) [2021-01-21 12:10:57.398] net new job from 127.0.0.1:18081 diff 293330 algo rx/0 height 756670 [2021-01-21 12:12:23.695] miner speed 10s/60s/15m 4089.0 4140.2 n/a H/s max 4390.9 H/s [2021-01-21 12:12:57.983] cpu accepted (1/1) diff 293330 (594 ms) ``` The `cpu: rejected` and `cpu: accepted` messages originate from stagenet or mainnet `monerod`, and show the Monero statistics. At this point, the mined and rejected Minotari coinbases should be visible in the Minotari Wallet. ##### Pool merged mining with Monero (self select) This paragraph is applicable to pool mining Monero on mainnet and solo mining Minotari on testnet. Pool merged mining with Monero is supported using the [Stratum mode self-select](https://github.com/jtgrassie/monero-pool/blob/master/sss.md) option via XMRig. Two mining pools we have tried out that support this feature are [monero-pool](https://github.com/jtgrassie/monero-pool), with its reference pool implementation running [here](http://monerop.com/), and [cryptonote.social](https://cryptonote.social/xmr). With normal self select mode, XMRig requests a Monero block template from a third party and submits the solution to the mining pool. Minotari added a `submit-to-origin` option to the self select mode whereby, if a solution has been found that only matches the pool difficulty, XMRig will submit the solution to the pool only; but if the achieved difficulty meets both that of the pool and Minotari, it will be submitted to the Merge Mining Proxy as well as to the mining pool. ###### Merge Mining Proxy configuration The `monerod_url` field in the `config.toml` should be enabled for the mainnet value: ``` # URL to monerod monerod_url = [ # mainnet "http://18.132.124.81:18081", "http://xmr.support:18081", "http://node1.xmr-tw.org:18081", "http://xmr.nthrow.nyc:18081", ] ``` ###### Runtime Ensure the `config.json` configuration file discussed in [Pool mining with self select](#pool-mining-with-self-select) is copied to the XMRig build or install folder, then start XMRig as before for solo mining. Look out for the following outputs in the XMRig console to confirm that it is connected to the pool and the Merge Mining Proxy and accepting jobs: ``` * POOL #1 cryptonote.social:5555 coin monero self-select 127.0.0.1:18081 submit-to-origin ``` ``` [2021-01-18 11:40:48.392] net new job from cryptonote.social:5555 diff 220006 algo rx/0 height 2277084 [2021-01-18 11:41:22.378] origin submitted to origin daemon (1/0) diff 284557 vs. 371742 [2021-01-18 11:41:22.812] cpu accepted (1/0) diff 220006 (433 ms) [2021-01-18 11:41:39.201] miner speed 10s/60s/15m 1562.2 1630.4 n/a H/s max 1710.0 H/s [2021-01-18 11:42:06.320] cpu accepted (2/0) diff 220006 (482 ms) ``` Status essages `origin: submitted to origin daemon (1/0)` and `origin: not submitted to origin daemon, difficulty too low (1/1)` pertains to submissions to the Tari network, and `cpu: accepted (1/0)` to the pool. Mined and rejected Tari coinbases should be visible in the Tari Console Wallet, and pool shares in the pool interface. If you are using `cryptonote.social:5555` as in the example above, go to <https://cryptonote.social/xmr> and type in your wallet identity under `Username:` to see your shares, or try `taritest` if you used this configuration example. # Project documentation - [RFC documents](https://rfc.tari.com) are hosted on Github Pages. The source markdown is in the `RFC` directory. - Source code documentation is hosted on [docs.rs](https://docs.rs) - [RFC repo](https://github.com/tari-project/rfcs) ## RFC documents The RFCs are long-form technical documents proposing changes and features to the Tari network and ecosystem. They are hosted at https://rfc.tari.com, and the RFC repo is at https://github.com/tari-project/rfcs. ### Source code documentation Run cargo doc to generate the documentation. The generated html sits in `target/doc/`. Alternatively, to open a specific package's documentation directly in your browser, run the following: cargo doc -p <package> --open ## Conversation channels We're generally on [Discord](https://discord.gg/tari). ", Assign "at most 3 tags" to the expected json: {"id":"13731","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"