@solana/web3.js 1.40.1 → 1.41.0

package/lib/index.cjs.js

@@ -4116,6 +4116,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__namespace.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__namespace.struct([BufferLayout__namespace.u8('instruction'), BufferLayout__namespace.u32('units'), BufferLayout__namespace.u32('additionalFee')])
+  },
+  RequestHeapFrame: {
+    index: 1,
+    layout: BufferLayout__namespace.struct([BufferLayout__namespace.u8('instruction'), BufferLayout__namespace.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) {
@@ -9413,6 +9543,9 @@ exports.BLOCKHASH_CACHE_TIMEOUT_MS = BLOCKHASH_CACHE_TIMEOUT_MS;
 exports.BPF_LOADER_DEPRECATED_PROGRAM_ID = BPF_LOADER_DEPRECATED_PROGRAM_ID;
 exports.BPF_LOADER_PROGRAM_ID = BPF_LOADER_PROGRAM_ID;
 exports.BpfLoader = BpfLoader;
+exports.COMPUTE_BUDGET_INSTRUCTION_LAYOUTS = COMPUTE_BUDGET_INSTRUCTION_LAYOUTS;
+exports.ComputeBudgetInstruction = ComputeBudgetInstruction;
+exports.ComputeBudgetProgram = ComputeBudgetProgram;
 exports.Connection = Connection;
 exports.Ed25519Program = Ed25519Program;
 exports.Enum = Enum;