@hazbase/simplicity 0.0.4 → 0.1.1

package/dist/core/types.d.ts

@@ -153,6 +153,51 @@ export interface ArtifactStateMetadata {
         sourceVerified: boolean;
     };
 }
+export type BondIssuanceStatus = "ISSUED" | "PARTIALLY_REDEEMED" | "REDEEMED" | "CLOSED";
+export type BondTransitionType = "ISSUE" | "REDEEM";
+export type BondOutputBindingMode = "none" | "script-bound" | "descriptor-bound";
+export type PropagationMode = "required" | "optional" | "none";
+export type OutputBindingReasonCode = "OK_EXPLICIT" | "OK_RAW_OUTPUT" | "OK_MANUAL_HASH" | "OK_SCRIPT_BOUND" | "OK_NONE" | "FALLBACK_UNSUPPORTED_ASSET" | "FALLBACK_UNSUPPORTED_OUTPUT_FORM" | "FALLBACK_MISSING_HASH_INPUT" | "FALLBACK_INCOMPLETE_RAW_OUTPUT" | "FALLBACK_INVALID_RAW_OUTPUT";
+export type OutputBindingSupportedForm = "explicit-v1" | "raw-output-v1" | "unsupported";
+export type OutputAssetForm = "explicit" | "confidential";
+export type OutputAmountForm = "explicit" | "confidential";
+export type OutputNonceForm = "null" | "confidential";
+export type OutputRangeProofForm = "empty" | "non-empty";
+export interface OutputForm {
+    assetForm: OutputAssetForm;
+    amountForm: OutputAmountForm;
+    nonceForm: OutputNonceForm;
+    rangeProofForm: OutputRangeProofForm;
+}
+export interface OutputRawFields {
+    assetBytesHex: string;
+    amountBytesHex: string;
+    nonceBytesHex: string;
+    scriptPubKeyHex?: string;
+    scriptPubKeyHashHex?: string;
+    rangeProofHex?: string;
+    rangeProofHashHex?: string;
+}
+export interface OutputBindingInputs {
+    assetId: string;
+    assetForm: OutputAssetForm;
+    amountForm: OutputAmountForm;
+    nonceForm: OutputNonceForm;
+    rangeProofForm: OutputRangeProofForm;
+    nextAmountSat: number;
+    nextOutputIndex: number;
+    feeIndex: number;
+    maxFeeSat: number;
+    rawOutputComponents?: {
+        scriptPubKey: "raw-bytes" | "hash";
+        rangeProof: "raw-bytes" | "hash";
+    };
+}
+export interface BondStateTransition {
+    type: BondTransitionType;
+    amount: number;
+    at: string;
+}
 export interface DeploymentInfo {
     contractAddress: string;
     internalKey: string;
@@ -194,6 +239,7 @@ export interface CallBaseInput {
     periodId?: string;
     bondDefinitionId?: string;
     sequence?: number;
+    locktimeHeight?: number;
     witness?: WitnessConfig;
 }
 export interface InspectCallInput extends CallBaseInput {
@@ -280,6 +326,7 @@ export interface GaslessExecuteInput {
     contractChangeAddress?: string;
     sponsorChangeAddress?: string;
     utxoPolicy?: UtxoPolicy;
+    locktimeHeight?: number;
     broadcast?: boolean;
 }
 export interface GaslessExecuteResult {
@@ -342,7 +389,545 @@ export interface BondIssuanceState {
     currencyAssetId: string;
     controllerXonly: string;
     issuedAt: string;
-    status: "ISSUED" | "REDEEMED";
+    status: BondIssuanceStatus;
+    previousStateHash?: string | null;
+    lastTransition?: BondStateTransition;
+    closedAt?: string;
+    closingReason?: "REDEEMED" | "CANCELLED" | "MATURED_OUT";
+    finalSettlementDescriptorHash?: string;
+}
+export interface BondSettlementDescriptor {
+    settlementId: string;
+    bondId: string;
+    issuanceId: string;
+    definitionHash: string;
+    previousStateHash: string;
+    nextStateHash: string;
+    previousStatus: BondIssuanceStatus;
+    nextStatus: BondIssuanceStatus;
+    transitionKind: BondTransitionType;
+    redeemAmount: number;
+    transitionAt: string;
+    assetId: string;
+    nextContractAddress: string;
+    nextAmountSat: number;
+    maxFeeSat: number;
+    expectedOutputDescriptorHash?: string;
+    outputBindingMode?: BondOutputBindingMode;
+    principal: {
+        issued: number;
+        previousOutstanding: number;
+        nextOutstanding: number;
+        previousRedeemed: number;
+        nextRedeemed: number;
+    };
+}
+export interface BondExpectedOutputDescriptor {
+    nextContractAddress: string;
+    nextOutputHash?: string;
+    nextOutputScriptHash?: string;
+    nextAmountSat: number;
+    assetId: string;
+    requestedOutputBindingMode?: BondOutputBindingMode;
+    outputForm?: OutputForm;
+    rawOutput?: Partial<OutputRawFields>;
+    feeIndex: number;
+    nextOutputIndex: number;
+    maxFeeSat: number;
+    outputBindingMode?: BondOutputBindingMode;
+}
+export interface BondClosingDescriptor {
+    closingId: string;
+    bondId: string;
+    issuanceId: string;
+    previousStateHash: string;
+    closedStateHash: string;
+    finalStatus: "CLOSED";
+    closingReason: "REDEEMED" | "CANCELLED" | "MATURED_OUT";
+    closedAt: string;
+    definitionHash: string;
+    stateHash: string;
+    finalSettlementDescriptorHash: string;
+}
+export interface BondVerificationReport {
+    artifactTrust: {
+        definition: DefinitionVerificationResult["trust"];
+        state: StateVerificationResult["trust"];
+    };
+    stateTrust: StateVerificationResult["trust"];
+    settlementTrust?: {
+        descriptorHashMatch: boolean;
+        outputBindingMode: BondOutputBindingMode;
+    };
+    outputBindingTrust?: {
+        mode: BondOutputBindingMode;
+        requestedMode?: BondOutputBindingMode;
+        supportedForm?: OutputBindingSupportedForm;
+        nextContractAddressCommitted: boolean;
+        expectedOutputDescriptorCommitted: boolean;
+        settlementDescriptorCommitted?: boolean;
+        outputCountRuntimeBound: boolean;
+        feeIndexRuntimeBound: boolean;
+        nextOutputHashRuntimeBound?: boolean;
+        nextOutputScriptRuntimeBound: boolean;
+        amountRuntimeBound: boolean;
+        reasonCode?: OutputBindingReasonCode;
+        autoDerived?: boolean;
+        fallbackReason?: string;
+        bindingInputs?: OutputBindingInputs;
+    };
+    arithmeticTrust?: {
+        principalArithmeticCommitted: boolean;
+        principalArithmeticValid: boolean;
+        statusProgressionCommitted: boolean;
+        statusProgressionValid: boolean;
+    };
+    closingTrust?: {
+        finalStatusValid: boolean;
+        finalSettlementDescriptorHashMatch: boolean;
+    };
+}
+export interface BondEvidenceBundle {
+    artifact: SimplicityArtifact;
+    definition: {
+        canonicalJson: string;
+        hash: string;
+    };
+    issuance: {
+        canonicalJson: string;
+        hash: string;
+    };
+    transition?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    settlement?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    closing?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    trust: BondVerificationReport;
+    renderedSourceHash?: string;
+    sourceVerificationMode: "source-reloaded" | "artifact-only";
+    compiled: {
+        program: string;
+        cmr: string;
+        contractAddress: string;
+    };
+}
+export type CapitalCallStatus = "OPEN" | "CLAIMED" | "REFUND_ONLY" | "REFUNDED";
+export type CapitalCallStage = "open" | "claimed" | "refund-only" | "refunded";
+export type CapitalCallCutoffMode = "rollover-window";
+export type LPPositionReceiptStatus = "ACTIVE" | "PARTIALLY_DISTRIBUTED" | "FULLY_DISTRIBUTED" | "CLOSED";
+export type FundClosingReason = "LIQUIDATED" | "CANCELLED" | "WRITTEN_OFF";
+export type FundVerificationReportSchemaVersion = "fund-verification-report/v1";
+export type FundEvidenceBundleSchemaVersion = "fund-evidence-bundle/v1";
+export type FundFinalityPayloadSchemaVersion = "fund-finality-payload/v1";
+export type LPPositionReceiptSchemaVersion = "lp-position-receipt/v2";
+export type LPPositionReceiptAttestationScheme = "bip340-sha256";
+export interface FundDefinition {
+    fundId: string;
+    managerEntityId: string;
+    managerXonly: string;
+    currencyAssetId: string;
+    jurisdiction?: string;
+    vintage?: string;
+}
+export interface CapitalCallState {
+    callId: string;
+    fundId: string;
+    lpId: string;
+    currencyAssetId: string;
+    amount: number;
+    lpXonly: string;
+    managerXonly: string;
+    status: CapitalCallStatus;
+    fundedAt?: string;
+    claimedAt?: string;
+    refundedAt?: string;
+    previousStateHash?: string | null;
+    claimCutoffHeight: number;
+}
+export interface LPPositionReceipt {
+    schemaVersion: LPPositionReceiptSchemaVersion;
+    positionId: string;
+    fundId: string;
+    lpId: string;
+    callId: string;
+    currencyAssetId: string;
+    lpXonly: string;
+    sequence: number;
+    committedAmount: number;
+    fundedAmount: number;
+    distributedAmount: number;
+    distributionCount: number;
+    effectiveAt: string;
+    lastDistributedAt?: string;
+    status: LPPositionReceiptStatus;
+    previousReceiptHash?: string | null;
+}
+export interface LPPositionReceiptAttestation {
+    positionReceiptHash: string;
+    sequence: number;
+    managerXonly: string;
+    signedAt: string;
+    signature: string;
+    scheme: LPPositionReceiptAttestationScheme;
+}
+export interface LPPositionReceiptEnvelope {
+    receipt: LPPositionReceipt;
+    attestation: LPPositionReceiptAttestation;
+}
+export interface DistributionDescriptor {
+    distributionId: string;
+    positionId: string;
+    fundId: string;
+    lpId: string;
+    assetId: string;
+    amountSat: number;
+    approvedAt: string;
+    positionReceiptHash: string;
+}
+export interface FundPayoutDescriptor {
+    receiverAddress: string;
+    nextOutputHash?: string;
+    nextOutputScriptHash?: string;
+    amountSat: number;
+    assetId: string;
+    requestedOutputBindingMode?: BondOutputBindingMode;
+    outputForm?: OutputForm;
+    rawOutput?: Partial<OutputRawFields>;
+    feeIndex: number;
+    nextOutputIndex: number;
+    maxFeeSat: number;
+    outputBindingMode: BondOutputBindingMode;
+}
+export interface FundClosingDescriptor {
+    closingId: string;
+    fundId: string;
+    lpId: string;
+    positionId: string;
+    positionReceiptHash: string;
+    finalDistributionHashes: string[];
+    closedAt: string;
+    closingReason: FundClosingReason;
+}
+export interface FundVerificationReport {
+    schemaVersion: FundVerificationReportSchemaVersion;
+    artifactTrust?: {
+        definition: DefinitionVerificationResult["trust"];
+        state: StateVerificationResult["trust"];
+    };
+    stateTrust?: StateVerificationResult["trust"];
+    capitalCallTrust?: {
+        capitalCallStage: CapitalCallStage;
+        cutoffMode: CapitalCallCutoffMode;
+        fundIdMatch: boolean;
+        currencyMatch: boolean;
+        managerMatch: boolean;
+        claimCutoffCommitted: boolean;
+        lpCommitted: boolean;
+        managerCommitted: boolean;
+        claimPathRuntimeAvailable: boolean;
+        refundPathRuntimeAvailable: boolean;
+        statusValid: boolean;
+    };
+    distributionTrust?: {
+        fundIdMatch: boolean;
+        lpIdMatch: boolean;
+        positionIdMatch: boolean;
+        positionReceiptHashMatch: boolean;
+        positionStatusEligible: boolean;
+    };
+    outputBindingTrust?: {
+        mode: BondOutputBindingMode;
+        requestedMode?: BondOutputBindingMode;
+        supportedForm?: OutputBindingSupportedForm;
+        nextReceiverRuntimeCommitted: boolean;
+        outputCountRuntimeBound: boolean;
+        feeIndexRuntimeBound: boolean;
+        nextOutputHashRuntimeBound?: boolean;
+        nextOutputScriptRuntimeBound: boolean;
+        amountRuntimeBound: boolean;
+        reasonCode?: OutputBindingReasonCode;
+        autoDerived?: boolean;
+        fallbackReason?: string;
+        bindingInputs?: OutputBindingInputs;
+    };
+    receiptTrust?: {
+        generated: boolean;
+        positionReceiptHash?: string;
+        positionStatus: LPPositionReceiptStatus;
+        attested: boolean;
+        attestationVerified: boolean;
+        sequence?: number;
+        sequenceMonotonic?: boolean;
+        attestingSignerMatch?: boolean;
+    };
+    closingTrust?: {
+        positionReceiptHashMatch: boolean;
+        finalDistributionHashesPresent: boolean;
+        positionStatusEligible: boolean;
+    };
+}
+export interface FundEvidenceBundle {
+    schemaVersion: FundEvidenceBundleSchemaVersion;
+    artifact?: SimplicityArtifact;
+    definition: {
+        canonicalJson: string;
+        hash: string;
+    };
+    capitalCall?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    positionReceipt?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    positionReceiptEnvelope?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    distribution?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    distributions?: Array<{
+        canonicalJson: string;
+        hash: string;
+    }>;
+    closing?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    trust: FundVerificationReport;
+    renderedSourceHash?: string;
+    sourceVerificationMode: "source-reloaded" | "artifact-only";
+    compiled?: {
+        program: string;
+        cmr: string;
+        contractAddress: string;
+    };
+}
+export interface FundFinalityPayload {
+    schemaVersion: FundFinalityPayloadSchemaVersion;
+    fundId: string;
+    lpId: string;
+    callId?: string;
+    positionId?: string;
+    definitionHash: string;
+    capitalCallStateHash?: string | null;
+    positionReceiptHash?: string | null;
+    positionReceiptEnvelopeHash?: string | null;
+    distributionHash?: string | null;
+    distributionHashes?: string[] | null;
+    closingHash?: string | null;
+    bindingMode: BondOutputBindingMode;
+    trust: FundVerificationReport;
+    trustSummary: {
+        definition?: DefinitionVerificationResult["trust"];
+        state?: StateVerificationResult["trust"];
+        bindingMode: BondOutputBindingMode;
+    };
+}
+export interface PolicyReceiver {
+    mode: "plain" | "policy";
+    address?: string;
+    recipientXonly?: string;
+    defaultPolicyTemplateId?: string;
+    defaultParams?: Record<string, string | number | boolean>;
+}
+export interface PolicyTemplateDocument {
+    policyTemplateId: string;
+    description?: string;
+    metadata?: Record<string, unknown>;
+}
+export type PolicyTemplateManifestVersion = "policy-template-manifest/v1";
+export type PolicyVerificationReportSchemaVersion = "policy-verification-report/v1";
+export type PolicyEvidenceBundleSchemaVersion = "policy-evidence-bundle/v1";
+export type PolicyOutputBindingReasonCode = OutputBindingReasonCode;
+export type PolicyOutputBindingSupportedForm = OutputBindingSupportedForm;
+export type PolicyOutputAssetForm = OutputAssetForm;
+export type PolicyOutputAmountForm = OutputAmountForm;
+export type PolicyOutputNonceForm = OutputNonceForm;
+export type PolicyOutputRangeProofForm = OutputRangeProofForm;
+export type PolicyTemplateManifestValidationReasonCode = "OK" | "MANIFEST_VERSION_UNSUPPORTED" | "MANIFEST_FIELD_REQUIRED" | "MANIFEST_FIELD_INVALID" | "MANIFEST_PARAMETER_SCHEMA_INVALID" | "MANIFEST_BINDING_MODE_INVALID" | "MANIFEST_PROPAGATION_MODE_INVALID";
+export interface PolicyTemplateManifest {
+    templateId: string;
+    manifestVersion: PolicyTemplateManifestVersion;
+    title: string;
+    description: string;
+    stateSimfPath: string;
+    directStateSimfPath?: string;
+    parameterSchema: Record<string, "string" | "number" | "boolean">;
+    supportedBindingModes: BondOutputBindingMode[];
+    supportsPlainExit: boolean;
+    defaultPropagationMode: PropagationMode;
+}
+export interface PolicyTemplateInput {
+    templateId?: string;
+    manifestPath?: string;
+    manifestValue?: PolicyTemplateManifest;
+    jsonPath?: string;
+    value?: unknown;
+    stateSimfPath?: string;
+    directStateSimfPath?: string;
+    transferMachineSimfPath?: string;
+}
+export interface PolicyState {
+    policyTemplateId: string;
+    policyHash: string;
+    recipient: string;
+    amountSat: number;
+    assetId: string;
+    params: Record<string, string | number | boolean>;
+    propagationMode: PropagationMode;
+    previousStateHash?: string | null;
+    hop: number;
+    status: "LOCKED" | "SPENT";
+}
+export interface PolicyOutputDescriptor {
+    nextContractAddress: string;
+    nextOutputHash?: string;
+    nextOutputScriptHash?: string;
+    nextAmountSat: number;
+    assetId: string;
+    requestedOutputBindingMode?: BondOutputBindingMode;
+    outputForm?: OutputForm;
+    rawOutput?: Partial<OutputRawFields>;
+    feeIndex: number;
+    nextOutputIndex: number;
+    maxFeeSat: number;
+    outputBindingMode: BondOutputBindingMode;
+}
+export interface PolicyTransferDescriptor {
+    policyTemplateId: string;
+    previousPolicyHash: string;
+    nextPolicyHash?: string | null;
+    previousStateHash: string;
+    nextStateHash?: string | null;
+    propagationMode: PropagationMode;
+    plainExitAddress?: string | null;
+    outputDescriptor?: PolicyOutputDescriptor;
+}
+export interface PolicyVerificationReport {
+    schemaVersion: PolicyVerificationReportSchemaVersion;
+    templateTrust?: DefinitionVerificationResult["trust"];
+    stateTrust: StateVerificationResult["trust"];
+    propagationMode: PropagationMode;
+    nextPolicyRequired: boolean;
+    nextPolicyPresent: boolean;
+    plainExitAllowed: boolean;
+    outputBinding?: {
+        mode: BondOutputBindingMode;
+        supportedForm: PolicyOutputBindingSupportedForm;
+        committed: boolean;
+        runtimeBound: boolean;
+        sdkVerified: boolean;
+        amountRuntimeBound: boolean;
+        nextOutputHashRuntimeBound: boolean;
+        nextOutputScriptRuntimeBound: boolean;
+        reasonCode: PolicyOutputBindingReasonCode;
+        nextOutputHash?: string;
+        autoDerived?: boolean;
+        fallbackReason?: string;
+        bindingInputs?: OutputBindingInputs;
+    };
+    enforcement: "sdk-path" | "conditional-hop" | "direct-hop";
+}
+export interface PolicyEvidenceBundle {
+    schemaVersion: PolicyEvidenceBundleSchemaVersion;
+    artifact: SimplicityArtifact;
+    template: {
+        canonicalJson: string;
+        hash: string;
+    };
+    state: {
+        canonicalJson: string;
+        hash: string;
+    };
+    transfer?: {
+        canonicalJson: string;
+        hash: string;
+    };
+    report: PolicyVerificationReport;
+    renderedSourceHash?: string;
+    sourceVerificationMode: "source-reloaded" | "artifact-only";
+    compiled: {
+        program: string;
+        cmr: string;
+        contractAddress: string;
+    };
+}
+export interface OutputBindingSupportMatrix {
+    supportedForms: Array<{
+        form: OutputBindingSupportedForm;
+        description: string;
+        autoDerived: boolean;
+    }>;
+    unsupportedOutputFeatures: Array<{
+        feature: string;
+        description: string;
+        fallbackReasonCode: Extract<OutputBindingReasonCode, "FALLBACK_UNSUPPORTED_ASSET" | "FALLBACK_UNSUPPORTED_OUTPUT_FORM">;
+        manualHashSupported: boolean;
+    }>;
+    outputBindingModes: Record<BondOutputBindingMode, {
+        description: string;
+        runtimeBinding: "none" | "script-hash" | "output-hash";
+        fallbackBehavior: string;
+    }>;
+    autoDeriveConditions: {
+        assetInput: string[];
+        amountForm: string;
+        nonceForm: string;
+        rangeProofForm: string;
+        rawOutputFields?: string[];
+        rawOutputFieldAlternatives?: Record<string, string[]>;
+        outputHashExclusions?: string[];
+    };
+    manualHashPath: {
+        supported: boolean;
+        description: string;
+    };
+    fallbackBehavior: {
+        defaultMode: BondOutputBindingMode;
+        reasonCodes: OutputBindingReasonCode[];
+    };
+    publicValidationMatrix: {
+        local: string[];
+        testnet: string[];
+    };
+    nonGoals: string[];
+}
+export type PolicyBindingSupportMatrix = OutputBindingSupportMatrix;
+export interface OutputBindingSupportEvaluation {
+    requestedBindingMode: BondOutputBindingMode;
+    resolvedBindingMode: BondOutputBindingMode;
+    supportedForm: OutputBindingSupportedForm;
+    reasonCode: OutputBindingReasonCode;
+    autoDerived: boolean;
+    fallbackReason?: string;
+    assetId: string;
+    outputForm: OutputForm;
+    unsupportedFeatures: string[];
+    explicitAssetInputSupported: boolean;
+    manualHashSupplied: boolean;
+    nextOutputScriptAvailable: boolean;
+    rawOutputProvided?: boolean;
+    rawOutputComponents?: {
+        scriptPubKey: "raw-bytes" | "hash";
+        rangeProof: "raw-bytes" | "hash";
+    };
+}
+export interface PolicyTemplateManifestValidationResult {
+    ok: boolean;
+    reasonCode: PolicyTemplateManifestValidationReasonCode;
+    reason?: string;
+    manifest?: PolicyTemplateManifest;
 }
 export interface WaitForFundingInput {
     minAmountSat?: number;

package/dist/docs/definitions/bond-anchor.simf

@@ -0,0 +1,19 @@
+/*
+ * Bond definition hash anchor via executed logic.
+ */
+fn not(bit: bool) -> bool {
+    <u1>::into(jet::complement_1(<bool>::into(bit)))
+}
+
+fn require_definition_anchor() {
+    let anchored_definition_hash: u256 = 0x{{DEFINITION_HASH}};
+    let zero_hash: u256 = 0x0000000000000000000000000000000000000000000000000000000000000000;
+    assert!(not(jet::eq_256(anchored_definition_hash, zero_hash)));
+}
+
+fn main() {
+    require_definition_anchor();
+    jet::check_lock_height({{MIN_HEIGHT}});
+    let signer: Pubkey = 0x{{SIGNER_XONLY}};
+    jet::bip_0340_verify((signer, jet::sig_all_hash()), witness::SIGNER_SIGNATURE)
+}

package/dist/docs/definitions/bond-definition.json

@@ -0,0 +1,10 @@
+{
+  "bondId": "BOND-2026-001",
+  "issuer": "Hazbase Treasury",
+  "faceValue": 1000000,
+  "couponBps": 500,
+  "issueDate": "2026-03-10",
+  "maturityDate": 2344430,
+  "currencyAssetId": "bitcoin",
+  "controllerXonly": "79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798"
+}