@hazbase/simplicity 0.0.3 → 0.0.5

package/dist/cli.js

@@ -8,6 +8,7 @@ const promises_1 = require("node:fs/promises");
 const node_path_1 = __importDefault(require("node:path"));
 const artifact_1 = require("./core/artifact");
 const definition_1 = require("./core/definition");
+const state_1 = require("./core/state");
 const presets_1 = require("./core/presets");
 const errors_1 = require("./core/errors");
 const SimplicityClient_1 = require("./client/SimplicityClient");
@@ -85,6 +86,25 @@ function parseDefinitionInput() {
         anchorMode,
     };
 }
+function parseStateInput() {
+    const type = getArg("state-type");
+    const id = getArg("state-id");
+    const jsonPath = getArg("state-json");
+    const valueJson = getArg("state-value");
+    const schemaVersion = getArg("state-schema-version");
+    const anchorMode = getArg("state-anchor-mode");
+    if (!type && !id && !jsonPath && !valueJson && !schemaVersion && !anchorMode) {
+        return undefined;
+    }
+    return {
+        type: type ?? "",
+        id: id ?? "",
+        schemaVersion: schemaVersion ?? undefined,
+        jsonPath,
+        value: valueJson ? JSON.parse(valueJson) : undefined,
+        anchorMode,
+    };
+}
 function resolveConfig() {
     return {
         network: getArg("network", "liquidtestnet"),
@@ -389,6 +409,18 @@ function formatArtifactHelp(artifact, preset, utxos) {
             `  source verified: ${artifact.definition.onChainAnchor?.sourceVerified === true ? "yes" : "no"}`,
         ].join("\n")
         : "  (none)";
+    const state = artifact.state
+        ? [
+            `  type: ${artifact.state.stateType}`,
+            `  id: ${artifact.state.stateId}`,
+            `  schema version: ${artifact.state.schemaVersion}`,
+            `  hash: ${artifact.state.hash}`,
+            `  trust mode: ${artifact.state.trustMode}`,
+            `  anchor mode: ${artifact.state.anchorMode}`,
+            `  on-chain helper: ${artifact.state.onChainAnchor?.helper ?? "(none)"}`,
+            `  source verified: ${artifact.state.onChainAnchor?.sourceVerified === true ? "yes" : "no"}`,
+        ].join("\n")
+        : "  (none)";
     const compileSource = artifact.source.simfPath ?? artifact.legacy?.simfTemplatePath ?? "(unknown)";
     const templateVars = artifact.source.templateVars ?? {};
     const inspectCommand = `simplicity-cli contract inspect --artifact ./artifact.json --wallet simplicity-test --privkey <privkey-hex> --to-address tex1...`;
@@ -410,6 +442,9 @@ function formatArtifactHelp(artifact, preset, utxos) {
         "Definition Anchor:",
         definition,
         "",
+        "State Anchor:",
+        state,
+        "",
         "Suggested Commands:",
         `  ${inspectCommand}`,
         `  ${executeCommand}`,
@@ -451,7 +486,7 @@ async function main() {
     const subcommand = process.argv[3];
     const sdk = (0, SimplicityClient_1.createSimplicityClient)(resolveConfig());
     if (!command) {
-        throw new Error("Usage: simplicity-cli <compile|presets|preset|contract|artifact|definition|gasless> ...");
+        throw new Error("Usage: simplicity-cli <compile|presets|preset|contract|artifact|definition|state|bond|gasless> ...");
     }
     if (command === "compile") {
         const result = await sdk.compileFromFile({
@@ -459,6 +494,7 @@ async function main() {
             templateVars: parseAssignments(getMultiArgs("template-var")),
             artifactPath: getArg("artifact"),
             definition: parseDefinitionInput(),
+            state: parseStateInput(),
         });
         printJson({ artifact: result.artifact, deployment: result.deployment() });
         return;
@@ -497,6 +533,40 @@ async function main() {
         });
         return;
     }
+    if (command === "state" && subcommand === "show") {
+        const state = await (0, state_1.loadStateInput)({
+            type: requireArg("type"),
+            id: requireArg("id"),
+            jsonPath: getArg("json-path"),
+            value: getArg("value") ? JSON.parse(getArg("value")) : undefined,
+            schemaVersion: getArg("schema-version"),
+        });
+        printJson({
+            ...state,
+            anchorRecommendation: "Use --state-anchor-mode on-chain-constant-committed with a blessed custom .simf helper for on-chain enforcement",
+        });
+        return;
+    }
+    if (command === "state" && subcommand === "verify") {
+        const verification = await sdk.verifyStateAgainstArtifact({
+            artifactPath: requireArg("artifact"),
+            type: getArg("type"),
+            id: getArg("id"),
+            expectedType: getArg("expected-type"),
+            expectedId: getArg("expected-id"),
+            jsonPath: getArg("json-path"),
+            value: getArg("value") ? JSON.parse(getArg("value")) : undefined,
+            schemaVersion: getArg("schema-version"),
+        });
+        printJson({
+            verified: verification.ok,
+            reason: verification.reason,
+            state: verification.state,
+            artifactState: verification.artifactState ?? null,
+            trust: verification.trust,
+        });
+        return;
+    }
     if (command === "presets" && subcommand === "list") {
         printJson((0, presets_1.listPresets)().map((preset) => (0, presets_1.describePreset)(preset)));
         return;
@@ -543,6 +613,7 @@ async function main() {
             params,
             artifactPath: getArg("artifact"),
             definition: parseDefinitionInput(),
+            state: parseStateInput(),
         });
         printJson({ artifact: result.artifact, deployment: result.deployment() });
         return;
@@ -572,6 +643,322 @@ async function main() {
         });
         return;
     }
+    if (command === "bond" && subcommand === "define") {
+        const result = await sdk.bonds.defineBond({
+            definitionPath: getArg("definition-json"),
+            issuancePath: getArg("issuance-json"),
+            simfPath: getArg("simf"),
+            artifactPath: getArg("artifact"),
+        });
+        printJson({ artifact: result.artifact, deployment: result.deployment() });
+        return;
+    }
+    if (command === "bond" && subcommand === "verify") {
+        const result = await sdk.bonds.verifyBond({
+            artifactPath: requireArg("artifact"),
+            definitionPath: getArg("definition-json"),
+            issuancePath: getArg("issuance-json"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "redeem") {
+        const preview = await sdk.bonds.buildBondRedemption({
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            amount: Number(requireArg("amount")),
+            redeemedAt: requireArg("redeemed-at"),
+        });
+        const nextIssuanceOut = getArg("next-issuance-out");
+        if (nextIssuanceOut) {
+            const resolved = node_path_1.default.resolve(nextIssuanceOut);
+            await (0, promises_1.mkdir)(node_path_1.default.dirname(resolved), { recursive: true });
+            await (0, promises_1.writeFile)(`${resolved}`, `${JSON.stringify(preview.next, null, 2)}\n`, "utf8");
+        }
+        const result = await sdk.bonds.redeemBond({
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            amount: Number(requireArg("amount")),
+            redeemedAt: requireArg("redeemed-at"),
+            simfPath: getArg("simf"),
+            artifactPath: getArg("artifact"),
+        });
+        printJson({
+            artifact: result.artifact,
+            deployment: result.deployment(),
+            previousHash: preview.previousHash,
+            nextHash: preview.nextHash,
+            transition: preview.transition,
+            nextIssuanceState: preview.next,
+            nextIssuanceOut: nextIssuanceOut ? node_path_1.default.resolve(nextIssuanceOut) : undefined,
+        });
+        return;
+    }
+    if (command === "bond" && subcommand === "verify-transition") {
+        const result = await sdk.bonds.verifyBondTransition({
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "compile-transition") {
+        const result = await sdk.bonds.compileBondTransition({
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            simfPath: getArg("simf"),
+            artifactPath: getArg("artifact"),
+        });
+        printJson({
+            artifact: result.compiled.artifact,
+            deployment: result.compiled.deployment(),
+            previousHash: result.previousHash,
+            nextHash: result.nextHash,
+            transition: result.transition,
+            payload: result.payload,
+        });
+        return;
+    }
+    if (command === "bond" && subcommand === "compile-redemption-machine") {
+        const result = await sdk.bonds.compileBondRedemptionMachine({
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextStateSimfPath: getArg("next-state-simf"),
+            nextAmountSat: getArg("next-amount-sat") ? Number(getArg("next-amount-sat")) : undefined,
+            maxFeeSat: getArg("max-fee-sat") ? Number(getArg("max-fee-sat")) : undefined,
+            simfPath: getArg("simf"),
+            artifactPath: getArg("artifact"),
+        });
+        printJson({
+            artifact: result.compiled.artifact,
+            deployment: result.compiled.deployment(),
+            previousHash: result.previousHash,
+            nextHash: result.nextHash,
+            redeemAmount: result.redeemAmount,
+            transitionKind: result.transitionKind,
+            nextStateContractAddress: result.nextStateContractAddress,
+            nextStateContractAddressHash: result.nextStateContractAddressHash,
+            settlementDescriptor: result.settlementDescriptor,
+            settlementDescriptorHash: result.settlementDescriptorHash,
+            transition: result.transition,
+            payload: result.payload,
+        });
+        return;
+    }
+    if (command === "bond" && subcommand === "verify-machine") {
+        const result = await sdk.bonds.verifyBondRedemptionMachineArtifact({
+            artifactPath: requireArg("artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextStateSimfPath: getArg("next-state-simf"),
+            nextAmountSat: getArg("next-amount-sat") ? Number(getArg("next-amount-sat")) : undefined,
+            maxFeeSat: getArg("max-fee-sat") ? Number(getArg("max-fee-sat")) : undefined,
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "settlement-payload") {
+        const result = await sdk.bonds.buildBondSettlementPayload({
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextStateSimfPath: getArg("next-state-simf"),
+            nextAmountSat: Number(requireArg("next-amount-sat")),
+            maxFeeSat: getArg("max-fee-sat") ? Number(getArg("max-fee-sat")) : undefined,
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "verify-settlement") {
+        const result = await sdk.bonds.verifyBondSettlementDescriptor({
+            descriptorPath: getArg("descriptor-json"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextStateSimfPath: getArg("next-state-simf"),
+            nextAmountSat: getArg("next-amount-sat") ? Number(getArg("next-amount-sat")) : undefined,
+            maxFeeSat: getArg("max-fee-sat") ? Number(getArg("max-fee-sat")) : undefined,
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "plan-rollover") {
+        const result = await sdk.bonds.buildBondRolloverPlan({
+            currentArtifactPath: requireArg("current-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextSimfPath: getArg("next-simf"),
+            nextArtifactPath: getArg("next-artifact"),
+        });
+        printJson({
+            currentArtifact: result.currentArtifact,
+            nextArtifact: result.nextCompiled.artifact,
+            nextDeployment: result.nextCompiled.deployment(),
+            nextContractAddress: result.nextContractAddress,
+            transitionPayload: result.transitionPayload,
+        });
+        return;
+    }
+    if (command === "bond" && subcommand === "plan-machine-rollover") {
+        const result = await sdk.bonds.buildBondMachineRolloverPlan({
+            currentArtifactPath: requireArg("current-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextStateSimfPath: getArg("next-state-simf"),
+            machineSimfPath: getArg("machine-simf"),
+            machineArtifactPath: getArg("machine-artifact"),
+        });
+        printJson({
+            currentArtifact: result.currentArtifact,
+            machineArtifact: result.machineCompiled.compiled.artifact,
+            machineDeployment: result.machineCompiled.compiled.deployment(),
+            machineVerification: result.machineVerification,
+            nextContractAddress: result.nextContractAddress,
+            transitionPayload: result.transitionPayload,
+        });
+        return;
+    }
+    if (command === "bond" && subcommand === "inspect-rollover") {
+        const result = await sdk.bonds.inspectBondStateRollover({
+            currentArtifactPath: requireArg("current-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextSimfPath: getArg("next-simf"),
+            nextArtifactPath: getArg("next-artifact"),
+            wallet: requireArg("wallet"),
+            signer: { type: "schnorrPrivkeyHex", privkeyHex: requireArg("privkey") },
+            feeSat: getArg("fee-sat") ? Number(getArg("fee-sat")) : undefined,
+            utxoPolicy: getArg("utxo-policy"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "inspect-machine-rollover") {
+        const result = await sdk.bonds.inspectBondMachineRollover({
+            currentArtifactPath: requireArg("current-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            machineSimfPath: getArg("machine-simf"),
+            machineArtifactPath: getArg("machine-artifact"),
+            wallet: requireArg("wallet"),
+            signer: { type: "schnorrPrivkeyHex", privkeyHex: requireArg("privkey") },
+            feeSat: getArg("fee-sat") ? Number(getArg("fee-sat")) : undefined,
+            utxoPolicy: getArg("utxo-policy"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "execute-rollover") {
+        const result = await sdk.bonds.executeBondStateRollover({
+            currentArtifactPath: requireArg("current-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextSimfPath: getArg("next-simf"),
+            nextArtifactPath: getArg("next-artifact"),
+            wallet: requireArg("wallet"),
+            signer: { type: "schnorrPrivkeyHex", privkeyHex: requireArg("privkey") },
+            feeSat: getArg("fee-sat") ? Number(getArg("fee-sat")) : undefined,
+            utxoPolicy: getArg("utxo-policy"),
+            broadcast: hasFlag("broadcast"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "execute-machine-rollover") {
+        const result = await sdk.bonds.executeBondMachineRollover({
+            currentArtifactPath: requireArg("current-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            machineSimfPath: getArg("machine-simf"),
+            machineArtifactPath: getArg("machine-artifact"),
+            wallet: requireArg("wallet"),
+            signer: { type: "schnorrPrivkeyHex", privkeyHex: requireArg("privkey") },
+            feeSat: getArg("fee-sat") ? Number(getArg("fee-sat")) : undefined,
+            utxoPolicy: getArg("utxo-policy"),
+            broadcast: hasFlag("broadcast"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "plan-machine-settlement") {
+        const result = await sdk.bonds.buildBondMachineSettlementPlan({
+            currentMachineArtifactPath: requireArg("current-machine-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextSimfPath: getArg("next-simf"),
+            nextArtifactPath: getArg("next-artifact"),
+        });
+        printJson({
+            currentMachineArtifact: result.currentMachineArtifact,
+            machineVerification: result.machineVerification,
+            nextArtifact: result.nextCompiled.artifact,
+            nextDeployment: result.nextCompiled.deployment(),
+            nextContractAddress: result.nextContractAddress,
+            transitionPayload: result.transitionPayload,
+        });
+        return;
+    }
+    if (command === "bond" && subcommand === "inspect-machine-settlement") {
+        const result = await sdk.bonds.inspectBondMachineSettlement({
+            currentMachineArtifactPath: requireArg("current-machine-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextSimfPath: getArg("next-simf"),
+            nextArtifactPath: getArg("next-artifact"),
+            wallet: requireArg("wallet"),
+            signer: { type: "schnorrPrivkeyHex", privkeyHex: requireArg("privkey") },
+            feeSat: getArg("fee-sat") ? Number(getArg("fee-sat")) : undefined,
+            utxoPolicy: getArg("utxo-policy"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "execute-machine-settlement") {
+        const result = await sdk.bonds.executeBondMachineSettlement({
+            currentMachineArtifactPath: requireArg("current-machine-artifact"),
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+            nextSimfPath: getArg("next-simf"),
+            nextArtifactPath: getArg("next-artifact"),
+            wallet: requireArg("wallet"),
+            signer: { type: "schnorrPrivkeyHex", privkeyHex: requireArg("privkey") },
+            feeSat: getArg("fee-sat") ? Number(getArg("fee-sat")) : undefined,
+            utxoPolicy: getArg("utxo-policy"),
+            broadcast: hasFlag("broadcast"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "transition-payload") {
+        const result = await sdk.bonds.buildBondTransitionPayload({
+            definitionPath: getArg("definition-json"),
+            previousIssuancePath: getArg("previous-issuance-json"),
+            nextIssuancePath: getArg("next-issuance-json"),
+        });
+        printJson(result);
+        return;
+    }
+    if (command === "bond" && subcommand === "payload") {
+        const result = await sdk.bonds.buildBondPayload({
+            artifactPath: requireArg("artifact"),
+            definitionPath: getArg("definition-json"),
+            issuancePath: getArg("issuance-json"),
+        });
+        printJson(result);
+        return;
+    }
     if (command === "contract" && subcommand === "wait-funding") {
         const compiled = await sdk.loadArtifact(requireArg("artifact"));
         const utxos = await compiled.at().waitForFunding({

package/dist/client/ContractFactory.d.ts

@@ -1,4 +1,4 @@
-import { ArtifactDefinitionMetadata, DeploymentInfo, SimplicityArtifact, SimplicityClientConfig } from "../core/types";
+import { ArtifactDefinitionMetadata, ArtifactStateMetadata, DeploymentInfo, SimplicityArtifact, SimplicityClientConfig } from "../core/types";
 import { DeployedContract } from "./DeployedContract";
 export declare class CompiledContract {
     private readonly config;
@@ -8,6 +8,7 @@ export declare class CompiledContract {
     get cmr(): string;
     get program(): string;
     definition(): ArtifactDefinitionMetadata | null;
+    state(): ArtifactStateMetadata | null;
     deployment(): DeploymentInfo;
     saveArtifact(path: string): Promise<void>;
     at(addressOverride?: string): DeployedContract;

package/dist/client/ContractFactory.js

@@ -22,6 +22,9 @@ class CompiledContract {
     definition() {
         return this.artifact.definition ?? null;
     }
+    state() {
+        return this.artifact.state ?? null;
+    }
     deployment() {
         return {
             contractAddress: this.artifact.compiled.contractAddress,

package/dist/client/DeployedContract.d.ts

@@ -1,5 +1,6 @@
 import { verifyDefinitionAgainstArtifact } from "../core/definition";
-import { ArtifactDefinitionMetadata, ContractUtxo, ExecuteCallInput, ExecuteResult, GaslessExecuteInput, GaslessExecuteResult, InspectCallInput, InspectResult, SimplicityArtifact, SimplicityClientConfig, WaitForFundingInput } from "../core/types";
+import { verifyStateAgainstArtifact } from "../core/state";
+import { ArtifactDefinitionMetadata, ArtifactStateMetadata, ContractUtxo, ExecuteCallInput, ExecuteResult, GaslessExecuteInput, GaslessExecuteResult, InspectCallInput, InspectResult, SimplicityArtifact, SimplicityClientConfig, WaitForFundingInput } from "../core/types";
 export declare class DeployedContract {
     private readonly config;
     readonly artifact: SimplicityArtifact;
@@ -23,4 +24,17 @@ export declare class DeployedContract {
         reason?: string;
         trust: Awaited<ReturnType<typeof verifyDefinitionAgainstArtifact>>["trust"];
     }>;
+    getTrustedState(input: {
+        jsonPath?: string;
+        value?: unknown;
+        type?: string;
+        id?: string;
+        schemaVersion?: string;
+    }): Promise<{
+        verified: boolean;
+        state: Awaited<ReturnType<typeof verifyStateAgainstArtifact>>["state"];
+        artifactState: ArtifactStateMetadata | null;
+        reason?: string;
+        trust: Awaited<ReturnType<typeof verifyStateAgainstArtifact>>["trust"];
+    }>;
 }

package/dist/client/DeployedContract.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeployedContract = void 0;
 const executor_1 = require("../core/executor");
 const definition_1 = require("../core/definition");
+const state_1 = require("../core/state");
 const executor_2 = require("../core/executor");
 class DeployedContract {
     config;
@@ -61,5 +62,26 @@ class DeployedContract {
             trust: verification.trust,
         };
     }
+    async getTrustedState(input) {
+        const verification = await (0, state_1.verifyStateAgainstArtifact)({
+            artifact: this.artifact,
+            state: {
+                type: input.type ?? this.artifact.state?.stateType ?? "",
+                id: input.id ?? this.artifact.state?.stateId ?? "",
+                schemaVersion: input.schemaVersion,
+                jsonPath: input.jsonPath,
+                value: input.value,
+            },
+            expectedType: this.artifact.state?.stateType,
+            expectedId: this.artifact.state?.stateId,
+        });
+        return {
+            verified: verification.ok,
+            state: verification.state,
+            artifactState: verification.artifactState ?? null,
+            reason: verification.reason,
+            trust: verification.trust,
+        };
+    }
 }
 exports.DeployedContract = DeployedContract;