@stacks/clarinet-sdk-browser 3.8.1

package/README.md

@@ -0,0 +1,41 @@
+# Clarinet SDK for the Web
+
+The Clarinet SDK can be used to interact with the simnet from web browsers.
+
+If you want to use the Clarinet SDK in Node.js, try [@stacks/clarinet-sdk](https://www.npmjs.com/package/@stacks/clarinet-sdk).
+
+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-browser
+```
+
+### Usage
+
+There are two ways to use the sdk in the browser:
+
+- With an empty clarinet session:
+
+```js
+const simnet = await initSimnet();
+await simnet.initEmptySession();
+simnet.runSnippet("(+ 1 2)");
+```
+
+- With a clarinet project (ie: with a Clarinet.toml)
+  💡 It requires to use a virtual file system. More documentation and examples soon.
+
+```js
+const simnet = await initSimnet();
+await simnet.initSession("/project", "Clarinet.toml");
+```

package/dist/esm/browser/src/defaultVfs.d.ts

@@ -0,0 +1,4 @@
+export declare const defaultFileStore: Map<string, string>;
+export declare function defaultVfs(action: string, data: unknown): string | boolean | Map<string, string> | {
+    [k: string]: string;
+} | null;

package/dist/esm/browser/src/defaultVfs.js

@@ -0,0 +1,63 @@
+export const defaultFileStore = new Map();
+// @ts-ignore
+globalThis.fsStore = defaultFileStore;
+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) || e?.content instanceof Uint8Array));
+}
+function exists(event) {
+    if (!isValidReadEvent(event))
+        throw new Error("invalid read event");
+    return defaultFileStore.has(event.path);
+}
+function readFile(event) {
+    if (!isValidReadEvent(event))
+        throw new Error("invalid read event");
+    const content = defaultFileStore.get(event.path) ?? null;
+    return content;
+}
+function readFiles(event) {
+    if (!isValidReadManyEvent(event))
+        throw new Error("invalid read event");
+    const files = event.paths.map((p) => {
+        try {
+            return defaultFileStore.get(p);
+        }
+        catch (err) {
+            console.warn(err);
+            return null;
+        }
+    });
+    return Object.fromEntries(files.reduce((acc, f, i) => {
+        if (f === null || f === undefined)
+            return acc;
+        return acc.concat([[event.paths[i], f]]);
+    }, []));
+}
+function writeFile(event) {
+    if (!isValidWriteEvent(event))
+        throw new Error("invalid write event");
+    return defaultFileStore.set(event.path, fileArrayToString(Uint8Array.from(event.content)));
+}
+export function defaultVfs(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=defaultVfs.js.map

package/dist/esm/browser/src/defaultVfs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultVfs.js","sourceRoot":"","sources":["../../../../src/defaultVfs.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAC;AAE1D,aAAa;AACb,UAAU,CAAC,OAAO,GAAG,gBAAgB,CAAC;AAEtC,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,CACL,OAAO,CAAC,EAAE,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,YAAY,UAAU,CAAC,CAC/F,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,KAAc;IAC5B,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACpE,OAAO,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IACzD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,SAAS,CAAC,KAAU;IAC3B,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAClC,IAAI,CAAC;YACH,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClB,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,WAAW,CACvB,KAAK,CAAC,MAAM,CACV,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;QACZ,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS;YAAE,OAAO,GAAG,CAAC;QAC9C,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC,EACD,EAAwB,CACzB,CACF,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACtE,OAAO,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC7F,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,IAAa;IACtD,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/esm/browser/src/index.d.ts

@@ -0,0 +1,6 @@
+import init, { SDK } from "@stacks/clarinet-sdk-wasm-browser";
+import { Simnet, getSessionProxy } from "./sdkProxy.js";
+export { tx, type ClarityEvent, type ParsedTransactionResult, type DeployContractOptions, type Tx, type TransferSTX, } from "../../common/src/sdkProxyHelpers.js";
+export { init, SDK, getSessionProxy, type Simnet };
+export { defaultVfs, defaultFileStore } from "./defaultVfs.js";
+export declare const initSimnet: (virtualFileSystem?: Function) => Promise<Simnet>;

package/dist/esm/browser/src/index.js

@@ -0,0 +1,19 @@
+import init, { SDK } from "@stacks/clarinet-sdk-wasm-browser";
+import { getSessionProxy } from "./sdkProxy.js";
+import { defaultVfs } from "./defaultVfs.js";
+// 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();
+};
+export { tx, } from "../../common/src/sdkProxyHelpers.js";
+export { init, SDK, getSessionProxy };
+export { defaultVfs, defaultFileStore } from "./defaultVfs.js";
+// @ts-ignore
+globalThis.vfs = defaultVfs;
+export const initSimnet = async (virtualFileSystem) => {
+    await init();
+    const vfs = virtualFileSystem ? virtualFileSystem : defaultVfs;
+    return new Proxy(new SDK(vfs), getSessionProxy());
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/browser/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,EAAE,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAE9D,OAAO,EAAU,eAAe,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,0GAA0G;AAC1G,aAAa;AACb,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG;IACxB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;AACzB,CAAC,CAAC;AAEF,OAAO,EACL,EAAE,GAMH,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,eAAe,EAAe,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAE/D,aAAa;AACb,UAAU,CAAC,GAAG,GAAG,UAAU,CAAC;AAE5B,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,iBAA4B,EAAE,EAAE;IAC/D,MAAM,IAAI,EAAE,CAAC;IACb,MAAM,GAAG,GAAG,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,UAAU,CAAC;IAC/D,OAAO,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,EAAE,eAAe,EAAE,CAAsB,CAAC;AACzE,CAAC,CAAC"}

package/dist/esm/browser/src/sdkProxy.d.ts

@@ -0,0 +1,11 @@
+import { type SDK } from "@stacks/clarinet-sdk-wasm-browser";
+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-browser").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-browser").SessionReport);
+};
+export {};

package/dist/esm/browser/src/sdkProxy.js

@@ -0,0 +1,95 @@
+import { Cl, serializeCVBytes } from "@stacks/transactions";
+import { CallFnArgs, DeployContractArgs, TransferSTXArgs, ContractOptions, } from "@stacks/clarinet-sdk-wasm-browser";
+import { parseEvents, parseCosts, } from "../../common/src/sdkProxyHelpers.js";
+function parseTxResponse(response) {
+    return {
+        result: Cl.deserialize(response.result),
+        events: parseEvents(response.events),
+        costs: parseCosts(response.costs),
+        performance: response.performance,
+    };
+}
+export 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 CallFnArgs(contract, method, args.map(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 ContractOptions(options.clarityVersion)
+                        : new ContractOptions();
+                    const response = session.deployContract(new DeployContractArgs(name, content, rustOptions, sender));
+                    return parseTxResponse(response);
+                };
+                return callDeployContract;
+            }
+            if (prop === "transferSTX") {
+                const callTransferSTX = (amount, ...args) => {
+                    const response = session.transferSTX(new 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(serializeCVBytes),
+                                },
+                            };
+                        }
+                        if (tx.callPrivateFn) {
+                            return {
+                                callPrivateFn: {
+                                    ...tx.callPrivateFn,
+                                    args_maps: tx.callPrivateFn.args.map(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 = Cl.deserialize(response);
+                    return result;
+                };
+                return getDataVar;
+            }
+            if (prop === "getMapEntry") {
+                const getMapEntry = (contract, mapName, mapKey) => {
+                    const response = session.getMapEntry(contract, mapName, serializeCVBytes(mapKey));
+                    const result = Cl.deserialize(response);
+                    return result;
+                };
+                return getMapEntry;
+            }
+            return Reflect.get(session, prop, receiver);
+        },
+    };
+}
+//# sourceMappingURL=sdkProxy.js.map

package/dist/esm/browser/src/sdkProxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkProxy.js","sourceRoot":"","sources":["../../../../src/sdkProxy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,eAAe,EACf,eAAe,GAGhB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EACL,WAAW,EASX,UAAU,GACX,MAAM,qCAAqC,CAAC;AA0B7C,SAAS,eAAe,CAAC,QAAwB;IAC/C,OAAO;QACL,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC;QACvC,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC;QACpC,KAAK,EAAE,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC;QACjC,WAAW,EAAE,QAAQ,CAAC,WAAW;KAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,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,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,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,eAAe,CAAC,OAAO,CAAC,cAAc,CAAC;wBAC7C,CAAC,CAAC,IAAI,eAAe,EAAE,CAAC;oBAE1B,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CACrC,IAAI,kBAAkB,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,eAAe,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,gBAAgB,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,gBAAgB,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,EAAE,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,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;oBAClF,MAAM,MAAM,GAAG,EAAE,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/esm/browser/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../../../src/defaultvfs.ts","../../../src/index.ts","../../../src/sdkproxy.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;

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

@@ -0,0 +1,61 @@
+import { Cl } from "@stacks/transactions";
+export const 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 },
+    }),
+};
+export 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 = Cl.deserialize(data.raw_value);
+            }
+            return {
+                event: event,
+                data: data,
+            };
+        });
+    }
+    catch (e) {
+        console.error(`Fail to parse events: ${e}`);
+        return [];
+    }
+}
+export 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/esm/common/src/sdkProxyHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkProxyHelpers.js","sourceRoot":"","sources":["../../../../../common/src/sdkProxyHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAgB,MAAM,sBAAsB,CAAC;AA6FxD,MAAM,CAAC,MAAM,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,MAAM,UAAU,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,EAAE,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,MAAM,UAAU,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/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@stacks/clarinet-sdk-browser",
+  "version": "3.8.1",
+  "description": "A SDK to interact with Clarity Smart Contracts in the browser",
+  "homepage": "https://stackslabs.com/clarinet",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stx-labs/clarinet.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/esm/browser/src/index.js",
+  "types": "./dist/esm/browser/src/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "compile": "tsc -b ./tsconfig.json",
+    "build": "npm run clean && npm run compile",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "stacks",
+    "clarity",
+    "clarinet",
+    "tests"
+  ],
+  "author": "stacks-labs",
+  "license": "GPL-3.0",
+  "readme": "./README.md",
+  "dependencies": {
+    "@stacks/clarinet-sdk-wasm-browser": "3.8.1",
+    "@stacks/transactions": "^7.0.6"
+  }
+}