WaterfallLens — LP/GP distribution waterfall
waterfall_distributeWaterfallLens (x402-paid, $0.30): deterministic LP/GP distribution waterfall (return of capital, preferred, GP catch-up, carried-interest split) with the exact split, per-tier breakdown, LP MOIC, and effective carry %.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payer | No | Optional wallet/account identifier; stored only as a hash | |
| years | No | Holding period for preferred accrual | |
| apiKey | No | Free-tier / plan API key (hp_free_… or a pass key). Forwarded as X-API-Key so paid tools serve from your monthly quota with NO x402 wallet. Get a free key (250 calls/mo) at https://hermesplant.com/pricing. | |
| channel | No | Discovery channel or source tag | |
| campaign | No | Campaign tag for downstream telemetry | |
| xPayment | No | Raw X-PAYMENT proof from an x402-compatible wallet/client | |
| actorType | No | Caller type for analytics: agent, human, synthetic, system, or unknown | |
| synthetic | No | Mark this paid retry as an internal test/probe for analytics exclusion | |
| compounding | No | Preferred-return accrual basis: 'simple' or 'compounded' (default compounded) | |
| distributable | Yes | Total cash to distribute | |
| preferredRate | No | Annual preferred rate, e.g. 0.08 | |
| carryPercentage | No | GP carry, e.g. 0.20 (default 0.20) | |
| paymentSignature | No | x402 payment proof to forward as PAYMENT-SIGNATURE and X-PAYMENT on retry | |
| catchUpPercentage | No | GP catch-up share, 1.0 = full (default) | |
| paymentIdentifier | No | Optional x402 payment identifier for idempotency/retry correlation | |
| contributedCapital | Yes | Total LP capital to return in tier 1 | |
| preferredReturnAmount | No | Explicit preferred return amount |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | True when the upstream storefront call returned a 2xx response | |
| httpStatus | Yes | Upstream HTTP status code | |
| paymentRequired | No | True when the response is an x402 HTTP 402 payment challenge |