Skip to content
This repository has been archived by the owner on Nov 3, 2022. It is now read-only.

A tool for Tezos bakers to process payments to their delegators.

License

Notifications You must be signed in to change notification settings

alis-is/breadcrumbs

 
 

Repository files navigation

Breadcrumbs

Overview

Breadcrumbs is a tool for Tezos validators (bakers 🥖) to pay their delegators.

Objective

Reward payments from bakers to delegators are a cornerstone of Tezos' delegation-based liquid proof-of-stake model. breadcrumbs is a payment tool built with in the spirit of:

  • increasing the choice of payout tools available and minimize dependency on single software stacks.
  • establishing payout tool accessible to (and open to contribution from) the ecosystem of JS/TS developers.
  • delivering life improvements to bakers

Features

  • Set a default service fee.
  • Set fees on a per-delegator basis.
  • Set separate payment addresses for given delegators.
  • Set minimum payment amounts.
  • Set minimum delegator balances.
  • Exclude given delegators from payment in case of over-delegation*
  • Protect the baker from over-delegation by ring-fencing 10% of the rewards.
  • Allow customized distribution of rewards associated with the baker's bond.
  • Allow customized distribution of fee income.
  • Send Telegram notifications.
  • Send Discord notifications.
  • Generate payment files (.csv) for each cycle.

Setup and Usage

Please consult the wiki for instructions related to setup and usage.

Credits

This tool is powered by the TzKT API and the Tezos Taquito library.

About

A tool for Tezos bakers to process payments to their delegators.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.8%
  • Other 0.2%