Dojo contains a suite of built in tools designed to allow you to effectively manage and interact with your instance of Dojo. This section will review the tools that are available and how to use them.
¶ Maintenance Tool
The Tor web browser is required to access the Maintenance Tool.
The Maintenance Tool is a web interface accessible through Tor and allowing to run maintenance operations. This tool can be seen as a graphical interface wrapping calls to web services provided by the REST API of MyDojo.
¶ Signing In
The Maintenance Tool is accessed through an onion address that can be retrieved with the ./dojo.sh onion command of the Dojo shell script. The onion address of the Maintenance Tool is identified by the label API hidden service address (v3).
Accesses to the Maintenance Tool are protected by an authentication mechanism requiring the knowledge of an Admin Key.
This Admin Key is the value set for the NODE_ADMIN_KEY configuration option. Additionally, you can now sign in using Auth47 by changing the configuration inside conf/docker-node.conf and just assign your PayNym PM8T payment code to the NODE_PAYMENT_CODE variable.
¶ Dojo Status
- Fullnode Status
- Tracker Status
- API Server Status.
¶ PushTx Status
- Monitor the transactions pushed through your Dojo.
- View transactions scheduled with Orchestrator
¶ Pairing
- First QR code allows to pair the software client to the REST API provided by this instance of MyDojo.
- Second QR code allows to pair the software client to the blocks explorer provided by this instance MyDojo.
¶ XPUBs Tool
- Check if a XPUB is tracked by your Dojo.
- Import and track a new XPUB.
- Rescan the full history of a XPUB.
¶ Missing Balance
- Log into your Dojo maintenance Tool using the Tor browser.
- Check there are no errors shown in the Dojo status tab. Check that the block heights matching between the full node and tracker sections.
- In Samourai mobile wallet tap your PayNym icon in the top left corner, then go to Settings > Wallet > Show XPUB
Which extended public key you choose will depend where your funds you are looking for are located within your wallet.
-
BIP44 XPUB = Your deposit account for addresses starting with a '1'
-
Segwit BIP49 YPUB = Your deposit account for addresses starting with a '3'
-
Segwit BIP84 ZPUB = Your deposit account for addresses starting with 'bc'
By default Samourai Wallet uses BIP84 ZPUB so it's likely that this is the one you will need if you are scanning for a balance in your deposit account.
-
Whirlpool pre-mix ZPUB = The account for any funds sent to Whirlpool that have not yet been mixed
-
Whirlpool post-mix ZPUB = The account where your mixed funds will be sat
Copy the public key of the account you wish to check using Dojo Maintenance Tool and pass this information to the computer you are using to access Dojo Maintenance Tool with.
- In Dojo Maintenance Tool click on 'xpubs tool' and paste the public key info you just shared from your wallet.
- Click go and wait until Dojo has finished processing this information. Once this is complete you should see a Status ok result.
The result should look similar to the below. The main things to look for here are...
- Tracked since = Date
- Balance = Your expected balance
- Derivation = The derivation type relevant to your xpub
If the derivation type is incorrect you can retype this xpub to the desired type.
- If you do not see a balance or the result indicates that Dojo is not tracking the xpub, press rescan this xpub. Start with the default values and hit rescan.
- If you still do not see your balance, increase the lookahead value by 100 and repeat.
-
Restart your Samourai Wallet app and wait for the loading line to disappear and navigate to the part of the wallet where you expect to see your funds eg Deposit (the wallet opens on this page), Premix or Postmix and you should see all of your sats.
-
If you have funds stored in multiple parts of the wallet simply repeat Steps 4-8 for the relevant extended public key.
¶ Addresses Tool
- Check if an address is tracked by your Dojo.
- Import and track a new address.
- Rescan the full history of an address.
¶ Transactions Tool
- Check if a transaction is found in a block or in the mempool of your full node.
- Get shown the Hex format for your transaction which can be placed into one of several transaction broadcasting tools to (re)broadcast the transaction if necessary.
¶ Blocks Rescan
- Force the Tracker to rescan a range of blocks.
¶ Block Explorer
The Tor web browser is required to access the Maintenance Tool.
MyDojo is packaged with a fully functional block explorer called BTC RPC Explorer.
¶ Signing In
The block explorer is accessed through an onion address that can be retrieved with the ./dojo.sh onion command of the Dojo shell script. The onion address of the Maintenance Tool is identified by the label Explorer hidden service address (v3).
Access is protected by a password that is the value set for the EXPLORER_KEY option in the Explorer configuration options. The user name can be any value.
¶ Pair wallet to block explorer
You can pair your Samourai Wallet or your Sentinel with the block explorer of MyDojo in 2 steps.
- Open the maintenance tool in a Tor browser and sign in with your admin key.
- With your smartphone, launch Samourai Wallet. Scan the second QRCode displayed in the Pairing tab of the maintenance tool.
This functionality is not yet available in Samourai Wallet
¶ Deactivate the block explorer
You can deactivate the block explorer hosted by MyDojo by setting the EXPLORER_INSTALL configuration option to off.
Not Recommended
¶ Limitations
- Display of past transactions related to a Bitcoin address requires that the Indexer module or that an external Electrum server have been activated.
- For security reasons, MyDojo deactivates all calls made by the block explorer to the RPC API of the full node.
¶ Dojo Shell Script
A linux shell script supporting multiple commands allowing to interact with your Dojo (install, updates, Dojo logs, etc).
# Change the working directory to the directory storing the shell script
# (e.g.: Dojo has been installed in the home directory of a linux user named dojo)
> cd /home/dojo/dojoapp/docker/my-dojo
# Call the shell script (e.g. displays the help)
./dojo.sh help
The Dojo shell script must be called with a UNIX account allowed to access Docker on your machine. If Docker has been installed for root only (default), you must prefix all calls to
dojo.shwith sudo.
The Dojo shell script is called in command line through a terminal window or through SSH if you’re running MyDojo on a headless operating system.
¶ help
- Displays a help page listing all commands supported by the shell script.
./dojo.sh help
¶ version
- Displays the version of Dojo currently stored in the Dojo directory of the host machine.
./dojo.sh version
¶ install
- Runs the first installation of MyDojo on the machine (i.e. shell script installs and initializes MyDojo from scratch).
- This command should be called only once on the host machine.
./dojo.sh install
The
uninstallcommand should be called before calling theinstallcommand again.
¶ upgrade
- Updates your Dojo with the version stored in the Dojo directory of the host machine.
- See the Updates section of this doc for a full description of the update process.
./dojo.sh upgrade
Updates preserve all data previously stored by MyDojo (local database, blockchain data, indexes, etc)
¶ start
- Starts MyDojo if it isn’t running.
./dojo.sh start
MyDojo should start automatically when the Docker service starts on the host machine.
¶ stop
- Starts MyDojo if it isn’t running.
./dojo.sh stop
Always use this command before shutting down the host machine.
¶ restart
- Restarts MyDojo if it is running.
./dojo.sh restart
This command is equivalent to running the
stopandstartcommands.
¶ logs
- Displays the logs generated by the different components of MyDojo.
./dojo.sh logs [module] [options]
¶ Available logs
- General logs - Displays the logs of main software components of MyDojo.
./dojo.sh logs - Bitcoind logs - Displays the logs of the bitcoin daemon.
./dojo.sh logs bitcoind - Database logs - Displays the logs of MyDojo database.
./dojo.sh logs bitcoind - Tor logs - Displays the logs of the Tor server.
./dojo.sh logs tor - Indexer logs - Displays the logs of the addresses indexer.
./dojo.sh logs indexer - Explorer logs - Displays the logs of the blocks explorer.
./dojo.sh logs indexer
Core modules logs
Logs of the core modules of Dojo are available through the logs command with the support of advanced options.
./dojo.sh logs [module_name] [-d display_mode] [-n nb_lines]
module_name- Value identifying the module- supported values:
api|tracker|pushtx|pushtx_orchest
- supported values:
-d- Option allowing to display a specific type of logs (info/error)- supported values:
output info|output logs|error info|error logs
- supported values:
-n- Option allowing to display a historical record of a log instead of real time logs.- Type:
Integer - Value: Number of lines to be displayed.
- Type:
¶ onion
- Displays the Tor onion addresses of the hidden services hosted by MyDojo (bitcoin daemon, blocks explorer, API and maintenance tool).
./dojo.sh onion
¶ bitcoin-cli
- Interacts with the bitcoin daemon through its RPC API.
./dojo.sh bitcoin-cli fcn_name [fcn_args]
See Bitcoin Core documentation for a list of available functions.
¶ clean
- Frees disk space on the host machine by deleting Docker images of previous MyDojo versions.
./dojo.sh clean
¶ uninstall
- Uninstalls MyDojo from the host machine.
./dojo.sh uninstall
This command is irreversible and removes all data previously stored by MyDojo on the host machine.