shufflecom-calculations 6.7.1 → 6.7.2

package/lib/utils/derive-purchase-bonus-multiplier.d.ts

@@ -0,0 +1,11 @@
+import BigNumber from 'bignumber.js';
+type PurchaseBonusPercentType = 'bps' | 'raw';
+export interface SweepStakePurchaseBonusAnchorPointSchema {
+    usdAmount: number;
+    percent: number;
+}
+export declare function derivePurchaseBonusMultiplier(percentType: PurchaseBonusPercentType, { usdReadable, anchorPoints }: {
+    usdReadable: BigNumber.Value;
+    anchorPoints: SweepStakePurchaseBonusAnchorPointSchema[];
+}): BigNumber;
+export {};

package/lib/utils/derive-purchase-bonus-multiplier.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.derivePurchaseBonusMultiplier = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const PERCENT_DIVISOR = {
+    bps: 10000,
+    raw: 100,
+};
+function derivePurchaseBonusMultiplier(percentType, { usdReadable, anchorPoints }) {
+    const deposit = new bignumber_js_1.default(usdReadable);
+    if (anchorPoints.length === 0 || !deposit.isFinite() || deposit.lte(0))
+        return new bignumber_js_1.default(0);
+    const divisor = PERCENT_DIVISOR[percentType];
+    const toMultiplier = (percent) => new bignumber_js_1.default(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_js_1.default(0);
+    if (deposit.gte(last.usdAmount))
+        return toMultiplier(last.percent);
+    const hiIndex = sorted.findIndex(anchor => deposit.lt(anchor.usdAmount));
+    const lo = sorted[hiIndex - 1];
+    const hi = sorted[hiIndex];
+    const slope = new bignumber_js_1.default(hi.percent).minus(lo.percent).div(hi.usdAmount - lo.usdAmount);
+    const pct = deposit.minus(lo.usdAmount).times(slope).plus(lo.percent);
+    return toMultiplier(pct);
+}
+exports.derivePurchaseBonusMultiplier = derivePurchaseBonusMultiplier;
+//# sourceMappingURL=derive-purchase-bonus-multiplier.js.map

package/lib/utils/derive-purchase-bonus-multiplier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"derive-purchase-bonus-multiplier.js","sourceRoot":"","sources":["../../src/utils/derive-purchase-bonus-multiplier.ts"],"names":[],"mappings":";;;;;;AAAA,gEAAqC;AAIrC,MAAM,eAAe,GAA6C;IAChE,GAAG,EAAE,KAAM;IACX,GAAG,EAAE,GAAG;CACT,CAAC;AAgBF,SAAgB,6BAA6B,CAC3C,WAAqC,EACrC,EAAE,WAAW,EAAE,YAAY,EAA8F;IAEzH,MAAM,OAAO,GAAG,IAAI,sBAAS,CAAC,WAAW,CAAC,CAAC;IAC3C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC;IAEhG,MAAM,OAAO,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IAC7C,MAAM,YAAY,GAAG,CAAC,OAAwB,EAAE,EAAE,CAAC,IAAI,sBAAS,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAEvF,MAAM,MAAM,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEvC,IAAI,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;QAAE,OAAO,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC;IACzD,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC;QAAE,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAGnE,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IACzE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;IAC/B,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAE3B,MAAM,KAAK,GAAG,IAAI,sBAAS,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC3F,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IACtE,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC;AAzBD,sEAyBC"}

package/package.json

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

package/src/index.ts

@@ -8,6 +8,7 @@ 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 './utils/derive-purchase-bonus-multiplier';
 export { convertBs58ToUuid, convertUuidToBs58 } from './utils/uuid-converter';
 export { Dice, DiceDirection } from './games/dice';
 export { Roulette } from './games/roulette';

package/src/utils/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/utils/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);
+}