@strkfarm/sdk 1.2.0 → 2.0.0-dev-strategy2.1

package/package.json

@@ -1,79 +1,89 @@
 {
-    "name": "@strkfarm/sdk",
-    "version": "1.2.0",
-    "description": "STRKFarm TS SDK (Meant for our internal use, but feel free to use it)",
-    "typings": "dist/index.d.ts",
-    "types": "dist/index.d.ts",
-    "bin": {
-        "accountsecure": "dist/cli.js"
-    },
-    "exports": {
-        ".": {
-            "import": {
-                "browser": "./dist/index.browser.mjs",
-                "default": "./dist/index.mjs"
-            },
-            "require": {
-                "browser": "./dist/index.browser.global.js",
-                "default": "./dist/index.js"
-            },
-            "browser": "./dist/index.browser.global.js",
-            "types": "./dist/index.d.ts"
-        }
-    },
-    "files": [
-        "dist",
-        "src"
-    ],
-    "scripts": {
-        "test": "jest",
-        "build": "tsup --clean && pnpm run build:esm && npm run build:dts && npm run build:iife && npm run build-cli && pnpm run build:iife-esm",
-        "build:esm": "tsup --clean false --format esm --platform node",
-        "build-cli:esm": "tsup ./src/cli.ts --clean false --format esm --platform node",
-        "build-cli": "tsup ./src/cli.ts --clean false && pnpm run build-cli:esm",
-        "build:dts": "tsup --clean false --dts-only",
-        "build:iife": "tsup --clean false --format iife --platform browser",
-        "build:iife-esm": "tsup --clean false --format iife --format esm --platform browser"
-    },
-    "keywords": [],
-    "author": "",
-    "license": "ISC",
-    "devDependencies": {
-        "@types/jest": "^29.5.12",
-        "@types/node-telegram-bot-api": "^0.64.7",
-        "jest": "^29.7.0",
-        "jest-environment-jsdom": "^29.7.0",
-        "request": "^2.88.2",
-        "ts-jest": "^29.1.5",
-        "ts-node": "^10.9.2",
-        "tsup": "^8.1.0",
-        "typedoc": "^0.26.3",
-        "typescript": "^5.5.3"
-    },
-    "peerDependencies": {
-        "@types/react": "^19.1.2",
-        "axios": "^1.7.2",
-        "react": "19.1.2",
-        "starknet": "9.2.1"
-    },
-    "dependencies": {
-        "@apollo/client": "3.11.8",
-        "@avnu/avnu-sdk": "3.0.2",
-        "@ericnordelo/strk-merkle-tree": "^1.0.0",
-        "@noble/curves": "^1.0.0",
-        "@noble/hashes": "^2.0.0",
-        "@scure/starknet": "^2.0.0",
-        "bignumber.js": "4.0.4",
-        "browser-assert": "^1.2.1",
-        "chalk": "^4.1.2",
-        "commander": "^12.1.0",
-        "ethers": "^6.13.5",
-        "graphql": "16.9.0",
-        "inquirer": "^10.1.2",
-        "node-telegram-bot-api": "^0.66.0",
-        "proxy-from-env": "^1.1.0",
-        "redis": "^4.7.0",
-        "stacktrace-js": "^2.0.2",
-        "winston": "^3.13.0"
+  "name": "@strkfarm/sdk",
+  "version": "2.0.0-dev-strategy2.1",
+  "description": "STRKFarm TS SDK (Meant for our internal use, but feel free to use it)",
+  "typings": "dist/index.d.ts",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "accountsecure": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "browser": "./dist/index.browser.mjs",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "browser": "./dist/index.browser.global.js",
+        "default": "./dist/index.js"
+      },
+      "browser": "./dist/index.browser.global.js",
+      "types": "./dist/index.d.ts"
     }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "test": "jest",
+    "build": "tsup --clean && pnpm run build:esm && npm run build:dts && npm run build:iife && npm run build-cli && pnpm run build:iife-esm",
+    "build:watch": "nodemon --watch src --ext ts,tsx --ignore 'src/**/*.test.ts' --exec 'pnpm run build'",
+    "build:esm": "tsup --clean false --format esm --platform node",
+    "build-cli:esm": "tsup ./src/cli.ts --clean false --format esm --platform node",
+    "build-cli": "tsup ./src/cli.ts --clean false && pnpm run build-cli:esm",
+    "build:dts": "tsup --clean false --dts-only",
+    "build:iife": "tsup --clean false --format iife --platform browser",
+    "build:iife-esm": "tsup --clean false --format iife --format esm --platform browser",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "publishConfig": {
+    "tag": "dev"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node-telegram-bot-api": "^0.64.7",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "nodemon": "^3.1.0",
+    "request": "^2.88.2",
+    "ts-jest": "^29.1.5",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.1.0",
+    "typedoc": "^0.26.3",
+    "typescript": "^5.5.3"
+  },
+  "peerDependencies": {
+    "@types/react": "^19.1.2",
+    "axios": "^1.7.2",
+    "react": "19.1.0",
+    "starknet": "8.5.2"
+  },
+  "dependencies": {
+    "@apollo/client": "3.11.8",
+    "@avnu/avnu-sdk": "3.0.2",
+    "@ericnordelo/strk-merkle-tree": "^1.0.0",
+    "@neondatabase/serverless": "^1.0.2",
+    "@noble/curves": "^1.0.0",
+    "@noble/hashes": "^2.0.0",
+    "@scure/starknet": "^2.0.0",
+    "bignumber.js": "4.0.4",
+    "browser-assert": "^1.2.1",
+    "chalk": "^4.1.2",
+    "commander": "^12.1.0",
+    "dotenv": "^17.2.3",
+    "drizzle-orm": "^0.45.1",
+    "ethers": "^6.13.5",
+    "graphql": "16.9.0",
+    "inquirer": "^10.1.2",
+    "node-telegram-bot-api": "^0.66.0",
+    "proxy-from-env": "^1.1.0",
+    "redis": "^4.7.0",
+    "stacktrace-js": "^2.0.2",
+    "winston": "^3.13.0"
+  }
 }

package/readme.md

@@ -1,4 +1,59 @@
 # STRKFarm SDK
 We are working on the documentation. It's not a priority right now, but we will get to it soon. If you have any questions, feel free to ask in our [Telegram](https://t.me/+HQ_eHaXmF-1lZDc1) in dev topic.
 
-Also, if you are interested to help in the documentation, please let us know in the Telegram group. We appreciate open source contributions and have a reward system for contributors on onlydust.
+Also, if you are interested to help in the documentation, please let us know in the Telegram group. We appreciate open source contributions and have a reward system for contributors on onlydust.
+
+## Linking in Other Repositories
+
+This package can be linked in other repositories using pnpm. There are two main approaches:
+
+### Method 1: Global Link (Recommended for Development)
+
+1. **In this repository**, build the package and create a global link:
+   ```bash
+   pnpm build
+   pnpm link --global
+   # or simply: pnpm link
+   ```
+
+2. **In your other repository**, link to the package:
+   ```bash
+   pnpm link @strkfarm/sdk
+   ```
+
+3. To unlink later:
+   ```bash
+   # In this repo:
+   pnpm unlink --global
+   
+   # In other repo:
+   pnpm unlink @strkfarm/sdk
+   ```
+
+### Method 2: Direct Path Link
+
+In your other repository, add this package directly:
+
+```bash
+pnpm add file:../path/to/sdk-ts-1
+# or
+pnpm link ../path/to/sdk-ts-1
+```
+
+### Method 3: Workspace Setup (Monorepo)
+
+If you're setting up a monorepo, add this package to your workspace:
+
+1. In your root `pnpm-workspace.yaml`:
+   ```yaml
+   packages:
+     - 'packages/*'
+     - '../sdk-ts-1'  # or wherever this package is located
+   ```
+
+2. Then in your other packages, add:
+   ```bash
+   pnpm add @strkfarm/sdk
+   ```
+
+**Note**: Make sure to rebuild this package (`pnpm build`) after making changes for the changes to be reflected in linked packages.