@solana/web3.js 1.40.1 → 1.41.2

package/lib/index.d.ts

@@ -338,14 +338,6 @@ declare module '@solana/web3.js' {
    * Transaction signature as base-58 encoded string
    */
   export type TransactionSignature = string;
-  /**
-   * Maximum over-the-wire size of a Transaction
-   *
-   * 1280 is IPv6 minimum MTU
-   * 40 bytes is the size of the IPv6 header
-   * 8 bytes is the size of the fragment header
-   */
-  export const PACKET_DATA_SIZE: number;
   /**
    * Account metadata used to define instructions
    */
@@ -535,6 +527,7 @@ declare module '@solana/web3.js' {
     static populate(message: Message, signatures?: Array<string>): Transaction;
   }
 
+  export type ClientSubscriptionId = number;
   export type TokenAccountsFilter =
     | {
         mint: PublicKey;
@@ -2009,13 +2002,15 @@ declare module '@solana/web3.js' {
       publicKey: PublicKey,
       callback: AccountChangeCallback,
       commitment?: Commitment,
-    ): number;
+    ): ClientSubscriptionId;
     /**
      * Deregister an account notification callback
      *
-     * @param id subscription id to deregister
+     * @param id client subscription id to deregister
      */
-    removeAccountChangeListener(id: number): Promise<void>;
+    removeAccountChangeListener(
+      clientSubscriptionId: ClientSubscriptionId,
+    ): Promise<void>;
     /**
      * Register a callback to be invoked whenever accounts owned by the
      * specified program change
@@ -2031,13 +2026,15 @@ declare module '@solana/web3.js' {
       callback: ProgramAccountChangeCallback,
       commitment?: Commitment,
       filters?: GetProgramAccountsFilter[],
-    ): number;
+    ): ClientSubscriptionId;
     /**
      * Deregister an account notification callback
      *
-     * @param id subscription id to deregister
+     * @param id client subscription id to deregister
      */
-    removeProgramAccountChangeListener(id: number): Promise<void>;
+    removeProgramAccountChangeListener(
+      clientSubscriptionId: ClientSubscriptionId,
+    ): Promise<void>;
     /**
      * Registers a callback to be invoked whenever logs are emitted.
      */
@@ -2045,26 +2042,30 @@ declare module '@solana/web3.js' {
       filter: LogsFilter,
       callback: LogsCallback,
       commitment?: Commitment,
-    ): number;
+    ): ClientSubscriptionId;
     /**
      * Deregister a logs callback.
      *
-     * @param id subscription id to deregister.
+     * @param id client subscription id to deregister.
      */
-    removeOnLogsListener(id: number): Promise<void>;
+    removeOnLogsListener(
+      clientSubscriptionId: ClientSubscriptionId,
+    ): Promise<void>;
     /**
      * Register a callback to be invoked upon slot changes
      *
      * @param callback Function to invoke whenever the slot changes
      * @return subscription id
      */
-    onSlotChange(callback: SlotChangeCallback): number;
+    onSlotChange(callback: SlotChangeCallback): ClientSubscriptionId;
     /**
      * Deregister a slot notification callback
      *
-     * @param id subscription id to deregister
+     * @param id client subscription id to deregister
      */
-    removeSlotChangeListener(id: number): Promise<void>;
+    removeSlotChangeListener(
+      clientSubscriptionId: ClientSubscriptionId,
+    ): Promise<void>;
     /**
      * Register a callback to be invoked upon slot updates. {@link SlotUpdate}'s
      * may be useful to track live progress of a cluster.
@@ -2072,13 +2073,15 @@ declare module '@solana/web3.js' {
      * @param callback Function to invoke whenever the slot updates
      * @return subscription id
      */
-    onSlotUpdate(callback: SlotUpdateCallback): number;
+    onSlotUpdate(callback: SlotUpdateCallback): ClientSubscriptionId;
     /**
      * Deregister a slot update notification callback
      *
-     * @param id subscription id to deregister
+     * @param id client subscription id to deregister
      */
-    removeSlotUpdateListener(id: number): Promise<void>;
+    removeSlotUpdateListener(
+      clientSubscriptionId: ClientSubscriptionId,
+    ): Promise<void>;
     _buildArgs(
       args: Array<any>,
       override?: Commitment,
@@ -2097,7 +2100,7 @@ declare module '@solana/web3.js' {
       signature: TransactionSignature,
       callback: SignatureResultCallback,
       commitment?: Commitment,
-    ): number;
+    ): ClientSubscriptionId;
     /**
      * Register a callback to be invoked when a transaction is
      * received and/or processed.
@@ -2112,26 +2115,30 @@ declare module '@solana/web3.js' {
       signature: TransactionSignature,
       callback: SignatureSubscriptionCallback,
       options?: SignatureSubscriptionOptions,
-    ): number;
+    ): ClientSubscriptionId;
     /**
      * Deregister a signature notification callback
      *
-     * @param id subscription id to deregister
+     * @param id client subscription id to deregister
      */
-    removeSignatureListener(id: number): Promise<void>;
+    removeSignatureListener(
+      clientSubscriptionId: ClientSubscriptionId,
+    ): Promise<void>;
     /**
      * Register a callback to be invoked upon root changes
      *
      * @param callback Function to invoke whenever the root changes
      * @return subscription id
      */
-    onRootChange(callback: RootChangeCallback): number;
+    onRootChange(callback: RootChangeCallback): ClientSubscriptionId;
     /**
      * Deregister a root notification callback
      *
-     * @param id subscription id to deregister
+     * @param id client subscription id to deregister
      */
-    removeRootChangeListener(id: number): Promise<void>;
+    removeRootChangeListener(
+      clientSubscriptionId: ClientSubscriptionId,
+    ): Promise<void>;
   }
 
   export const BPF_LOADER_PROGRAM_ID: PublicKey;
@@ -2165,6 +2172,65 @@ declare module '@solana/web3.js' {
     ): Promise<boolean>;
   }
 
+  /**
+   * Compute Budget Instruction class
+   */
+  export class ComputeBudgetInstruction {
+    /**
+     * Decode a compute budget instruction and retrieve the instruction type.
+     */
+    static decodeInstructionType(
+      instruction: TransactionInstruction,
+    ): ComputeBudgetInstructionType;
+    /**
+     * Decode request units compute budget instruction and retrieve the instruction params.
+     */
+    static decodeRequestUnits(
+      instruction: TransactionInstruction,
+    ): RequestUnitsParams;
+    /**
+     * Decode request heap frame compute budget instruction and retrieve the instruction params.
+     */
+    static decodeRequestHeapFrame(
+      instruction: TransactionInstruction,
+    ): RequestHeapFrameParams;
+  }
+  /**
+   * An enumeration of valid ComputeBudgetInstructionType's
+   */
+  export type ComputeBudgetInstructionType =
+    | 'RequestUnits'
+    | 'RequestHeapFrame';
+  /**
+   * Request units instruction params
+   */
+  interface RequestUnitsParams {
+    /** Units to request for transaction-wide compute */
+    units: number;
+    /** Additional fee to pay */
+    additionalFee: number;
+  }
+  /**
+   * Request heap frame instruction params
+   */
+  export type RequestHeapFrameParams = {
+    /** Requested transaction-wide program heap size in bytes. Must be multiple of 1024. Applies to each program, including CPIs. */
+    bytes: number;
+  };
+  /**
+   * Factory class for transaction instructions to interact with the Compute Budget program
+   */
+  export class ComputeBudgetProgram {
+    /**
+     * Public key that identifies the Compute Budget program
+     */
+    static programId: PublicKey;
+    static requestUnits(params: RequestUnitsParams): TransactionInstruction;
+    static requestHeapFrame(
+      params: RequestHeapFrameParams,
+    ): TransactionInstruction;
+  }
+
   /**
    * Params for creating an ed25519 instruction using a public key
    */