@fintekkers/ledger-models 0.4.0 → 0.4.2

package/node/wrappers/models/security/MortgageBackedSecurity.fromPricerInputs.test.ts

@@ -0,0 +1,107 @@
+import Security from './security';
+import BondSecurity from './BondSecurity';
+import MortgageBackedSecurity from './MortgageBackedSecurity';
+import { SecurityProto } from '../../../fintekkers/models/security/security_pb';
+import { ProductTypeProto } from '../../../fintekkers/models/security/product_type_pb';
+import { CouponTypeProto } from '../../../fintekkers/models/security/coupon_type_pb';
+import { CouponFrequencyProto } from '../../../fintekkers/models/security/coupon_frequency_pb';
+import { AgencyProto } from '../../../fintekkers/models/security/bond/agency_pb';
+import { LocalDate } from '../utils/date';
+import { LocalDateProto } from '../../../fintekkers/models/util/local_date_pb';
+import { Decimal } from 'decimal.js';
+
+function makeDate(y: number, m: number, d: number): LocalDate {
+  return new LocalDate(new LocalDateProto().setYear(y).setMonth(m).setDay(d));
+}
+
+const baseInputs = {
+  faceValue: new Decimal('250000000'),
+  couponRate: new Decimal('0.04'),
+  couponType: CouponTypeProto.FIXED,
+  couponFrequency: CouponFrequencyProto.MONTHLY,
+  issueDate: makeDate(2024, 1, 1),
+  maturityDate: makeDate(2054, 1, 1),
+};
+
+const mbsInputs = {
+  ...baseInputs,
+  poolNumber: 'FN AS1234',
+  agency: AgencyProto.FNMA,
+  wac: new Decimal('0.045'),
+  wam: 358,
+  passThroughRate: new Decimal('0.04'),
+  currentFactor: new Decimal('0.95'),
+  originalFaceValue: new Decimal('250000000'),
+  currentUpb: new Decimal('237500000'),
+  psaSpeed: new Decimal('150'),
+};
+
+test('MortgageBackedSecurity.fromPricerInputs populates bond_details and mbs_extension', () => {
+  const proto = MortgageBackedSecurity.fromPricerInputs(mbsInputs);
+  expect(proto.getProductType()).toBe(ProductTypeProto.MORTGAGE_BACKED);
+  expect(proto.hasBondDetails()).toBe(true);
+  expect(proto.hasMbsExtension()).toBe(true);
+
+  const ext = proto.getMbsExtension()!;
+  expect(ext.getPoolNumber()).toBe('FN AS1234');
+  expect(ext.getAgency()).toBe(AgencyProto.FNMA);
+  expect(ext.getWac()?.getArbitraryPrecisionValue()).toBe('0.045');
+  expect(ext.getWam()).toBe(358);
+  expect(ext.getPassThroughRate()?.getArbitraryPrecisionValue()).toBe('0.04');
+  expect(ext.getCurrentFactor()?.getArbitraryPrecisionValue()).toBe('0.95');
+  expect(ext.getOriginalFaceValue()?.getArbitraryPrecisionValue()).toBe('250000000');
+  expect(ext.getCurrentUpb()?.getArbitraryPrecisionValue()).toBe('237500000');
+  expect(ext.getPsaSpeed()?.getArbitraryPrecisionValue()).toBe('150');
+});
+
+test('MortgageBackedSecurity round-trips via serializeBinary / deserializeBinary preserving all 9 mbs fields', () => {
+  const proto = MortgageBackedSecurity.fromPricerInputs(mbsInputs);
+  const bytes = proto.serializeBinary();
+  const round = SecurityProto.deserializeBinary(bytes);
+
+  expect(round.getProductType()).toBe(ProductTypeProto.MORTGAGE_BACKED);
+  expect(round.hasBondDetails()).toBe(true);
+  expect(round.hasMbsExtension()).toBe(true);
+
+  const ext = round.getMbsExtension()!;
+  expect(ext.getPoolNumber()).toBe('FN AS1234');
+  expect(ext.getAgency()).toBe(AgencyProto.FNMA);
+  expect(ext.getWac()?.getArbitraryPrecisionValue()).toBe('0.045');
+  expect(ext.getWam()).toBe(358);
+  expect(ext.getPassThroughRate()?.getArbitraryPrecisionValue()).toBe('0.04');
+  expect(ext.getCurrentFactor()?.getArbitraryPrecisionValue()).toBe('0.95');
+  expect(ext.getOriginalFaceValue()?.getArbitraryPrecisionValue()).toBe('250000000');
+  expect(ext.getCurrentUpb()?.getArbitraryPrecisionValue()).toBe('237500000');
+  expect(ext.getPsaSpeed()?.getArbitraryPrecisionValue()).toBe('150');
+});
+
+test('MortgageBackedSecurity wraps via Security.create factory dispatch', () => {
+  const proto = MortgageBackedSecurity.fromPricerInputs(mbsInputs);
+  const sec = Security.create(proto);
+  expect(sec).toBeInstanceOf(MortgageBackedSecurity);
+  // Inherits BondSecurity behaviour.
+  expect(sec).toBeInstanceOf(BondSecurity);
+  expect(sec.isBond()).toBe(true);
+});
+
+test('MortgageBackedSecurity typed accessors read back the expected values', () => {
+  const proto = MortgageBackedSecurity.fromPricerInputs(mbsInputs);
+  const sec = Security.create(proto) as MortgageBackedSecurity;
+
+  // Bond-side checks (inherited from BondSecurity).
+  expect(sec.getCouponRate().getArbitraryPrecisionValue()).toBe('0.04');
+  expect(sec.getFaceValue().getArbitraryPrecisionValue()).toBe('250000000');
+  expect(sec.getIssueDate().toDate().getFullYear()).toBe(2024);
+  expect(sec.getMaturityDate().toDate().getFullYear()).toBe(2054);
+
+  // MBS-specific accessor checks.
+  expect(sec.getPoolNumber()).toBe('FN AS1234');
+  expect(sec.getAgency()).toBe(AgencyProto.FNMA);
+  expect(sec.getWac()?.toString()).toBe('0.045');
+  expect(sec.getWam()).toBe(358);
+  expect(sec.getPassThroughRate()?.toString()).toBe('0.04');
+  expect(sec.getCurrentFactor()?.toString()).toBe('0.95');
+  expect(sec.getOriginalFaceValue()?.toString()).toBe('250000000');
+  expect(sec.getCurrentUpb()?.toString()).toBe('237500000');
+  expect(sec.getPsaSpeed()?.toString()).toBe('150');
+});

package/node/wrappers/models/security/MortgageBackedSecurity.js

@@ -0,0 +1,131 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BondSecurity_1 = __importStar(require("./BondSecurity"));
+const security_pb_1 = require("../../../fintekkers/models/security/security_pb");
+const agency_pb_1 = require("../../../fintekkers/models/security/bond/agency_pb");
+const product_type_pb_1 = require("../../../fintekkers/models/security/product_type_pb");
+const decimal_js_1 = require("decimal.js");
+/**
+ * MBS-specific accessors layered on top of BondSecurity. Pool-level fields
+ * (agency, WAC, WAM, pass-through rate, factors, balances, PSA) live in
+ * the parallel mbs_extension sub-message; bond_details still carries the
+ * canonical coupon/dates/face value.
+ */
+class MortgageBackedSecurity extends BondSecurity_1.default {
+    constructor(proto) {
+        super(proto);
+    }
+    getMbsExtension() {
+        var _a;
+        return (_a = this.proto.getMbsExtension()) !== null && _a !== void 0 ? _a : undefined;
+    }
+    /** Pool identifier (e.g. "FN AS1234"). */
+    getPoolNumber() {
+        const ext = this.getMbsExtension();
+        return ext ? ext.getPoolNumber() : '';
+    }
+    /** Issuing agency (FNMA / FHLMC / GNMA). */
+    getAgency() {
+        const ext = this.getMbsExtension();
+        return ext ? ext.getAgency() : agency_pb_1.AgencyProto.AGENCY_UNKNOWN;
+    }
+    /** Weighted Average Coupon across underlying loans. */
+    getWac() {
+        const ext = this.getMbsExtension();
+        const v = ext ? ext.getWac() : undefined;
+        if (!v)
+            return null;
+        return new decimal_js_1.Decimal(v.getArbitraryPrecisionValue());
+    }
+    /** Weighted Average Maturity, in months. */
+    getWam() {
+        const ext = this.getMbsExtension();
+        return ext ? ext.getWam() : 0;
+    }
+    /** Pass-through rate paid to investors (net of servicing/guarantee fees). */
+    getPassThroughRate() {
+        const ext = this.getMbsExtension();
+        const v = ext ? ext.getPassThroughRate() : undefined;
+        if (!v)
+            return null;
+        return new decimal_js_1.Decimal(v.getArbitraryPrecisionValue());
+    }
+    /** Current pool factor (remaining UPB / original face). */
+    getCurrentFactor() {
+        const ext = this.getMbsExtension();
+        const v = ext ? ext.getCurrentFactor() : undefined;
+        if (!v)
+            return null;
+        return new decimal_js_1.Decimal(v.getArbitraryPrecisionValue());
+    }
+    /** Original face value at issuance. */
+    getOriginalFaceValue() {
+        const ext = this.getMbsExtension();
+        const v = ext ? ext.getOriginalFaceValue() : undefined;
+        if (!v)
+            return null;
+        return new decimal_js_1.Decimal(v.getArbitraryPrecisionValue());
+    }
+    /** Current Unpaid Principal Balance. */
+    getCurrentUpb() {
+        const ext = this.getMbsExtension();
+        const v = ext ? ext.getCurrentUpb() : undefined;
+        if (!v)
+            return null;
+        return new decimal_js_1.Decimal(v.getArbitraryPrecisionValue());
+    }
+    /** PSA prepayment speed assumption. */
+    getPsaSpeed() {
+        const ext = this.getMbsExtension();
+        const v = ext ? ext.getPsaSpeed() : undefined;
+        if (!v)
+            return null;
+        return new decimal_js_1.Decimal(v.getArbitraryPrecisionValue());
+    }
+    /**
+     * Build a fresh SecurityProto for an agency MBS pass-through. product_type
+     * is set to MORTGAGE_BACKED so Security.create routes back to this wrapper.
+     */
+    static fromPricerInputs(args) {
+        const bond = (0, BondSecurity_1.buildBondDetails)(args);
+        const mbs = new security_pb_1.MbsExtensionProto()
+            .setPoolNumber(args.poolNumber)
+            .setAgency(args.agency)
+            .setWac((0, BondSecurity_1.decimalToProto)(args.wac))
+            .setWam(args.wam)
+            .setPassThroughRate((0, BondSecurity_1.decimalToProto)(args.passThroughRate))
+            .setCurrentFactor((0, BondSecurity_1.decimalToProto)(args.currentFactor))
+            .setOriginalFaceValue((0, BondSecurity_1.decimalToProto)(args.originalFaceValue))
+            .setCurrentUpb((0, BondSecurity_1.decimalToProto)(args.currentUpb))
+            .setPsaSpeed((0, BondSecurity_1.decimalToProto)(args.psaSpeed));
+        return new security_pb_1.SecurityProto()
+            .setProductType(product_type_pb_1.ProductTypeProto.MORTGAGE_BACKED)
+            .setBondDetails(bond)
+            .setMbsExtension(mbs);
+    }
+}
+exports.default = MortgageBackedSecurity;
+//# sourceMappingURL=MortgageBackedSecurity.js.map

package/node/wrappers/models/security/MortgageBackedSecurity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MortgageBackedSecurity.js","sourceRoot":"","sources":["MortgageBackedSecurity.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAIwB;AACxB,iFAAmG;AACnG,kFAAiF;AACjF,yFAAuF;AACvF,2CAAqC;AAErC;;;;;GAKG;AACH,MAAM,sBAAuB,SAAQ,sBAAY;IAC/C,YAAY,KAAoB;QAC9B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEO,eAAe;;QACrB,OAAO,MAAA,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,mCAAI,SAAS,CAAC;IACnD,CAAC;IAED,0CAA0C;IAC1C,aAAa;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACxC,CAAC;IAED,4CAA4C;IAC5C,SAAS;QACP,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,uBAAW,CAAC,cAAc,CAAC;IAC5D,CAAC;IAED,uDAAuD;IACvD,MAAM;QACJ,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,IAAI,oBAAO,CAAC,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,4CAA4C;IAC5C,MAAM;QACJ,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IAED,6EAA6E;IAC7E,kBAAkB;QAChB,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACrD,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,IAAI,oBAAO,CAAC,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,2DAA2D;IAC3D,gBAAgB;QACd,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACnD,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,IAAI,oBAAO,CAAC,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,uCAAuC;IACvC,oBAAoB;QAClB,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACvD,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,IAAI,oBAAO,CAAC,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,wCAAwC;IACxC,aAAa;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAChD,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,IAAI,oBAAO,CAAC,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,uCAAuC;IACvC,WAAW;QACT,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9C,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,IAAI,oBAAO,CAAC,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAUvB;QACC,MAAM,IAAI,GAAG,IAAA,+BAAgB,EAAC,IAAI,CAAC,CAAC;QACpC,MAAM,GAAG,GAAG,IAAI,+BAAiB,EAAE;aAChC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC;aAC9B,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;aACtB,MAAM,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAChC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;aAChB,kBAAkB,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,eAAe,CAAC,CAAC;aACxD,gBAAgB,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aACpD,oBAAoB,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;aAC5D,aAAa,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAC9C,WAAW,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9C,OAAO,IAAI,2BAAa,EAAE;aACvB,cAAc,CAAC,kCAAgB,CAAC,eAAe,CAAC;aAChD,cAAc,CAAC,IAAI,CAAC;aACpB,eAAe,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;CACF;AAED,kBAAe,sBAAsB,CAAC"}

package/node/wrappers/models/security/MortgageBackedSecurity.ts

@@ -0,0 +1,125 @@
+import BondSecurity, {
+  BondPricerInputs,
+  buildBondDetails,
+  decimalToProto,
+} from './BondSecurity';
+import { SecurityProto, MbsExtensionProto } from '../../../fintekkers/models/security/security_pb';
+import { AgencyProto } from '../../../fintekkers/models/security/bond/agency_pb';
+import { ProductTypeProto } from '../../../fintekkers/models/security/product_type_pb';
+import { Decimal } from 'decimal.js';
+
+/**
+ * MBS-specific accessors layered on top of BondSecurity. Pool-level fields
+ * (agency, WAC, WAM, pass-through rate, factors, balances, PSA) live in
+ * the parallel mbs_extension sub-message; bond_details still carries the
+ * canonical coupon/dates/face value.
+ */
+class MortgageBackedSecurity extends BondSecurity {
+  constructor(proto: SecurityProto) {
+    super(proto);
+  }
+
+  private getMbsExtension(): MbsExtensionProto | undefined {
+    return this.proto.getMbsExtension() ?? undefined;
+  }
+
+  /** Pool identifier (e.g. "FN AS1234"). */
+  getPoolNumber(): string {
+    const ext = this.getMbsExtension();
+    return ext ? ext.getPoolNumber() : '';
+  }
+
+  /** Issuing agency (FNMA / FHLMC / GNMA). */
+  getAgency(): AgencyProto {
+    const ext = this.getMbsExtension();
+    return ext ? ext.getAgency() : AgencyProto.AGENCY_UNKNOWN;
+  }
+
+  /** Weighted Average Coupon across underlying loans. */
+  getWac(): Decimal | null {
+    const ext = this.getMbsExtension();
+    const v = ext ? ext.getWac() : undefined;
+    if (!v) return null;
+    return new Decimal(v.getArbitraryPrecisionValue());
+  }
+
+  /** Weighted Average Maturity, in months. */
+  getWam(): number {
+    const ext = this.getMbsExtension();
+    return ext ? ext.getWam() : 0;
+  }
+
+  /** Pass-through rate paid to investors (net of servicing/guarantee fees). */
+  getPassThroughRate(): Decimal | null {
+    const ext = this.getMbsExtension();
+    const v = ext ? ext.getPassThroughRate() : undefined;
+    if (!v) return null;
+    return new Decimal(v.getArbitraryPrecisionValue());
+  }
+
+  /** Current pool factor (remaining UPB / original face). */
+  getCurrentFactor(): Decimal | null {
+    const ext = this.getMbsExtension();
+    const v = ext ? ext.getCurrentFactor() : undefined;
+    if (!v) return null;
+    return new Decimal(v.getArbitraryPrecisionValue());
+  }
+
+  /** Original face value at issuance. */
+  getOriginalFaceValue(): Decimal | null {
+    const ext = this.getMbsExtension();
+    const v = ext ? ext.getOriginalFaceValue() : undefined;
+    if (!v) return null;
+    return new Decimal(v.getArbitraryPrecisionValue());
+  }
+
+  /** Current Unpaid Principal Balance. */
+  getCurrentUpb(): Decimal | null {
+    const ext = this.getMbsExtension();
+    const v = ext ? ext.getCurrentUpb() : undefined;
+    if (!v) return null;
+    return new Decimal(v.getArbitraryPrecisionValue());
+  }
+
+  /** PSA prepayment speed assumption. */
+  getPsaSpeed(): Decimal | null {
+    const ext = this.getMbsExtension();
+    const v = ext ? ext.getPsaSpeed() : undefined;
+    if (!v) return null;
+    return new Decimal(v.getArbitraryPrecisionValue());
+  }
+
+  /**
+   * Build a fresh SecurityProto for an agency MBS pass-through. product_type
+   * is set to MORTGAGE_BACKED so Security.create routes back to this wrapper.
+   */
+  static fromPricerInputs(args: BondPricerInputs & {
+    poolNumber: string;
+    agency: AgencyProto;
+    wac: Decimal;
+    wam: number;
+    passThroughRate: Decimal;
+    currentFactor: Decimal;
+    originalFaceValue: Decimal;
+    currentUpb: Decimal;
+    psaSpeed: Decimal;
+  }): SecurityProto {
+    const bond = buildBondDetails(args);
+    const mbs = new MbsExtensionProto()
+      .setPoolNumber(args.poolNumber)
+      .setAgency(args.agency)
+      .setWac(decimalToProto(args.wac))
+      .setWam(args.wam)
+      .setPassThroughRate(decimalToProto(args.passThroughRate))
+      .setCurrentFactor(decimalToProto(args.currentFactor))
+      .setOriginalFaceValue(decimalToProto(args.originalFaceValue))
+      .setCurrentUpb(decimalToProto(args.currentUpb))
+      .setPsaSpeed(decimalToProto(args.psaSpeed));
+    return new SecurityProto()
+      .setProductType(ProductTypeProto.MORTGAGE_BACKED)
+      .setBondDetails(bond)
+      .setMbsExtension(mbs);
+  }
+}
+
+export default MortgageBackedSecurity;

package/node/wrappers/models/security/TIPSBond.d.ts

@@ -0,0 +1,30 @@
+import BondSecurity, { BondPricerInputs } from './BondSecurity';
+import { SecurityProto } from '../../../fintekkers/models/security/security_pb';
+import { IndexTypeProto } from '../../../fintekkers/models/security/index/index_type_pb';
+import { LocalDate } from '../utils/date';
+import { Decimal } from 'decimal.js';
+/**
+ * TIPS-specific accessors layered on top of BondSecurity. The inflation
+ * fields live in the parallel tips_extension sub-message; bond_details
+ * (coupon, maturity, etc.) still carries the rest.
+ */
+declare class TIPSBond extends BondSecurity {
+    constructor(proto: SecurityProto);
+    private getTipsExtension;
+    /** Base CPI value at issue, used to scale inflation-adjusted principal. */
+    getBaseCpi(): Decimal | null;
+    /** Reference date for the base CPI fixing. */
+    getIndexDate(): LocalDate | null;
+    /** Which inflation index drives accruals (CPI_U on US TIPS). */
+    getInflationIndexType(): IndexTypeProto;
+    /**
+     * Build a fresh SecurityProto for a TIPS bond. product_type is set to
+     * TIPS so Security.create routes back to this wrapper.
+     */
+    static fromPricerInputs(args: BondPricerInputs & {
+        baseCpi: Decimal;
+        indexDate: LocalDate;
+        inflationIndexType: IndexTypeProto;
+    }): SecurityProto;
+}
+export default TIPSBond;

package/node/wrappers/models/security/TIPSBond.js

@@ -0,0 +1,83 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BondSecurity_1 = __importStar(require("./BondSecurity"));
+const security_pb_1 = require("../../../fintekkers/models/security/security_pb");
+const product_type_pb_1 = require("../../../fintekkers/models/security/product_type_pb");
+const index_type_pb_1 = require("../../../fintekkers/models/security/index/index_type_pb");
+const date_1 = require("../utils/date");
+const decimal_js_1 = require("decimal.js");
+/**
+ * TIPS-specific accessors layered on top of BondSecurity. The inflation
+ * fields live in the parallel tips_extension sub-message; bond_details
+ * (coupon, maturity, etc.) still carries the rest.
+ */
+class TIPSBond extends BondSecurity_1.default {
+    constructor(proto) {
+        super(proto);
+    }
+    getTipsExtension() {
+        var _a;
+        return (_a = this.proto.getTipsExtension()) !== null && _a !== void 0 ? _a : undefined;
+    }
+    /** Base CPI value at issue, used to scale inflation-adjusted principal. */
+    getBaseCpi() {
+        const ext = this.getTipsExtension();
+        const v = ext ? ext.getBaseCpi() : undefined;
+        if (!v)
+            return null;
+        return new decimal_js_1.Decimal(v.getArbitraryPrecisionValue());
+    }
+    /** Reference date for the base CPI fixing. */
+    getIndexDate() {
+        const ext = this.getTipsExtension();
+        const d = ext ? ext.getIndexDate() : undefined;
+        if (!d)
+            return null;
+        return new date_1.LocalDate(d);
+    }
+    /** Which inflation index drives accruals (CPI_U on US TIPS). */
+    getInflationIndexType() {
+        const ext = this.getTipsExtension();
+        return ext ? ext.getInflationIndexType() : index_type_pb_1.IndexTypeProto.UNKNOWN_INDEX_TYPE;
+    }
+    /**
+     * Build a fresh SecurityProto for a TIPS bond. product_type is set to
+     * TIPS so Security.create routes back to this wrapper.
+     */
+    static fromPricerInputs(args) {
+        const bond = (0, BondSecurity_1.buildBondDetails)(args);
+        const tips = new security_pb_1.TipsExtensionProto()
+            .setBaseCpi((0, BondSecurity_1.decimalToProto)(args.baseCpi))
+            .setIndexDate((0, BondSecurity_1.localDateToProto)(args.indexDate))
+            .setInflationIndexType(args.inflationIndexType);
+        return new security_pb_1.SecurityProto()
+            .setProductType(product_type_pb_1.ProductTypeProto.TIPS)
+            .setBondDetails(bond)
+            .setTipsExtension(tips);
+    }
+}
+exports.default = TIPSBond;
+//# sourceMappingURL=TIPSBond.js.map

package/node/wrappers/models/security/TIPSBond.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TIPSBond.js","sourceRoot":"","sources":["TIPSBond.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAKwB;AACxB,iFAAoG;AACpG,yFAAuF;AACvF,2FAAyF;AACzF,wCAA0C;AAC1C,2CAAqC;AAErC;;;;GAIG;AACH,MAAM,QAAS,SAAQ,sBAAY;IACjC,YAAY,KAAoB;QAC9B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEO,gBAAgB;;QACtB,OAAO,MAAA,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,mCAAI,SAAS,CAAC;IACpD,CAAC;IAED,2EAA2E;IAC3E,UAAU;QACR,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7C,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,IAAI,oBAAO,CAAC,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,8CAA8C;IAC9C,YAAY;QACV,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/C,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,OAAO,IAAI,gBAAS,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED,gEAAgE;IAChE,qBAAqB;QACnB,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACpC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,8BAAc,CAAC,kBAAkB,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAIvB;QACC,MAAM,IAAI,GAAG,IAAA,+BAAgB,EAAC,IAAI,CAAC,CAAC;QACpC,MAAM,IAAI,GAAG,IAAI,gCAAkB,EAAE;aAClC,UAAU,CAAC,IAAA,6BAAc,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACxC,YAAY,CAAC,IAAA,+BAAgB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC9C,qBAAqB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAClD,OAAO,IAAI,2BAAa,EAAE;aACvB,cAAc,CAAC,kCAAgB,CAAC,IAAI,CAAC;aACrC,cAAc,CAAC,IAAI,CAAC;aACpB,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,kBAAe,QAAQ,CAAC"}

package/node/wrappers/models/security/TIPSBond.ts

@@ -0,0 +1,70 @@
+import BondSecurity, {
+  BondPricerInputs,
+  buildBondDetails,
+  decimalToProto,
+  localDateToProto,
+} from './BondSecurity';
+import { SecurityProto, TipsExtensionProto } from '../../../fintekkers/models/security/security_pb';
+import { ProductTypeProto } from '../../../fintekkers/models/security/product_type_pb';
+import { IndexTypeProto } from '../../../fintekkers/models/security/index/index_type_pb';
+import { LocalDate } from '../utils/date';
+import { Decimal } from 'decimal.js';
+
+/**
+ * TIPS-specific accessors layered on top of BondSecurity. The inflation
+ * fields live in the parallel tips_extension sub-message; bond_details
+ * (coupon, maturity, etc.) still carries the rest.
+ */
+class TIPSBond extends BondSecurity {
+  constructor(proto: SecurityProto) {
+    super(proto);
+  }
+
+  private getTipsExtension(): TipsExtensionProto | undefined {
+    return this.proto.getTipsExtension() ?? undefined;
+  }
+
+  /** Base CPI value at issue, used to scale inflation-adjusted principal. */
+  getBaseCpi(): Decimal | null {
+    const ext = this.getTipsExtension();
+    const v = ext ? ext.getBaseCpi() : undefined;
+    if (!v) return null;
+    return new Decimal(v.getArbitraryPrecisionValue());
+  }
+
+  /** Reference date for the base CPI fixing. */
+  getIndexDate(): LocalDate | null {
+    const ext = this.getTipsExtension();
+    const d = ext ? ext.getIndexDate() : undefined;
+    if (!d) return null;
+    return new LocalDate(d);
+  }
+
+  /** Which inflation index drives accruals (CPI_U on US TIPS). */
+  getInflationIndexType(): IndexTypeProto {
+    const ext = this.getTipsExtension();
+    return ext ? ext.getInflationIndexType() : IndexTypeProto.UNKNOWN_INDEX_TYPE;
+  }
+
+  /**
+   * Build a fresh SecurityProto for a TIPS bond. product_type is set to
+   * TIPS so Security.create routes back to this wrapper.
+   */
+  static fromPricerInputs(args: BondPricerInputs & {
+    baseCpi: Decimal;
+    indexDate: LocalDate;
+    inflationIndexType: IndexTypeProto;
+  }): SecurityProto {
+    const bond = buildBondDetails(args);
+    const tips = new TipsExtensionProto()
+      .setBaseCpi(decimalToProto(args.baseCpi))
+      .setIndexDate(localDateToProto(args.indexDate))
+      .setInflationIndexType(args.inflationIndexType);
+    return new SecurityProto()
+      .setProductType(ProductTypeProto.TIPS)
+      .setBondDetails(bond)
+      .setTipsExtension(tips);
+  }
+}
+
+export default TIPSBond;

package/node/wrappers/models/security/security.d.ts

@@ -1,9 +1,10 @@
 import { FieldProto } from "../../../fintekkers/models/position/field_pb";
-import { IdentifierProto } from "../../../fintekkers/models/security/identifier/identifier_pb";
 import { SecurityProto } from "../../../fintekkers/models/security/security_pb";
 import { ZonedDateTime } from "../utils/datetime";
 import { UUID } from "../utils/uuid";
 import { LocalDate } from "../utils/date";
+import { IdentifierTypeProto } from "../../../fintekkers/models/security/identifier/identifier_type_pb";
+import { Identifier } from "./identifier";
 declare class Security {
     proto: SecurityProto;
     constructor(proto: SecurityProto);
@@ -33,7 +34,14 @@ declare class Security {
      */
     private assertNotLink;
     /**
-     * Factory method to create the appropriate Security subclass based on security type
+     * Factory method to create the appropriate Security subclass based on
+     * the proto's product_type. Dispatch rules:
+     *   - TIPS                       -> TIPSBond
+     *   - TREASURY_FRN               -> FloatingRateNote
+     *   - MORTGAGE_BACKED            -> MortgageBackedSecurity
+     *   - any other descendant of BOND in hierarchy.json -> BondSecurity
+     *   - any descendant of INDEX in hierarchy.json     -> IndexSecurity
+     *   - everything else (equity, cash, fx, etc.)       -> base Security
      */
     static create(proto: SecurityProto): Security;
     /**
@@ -63,7 +71,16 @@ declare class Security {
     getAssetClass(): string;
     getProductClass(): string;
     getProductType(): string;
-    getSecurityID(): IdentifierProto;
+    /**
+     * Returns every Identifier attached to this security as typed wrappers.
+     * Empty list if none are set. Throws on a link-mode Security.
+     */
+    getIdentifiers(): Identifier[];
+    /**
+     * Returns the first Identifier matching the given IdentifierTypeProto,
+     * or undefined if none is present. Throws on a link-mode Security.
+     */
+    getIdentifierByType(type: IdentifierTypeProto): Identifier | undefined;
     /**
      * Returns the issue date if set, else null. Per-type semantic:
      *   - Bond / TIPS / FRN: auction date.

package/node/wrappers/models/security/security.identifiers.test.d.ts

@@ -0,0 +1 @@
+export {};