@triton-one/yellowstone-grpc 4.0.2 → 5.0.0

package/README.md

@@ -24,3 +24,25 @@ npm run build
 ```
 
 Please refer to [examples/typescript](../examples/typescript/README.md) for some usage examples.
+
+## Troubleshooting
+
+### For macOS:
+
+You might have to run `npm run build` with `RUSTFLAGS="-Clink-arg=-undefined -Clink-arg=dynamic_lookup"` to skip the strict linkers from failing the build step and resolve `dylib`s via runtime.
+
+```bash
+RUSTFLAGS="-Clink-arg=-undefined -Clink-arg=dynamic_lookup" npm run build
+```
+
+## Working
+
+Since the start, the `@triton-one/yellowstone-grpc` package has used the `@grpc/grpc-js` lib for gRPC types enforcement, connection and subscription management. This hit a bottleneck, described in [this blog](https://blog.triton.one/supercharging-the-javascript-sdk-with-napi/)
+
+From `v5.0.0` the [napi-rs](https://github.com/napi-rs/napi-rs) framework is used for gRPC connection and subscription management. It's described into [this blog](https://blog.triton.one/supercharging-the-javascript-sdk-with-napi/)
+
+These changes are internal to the SDK and do not have any breaking changes for client code. If you face any issues, please open an issue
+
+The `@grpc/grpc-js` lib is still being used for types management. This is will be removed in the future release without any braking API changes
+
+The [napi-rs](https://github.com/napi-rs/napi-rs) based implementation is inspired from the implemenation of the [LaserStream SDK](https://github.com/helius-labs/laserstream-sdk)

package/package.json

@@ -1,16 +1,21 @@
 {
   "name": "@triton-one/yellowstone-grpc",
-  "version": "4.0.2",
+  "version": "5.0.0",
   "license": "Apache-2.0",
   "author": "Triton One",
   "description": "Yellowstone gRPC Geyser Node.js Client",
   "main": "./dist/cjs/index.js",
   "types": "./dist/types/index.d.ts",
   "scripts": {
-    "build": "npm run grpc-generate && tsc --project tsconfig.esm.json && tsc --project tsconfig.cjs.json && npm run cp-encoding-files && node add-js-extensions.js",
+    "build": "npm run grpc-generate && npm run build:napi && npm run cp-napi-files && tsc --project tsconfig.esm.json && tsc --project tsconfig.cjs.json && npm run cp-encoding-files && node add-js-extensions.js",
+    "build:napi": "cd napi && napi build --platform --release --no-dts-cache",
+    "build:napi:debug": "cd napi && napi build --platform --no-dts-cache",
     "cp-encoding-files": "mkdir -p dist/esm/encoding && cp -r src/encoding/* dist/cjs/encoding/ && mkdir -p dist/esm/encoding && cp -r src/encoding/* dist/esm/encoding/ && mkdir -p dist/types/encoding && cp -r src/encoding/* dist/types/encoding/",
+    "cp-napi-files": "mkdir -p src/napi && mkdir -p dist/cjs/napi && mkdir -p dist/esm/napi && mkdir -p dist/types/napi && cp -r napi/*.node src/napi/ 2>/dev/null || true && cp -r napi/*.node dist/cjs/napi/ 2>/dev/null || true && cp -r napi/*.node dist/esm/napi/ 2>/dev/null || true && cp -r napi/index.d.ts src/napi 2>/dev/null || true && cp -r napi/index.d.ts dist/types/napi/ 2>/dev/null || true && cp -r napi/index.js src/napi 2>/dev/null || true && cp -r napi/index.js dist/cjs/napi/ 2>/dev/null || true && cp -r napi/index.js dist/esm/napi/ 2>/dev/null || true",
     "fmt": "prettier -w .",
-    "grpc-generate": "mkdir -p src/grpc && protoc -I../yellowstone-grpc-proto/proto --plugin=node_modules/.bin/protoc-gen-ts_proto --ts_proto_opt=forceLong=string --ts_proto_opt=outputServices=grpc-js --experimental_allow_proto3_optional --ts_proto_out=src/grpc geyser.proto --ts_proto_opt=esModuleInterop=true"
+    "grpc-generate": "mkdir -p src/grpc && protoc -I../yellowstone-grpc-proto/proto --plugin=node_modules/.bin/protoc-gen-ts_proto --ts_proto_opt=forceLong=string --ts_proto_opt=outputServices=grpc-js --experimental_allow_proto3_optional --ts_proto_out=src/grpc geyser.proto --ts_proto_opt=esModuleInterop=true",
+    "test": "jest",
+    "test:debug": "jest --detectOpenHandles"
   },
   "repository": {
     "type": "git",
@@ -30,11 +35,21 @@
     "@grpc/grpc-js": "^1.8.0"
   },
   "devDependencies": {
+    "@babel/core": "^7.28.5",
     "@babel/parser": "^7.26.3",
+    "@babel/preset-env": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@napi-rs/cli": "^3.4.1",
     "@solana/rpc-api": "=2.0.0",
+    "@types/jest": "^30.0.0",
+    "babel-jest": "^30.2.0",
+    "dotenv": "^17.2.3",
+    "jest": "^30.2.0",
+    "jest-json-schema": "^6.1.0",
     "prettier": "^2.8.3",
     "recast": "^0.23.9",
-    "ts-proto": "^1.181.2",
+    "ts-jest": "^29.4.5",
+    "ts-proto": "^1.139.0",
     "typescript": "=5.2.2"
   },
   "engines": {
@@ -48,6 +63,11 @@
       "import": "./dist/esm/index.js",
       "require": "./dist/cjs/index.js",
       "types": "./dist/types/index.d.ts"
+    },
+    "./napi": {
+      "import": "./dist/esm/napi/index.js",
+      "require": "./dist/cjs/napi/index.js",
+      "types": "./dist/types/napi/index.d.ts"
     }
   }
 }