chore: remove legacy CJS files, fix env defaults, and improve type annotations (#63)

thephez · claude · web-flow · commit b1b32dc50ddd · 2026-03-18T13:03:30.000-04:00
* chore: remove old sdk files * chore: fix main in package.json * fix: use || instead of ?? for env var defaults to handle empty strings ?? only falls back on null/undefined, so an empty env var (e.g. DATA_CONTRACT_ID='') would be used as-is instead of the intended default. * chore: fmt * chore: fix tsconfig to check setupDashClient with correct ESM settings (#64) * chore: fix tsconfig to check setupDashClient with correct ESM settings Update tsconfig.json to use module/moduleResolution node16 for proper .mjs ESM support, scope include to setupDashClient.mjs only, and set maxNodeModuleJsDepth to 0. Add @types/node and @types/mocha devDeps. Add JSDoc type annotations to setupDashClient.mjs to pass strict tsc check. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * chore: replace any types with precise SDK types in setupDashClient Add JSDoc typedef imports for Identity, IdentityPublicKey, PlatformAddress, PlatformAddressInfo, and NetworkLike. Define DerivedKeyEntry and AddressEntry typedefs. Replace all any params/returns with real SDK types. Add missing @returns to create(), convenience signer methods, and exported functions. Add identity-not-found guard in getSigner() with corresponding test. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
diff --git a/1-Identities-and-Names/identity-retrieve-account-ids.js b/1-Identities-and-Names/identity-retrieve-account-ids.js
diff --git a/1-Identities-and-Names/identity-transfer-credits.mjs b/1-Identities-and-Names/identity-transfer-credits.mjs
@@ -6,7 +6,7 @@ const { identity, signer } = await keyManager.getTransfer();
 
 // Default recipient (testnet). Replace or override via RECIPIENT_ID.
 const recipientId =
-  process.env.RECIPIENT_ID ?? '7XcruVSsGQVSgTcmPewaE4tXLutnW1F6PXxwMbo8GYQC';
+  process.env.RECIPIENT_ID || '7XcruVSsGQVSgTcmPewaE4tXLutnW1F6PXxwMbo8GYQC';
 const transferAmount = 100000n; // Credits to transfer
 
 try {
diff --git a/1-Identities-and-Names/identity-update-add-key.js b/1-Identities-and-Names/identity-update-add-key.js
diff --git a/1-Identities-and-Names/identity-update-disable-key.js b/1-Identities-and-Names/identity-update-disable-key.js
diff --git a/1-Identities-and-Names/identity-update-disable-key.mjs b/1-Identities-and-Names/identity-update-disable-key.mjs
@@ -5,7 +5,7 @@ const { sdk, keyManager } = await setupDashClient();
 const { identity, signer } = await keyManager.getMaster();
 
 // Replace with one of the identity's existing public key IDs
-const DISABLE_KEY_ID = Number(process.env.DISABLE_KEY_ID ?? 99);
+const DISABLE_KEY_ID = Number(process.env.DISABLE_KEY_ID || 99);
 
 console.log(
   `Disabling key ${DISABLE_KEY_ID} on identity ${keyManager.identityId}...`,
diff --git a/1-Identities-and-Names/identity-withdraw-credits.mjs b/1-Identities-and-Names/identity-withdraw-credits.mjs
@@ -8,7 +8,7 @@ console.log('Identity balance before withdrawal:', identity.balance);
 
 // Default: testnet faucet address. Replace or override via WITHDRAWAL_ADDRESS.
 const toAddress =
-  process.env.WITHDRAWAL_ADDRESS ?? 'yXWJGWuD4VBRMp9n2MtXQbGpgSeWyTRHme';
+  process.env.WITHDRAWAL_ADDRESS || 'yXWJGWuD4VBRMp9n2MtXQbGpgSeWyTRHme';
 const amount = 190000n; // Credits to withdraw
 const amountDash = Number(amount) / (1000 * 100000000);
 
diff --git a/1-Identities-and-Names/name-register.mjs b/1-Identities-and-Names/name-register.mjs
@@ -5,7 +5,7 @@ const { sdk, keyManager } = await setupDashClient();
 const { identity, identityKey, signer } = await keyManager.getAuth();
 
 // ⚠️ Change this to a unique name to register
-const NAME_LABEL = process.env.NAME_LABEL ?? 'alice';
+const NAME_LABEL = process.env.NAME_LABEL || 'alice';
 
 try {
   // Register a DPNS name for the identity
diff --git a/2-Contracts-and-Documents/contract-retrieve-history.mjs b/2-Contracts-and-Documents/contract-retrieve-history.mjs
@@ -4,7 +4,7 @@ const { sdk } = await setupDashClient();
 
 // Default tutorial contract with history (testnet). Replace or override via DATA_CONTRACT_ID.
 const DATA_CONTRACT_ID =
-  process.env.DATA_CONTRACT_ID ??
+  process.env.DATA_CONTRACT_ID ||
   '5J4VPym1Bnc2Ap9bbo9wNw6fZLGsCzDM7ZScdzcggN1r';
 
 try {
diff --git a/2-Contracts-and-Documents/contract-retrieve.mjs b/2-Contracts-and-Documents/contract-retrieve.mjs
@@ -5,7 +5,7 @@ const { sdk } = await setupDashClient();
 
 // Default tutorial contract (testnet). Replace or override via DATA_CONTRACT_ID.
 const DATA_CONTRACT_ID =
-  process.env.DATA_CONTRACT_ID ??
+  process.env.DATA_CONTRACT_ID ||
   'FW3DHrQiG24VqzPY4ARenMgjEPpBNuEQTZckV8hbVCG4';
 
 try {
diff --git a/2-Contracts-and-Documents/contract-update-history.mjs b/2-Contracts-and-Documents/contract-update-history.mjs
@@ -7,7 +7,7 @@ const { identityKey, signer } = await keyManager.getAuth();
 // Edit these values for your environment
 // Your contract ID from the Register a Data Contract tutorial
 const DATA_CONTRACT_ID =
-  process.env.DATA_CONTRACT_ID ?? 'YOUR_DATA_CONTRACT_ID';
+  process.env.DATA_CONTRACT_ID || 'YOUR_DATA_CONTRACT_ID';
 const DOCUMENT_TYPE = 'note';
 
 if (!DATA_CONTRACT_ID || DATA_CONTRACT_ID === 'YOUR_DATA_CONTRACT_ID') {
diff --git a/2-Contracts-and-Documents/contract-update-minimal.mjs b/2-Contracts-and-Documents/contract-update-minimal.mjs
@@ -7,7 +7,7 @@ const { identityKey, signer } = await keyManager.getAuth();
 // Edit these values for your environment
 // Your contract ID from the Register a Data Contract tutorial
 const DATA_CONTRACT_ID =
-  process.env.DATA_CONTRACT_ID ?? 'YOUR_DATA_CONTRACT_ID';
+  process.env.DATA_CONTRACT_ID || 'YOUR_DATA_CONTRACT_ID';
 const DOCUMENT_TYPE = 'note';
 
 if (!DATA_CONTRACT_ID || DATA_CONTRACT_ID === 'YOUR_DATA_CONTRACT_ID') {
diff --git a/2-Contracts-and-Documents/document-delete.mjs b/2-Contracts-and-Documents/document-delete.mjs
@@ -6,11 +6,11 @@ const { identity, identityKey, signer } = await keyManager.getAuth();
 
 // Default tutorial contract (testnet). Replace or override via DATA_CONTRACT_ID.
 const DATA_CONTRACT_ID =
-  process.env.DATA_CONTRACT_ID ??
+  process.env.DATA_CONTRACT_ID ||
   'FW3DHrQiG24VqzPY4ARenMgjEPpBNuEQTZckV8hbVCG4';
 
 // Replace with your existing document ID
-const DOCUMENT_ID = process.env.DOCUMENT_ID ?? 'YOUR_DOCUMENT_ID';
+const DOCUMENT_ID = process.env.DOCUMENT_ID || 'YOUR_DOCUMENT_ID';
 
 try {
   // Delete the document from the platform
diff --git a/2-Contracts-and-Documents/document-retrieve.mjs b/2-Contracts-and-Documents/document-retrieve.mjs
@@ -5,7 +5,7 @@ const { sdk } = await setupDashClient();
 
 // Default tutorial contract (testnet). Replace or override via DATA_CONTRACT_ID.
 const DATA_CONTRACT_ID =
-  process.env.DATA_CONTRACT_ID ??
+  process.env.DATA_CONTRACT_ID ||
   'FW3DHrQiG24VqzPY4ARenMgjEPpBNuEQTZckV8hbVCG4';
 
 try {
diff --git a/2-Contracts-and-Documents/document-submit.mjs b/2-Contracts-and-Documents/document-submit.mjs
@@ -7,7 +7,7 @@ const { identity, identityKey, signer } = await keyManager.getAuth();
 
 // Default tutorial contract (testnet). Replace or override via DATA_CONTRACT_ID.
 const DATA_CONTRACT_ID =
-  process.env.DATA_CONTRACT_ID ??
+  process.env.DATA_CONTRACT_ID ||
   'FW3DHrQiG24VqzPY4ARenMgjEPpBNuEQTZckV8hbVCG4';
 
 try {
diff --git a/2-Contracts-and-Documents/document-update.mjs b/2-Contracts-and-Documents/document-update.mjs
@@ -6,11 +6,11 @@ const { identity, identityKey, signer } = await keyManager.getAuth();
 
 // Default tutorial contract (testnet). Replace or override via DATA_CONTRACT_ID.
 const DATA_CONTRACT_ID =
-  process.env.DATA_CONTRACT_ID ??
+  process.env.DATA_CONTRACT_ID ||
   'FW3DHrQiG24VqzPY4ARenMgjEPpBNuEQTZckV8hbVCG4';
 
 // Replace with your existing document ID from the Submit Documents tutorial
-const DOCUMENT_ID = process.env.DOCUMENT_ID ?? 'YOUR_DOCUMENT_ID';
+const DOCUMENT_ID = process.env.DOCUMENT_ID || 'YOUR_DOCUMENT_ID';
 
 try {
   // Fetch the existing document to get current revision
diff --git a/README.md b/README.md
@@ -16,11 +16,12 @@ Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/das
 The included dev container provides a ready-to-use environment with Node.js, dependencies, and
 editor tooling pre-configured. Open the repo in [GitHub
 Codespaces](https://codespaces.new/dashpay/platform-tutorials) or locally with the [VS Code Dev
-Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
+Containers
+extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
 
 On first launch the container installs dependencies and creates a starter `.env` file from
-`.env.example`. Run `node create-wallet.mjs` to generate a mnemonic, then set `PLATFORM_MNEMONIC`
-in your `.env` file to begin the tutorials.
+`.env.example`. Run `node create-wallet.mjs` to generate a mnemonic, then set `PLATFORM_MNEMONIC` in
+your `.env` file to begin the tutorials.
 
 ## Install
 
@@ -63,8 +64,8 @@ Some client configuration options are included as comments in
 
 ## Testing
 
-Tests run each tutorial as a subprocess and validate its output. No test framework
-dependencies are required — tests use the Node.js built-in test runner.
+Tests run each tutorial as a subprocess and validate its output. No test framework dependencies are
+required — tests use the Node.js built-in test runner.
 
 Ensure your `.env` file is configured (see [`.env.example`](./.env.example)) before running tests.
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,9 +2,9 @@
   "name": "platform-tutorials",
   "version": "3.1-dev",
   "description": "Tutorial code for https://docs.dash.org/platform",
-  "main": "connect.js",
+  "main": "connect.mjs",
   "scripts": {
-    "fmt": "npx prettier@2 --write '**/*.{md,js,mjs}'",
+    "fmt": "npx prettier@3.8.1 --write '**/*.{js,mjs}'",
     "lint": "npx -p typescript@4 tsc",
     "test": "node --test --test-timeout=120000 test/read-only.test.mjs",
     "test:read-only": "node --test --test-timeout=120000 test/read-only.test.mjs",
@@ -27,6 +27,8 @@
     "dotenv": "17.3.1"
   },
   "devDependencies": {
+    "@types/mocha": "10.0.10",
+    "@types/node": "25.5.0",
     "chai": "6.2.2",
     "eslint": "8.45.0",
     "mocha": "11.7.5"
diff --git a/setupDashClient.mjs b/setupDashClient.mjs
diff --git a/test/setupDashClient.test.mjs b/test/setupDashClient.test.mjs
diff --git a/tsconfig.json b/tsconfig.json
