Skip to content

Commit

Permalink
remove mention of owners in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolasochem committed Jul 25, 2024
1 parent ab8f87a commit ddc3a7d
Showing 1 changed file with 1 addition and 19 deletions.
20 changes: 1 addition & 19 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,24 +81,6 @@ Available configuration parameters are:
Alice and Bob are both founders of Acme Bakery. Their bakery fee is 10%. Alice has a 60% (0.6) interest in the bakery, and Bob has a 40% (0.4) interest. When rewards are delivered at the end of each cycle, 10% is taken as the bakery fee (ie: *service_fee*). That 10% is then divided between Alice and Bob according to their ratios.

**owners_map**
A dictionary of PKH and ratio ( decimal in the range [0-1]) pairs. Each item in this dictionary represents PKH of each balance owner and his ratio of the amount he owns in the total baking balance. Implicit or originated addresses are accepted. It is important that the sum of all ratios equals to 1. This map is optional if owners do not want to be paid for baking rewards, in this case, baking rewards remain in baking balance.

Example::

Current Baker Balance: 17,400 tez
Total Delegations: 69,520 tez
Total Staked: 86,920 tez

service_fee: 9
owners_map:
{'tz1PV5g16m9hHMAVJ4Hx6NzzUHgksDnTLFcK' : 0.4,
'tz1PirboZKFVqkfE45hVLpkpXaZtLk3mqC17' : 0.4,
'tz1VxS7ff4YnZRs8b4mMP4WaMVpoQjuo1rjf' : 0.2}
Charlie, and Dave, have each transfered 6,960 tez to the baker address. Edwin has transfered 3,480 tez. They are each partial owners of the baking balance. When rewards are delivered at the end of each cycle, 9% is taken as the bakery fee (ie: *service_fee*). That 9% is dispersed to any *founders*. If there are no founders, that 9% remains in the baker's balance.
The baker address is technically a delegator to itself. Its share of rewards are part of the overall cycle rewards. Charlie, Dave, and Edwin divide the "baker address rewards" as per the ratios in *owners_map*. Additionally, owners are *not* subject to the *service_fee*.

**specials_map**
A dictionary of PKH and fee (decimal in the range [0-100] ) pairs. This dictionary can be used to set special service fee values for desired delegators.

Expand All @@ -108,7 +90,7 @@ Available configuration parameters are:
'tz1PirboZKFVqkfE45hVLpkpXaZtLk3mqC17' : 5}
**supporters_set**
A set of PKH values. Each PKH represents a supporter of the baker. Supporters are not charged with a service fee. Founders and balance owners are natural supporters, they are not needed to be added.
A set of PKH values. Each PKH represents a supporter of the baker. Supporters are not charged with a service fee. Founders are natural supporters, they are not needed to be added.

Example::

Expand Down

0 comments on commit ddc3a7d

Please sign in to comment.