@hazbase/simplicity 0.0.3 → 0.0.4

package/dist/domain/bondValidation.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateBondDefinition = validateBondDefinition;
+exports.validateBondIssuanceState = validateBondIssuanceState;
+exports.validateBondCrossChecks = validateBondCrossChecks;
+const errors_1 = require("../core/errors");
+function assertNonEmptyString(value, code, message) {
+    if (typeof value !== "string" || value.trim().length === 0) {
+        throw new errors_1.ValidationError(message, { code });
+    }
+}
+function assertFiniteNumber(value, code, message) {
+    if (typeof value !== "number" || !Number.isFinite(value)) {
+        throw new errors_1.ValidationError(message, { code });
+    }
+}
+function validateBondDefinition(value) {
+    const definition = value;
+    assertNonEmptyString(definition?.bondId, "BOND_ID_INVALID", "bondId must be a non-empty string");
+    assertNonEmptyString(definition?.issuer, "BOND_ISSUER_INVALID", "issuer must be a non-empty string");
+    assertFiniteNumber(definition?.faceValue, "BOND_FACE_VALUE_INVALID", "faceValue must be a finite number");
+    assertFiniteNumber(definition?.couponBps, "BOND_COUPON_INVALID", "couponBps must be a finite number");
+    assertNonEmptyString(definition?.issueDate, "BOND_ISSUE_DATE_INVALID", "issueDate must be a non-empty string");
+    assertFiniteNumber(definition?.maturityDate, "BOND_MATURITY_DATE_INVALID", "maturityDate must be a finite number");
+    assertNonEmptyString(definition?.currencyAssetId, "BOND_CURRENCY_INVALID", "currencyAssetId must be a non-empty string");
+    assertNonEmptyString(definition?.controllerXonly, "BOND_CONTROLLER_INVALID", "controllerXonly must be a non-empty string");
+    return definition;
+}
+function validateBondIssuanceState(value) {
+    const issuance = value;
+    assertNonEmptyString(issuance?.issuanceId, "BOND_ISSUANCE_ID_INVALID", "issuanceId must be a non-empty string");
+    assertNonEmptyString(issuance?.bondId, "BOND_ID_INVALID", "bondId must be a non-empty string");
+    assertNonEmptyString(issuance?.issuerEntityId, "BOND_ISSUER_ENTITY_INVALID", "issuerEntityId must be a non-empty string");
+    assertFiniteNumber(issuance?.issuedPrincipal, "BOND_ISSUED_PRINCIPAL_INVALID", "issuedPrincipal must be a finite number");
+    assertFiniteNumber(issuance?.outstandingPrincipal, "BOND_OUTSTANDING_PRINCIPAL_INVALID", "outstandingPrincipal must be a finite number");
+    assertFiniteNumber(issuance?.redeemedPrincipal, "BOND_REDEEMED_PRINCIPAL_INVALID", "redeemedPrincipal must be a finite number");
+    assertNonEmptyString(issuance?.currencyAssetId, "BOND_CURRENCY_INVALID", "currencyAssetId must be a non-empty string");
+    assertNonEmptyString(issuance?.controllerXonly, "BOND_CONTROLLER_INVALID", "controllerXonly must be a non-empty string");
+    assertNonEmptyString(issuance?.issuedAt, "BOND_ISSUED_AT_INVALID", "issuedAt must be a non-empty string");
+    if (issuance.status !== "ISSUED" && issuance.status !== "REDEEMED") {
+        throw new errors_1.ValidationError("status must be ISSUED or REDEEMED", { code: "BOND_STATUS_INVALID" });
+    }
+    if (issuance.issuedPrincipal <= 0) {
+        throw new errors_1.ValidationError("issuedPrincipal must be greater than 0", { code: "BOND_PRINCIPAL_INVARIANT_INVALID" });
+    }
+    if (issuance.outstandingPrincipal < 0 || issuance.redeemedPrincipal < 0) {
+        throw new errors_1.ValidationError("principal values must not be negative", { code: "BOND_PRINCIPAL_INVARIANT_INVALID" });
+    }
+    if (issuance.issuedPrincipal !== issuance.outstandingPrincipal + issuance.redeemedPrincipal) {
+        throw new errors_1.ValidationError("issuedPrincipal must equal outstandingPrincipal + redeemedPrincipal", {
+            code: "BOND_PRINCIPAL_INVARIANT_INVALID",
+        });
+    }
+    if (Number.isNaN(Date.parse(issuance.issuedAt))) {
+        throw new errors_1.ValidationError("issuedAt must be an ISO8601 string", { code: "BOND_ISSUED_AT_INVALID" });
+    }
+    return issuance;
+}
+function validateBondCrossChecks(definition, issuance) {
+    const result = {
+        bondIdMatch: definition.bondId === issuance.bondId,
+        currencyMatch: definition.currencyAssetId === issuance.currencyAssetId,
+        controllerMatch: definition.controllerXonly === issuance.controllerXonly,
+        principalInvariantValid: issuance.issuedPrincipal > 0 &&
+            issuance.outstandingPrincipal >= 0 &&
+            issuance.redeemedPrincipal >= 0 &&
+            issuance.issuedPrincipal === issuance.outstandingPrincipal + issuance.redeemedPrincipal,
+    };
+    if (!result.bondIdMatch) {
+        throw new errors_1.ValidationError("Bond definition and issuance state bondId do not match", {
+            code: "BOND_ID_MISMATCH",
+        });
+    }
+    if (!result.currencyMatch) {
+        throw new errors_1.ValidationError("Bond definition and issuance state currencyAssetId do not match", {
+            code: "BOND_CURRENCY_MISMATCH",
+        });
+    }
+    if (!result.controllerMatch) {
+        throw new errors_1.ValidationError("Bond definition and issuance state controllerXonly do not match", {
+            code: "BOND_CONTROLLER_MISMATCH",
+        });
+    }
+    if (!result.principalInvariantValid) {
+        throw new errors_1.ValidationError("Bond issuance principal invariants are invalid", {
+            code: "BOND_PRINCIPAL_INVARIANT_INVALID",
+        });
+    }
+    return result;
+}

package/dist/index.d.ts

@@ -7,3 +7,6 @@ export * from "./core/errors";
 export { listPresets, getPresetOrThrow } from "./core/presets";
 export { loadArtifact, saveArtifact, normalizeArtifact } from "./core/artifact";
 export { loadDefinitionInput, buildArtifactDefinitionMetadata, verifyDefinitionAgainstArtifact, verifyDefinitionDescriptorAgainstArtifact, } from "./core/definition";
+export { loadStateInput, buildArtifactStateMetadata, verifyStateAgainstArtifact, verifyStateDescriptorAgainstArtifact, } from "./core/state";
+export { defineBond, verifyBond, loadBond } from "./domain/bond";
+export { validateBondDefinition, validateBondIssuanceState, validateBondCrossChecks, } from "./domain/bondValidation";

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyDefinitionDescriptorAgainstArtifact = exports.verifyDefinitionAgainstArtifact = exports.buildArtifactDefinitionMetadata = exports.loadDefinitionInput = exports.normalizeArtifact = exports.saveArtifact = exports.loadArtifact = exports.getPresetOrThrow = exports.listPresets = exports.RelayerClient = exports.DeployedContract = exports.CompiledContract = exports.SimplicityClient = exports.createSimplicityClient = void 0;
+exports.validateBondCrossChecks = exports.validateBondIssuanceState = exports.validateBondDefinition = exports.loadBond = exports.verifyBond = exports.defineBond = exports.verifyStateDescriptorAgainstArtifact = exports.verifyStateAgainstArtifact = exports.buildArtifactStateMetadata = exports.loadStateInput = exports.verifyDefinitionDescriptorAgainstArtifact = exports.verifyDefinitionAgainstArtifact = exports.buildArtifactDefinitionMetadata = exports.loadDefinitionInput = exports.normalizeArtifact = exports.saveArtifact = exports.loadArtifact = exports.getPresetOrThrow = exports.listPresets = exports.RelayerClient = exports.DeployedContract = exports.CompiledContract = exports.SimplicityClient = exports.createSimplicityClient = void 0;
 var SimplicityClient_1 = require("./client/SimplicityClient");
 Object.defineProperty(exports, "createSimplicityClient", { enumerable: true, get: function () { return SimplicityClient_1.createSimplicityClient; } });
 Object.defineProperty(exports, "SimplicityClient", { enumerable: true, get: function () { return SimplicityClient_1.SimplicityClient; } });
@@ -38,3 +38,16 @@ Object.defineProperty(exports, "loadDefinitionInput", { enumerable: true, get: f
 Object.defineProperty(exports, "buildArtifactDefinitionMetadata", { enumerable: true, get: function () { return definition_1.buildArtifactDefinitionMetadata; } });
 Object.defineProperty(exports, "verifyDefinitionAgainstArtifact", { enumerable: true, get: function () { return definition_1.verifyDefinitionAgainstArtifact; } });
 Object.defineProperty(exports, "verifyDefinitionDescriptorAgainstArtifact", { enumerable: true, get: function () { return definition_1.verifyDefinitionDescriptorAgainstArtifact; } });
+var state_1 = require("./core/state");
+Object.defineProperty(exports, "loadStateInput", { enumerable: true, get: function () { return state_1.loadStateInput; } });
+Object.defineProperty(exports, "buildArtifactStateMetadata", { enumerable: true, get: function () { return state_1.buildArtifactStateMetadata; } });
+Object.defineProperty(exports, "verifyStateAgainstArtifact", { enumerable: true, get: function () { return state_1.verifyStateAgainstArtifact; } });
+Object.defineProperty(exports, "verifyStateDescriptorAgainstArtifact", { enumerable: true, get: function () { return state_1.verifyStateDescriptorAgainstArtifact; } });
+var bond_1 = require("./domain/bond");
+Object.defineProperty(exports, "defineBond", { enumerable: true, get: function () { return bond_1.defineBond; } });
+Object.defineProperty(exports, "verifyBond", { enumerable: true, get: function () { return bond_1.verifyBond; } });
+Object.defineProperty(exports, "loadBond", { enumerable: true, get: function () { return bond_1.loadBond; } });
+var bondValidation_1 = require("./domain/bondValidation");
+Object.defineProperty(exports, "validateBondDefinition", { enumerable: true, get: function () { return bondValidation_1.validateBondDefinition; } });
+Object.defineProperty(exports, "validateBondIssuanceState", { enumerable: true, get: function () { return bondValidation_1.validateBondIssuanceState; } });
+Object.defineProperty(exports, "validateBondCrossChecks", { enumerable: true, get: function () { return bondValidation_1.validateBondCrossChecks; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hazbase/simplicity",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "An SDK for Simplicity on Liquid",
   "author": "IndieSquare Inc <info@hazbase.com>",
   "keywords": [