@mistcash/sdk 0.1.0-beta

package/dist/index.d.mts

@@ -0,0 +1,62 @@
+import { ProviderInterface, AccountInterface } from 'starknet';
+import { ChamberTypedContract } from '@mistcash/config';
+
+/**
+ * devVal shortcut for empty string
+ * @uses devVal
+ */
+declare const devStr: (val: string) => string;
+/**
+ * Dev util to preset defaults if devVals is set in localStorage
+ * @param val value to set
+ * @param deflt default value when no dev vals is set
+ * @returns devVals ? val : deflt
+ */
+declare const devVal: <T>(val: T, deflt?: T | undefined) => T | undefined;
+
+interface Asset {
+    amount: bigint;
+    addr: string;
+}
+
+/**
+ * Returns Chamber starknet contract
+ * @param provider Starknet provider
+ * @returns Typed chamber contract
+ */
+declare function getChamber(provider?: ProviderInterface | AccountInterface): ChamberTypedContract;
+/**
+ * Fetch transaction assets from the chamber contract.
+ * ⚠️ Will show assets even if transaction is spent
+ * ⚠️ Contract has no way of knowing which transaction is spent
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @returns The asset associated with the transaction.
+ */
+declare function fetchTxAssets(contract: ChamberTypedContract, valKey: string, valTo: string): Promise<Asset>;
+/**
+ * Checks if the transaction exists on the tree in the contract
+ * gets tx array from the contract and returns true if tx is found in the leaves
+ * ⚠️ Will show transaction exists even if it is spent
+ * ⚠️ Contract has no way of knowing which transaction is spent
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @param tokenAddr token address.
+ * @param amount token amount.
+ * @returns True if the transaction exists, false otherwise.
+ */
+declare function checkTxExists(contract: ChamberTypedContract, valKey: string, valTo: string, tokenAddr: string, amount: string): Promise<boolean>;
+/**
+ * Receives tx leaves array and returns true if tx is found on the tree
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @param tokenAddr token address.
+ * @param amount token amount.
+ * @returns index of the transaction
+ */
+declare function getTxIndexInTree(leaves: bigint[], valKey: string, valTo: string, tokenAddr: string, amount: string): Promise<number>;
+
+export { type Asset, checkTxExists, devStr, devVal, fetchTxAssets, getChamber, getTxIndexInTree };

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+import { ProviderInterface, AccountInterface } from 'starknet';
+import { ChamberTypedContract } from '@mistcash/config';
+
+/**
+ * devVal shortcut for empty string
+ * @uses devVal
+ */
+declare const devStr: (val: string) => string;
+/**
+ * Dev util to preset defaults if devVals is set in localStorage
+ * @param val value to set
+ * @param deflt default value when no dev vals is set
+ * @returns devVals ? val : deflt
+ */
+declare const devVal: <T>(val: T, deflt?: T | undefined) => T | undefined;
+
+interface Asset {
+    amount: bigint;
+    addr: string;
+}
+
+/**
+ * Returns Chamber starknet contract
+ * @param provider Starknet provider
+ * @returns Typed chamber contract
+ */
+declare function getChamber(provider?: ProviderInterface | AccountInterface): ChamberTypedContract;
+/**
+ * Fetch transaction assets from the chamber contract.
+ * ⚠️ Will show assets even if transaction is spent
+ * ⚠️ Contract has no way of knowing which transaction is spent
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @returns The asset associated with the transaction.
+ */
+declare function fetchTxAssets(contract: ChamberTypedContract, valKey: string, valTo: string): Promise<Asset>;
+/**
+ * Checks if the transaction exists on the tree in the contract
+ * gets tx array from the contract and returns true if tx is found in the leaves
+ * ⚠️ Will show transaction exists even if it is spent
+ * ⚠️ Contract has no way of knowing which transaction is spent
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @param tokenAddr token address.
+ * @param amount token amount.
+ * @returns True if the transaction exists, false otherwise.
+ */
+declare function checkTxExists(contract: ChamberTypedContract, valKey: string, valTo: string, tokenAddr: string, amount: string): Promise<boolean>;
+/**
+ * Receives tx leaves array and returns true if tx is found on the tree
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @param tokenAddr token address.
+ * @param amount token amount.
+ * @returns index of the transaction
+ */
+declare function getTxIndexInTree(leaves: bigint[], valKey: string, valTo: string, tokenAddr: string, amount: string): Promise<number>;
+
+export { type Asset, checkTxExists, devStr, devVal, fetchTxAssets, getChamber, getTxIndexInTree };

package/dist/index.js

@@ -0,0 +1,74 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  checkTxExists: () => checkTxExists,
+  devStr: () => devStr,
+  devVal: () => devVal,
+  fetchTxAssets: () => fetchTxAssets,
+  getChamber: () => getChamber,
+  getTxIndexInTree: () => getTxIndexInTree
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/dev.ts
+var devStr = (val) => devVal(val, "");
+var devVal = (val, deflt = void 0) => {
+  return typeof window !== "undefined" && window.localStorage.getItem("devVals") ? val : deflt;
+};
+
+// src/utils.ts
+var import_starknet = require("starknet");
+var import_config = require("@mistcash/config");
+var import_crypto = require("@mistcash/crypto");
+function getChamber(provider) {
+  return new import_starknet.Contract(
+    import_config.CHAMBER_ABI,
+    import_config.CHAMBER_ADDR_MAINNET,
+    provider
+  ).typedv2(import_config.CHAMBER_ABI);
+}
+async function fetchTxAssets(contract, valKey, valTo) {
+  const asset = await contract.read_tx(await (0, import_crypto.txSecret)(valKey, valTo));
+  let amount = asset.amount;
+  if (typeof amount == "number") {
+    amount = BigInt(amount);
+  } else if (typeof amount != "bigint") {
+    amount = BigInt(`${amount.low}`);
+  }
+  return { amount, addr: asset.addr };
+}
+async function checkTxExists(contract, valKey, valTo, tokenAddr, amount) {
+  return await getTxIndexInTree(await contract.tx_array(), valKey, valTo, tokenAddr, amount) !== -1;
+}
+async function getTxIndexInTree(leaves, valKey, valTo, tokenAddr, amount) {
+  const tx_hash = await (0, import_crypto.txHash)(valKey, valTo, tokenAddr, amount);
+  return leaves.indexOf(tx_hash);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  checkTxExists,
+  devStr,
+  devVal,
+  fetchTxAssets,
+  getChamber,
+  getTxIndexInTree
+});

package/dist/index.mjs

@@ -0,0 +1,42 @@
+// src/dev.ts
+var devStr = (val) => devVal(val, "");
+var devVal = (val, deflt = void 0) => {
+  return typeof window !== "undefined" && window.localStorage.getItem("devVals") ? val : deflt;
+};
+
+// src/utils.ts
+import { Contract } from "starknet";
+import { CHAMBER_ABI, CHAMBER_ADDR_MAINNET } from "@mistcash/config";
+import { txSecret, txHash } from "@mistcash/crypto";
+function getChamber(provider) {
+  return new Contract(
+    CHAMBER_ABI,
+    CHAMBER_ADDR_MAINNET,
+    provider
+  ).typedv2(CHAMBER_ABI);
+}
+async function fetchTxAssets(contract, valKey, valTo) {
+  const asset = await contract.read_tx(await txSecret(valKey, valTo));
+  let amount = asset.amount;
+  if (typeof amount == "number") {
+    amount = BigInt(amount);
+  } else if (typeof amount != "bigint") {
+    amount = BigInt(`${amount.low}`);
+  }
+  return { amount, addr: asset.addr };
+}
+async function checkTxExists(contract, valKey, valTo, tokenAddr, amount) {
+  return await getTxIndexInTree(await contract.tx_array(), valKey, valTo, tokenAddr, amount) !== -1;
+}
+async function getTxIndexInTree(leaves, valKey, valTo, tokenAddr, amount) {
+  const tx_hash = await txHash(valKey, valTo, tokenAddr, amount);
+  return leaves.indexOf(tx_hash);
+}
+export {
+  checkTxExists,
+  devStr,
+  devVal,
+  fetchTxAssets,
+  getChamber,
+  getTxIndexInTree
+};

package/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src', '<rootDir>/tests']
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@mistcash/sdk",
+  "version": "0.1.0-beta",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "MIST Core SDK",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "starknet": "^7.6.4",
+    "@mistcash/config": "0.1.0-beta",
+    "@mistcash/crypto": "0.1.0-beta"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "jest": "^29.5.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "clean": "rm -rf dist"
+  }
+}

package/readme.md

@@ -0,0 +1,33 @@
+# @mistcash/sdk
+
+MIST Core SDK
+
+## Installation
+
+```sh
+pnpm add @mistcash/sdk
+```
+
+## Usage
+
+```js
+import { type Asset, fetchTxAssets, getChamber } from '@mistcash/sdk';
+
+// Takes in Starknet provider
+// Returns Typed chamber contract
+const contract = getChamber(provider);
+
+// Fetch transaction assets from the chamber contract.
+// guarantees transaction was generated
+// ⚠️ Will show assets even if transaction is spent
+// ⚠️ Contract has no way of knowing which transaction is spent
+const asset = await fetchTxAssets(contract, valKey, valTo);
+```
+
+## Contributing
+
+Head over to https://github.com/mistcash/sdk for details.
+
+## License
+
+MIT

package/src/dev.ts

@@ -0,0 +1,16 @@
+
+/**
+ * devVal shortcut for empty string
+ * @uses devVal
+ */
+export const devStr = (val: string) => devVal(val, '') as string;
+
+/**
+ * Dev util to preset defaults if devVals is set in localStorage
+ * @param val value to set
+ * @param deflt default value when no dev vals is set
+ * @returns devVals ? val : deflt
+ */
+export const devVal = <T,>(val: T, deflt: T | undefined = undefined) => {
+	return typeof window !== 'undefined' && window.localStorage.getItem('devVals') ? val : deflt
+};

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './dev';
+export * from './utils';
+export * from './types';

package/src/types.ts

@@ -0,0 +1,4 @@
+export interface Asset {
+	amount: bigint;
+	addr: string;
+}

package/src/utils.ts

@@ -0,0 +1,68 @@
+import { AccountInterface, Contract, ProviderInterface, Uint256 } from 'starknet';
+import { CHAMBER_ABI, CHAMBER_ADDR_MAINNET, ChamberTypedContract } from '@mistcash/config';
+import { txSecret, txHash } from '@mistcash/crypto';
+import { Asset } from './types';
+
+/**
+ * Returns Chamber starknet contract
+ * @param provider Starknet provider
+ * @returns Typed chamber contract
+ */
+export function getChamber(provider?: ProviderInterface | AccountInterface): ChamberTypedContract {
+	return new Contract(
+		CHAMBER_ABI,
+		CHAMBER_ADDR_MAINNET,
+		provider
+	).typedv2(CHAMBER_ABI)
+}
+
+/**
+ * Fetch transaction assets from the chamber contract.
+ * ⚠️ Will show assets even if transaction is spent
+ * ⚠️ Contract has no way of knowing which transaction is spent
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @returns The asset associated with the transaction.
+ */
+export async function fetchTxAssets(contract: ChamberTypedContract, valKey: string, valTo: string): Promise<Asset> {
+	const asset = await contract.read_tx(await txSecret(valKey, valTo))
+	let amount = asset.amount;
+	if (typeof amount == 'number') {
+		amount = BigInt(amount);
+
+	} else if (typeof amount != 'bigint') {
+		amount = BigInt(`${amount.low}`);
+	}
+	return { amount, addr: asset.addr }
+}
+
+/**
+ * Checks if the transaction exists on the tree in the contract
+ * gets tx array from the contract and returns true if tx is found in the leaves
+ * ⚠️ Will show transaction exists even if it is spent
+ * ⚠️ Contract has no way of knowing which transaction is spent
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @param tokenAddr token address.
+ * @param amount token amount.
+ * @returns True if the transaction exists, false otherwise.
+ */
+export async function checkTxExists(contract: ChamberTypedContract, valKey: string, valTo: string, tokenAddr: string, amount: string): Promise<boolean> {
+	return await getTxIndexInTree(await contract.tx_array() as bigint[], valKey, valTo, tokenAddr, amount) !== -1;
+}
+
+/**
+ * Receives tx leaves array and returns true if tx is found on the tree
+ * @param contract chamber contract instance.
+ * @param valKey claiming key.
+ * @param valTo recipient.
+ * @param tokenAddr token address.
+ * @param amount token amount.
+ * @returns index of the transaction
+ */
+export async function getTxIndexInTree(leaves: bigint[], valKey: string, valTo: string, tokenAddr: string, amount: string): Promise<number> {
+	const tx_hash = await txHash(valKey, valTo, tokenAddr, amount)
+	return leaves.indexOf(tx_hash);
+}

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": [
+    "src/**/*"
+  ]
+}