@solana/web3.js 1.53.0 → 1.55.0

package/lib/index.d.ts

@@ -19,6 +19,10 @@ declare module '@solana/web3.js' {
    * Maximum length of derived pubkey seed
    */
   export const MAX_SEED_LENGTH = 32;
+  /**
+   * Size of public key in bytes
+   */
+  export const PUBLIC_KEY_LENGTH = 32;
   /**
    * Value to be converted into public key
    */
@@ -137,7 +141,9 @@ declare module '@solana/web3.js' {
      */
     get publicKey(): PublicKey;
     /**
-     * The **unencrypted** secret key for this account
+     * The **unencrypted** secret key for this account. The first 32 bytes
+     * is the private scalar and the last 32 bytes is the public key.
+     * Read more: https://blog.mozilla.org/warner/2011/11/29/ed25519-keys/
      */
     get secretKey(): Buffer;
   }
@@ -214,17 +220,24 @@ declare module '@solana/web3.js' {
   }
 
   /**
-   * Keypair signer interface
+   * A 64 byte secret key, the first 32 bytes of which is the
+   * private scalar and the last 32 bytes is the public key.
+   * Read more: https://blog.mozilla.org/warner/2011/11/29/ed25519-keys/
    */
-  interface Signer {
-    publicKey: PublicKey;
-    secretKey: Uint8Array;
-  }
+  export type Ed25519SecretKey = Uint8Array;
   /**
    * Ed25519 Keypair
    */
   interface Ed25519Keypair {
     publicKey: Uint8Array;
+    secretKey: Ed25519SecretKey;
+  }
+
+  /**
+   * Keypair signer interface
+   */
+  interface Signer {
+    publicKey: PublicKey;
     secretKey: Uint8Array;
   }
   /**
@@ -285,6 +298,7 @@ declare module '@solana/web3.js' {
    * 8 bytes is the size of the fragment header
    */
   export const PACKET_DATA_SIZE: number;
+  export const VERSION_PREFIX_MASK = 127;
   export const SIGNATURE_LENGTH_IN_BYTES = 64;
 
   export class TransactionExpiredBlockheightExceededError extends Error {
@@ -296,6 +310,21 @@ declare module '@solana/web3.js' {
     constructor(signature: string, timeoutSeconds: number);
   }
 
+  /**
+   * An instruction to execute by a program
+   *
+   * @property {number} programIdIndex
+   * @property {number[]} accounts
+   * @property {string} data
+   */
+  export type CompiledInstruction = {
+    /** Index into the transaction keys array indicating the program account that executes this instruction */
+    programIdIndex: number;
+    /** Ordered indices into the transaction keys array indicating which accounts to pass to the program */
+    accounts: number[];
+    /** The program input data encoded as base 58 */
+    data: string;
+  };
   /**
    * Message constructor arguments
    */
@@ -319,6 +348,10 @@ declare module '@solana/web3.js' {
     instructions: CompiledInstruction[];
     private indexToProgramIds;
     constructor(args: MessageArgs);
+    get version(): 'legacy';
+    get staticAccountKeys(): Array<PublicKey>;
+    get compiledInstructions(): Array<MessageCompiledInstruction>;
+    get addressTableLookups(): Array<MessageAddressTableLookup>;
     isAccountSigner(index: number): boolean;
     isAccountWritable(index: number): boolean;
     isProgramId(index: number): boolean;
@@ -331,6 +364,41 @@ declare module '@solana/web3.js' {
     static from(buffer: Buffer | Uint8Array | Array<number>): Message;
   }
 
+  /**
+   * Message constructor arguments
+   */
+  export type MessageV0Args = {
+    /** The message header, identifying signed and read-only `accountKeys` */
+    header: MessageHeader;
+    /** The static account keys used by this transaction */
+    staticAccountKeys: PublicKey[];
+    /** The hash of a recent ledger block */
+    recentBlockhash: Blockhash;
+    /** Instructions that will be executed in sequence and committed in one atomic transaction if all succeed. */
+    compiledInstructions: MessageCompiledInstruction[];
+    /** Instructions that will be executed in sequence and committed in one atomic transaction if all succeed. */
+    addressTableLookups: MessageAddressTableLookup[];
+  };
+  export class MessageV0 {
+    header: MessageHeader;
+    staticAccountKeys: Array<PublicKey>;
+    recentBlockhash: Blockhash;
+    compiledInstructions: Array<MessageCompiledInstruction>;
+    addressTableLookups: Array<MessageAddressTableLookup>;
+    constructor(args: MessageV0Args);
+    get version(): 0;
+    serialize(): Uint8Array;
+    private serializeInstructions;
+    private serializeAddressTableLookups;
+    static deserialize(serializedMessage: Uint8Array): MessageV0;
+  }
+
+  export type VersionedMessage = Message | MessageV0;
+  export const VersionedMessage: {
+    deserializeMessageVersion(serializedMessage: Uint8Array): 'legacy' | number;
+    deserialize: (serializedMessage: Uint8Array) => VersionedMessage;
+  };
+
   /**
    * The message header, identifying signed and read-only account
    */
@@ -345,20 +413,28 @@ declare module '@solana/web3.js' {
     /** The last `numReadonlySignedAccounts` of the unsigned keys are read-only accounts */
     numReadonlyUnsignedAccounts: number;
   };
+  /**
+   * An address table lookup used to load additional accounts
+   */
+  export type MessageAddressTableLookup = {
+    accountKey: PublicKey;
+    writableIndexes: Array<number>;
+    readonlyIndexes: Array<number>;
+  };
   /**
    * An instruction to execute by a program
    *
    * @property {number} programIdIndex
-   * @property {number[]} accounts
-   * @property {string} data
+   * @property {number[]} accountKeyIndexes
+   * @property {Uint8Array} data
    */
-  export type CompiledInstruction = {
+  export type MessageCompiledInstruction = {
     /** Index into the transaction keys array indicating the program account that executes this instruction */
     programIdIndex: number;
     /** Ordered indices into the transaction keys array indicating which accounts to pass to the program */
-    accounts: number[];
-    /** The program input data encoded as base 58 */
-    data: string;
+    accountKeyIndexes: number[];
+    /** The program input data */
+    data: Uint8Array;
   };
 
   /**
@@ -578,6 +654,19 @@ declare module '@solana/web3.js' {
     static populate(message: Message, signatures?: Array<string>): Transaction;
   }
 
+  export type TransactionVersion = 'legacy' | 0;
+  /**
+   * Versioned transaction class
+   */
+  export class VersionedTransaction {
+    signatures: Array<Uint8Array>;
+    message: VersionedMessage;
+    constructor(message: VersionedMessage, signatures?: Array<Uint8Array>);
+    serialize(): Uint8Array;
+    static deserialize(serializedTransaction: Uint8Array): VersionedTransaction;
+    sign(signers: Array<Signer>): void;
+  }
+
   export type AddressLookupTableState = {
     deactivationSlot: bigint;
     lastExtendedSlot: number;
@@ -3595,6 +3684,19 @@ declare module '@solana/web3.js' {
      * Generate a transaction to withdraw from a Vote account.
      */
     static withdraw(params: WithdrawFromVoteAccountParams): Transaction;
+    /**
+     * Generate a transaction to withdraw safely from a Vote account.
+     *
+     * This function was created as a safeguard for vote accounts running validators, `safeWithdraw`
+     * checks that the withdraw amount will not exceed the specified balance while leaving enough left
+     * to cover rent. If you wish to close the vote account by withdrawing the full amount, call the
+     * `withdraw` method directly.
+     */
+    static safeWithdraw(
+      params: WithdrawFromVoteAccountParams,
+      currentVoteAccountBalance: number,
+      rentExemptMinimum: number,
+    ): Transaction;
   }
 
   export const VALIDATOR_INFO_KEY: PublicKey;