@solana/web3.js 1.40.1 → 1.41.0

package/lib/index.d.ts

@@ -2165,6 +2165,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
    */

package/lib/index.esm.js

@@ -4081,6 +4081,136 @@ class BpfLoader {
 
 }
 
+/**
+ * Compute Budget Instruction class
+ */
+
+class ComputeBudgetInstruction {
+  /**
+   * @internal
+   */
+  constructor() {}
+  /**
+   * Decode a compute budget instruction and retrieve the instruction type.
+   */
+
+
+  static decodeInstructionType(instruction) {
+    this.checkProgramId(instruction.programId);
+    const instructionTypeLayout = BufferLayout.u8('instruction');
+    const typeIndex = instructionTypeLayout.decode(instruction.data);
+    let type;
+
+    for (const [ixType, layout] of Object.entries(COMPUTE_BUDGET_INSTRUCTION_LAYOUTS)) {
+      if (layout.index == typeIndex) {
+        type = ixType;
+        break;
+      }
+    }
+
+    if (!type) {
+      throw new Error('Instruction type incorrect; not a ComputeBudgetInstruction');
+    }
+
+    return type;
+  }
+  /**
+   * Decode request units compute budget instruction and retrieve the instruction params.
+   */
+
+
+  static decodeRequestUnits(instruction) {
+    this.checkProgramId(instruction.programId);
+    const {
+      units,
+      additionalFee
+    } = decodeData(COMPUTE_BUDGET_INSTRUCTION_LAYOUTS.RequestUnits, instruction.data);
+    return {
+      units,
+      additionalFee
+    };
+  }
+  /**
+   * Decode request heap frame compute budget instruction and retrieve the instruction params.
+   */
+
+
+  static decodeRequestHeapFrame(instruction) {
+    this.checkProgramId(instruction.programId);
+    const {
+      bytes
+    } = decodeData(COMPUTE_BUDGET_INSTRUCTION_LAYOUTS.RequestHeapFrame, instruction.data);
+    return {
+      bytes
+    };
+  }
+  /**
+   * @internal
+   */
+
+
+  static checkProgramId(programId) {
+    if (!programId.equals(ComputeBudgetProgram.programId)) {
+      throw new Error('invalid instruction; programId is not ComputeBudgetProgram');
+    }
+  }
+
+}
+/**
+ * An enumeration of valid ComputeBudgetInstructionType's
+ */
+
+/**
+ * An enumeration of valid ComputeBudget InstructionType's
+ * @internal
+ */
+const COMPUTE_BUDGET_INSTRUCTION_LAYOUTS = Object.freeze({
+  RequestUnits: {
+    index: 0,
+    layout: BufferLayout.struct([BufferLayout.u8('instruction'), BufferLayout.u32('units'), BufferLayout.u32('additionalFee')])
+  },
+  RequestHeapFrame: {
+    index: 1,
+    layout: BufferLayout.struct([BufferLayout.u8('instruction'), BufferLayout.u32('bytes')])
+  }
+});
+/**
+ * Factory class for transaction instructions to interact with the Compute Budget program
+ */
+
+class ComputeBudgetProgram {
+  /**
+   * @internal
+   */
+  constructor() {}
+  /**
+   * Public key that identifies the Compute Budget program
+   */
+
+
+  static requestUnits(params) {
+    const type = COMPUTE_BUDGET_INSTRUCTION_LAYOUTS.RequestUnits;
+    const data = encodeData(type, params);
+    return new TransactionInstruction({
+      keys: [],
+      programId: this.programId,
+      data
+    });
+  }
+
+  static requestHeapFrame(params) {
+    const type = COMPUTE_BUDGET_INSTRUCTION_LAYOUTS.RequestHeapFrame;
+    const data = encodeData(type, params);
+    return new TransactionInstruction({
+      keys: [],
+      programId: this.programId,
+      data
+    });
+  }
+
+}
+ComputeBudgetProgram.programId = new PublicKey('ComputeBudget111111111111111111111111111111');
+
 const DESTROY_TIMEOUT_MS = 5000;
 class AgentManager {
   static _newAgent(useHttps) {
@@ -9372,5 +9502,5 @@ function clusterApiUrl(cluster, tls) {
 
 const LAMPORTS_PER_SOL = 1000000000;
 
-export { Account, Authorized, BLOCKHASH_CACHE_TIMEOUT_MS, BPF_LOADER_DEPRECATED_PROGRAM_ID, BPF_LOADER_PROGRAM_ID, BpfLoader, Connection, Ed25519Program, Enum, EpochSchedule, FeeCalculatorLayout, Keypair, LAMPORTS_PER_SOL, Loader, Lockup, MAX_SEED_LENGTH, Message, NONCE_ACCOUNT_LENGTH, NonceAccount, PACKET_DATA_SIZE, PublicKey, SOLANA_SCHEMA, STAKE_CONFIG_ID, STAKE_INSTRUCTION_LAYOUTS, SYSTEM_INSTRUCTION_LAYOUTS, SYSVAR_CLOCK_PUBKEY, SYSVAR_EPOCH_SCHEDULE_PUBKEY, SYSVAR_INSTRUCTIONS_PUBKEY, SYSVAR_RECENT_BLOCKHASHES_PUBKEY, SYSVAR_RENT_PUBKEY, SYSVAR_REWARDS_PUBKEY, SYSVAR_SLOT_HASHES_PUBKEY, SYSVAR_SLOT_HISTORY_PUBKEY, SYSVAR_STAKE_HISTORY_PUBKEY, Secp256k1Program, SendTransactionError, StakeAuthorizationLayout, StakeInstruction, StakeProgram, Struct, SystemInstruction, SystemProgram, Transaction, TransactionInstruction, VALIDATOR_INFO_KEY, VOTE_PROGRAM_ID, ValidatorInfo, VoteAccount, VoteAuthorizationLayout, VoteInit, VoteInstruction, VoteProgram, clusterApiUrl, sendAndConfirmRawTransaction, sendAndConfirmTransaction };
+export { Account, Authorized, BLOCKHASH_CACHE_TIMEOUT_MS, BPF_LOADER_DEPRECATED_PROGRAM_ID, BPF_LOADER_PROGRAM_ID, BpfLoader, COMPUTE_BUDGET_INSTRUCTION_LAYOUTS, ComputeBudgetInstruction, ComputeBudgetProgram, Connection, Ed25519Program, Enum, EpochSchedule, FeeCalculatorLayout, Keypair, LAMPORTS_PER_SOL, Loader, Lockup, MAX_SEED_LENGTH, Message, NONCE_ACCOUNT_LENGTH, NonceAccount, PACKET_DATA_SIZE, PublicKey, SOLANA_SCHEMA, STAKE_CONFIG_ID, STAKE_INSTRUCTION_LAYOUTS, SYSTEM_INSTRUCTION_LAYOUTS, SYSVAR_CLOCK_PUBKEY, SYSVAR_EPOCH_SCHEDULE_PUBKEY, SYSVAR_INSTRUCTIONS_PUBKEY, SYSVAR_RECENT_BLOCKHASHES_PUBKEY, SYSVAR_RENT_PUBKEY, SYSVAR_REWARDS_PUBKEY, SYSVAR_SLOT_HASHES_PUBKEY, SYSVAR_SLOT_HISTORY_PUBKEY, SYSVAR_STAKE_HISTORY_PUBKEY, Secp256k1Program, SendTransactionError, StakeAuthorizationLayout, StakeInstruction, StakeProgram, Struct, SystemInstruction, SystemProgram, Transaction, TransactionInstruction, VALIDATOR_INFO_KEY, VOTE_PROGRAM_ID, ValidatorInfo, VoteAccount, VoteAuthorizationLayout, VoteInit, VoteInstruction, VoteProgram, clusterApiUrl, sendAndConfirmRawTransaction, sendAndConfirmTransaction };
 //# sourceMappingURL=index.esm.js.map