feat: one-click installer - cli edition #3534
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Picked up a few issues when running on a clean Linux build. Moving to draft while I sort them out |
This seemingly innoucous update required several changes due to changes in how the compiler interprets dead code. * A few variables were renamed _x where it looked like x might be used in upcoming PRs. YAGNI maybe, but I gave the benefit of the doubt in this cases. * Some crates that had LOADS of dead code (ffi crate I'm looking at you), I just changed the `deny(dead_code)` to `warn(dead_code)` * And in some places, I just nuked the dead code, which tidied up some heavy code in the wallet in particular. Since the tests pass, I presume this is fine and there isn't a weird new compioler bug that is missing where the code is needed. Add more docker files to installer Add docker build files for xmrig, mm_proxy, monerod. Add a quick_start.sh script that demonstrates one-click miner capability Tidy up docker compose and add services for mining Update base images to buster Force cargo to http 1.1 in docker Move docker specs to launchpad folder Add script to push latest image bundle - `push_bundle.sh` examines the `:latest` images of the docker rig and pushes them to quay.io, tagging them with both the `latest` tag and their individual version numbers.
a.k.a. _Tari one-click miner_. Currently this only works on MacOS and Linux. Contributions for `quick_start.bat` are welcomed. `./quick-start.sh` and you fire up a tor instance, a base node, wallet, sha3 miner, merge_miner proxy and xmrig. All networking, configuration and setup is taken care of via environment variables and sane defaults. Any Tari client that supports gRPC can be connected to the node setup. With the default configuration, the base node will be at `http://127.0.0.1:18142` and the wallet will be at `http://127.0.0.1:18143`. -- Current shortcomings and TODOs * It's a CLI only. Next step is to build a nice UI wrapper around this. * TODO - Windows support. * The blockchain data is stores in docker volumes, and not on the host machine directly. This is due to crippling performance limitations one suffers when mounting host file system from Windows or MacOS into docker containers. This isn't a big drawback, since you seldom want or need to access the raw blockchain database files anyway. Are they're [still accessible](#accessing-blockchain-data). But **ensure that you reserve enough space to store the Tari, and optionally, Monero blockchains inside the Docker VM**. * TODO - Multi-network sandboxing. Sandboxing currently doesn't work across different networks (e.g. weatherwax and mainnet). This should be fixed soon. * Local MoneroD support. The merge-miner proxy doesn't actually use the local MoneroD container if it is running. This is left as a TODO for the UI version. * Tor control password. For now, you set this manually. In the UI edition, this will be ephemeral and configured automatically. * GRPC addresses. The code only supports IPv4 addresses as gRPC configuration parameters. This makes the docker networking fragile since the IP addresses must be guessed. TODO - accept DNS names in gRPC configs to make this more robust. Resolve file permissions on internal docker volumes
Robust networking support in docker configurations requires us to be able to specify the gRPC address of things like the node and wallet in terms of domains instead of raw IP addresses. This adds support for MultiAddr specification of these addresses while still being 100% backwards compatible.
aviator-app bot
pushed a commit
that referenced
this pull request
Nov 10, 2021
Motivation and Context --- Robust networking support in docker configurations requires us to be able to specify the gRPC address of things like the node and wallet in terms of domains instead of raw IP addresses. This adds support for MultiAddr specification of these addresses while still being 100% backwards compatible. Also included in #3534 How Has This Been Tested? --- No new tests added.
Description --- - Fixed broken cucumber tests involving wallet startup - the promise was not returned when the wallet started up. - **Edit** Fixed "ambiguous" error in `Scenario: Massive multiple reorg` Motivation and Context --- See above. How Has This Been Tested? --- Running cucumber locally with `npm test -- --tags "not @long-running and not @broken"`
stringhandler
approved these changes
Nov 11, 2021
sdbondi
added a commit
to sdbondi/tari
that referenced
this pull request
Nov 18, 2021
* development: (32 commits) feat: add atomic swap refund transaction handling (tari-project#3573) feat: improve wallet connectivity status for console wallet (tari-project#3577) v0.21.1 feat: add error codes to LibWallet for CipherSeed errors (tari-project#3578) ci: split cucumber job into two (tari-project#3583) feat(wallet): import utxo’s as EncumberedToBeReceived rather than Unspent (tari-project#3575) docs: rfc 0250_Covenants (tari-project#3574) feat: get fee for transactions for stratum transcoder (tari-project#3571) test: make monerod stagenet usage resilient (tari-project#3572) feat: add atomic swap htlc sending and claiming (tari-project#3552) feat: implement prometheus metrics for base node (tari-project#3563) feat: implement multiple read single write for sqlite (tari-project#3568) feat: trigger time lock balance update when block received (tari-project#3567) test: reduce cucumber ci to critical only (tari-project#3566) test: fix cucumber console wallet startup (tari-project#3564) chore: add node id/public key to log mdc (tari-project#3559) fix: avoid implicit using of the time crate (tari-project#3562) feat: one-click installer - cli edition (tari-project#3534) ci: add workflow dispatch to libwallet build action (tari-project#3556) fix: stop leak of value of recovered output (tari-project#3558) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Tari Launchpad - CLI edition
Code changes
a.k.a. Tari one-click miner.
Currently this only works on MacOS and Linux.
Contributions for
quick_start.batare welcomed.Prerequisites
DATA_FOLDER(required). The path to store the Tari configuration files and logs. You can create multiplenetwork setups, each in their own sandbox.
TARI_NETWORK(optional). Default=weatherwax. Specify the Tari network to connect to.START_TOR(optional). Default=1. Whether we should start a Tor instanceSTART_BASE_NODE(optional). Default=1. Whether we should start a base node instanceSTART_WALLET(optional). Default=1. Whether we should start a wallet instance (GRPC only)START_MINER(optional). Default=1. Whether we should fire up a SHA_3 solo miner.USE_OWN_MODEROD(optional). Default=0. Whether we should start and sync our own Monero node.START_MONERO_MM(optional). Default=1. Whether we should start merge-mining on Monero.TARI_WALLET_PASSWORD(optional). Highly recommended. Default: tari. The password for your Tari wallet.TARI_WALLET__WEATHERWAX__TOR_CONTROL_AUTH(optional). Default: tari. The password for the Tor control auth.TARI_MONERO_WALLET_ADDRESS(optional). Though you'll donate funds to some random address if you don't set it.Quick Start
./quick-start.shAnd you should be golden.
Interacting with the wallet and base node.
Any Tari client that supports gRPC can be connected to the node setup. With the default configuration, the base node
will be at
http://127.0.0.1:18142and the wallet will be athttp://127.0.0.1:18143.Kreya is a fairly user-friendly gRPC client that can give you a rudimentary UI to the docker rig
out of the box:
Getting block information
Wallet - whoami
Wallet - send transactions
Viewing logs and configuration files
Logs and configuration files are stored in
{DATA_FOLDER}/{app}/log/*.log.So assuming your data folder is `/tmp/tari1/, the generated file structure looks like:
You can edit the network configuration (requires a container restart) and log configuration (takes effect within 30s)
by editing the files in the top-level
configfolder.Current shortcomings and TODOs
It's a CLI only. Next step is to build a nice UI wrapper around this.
TODO - Windows support.
The blockchain data is stores in docker volumes, and not on the host machine directly. This is due to crippling performance
limitations one suffers when mounting host file system from Windows or MacOS into docker containers.
This isn't a big drawback, since you seldom want or need to access the raw blockchain database files anyway. They're
still accessible. But ensure that you reserve enough space to store the Tari, and optionally,
Monero blockchains inside the Docker VM.
TODO - Multi-network sandboxing. Sandboxing currently doesn't work across different networks (e.g. weatherwax and mainnet). This should be fixed soon.
Local MoneroD support. The merge-miner proxy doesn't actually use the local MoneroD container if it is running. This
is left as a TODO for the UI version.
Tor control password. For now, you set this manually. In the UI edition, this will be ephemeral and configured automatically.
GRPC addresses. The code only supports IPv4 addresses as gRPC configuration parameters. This makes the docker networking
fragile since the IP addresses must be guessed. TODO - accept DNS names in gRPC configs to make this more robust.
Accessing blockchain data
The blockchain data is stored in a docker volume for performance reasons. If you need to back up or access the LMDB
a blockchain data, you can use something like this to extract it to the host filesystem:
docker run --rm -v $(pwd):/backup -v blockchain:/blockchain ubuntu tar czvf /backup/backup.tar.gz /blockchain