@solana/web3.js 1.7.0 → 1.7.2

package/module.flow.js

@@ -1,7 +1,7 @@
 /**
  * Flowtype definitions for index
  * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.14.0
+ * Flowgen v1.14.1
  */
 
 declare module "@solana/web3.js" {
@@ -22,6 +22,11 @@ declare module "@solana/web3.js" {
       value: number | string | Buffer | Uint8Array | Array<number>
     ): this;
 
+    /**
+     * Default public key value. (All zeros)
+     */
+    static default: PublicKey;
+
     /**
      * Checks if two publicKeys are equal
      */
@@ -75,6 +80,11 @@ 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;
   }
 
   /**
@@ -2390,6 +2400,11 @@ feeCalculator: FeeCalculator,...
       epoch: number,
       custodian: PublicKey
     ): this;
+
+    /**
+     * Default, inactive Lockup value
+     */
+    static default: Lockup;
   }
 
   /**
@@ -2414,7 +2429,7 @@ feeCalculator: FeeCalculator,...
     /**
      * Lockup of the new stake account
      */
-    lockup: Lockup,
+    lockup?: Lockup,
 
     /**
      * Funding amount
@@ -2432,7 +2447,7 @@ feeCalculator: FeeCalculator,...
     basePubkey: PublicKey,
     seed: string,
     authorized: Authorized,
-    lockup: Lockup,
+    lockup?: Lockup,
     lamports: number,
     ...
   };
@@ -2443,7 +2458,7 @@ feeCalculator: FeeCalculator,...
   declare export type InitializeStakeParams = {
     stakePubkey: PublicKey,
     authorized: Authorized,
-    lockup: Lockup,
+    lockup?: Lockup,
     ...
   };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/web3.js",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "Solana Javascript API",
   "keywords": [
     "api",
@@ -36,32 +36,6 @@
     "/module.flow.js",
     "/src"
   ],
-  "scripts": {
-    "build": "npm run clean; cross-env NODE_ENV=production rollup -c; npm run generate:dts; npm run generate:flow",
-    "build:browser-test": "rollup -c test/rollup.config.js",
-    "build:fixtures": "set -ex; ./test/fixtures/noop-program/build.sh",
-    "clean": "rimraf ./coverage ./lib",
-    "codecov": "set -ex; npm run test:cover; cat ./coverage/lcov.info | codecov",
-    "dev": "cross-env NODE_ENV=development rollup -c",
-    "doc": "set -ex; typedoc",
-    "doc:watch": "watch 'npm run doc' . --wait=1 --ignoreDirectoryPattern=/doc/",
-    "generate:dts": "./scripts/typegen.sh",
-    "generate:flow": "flowgen lib/index.d.ts -o module.flow.js",
-    "lint": "set -ex; npm run pretty; eslint . --ext .js,.ts",
-    "lint:fix": "npm run pretty:fix && eslint . --fix",
-    "lint:watch": "watch 'npm run lint:fix' . --wait=1 --ignoreDirectoryPattern=/doc/",
-    "ok": "run-s lint test doc",
-    "pretty": "prettier --check '{,{src,test}/**/}*.{j,t}s'",
-    "pretty:fix": "prettier --write '{,{src,test}/**/}*.{j,t}s'",
-    "re": "semantic-release --repository-url git@github.com:solana-labs/solana-web3.js.git",
-    "test": "mocha -r ts-node/register './test/**/*.test.ts'",
-    "test:cover": "TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' nyc --reporter=lcov mocha -r ts-node/register './test/**/*.test.ts'",
-    "test:browser": "TEST_LIVE=1 npm run build:browser-test && mocha-headless-chrome -f http://localhost:8080/mocha.html --timeout 180000",
-    "test:browser-with-server": "start-server-and-test 'http-server -p 8080' 8080 test:browser",
-    "test:browser-with-test-validator": "start-server-and-test 'solana-test-validator --reset --quiet' http://localhost:8899/health test:browser-with-server",
-    "test:live": "TEST_LIVE=1 npm run test",
-    "test:live-with-test-validator": "start-server-and-test 'solana-test-validator --reset --quiet' http://localhost:8899/health test:live"
-  },
   "dependencies": {
     "@babel/runtime": "^7.12.5",
     "bn.js": "^5.0.0",
@@ -100,7 +74,7 @@
     "@types/chai-as-promised": "^7.1.3",
     "@types/mocha": "^8.2.1",
     "@types/mz": "^2.7.3",
-    "@types/node": "^14.14.26",
+    "@types/node": "^15.0.0",
     "@types/node-fetch": "^2.5.8",
     "@types/secp256k1": "^4.0.1",
     "@types/sinon": "^10.0.0",
@@ -126,7 +100,7 @@
     "nyc": "^15.1.0",
     "prettier": "^2.0.0",
     "rimraf": "3.0.2",
-    "rollup": "2.45.2",
+    "rollup": "2.46.0",
     "rollup-plugin-dts": "^3.0.1",
     "rollup-plugin-node-polyfills": "^0.2.1",
     "rollup-plugin-terser": "^7.0.2",
@@ -138,5 +112,31 @@
     "typedoc": "^0.20.31",
     "typescript": "^4.1.5",
     "watch": "^1.0.2"
+  },
+  "scripts": {
+    "build": "npm run clean; cross-env NODE_ENV=production rollup -c; npm run generate:dts; npm run generate:flow",
+    "build:browser-test": "rollup -c test/rollup.config.js",
+    "build:fixtures": "set -ex; ./test/fixtures/noop-program/build.sh",
+    "clean": "rimraf ./coverage ./lib",
+    "codecov": "set -ex; npm run test:cover; cat ./coverage/lcov.info | codecov",
+    "dev": "cross-env NODE_ENV=development rollup -c",
+    "doc": "set -ex; typedoc",
+    "doc:watch": "watch 'npm run doc' . --wait=1 --ignoreDirectoryPattern=/doc/",
+    "generate:dts": "./scripts/typegen.sh",
+    "generate:flow": "flowgen lib/index.d.ts -o module.flow.js",
+    "lint": "set -ex; npm run pretty; eslint . --ext .js,.ts",
+    "lint:fix": "npm run pretty:fix && eslint . --fix",
+    "lint:watch": "watch 'npm run lint:fix' . --wait=1 --ignoreDirectoryPattern=/doc/",
+    "ok": "run-s lint test doc",
+    "pretty": "prettier --check '{,{src,test}/**/}*.{j,t}s'",
+    "pretty:fix": "prettier --write '{,{src,test}/**/}*.{j,t}s'",
+    "re": "semantic-release --repository-url git@github.com:solana-labs/solana-web3.js.git",
+    "test": "mocha -r ts-node/register './test/**/*.test.ts'",
+    "test:cover": "TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' nyc --reporter=lcov mocha -r ts-node/register './test/**/*.test.ts'",
+    "test:browser": "TEST_LIVE=1 npm run build:browser-test && mocha-headless-chrome -f http://localhost:8080/mocha.html --timeout 180000",
+    "test:browser-with-server": "start-server-and-test 'http-server -p 8080' 8080 test:browser",
+    "test:browser-with-test-validator": "start-server-and-test 'solana-test-validator --reset --quiet' http://localhost:8899/health test:browser-with-server",
+    "test:live": "TEST_LIVE=1 npm run test",
+    "test:live-with-test-validator": "start-server-and-test 'solana-test-validator --reset --quiet' http://localhost:8899/health test:live"
   }
-}
+}

package/src/message.ts

@@ -8,6 +8,7 @@ import * as Layout from './layout';
 import {PACKET_DATA_SIZE} from './transaction';
 import * as shortvec from './util/shortvec-encoding';
 import {toBuffer} from './util/to-buffer';
+import {guardedShift, guardedSplice} from './util/guarded-array-utils';
 
 /**
  * The message header, identifying signed and read-only account
@@ -178,32 +179,28 @@ export class Message {
     // Slice up wire data
     let byteArray = [...buffer];
 
-    const numRequiredSignatures = byteArray.shift() as number;
-    const numReadonlySignedAccounts = byteArray.shift() as number;
-    const numReadonlyUnsignedAccounts = byteArray.shift() as number;
+    const numRequiredSignatures = guardedShift(byteArray);
+    const numReadonlySignedAccounts = guardedShift(byteArray);
+    const numReadonlyUnsignedAccounts = guardedShift(byteArray);
 
     const accountCount = shortvec.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 = shortvec.decodeLength(byteArray);
     let instructions: CompiledInstruction[] = [];
     for (let i = 0; i < instructionCount; i++) {
-      const programIdIndex = byteArray.shift() as number;
+      const programIdIndex = guardedShift(byteArray);
       const accountCount = shortvec.decodeLength(byteArray);
-      const accounts = byteArray.slice(0, accountCount);
-      byteArray = byteArray.slice(accountCount);
+      const accounts = guardedSplice(byteArray, 0, accountCount);
       const dataLength = shortvec.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,

package/src/publickey.ts

@@ -39,6 +39,11 @@ export class PublicKey {
     }
   }
 
+  /**
+   * Default public key value. (All zeros)
+   */
+  static default: PublicKey = new PublicKey('11111111111111111111111111111111');
+
   /**
    * Checks if two publicKeys are equal
    */
@@ -150,6 +155,13 @@ export 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: Uint8Array): boolean {
+    return is_on_curve(pubkey) == 1;
+  }
 }
 
 // @ts-ignore

package/src/stake-program.ts

@@ -59,6 +59,11 @@ export class Lockup {
     this.epoch = epoch;
     this.custodian = custodian;
   }
+
+  /**
+   * Default, inactive Lockup value
+   */
+  static default: Lockup = new Lockup(0, 0, PublicKey.default);
 }
 
 /**
@@ -72,7 +77,7 @@ export type CreateStakeAccountParams = {
   /** Authorities of the new stake account */
   authorized: Authorized;
   /** Lockup of the new stake account */
-  lockup: Lockup;
+  lockup?: Lockup;
   /** Funding amount */
   lamports: number;
 };
@@ -86,7 +91,7 @@ export type CreateStakeAccountWithSeedParams = {
   basePubkey: PublicKey;
   seed: string;
   authorized: Authorized;
-  lockup: Lockup;
+  lockup?: Lockup;
   lamports: number;
 };
 
@@ -96,7 +101,7 @@ export type CreateStakeAccountWithSeedParams = {
 export type InitializeStakeParams = {
   stakePubkey: PublicKey;
   authorized: Authorized;
-  lockup: Lockup;
+  lockup?: Lockup;
 };
 
 /**
@@ -502,7 +507,8 @@ export class StakeProgram {
    * Generate an Initialize instruction to add to a Stake Create transaction
    */
   static initialize(params: InitializeStakeParams): TransactionInstruction {
-    const {stakePubkey, authorized, lockup} = params;
+    const {stakePubkey, authorized, lockup: maybeLockup} = params;
+    const lockup: Lockup = maybeLockup || Lockup.default;
     const type = STAKE_INSTRUCTION_LAYOUTS.Initialize;
     const data = encodeData(type, {
       authorized: {

package/src/transaction.ts

@@ -10,6 +10,7 @@ import {Account} from './account';
 import * as shortvec from './util/shortvec-encoding';
 import type {Blockhash} from './blockhash';
 import {toBuffer} from './util/to-buffer';
+import {guardedSplice} from './util/guarded-array-utils';
 
 /**
  * Transaction signature as base-58 encoded string
@@ -655,8 +656,7 @@ export class Transaction {
     const signatureCount = shortvec.decodeLength(byteArray);
     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)));
     }
 

package/src/util/guarded-array-utils.ts

@@ -0,0 +1,37 @@
+const END_OF_BUFFER_ERROR_MESSAGE = 'Reached end of buffer unexpectedly';
+
+/**
+ * Delegates to `Array#shift`, but throws if the array is zero-length.
+ */
+export function guardedShift<T>(byteArray: T[]): T {
+  if (byteArray.length === 0) {
+    throw new Error(END_OF_BUFFER_ERROR_MESSAGE);
+  }
+  return byteArray.shift() as T;
+}
+
+/**
+ * Delegates to `Array#splice`, but throws if the section being spliced out extends past the end of
+ * the array.
+ */
+export function guardedSplice<T>(
+  byteArray: T[],
+  ...args:
+    | [start: number, deleteCount?: number]
+    | [start: number, deleteCount: number, ...items: T[]]
+): T[] {
+  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 as Parameters<typeof Array.prototype.splice>),
+  );
+}

package/src/validator-info.ts

@@ -9,6 +9,7 @@ import {
 import * as Layout from './layout';
 import * as shortvec from './util/shortvec-encoding';
 import {PublicKey} from './publickey';
+import {guardedShift, guardedSplice} from './util/guarded-array-utils';
 
 export const VALIDATOR_INFO_KEY = new PublicKey(
   'Va1idator1nfo111111111111111111111111111111',
@@ -85,10 +86,10 @@ export class ValidatorInfo {
 
     const configKeys: Array<ConfigKey> = [];
     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});
     }