Bug/clean esm cjs exports

packages/sdk/README.md

@@ -19,6 +19,20 @@ npm install susuchain-sdk viem @stacks/network @stacks/transactions @stacks/conn
 
 ## Usage
 
+This SDK natively supports both **ES Modules (ESM)** and **CommonJS (CJS)** module systems.
+
+### 📦 Importing the SDK
+
+#### Using ES Modules (import)
+```typescript
+import { SUSUCHAIN_CELO_ADDRESS, STACKS_CONTRACT_NAME } from 'susuchain-sdk';
+```
+
+#### Using CommonJS (require)
+```javascript
+const { SUSUCHAIN_CELO_ADDRESS, STACKS_CONTRACT_NAME } = require('susuchain-sdk');
+```
+
 ### 🟡 Celo Integration (Viem)
 
 You can easily interact with the SusuChain smart contract on Celo using `viem`:
@@ -79,6 +93,10 @@ callContribute(0, (data) => {
 - `STACKS_CONTRACT_NAME`: The contract name (`"susuchain"`).
 - `STACKS_NETWORK`: The Stacks network configuration object (Mainnet).
 
+## Tracking
+
+This release satisfies clean ES Modules and CommonJS packaging guidelines in alignment with issue #27.
+
 ## License
 
 MIT

packages/sdk/package.json

@@ -3,12 +3,22 @@
   "version": "1.0.0",
   "description": "SDK for SusuChain community savings protocol on Celo and Stacks",
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsup",
+    "test": "node test-cjs.js && node test-esm.mjs",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -29,6 +39,7 @@
     "@stacks/connect": "^8.0.0"
   },
   "devDependencies": {
+    "tsup": "^8.0.2",
     "typescript": "^5.0.0"
   }
 }

packages/sdk/test-cjs.js

@@ -0,0 +1,10 @@
+const { SUSUCHAIN_CELO_ADDRESS, STACKS_CONTRACT_NAME } = require("./dist/index.js");
+
+if (SUSUCHAIN_CELO_ADDRESS !== "0x20B421Db767D3496E4489Db5C3122C1fD4625525") {
+  throw new Error("Invalid Celo contract address exported in CommonJS module");
+}
+if (STACKS_CONTRACT_NAME !== "susuchain") {
+  throw new Error("Invalid Stacks contract name exported in CommonJS module");
+}
+
+console.log("CommonJS exports validated successfully.");

packages/sdk/test-esm.mjs

@@ -0,0 +1,10 @@
+import { SUSUCHAIN_CELO_ADDRESS, STACKS_CONTRACT_NAME } from "./dist/index.mjs";
+
+if (SUSUCHAIN_CELO_ADDRESS !== "0x20B421Db767D3496E4489Db5C3122C1fD4625525") {
+  throw new Error("Invalid Celo contract address exported in ES Module");
+}
+if (STACKS_CONTRACT_NAME !== "susuchain") {
+  throw new Error("Invalid Stacks contract name exported in ES Module");
+}
+
+console.log("ES Module exports validated successfully.");

packages/sdk/test-types.js

@@ -0,0 +1,9 @@
+const fs = require("fs");
+const path = require("path");
+
+const dtsPath = path.join(__dirname, "dist/index.d.ts");
+if (!fs.existsSync(dtsPath)) {
+  throw new Error("Type declaration file index.d.ts is missing!");
+}
+
+console.log("Declaration files verified successfully.");

packages/sdk/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  clean: true,
+  format: ["cjs", "esm"],
+  dts: true,
+  splitting: false,
+  sourcemap: true,
+});