@solana/web3.js 1.39.1 → 1.41.0

package/lib/index.d.ts

@@ -80,6 +80,14 @@ declare module '@solana/web3.js' {
     /**
      * Derive a program address from seeds and a program ID.
      */
+    static createProgramAddressSync(
+      seeds: Array<Buffer | Uint8Array>,
+      programId: PublicKey,
+    ): PublicKey;
+    /**
+     * Async version of createProgramAddressSync
+     * For backwards compatibility
+     */
     static createProgramAddress(
       seeds: Array<Buffer | Uint8Array>,
       programId: PublicKey,
@@ -91,6 +99,14 @@ declare module '@solana/web3.js' {
      * iterates a nonce until it finds one that when combined with the seeds
      * results in a valid program address.
      */
+    static findProgramAddressSync(
+      seeds: Array<Buffer | Uint8Array>,
+      programId: PublicKey,
+    ): [PublicKey, number];
+    /**
+     * Async version of findProgramAddressSync
+     * For backwards compatibility
+     */
     static findProgramAddress(
       seeds: Array<Buffer | Uint8Array>,
       programId: PublicKey,
@@ -98,7 +114,7 @@ declare module '@solana/web3.js' {
     /**
      * Check that a pubkey is on the ed25519 curve.
      */
-    static isOnCurve(pubkey: Uint8Array): boolean;
+    static isOnCurve(pubkeyData: PublicKeyInitData): boolean;
   }
 
   /**
@@ -1807,6 +1823,14 @@ declare module '@solana/web3.js' {
       signatures: TransactionSignature[],
       commitment?: Finality,
     ): Promise<(ParsedConfirmedTransaction | null)[]>;
+    /**
+     * Fetch transaction details for a batch of confirmed transactions.
+     * Similar to {@link getParsedTransactions} but returns a {@link TransactionResponse}.
+     */
+    getTransactions(
+      signatures: TransactionSignature[],
+      commitment?: Finality,
+    ): Promise<(TransactionResponse | null)[]>;
     /**
      * Fetch a list of Transactions and transaction statuses from the cluster
      * for a confirmed block.
@@ -2141,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
    */
@@ -2460,8 +2543,8 @@ declare module '@solana/web3.js' {
      * Max space of a Stake account
      *
      * This is generated from the solana-stake-program StakeState struct as
-     * `std::mem::size_of::<StakeState>()`:
-     * https://docs.rs/solana-stake-program/1.4.4/solana_stake_program/stake_state/enum.StakeState.html
+     * `StakeState::size_of()`:
+     * https://docs.rs/solana-stake-program/latest/solana_stake_program/stake_state/enum.StakeState.html
      */
     static space: number;
     /**

package/lib/index.esm.js

@@ -1902,7 +1902,7 @@ class PublicKey extends Struct {
   /* eslint-disable require-await */
 
 
-  static async createProgramAddress(seeds, programId) {
+  static createProgramAddressSync(seeds, programId) {
     let buffer = Buffer.alloc(0);
     seeds.forEach(function (seed) {
       if (seed.length > MAX_SEED_LENGTH) {
@@ -1921,6 +1921,17 @@ class PublicKey extends Struct {
 
     return new PublicKey(publicKeyBytes);
   }
+  /**
+   * Async version of createProgramAddressSync
+   * For backwards compatibility
+   */
+
+  /* eslint-disable require-await */
+
+
+  static async createProgramAddress(seeds, programId) {
+    return this.createProgramAddressSync(seeds, programId);
+  }
   /**
    * Find a valid program address
    *
@@ -1930,14 +1941,14 @@ class PublicKey extends Struct {
    */
 
 
-  static async findProgramAddress(seeds, programId) {
+  static findProgramAddressSync(seeds, programId) {
     let nonce = 255;
     let address;
 
     while (nonce != 0) {
       try {
         const seedsWithNonce = seeds.concat(Buffer.from([nonce]));
-        address = await this.createProgramAddress(seedsWithNonce, programId);
+        address = this.createProgramAddressSync(seedsWithNonce, programId);
       } catch (err) {
         if (err instanceof TypeError) {
           throw err;
@@ -1952,13 +1963,23 @@ class PublicKey extends Struct {
 
     throw new Error(`Unable to find a viable program address nonce`);
   }
+  /**
+   * Async version of findProgramAddressSync
+   * For backwards compatibility
+   */
+
+
+  static async findProgramAddress(seeds, programId) {
+    return this.findProgramAddressSync(seeds, programId);
+  }
   /**
    * Check that a pubkey is on the ed25519 curve.
    */
 
 
-  static isOnCurve(pubkey) {
-    return is_on_curve(pubkey) == 1;
+  static isOnCurve(pubkeyData) {
+    const pubkey = new PublicKey(pubkeyData);
+    return is_on_curve(pubkey.toBytes()) == 1;
   }
 
 }
@@ -2445,13 +2466,11 @@ class Transaction {
         nonceInstruction: this.nonceInfo.nonceInstruction.toJSON()
       } : null,
       instructions: this.instructions.map(instruction => instruction.toJSON()),
-      signatures: this.signatures.map(({
-        publicKey,
-        signature
-      }) => ({
-        publicKey: publicKey.toJSON(),
-        signature: signature ? [...signature] : null
-      }))
+      signers: this.signatures.map(({
+        publicKey
+      }) => {
+        return publicKey.toJSON();
+      })
     };
   }
   /**
@@ -2483,7 +2502,7 @@ class Transaction {
   compileMessage() {
     if (this._message) {
       if (JSON.stringify(this.toJSON()) !== JSON.stringify(this._json)) {
-        throw new Error('Transaction mutated after being populated from Message');
+        throw new Error('Transaction message mutated after being populated from Message');
       }
 
       return this._message;
@@ -4062,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) {
@@ -5151,9 +5300,14 @@ const LogsNotificationResult = type({
  * Filter for log subscriptions.
  */
 
+function createSubscriptionWarningMessage(id, label) {
+  return 'Ignored unsubscribe request because an active subscription ' + `with id \`${id}\` for '${label}' events could not be found.`;
+}
 /**
  * A connection to a fullnode JSON RPC endpoint
  */
+
+
 class Connection {
   /** @internal */
 
@@ -6353,6 +6507,33 @@ class Connection {
     });
     return res;
   }
+  /**
+   * Fetch transaction details for a batch of confirmed transactions.
+   * Similar to {@link getParsedTransactions} but returns a {@link TransactionResponse}.
+   */
+
+
+  async getTransactions(signatures, commitment) {
+    const batch = signatures.map(signature => {
+      const args = this._buildArgsAtLeastConfirmed([signature], commitment);
+
+      return {
+        methodName: 'getTransaction',
+        args
+      };
+    });
+    const unsafeRes = await this._rpcBatchRequest(batch);
+    const res = unsafeRes.map(unsafeRes => {
+      const res = create(unsafeRes, GetTransactionRpcResult);
+
+      if ('error' in res) {
+        throw new Error('failed to get transactions: ' + res.error.message);
+      }
+
+      return res.result;
+    });
+    return res;
+  }
   /**
    * Fetch a list of Transactions and transaction statuses from the cluster
    * for a confirmed block.
@@ -7222,7 +7403,7 @@ class Connection {
 
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown account change id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'account change'));
     }
   }
   /**
@@ -7288,7 +7469,7 @@ class Connection {
 
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown program account change id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'program account change'));
     }
   }
   /**
@@ -7317,15 +7498,15 @@ class Connection {
 
 
   async removeOnLogsListener(id) {
-    if (!this._logsSubscriptions[id]) {
-      throw new Error(`Unknown logs id: ${id}`);
-    }
-
-    const subInfo = this._logsSubscriptions[id];
-    delete this._logsSubscriptions[id];
-    await this._unsubscribe(subInfo, 'logsUnsubscribe');
+    if (this._logsSubscriptions[id]) {
+      const subInfo = this._logsSubscriptions[id];
+      delete this._logsSubscriptions[id];
+      await this._unsubscribe(subInfo, 'logsUnsubscribe');
 
-    this._updateSubscriptions();
+      this._updateSubscriptions();
+    } else {
+      console.warn(createSubscriptionWarningMessage(id, 'logs'));
+    }
   }
   /**
    * @internal
@@ -7394,7 +7575,7 @@ class Connection {
 
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown slot change id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'slot change'));
     }
   }
   /**
@@ -7447,7 +7628,7 @@ class Connection {
 
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown slot update id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'slot update'));
     }
   }
 
@@ -7588,7 +7769,7 @@ class Connection {
 
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown signature result id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'signature result'));
     }
   }
   /**
@@ -7640,7 +7821,7 @@ class Connection {
 
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown root change id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'root change'));
     }
   }
 
@@ -9321,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