shufflecom-calculations 6.7.1 → 6.8.0

package/lib/types/wallet-product.type.d.ts

@@ -0,0 +1,5 @@
+export declare enum WalletProduct {
+    CRYPTO_DEPOSIT = "CRYPTO_DEPOSIT",
+    BUNDLE_PACKAGE = "BUNDLE_PACKAGE",
+    GOLD_COIN_PACKAGE = "GOLD_COIN_PACKAGE"
+}

package/lib/types/wallet-product.type.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WalletProduct = void 0;
+var WalletProduct;
+(function (WalletProduct) {
+    WalletProduct["CRYPTO_DEPOSIT"] = "CRYPTO_DEPOSIT";
+    WalletProduct["BUNDLE_PACKAGE"] = "BUNDLE_PACKAGE";
+    WalletProduct["GOLD_COIN_PACKAGE"] = "GOLD_COIN_PACKAGE";
+})(WalletProduct || (exports.WalletProduct = WalletProduct = {}));
+//# sourceMappingURL=wallet-product.type.js.map

package/lib/types/wallet-product.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-product.type.js","sourceRoot":"","sources":["../../src/types/wallet-product.type.ts"],"names":[],"mappings":";;;AAAA,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,kDAAiC,CAAA;IACjC,wDAAuC,CAAA;AACzC,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shufflecom-calculations",
-  "version": "6.7.1",
+  "version": "6.8.0",
   "description": "",
   "types": "lib/index.d.ts",
   "main": "lib/index.js",
@@ -19,5 +19,5 @@
   },
   "author": "",
   "license": "ISC",
-  "gitHead": "95c91f287455e4c560530d39b5ba0ef101c6a798"
+  "gitHead": "aa6d35e33a97dff5bb25838a0999b5afd4f97fa2"
 }

package/src/index.ts

@@ -8,6 +8,8 @@ export { ChatMessageType, ChatMessage } from './utils/chat-message.type';
 export { DatesCalculator } from './utils/dates-calculator';
 export { VipBonusIssuanceStatus } from './utils/vip-bonus.type';
 export { deriveBonusIssuances } from './utils/derive-vip-bonus';
+export { derivePurchaseBonusMultiplier } from './sweep-stakes/derive-purchase-bonus-multiplier';
+export { SweepStakePurchasePackageCalculator, SWEEP_STAKE_PURCHASE_PACKAGES } from './sweep-stakes/sweep-stakes-package';
 export { convertBs58ToUuid, convertUuidToBs58 } from './utils/uuid-converter';
 export { Dice, DiceDirection } from './games/dice';
 export { Roulette } from './games/roulette';

package/src/sweep-stakes/derive-purchase-bonus-multiplier.spec.ts

@@ -0,0 +1,50 @@
+import BigNumber from 'bignumber.js';
+import { derivePurchaseBonusMultiplier } from './derive-purchase-bonus-multiplier';
+
+const bonus = (usd: number, multiplier: BigNumber) => new BigNumber(usd).times(multiplier).decimalPlaces(2, BigNumber.ROUND_DOWN).toString();
+
+describe('derivePurchaseBonusMultiplier', () => {
+  const ascBps = [
+    { usdAmount: 50, percent: 4000 },
+    { usdAmount: 10, percent: 3000 },
+  ];
+  const ascRaw = [
+    { usdAmount: 10, percent: 30 },
+    { usdAmount: 50, percent: 40 },
+  ];
+  const descBps = [
+    { usdAmount: 10, percent: 4000 },
+    { usdAmount: 50, percent: 3000 },
+  ];
+
+  it('returns 0 with no anchors', () => {
+    expect(derivePurchaseBonusMultiplier('bps', { usdReadable: 15, anchorPoints: [] }).toNumber()).toBe(0);
+  });
+
+  it('returns 0 below the lowest anchor', () => {
+    expect(derivePurchaseBonusMultiplier('bps', { usdReadable: 5, anchorPoints: ascBps }).toNumber()).toBe(0);
+  });
+
+  it('returns the anchor percent on an exact anchor', () => {
+    expect(derivePurchaseBonusMultiplier('bps', { usdReadable: 10, anchorPoints: ascBps }).toNumber()).toBe(0.3);
+    expect(derivePurchaseBonusMultiplier('bps', { usdReadable: 50, anchorPoints: ascBps }).toNumber()).toBe(0.4);
+  });
+
+  it('caps at the highest anchor', () => {
+    expect(derivePurchaseBonusMultiplier('bps', { usdReadable: 500, anchorPoints: ascBps }).toNumber()).toBe(0.4);
+  });
+
+  it('interpolates increasing anchors (bps & raw give same result)', () => {
+    const m1 = derivePurchaseBonusMultiplier('bps', { usdReadable: 15, anchorPoints: ascBps });
+    const m2 = derivePurchaseBonusMultiplier('raw', { usdReadable: 15, anchorPoints: ascRaw });
+    expect(m1.toNumber()).toBe(0.3125);
+    expect(m2.toNumber()).toBe(0.3125);
+    expect(bonus(15, m1)).toBe('4.68');
+  });
+
+  it('interpolates decreasing anchors', () => {
+    const m = derivePurchaseBonusMultiplier('bps', { usdReadable: 15, anchorPoints: descBps });
+    expect(m.toNumber()).toBe(0.3875);
+    expect(bonus(15, m)).toBe('5.81');
+  });
+});

package/src/sweep-stakes/derive-purchase-bonus-multiplier.ts

@@ -0,0 +1,49 @@
+import BigNumber from 'bignumber.js';
+
+type PurchaseBonusPercentType = 'bps' | 'raw';
+
+const PERCENT_DIVISOR: Record<PurchaseBonusPercentType, number> = {
+  bps: 10_000,
+  raw: 100,
+};
+
+export interface SweepStakePurchaseBonusAnchorPointSchema {
+  usdAmount: number;
+  percent: number;
+}
+
+/**
+ * Derives the purchase bonus multiplier for a deposit by linearly interpolating between anchor points.
+ *
+ * @param percentType - the unit that `anchorPoints[].percent` is stored in:
+ *   - `'bps'`: basis points, where 10_000 = 100% (e.g. 250 = 2.5%). Stored/admin configured values use this.
+ *   - `'raw'`: whole percent, where 100 = 100% (e.g. 2.5 = 2.5%).
+ *
+ * @returns the multiplier as a fraction (e.g. 0.025 for 2.5%), or 0 when the deposit is below the first anchor point.
+ */
+export function derivePurchaseBonusMultiplier(
+  percentType: PurchaseBonusPercentType,
+  { usdReadable, anchorPoints }: { usdReadable: BigNumber.Value; anchorPoints: SweepStakePurchaseBonusAnchorPointSchema[] },
+): BigNumber {
+  const deposit = new BigNumber(usdReadable);
+  if (anchorPoints.length === 0 || !deposit.isFinite() || deposit.lte(0)) return new BigNumber(0);
+
+  const divisor = PERCENT_DIVISOR[percentType];
+  const toMultiplier = (percent: BigNumber.Value) => new BigNumber(percent).div(divisor);
+
+  const sorted = [...anchorPoints].sort((a, b) => a.usdAmount - b.usdAmount);
+  const first = sorted[0];
+  const last = sorted[sorted.length - 1];
+
+  if (deposit.lt(first.usdAmount)) return new BigNumber(0);
+  if (deposit.gte(last.usdAmount)) return toMultiplier(last.percent);
+
+  // first <= deposit < last, so hiIndex is always >= 1 and lo.usdAmount <= deposit < hi.usdAmount
+  const hiIndex = sorted.findIndex(anchor => deposit.lt(anchor.usdAmount));
+  const lo = sorted[hiIndex - 1];
+  const hi = sorted[hiIndex];
+
+  const slope = new BigNumber(hi.percent).minus(lo.percent).div(hi.usdAmount - lo.usdAmount);
+  const pct = deposit.minus(lo.usdAmount).times(slope).plus(lo.percent);
+  return toMultiplier(pct);
+}

package/src/sweep-stakes/sweep-stakes-package.ts

@@ -0,0 +1,49 @@
+import BigNumber from 'bignumber.js';
+import { WalletProduct } from '../types/wallet-product.type';
+
+export const SC_GC_BUNDLE_RATE = 10_000;
+
+type SweepStakePurchasePackages = {
+  usdAmount: number;
+  product: WalletProduct.BUNDLE_PACKAGE | WalletProduct.GOLD_COIN_PACKAGE;
+};
+
+export const SWEEP_STAKE_PURCHASE_PACKAGES: SweepStakePurchasePackages[] = [
+  { usdAmount: 5, product: WalletProduct.BUNDLE_PACKAGE },
+  { usdAmount: 10, product: WalletProduct.BUNDLE_PACKAGE },
+  { usdAmount: 20, product: WalletProduct.BUNDLE_PACKAGE },
+  { usdAmount: 50, product: WalletProduct.BUNDLE_PACKAGE },
+  { usdAmount: 100, product: WalletProduct.BUNDLE_PACKAGE },
+  { usdAmount: 250, product: WalletProduct.BUNDLE_PACKAGE },
+  { usdAmount: 500, product: WalletProduct.BUNDLE_PACKAGE },
+  { usdAmount: 1000, product: WalletProduct.BUNDLE_PACKAGE },
+  { usdAmount: 30, product: WalletProduct.GOLD_COIN_PACKAGE },
+];
+
+export class SweepStakePurchasePackageCalculator {
+  static usdToGc(usdAmount: BigNumber.Value): BigNumber {
+    return new BigNumber(usdAmount).times(SC_GC_BUNDLE_RATE);
+  }
+
+  static getPackageValue({ usdAmount, product }: { usdAmount: BigNumber.Value; product: WalletProduct }): { gc: BigNumber; sc: BigNumber } {
+    switch (product) {
+      case WalletProduct.BUNDLE_PACKAGE:
+        return {
+          gc: SweepStakePurchasePackageCalculator.usdToGc(usdAmount),
+          sc: new BigNumber(usdAmount),
+        };
+      case WalletProduct.GOLD_COIN_PACKAGE:
+        return {
+          gc: SweepStakePurchasePackageCalculator.usdToGc(usdAmount),
+          sc: new BigNumber(0),
+        };
+      case WalletProduct.CRYPTO_DEPOSIT:
+        return {
+          gc: new BigNumber(0),
+          sc: new BigNumber(0),
+        };
+      default:
+        return product satisfies never;
+    }
+  }
+}

package/src/types/wallet-product.type.ts

@@ -0,0 +1,5 @@
+export enum WalletProduct {
+  CRYPTO_DEPOSIT = 'CRYPTO_DEPOSIT',
+  BUNDLE_PACKAGE = 'BUNDLE_PACKAGE',
+  GOLD_COIN_PACKAGE = 'GOLD_COIN_PACKAGE',
+}