@hazbase/simplicity 0.0.4 → 0.0.5

package/dist/client/SimplicityClient.d.ts

@@ -1,10 +1,10 @@
 import { ElementsRpcClient } from "../core/rpc";
-import { BondDefinition, BondIssuanceState, DefinitionInput, DefinitionVerificationResult, CompileFromFileInput, CompileFromPresetInput, DefinitionDescriptor, StateDocumentDescriptor, StateDocumentInput, StateVerificationResult, SimplicityArtifact, SimplicityClientConfig } from "../core/types";
+import { BondDefinition, BondIssuanceState, BondSettlementDescriptor, DefinitionInput, DefinitionVerificationResult, CompileFromFileInput, CompileFromPresetInput, DefinitionDescriptor, StateDocumentDescriptor, StateDocumentInput, StateVerificationResult, SimplicityArtifact, SimplicityClientConfig } from "../core/types";
 import { RelayerClient } from "../gasless/RelayerClient";
 import { GaslessTransferInput, GaslessTransferResult, RelayerClientConfig } from "../gasless/types";
 import { CompiledContract } from "./ContractFactory";
 import { DeployedContract } from "./DeployedContract";
-import { loadBond, verifyBond } from "../domain/bond";
+import { buildBondPayload, buildBondRedemption, buildBondTransitionPayload, buildBondRolloverPlan, buildBondMachineRolloverPlan, buildBondMachineSettlementPlan, buildBondSettlementDescriptor, buildBondSettlementPayload, compileBondRedemptionMachine, compileBondTransition, executeBondStateRollover, executeBondMachineRollover, executeBondMachineSettlement, inspectBondStateRollover, inspectBondMachineRollover, inspectBondMachineSettlement, loadBond, redeemBond, verifyBond, verifyBondSettlementDescriptor, verifyBondRedemptionMachineArtifact, verifyBondTransition } from "../domain/bond";
 export declare class SimplicityClient {
     readonly config: SimplicityClientConfig;
     readonly rpc: ElementsRpcClient;
@@ -28,6 +28,271 @@ export declare class SimplicityClient {
             issuancePath?: string;
             issuanceValue?: BondIssuanceState;
         }) => ReturnType<typeof verifyBond>;
+        redeemBond: (input: {
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            amount: number;
+            redeemedAt: string;
+            simfPath?: string;
+            artifactPath?: string;
+        }) => ReturnType<typeof redeemBond>;
+        verifyBondTransition: (input: {
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+        }) => ReturnType<typeof verifyBondTransition>;
+        buildBondRedemption: (input: {
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            amount: number;
+            redeemedAt: string;
+        }) => ReturnType<typeof buildBondRedemption>;
+        buildBondPayload: (input: {
+            artifactPath?: string;
+            artifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            issuancePath?: string;
+            issuanceValue?: BondIssuanceState;
+        }) => ReturnType<typeof buildBondPayload>;
+        buildBondTransitionPayload: (input: {
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+        }) => ReturnType<typeof buildBondTransitionPayload>;
+        buildBondSettlementDescriptor: (input: {
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextStateSimfPath?: string;
+            nextAmountSat: number;
+            maxFeeSat?: number;
+        }) => ReturnType<typeof buildBondSettlementDescriptor>;
+        verifyBondSettlementDescriptor: (input: {
+            descriptorPath?: string;
+            descriptorValue?: BondSettlementDescriptor;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextStateSimfPath?: string;
+            nextAmountSat?: number;
+            maxFeeSat?: number;
+        }) => ReturnType<typeof verifyBondSettlementDescriptor>;
+        buildBondSettlementPayload: (input: {
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextStateSimfPath?: string;
+            nextAmountSat: number;
+            maxFeeSat?: number;
+        }) => ReturnType<typeof buildBondSettlementPayload>;
+        buildBondRolloverPlan: (input: {
+            currentArtifactPath?: string;
+            currentArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextSimfPath?: string;
+            nextArtifactPath?: string;
+        }) => ReturnType<typeof buildBondRolloverPlan>;
+        buildBondMachineRolloverPlan: (input: {
+            currentArtifactPath?: string;
+            currentArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextStateSimfPath?: string;
+            machineSimfPath?: string;
+            machineArtifactPath?: string;
+        }) => ReturnType<typeof buildBondMachineRolloverPlan>;
+        buildBondMachineSettlementPlan: (input: {
+            currentMachineArtifactPath?: string;
+            currentMachineArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextSimfPath?: string;
+            nextArtifactPath?: string;
+        }) => ReturnType<typeof buildBondMachineSettlementPlan>;
+        compileBondTransition: (input: {
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            simfPath?: string;
+            artifactPath?: string;
+        }) => ReturnType<typeof compileBondTransition>;
+        compileBondRedemptionMachine: (input: {
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextStateSimfPath?: string;
+            nextAmountSat?: number;
+            maxFeeSat?: number;
+            simfPath?: string;
+            artifactPath?: string;
+        }) => ReturnType<typeof compileBondRedemptionMachine>;
+        verifyBondRedemptionMachineArtifact: (input: {
+            artifactPath?: string;
+            artifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextStateSimfPath?: string;
+            nextAmountSat?: number;
+            maxFeeSat?: number;
+        }) => ReturnType<typeof verifyBondRedemptionMachineArtifact>;
+        inspectBondStateRollover: (input: {
+            currentArtifactPath?: string;
+            currentArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextSimfPath?: string;
+            nextArtifactPath?: string;
+            wallet: string;
+            signer: {
+                type: "schnorrPrivkeyHex";
+                privkeyHex: string;
+            };
+            feeSat?: number;
+            utxoPolicy?: "smallest_over" | "largest" | "newest";
+        }) => ReturnType<typeof inspectBondStateRollover>;
+        inspectBondMachineRollover: (input: {
+            currentArtifactPath?: string;
+            currentArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            machineSimfPath?: string;
+            machineArtifactPath?: string;
+            wallet: string;
+            signer: {
+                type: "schnorrPrivkeyHex";
+                privkeyHex: string;
+            };
+            feeSat?: number;
+            utxoPolicy?: "smallest_over" | "largest" | "newest";
+        }) => ReturnType<typeof inspectBondMachineRollover>;
+        inspectBondMachineSettlement: (input: {
+            currentMachineArtifactPath?: string;
+            currentMachineArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextSimfPath?: string;
+            nextArtifactPath?: string;
+            wallet: string;
+            signer: {
+                type: "schnorrPrivkeyHex";
+                privkeyHex: string;
+            };
+            feeSat?: number;
+            utxoPolicy?: "smallest_over" | "largest" | "newest";
+        }) => ReturnType<typeof inspectBondMachineSettlement>;
+        executeBondStateRollover: (input: {
+            currentArtifactPath?: string;
+            currentArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextSimfPath?: string;
+            nextArtifactPath?: string;
+            wallet: string;
+            signer: {
+                type: "schnorrPrivkeyHex";
+                privkeyHex: string;
+            };
+            feeSat?: number;
+            utxoPolicy?: "smallest_over" | "largest" | "newest";
+            broadcast?: boolean;
+        }) => ReturnType<typeof executeBondStateRollover>;
+        executeBondMachineRollover: (input: {
+            currentArtifactPath?: string;
+            currentArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            machineSimfPath?: string;
+            machineArtifactPath?: string;
+            wallet: string;
+            signer: {
+                type: "schnorrPrivkeyHex";
+                privkeyHex: string;
+            };
+            feeSat?: number;
+            utxoPolicy?: "smallest_over" | "largest" | "newest";
+            broadcast?: boolean;
+        }) => ReturnType<typeof executeBondMachineRollover>;
+        executeBondMachineSettlement: (input: {
+            currentMachineArtifactPath?: string;
+            currentMachineArtifact?: SimplicityArtifact;
+            definitionPath?: string;
+            definitionValue?: BondDefinition;
+            previousIssuancePath?: string;
+            previousIssuanceValue?: BondIssuanceState;
+            nextIssuancePath?: string;
+            nextIssuanceValue?: BondIssuanceState;
+            nextSimfPath?: string;
+            nextArtifactPath?: string;
+            wallet: string;
+            signer: {
+                type: "schnorrPrivkeyHex";
+                privkeyHex: string;
+            };
+            feeSat?: number;
+            utxoPolicy?: "smallest_over" | "largest" | "newest";
+            broadcast?: boolean;
+        }) => ReturnType<typeof executeBondMachineSettlement>;
         loadBond: (input: {
             artifactPath: string;
             definitionPath?: string;

package/dist/client/SimplicityClient.js

@@ -26,6 +26,26 @@ class SimplicityClient {
         this.bonds = {
             defineBond: async (input) => (0, bond_1.defineBond)(this, input),
             verifyBond: async (input) => (0, bond_1.verifyBond)(this, input),
+            redeemBond: async (input) => (0, bond_1.redeemBond)(this, input),
+            verifyBondTransition: async (input) => (0, bond_1.verifyBondTransition)(this, input),
+            buildBondRedemption: async (input) => (0, bond_1.buildBondRedemption)(this, input),
+            buildBondPayload: async (input) => (0, bond_1.buildBondPayload)(this, input),
+            buildBondTransitionPayload: async (input) => (0, bond_1.buildBondTransitionPayload)(this, input),
+            buildBondSettlementDescriptor: async (input) => (0, bond_1.buildBondSettlementDescriptor)(this, input),
+            verifyBondSettlementDescriptor: async (input) => (0, bond_1.verifyBondSettlementDescriptor)(this, input),
+            buildBondSettlementPayload: async (input) => (0, bond_1.buildBondSettlementPayload)(this, input),
+            buildBondRolloverPlan: async (input) => (0, bond_1.buildBondRolloverPlan)(this, input),
+            buildBondMachineRolloverPlan: async (input) => (0, bond_1.buildBondMachineRolloverPlan)(this, input),
+            buildBondMachineSettlementPlan: async (input) => (0, bond_1.buildBondMachineSettlementPlan)(this, input),
+            compileBondTransition: async (input) => (0, bond_1.compileBondTransition)(this, input),
+            compileBondRedemptionMachine: async (input) => (0, bond_1.compileBondRedemptionMachine)(this, input),
+            verifyBondRedemptionMachineArtifact: async (input) => (0, bond_1.verifyBondRedemptionMachineArtifact)(this, input),
+            inspectBondStateRollover: async (input) => (0, bond_1.inspectBondStateRollover)(this, input),
+            inspectBondMachineRollover: async (input) => (0, bond_1.inspectBondMachineRollover)(this, input),
+            inspectBondMachineSettlement: async (input) => (0, bond_1.inspectBondMachineSettlement)(this, input),
+            executeBondStateRollover: async (input) => (0, bond_1.executeBondStateRollover)(this, input),
+            executeBondMachineRollover: async (input) => (0, bond_1.executeBondMachineRollover)(this, input),
+            executeBondMachineSettlement: async (input) => (0, bond_1.executeBondMachineSettlement)(this, input),
             loadBond: async (input) => (0, bond_1.loadBond)(this, input),
         };
     }

package/dist/core/types.d.ts

@@ -153,6 +153,13 @@ export interface ArtifactStateMetadata {
         sourceVerified: boolean;
     };
 }
+export type BondIssuanceStatus = "ISSUED" | "PARTIALLY_REDEEMED" | "REDEEMED";
+export type BondTransitionType = "ISSUE" | "REDEEM";
+export interface BondStateTransition {
+    type: BondTransitionType;
+    amount: number;
+    at: string;
+}
 export interface DeploymentInfo {
     contractAddress: string;
     internalKey: string;
@@ -342,7 +349,33 @@ export interface BondIssuanceState {
     currencyAssetId: string;
     controllerXonly: string;
     issuedAt: string;
-    status: "ISSUED" | "REDEEMED";
+    status: BondIssuanceStatus;
+    previousStateHash?: string | null;
+    lastTransition?: BondStateTransition;
+}
+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;
+    principal: {
+        issued: number;
+        previousOutstanding: number;
+        nextOutstanding: number;
+        previousRedeemed: number;
+        nextRedeemed: number;
+    };
 }
 export interface WaitForFundingInput {
     minAmountSat?: number;