Module payee

Defines pluggable payee models for distributing a total payout across a set of participants.

Payees are abstracted as allocation models that transform a total payout and a set of participant weights into individual reward assignments.

Concept

• A payee model determines how a total payout is distributed.
• The distribution is computed over a set of (Id, Share) pairs.
• The output assigns a payout value to each participant.

Mathematical Form

Where:

• P = total payout
• p_i = payout assigned to participant i
• n = number of participants

In this model:

• Input is (Payout, [(Id, Share)]).
• Output is [(Id, Payout)].

Properties

• Conservative distribution: Total assigned payout equals input payout.
• Deterministic mapping: Same inputs produce identical allocations.
• Context-free or context-driven depending on model.
• Finite partitioning of total value across participants.

Purpose

Payee models provide flexibility in defining reward distribution:

• Control how total rewards are allocated among participants.
• Support different allocation strategies based on weights or structure.
• Serve as the final stage in reward pipelines.

Structs

EqualPay

The EqualPay model distributes a total payout equally among all participants.

SharesPay

The SharesPay model distributes a total payout proportionally based on participant shares.