@triton-one/yellowstone-grpc 4.0.1 → 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.1",
+  "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,10 +35,20 @@
     "@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-jest": "^29.4.5",
     "ts-proto": "^1.139.0",
     "typescript": "=5.2.2"
   },
@@ -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"
     }
   }
 }

package/dist/encoding/yellowstone_grpc_solana_encoding_wasm.d.ts

@@ -1,228 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * @param {Uint8Array} data
- * @param {WasmUiTransactionEncoding} encoding
- * @param {number | undefined} max_supported_transaction_version
- * @param {boolean} show_rewards
- * @returns {string}
- */
-export function encode(data: Uint8Array, encoding: WasmUiTransactionEncoding, max_supported_transaction_version: number | undefined, show_rewards: boolean): string;
-/**
- * Initialize Javascript logging and panic handler
- */
-export function solana_program_init(): void;
-export enum WasmUiTransactionEncoding {
-  Binary = 0,
-  Base64 = 1,
-  Base58 = 2,
-  Json = 3,
-  JsonParsed = 4,
-}
-/**
- * A hash; the 32-byte output of a hashing algorithm.
- *
- * This struct is used most often in `solana-sdk` and related crates to contain
- * a [SHA-256] hash, but may instead contain a [blake3] hash.
- *
- * [SHA-256]: https://en.wikipedia.org/wiki/SHA-2
- * [blake3]: https://github.com/BLAKE3-team/BLAKE3
- */
-export class Hash {
-  free(): void;
-  /**
-   * Create a new Hash object
-   *
-   * * `value` - optional hash as a base58 encoded string, `Uint8Array`, `[number]`
-   * @param {any} value
-   */
-  constructor(value: any);
-  /**
-   * Return the base58 string representation of the hash
-   * @returns {string}
-   */
-  toString(): string;
-  /**
-   * Checks if two `Hash`s are equal
-   * @param {Hash} other
-   * @returns {boolean}
-   */
-  equals(other: Hash): boolean;
-  /**
-   * Return the `Uint8Array` representation of the hash
-   * @returns {Uint8Array}
-   */
-  toBytes(): Uint8Array;
-}
-/**
- * wasm-bindgen version of the Instruction struct.
- * This duplication is required until https://github.com/rustwasm/wasm-bindgen/issues/3671
- * is fixed. This must not diverge from the regular non-wasm Instruction struct.
- */
-export class Instruction {
-  free(): void;
-}
-export class Instructions {
-  free(): void;
-  constructor();
-  /**
-   * @param {Instruction} instruction
-   */
-  push(instruction: Instruction): void;
-}
-/**
- * A vanilla Ed25519 key pair
- */
-export class Keypair {
-  free(): void;
-  /**
-   * Create a new `Keypair `
-   */
-  constructor();
-  /**
-   * Convert a `Keypair` to a `Uint8Array`
-   * @returns {Uint8Array}
-   */
-  toBytes(): Uint8Array;
-  /**
-   * Recover a `Keypair` from a `Uint8Array`
-   * @param {Uint8Array} bytes
-   * @returns {Keypair}
-   */
-  static fromBytes(bytes: Uint8Array): Keypair;
-  /**
-   * Return the `Pubkey` for this `Keypair`
-   * @returns {Pubkey}
-   */
-  pubkey(): Pubkey;
-}
-/**
- * wasm-bindgen version of the Message struct.
- * This duplication is required until https://github.com/rustwasm/wasm-bindgen/issues/3671
- * is fixed. This must not diverge from the regular non-wasm Message struct.
- */
-export class Message {
-  free(): void;
-/**
- * The id of a recent ledger entry.
- */
-  recent_blockhash: Hash;
-}
-/**
- * The address of a [Solana account][acc].
- *
- * Some account addresses are [ed25519] public keys, with corresponding secret
- * keys that are managed off-chain. Often, though, account addresses do not
- * have corresponding secret keys — as with [_program derived
- * addresses_][pdas] — or the secret key is not relevant to the operation
- * of a program, and may have even been disposed of. As running Solana programs
- * can not safely create or manage secret keys, the full [`Keypair`] is not
- * defined in `solana-program` but in `solana-sdk`.
- *
- * [acc]: https://solana.com/docs/core/accounts
- * [ed25519]: https://ed25519.cr.yp.to/
- * [pdas]: https://solana.com/docs/core/cpi#program-derived-addresses
- * [`Keypair`]: https://docs.rs/solana-sdk/latest/solana_sdk/signer/keypair/struct.Keypair.html
- */
-export class Pubkey {
-  free(): void;
-  /**
-   * Create a new Pubkey object
-   *
-   * * `value` - optional public key as a base58 encoded string, `Uint8Array`, `[number]`
-   * @param {any} value
-   */
-  constructor(value: any);
-  /**
-   * Return the base58 string representation of the public key
-   * @returns {string}
-   */
-  toString(): string;
-  /**
-   * Check if a `Pubkey` is on the ed25519 curve.
-   * @returns {boolean}
-   */
-  isOnCurve(): boolean;
-  /**
-   * Checks if two `Pubkey`s are equal
-   * @param {Pubkey} other
-   * @returns {boolean}
-   */
-  equals(other: Pubkey): boolean;
-  /**
-   * Return the `Uint8Array` representation of the public key
-   * @returns {Uint8Array}
-   */
-  toBytes(): Uint8Array;
-  /**
-   * Derive a Pubkey from another Pubkey, string seed, and a program id
-   * @param {Pubkey} base
-   * @param {string} seed
-   * @param {Pubkey} owner
-   * @returns {Pubkey}
-   */
-  static createWithSeed(base: Pubkey, seed: string, owner: Pubkey): Pubkey;
-  /**
-   * Derive a program address from seeds and a program id
-   * @param {any[]} seeds
-   * @param {Pubkey} program_id
-   * @returns {Pubkey}
-   */
-  static createProgramAddress(seeds: any[], program_id: Pubkey): Pubkey;
-  /**
-   * Find a valid program address
-   *
-   * Returns:
-   * * `[PubKey, number]` - the program address and bump seed
-   * @param {any[]} seeds
-   * @param {Pubkey} program_id
-   * @returns {any}
-   */
-  static findProgramAddress(seeds: any[], program_id: Pubkey): any;
-}
-/**
- * wasm-bindgen version of the Transaction struct.
- * This duplication is required until https://github.com/rustwasm/wasm-bindgen/issues/3671
- * is fixed. This must not diverge from the regular non-wasm Transaction struct.
- */
-export class Transaction {
-  free(): void;
-  /**
-   * Create a new `Transaction`
-   * @param {Instructions} instructions
-   * @param {Pubkey | undefined} [payer]
-   */
-  constructor(instructions: Instructions, payer?: Pubkey);
-  /**
-   * Return a message containing all data that should be signed.
-   * @returns {Message}
-   */
-  message(): Message;
-  /**
-   * Return the serialized message data to sign.
-   * @returns {Uint8Array}
-   */
-  messageData(): Uint8Array;
-  /**
-   * Verify the transaction
-   */
-  verify(): void;
-  /**
-   * @param {Keypair} keypair
-   * @param {Hash} recent_blockhash
-   */
-  partialSign(keypair: Keypair, recent_blockhash: Hash): void;
-  /**
-   * @returns {boolean}
-   */
-  isSigned(): boolean;
-  /**
-   * @returns {Uint8Array}
-   */
-  toBytes(): Uint8Array;
-  /**
-   * @param {Uint8Array} bytes
-   * @returns {Transaction}
-   */
-  static fromBytes(bytes: Uint8Array): Transaction;
-}