MavPay is a Mavryk reward distributor that simplifies the process of distributing rewards to your stakeholders. This readme provides instructions on how to use the mavryk-network/mavpay container image, which comes with both mavpay and eli preinstalled.
Docker installed on your system.
- Pull the MavPay container image:
docker pull ghcr.io/mavryk-network/mavpay- Run the MavPay container with the desired command. Replace
[command]with the desired MavPay command and[options]with the corresponding command options:
docker run --rm -it -v $(pwd):/mavpay ghcr.io/mavryk-network/mavpay [command] [options]Here are some examples of how to use the MavPay commands:
Generate payouts:
docker run --rm -it -v $(pwd):/mavpay ghcr.io/mavryk-network/mavpay 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):/mavpay ghcr.io/mavryk-network/mavpay continual [flags]Manual payout:
docker run --rm -it -v $(pwd):/mavpay ghcr.io/mavryk-network/mavpay pay --cycle <cycle_number> [flags]Note: When running the container, make sure to mount the current working directory (or the desired directory containing your MavPay configuration) to the /mavpay 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 MavPay 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 MavPay help:
docker run --rm -it ghcr.io/mavryk-network/mavpay helpFor any questions or issues related to the container or MavPay, please visit the GitHub repository at mavryk-network/mavpay or submit an issue there.