@hazbase/simplicity 0.0.5 → 0.2.0

package/dist/domain/receivableValidation.d.ts

@@ -0,0 +1,147 @@
+import { ReceivableClosingDescriptor, ReceivableClosingReason, ReceivableClaimTrust, ReceivableDefinition, ReceivableFundingClaimDescriptor, ReceivableRepaymentClaimDescriptor, ReceivableState, ReceivableStatus } from "../core/types";
+export declare function summarizeReceivableDefinition(definition: ReceivableDefinition): {
+    canonicalJson: string;
+    hash: string;
+};
+export declare function summarizeReceivableState(state: ReceivableState): {
+    canonicalJson: string;
+    hash: string;
+};
+export declare function summarizeReceivableClosingDescriptor(closing: ReceivableClosingDescriptor): {
+    canonicalJson: string;
+    hash: string;
+};
+export declare function summarizeReceivableFundingClaimDescriptor(claim: ReceivableFundingClaimDescriptor): {
+    canonicalJson: string;
+    hash: string;
+};
+export declare function summarizeReceivableRepaymentClaimDescriptor(claim: ReceivableRepaymentClaimDescriptor): {
+    canonicalJson: string;
+    hash: string;
+};
+export declare function validateReceivableDefinition(value: unknown): ReceivableDefinition;
+export declare function validateReceivableState(value: unknown): ReceivableState;
+export declare function validateReceivableClosingDescriptor(value: unknown): ReceivableClosingDescriptor;
+export declare function validateReceivableFundingClaimDescriptor(value: unknown): ReceivableFundingClaimDescriptor;
+export declare function validateReceivableRepaymentClaimDescriptor(value: unknown): ReceivableRepaymentClaimDescriptor;
+export declare function validateReceivableCrossChecks(definition: ReceivableDefinition, state: ReceivableState): {
+    receivableIdMatch: boolean;
+    originatorMatch: boolean;
+    debtorMatch: boolean;
+    currencyMatch: boolean;
+    controllerMatch: boolean;
+    faceValueMatch: boolean;
+    arithmeticValid: boolean;
+};
+export declare function buildFundedReceivableState(input: {
+    previous: ReceivableState;
+    stateId: string;
+    holderEntityId: string;
+    fundedAt: string;
+}): ReceivableState;
+export declare function applyReceivableRepayment(input: {
+    previous: ReceivableState;
+    stateId: string;
+    amount: number;
+    repaidAt: string;
+}): ReceivableState;
+export declare function buildDefaultedReceivableState(input: {
+    previous: ReceivableState;
+    stateId: string;
+    defaultedAt: string;
+    writeOffAmount?: number;
+}): ReceivableState;
+export declare function buildReceivableClosingDescriptor(input: {
+    closingId: string;
+    latestState: ReceivableState;
+    closedAt: string;
+    closingReason?: ReceivableClosingReason;
+}): ReceivableClosingDescriptor;
+export declare function buildReceivableFundingClaimDescriptor(input: {
+    claimId: string;
+    currentState: ReceivableState;
+    payerEntityId?: string;
+    payeeEntityId?: string;
+    claimantXonly?: string;
+    amountSat?: number;
+    eventTimestamp?: string;
+}): ReceivableFundingClaimDescriptor;
+export declare function buildReceivableRepaymentClaimDescriptor(input: {
+    claimId: string;
+    currentState: ReceivableState;
+    payerEntityId?: string;
+    payeeEntityId?: string;
+    claimantXonly?: string;
+    amountSat?: number;
+    eventTimestamp?: string;
+}): ReceivableRepaymentClaimDescriptor;
+export declare function validateReceivableFundingClaimAgainstState(input: {
+    currentState: ReceivableState;
+    claim: ReceivableFundingClaimDescriptor;
+}): Omit<ReceivableClaimTrust, "generated" | "bindingMode" | "requestedMode" | "supportedForm" | "reasonCode" | "nextReceiverRuntimeCommitted" | "nextOutputHashRuntimeBound" | "nextOutputScriptRuntimeBound" | "amountRuntimeBound" | "autoDerived" | "fallbackReason" | "bindingInputs" | "claimantXonlyCommitted">;
+export declare function validateReceivableRepaymentClaimAgainstState(input: {
+    currentState: ReceivableState;
+    claim: ReceivableRepaymentClaimDescriptor;
+}): Omit<ReceivableClaimTrust, "generated" | "bindingMode" | "requestedMode" | "supportedForm" | "reasonCode" | "nextReceiverRuntimeCommitted" | "nextOutputHashRuntimeBound" | "nextOutputScriptRuntimeBound" | "amountRuntimeBound" | "autoDerived" | "fallbackReason" | "bindingInputs" | "claimantXonlyCommitted">;
+export declare function validateReceivableFundingTransition(previousValue: ReceivableState, nextValue: ReceivableState): {
+    transitionType: "FUND";
+    previousStateHashMatch: true;
+    participantConsistencyValid: true;
+    statusProgressionValid: true;
+    arithmeticDeltaValid: true;
+    createdAtMonotonic: true;
+    transitionAmountValid: true;
+    fullTransitionVerified: boolean;
+};
+export declare function validateReceivableRepaymentTransition(previousValue: ReceivableState, nextValue: ReceivableState): {
+    transitionType: "REPAY";
+    previousStateHashMatch: true;
+    participantConsistencyValid: true;
+    statusProgressionValid: true;
+    arithmeticDeltaValid: true;
+    createdAtMonotonic: true;
+    transitionAmountValid: true;
+    fullTransitionVerified: boolean;
+};
+export declare function validateReceivableWriteOffTransition(previousValue: ReceivableState, nextValue: ReceivableState): {
+    transitionType: "WRITE_OFF";
+    previousStateHashMatch: true;
+    participantConsistencyValid: true;
+    statusProgressionValid: true;
+    arithmeticDeltaValid: true;
+    createdAtMonotonic: true;
+    transitionAmountValid: true;
+    fullTransitionVerified: boolean;
+};
+export declare function validateReceivableClosingAgainstState(input: {
+    latestState: ReceivableState;
+    closing: ReceivableClosingDescriptor;
+    history?: ReceivableState[];
+}): {
+    terminalStatusEligible: true;
+    latestStateHashMatch: true;
+    closingReasonMatchesStatus: true;
+    historyTipMatches: true;
+    lineageProvided: boolean;
+    fullClosingVerified: boolean;
+};
+export declare function verifyReceivableStateHistory(input: {
+    history: ReceivableState[];
+}): {
+    chainLength: number;
+    startsAtGenesis: boolean;
+    latestStatus: ReceivableStatus;
+    allPreviousStateHashMatch: boolean;
+    receivableIdConsistent: boolean;
+    originatorConsistent: boolean;
+    debtorConsistent: boolean;
+    currencyConsistent: boolean;
+    controllerConsistent: boolean;
+    faceValueConsistent: boolean;
+    allArithmeticValid: boolean;
+    allStatusProgressionValid: boolean;
+    fullHistoryVerified: boolean;
+    summaries: {
+        hash: string;
+    }[];
+};