From a86c2abb9a00e5e14708fc84d88e50d86b5c7d6e Mon Sep 17 00:00:00 2001 From: Tobias Merkle Date: Mon, 15 Dec 2025 13:46:08 -0500 Subject: [PATCH] update README with sdk build steps --- README.md | 12 ++++++++++++ package-lock.json | 7 +------ package.json | 2 +- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0214c1d..028f968 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,9 @@ cd # Install dependencies npm install +# Build the SDK (required before building the extension) +cd sdk && npm run build && cd .. + # Build extension npm run build ``` @@ -48,6 +51,15 @@ After changes, click the refresh icon in `chrome://extensions` to reload. npm run build ``` +### Working with the SDK + +The extension depends on the local `@nockbox/iris-sdk` package (in the `sdk/` directory). If you modify SDK source files, rebuild it before building the extension: + +```bash +cd sdk && npm run build && cd .. +npm run build +``` + ## WASM Modules WASM binaries are **pre-built and included** in `extension/lib/`. No build required. diff --git a/package-lock.json b/package-lock.json index 8a9125f..6bb3d89 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "dependencies": { "@fontsource/inter": "^5.2.8", "@fontsource/lora": "^5.2.8", - "@nockbox/iris-sdk": "file:./sdk", + "@nockbox/iris-sdk": "file:sdk", "@scure/base": "^2.0.0", "@scure/bip39": "^2.0.1", "react": "^19.2.0", @@ -1292,7 +1292,6 @@ "integrity": "sha512-6mDvHUFSjyT2B2yeNx2nUgMxh9LtOWvkhIU3uePn2I2oyNymUAX1NIsdgviM4CH+JSrp2D2hsMvJOkxY+0wNRA==", "devOptional": true, "license": "MIT", - "peer": true, "dependencies": { "csstype": "^3.0.2" } @@ -1428,7 +1427,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "baseline-browser-mapping": "^2.8.9", "caniuse-lite": "^1.0.30001746", @@ -2445,7 +2443,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -2504,7 +2501,6 @@ "resolved": "https://registry.npmjs.org/react/-/react-19.2.0.tgz", "integrity": "sha512-tmbWg6W31tQLeB5cdIBOicJDJRR2KzXsV7uSK9iNfLWQ5bIZfxuPEHp7M8wiHyHnn0DD1i7w3Zmin0FtkrwoCQ==", "license": "MIT", - "peer": true, "engines": { "node": ">=0.10.0" } @@ -2680,7 +2676,6 @@ "integrity": "sha512-t/R3R/n0MSwnnazuPpPNVO60LX0SKL45pyl9YlvxIdkH0Of7D5qM2EVe+yASRIlY5pZ73nclYJfNANGWPwFDZw==", "dev": true, "license": "BSD-2-Clause", - "peer": true, "dependencies": { "@jridgewell/source-map": "^0.3.3", "acorn": "^8.15.0", diff --git a/package.json b/package.json index 22644a9..41be71c 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "dependencies": { "@fontsource/inter": "^5.2.8", "@fontsource/lora": "^5.2.8", - "@nockbox/iris-sdk": "file:./sdk", + "@nockbox/iris-sdk": "file:sdk", "@scure/base": "^2.0.0", "@scure/bip39": "^2.0.1", "react": "^19.2.0",