Tez Capital Docs

https://docs.tez.capital/
Admin
Tez Capital provides documentation for its suite of tools designed for the Tezos blockchain,...
Tokens:37,974
Snippets:283
Trust Score:5.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Download and Install TezPay via CLI

Source: https://docs.tez.capital/tezpay/tutorials/setup

This command sequence provides an alternative method to download and install TezPay directly from the GitHub repository using the command-line interface. It fetches the 'install.sh' script and then executes it.

```bash
wget -q https://raw.githubusercontent.com/tez-capital/tezpay/main/install.sh -O /tmp/install.sh && sh /tmp/install.sh
```

--------------------------------

### Download and Install TezBake

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-ghostnet

This script downloads the latest TezBake installer from GitHub and executes it, copying TezBake to the /usr/sbin directory. It is compatible with both x86_64 and arm64 architectures.

```bash
wget -q https://github.com/tez-capital/tezbake/raw/main/install.sh -O /tmp/install.sh && sudo sh /tmp/install.sh
```

--------------------------------

### Start TezPeak Command

Source: https://docs.tez.capital/tezpay/tutorials/setup-peak-gui

This command-line snippet demonstrates how to start the TezPeak service using the `tezbake` utility. This initiates the TezPeak application, making it accessible for configuration and monitoring.

```Shell
tezbake start --peak
```

--------------------------------

### Download and install TezPeak via TezBake

Source: https://docs.tez.capital/tezpay/tutorials/setup-peak-gui

This command uses TezBake to download and install the TezPeak application. It's a quick way to get TezPeak set up without needing to install TezBake's node or baker services.

```shell
tezbake setup --peak
```

--------------------------------

### Setup Tezos Node and TezBake Dependencies

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-ghostnet

Initializes the Tezos node and installs necessary TezBake dependencies. It uses a specified configuration URL to set up the node, typically for a network like Ghostnet.

```bash
tezbake setup --node-configuration=https://raw.githubusercontent.com/tez-capital/xtz.configs/main/ghostnet.json
```

--------------------------------

### Install TezPeak via TezBake

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-peak-gui

This command uses the TezBake setup utility to download and install TezPeak. It's the initial step for setting up the GUI.

```bash
tezbake setup --peak
```

--------------------------------

### TezBake Pay Module Command Cheatsheet

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

A quick reference guide for common TezBake commands related to the TezPay module, including installation, payout generation, and service management.

```APIDOC
Task: Install TezPay Module
Command: tezbake setup --pay

Task: Verify Installation
Command: tezbake apps

Task: Generate Payouts
Command: tezbake pay generate-payouts

Task: Check Continual Payout Status
Command: tezbake pay continual status

Task: Enable Continual Payouts
Command: tezbake pay continual enable

Task: Disable Continual Payouts
Command: tezbake pay continual disable

Task: Start TezPay
Command: tezbake pay start or tezbake start --pay

Task: Stop TezPay
Command: tezbake pay stop or tezbake stop --pay

Task: TezPay Information
Command: tezbake info --pay

Task: Remove TezPay Module
Command: tezbake remove --pay
```

--------------------------------

### Start Tezos Node

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-ghostnet

Starts the Tezos node after a snapshot has been imported. After execution, the node will begin synchronizing with the network.

```bash
tezbake start
```

--------------------------------

### Run TezBake Setup with Trace Logging

Source: https://docs.tez.capital/tezbake/tutorials/troubleshooting

This command executes the TezBake setup process with the `--log-level=trace` option, which provides detailed output for debugging installation errors. This verbose logging can help identify the root cause of setup failures.

```bash
tezbake setup --log-level=trace
```

--------------------------------

### Install TezPay Module

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

Command to install the TezPay module within the TezBake environment.

```Shell
tezbake setup --pay
```

--------------------------------

### Verify TezPay Module Installation

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

Command to verify that the TezPay module has been successfully installed in TezBake.

```Shell
tezbake apps
```

--------------------------------

### Minimal TezPeak configuration for TezPay

Source: https://docs.tez.capital/tezpay/tutorials/setup-peak-gui

This HJSON example demonstrates a minimal `config.hjson` setup for TezPeak, specifically configuring the `tezpay` module. It specifies the listening address and port for the application, the root directory, and the payout wallet address for TezPay.

```hjson
{
 listen: 0.0.0.0:8733
 app_root: /bake-buddy
 modules: {
     tezpay: {
         payout_wallet: tz1X7U9XxVz6NDxL4DSZhijME61PW45bYUJE
     }
 }
}
```

--------------------------------

### Start TezPay Continual Service

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

These commands are used to start the TezPay continual service, which processes payouts automatically. Both direct and combined `tezbake` commands are provided.

```shell
tezbake pay start
```

```shell
tezbake start --pay
```

--------------------------------

### Setup Tezos Node and Tezbake Dependencies

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-mainnet

This command initializes the Tezos node, configures the signer, and installs all necessary Tezbake dependencies. Execution may prompt for a sudo password to complete the setup process.

```sh
tezbake setup
```

--------------------------------

### Minimal TezPay Configuration File (config.hjson)

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

Provides a minimal example of the `config.hjson` file for TezPay, specifying the baker address, payout fee percentage, whether the delegator pays transfer fees, and the minimum payout amount in XTZ.

```hjson
{
  baker_address: "tz1-your-baker-wallet-address",
  payout_fee: 0.05, // 5% fee
  delegator_pays_xfer_fee: true,
  min_payout: 1 // minimum payout 1 XTZ
}
```

--------------------------------

### Download and Install Tezbake

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-mainnet

This script downloads the latest version of TezBake from its GitHub repository and installs it to the /usr/sbin directory. It is compatible with both x86_64 and arm64 architectures and may require a sudo password for installation.

```sh
wget -q https://github.com/tez-capital/tezbake/raw/main/install.sh -O /tmp/install.sh && sudo sh /tmp/install.sh
```

--------------------------------

### tezbake setup Command Options Reference

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup

This section details all available command-line options for `tezbake setup`, including their types, default values, and descriptions. Options allow for fine-grained control over component setup, branching, configuration, and experimental remote operations.

```APIDOC
tezbake_setup:
  Synopsis: Installs and configures BB instance.
  Usage: tezbake setup [flags]
  Options:
    - --branch (string): Select package release branch you want to setup (addets node and signer app only). (default "main")
    - --dal: Setups dal.
    - --dal-branch (string): Sets dal configuration.
    - --dal-configuration (string): Sets dal configuration. (default "{}")
    - --dal-remote (string): username:<ssh key file>@address (experimental)
    - --dal-remote-auth (string): pass|key:<path to key>  (experimental)
    - --dal-remote-elevate (string): only 'sudo' supported now (experimental)
    - --dal-version (string): Sets dal configuration. (default "latest")
    - --disable-post-process: Disables post process - app linking node <-> dal.
    - --force: Force setup - potentially overwriting existing installation.
    - -h, --help: help for setup
    - -i, --id (string): Id of BB instance. (default "bb-default")
    - --node: Setups node.
    - --node-branch (string): Sets node configuration.
    - --node-configuration (string): Sets node configuration. (default "{}")
    - --node-remote (string): username:<ssh key file>@address (experimental)
    - --node-remote-auth (string): pass|key:<path to key>  (experimental)
    - --node-remote-elevate (string): only 'sudo' supported now (experimental)
    - --node-version (string): Sets node configuration. (default "latest")
    - --pay: Setups pay.
    - --pay-branch (string): Sets pay configuration.
    - --pay-configuration (string): Sets pay configuration. (default "{}")
    - --pay-version (string): Sets pay configuration. (default "latest")
    - --peak: Setups peak.
    - --peak-branch (string): Sets peak configuration.
    - --peak-configuration (string): Sets peak configuration. (default "{}")
    - --peak-version (string): Sets peak configuration. (default "latest")
    - --remote-reset: Resets and reconfigures remote node locator. (experimental)
    - --signer: Setups signer.
    - --signer-branch (string): Sets signer configuration.
    - --signer-configuration (string): Sets signer configuration. (default "{}")
    - --signer-version (string): Sets signer configuration. (default "latest")
    - --skip-ami-setup: Skip ami setup.
    - -u, --user (string): User you want to operate BB under. (default "runner")
    - --with-dal: Setup dal node. (experimental)
```

--------------------------------

### Tezbake Setup Ledger Command Synopsis

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup-ledger

The basic command line usage for `tezbake setup-ledger`, showing its general structure with flags.

```bash
tezbake setup-ledger [flags]

```

--------------------------------

### Synopsis of tezbake setup Command

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup

This snippet shows the basic command-line syntax for `tezbake setup`, indicating that it accepts various flags to customize its behavior.

```CLI
tezbake setup [flags]
```

--------------------------------

### Expected TezPay Installation Verification Output

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

The expected output when verifying the TezPay module installation, indicating its active status.

```Shell
pay    │ true
```

--------------------------------

### TezBake Prism CLI Command Cheatsheet

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

A quick reference for `tezbake` command-line interface operations related to Prism tunneling setup, including installation, removal, key generation, configuration activation, and service startup.

```Shell
tezbake setup --node --node-remote <user>@<ip>:<port> ...
```

```Shell
tezbake setup --dal --dal-remote <user>@<ip>:<port> ...
```

```Shell
tezbake remove --node --all
```

```Shell
tezbake remove --dal --all
```

```Shell
tezbake <app> prism generate-ca --output=/bake-buddy/<app>/prism/keys/ca
```

```Shell
tezbake <app> prism generate-key --ca=... --name=... --output=...
```

```Shell
tezbake <app> prism key-info --path=<key>.prism
```

```Shell
tezbake upgrade
```

```Shell
tezbake start
```

--------------------------------

### Full TezPeak Configuration Example

Source: https://docs.tez.capital/tezpay/tutorials/setup-peak-gui

This snippet provides a complete TezPeak configuration, showcasing all available TezPay options, including application paths, payout wallet settings, and force dry run. It also defines multiple reference nodes (Tezos Foundation, TzKT) with their addresses and roles (rights/block provider), and specifies the operational mode (auto, public, private).

```YAML
{
 # Id to show in the header
 id: ""
 # Address to listen on
 listen: 127.0.0.1:8733
 app_root: /bake-buddy
 modules: {
     tezpay: {
 		# can be null to disable tezpay package monitoring
         applications: {
 			# path to tezpay ami package, either absolute or relative to parent directory peak
             tezpay: tezpay
         }
         payout_wallet: tz1X7U9XxVz6NDxL4DSZhijME61PW45bYUJE
         payout_wallet_preferences: {
             balance_warning_threshold: 100
             balance_error_threshold: 50
         }
 		# forces all operations to be dry run
         force_dry_run: true
     }
 }

 # List of reference nodes to connect to
 # The reference nodes are used to get the rights and blocks if the baker's node is not available
 nodes: {
     "Tezos Foundation": {
         address: https://rpc.tzbeta.net/
         is_rights_provider: true
         is_block_provider: false
     }
     tzkt: {
         address: https://rpc.tzkt.io/mainnet/
         is_rights_provider: false
         is_block_provider: true
         # reports error if node not available, use for baker's node
         is_essential: false
     }
 }
 # The mode tezpeak should operate in
 # auto - if bound to localhost, it will operate in private mode if not, it will operate in public mode
 # public - assumes public environment, only readonly operations are allowed
 # private - assumes private environment, all operations are allowed
 mode: auto
}
```

--------------------------------

### tezbake start Command Specific Options

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_start

Lists the flags specific to the `tezbake start` command, allowing users to selectively start services for components such as DAL, node, pay, peak, or signer. Includes a help flag for command-specific assistance.

```CLI
      --dal      Starts dal's services.
  -h, --help     help for start
      --node     Starts node's services.
      --pay      Starts pay's services.
      --peak     Starts peak's services.
      --signer   Starts signer's services.
```

--------------------------------

### Install latest TezBake prerelease version

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-dal

Downloads and executes the TezBake installation script from GitHub to install the latest prerelease version. This step is required for new TezBake setups that intend to integrate with DAL.

```bash
wget -q https://github.com/tez-capital/tezbake/raw/main/install.sh -O /tmp/install.sh && sudo sh /tmp/install.sh --prerelease
```

--------------------------------

### Start all TezBake services and Prism tunnels

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

Final command to initialize all TezBake services and establish secure Prism tunnels, bringing the entire baking infrastructure online and operational.

```bash
tezbake start
```

--------------------------------

### Sample TezPeak configuration for one baker (local access)

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-peak-gui

This HJSON configuration example provides a minimal setup for TezPeak with a single baker, configured to listen only on the local loopback interface (127.0.0.1:8733). This is ideal for all-in-one setups where the baker and GUI are on the same machine and access is restricted to local connections.

```hjson
{
 listen: 127.0.0.1:8733
 app_root: /bake-buddy
 modules: {
     tezbake: {
         bakers: [
             tz1S5WxdZR5f9NzsPXhr7L9L1vrEb5spZFur
         ]
     }
 }
}
```

--------------------------------

### Sample TezPeak configuration for one baker (public access)

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-peak-gui

This HJSON configuration example shows a minimal setup for TezPeak with a single baker, configured to listen on all network interfaces (0.0.0.0:8733). It's suitable for setups where the GUI needs to be accessible from other machines.

```hjson
{
 listen: 0.0.0.0:8733
 app_root: /bake-buddy
 modules: {
     tezbake: {
         bakers: [
             tz1S5WxdZR5f9NzsPXhr7L9L1vrEb5spZFur
         ]
     }
 }
}
```

--------------------------------

### Bootstrap Tezos Node from Snapshot

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-ghostnet

Bootstraps the Tezos node by downloading a blockchain snapshot from a given URL. Optionally, a block hash can be provided for verification, which is encouraged for security. This method significantly reduces synchronization time compared to block-by-block syncing.

```bash
tezbake bootstrap-node <url> <block_hash>
# example:
tezbake bootstrap-node https://snapshots.tzinit.org/ghostnet/rolling BL8Vq12HX6MJWkB6RLgQAYRKpKZ5fyMoLpWzAoQ6mh55gkKHiQU
```

--------------------------------

### tezbake start Command Synopsis

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_start

Provides the basic command-line syntax for initiating the `tezbake start` command, indicating that it accepts optional flags.

```CLI
tezbake start [flags]
```

--------------------------------

### List Available Protocols in TezBox Container (Mainnet Version)

Source: https://docs.tez.capital/tezbox/tutorials/setup

This command executes the 'tezbox' entrypoint within the 'tezos-v20.3' TezBox Docker container to list all available Tezos protocols supported by that specific container image.

```bash
sudo docker run -it --entrypoint tezbox ghcr.io/tez-capital/tezbox:tezos-v20.3 list-protocols
```

--------------------------------

### TezPay Migration Directory Path

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

The target directory for migrating existing TezPay configuration and key files when moving to the integrated TezBake module.

```Text
/bake-buddy/pay
```

--------------------------------

### Start Tezos Node

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-mainnet

Initiates the Tezos node process after a snapshot has been imported. The node must fully synchronize with the network before proceeding with operations such as importing a Ledger key.

```sh
tezbake start
```

--------------------------------

### List Available Protocols in TezBox Container (RC Version)

Source: https://docs.tez.capital/tezbox/tutorials/setup

This command executes the 'tezbox' entrypoint within the 'tezos-v21.0-rc4' TezBox Docker container to list all available Tezos protocols supported by that specific Release Candidate image.

```bash
sudo docker run -it --entrypoint tezbox ghcr.io/tez-capital/tezbox:tezos-v21.0-rc4 list-protocols
```

--------------------------------

### Example TezWatch Baker Notification Subscription Command

Source: https://docs.tez.capital/tezwatch/tutorials/setup

Provides an example of a slash command to subscribe to specific baker performance notifications, such as missed attestations or missed blocks, for a designated Tezos address. This command illustrates the practical application of the `source`, `event`, and `conditions` variables.

```APIDOC
/subscribe source:baking event:missed-attestation,missed-block conditions:tz1UGkfyrT9yBt6U5PV7Qeui3pt3a8jffoWv
```

--------------------------------

### View TezPay Service Information

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

This command displays detailed information about the TezPay continual service, including its status and other relevant operational data.

```shell
tezbake info --pay
```

--------------------------------

### TezPay Starter Configuration Template

Source: https://docs.tez.capital/tezpay/configuration/examples/starter

This configuration template serves as a starting point for setting up TezPay. It defines the configuration file version, the baker's public key hash, and detailed payout settings including balance check mode, fee percentage, and minimum payout amount. Additionally, it specifies delegator requirements such as minimum balance and enables overdelegation protection. The comments within the code provide guidance and links to more extensive configuration examples.

```YAML
{
#=====================================================================================================
# This is tezpay starter configuration template. Please refer to https://docs.tez.capital/tezpay/
# - for default configuration (list of default values) see https://docs.tez.capital/tezpay/configuration/examples/default/.
# - for sample of all available fields see https://docs.tez.capital/tezpay/configuration/examples/sample/.
#=====================================================================================================

  # version of the configuration file
  tezpay_config_version: 0

  # baker's public key hash
  baker: your-baker-address

  # payout configuration
  payouts: {

    # balance check mode to use, can be 'protocol' or 'tzkt'
    balance_check_mode: protocol

    # fee to charge delegators for the payout (portion of the reward as decimal, e.g. 0.075 for 7.5%)
    fee: 0.1

    # minimum amount to pay out to delegators, if the amount is less, the payout will be ignored
    minimum_payout_amount: 0.01
  }

  # delegators configuration
  delegators: {
    # Requirements delegators have to meet
    requirements: {
      # Minimum balance of tez a delegator has to have to be considered for payout
      minimum_balance: 10
    }
  }

  # overdelegation protection configuration
  overdelegation: {
    protect: true
  }
}
```

--------------------------------

### Execute TezPay Payouts

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

This command initiates and executes the actual payout transactions to delegators according to the configured rules and generated payout reports.

```shell
tezbake pay pay
```

--------------------------------

### Create TezPeak configuration file

Source: https://docs.tez.capital/tezpay/tutorials/setup-peak-gui

Navigate to the TezPeak directory and create an empty `config.hjson` file. This file will store the configuration settings for TezPeak, including TezPay integration details.

```shell
cd /bake-buddy/peak/ && touch config.hjson
```

--------------------------------

### Set up TezBake Node remotely

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

Shows how to install the TezBake Node application on a remote machine via SSH, including remote user, IP, port, and SSH key path.

```bash
tezbake setup --node \
  --node-remote user@192.168.1.60:22 \
  --node-remote-auth key:/path/to/ssh/key
```

--------------------------------

### Install TezBake Prerelease Version

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-dal

Downloads and executes the TezBake installation script from GitHub to install the latest prerelease version. This step ensures you have the necessary base for DAL integration.

```Shell
wget -q https://github.com/tez-capital/tezbake/raw/main/install.sh -O /tmp/install.sh && sudo sh /tmp/install.sh --prerelease
```

--------------------------------

### Full TezBake Configuration Example with Consensus Key

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-consensus-key

Provides a complete example of the `app.json` configuration file for a TezBake node, illustrating how the `additional_key_aliases` entry for 'consensus' is integrated alongside other network and baking parameters.

```JSON
{
         "configuration": {
                 "BAKER_STARTUP_ARGS": [
                         "--dal-node",
                         "http://127.0.0.1:10732/"
                 ],
                 "CONFIG_FILE": {
                         "p2p": {
                                 "bootstrap-peers": [
                                         "boot.tzbeta.net"
                                 ],
                                 "limits": {
                                         "connection-timeout": 10,
                                         "expected-connections": 40,
                                         "max-connections": 50,
                                         "max_known_peer_ids": [
                                                 320,
                                                 240
                                         ],
                                         "max_known_points": [
                                                 320,
                                                 240
                                         ],
                                         "min-connections": 20
                                 },
                                 "listen-addr": "[::]:9732"
                         },
                         "shell": {
                                 "chain_validator": {
                                         "synchronisation_threshold": 6
                                 }
                         }
                 },
                 "NODE_TYPE": "baker",
                 "VOTE_FILE": {
                         "adaptive_issuance_vote": "on",
                         "liquidity_baking_toggle_vote": "on"
                 },
                 "additional_key_aliases": [
                         "consensus"
                 ]
         },
         "id": "bb-default-node",
         "type": {
                 "id": "xtz.node",
                 "version": "latest"
         },
         "user": "bb"
 }
```

--------------------------------

### Full Application Configuration Example

Source: https://docs.tez.capital/tezpay/configuration/examples/sample

A comprehensive example of an application's configuration file, demonstrating how to set up various notification channels (e.g., Discord, Twitter, Telegram, Email, external services) and define custom extensions with their respective commands, arguments, and hooks. It also includes a global setting for analytics.

```YAML
      message_template: my awesome message
      admin: true
    }
    {
      type: discord
      webhook_id: webhook id
      webhook_token: webhook token
      message_template: my awesome message
    }
    {
      type: twitter
      access_token: your access token
      access_token_secret: your access token secret
      consumer_key: your consumer key
      consumer_secret: your consumer secret
      message_template: my awesome message
    }
    {
      type: telegram
      api_token: your api token
      receivers: [
        list of chat numbers without quotes
        -1234567890
      ]
      message_template: my awesome message
    }
    {
      type: email
      sender: my@email.is
      smtp_server: smtp.gmail.com:443
      smtp_identity: ""
      smtp_username: my@email.is
      smtp_password: password123
      recipients: [
        my-follower1@email.is
        my-follower2@email.is
      ]
      message_template: my awesome message
    }
    {
      type: external
      path: path to external notificator binary
      args: [
        --kind
        <kind>
        <data>
      ]
    }
  ]

  # extensions (for custom functionality)
  extensions: [
    {
      name: log-extension
      command: python3
      args: [
        /path/to/my/extension.py
      ]
      kind: stdio
      configuration: {
        LOG_FILE: path/to/my/extension.log
      }
      hooks: [
        {
          id: all
          mode: ro
        }
      ]
    }
    {
      name: fee-extension
      command: /path/to/my/extension.bin
      args: [
        --config
        /path/to/my/extension.config
      ]
      kind: stdio
      configuration: {
        FEE: 0
        TOKEN: "1"
        CONTRACT: KT1Hkg6qgV3VykjgUXKbWcU3h6oJ1qVxUxZV
      }
      hooks: [
        {
          id: after_candidates_generated
          mode: rw
        }
      ]
    }
  ]

  # disables analytics, please consider leaving it enabled🙏
  disable_analytics: true
}
```

--------------------------------

### Run TezBox Container in Background for RC Protocols (Qena42)

Source: https://docs.tez.capital/tezbox/tutorials/setup

This command starts the TezBox Docker container for Release Candidate protocols (Qena42) in detached mode ('-d'), allowing it to run in the background. Port 8732 is mapped for external access.

```bash
sudo docker run -d -p 0.0.0.0:8732:8732 ghcr.io/tez-capital/tezbox:tezos-v21.0-rc4 qenabox
```

--------------------------------

### Run TezBox Container for RC Protocols (Qena42)

Source: https://docs.tez.capital/tezbox/tutorials/setup

This command launches the TezBox Docker container for testing Release Candidate protocols. It uses the 'tezos-v21.0-rc4' image and specifies 'qenabox' to activate the Qena42 protocol, mapping port 8732 for access.

```bash
sudo docker run -it -p 0.0.0.0:8732:8732 ghcr.io/tez-capital/tezbox:tezos-v21.0-rc4 qenabox
```

--------------------------------

### Set up TezBake DAL remotely

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

Demonstrates how to install the TezBake Data Availability Layer (DAL) application on a remote machine using SSH, specifying the remote user, IP, port, SSH key path, and elevation method.

```bash
tezbake setup --dal \
  --dal-remote user@192.168.1.50:22 \
  --dal-remote-auth key:/path/to/ssh/key \
  --dal-remote-elevate sudo
```

--------------------------------

### Start TezPeak via TezBake Command

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-peak-gui

This command initiates the TezPeak application using the TezBake utility. It launches the necessary services for TezPeak to run, allowing users to access its web interface.

```Shell
tezbake start --peak
```

--------------------------------

### Run TezBake setup with DAL integration

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-dal

Executes the TezBake setup command, enabling integration with the Data Availability Layer (DAL). This command configures TezBake to work with a local DAL node.

```bash
tezbake setup --with-dal
```

--------------------------------

### Tezbake Setup-AMI Command Synopsis

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup-ami

Shows the basic command-line syntax for `tezbake setup-ami`, indicating it accepts various flags.

```bash
tezbake setup-ami [flags]

```

--------------------------------

### TezPay Import Configuration Usage Examples

Source: https://docs.tez.capital/tezpay/reference/cmd/tezpay_import-configuration

Demonstrates how to import configuration from various supported sources, such as 'bc' (blockchain) or 'trd' (transaction data), by providing the source type and the path to the configuration file.

```Shell
tezpay import-configuration bc ./bc.json
tezpay import-configuration trd ./trd.yaml
```

--------------------------------

### Activate TezBake configurations

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

Command to apply updated `app.json` configurations and prepare the TezBake runtime, ensuring all changes take effect across deployed applications.

```bash
tezbake upgrade
```

--------------------------------

### Make TezPay Binary Executable

Source: https://docs.tez.capital/tezpay/tutorials/trd-migration

Command to grant execute permissions to the downloaded TezPay binary on Linux/Unix systems, making it runnable from the command line.

```Shell
chmod +x ./tezpay
```

--------------------------------

### Retrieve TezWatch Available Events

Source: https://docs.tez.capital/tezwatch/tutorials/setup

Demonstrates how to use the `/events` slash command within the TezWatch Discord channel to list all available sources and events for baker performance monitoring.

```APIDOC
/events
```

--------------------------------

### Bootstrap Tezos Node from Snapshot

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-mainnet

Bootstraps the Tezos node by downloading a blockchain snapshot, which significantly reduces synchronization time compared to block-by-block syncing. The command requires a snapshot URL and optionally accepts a block hash for integrity verification.

```sh
tezbake bootstrap-node <url> <block_hash>
# example:
tezbake bootstrap-node https://snapshots.tzinit.org/mainnet/rolling BL8Vq12HX6MJWkB6RLgQAYRKpKZ5fyMoLpWzAoQ6mh55gkKHiQU
```

--------------------------------

### Verify TezBake DAL Prism key after distribution

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

Command to verify the Prism key information for the TezBake DAL application after it has been distributed to its designated location, ensuring correct setup.

```bash
tezbake dal prism key-info --path=/bake-buddy/node/prism/keys/dal.prism
```

--------------------------------

### Install Data Availability Layer (DAL) with TezBake

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-dal

Initiates the installation and configuration of the Data Availability Layer (DAL) within the TezBake environment. This command sets up the necessary DAL components.

```Shell
tezbake setup --dal
```

--------------------------------

### Verify TezBake Node Prism key after distribution

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

Command to verify the Prism key information for the TezBake Node application after it has been distributed to its designated location, ensuring correct setup.

```bash
tezbake node prism key-info --path=/bake-buddy/node/prism/keys/node.prism
```

--------------------------------

### Options Inherited from Parent Commands

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_start

Details the global options that `tezbake start` inherits from its parent commands. These options control aspects like log level, output format, the path to the Bake Buddy instance, and display of the tezbake version.

```CLI
  -l, --log-level string       Sets output log format (json/text/auto) (default "info")
  -o, --output-format string   Sets output log format (json/text/auto) (default "auto")
  -p, --path string            Path to bake buddy instance (default "/bake-buddy")
      --version                Prints tezbake version
```

--------------------------------

### Open TezBake Node Configuration File

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-consensus-key

Opens the `app.json` configuration file for the TezBake node using the `nano` text editor, allowing modifications to the baking setup.

```Shell
nano /bake-buddy/node/app.json
```

--------------------------------

### Check System Architecture

Source: https://docs.tez.capital/tezpay/tutorials/setup

This command is executed in a terminal to determine the system's architecture, which is crucial for selecting the correct TezPay release. It will return 'arm64' or 'amd64'.

```bash
uname -m
```

--------------------------------

### Create directory for TezBake Prism keys

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

Command to create the necessary directory structure for storing TezBake Prism Certificate Authority (CA) and identity keys securely.

```bash
mkdir -p /bake-buddy/<app>/prism/keys/
```

--------------------------------

### Verify TezBox Container Status with octez-client

Source: https://docs.tez.capital/tezbox/tutorials/setup

This command uses 'octez-client' to query the running TezBox node. It connects to the local host on port 8732 and retrieves the header of the current head block on the main chain, confirming the node's operational status.

```bash
octez-client -E http://127.0.0.1:8732 rpc get /chains/main/blocks/head/header
```

--------------------------------

### Remove all local TezBake Node and DAL installations

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-prism

Provides commands to completely remove previously installed local TezBake Node and DAL applications before proceeding with remote setups, ensuring a clean slate.

```bash
tezbake remove --node --all
tezbake remove --dal --all
```

--------------------------------

### Run TezBox Container for Mainnet (Paris Protocol)

Source: https://docs.tez.capital/tezbox/tutorials/setup

This command runs the TezBox Docker container in interactive mode, mapping port 8732 from the host to the container. It uses the 'tezos-v20.3' image and specifies 'parisbox' to activate the Paris protocol for Mainnet testing.

```bash
sudo docker run -it -p 0.0.0.0:8732:8732 ghcr.io/tez-capital/tezbox:tezos-v20.3 parisbox
```

--------------------------------

### Tezbake Inherited Command Options

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup-ami

Lists common command-line options inherited from parent `tezbake` commands, which control logging, output format, and instance path.

```APIDOC
  -l, --log-level string       Sets output log format (json/text/auto) (default "info")
  -o, --output-format string   Sets output log format (json/text/auto) (default "auto")
  -p, --path string            Path to bake buddy instance (default "/bake-buddy")
      --version                Prints tezbake version

```

--------------------------------

### TezBake Upgrade Command Specific Options

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_upgrade

Lists and describes the flags unique to the `tezbake upgrade` command, allowing users to specify which components (e.g., DAL, node, pay) to upgrade or to control the upgrade process (e.g., skipping AMI setup, upgrading storage).

```CLI
--dal               Upgrade dal.
  -h, --help              help for upgrade
      --node              Upgrade node.
      --pay               Upgrade pay.
      --peak              Upgrade peak.
      --signer            Upgrade signer.
      --skip-ami-setup    Skip ami upgrade
  -s, --upgrade-storage   Upgrade storage during the upgrade.
```

--------------------------------

### Tezbake Vote Command Usage Examples

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_vote

Illustrates various ways to use the `tezbake vote` command for different voting periods (Exploration, Proposal, Promotion), showing how to submit votes for proposals. It also shows the general command structure with flags.

```Shell
Submits vote for proposal/s based on provided voting period.

Exploration:
`tezbake vote --period exploration <proposal> yay|nay|pass`
Proposal:
`tezbake vote --period proposal <proposal1> <proposal2>`
Promotion:
`tezbake vote --period promotion <proposal> yay|nay|pass`

tezbake vote [flags]
```

--------------------------------

### Tezbake Setup-AMI Specific Options

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup-ami

Details the command-line options directly available for the `tezbake setup-ami` command, including help and silent mode.

```APIDOC
  -h, --help     help for setup-ami
      --silent   Do not print any output.

```

--------------------------------

### Setup TezBake Docker Container

Source: https://docs.tez.capital/tezbake/tutorials/baking-with-docker

This command runs a new Docker container named 'tezbake-container' using the previously pulled TezBake image. The `--privileged` flag grants extended privileges, and `-d` runs the container in detached mode. This initiates the Tezos node bootstrapping process within the container.

```Shell
sudo docker run --name tezbake-container --privileged -d ghcr.io/tez-capital/tezbake:latest-alpine
```

--------------------------------

### Remove TezPay Module Integration

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

This command removes the TezPay module integration from the `tezbake` setup. It's important to note that this action does not delete existing configuration files or payout reports.

```shell
tezbake remove --pay
```

--------------------------------

### Common Command-Line Options

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup

These options are inherited by all subcommands of `tezbake`, allowing users to configure logging verbosity, output data format, specify the path to the bake buddy instance, and retrieve the application version.

```CLI
  -l, --log-level string       Sets output log format (json/text/auto) (default "info")
  -o, --output-format string   Sets output log format (json/text/auto) (default "auto")
  -p, --path string            Path to bake buddy instance (default "/bake-buddy")
      --version                Prints tezbake version

```

--------------------------------

### View TezBake Signer Information

Source: https://docs.tez.capital/tezbake/tutorials/baking-on-mainnet

Displays comprehensive information about the configured TezBake signer, including the baker address, after a key has been successfully imported or set up. This command is useful for verifying the active baker and its associated details.

```shell
tezbake info
```

--------------------------------

### Synopsis of tezbake setup-soft-wallet command

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup-soft-wallet

This snippet illustrates the basic command-line usage syntax for `tezbake setup-soft-wallet`, indicating that it accepts various flags to modify its behavior.

```bash
tezbake setup-soft-wallet [flags]
```

--------------------------------

### Tezbake Setup Ledger Command Options

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup-ledger

Detailed options available for configuring the `tezbake setup-ledger` command, including parameters for authorization, chain ID, force import, help, high watermark, key import, key alias, ledger ID, udev rules, node import, platform preparation, protocol hash, and signer import.

```APIDOC
--authorize: Authorize ledger for baking.
--chain-id string: Id of chain to be used for baking.
-f, --force: Force key import. (overwrites existing)
-h, --help: help for setup-ledger
--hwm string: High watermark to be used during baking.
--import-key [string][=true]: Import key from ledger (optionally specify derivation path) (default )
--key-alias string: Alias ofkey to be imported (default "baker")
--ledger-id string: Ledger id to import key from (affects import-key only)
--no-udev string: Skip udev rules installation. (linux only)
--node: Import key to node (affects import-key only)
--platform [string][=true]: Prepare platform for ledger (optionally specify platform to override) (default )
--protocol string: Protocol hash to be used during setup-ledger.
--signer: Import key to signer (affects import-key only)

```

--------------------------------

### TezPay Payout Reports Storage Location

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

Specifies the default directory where TezPay stores all generated payout reports and related logs.

```plaintext
/bake-buddy/pay/reports
```

--------------------------------

### Options for tezbake setup-soft-wallet command

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup-soft-wallet

This section details the specific command-line options available for the `tezbake setup-soft-wallet` command. These options control aspects such as forcing key import, generating new keys, specifying keys to import, and setting key aliases.

```APIDOC
-f, --force               Force key import. (overwrites existing)
    --generate string     Generate key (default "ed25519")
-h, --help                help for setup-soft-wallet
    --import-key string   Import key
    --key-alias string    Alias ofkey to be imported (default "baker")
    --node                Import key to node (affects import-key only)
    --signer              Import key to signer (affects import-key only)
```

--------------------------------

### Build TezBox Project Steps

Source: https://docs.tez.capital/tezbox/tutorials/configuration

A series of commands detailing the steps required to build the TezBox project from source, including cloning the repository, building Lua sources, and building the Docker image.

```bash
git clone https://github.com/tez-capital/tezbox && cd tezbox
```

```bash
eli build/build.lua
```

```bash
sudo docker build --build-arg="PROTOCOLS=PsParisC" --build-arg="IMAGE_TAG=octez-v20.3" -t tezbox . -f containers/tezos/Containerfile --no-cache
```

--------------------------------

### Stop TezPay Continual Service

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

These commands are used to stop the running TezPay continual service. Both direct and combined `tezbake` commands are provided for convenience.

```shell
tezbake pay stop
```

```shell
tezbake stop --pay
```

--------------------------------

### Manage TezPay Continual Payouts Status

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

These commands allow users to check the current status of the continual payouts service, and to enable or disable its automatic operation.

```shell
tezbake pay continual status
```

```shell
tezbake pay continual enable
```

```shell
tezbake pay continual disable
```

--------------------------------

### Manually Generate TezPay Payouts Report

Source: https://docs.tez.capital/tezpay/tutorials/tezbake-integration

This command generates a report of potential payouts based on the current configuration and delegator balances. It is for display purposes only and does not execute any transactions.

```shell
tezbake pay generate-payouts
```

--------------------------------

### Options inherited from parent tezbake commands

Source: https://docs.tez.capital/tezbake/reference/cmd/tezbake_setup-soft-wallet

This section lists common command-line options that are inherited from parent `tezbake` commands. These options provide global control over aspects like output log format, general output format, and the path to the bake buddy instance.

```APIDOC
-l, --log-level string       Sets output log format (json/text/auto) (default "info")
-o, --output-format string   Sets output log format (json/text/auto) (default "auto")
-p, --path string            Path to bake buddy instance (default "/bake-buddy")
    --version                Prints tezbake version
```

--------------------------------

### Run TezPay Continual Payouts

Source: https://docs.tez.capital/tezpay/tutorials/trd-migration

Starts TezPay in a continuous mode, automatically processing payouts as new cycles complete. This is ideal for setting up TezPay as a long-running service for automated and ongoing distributions.

```shell
./tezpay continual
```

--------------------------------

### Monitor overall TezBake status

Source: https://docs.tez.capital/tezbake/tutorials/monitoring-logs-and-status

Run this command to get the status of your baker in a snapshot. After first setting up and starting the baker, you may need to give it a minute or 2 before the status display stops changing and missing some information. If you notice there is an error status on any of the fields after around 3-5 minutes of starting the services, seek out help in the Tez Capital community as there is something that probably needs tweaking.

```Shell
tezbake info
```
Tokens:
Raw