@triton-one/yellowstone-grpc 4.0.2 → 5.0.1-beta

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/dist/cjs/encoding/yellowstone_grpc_solana_encoding_wasm.d.ts

@@ -2,10 +2,6 @@
 /* eslint-disable */
 export function encode_tx(data: Uint8Array, encoding: WasmUiTransactionEncoding, max_supported_transaction_version: number | null | undefined, show_rewards: boolean): string;
 export function decode_tx_error(err: Uint8Array): string;
-/**
- * Initialize Javascript logging and panic handler
- */
-export function solana_program_init(): void;
 export enum WasmUiTransactionEncoding {
   Binary = 0,
   Base64 = 1,
@@ -26,7 +22,7 @@ export class AeKey {
   /**
    * Generates a random authenticated encryption key.
    *
-   * This function is randomized. It internally samples a scalar element using `OsRng`.
+   * This function is randomized. It internally samples a 128-bit key using `OsRng`.
    */
   static newRand(): AeKey;
   /**
@@ -308,92 +304,13 @@ export class GroupedElGamalCiphertext2Handles {
   private constructor();
   free(): void;
   static encryptU64(first_pubkey: ElGamalPubkey, second_pubkey: ElGamalPubkey, amount: bigint): GroupedElGamalCiphertext2Handles;
-  static encryptionWithU64(first_pubkey: ElGamalPubkey, second_pubkey: ElGamalPubkey, amount: bigint, opening: PedersenOpening): GroupedElGamalCiphertext2Handles;
+  static encryptWithU64(first_pubkey: ElGamalPubkey, second_pubkey: ElGamalPubkey, amount: bigint, opening: PedersenOpening): GroupedElGamalCiphertext2Handles;
 }
 export class GroupedElGamalCiphertext3Handles {
   private constructor();
   free(): void;
   static encryptU64(first_pubkey: ElGamalPubkey, second_pubkey: ElGamalPubkey, third_pubkey: ElGamalPubkey, amount: bigint): GroupedElGamalCiphertext3Handles;
-  static encryptionWithU64(first_pubkey: ElGamalPubkey, second_pubkey: ElGamalPubkey, third_pubkey: ElGamalPubkey, amount: bigint, opening: PedersenOpening): GroupedElGamalCiphertext3Handles;
-}
-/**
- * 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]`
-   */
-  constructor(value: any);
-  /**
-   * Return the base58 string representation of the hash
-   */
-  toString(): string;
-  /**
-   * Checks if two `Hash`s are equal
-   */
-  equals(other: Hash): boolean;
-  /**
-   * Return the `Uint8Array` representation of the hash
-   */
-  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 {
-  private constructor();
-  free(): void;
-}
-export class Instructions {
-  free(): void;
-  constructor();
-  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`
-   */
-  toBytes(): Uint8Array;
-  /**
-   * Recover a `Keypair` from a `Uint8Array`
-   */
-  static fromBytes(bytes: Uint8Array): Keypair;
-  /**
-   * Return the `Pubkey` for this `Keypair`
-   */
-  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 {
-  private constructor();
-  free(): void;
-  /**
-   * The id of a recent ledger entry.
-   */
-  recent_blockhash: Hash;
+  static encryptWithU64(first_pubkey: ElGamalPubkey, second_pubkey: ElGamalPubkey, third_pubkey: ElGamalPubkey, amount: bigint, opening: PedersenOpening): GroupedElGamalCiphertext3Handles;
 }
 /**
  * Algorithm handle for the Pedersen commitment scheme.
@@ -426,7 +343,7 @@ export class PedersenOpening {
  * The proof consists of two main components: `percentage_max_proof` and
  * `percentage_equality_proof`. If the committed amount is greater than the maximum cap value,
  * then the `percentage_max_proof` is properly generated and `percentage_equality_proof` is
- * simulated. If the encrypted amount is smaller than the maximum cap bound, the
+ * simulated. If the committed amount is smaller than the maximum cap bound, the
  * `percentage_equality_proof` is properly generated and `percentage_max_proof` is simulated.
  */
 export class PercentageWithCapProof {
@@ -606,62 +523,6 @@ export class PodZeroCiphertextProof {
   private constructor();
   free(): void;
 }
-/**
- * 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]`
-   */
-  constructor(value: any);
-  /**
-   * Return the base58 string representation of the public key
-   */
-  toString(): string;
-  /**
-   * Check if a `Pubkey` is on the ed25519 curve.
-   */
-  isOnCurve(): boolean;
-  /**
-   * Checks if two `Pubkey`s are equal
-   */
-  equals(other: Pubkey): boolean;
-  /**
-   * Return the `Uint8Array` representation of the public key
-   */
-  toBytes(): Uint8Array;
-  /**
-   * Derive a Pubkey from another Pubkey, string seed, and a program id
-   */
-  static createWithSeed(base: Pubkey, seed: string, owner: Pubkey): Pubkey;
-  /**
-   * Derive a program address from seeds and a program id
-   */
-  static createProgramAddress(seeds: any[], program_id: Pubkey): Pubkey;
-  /**
-   * Find a valid program address
-   *
-   * Returns:
-   * * `[PubKey, number]` - the program address and bump seed
-   */
-  static findProgramAddress(seeds: any[], program_id: Pubkey): any;
-}
 /**
  * Public-key proof.
  *
@@ -706,34 +567,6 @@ export class PubkeyValidityProofData {
    */
   proof: PodPubkeyValidityProof;
 }
-/**
- * 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`
-   */
-  constructor(instructions: Instructions, payer?: Pubkey | null);
-  /**
-   * Return a message containing all data that should be signed.
-   */
-  message(): Message;
-  /**
-   * Return the serialized message data to sign.
-   */
-  messageData(): Uint8Array;
-  /**
-   * Verify the transaction
-   */
-  verify(): void;
-  partialSign(keypair: Keypair, recent_blockhash: Hash): void;
-  isSigned(): boolean;
-  toBytes(): Uint8Array;
-  static fromBytes(bytes: Uint8Array): Transaction;
-}
 /**
  * Zero-ciphertext proof.
  *
@@ -761,7 +594,7 @@ export class ZeroCiphertextProofContext {
   ciphertext: PodElGamalCiphertext;
 }
 /**
- * The instruction data that is needed for the `ProofInstruction::ZeroCiphertext` instruction.
+ * The instruction data that is needed for the `ProofInstruction::VerifyZeroCiphertext` instruction.
  *
  * It includes the cryptographic proof as well as the context data information needed to verify
  * the proof.