Thanks to visit codestin.com
Credit goes to github.com

Skip to content

blackcatacademy/blackcat-payout

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BlackCat Payout Engine

Repo pro výpočet výplat (marketplace komponenty, usage-based revenue share). Napojené na blackcat-marketplace, blackcat-usage, blackcat-commerce/blackcat-billing. Obsahuje CLI payout run, ledger API, exporty.

Stage 1 – Foundation ✅

  • Konfiguraceconfig/example.payout.php podporuje ${env:} / ${file:} placeholders a sdílí secrets přes blackcat-config profily. Obsahuje cestu ke komponentám, pravidla výpočtu, telemetrii a ledger.
  • Runtime / CLIbin/payout <config> simulate|run načte konfiguraci, vypočítá odměny, a při run je uloží do ledgeru. CLI se chová stejně napříč prostředími (stačí vyměnit config).
  • Telemetry & Ledger – výsledky se zapisují do var/ledger.ndjson a metriky do var/metrics.prom (payout_entries_total, payout_amount_total).
  • Testingtests/SmokeTest.php ověřuje výpočet i zápis do ledgeru s fixture snapshotem.

Jak to funguje

  1. blackcat-usage generuje snapshot (usage export revenue) se strukturou [{"component_id": "...", "events": 123, ...}].
  2. bin/payout run snapshot.json:
    • načte komponenty z marketplace (components/*.json),
    • propojí usage se jménem autora,
    • vypočítá částku (základní sazba za event + bonus za tenant + multiplikátor dle pricing modelu),
    • uloží výsledek do ledgeru (data/ledger.ndjson).
  3. blackcat-commerce / blackcat-billing načte ledger a připraví faktury/platby.
export BLACKCAT_PAYOUT_CONFIG=blackcat-payout/config/example.payout.php

# simulace bez zápisu
php bin/payout $BLACKCAT_PAYOUT_CONFIG simulate tests/fixtures/usage-snapshot.json

# plný běh s uložením do ledgeru
php bin/payout $BLACKCAT_PAYOUT_CONFIG run tests/fixtures/usage-snapshot.json

Konfigurovatelné proměnné:

  • PAYOUT_BASE_RATE (USD za event, default 0.02)
  • PAYOUT_TENANT_BONUS (USD za unikátní tenant, default 0.10)
  • PAYOUT_SUB_MULT (multiplikátor pro subscription komponenty, default 1.5)

About

Revenue share engine that computes marketplace payouts from usage metrics.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages