@moneypot/hub 1.19.16 → 1.20.0-dev.0

package/README.md

@@ -77,6 +77,32 @@ insert into hub.api_key default values returning key;
 
 You should always keep your hub server up to date as soon as possible. Never install an old, intermediate version: it may leave you without an automatic upgrade path.
 
+### 1.20.x
+
+Introduces a way to represent the part of a bankroll that is reserved by pending multi-stage games.
+
+Example
+
+1. Player starts a mines game with a max potential payout of $100
+2. Operator calls `dbCreateLiability({ refType: "MINES", refId: game.id, maxPayout: 100, ... })`
+   - Hub adds 100 to `hub.bankroll.liability`
+3. (Some time later...)
+4. Game ends and player wins or loses
+5. Operator calls `dbResolveLiability({ refType: "MINES", refId: game.id })`
+
+Changes
+
+- New column `hub.bankroll.liability`
+  - Available bankroll = `amount - liability`
+- New table `hub.liability`
+  - Triggers an update in `hub.bankroll.liability` when created/modified
+- Various type renames including
+  - `DbBalance` -> `DbPlayerBalance`
+  - `DbBankroll` -> `DbHouseBankroll`
+- More specific return types
+  - `dbLockedHouseBankroll(): DbHouseBankroll` -> `DbLockedHouseBankrollWithAvailable` (has `grossAmount` and `available` field to help you avoid mistaking amount vs available)
+  - `dbLockedPlayerBalance(): DbPlayerBalance` -> `DbLockedPlayerBalance`
+
 ### 1.19.x
 
 - All of hub's internal graphql-schema-modifying plugins have been moved to hub's set of required plugins.