@solana/web3.js 1.7.0 → 1.7.2

package/lib/index.d.ts

@@ -13,6 +13,10 @@ declare module '@solana/web3.js' {
      * @param value ed25519 public key as buffer or base-58 encoded string
      */
     constructor(value: number | string | Buffer | Uint8Array | Array<number>);
+    /**
+     * Default public key value. (All zeros)
+     */
+    static default: PublicKey;
     /**
      * Checks if two publicKeys are equal
      */
@@ -59,6 +63,10 @@ declare module '@solana/web3.js' {
       seeds: Array<Buffer | Uint8Array>,
       programId: PublicKey,
     ): Promise<[PublicKey, number]>;
+    /**
+     * Check that a pubkey is on the ed25519 curve.
+     */
+    static isOnCurve(pubkey: Uint8Array): boolean;
   }
 
   /**
@@ -1692,6 +1700,10 @@ declare module '@solana/web3.js' {
      * Create a new Lockup object
      */
     constructor(unixTimestamp: number, epoch: number, custodian: PublicKey);
+    /**
+     * Default, inactive Lockup value
+     */
+    static default: Lockup;
   }
   /**
    * Create stake account transaction params
@@ -1704,7 +1716,7 @@ declare module '@solana/web3.js' {
     /** Authorities of the new stake account */
     authorized: Authorized;
     /** Lockup of the new stake account */
-    lockup: Lockup;
+    lockup?: Lockup;
     /** Funding amount */
     lamports: number;
   };
@@ -1717,7 +1729,7 @@ declare module '@solana/web3.js' {
     basePubkey: PublicKey;
     seed: string;
     authorized: Authorized;
-    lockup: Lockup;
+    lockup?: Lockup;
     lamports: number;
   };
   /**
@@ -1726,7 +1738,7 @@ declare module '@solana/web3.js' {
   export type InitializeStakeParams = {
     stakePubkey: PublicKey;
     authorized: Authorized;
-    lockup: Lockup;
+    lockup?: Lockup;
   };
   /**
    * Delegate stake instruction params

package/lib/index.esm.js

@@ -64,10 +64,13 @@ class PublicKey {
     }
   }
   /**
-   * Checks if two publicKeys are equal
+   * Default public key value. (All zeros)
    */
 
 
+  /**
+   * Checks if two publicKeys are equal
+   */
   equals(publicKey) {
     return this._bn.eq(publicKey._bn);
   }
@@ -172,9 +175,19 @@ class PublicKey {
 
     throw new Error("Unable to find a viable program address nonce");
   }
+  /**
+   * Check that a pubkey is on the ed25519 curve.
+   */
+
+
+  static isOnCurve(pubkey) {
+    return is_on_curve(pubkey) == 1;
+  }
 
 } // @ts-ignore
 
+_defineProperty(PublicKey, "default", new PublicKey('11111111111111111111111111111111'));
+
 let naclLowLevel = nacl__default.lowlevel; // Check that a pubkey is on the curve.
 // This function and its dependents were sourced from:
 // https://github.com/dchest/tweetnacl-js/blob/f1ec050ceae0861f34280e62498b1d3ed9c350c6/nacl.js#L792
@@ -365,6 +378,36 @@ function encodeLength(bytes, len) {
   }
 }
 
+const END_OF_BUFFER_ERROR_MESSAGE = 'Reached end of buffer unexpectedly';
+/**
+ * Delegates to `Array#shift`, but throws if the array is zero-length.
+ */
+
+function guardedShift(byteArray) {
+  if (byteArray.length === 0) {
+    throw new Error(END_OF_BUFFER_ERROR_MESSAGE);
+  }
+
+  return byteArray.shift();
+}
+/**
+ * Delegates to `Array#splice`, but throws if the section being spliced out extends past the end of
+ * the array.
+ */
+
+function guardedSplice(byteArray, ...args) {
+  var _args$;
+
+  const [start] = args;
+
+  if (args.length === 2 // Implies that `deleteCount` was supplied
+  ? start + ((_args$ = args[1]) !== null && _args$ !== void 0 ? _args$ : 0) > byteArray.length : start >= byteArray.length) {
+    throw new Error(END_OF_BUFFER_ERROR_MESSAGE);
+  }
+
+  return byteArray.splice(...args);
+}
+
 /**
  * The message header, identifying signed and read-only account
  */
@@ -449,32 +492,28 @@ class Message {
   static from(buffer) {
     // Slice up wire data
     let byteArray = [...buffer];
-    const numRequiredSignatures = byteArray.shift();
-    const numReadonlySignedAccounts = byteArray.shift();
-    const numReadonlyUnsignedAccounts = byteArray.shift();
+    const numRequiredSignatures = guardedShift(byteArray);
+    const numReadonlySignedAccounts = guardedShift(byteArray);
+    const numReadonlyUnsignedAccounts = guardedShift(byteArray);
     const accountCount = decodeLength(byteArray);
     let accountKeys = [];
 
     for (let i = 0; i < accountCount; i++) {
-      const account = byteArray.slice(0, PUBKEY_LENGTH);
-      byteArray = byteArray.slice(PUBKEY_LENGTH);
+      const account = guardedSplice(byteArray, 0, PUBKEY_LENGTH);
       accountKeys.push(bs58.encode(Buffer.from(account)));
     }
 
-    const recentBlockhash = byteArray.slice(0, PUBKEY_LENGTH);
-    byteArray = byteArray.slice(PUBKEY_LENGTH);
+    const recentBlockhash = guardedSplice(byteArray, 0, PUBKEY_LENGTH);
     const instructionCount = decodeLength(byteArray);
     let instructions = [];
 
     for (let i = 0; i < instructionCount; i++) {
-      const programIdIndex = byteArray.shift();
+      const programIdIndex = guardedShift(byteArray);
       const accountCount = decodeLength(byteArray);
-      const accounts = byteArray.slice(0, accountCount);
-      byteArray = byteArray.slice(accountCount);
+      const accounts = guardedSplice(byteArray, 0, accountCount);
       const dataLength = decodeLength(byteArray);
-      const dataSlice = byteArray.slice(0, dataLength);
+      const dataSlice = guardedSplice(byteArray, 0, dataLength);
       const data = bs58.encode(Buffer.from(dataSlice));
-      byteArray = byteArray.slice(dataLength);
       instructions.push({
         programIdIndex,
         accounts,
@@ -1094,8 +1133,7 @@ class Transaction {
     let signatures = [];
 
     for (let i = 0; i < signatureCount; i++) {
-      const signature = byteArray.slice(0, SIGNATURE_LENGTH);
-      byteArray = byteArray.slice(SIGNATURE_LENGTH);
+      const signature = guardedSplice(byteArray, 0, SIGNATURE_LENGTH);
       signatures.push(bs58.encode(Buffer.from(signature)));
     }
 
@@ -5102,12 +5140,18 @@ class Lockup {
     this.epoch = epoch;
     this.custodian = custodian;
   }
+  /**
+   * Default, inactive Lockup value
+   */
+
 
 }
 /**
  * Create stake account transaction params
  */
 
+_defineProperty(Lockup, "default", new Lockup(0, 0, PublicKey.default));
+
 /**
  * Stake Instruction class
  */
@@ -5383,8 +5427,9 @@ class StakeProgram {
     const {
       stakePubkey,
       authorized,
-      lockup
+      lockup: maybeLockup
     } = params;
+    const lockup = maybeLockup || Lockup.default;
     const type = STAKE_INSTRUCTION_LAYOUTS.Initialize;
     const data = encodeData(type, {
       authorized: {
@@ -5940,10 +5985,8 @@ class ValidatorInfo {
     const configKeys = [];
 
     for (let i = 0; i < 2; i++) {
-      const publicKey = new PublicKey(byteArray.slice(0, PUBKEY_LENGTH));
-      byteArray = byteArray.slice(PUBKEY_LENGTH);
-      const isSigner = byteArray.slice(0, 1)[0] === 1;
-      byteArray = byteArray.slice(1);
+      const publicKey = new PublicKey(guardedSplice(byteArray, 0, PUBKEY_LENGTH));
+      const isSigner = guardedShift(byteArray) === 1;
       configKeys.push({
         publicKey,
         isSigner