TezPay is a Tezos reward distributor that simplifies the process of distributing rewards to your stakeholders. This readme provides instructions on how to use the tez-capital/tezpay container image, which comes with both tezpay and eli preinstalled.
Docker installed on your system.
- Pull the TezPay container image:
docker pull ghcr.io/tez-capital/tezpay- Run the TezPay container with the desired command. Replace
[command]with the desired TezPay command and[options]with the corresponding command options:
docker run --rm -it -v $(pwd):/tezpay ghcr.io/tez-capital/tezpay [command] [options]Here are some examples of how to use the TezPay commands:
Generate payouts:
docker run --rm -it -v $(pwd):/tezpay ghcr.io/tez-capital/tezpay generate-payouts --cycle <cycle_number> [flags]Replace <cycle_number> with the desired cycle number for which you want to generate payouts.
Continual payout (executed by default if no commands or arguments are provided):
docker run --rm -it -v $(pwd):/tezpay ghcr.io/tez-capital/tezpay continual [flags]Manual payout:
docker run --rm -it -v $(pwd):/tezpay ghcr.io/tez-capital/tezpay pay --cycle <cycle_number> [flags]Note: When running the container, make sure to mount the current working directory (or the desired directory containing your TezPay configuration) to the /tezpay path inside the container. This ensures that the container has access to your configuration files and can write any generated files back to your host system. Your TezPay configuration should be named config.hjson. Payout reports will be stored in the mounted directory under the reports directory by default.
For more information about available commands and their options, refer to the provided TezPay help:
docker run --rm -it ghcr.io/tez-capital/tezpay helpFor any questions or issues related to the container or TezPay, please visit the GitHub repository at tez-capital/tezpay or submit an issue there.