@stacks/clarinet-sdk 3.8.1

package/README.md

@@ -0,0 +1,91 @@
+# Clarinet SDK for Node.js
+
+The Clarinet SDK allows to interact with the simnet in Node.js.
+
+If you want to use the Clarinet SDK in web browsers, try [@stacks/clarinet-sdk-browser](https://www.npmjs.com/package/@stacks/clarinet-sdk-browser).
+
+Find the API references of the SDK in [our documentation](https://docs.stacks.co/reference/clarinet-js-sdk/overview).
+
+You can use this SDK to:
+
+- Interact with a clarinet project as you would with the Clarinet CLI
+- Call public, read-only, and private functions from smart contracts
+- Get clarity maps or data-var values
+- Get contract interfaces (available functions and data)
+- Write unit tests for Clarity smart contracts
+
+## Installation
+
+```sh
+npm install @stacks/clarinet-sdk
+```
+
+## Usage
+
+```ts
+import { initSimnet } from "@stacks/clarinet-sdk";
+import { Cl } from "@stacks/transactions";
+
+async function main() {
+  const simnet = await initSimnet();
+
+  const accounts = simnet.getAccounts();
+  const address1 = accounts.get("wallet_1");
+  if (!address1) throw new Error("invalid wallet name.");
+
+  const call = simnet.callPublicFn("counter", "add", [Cl.uint(1)], address1);
+  console.log(Cl.prettyPrint(call.result)); // (ok u1)
+
+  const counter = simnet.getDataVar("counter", "counter");
+  console.log(Cl.prettyPrint(counter)); // 2
+}
+
+main();
+```
+
+By default, the SDK will look for a Clarinet.toml file in the current working directory.
+It's also possible to provide the path to the manifest like so:
+
+```ts
+const simnet = await initSimnet("./path/to/Clarinet.toml");
+```
+
+## Tests
+
+The SDK can be used to write unit tests for Clarinet projects.
+
+You'll need to have Node.js (>= 18) and NPM setup. If you are not sure how to set it up, [Volta](https://volta.sh/) is a nice tool to get started.
+
+In the terminal, run `node --version` to make sure it's available and up to date.
+
+Open your terminal and go to a new or existing Clarinet project:
+
+```sh
+cd my-project
+ls # you should see Clarinet.toml and package.json in the list
+```
+
+Install the dependencies and run the test
+
+```sh
+npm install
+npm test
+```
+
+Visit the [clarity starter project](https://github.com/stx-labs/clarity-starter) to see the testing framework in action.
+
+### Type checking
+
+We recommend to use TypeScript to write the unit tests, but it's also possible to do it with JavaScript. To do so, rename your test files to `.test.js` instead of `.test.ts`. You can also delete the `tsconfig.json` and uninstall typescript with `npm uninstall typescript`.
+
+Note: If you want to write your test in JavaScript but still have a certain level of type safety and autocompletion, VSCode can help you with that. You can create a basic `jsconfig.json` file:
+
+```json
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "strict": true
+  },
+  "include": ["node_modules/@stacks/clarinet-sdk/vitest-helpers/src", "unit-tests"]
+}
+```

package/dist/cjs/common/src/sdkProxyHelpers.d.ts

@@ -0,0 +1,86 @@
+import { ClarityValue } from "@stacks/transactions";
+export type ClarityEvent = {
+    event: string;
+    data: {
+        raw_value?: string;
+        value?: ClarityValue;
+        [key: string]: any;
+    };
+};
+export type ExecutionCost = {
+    writeLength: number;
+    writeCount: number;
+    readLength: number;
+    readCount: number;
+    runtime: number;
+};
+export type ClarityCosts = {
+    total: ExecutionCost;
+    limit: ExecutionCost;
+    memory: number;
+    memory_limit: number;
+};
+export type ParsedTransactionResult = {
+    result: ClarityValue;
+    events: ClarityEvent[];
+    costs: ClarityCosts | null;
+    performance: string | undefined;
+};
+export type CallFn = (contract: string, method: string, args: ClarityValue[], sender: string) => ParsedTransactionResult;
+export type DeployContractOptions = {
+    clarityVersion: 1 | 2 | 3 | 4;
+};
+export type DeployContract = (name: string, content: string, options: DeployContractOptions | null, sender: string) => ParsedTransactionResult;
+export type TransferSTX = (amount: number | bigint, recipient: string, sender: string) => ParsedTransactionResult;
+export type Tx = {
+    callPublicFn: {
+        contract: string;
+        method: string;
+        args: ClarityValue[];
+        sender: string;
+    };
+    callPrivateFn?: never;
+    deployContract?: never;
+    transferSTX?: never;
+} | {
+    callPublicFn?: never;
+    callPrivateFn: {
+        contract: string;
+        method: string;
+        args: ClarityValue[];
+        sender: string;
+    };
+    deployContract?: never;
+    transferSTX?: never;
+} | {
+    callPublicFn?: never;
+    callPrivateFn?: never;
+    deployContract: {
+        name: string;
+        content: string;
+        options: DeployContractOptions | null;
+        sender: string;
+    };
+    transferSTX?: never;
+} | {
+    callPublicFn?: never;
+    callPrivateFn?: never;
+    deployContradct?: never;
+    transferSTX: {
+        amount: number;
+        recipient: string;
+        sender: string;
+    };
+};
+export declare const tx: {
+    callPublicFn: (contract: string, method: string, args: ClarityValue[], sender: string) => Tx;
+    callPrivateFn: (contract: string, method: string, args: ClarityValue[], sender: string) => Tx;
+    deployContract: (name: string, content: string, options: DeployContractOptions | null, sender: string) => Tx;
+    transferSTX: (amount: number, recipient: string, sender: string) => Tx;
+};
+export declare function parseEvents(events: string): ClarityEvent[];
+export declare function parseCosts(costs: string): ClarityCosts | null;
+export type MineBlock = (txs: Array<Tx>) => ParsedTransactionResult[];
+export type Execute = (snippet: string) => ParsedTransactionResult;
+export type GetDataVar = (contract: string, dataVar: string) => ClarityValue;
+export type GetMapEntry = (contract: string, mapName: string, mapKey: ClarityValue) => ClarityValue;

package/dist/cjs/common/src/sdkProxyHelpers.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tx = void 0;
+exports.parseEvents = parseEvents;
+exports.parseCosts = parseCosts;
+const transactions_1 = require("@stacks/transactions");
+exports.tx = {
+    callPublicFn: (contract, method, args, sender) => ({
+        callPublicFn: { contract, method, args, sender },
+    }),
+    callPrivateFn: (contract, method, args, sender) => ({
+        callPrivateFn: { contract, method, args, sender },
+    }),
+    deployContract: (name, content, options, sender) => ({
+        deployContract: { name, content, options, sender },
+    }),
+    transferSTX: (amount, recipient, sender) => ({
+        transferSTX: { amount, recipient, sender },
+    }),
+};
+function parseEvents(events) {
+    try {
+        // @todo: improve type safety
+        return JSON.parse(events).map((e) => {
+            const { event, data } = JSON.parse(e);
+            if ("raw_value" in data) {
+                data.value = transactions_1.Cl.deserialize(data.raw_value);
+            }
+            return {
+                event: event,
+                data: data,
+            };
+        });
+    }
+    catch (e) {
+        console.error(`Fail to parse events: ${e}`);
+        return [];
+    }
+}
+function parseCosts(costs) {
+    try {
+        let { memory, memory_limit, total, limit } = JSON.parse(costs);
+        return {
+            memory: memory,
+            memory_limit: memory_limit,
+            total: {
+                writeLength: total.write_length,
+                writeCount: total.write_count,
+                readLength: total.read_length,
+                readCount: total.read_count,
+                runtime: total.runtime,
+            },
+            limit: {
+                writeLength: limit.write_length,
+                writeCount: limit.write_count,
+                readLength: limit.read_length,
+                readCount: limit.read_count,
+                runtime: limit.runtime,
+            },
+        };
+    }
+    catch (_e) {
+        return null;
+    }
+}
+//# sourceMappingURL=sdkProxyHelpers.js.map

package/dist/cjs/common/src/sdkProxyHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkProxyHelpers.js","sourceRoot":"","sources":["../../../../../common/src/sdkProxyHelpers.ts"],"names":[],"mappings":";;;AAiHA,kCAiBC;AAED,gCAwBC;AA5JD,uDAAwD;AA6F3C,QAAA,EAAE,GAAG;IAChB,YAAY,EAAE,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAoB,EAAE,MAAc,EAAM,EAAE,CAAC,CAAC;QAC7F,YAAY,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;KACjD,CAAC;IACF,aAAa,EAAE,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAoB,EAAE,MAAc,EAAM,EAAE,CAAC,CAAC;QAC9F,aAAa,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;KAClD,CAAC;IACF,cAAc,EAAE,CACd,IAAY,EACZ,OAAe,EACf,OAAqC,EACrC,MAAc,EACV,EAAE,CAAC,CAAC;QACR,cAAc,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE;KACnD,CAAC;IACF,WAAW,EAAE,CAAC,MAAc,EAAE,SAAiB,EAAE,MAAc,EAAM,EAAE,CAAC,CAAC;QACvE,WAAW,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE;KAC3C,CAAC;CACH,CAAC;AAEF,SAAgB,WAAW,CAAC,MAAc;IACxC,IAAI,CAAC;QACH,6BAA6B;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE;YAC1C,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACtC,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,CAAC,KAAK,GAAG,iBAAE,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9C,CAAC;YACD,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC;QAC5C,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,SAAgB,UAAU,CAAC,KAAa;IACtC,IAAI,CAAC;QACH,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/D,OAAO;YACL,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,KAAK,EAAE;gBACL,WAAW,EAAE,KAAK,CAAC,YAAY;gBAC/B,UAAU,EAAE,KAAK,CAAC,WAAW;gBAC7B,UAAU,EAAE,KAAK,CAAC,WAAW;gBAC7B,SAAS,EAAE,KAAK,CAAC,UAAU;gBAC3B,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB;YACD,KAAK,EAAE;gBACL,WAAW,EAAE,KAAK,CAAC,YAAY;gBAC/B,UAAU,EAAE,KAAK,CAAC,WAAW;gBAC7B,UAAU,EAAE,KAAK,CAAC,WAAW;gBAC7B,SAAS,EAAE,KAAK,CAAC,UAAU;gBAC3B,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,EAAE,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/cjs/node/src/index.d.ts

@@ -0,0 +1,15 @@
+export { tx, type ClarityEvent, type ParsedTransactionResult, type DeployContractOptions, type Tx, type TransferSTX, } from "../../common/src/sdkProxyHelpers.js";
+import { Simnet } from "./sdkProxy.js";
+export { type Simnet } from "./sdkProxy.js";
+type Options = {
+    trackCosts: boolean;
+    trackCoverage: boolean;
+    trackPerformance?: boolean;
+};
+export declare function getSDK(options?: Options): Promise<Simnet>;
+export declare const initSimnet: (manifestPath?: string, noCache?: boolean, options?: {
+    trackCosts: boolean;
+    trackCoverage: boolean;
+    trackPerformance?: boolean;
+    performanceCostField?: string;
+}) => Promise<Simnet>;

package/dist/cjs/node/src/index.js

@@ -0,0 +1,68 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initSimnet = exports.tx = void 0;
+exports.getSDK = getSDK;
+const clarinet_sdk_wasm_1 = require("@stacks/clarinet-sdk-wasm");
+var sdkProxyHelpers_js_1 = require("../../common/src/sdkProxyHelpers.js");
+Object.defineProperty(exports, "tx", { enumerable: true, get: function () { return sdkProxyHelpers_js_1.tx; } });
+const vfs_js_1 = require("./vfs.js");
+const sdkProxy_js_1 = require("./sdkProxy.js");
+const wasmModule = Promise.resolve().then(() => __importStar(require("@stacks/clarinet-sdk-wasm")));
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json
+// @ts-ignore
+BigInt.prototype.toJSON = function () {
+    return this.toString();
+};
+async function getSDK(options) {
+    const module = await wasmModule;
+    let sdkOptions = new clarinet_sdk_wasm_1.SDKOptions(!!options?.trackCosts, !!options?.trackCoverage, !!options?.trackPerformance);
+    const simnet = new Proxy(new module.SDK(vfs_js_1.vfs, sdkOptions), (0, sdkProxy_js_1.getSessionProxy)());
+    return simnet;
+}
+// load wasm only once and memoize it
+function memoizedInit() {
+    let simnet = null;
+    return async (manifestPath = "./Clarinet.toml", noCache = false, options) => {
+        if (noCache || !simnet) {
+            simnet = await getSDK(options);
+        }
+        // start a new simnet session
+        await simnet.initSession(process.cwd(), manifestPath);
+        return simnet;
+    };
+}
+exports.initSimnet = memoizedInit();
+//# sourceMappingURL=index.js.map

package/dist/cjs/node/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,wBAUC;AAxCD,iEAAuD;AAEvD,0EAO6C;AAN3C,wGAAA,EAAE,OAAA;AAQJ,qCAA+B;AAC/B,+CAAwD;AAIxD,MAAM,UAAU,qDAAU,2BAA2B,GAAC,CAAC;AAEvD,0GAA0G;AAC1G,aAAa;AACb,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG;IACxB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;AACzB,CAAC,CAAC;AAQK,KAAK,UAAU,MAAM,CAAC,OAAiB;IAC5C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;IAChC,IAAI,UAAU,GAAG,IAAI,8BAAU,CAC7B,CAAC,CAAC,OAAO,EAAE,UAAU,EACrB,CAAC,CAAC,OAAO,EAAE,aAAa,EACxB,CAAC,CAAC,OAAO,EAAE,gBAAgB,CAC5B,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,YAAG,EAAE,UAAU,CAAC,EAAE,IAAA,6BAAe,GAAE,CAAsB,CAAC;IAClG,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,qCAAqC;AACrC,SAAS,YAAY;IACnB,IAAI,MAAM,GAAkB,IAAI,CAAC;IAEjC,OAAO,KAAK,EACV,YAAY,GAAG,iBAAiB,EAChC,OAAO,GAAG,KAAK,EACf,OAKC,EACD,EAAE;QACF,IAAI,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;QAED,6BAA6B;QAC7B,MAAM,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAEY,QAAA,UAAU,GAAG,YAAY,EAAE,CAAC"}

package/dist/cjs/node/src/sdkProxy.d.ts

@@ -0,0 +1,11 @@
+import { type SDK } from "@stacks/clarinet-sdk-wasm";
+import { type CallFn, type DeployContract, type GetDataVar, type GetMapEntry, type MineBlock, type Execute, type TransferSTX } from "../../common/src/sdkProxyHelpers.js";
+/** @deprecated use `simnet.execute(command)` instead */
+type RunSnippet = SDK["runSnippet"];
+export type Simnet = {
+    [K in keyof SDK]: K extends "callReadOnlyFn" | "callPublicFn" | "callPrivateFn" ? CallFn : K extends "execute" ? Execute : K extends "runSnippet" ? RunSnippet : K extends "deployContract" ? DeployContract : K extends "transferSTX" ? TransferSTX : K extends "mineBlock" ? MineBlock : K extends "getDataVar" ? GetDataVar : K extends "getMapEntry" ? GetMapEntry : SDK[K];
+};
+export declare function getSessionProxy(): {
+    get(session: SDK, prop: keyof SDK, receiver: any): string | number | CallFn | DeployContract | TransferSTX | MineBlock | GetMapEntry | ((cwd: string, manifest_path: string) => Promise<void>) | ((epoch: import("@stacks/clarinet-sdk-wasm").EpochString) => void) | ((count?: number | null) => number) | ((addresses: string[]) => void) | ((recipient: string, amount: bigint) => string) | ((include_boot_contracts: boolean, boot_contracts_path: string) => import("@stacks/clarinet-sdk-wasm").SessionReport);
+};
+export {};

package/dist/cjs/node/src/sdkProxy.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSessionProxy = getSessionProxy;
+const transactions_1 = require("@stacks/transactions");
+const clarinet_sdk_wasm_1 = require("@stacks/clarinet-sdk-wasm");
+const sdkProxyHelpers_js_1 = require("../../common/src/sdkProxyHelpers.js");
+function parseTxResponse(response) {
+    return {
+        result: transactions_1.Cl.deserialize(response.result),
+        events: (0, sdkProxyHelpers_js_1.parseEvents)(response.events),
+        costs: (0, sdkProxyHelpers_js_1.parseCosts)(response.costs),
+        performance: response.performance,
+    };
+}
+function getSessionProxy() {
+    return {
+        get(session, prop, receiver) {
+            // some of the WASM methods are proxied here to:
+            // - serialize clarity values input argument
+            // - deserialize output into clarity values
+            if (prop === "callReadOnlyFn" || prop === "callPublicFn" || prop === "callPrivateFn") {
+                const callFn = (contract, method, args, sender) => {
+                    const response = session[prop](new clarinet_sdk_wasm_1.CallFnArgs(contract, method, args.map(transactions_1.serializeCVBytes), sender));
+                    return parseTxResponse(response);
+                };
+                return callFn;
+            }
+            if (prop === "execute") {
+                const execute = (snippet) => {
+                    const response = session.execute(snippet);
+                    return parseTxResponse(response);
+                };
+                return execute;
+            }
+            if (prop === "deployContract") {
+                const callDeployContract = (name, content, options, sender) => {
+                    const rustOptions = options
+                        ? new clarinet_sdk_wasm_1.ContractOptions(options.clarityVersion)
+                        : new clarinet_sdk_wasm_1.ContractOptions();
+                    const response = session.deployContract(new clarinet_sdk_wasm_1.DeployContractArgs(name, content, rustOptions, sender));
+                    return parseTxResponse(response);
+                };
+                return callDeployContract;
+            }
+            if (prop === "transferSTX") {
+                const callTransferSTX = (amount, ...args) => {
+                    const response = session.transferSTX(new clarinet_sdk_wasm_1.TransferSTXArgs(BigInt(amount), ...args));
+                    return parseTxResponse(response);
+                };
+                return callTransferSTX;
+            }
+            if (prop === "mineBlock") {
+                const callMineBlock = (txs) => {
+                    const serializedTxs = txs.map((tx) => {
+                        if (tx.callPublicFn) {
+                            return {
+                                callPublicFn: {
+                                    ...tx.callPublicFn,
+                                    args_maps: tx.callPublicFn.args.map(transactions_1.serializeCVBytes),
+                                },
+                            };
+                        }
+                        if (tx.callPrivateFn) {
+                            return {
+                                callPrivateFn: {
+                                    ...tx.callPrivateFn,
+                                    args_maps: tx.callPrivateFn.args.map(transactions_1.serializeCVBytes),
+                                },
+                            };
+                        }
+                        return tx;
+                    });
+                    const responses = session.mineBlock(serializedTxs);
+                    return responses.map(parseTxResponse);
+                };
+                return callMineBlock;
+            }
+            if (prop === "getDataVar") {
+                const getDataVar = (...args) => {
+                    const response = session.getDataVar(...args);
+                    const result = transactions_1.Cl.deserialize(response);
+                    return result;
+                };
+                return getDataVar;
+            }
+            if (prop === "getMapEntry") {
+                const getMapEntry = (contract, mapName, mapKey) => {
+                    const response = session.getMapEntry(contract, mapName, (0, transactions_1.serializeCVBytes)(mapKey));
+                    const result = transactions_1.Cl.deserialize(response);
+                    return result;
+                };
+                return getMapEntry;
+            }
+            return Reflect.get(session, prop, receiver);
+        },
+    };
+}
+//# sourceMappingURL=sdkProxy.js.map

package/dist/cjs/node/src/sdkProxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkProxy.js","sourceRoot":"","sources":["../../../../src/sdkProxy.ts"],"names":[],"mappings":";;AAwDA,0CAgGC;AAxJD,uDAA4D;AAC5D,iEAOmC;AAEnC,4EAW6C;AA0B7C,SAAS,eAAe,CAAC,QAAwB;IAC/C,OAAO;QACL,MAAM,EAAE,iBAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC;QACvC,MAAM,EAAE,IAAA,gCAAW,EAAC,QAAQ,CAAC,MAAM,CAAC;QACpC,KAAK,EAAE,IAAA,+BAAU,EAAC,QAAQ,CAAC,KAAK,CAAC;QACjC,WAAW,EAAE,QAAQ,CAAC,WAAW;KAClC,CAAC;AACJ,CAAC;AAED,SAAgB,eAAe;IAC7B,OAAO;QACL,GAAG,CAAC,OAAY,EAAE,IAAe,EAAE,QAAa;YAC9C,gDAAgD;YAChD,4CAA4C;YAC5C,2CAA2C;YAE3C,IAAI,IAAI,KAAK,gBAAgB,IAAI,IAAI,KAAK,cAAc,IAAI,IAAI,KAAK,eAAe,EAAE,CAAC;gBACrF,MAAM,MAAM,GAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;oBACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAC5B,IAAI,8BAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,+BAAgB,CAAC,EAAE,MAAM,CAAC,CACrE,CAAC;oBACF,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC;gBACnC,CAAC,CAAC;gBACF,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,OAAO,GAAY,CAAC,OAAO,EAAE,EAAE;oBACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;oBAC1C,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC;gBACnC,CAAC,CAAC;gBACF,OAAO,OAAO,CAAC;YACjB,CAAC;YAED,IAAI,IAAI,KAAK,gBAAgB,EAAE,CAAC;gBAC9B,MAAM,kBAAkB,GAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC5E,MAAM,WAAW,GAAG,OAAO;wBACzB,CAAC,CAAC,IAAI,mCAAe,CAAC,OAAO,CAAC,cAAc,CAAC;wBAC7C,CAAC,CAAC,IAAI,mCAAe,EAAE,CAAC;oBAE1B,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CACrC,IAAI,sCAAkB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,CAC3D,CAAC;oBACF,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC;gBACnC,CAAC,CAAC;gBACF,OAAO,kBAAkB,CAAC;YAC5B,CAAC;YAED,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;gBAC3B,MAAM,eAAe,GAAgB,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE;oBACvD,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,mCAAe,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;oBACnF,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC;gBACnC,CAAC,CAAC;gBACF,OAAO,eAAe,CAAC;YACzB,CAAC;YAED,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;gBACzB,MAAM,aAAa,GAAc,CAAC,GAAG,EAAE,EAAE;oBACvC,MAAM,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;wBACnC,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC;4BACpB,OAAO;gCACL,YAAY,EAAE;oCACZ,GAAG,EAAE,CAAC,YAAY;oCAClB,SAAS,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,+BAAgB,CAAC;iCACtD;6BACF,CAAC;wBACJ,CAAC;wBACD,IAAI,EAAE,CAAC,aAAa,EAAE,CAAC;4BACrB,OAAO;gCACL,aAAa,EAAE;oCACb,GAAG,EAAE,CAAC,aAAa;oCACnB,SAAS,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,+BAAgB,CAAC;iCACvD;6BACF,CAAC;wBACJ,CAAC;wBACD,OAAO,EAAE,CAAC;oBACZ,CAAC,CAAC,CAAC;oBAEH,MAAM,SAAS,GAAqB,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;oBACrE,OAAO,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBACxC,CAAC,CAAC;gBACF,OAAO,aAAa,CAAC;YACvB,CAAC;YAED,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;gBAC1B,MAAM,UAAU,GAAe,CAAC,GAAG,IAAI,EAAE,EAAE;oBACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;oBAC7C,MAAM,MAAM,GAAG,iBAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;oBACxC,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC;gBACF,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;gBAC3B,MAAM,WAAW,GAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC7D,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAA,+BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC;oBAClF,MAAM,MAAM,GAAG,iBAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;oBACxC,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC;gBACF,OAAO,WAAW,CAAC;YACrB,CAAC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC9C,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/cjs/node/src/vfs.d.ts

@@ -0,0 +1,3 @@
+export declare function vfs(action: string, data: unknown): Promise<boolean> | Promise<string> | Promise<{
+    [k: string]: string;
+}> | Promise<void>;

package/dist/cjs/node/src/vfs.js

@@ -0,0 +1,109 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.vfs = vfs;
+const fs = __importStar(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+function fileArrayToString(bufferArray) {
+    return Array.from(bufferArray)
+        .map((item) => String.fromCharCode(item))
+        .join("");
+}
+function isValidReadEvent(e) {
+    return typeof e?.path === "string";
+}
+function isValidReadManyEvent(e) {
+    return Array.isArray(e?.paths) && e.paths.every((s) => typeof s === "string");
+}
+function isValidWriteEvent(e) {
+    return typeof e?.path === "string" && Array.isArray(e?.content);
+}
+async function exists(event) {
+    if (!isValidReadEvent(event))
+        throw new Error("invalid read event");
+    try {
+        await fs.stat(event.path);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+async function readFile(event) {
+    if (!isValidReadEvent(event))
+        throw new Error("invalid read event");
+    return fileArrayToString(await fs.readFile(event.path));
+}
+async function readFiles(event) {
+    if (!isValidReadManyEvent(event))
+        throw new Error("invalid read event");
+    const files = await Promise.all(event.paths.map(async (p) => {
+        try {
+            return fs.readFile(p);
+        }
+        catch (err) {
+            console.warn(err);
+            return null;
+        }
+    }));
+    return Object.fromEntries(files.reduce((acc, f, i) => {
+        if (f === null)
+            return acc;
+        return acc.concat([[event.paths[i], fileArrayToString(f)]]);
+    }, []));
+}
+async function writeFile(event) {
+    if (!isValidWriteEvent(event))
+        throw new Error("invalid write event");
+    const dir = node_path_1.default.dirname(event.path);
+    if (dir !== ".")
+        await fs.mkdir(dir, { recursive: true });
+    return fs.writeFile(event.path, Uint8Array.from(event.content));
+}
+function vfs(action, data) {
+    if (action === "vfs/exists")
+        return exists(data);
+    if (action === "vfs/readFile")
+        return readFile(data);
+    if (action === "vfs/readFiles")
+        return readFiles(data);
+    if (action === "vfs/writeFile")
+        return writeFile(data);
+    throw new Error("invalid vfs action");
+}
+//# sourceMappingURL=vfs.js.map

package/dist/cjs/node/src/vfs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vfs.js","sourceRoot":"","sources":["../../../../src/vfs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkEA,kBAMC;AAxED,qDAAuC;AACvC,0DAA6B;AAE7B,SAAS,iBAAiB,CAAC,WAAuB;IAChD,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC;SAC3B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;SACxC,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAM;IAC9B,OAAO,OAAO,CAAC,EAAE,IAAI,KAAK,QAAQ,CAAC;AACrC,CAAC;AAED,SAAS,oBAAoB,CAAC,CAAM;IAClC,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;AACzF,CAAC;AAED,SAAS,iBAAiB,CAAC,CAAM;IAC/B,OAAO,OAAO,CAAC,EAAE,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,KAAc;IAClC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACpE,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,KAAc;IACpC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACpE,OAAO,iBAAiB,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,KAAU;IACjC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC1B,IAAI,CAAC;YACH,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACxB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClB,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CACH,CAAC;IACF,OAAO,MAAM,CAAC,WAAW,CACvB,KAAK,CAAC,MAAM,CACV,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;QACZ,IAAI,CAAC,KAAK,IAAI;YAAE,OAAO,GAAG,CAAC;QAC3B,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC,EACD,EAAwB,CACzB,CACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,KAAc;IACrC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACtE,MAAM,GAAG,GAAG,mBAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,GAAG,KAAK,GAAG;QAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,SAAgB,GAAG,CAAC,MAAc,EAAE,IAAa;IAC/C,IAAI,MAAM,KAAK,YAAY;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACjD,IAAI,MAAM,KAAK,cAAc;QAAE,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;IACrD,IAAI,MAAM,KAAK,eAAe;QAAE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;IACvD,IAAI,MAAM,KAAK,eAAe;QAAE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;AACxC,CAAC"}

package/dist/cjs/node/tsconfig.cjs.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../../../src/index.ts","../../../src/sdkproxy.ts","../../../src/vfs.ts","../../../../common/src/sdkproxyhelpers.ts"],"version":"5.9.2"}

package/dist/esm/common/src/sdkProxyHelpers.d.ts

@@ -0,0 +1,86 @@
+import { ClarityValue } from "@stacks/transactions";
+export type ClarityEvent = {
+    event: string;
+    data: {
+        raw_value?: string;
+        value?: ClarityValue;
+        [key: string]: any;
+    };
+};
+export type ExecutionCost = {
+    writeLength: number;
+    writeCount: number;
+    readLength: number;
+    readCount: number;
+    runtime: number;
+};
+export type ClarityCosts = {
+    total: ExecutionCost;
+    limit: ExecutionCost;
+    memory: number;
+    memory_limit: number;
+};
+export type ParsedTransactionResult = {
+    result: ClarityValue;
+    events: ClarityEvent[];
+    costs: ClarityCosts | null;
+    performance: string | undefined;
+};
+export type CallFn = (contract: string, method: string, args: ClarityValue[], sender: string) => ParsedTransactionResult;
+export type DeployContractOptions = {
+    clarityVersion: 1 | 2 | 3 | 4;
+};
+export type DeployContract = (name: string, content: string, options: DeployContractOptions | null, sender: string) => ParsedTransactionResult;
+export type TransferSTX = (amount: number | bigint, recipient: string, sender: string) => ParsedTransactionResult;
+export type Tx = {
+    callPublicFn: {
+        contract: string;
+        method: string;
+        args: ClarityValue[];
+        sender: string;
+    };
+    callPrivateFn?: never;
+    deployContract?: never;
+    transferSTX?: never;
+} | {
+    callPublicFn?: never;
+    callPrivateFn: {
+        contract: string;
+        method: string;
+        args: ClarityValue[];
+        sender: string;
+    };
+    deployContract?: never;
+    transferSTX?: never;
+} | {
+    callPublicFn?: never;
+    callPrivateFn?: never;
+    deployContract: {
+        name: string;
+        content: string;
+        options: DeployContractOptions | null;
+        sender: string;
+    };
+    transferSTX?: never;
+} | {
+    callPublicFn?: never;
+    callPrivateFn?: never;
+    deployContradct?: never;
+    transferSTX: {
+        amount: number;
+        recipient: string;
+        sender: string;
+    };
+};
+export declare const tx: {
+    callPublicFn: (contract: string, method: string, args: ClarityValue[], sender: string) => Tx;
+    callPrivateFn: (contract: string, method: string, args: ClarityValue[], sender: string) => Tx;
+    deployContract: (name: string, content: string, options: DeployContractOptions | null, sender: string) => Tx;
+    transferSTX: (amount: number, recipient: string, sender: string) => Tx;
+};
+export declare function parseEvents(events: string): ClarityEvent[];
+export declare function parseCosts(costs: string): ClarityCosts | null;
+export type MineBlock = (txs: Array<Tx>) => ParsedTransactionResult[];
+export type Execute = (snippet: string) => ParsedTransactionResult;
+export type GetDataVar = (contract: string, dataVar: string) => ClarityValue;
+export type GetMapEntry = (contract: string, mapName: string, mapKey: ClarityValue) => ClarityValue;