feat: add code testing

.github/workflows/code:test.yml

@@ -0,0 +1,84 @@
+name: Code Snippets testing
+
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - "code/**/*.test.ts" # Only trigger on test file changes
+  schedule:
+    - cron: "0 0 * * *" # Run daily at midnight UTC
+
+jobs:
+  snippets-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20]
+      fail-fast: false
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get changed test files
+        id: changed-files
+        uses: tj-actions/changed-files@v39
+        with:
+          files: |
+            code/**/*.test.ts
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Change Directory
+        run: cd code
+
+      - name: Run tests on changed files
+        if: github.event_name == 'pull_request'
+        run: |
+          CHANGED_FILES="${{ steps.changed-files.outputs.all_changed_files }}"
+
+          if [ -z "$CHANGED_FILES" ]; then
+            echo "No test files were changed"
+            exit 0
+          fi
+
+          # Create array for test files
+          declare -a test_files=()
+
+          # Collect only .test.ts files
+          for file in $CHANGED_FILES; do
+            if [[ $file == *.test.ts ]]; then
+              test_files+=("$file")
+              echo "Added test file: $file"
+            fi
+          done
+
+          # If we found test files, run them together
+          if [ ${#test_files[@]} -gt 0 ]; then
+            echo "Running tests for the following files:"
+            printf '%s\n' "${test_files[@]}"
+
+            # Run all test files in a single command
+            node --import tsx --test "${test_files[@]}" || exit 1
+          else
+            echo "No test files to run"
+          fi
+
+      - name: Run all tests
+        if: github.event_name == 'schedule'
+        run: |
+          echo "Running all tests in code directory"
+          pnpm turbo test

.github/workflows/contentlayer.yml

@@ -16,8 +16,6 @@ jobs:
       - uses: actions/checkout@v4
       - name: Install pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: 9
       - name: use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:

.github/workflows/deploy.yml

@@ -18,8 +18,6 @@ jobs:
       - uses: actions/checkout@v4
       - name: Install pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: 9
       - name: Install Vercel CLI and pnpm
         run: npm install --global vercel@latest
       - name: Pull Vercel Environment Information

.github/workflows/formatting.yml

@@ -16,8 +16,6 @@ jobs:
         uses: actions/checkout@v4
       - name: Install pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: 9
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:

.gitignore

@@ -106,6 +106,8 @@ package-lock.json
 # translations are stored in the `i18n` via crowdin
 i18n
 
+# turborepo
+.turbo
 
 # code-import
 .turbo

.prettierrc

@@ -1,10 +1,39 @@
 {
+  "printWidth": 80,
   "tabWidth": 2,
   "useTabs": false,
+  "semi": true,
   "singleQuote": false,
-  "printWidth": 80,
-  "trailingComma": "all",
-  "arrowParens": "avoid",
-  "endOfLine": "auto",
-  "proseWrap": "always"
-}
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "proseWrap": "preserve",
+  "endOfLine": "lf",
+  "embeddedLanguageFormatting": "auto",
+  "singleAttributePerLine": false,
+  "overrides": [
+    {
+      "files": ["*.md", "*.mdx"],
+      "options": {
+        "parser": "mdx",
+        "printWidth": 80,
+        "proseWrap": "preserve",
+        "singleQuote": false,
+        "jsxSingleQuote": false,
+        "bracketSameLine": false,
+        "singleAttributePerLine": false
+      }
+    },
+    {
+      "files": ["*.{ts,tsx,js,jsx}"],
+      "options": {
+        "printWidth": 80,
+        "semi": true,
+        "singleQuote": false,
+        "trailingComma": "es5",
+        "bracketSpacing": true,
+        "bracketSameLine": false
+      }
+    }
+  ]
+}

CONTRIBUTING.md

@@ -23,7 +23,7 @@ transparent as possible, whether it's:
 - content translations are supported via Crowdin
 - code blocks must use code-import for file snippets (via filesystem)
 - code file should be [tests](https://nodejs.org/api/test.html) and should add
-  code ranges instead of whole test file
+  code ranges instead of whole file
 
 ## Style guidelines
 
@@ -285,8 +285,8 @@ source files.
 
 To use code-import, follow these steps:
 
-Ensure your code file is a test file located in the appropriate directory within
-the repo. Use the following syntax to import code snippets:
+Ensure your code file is located in the appropriate directory within the repo.
+Use the following syntax to import code snippets:
 
 ```javascript file="/path/to/your/file.ts#L1-L10,#L15-L20"
 
@@ -1012,3 +1012,71 @@ pnpm dev
 ```
 
 > Note: The developer content API normally runs locally on port `3001`
+
+4. Installing other packages, since the repo is a pnpm workspace.
+
+`pnpm i -D remark-mdx -w solana-developer-content-api` `remarkmdx`
+
+## Testing Code Snippets
+
+The repository uses Node's native test runner for testing code examples. This
+ensures all code snippets are correct and working as expected.
+
+### Test Structure
+
+There are two supported ways to structure your tests:
+
+1. **Adjacent test files** - For simpler modules with a single code file:
+
+   ```
+   pda/
+   ├── index.ts
+   └── index.test.ts
+   ```
+
+2. **Tests directory** - For modules with multiple code files or complex test
+   cases:
+   ```
+   pda/
+   ├── index.ts
+   ├── utils.ts
+   └── tests/
+       ├── index.test.ts
+       └── utils.test.ts
+   ```
+
+Choose the structure that best fits your needs:
+
+- Use adjacent test files (`index.test.ts`) when you have a simple 1:1
+  relationship between code and test files
+- Use a `tests` directory when you have multiple code files that need testing or
+  need multiple test files for a single code file
+
+### Running Tests
+
+You can run tests in two ways:
+
+1. Test the entire codebase:
+
+   ```shell
+   pnpm install
+   pnpm turbo test
+   ```
+
+2. Test specific code imports:
+   ```shell
+   pnpm install
+   cd code
+   pnpm turbo test
+   ```
+
+### Writing Tests
+
+We use [Behavior-Driven Development (BDD)](https://cucumber.io/docs/bdd/) style
+testing, which uses `describe` and `it` blocks to create readable test
+descriptions. When tests run, they read like natural sentences.
+
+Example:
+[generate-mnemonic.test.ts](github.com/solana-foundation/developer-content/tree/main/code/content/cookbook/wallets/tests/generate-mnemonic.test.ts)
+
+All tests should handle both success and failure (error) cases appropriately.

code/cookbook/wallets/check-public-key.ts → code/content/web3jsv1/cookbook/wallets/check-publickey.ts

@@ -1,4 +1,4 @@
-import { PublicKey } from "@solana/web3.js";
+import { PublicKey, Keypair } from "@solana/web3.js";
 
 // Note that Keypair.generate() will always give a public key that is valid for users
 
@@ -9,11 +9,20 @@ console.log(PublicKey.isOnCurve(key.toBytes()));
 
 // Valid public key
 const offCurveAddress = new PublicKey(
-  "4BJXYkfvg37zEmBbsacZjeQDpTNx91KppxFJxRqrz48e",
+  "4BJXYkfvg37zEmBbsacZjeQDpTNx91KppxFJxRqrz48e"
 );
 
 // Not on the ed25519 curve, therefore not suitable for users
 console.log(PublicKey.isOnCurve(offCurveAddress.toBytes()));
 
-// Not a valid public key
-const errorPubkey = new PublicKey("testPubkey");
+let errorPubkey;
+try {
+  // Not a valid public key
+  errorPubkey = new PublicKey("testPubkey");
+} catch (err) {
+  // Error will be caught here
+}
+
+const onCurve = PublicKey.isOnCurve(key.toBytes());
+
+export { key, onCurve, offCurveAddress, errorPubkey };

code/content/web3jsv1/cookbook/wallets/create-keypair.ts

@@ -0,0 +1,5 @@
+import { Keypair } from "@solana/web3.js";
+
+const keypair = Keypair.generate();
+
+export { keypair };

code/content/web3jsv1/cookbook/wallets/generate-mnemonic.ts

@@ -0,0 +1,5 @@
+import * as bip39 from "bip39";
+
+const mnemonic = bip39.generateMnemonic();
+
+export { mnemonic };

code/content/web3jsv1/cookbook/wallets/generate-vanity-address.sh

@@ -0,0 +1 @@
+solana-keygen grind --starts-with e1v1s:1

code/content/web3jsv1/cookbook/wallets/restore-bip39-mnemonic.ts

@@ -0,0 +1,15 @@
+import { Keypair } from "@solana/web3.js";
+import * as bip39 from "bip39";
+
+const mnemonic =
+  "pill tomorrow foster begin walnut borrow virtual kick shift mutual shoe scatter";
+
+// arguments: (mnemonic, password)
+const seed = bip39.mnemonicToSeedSync(mnemonic, "");
+const keypair = Keypair.fromSeed(seed.slice(0, 32));
+
+console.log(`${keypair.publicKey.toBase58()}`);
+
+// output: 5ZWj7a1f8tWkjBESHKgrLmXshuXxqeY9SYcfbshpAqPG
+
+export { keypair };

code/content/web3jsv1/cookbook/wallets/restore-bip44-mnemonic.ts

@@ -0,0 +1,29 @@
+import { Keypair } from "@solana/web3.js";
+import { HDKey } from "micro-key-producer/slip10.js";
+import * as bip39 from "bip39";
+
+type Wallet = {
+  path: string;
+  keypair: Keypair;
+  publicKey: string;
+};
+
+const mnemonic =
+  "neither lonely flavor argue grass remind eye tag avocado spot unusual intact";
+
+const seed = bip39.mnemonicToSeedSync(mnemonic, "");
+const hd = HDKey.fromMasterSeed(seed.toString("hex"));
+
+const wallets: Wallet[] = [];
+
+for (let i = 0; i < 10; i++) {
+  const path = `m/44'/501'/${i}'/0'`;
+  const keypair = Keypair.fromSeed(hd.derive(path).privateKey);
+  wallets.push({
+    path,
+    keypair,
+    publicKey: keypair.publicKey.toBase58(),
+  });
+}
+
+export { mnemonic, wallets };

code/content/web3jsv1/cookbook/wallets/restore-keypair-from-bs58.ts

@@ -0,0 +1,10 @@
+import { Keypair } from "@solana/web3.js";
+import bs58 from "bs58";
+
+const keypair = Keypair.fromSecretKey(
+  bs58.decode(
+    "4UzFMkVbk1q6ApxvDS8inUxg4cMBxCQRVXRx5msqQyktbi1QkJkt574Jda6BjZThSJi54CHfVoLFdVFX8XFn233L"
+  )
+);
+
+export { keypair as bs58Keypair };

code/content/web3jsv1/cookbook/wallets/restore-keypair-from-bytes.ts

@@ -0,0 +1,12 @@
+import { Keypair } from "@solana/web3.js";
+
+const keypair = Keypair.fromSecretKey(
+  Uint8Array.from([
+    174, 47, 154, 16, 202, 193, 206, 113, 199, 190, 53, 133, 169, 175, 31, 56,
+    222, 53, 138, 189, 224, 216, 117, 173, 10, 149, 53, 45, 73, 251, 237, 246,
+    15, 185, 186, 82, 177, 240, 148, 69, 241, 227, 167, 80, 141, 89, 240, 121,
+    121, 35, 172, 247, 68, 251, 226, 218, 48, 63, 176, 109, 168, 89, 238, 135,
+  ])
+);
+
+export { keypair as bytesKeypair };