@centrifuge/sdk 1.8.6 → 1.9.0

package/dist/entities/Reports/PoolReports.d.ts

@@ -1,8 +1,10 @@
 import { Entity } from '../Entity.js';
 import { Pool } from '../Pool.js';
+import { ShareYieldsReportFilter } from './PoolShareYieldsReport.js';
 import { SharePricesReportFilter } from './PoolSharePricesReport.js';
 export declare class PoolReports extends Entity {
     pool: Pool;
     sharePrices(filter?: SharePricesReportFilter): import("../../index.js").Query<import("./PoolSharePricesReport.js").SharePricesReport>;
+    shareYields(filter?: ShareYieldsReportFilter): import("../../index.js").Query<import("./PoolShareYieldsReport.js").ShareYieldsReport>;
 }
 //# sourceMappingURL=PoolReports.d.ts.map

package/dist/entities/Reports/PoolReports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PoolReports.d.ts","sourceRoot":"","sources":["../../../src/entities/Reports/PoolReports.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAyB,uBAAuB,EAAE,MAAM,4BAA4B,CAAA;AAE3F,qBAAa,WAAY,SAAQ,MAAM;IAI5B,IAAI,EAAE,IAAI;IAKnB,WAAW,CAAC,MAAM,CAAC,EAAE,uBAAuB;CAG7C"}
+{"version":3,"file":"PoolReports.d.ts","sourceRoot":"","sources":["../../../src/entities/Reports/PoolReports.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAyB,uBAAuB,EAAE,MAAM,4BAA4B,CAAA;AAC3F,OAAO,EAAyB,uBAAuB,EAAE,MAAM,4BAA4B,CAAA;AAE3F,qBAAa,WAAY,SAAQ,MAAM;IAI5B,IAAI,EAAE,IAAI;IAKnB,WAAW,CAAC,MAAM,CAAC,EAAE,uBAAuB;IAI5C,WAAW,CAAC,MAAM,CAAC,EAAE,uBAAuB;CAG7C"}

package/dist/entities/Reports/PoolReports.js

@@ -1,4 +1,5 @@
 import { Entity } from '../Entity.js';
+import { PoolShareYieldsReport } from './PoolShareYieldsReport.js';
 import { PoolSharePricesReport } from './PoolSharePricesReport.js';
 export class PoolReports extends Entity {
     pool;
@@ -10,5 +11,8 @@ export class PoolReports extends Entity {
     sharePrices(filter) {
         return new PoolSharePricesReport(this._root, this).report(filter);
     }
+    shareYields(filter) {
+        return new PoolShareYieldsReport(this._root, this).report(filter);
+    }
 }
 //# sourceMappingURL=PoolReports.js.map

package/dist/entities/Reports/PoolReports.js.map

@@ -1 +1 @@
-{"version":3,"file":"PoolReports.js","sourceRoot":"","sources":["../../../src/entities/Reports/PoolReports.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC,OAAO,EAAE,qBAAqB,EAA2B,MAAM,4BAA4B,CAAA;AAE3F,MAAM,OAAO,WAAY,SAAQ,MAAM;IAI5B;IAHT,gBAAgB;IAChB,YACE,UAAsB,EACf,IAAU;QAEjB,KAAK,CAAC,UAAU,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QAF/C,SAAI,GAAJ,IAAI,CAAM;IAGnB,CAAC;IAED,WAAW,CAAC,MAAgC;QAC1C,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACnE,CAAC;CACF"}
+{"version":3,"file":"PoolReports.js","sourceRoot":"","sources":["../../../src/entities/Reports/PoolReports.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC,OAAO,EAAE,qBAAqB,EAA2B,MAAM,4BAA4B,CAAA;AAC3F,OAAO,EAAE,qBAAqB,EAA2B,MAAM,4BAA4B,CAAA;AAE3F,MAAM,OAAO,WAAY,SAAQ,MAAM;IAI5B;IAHT,gBAAgB;IAChB,YACE,UAAsB,EACf,IAAU;QAEjB,KAAK,CAAC,UAAU,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QAF/C,SAAI,GAAJ,IAAI,CAAM;IAGnB,CAAC;IAED,WAAW,CAAC,MAAgC;QAC1C,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACnE,CAAC;IAED,WAAW,CAAC,MAAgC;QAC1C,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACnE,CAAC;CACF"}

package/dist/entities/Reports/PoolShareYieldsReport.d.ts

@@ -0,0 +1,73 @@
+import { Centrifuge } from '../../Centrifuge.js';
+import { HexString } from '../../types/index.js';
+import { DecimalJsType } from '../../utils/decimal.js';
+import { ShareClassId } from '../../utils/types.js';
+import { Entity } from '../Entity.js';
+import { Pool } from '../Pool.js';
+import { PoolReports } from './PoolReports.js';
+import { DataReportFilter } from './types.js';
+/**
+ * Per-snapshot yield/return figures returned by the indexer.
+ *
+ * Naming matches the underlying indexer columns. Values are expressed as
+ * percentages (e.g. `5.5` = 5.5%). Fields are optional because the indexer
+ * may not have a value yet for the corresponding window (e.g. `yield90d`
+ * before the share class has 90 days of price history).
+ *
+ * Window encoding:
+ * - `yield{N}d`     — simple total return over the trailing N days.
+ * - `yield{N}d360`  — same window, annualized using a 360-day basis.
+ * - `yield{N}d365`  — same window, annualized using a 365-day basis.
+ * - `yield30dComp*` — 30-day compounded variants (annualized).
+ *
+ * `yieldTtm` is the trailing ~365 day simple return, `yieldSinceInception`
+ * is from the first usable price, and `yieldYtd` is year-to-date (UTC).
+ */
+export type ShareYields = {
+    yield1d?: DecimalJsType;
+    yield1d360?: DecimalJsType;
+    yield1d365?: DecimalJsType;
+    yield7d?: DecimalJsType;
+    yield7d360?: DecimalJsType;
+    yield7d365?: DecimalJsType;
+    yield15d?: DecimalJsType;
+    yield15d360?: DecimalJsType;
+    yield15d365?: DecimalJsType;
+    yield30d?: DecimalJsType;
+    yield30d360?: DecimalJsType;
+    yield30d365?: DecimalJsType;
+    yield90d?: DecimalJsType;
+    yield90d360?: DecimalJsType;
+    yield90d365?: DecimalJsType;
+    yield180d?: DecimalJsType;
+    yield180d360?: DecimalJsType;
+    yield180d365?: DecimalJsType;
+    yield30dComp360?: DecimalJsType;
+    yield30dComp365?: DecimalJsType;
+    yieldTtm?: DecimalJsType;
+    yieldSinceInception?: DecimalJsType;
+    yieldYtd?: DecimalJsType;
+};
+export type ShareYieldsReport = {
+    timestamp: string;
+    shareClasses: Record<HexString, ShareYields>;
+}[];
+export type ShareYieldsReportFilter = DataReportFilter & {
+    shareClassId?: ShareClassId;
+};
+export declare class PoolShareYieldsReport extends Entity {
+    poolReports: PoolReports;
+    pool: Pool;
+    constructor(centrifuge: Centrifuge, poolReports: PoolReports);
+    /**
+     * Get the per-day share-class yields report for a pool.
+     *
+     * Yields live on the share-class-level `token_snapshot` entity (not the
+     * per-network `token_instance_snapshot` consumed by `sharePrices`), and are
+     * populated on price-update events (`UpdatePricePoolPerShare`,
+     * `UpdateShareClass`) rather than on `NewPeriod` snapshots. The
+     * `(date, shareClassId)` dedupe keeps the latest snapshot per day.
+     */
+    report(filter?: ShareYieldsReportFilter): import("../../index.js").Query<ShareYieldsReport>;
+}
+//# sourceMappingURL=PoolShareYieldsReport.d.ts.map

package/dist/entities/Reports/PoolShareYieldsReport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PoolShareYieldsReport.d.ts","sourceRoot":"","sources":["../../../src/entities/Reports/PoolShareYieldsReport.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAEhD,OAAO,EAAO,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAG7C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,UAAU,CAAC,EAAE,aAAa,CAAA;IAC1B,UAAU,CAAC,EAAE,aAAa,CAAA;IAC1B,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,UAAU,CAAC,EAAE,aAAa,CAAA;IAC1B,UAAU,CAAC,EAAE,aAAa,CAAA;IAC1B,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,YAAY,CAAC,EAAE,aAAa,CAAA;IAC5B,YAAY,CAAC,EAAE,aAAa,CAAA;IAC5B,eAAe,CAAC,EAAE,aAAa,CAAA;IAC/B,eAAe,CAAC,EAAE,aAAa,CAAA;IAC/B,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,mBAAmB,CAAC,EAAE,aAAa,CAAA;IACnC,QAAQ,CAAC,EAAE,aAAa,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;CAC7C,EAAE,CAAA;AAEH,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,GAAG;IACvD,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B,CAAA;AAmDD,qBAAa,qBAAsB,SAAQ,MAAM;IAItC,WAAW,EAAE,WAAW;IAH1B,IAAI,EAAE,IAAI,CAAA;gBAEf,UAAU,EAAE,UAAU,EACf,WAAW,EAAE,WAAW;IAMjC;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,GAAE,uBAA4B;CAgE5C"}

package/dist/entities/Reports/PoolShareYieldsReport.js

@@ -0,0 +1,111 @@
+import { map, switchMap } from 'rxjs';
+import { Dec } from '../../utils/decimal.js';
+import { Entity } from '../Entity.js';
+import { applyGrouping } from './utils.js';
+const YIELD_FIELDS = [
+    'yield1d',
+    'yield1d360',
+    'yield1d365',
+    'yield7d',
+    'yield7d360',
+    'yield7d365',
+    'yield15d',
+    'yield15d360',
+    'yield15d365',
+    'yield30d',
+    'yield30d360',
+    'yield30d365',
+    'yield90d',
+    'yield90d360',
+    'yield90d365',
+    'yield180d',
+    'yield180d360',
+    'yield180d365',
+    'yield30dComp360',
+    'yield30dComp365',
+    'yieldTtm',
+    'yieldSinceInception',
+    'yieldYtd',
+];
+// Yields are stored as Ray (1e27 fixed point) on token_snapshot. Dividing by
+// 1e25 gives the value expressed as a percentage (e.g. Ray * 0.055 -> 5.5).
+const RAY_PER_PERCENT = Dec('1e25');
+function rayPercent(value) {
+    if (value == null)
+        return undefined;
+    try {
+        return Dec(value).div(RAY_PER_PERCENT);
+    }
+    catch {
+        return undefined;
+    }
+}
+export class PoolShareYieldsReport extends Entity {
+    poolReports;
+    pool;
+    constructor(centrifuge, poolReports) {
+        super(centrifuge, ['poolShareYieldsReport', poolReports.pool.id.toString()]);
+        this.poolReports = poolReports;
+        this.pool = poolReports.pool;
+    }
+    /**
+     * Get the per-day share-class yields report for a pool.
+     *
+     * Yields live on the share-class-level `token_snapshot` entity (not the
+     * per-network `token_instance_snapshot` consumed by `sharePrices`), and are
+     * populated on price-update events (`UpdatePricePoolPerShare`,
+     * `UpdateShareClass`) rather than on `NewPeriod` snapshots. The
+     * `(date, shareClassId)` dedupe keeps the latest snapshot per day.
+     */
+    report(filter = {}) {
+        const { groupBy } = filter;
+        return this._query(['report', groupBy?.toString()], () => this.pool._shareClassIds().pipe(switchMap((shareClassIds) => this._root
+            ._queryIndexer(`query ($filter: TokenSnapshotFilter) {
+                  tokenSnapshots(
+                    where: $filter
+                    orderBy: "timestamp"
+                    orderDirection: "desc"
+                    limit: 1000
+                  ) {
+                    items {
+                      id
+                      timestamp
+                      ${YIELD_FIELDS.join('\n                      ')}
+                    }
+                  }
+                }`, {
+            filter: {
+                id_in: shareClassIds
+                    .filter((id) => !filter.shareClassId || filter.shareClassId.equals(id))
+                    .map((id) => id.toString()),
+            },
+        }, undefined, 60 * 60 * 1000)
+            .pipe(map((data) => this._process(data, filter))))));
+    }
+    /** @internal */
+    _process(data, filter) {
+        // Yields are keyed by (date, shareClassId). Results are ordered timestamp
+        // DESC; the first row we see for a given (date, id) is the latest snapshot
+        // for that date.
+        const yieldsByDate = {};
+        data.tokenSnapshots.items.forEach((row) => {
+            const date = new Date(Number(row.timestamp)).toISOString().slice(0, 10);
+            const byTokenId = (yieldsByDate[date] ??= {});
+            if (byTokenId[row.id])
+                return;
+            const yields = {};
+            for (const field of YIELD_FIELDS) {
+                const value = rayPercent(row[field]);
+                if (value !== undefined)
+                    yields[field] = value;
+            }
+            byTokenId[row.id] = yields;
+        });
+        const items = Object.entries(yieldsByDate).map(([date, shareClasses]) => ({
+            timestamp: new Date(date).toISOString(),
+            shareClasses,
+        }));
+        return applyGrouping(items, filter.groupBy ?? 'day', 'latest').sort((a, b) => new Date(a.timestamp).getTime() - new Date(b.timestamp).getTime());
+    }
+}
+//# sourceMappingURL=PoolShareYieldsReport.js.map

package/dist/entities/Reports/PoolShareYieldsReport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PoolShareYieldsReport.js","sourceRoot":"","sources":["../../../src/entities/Reports/PoolShareYieldsReport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAIrC,OAAO,EAAE,GAAG,EAAiB,MAAM,wBAAwB,CAAA;AAE3D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAIrC,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAsD1C,MAAM,YAAY,GAAG;IACnB,SAAS;IACT,YAAY;IACZ,YAAY;IACZ,SAAS;IACT,YAAY;IACZ,YAAY;IACZ,UAAU;IACV,aAAa;IACb,aAAa;IACb,UAAU;IACV,aAAa;IACb,aAAa;IACb,UAAU;IACV,aAAa;IACb,aAAa;IACb,WAAW;IACX,cAAc;IACd,cAAc;IACd,iBAAiB;IACjB,iBAAiB;IACjB,UAAU;IACV,qBAAqB;IACrB,UAAU;CACuC,CAAA;AAEnD,6EAA6E;AAC7E,4EAA4E;AAC5E,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC,CAAA;AAEnC,SAAS,UAAU,CAAC,KAAgC;IAClD,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,SAAS,CAAA;IACnC,IAAI,CAAC;QACH,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;IACxC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC;AAYD,MAAM,OAAO,qBAAsB,SAAQ,MAAM;IAItC;IAHF,IAAI,CAAM;IACjB,YACE,UAAsB,EACf,WAAwB;QAE/B,KAAK,CAAC,UAAU,EAAE,CAAC,uBAAuB,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QAFrE,gBAAW,GAAX,WAAW,CAAa;QAG/B,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAA;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAkC,EAAE;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,CACvD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAC7B,SAAS,CAAC,CAAC,aAAa,EAAE,EAAE,CAC1B,IAAI,CAAC,KAAK;aACP,aAAa,CACZ;;;;;;;;;;wBAUU,YAAY,CAAC,IAAI,CAAC,0BAA0B,CAAC;;;kBAGnD,EACJ;YACE,MAAM,EAAE;gBACN,KAAK,EAAE,aAAa;qBACjB,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;qBACtE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;aACA;SAChC,EACD,SAAS,EACT,EAAE,GAAG,EAAE,GAAG,IAAI,CACf;aACA,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CACpD,CACF,CACF,CAAA;IACH,CAAC;IAED,gBAAgB;IAChB,QAAQ,CAAC,IAAqB,EAAE,MAAgD;QAC9E,0EAA0E;QAC1E,2EAA2E;QAC3E,iBAAiB;QACjB,MAAM,YAAY,GAAmD,EAAE,CAAA;QACvE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACxC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;YACvE,MAAM,SAAS,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;YAC7C,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;gBAAE,OAAM;YAC7B,MAAM,MAAM,GAAgB,EAAE,CAAA;YAC9B,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;gBACjC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAA;gBACpC,IAAI,KAAK,KAAK,SAAS;oBAAE,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAA;YAChD,CAAC;YACD,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAA;QAC5B,CAAC,CAAC,CAAA;QAEF,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,EAAE,CAAC,CAAC;YACxE,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;YACvC,YAAY;SACb,CAAC,CAAC,CAAA;QAEH,OAAO,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,IAAI,KAAK,EAAE,QAAQ,CAAC,CAAC,IAAI,CACjE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAC5E,CAAA;IACH,CAAC;CACF"}

package/dist/entities/Reports/PoolShareYieldsReport.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PoolShareYieldsReport.test.d.ts.map

package/dist/entities/Reports/PoolShareYieldsReport.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PoolShareYieldsReport.test.d.ts","sourceRoot":"","sources":["../../../src/entities/Reports/PoolShareYieldsReport.test.ts"],"names":[],"mappings":""}

package/dist/entities/Reports/PoolShareYieldsReport.test.js

@@ -0,0 +1,129 @@
+import { expect } from 'chai';
+import { context } from '../../tests/setup.js';
+import { PoolId, ShareClassId } from '../../utils/types.js';
+import { Pool } from '../Pool.js';
+import { PoolReports } from './PoolReports.js';
+import { PoolShareYieldsReport } from './PoolShareYieldsReport.js';
+const centId = 1;
+const poolId = PoolId.from(centId, 1);
+const scId = ShareClassId.from(poolId, 1);
+describe('PoolShareYieldsReport', () => {
+    let poolShareYieldsReport;
+    before(() => {
+        const { centrifuge } = context;
+        const pool = new Pool(centrifuge, poolId);
+        const poolReports = new PoolReports(centrifuge, pool);
+        poolShareYieldsReport = new PoolShareYieldsReport(centrifuge, poolReports);
+    });
+    it('converts Ray-encoded yields to Decimal percentages keyed by (date, shareClassId)', () => {
+        const tokenId = scId.raw;
+        // Ray-encoded yields: 5.5% -> 0.055 * 1e27 = 5.5e25
+        const data = {
+            tokenSnapshots: {
+                items: [
+                    {
+                        id: tokenId,
+                        timestamp: '1777939200000',
+                        yieldYtd: '55000000000000000000000000',
+                        yield30d365: '120000000000000000000000000',
+                        yield1d: null,
+                        yield1d360: null,
+                        yield1d365: null,
+                        yield7d: null,
+                        yield7d360: null,
+                        yield7d365: null,
+                        yield15d: null,
+                        yield15d360: null,
+                        yield15d365: null,
+                        yield30d: null,
+                        yield30d360: null,
+                        yield90d: null,
+                        yield90d360: null,
+                        yield90d365: null,
+                        yield180d: null,
+                        yield180d360: null,
+                        yield180d365: null,
+                        yield30dComp360: null,
+                        yield30dComp365: null,
+                        yieldTtm: null,
+                        yieldSinceInception: null,
+                    },
+                ],
+            },
+        };
+        const report = poolShareYieldsReport._process(data, {});
+        const entry = report[0].shareClasses[tokenId];
+        expect(entry.yieldYtd.toNumber()).to.equal(5.5);
+        expect(entry.yield30d365.toNumber()).to.equal(12);
+        expect(entry.yield1d).to.equal(undefined);
+    });
+    it('keeps the latest snapshot per (date, shareClassId)', () => {
+        const tokenId = scId.raw;
+        const data = {
+            tokenSnapshots: {
+                items: [
+                    // Order returned by indexer: timestamp DESC, so the first row is the latest.
+                    {
+                        id: tokenId,
+                        timestamp: '1777982400000',
+                        yieldYtd: '70000000000000000000000000',
+                        yield30d365: null,
+                        yield1d: null,
+                        yield1d360: null,
+                        yield1d365: null,
+                        yield7d: null,
+                        yield7d360: null,
+                        yield7d365: null,
+                        yield15d: null,
+                        yield15d360: null,
+                        yield15d365: null,
+                        yield30d: null,
+                        yield30d360: null,
+                        yield90d: null,
+                        yield90d360: null,
+                        yield90d365: null,
+                        yield180d: null,
+                        yield180d360: null,
+                        yield180d365: null,
+                        yield30dComp360: null,
+                        yield30dComp365: null,
+                        yieldTtm: null,
+                        yieldSinceInception: null,
+                    },
+                    {
+                        id: tokenId,
+                        timestamp: '1777939200000',
+                        yieldYtd: '55000000000000000000000000',
+                        yield30d365: null,
+                        yield1d: null,
+                        yield1d360: null,
+                        yield1d365: null,
+                        yield7d: null,
+                        yield7d360: null,
+                        yield7d365: null,
+                        yield15d: null,
+                        yield15d360: null,
+                        yield15d365: null,
+                        yield30d: null,
+                        yield30d360: null,
+                        yield90d: null,
+                        yield90d360: null,
+                        yield90d365: null,
+                        yield180d: null,
+                        yield180d360: null,
+                        yield180d365: null,
+                        yield30dComp360: null,
+                        yield30dComp365: null,
+                        yieldTtm: null,
+                        yieldSinceInception: null,
+                    },
+                ],
+            },
+        };
+        const report = poolShareYieldsReport._process(data, {});
+        // Both rows share the same UTC date; the first (latest) one wins.
+        expect(report).to.have.length(1);
+        expect(report[0].shareClasses[tokenId].yieldYtd.toNumber()).to.equal(7);
+    });
+});
+//# sourceMappingURL=PoolShareYieldsReport.test.js.map

package/dist/entities/Reports/PoolShareYieldsReport.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PoolShareYieldsReport.test.js","sourceRoot":"","sources":["../../../src/entities/Reports/PoolShareYieldsReport.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAC7B,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAElE,MAAM,MAAM,GAAG,CAAC,CAAA;AAChB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AACrC,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AAEzC,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAI,qBAA4C,CAAA;IAEhD,MAAM,CAAC,GAAG,EAAE;QACV,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;QAC9B,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QACzC,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QACrD,qBAAqB,GAAG,IAAI,qBAAqB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;IAC5E,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,kFAAkF,EAAE,GAAG,EAAE;QAC1F,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAA;QACxB,oDAAoD;QACpD,MAAM,IAAI,GAAG;YACX,cAAc,EAAE;gBACd,KAAK,EAAE;oBACL;wBACE,EAAE,EAAE,OAAO;wBACX,SAAS,EAAE,eAAe;wBAC1B,QAAQ,EAAE,4BAA4B;wBACtC,WAAW,EAAE,6BAA6B;wBAC1C,OAAO,EAAE,IAAI;wBACb,UAAU,EAAE,IAAI;wBAChB,UAAU,EAAE,IAAI;wBAChB,OAAO,EAAE,IAAI;wBACb,UAAU,EAAE,IAAI;wBAChB,UAAU,EAAE,IAAI;wBAChB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,WAAW,EAAE,IAAI;wBACjB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,WAAW,EAAE,IAAI;wBACjB,SAAS,EAAE,IAAI;wBACf,YAAY,EAAE,IAAI;wBAClB,YAAY,EAAE,IAAI;wBAClB,eAAe,EAAE,IAAI;wBACrB,eAAe,EAAE,IAAI;wBACrB,QAAQ,EAAE,IAAI;wBACd,mBAAmB,EAAE,IAAI;qBAC1B;iBACF;aACF;SACF,CAAA;QAED,MAAM,MAAM,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACvD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC,YAAY,CAAC,OAAO,CAAE,CAAA;QAC/C,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChD,MAAM,CAAC,KAAK,CAAC,WAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAClD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IAC3C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAA;QACxB,MAAM,IAAI,GAAG;YACX,cAAc,EAAE;gBACd,KAAK,EAAE;oBACL,6EAA6E;oBAC7E;wBACE,EAAE,EAAE,OAAO;wBACX,SAAS,EAAE,eAAe;wBAC1B,QAAQ,EAAE,4BAA4B;wBACtC,WAAW,EAAE,IAAI;wBACjB,OAAO,EAAE,IAAI;wBACb,UAAU,EAAE,IAAI;wBAChB,UAAU,EAAE,IAAI;wBAChB,OAAO,EAAE,IAAI;wBACb,UAAU,EAAE,IAAI;wBAChB,UAAU,EAAE,IAAI;wBAChB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,WAAW,EAAE,IAAI;wBACjB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,WAAW,EAAE,IAAI;wBACjB,SAAS,EAAE,IAAI;wBACf,YAAY,EAAE,IAAI;wBAClB,YAAY,EAAE,IAAI;wBAClB,eAAe,EAAE,IAAI;wBACrB,eAAe,EAAE,IAAI;wBACrB,QAAQ,EAAE,IAAI;wBACd,mBAAmB,EAAE,IAAI;qBAC1B;oBACD;wBACE,EAAE,EAAE,OAAO;wBACX,SAAS,EAAE,eAAe;wBAC1B,QAAQ,EAAE,4BAA4B;wBACtC,WAAW,EAAE,IAAI;wBACjB,OAAO,EAAE,IAAI;wBACb,UAAU,EAAE,IAAI;wBAChB,UAAU,EAAE,IAAI;wBAChB,OAAO,EAAE,IAAI;wBACb,UAAU,EAAE,IAAI;wBAChB,UAAU,EAAE,IAAI;wBAChB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,WAAW,EAAE,IAAI;wBACjB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,QAAQ,EAAE,IAAI;wBACd,WAAW,EAAE,IAAI;wBACjB,WAAW,EAAE,IAAI;wBACjB,SAAS,EAAE,IAAI;wBACf,YAAY,EAAE,IAAI;wBAClB,YAAY,EAAE,IAAI;wBAClB,eAAe,EAAE,IAAI;wBACrB,eAAe,EAAE,IAAI;wBACrB,QAAQ,EAAE,IAAI;wBACd,mBAAmB,EAAE,IAAI;qBAC1B;iBACF;aACF;SACF,CAAA;QAED,MAAM,MAAM,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACvD,kEAAkE;QAClE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QAChC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,YAAY,CAAC,OAAO,CAAE,CAAC,QAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAC5E,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export * from './entities/OnOffRampManager.js';
 export * from './entities/Pool.js';
 export * from './entities/PoolNetwork.js';
 export * from './entities/Reports/PoolReports.js';
+export * from './entities/Reports/PoolShareYieldsReport.js';
 export * from './entities/Reports/PoolSharePricesReport.js';
 export * from './entities/ShareClass.js';
 export * from './entities/Vault.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,6CAA6C,CAAA;AAC3D,cAAc,0BAA0B,CAAA;AACxC,cAAc,qBAAqB,CAAA;AACnC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAClF,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACxG,cAAc,yBAAyB,CAAA;AACvC,YAAY,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,YAAY,EACV,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,EACtB,4BAA4B,EAC5B,6BAA6B,EAC7B,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,0BAA0B,EAC1B,gBAAgB,EAChB,MAAM,EACN,WAAW,GACZ,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AACrE,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,cAAc,kBAAkB,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AAC/F,YAAY,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAChH,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAE9D,OAAO,EAAE,UAAU,EAAE,CAAA;AACrB,eAAe,UAAU,CAAA;AAEzB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,6CAA6C,CAAA;AAC3D,cAAc,6CAA6C,CAAA;AAC3D,cAAc,0BAA0B,CAAA;AACxC,cAAc,qBAAqB,CAAA;AACnC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAClF,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACxG,cAAc,yBAAyB,CAAA;AACvC,YAAY,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,YAAY,EACV,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,EACtB,4BAA4B,EAC5B,6BAA6B,EAC7B,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,0BAA0B,EAC1B,gBAAgB,EAChB,MAAM,EACN,WAAW,GACZ,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AACrE,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,cAAc,kBAAkB,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AAC/F,YAAY,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAChH,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAE9D,OAAO,EAAE,UAAU,EAAE,CAAA;AACrB,eAAe,UAAU,CAAA;AAEzB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/index.js

@@ -7,6 +7,7 @@ export * from './entities/OnOffRampManager.js';
 export * from './entities/Pool.js';
 export * from './entities/PoolNetwork.js';
 export * from './entities/Reports/PoolReports.js';
+export * from './entities/Reports/PoolShareYieldsReport.js';
 export * from './entities/Reports/PoolSharePricesReport.js';
 export * from './entities/ShareClass.js';
 export * from './entities/Vault.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,6CAA6C,CAAA;AAC3D,cAAc,0BAA0B,CAAA;AACxC,cAAc,qBAAqB,CAAA;AAGnC,cAAc,yBAAyB,CAAA;AAgBvC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAErE,cAAc,kBAAkB,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AAE/F,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAG3D,OAAO,EAAE,UAAU,EAAE,CAAA;AACrB,eAAe,UAAU,CAAA;AAEzB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,6CAA6C,CAAA;AAC3D,cAAc,6CAA6C,CAAA;AAC3D,cAAc,0BAA0B,CAAA;AACxC,cAAc,qBAAqB,CAAA;AAGnC,cAAc,yBAAyB,CAAA;AAgBvC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAErE,cAAc,kBAAkB,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AAE/F,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAG3D,OAAO,EAAE,UAAU,EAAE,CAAA;AACrB,eAAe,UAAU,CAAA;AAEzB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centrifuge/sdk",
-  "version": "1.8.6",
+  "version": "1.9.0",
   "description": "",
   "homepage": "https://github.com/centrifuge/sdk/tree/main#readme",
   "author": "",