@solana/web3.js 0.0.0-next

package/src/util/assert.ts

@@ -0,0 +1,8 @@
+export default function (
+  condition: unknown,
+  message?: string,
+): asserts condition {
+  if (!condition) {
+    throw new Error(message || 'Assertion failed');
+  }
+}

package/src/util/borsh-schema.ts

@@ -0,0 +1,38 @@
+import {Buffer} from 'buffer';
+import {serialize, deserialize, deserializeUnchecked} from 'borsh';
+
+// Class wrapping a plain object
+export class Struct {
+  constructor(properties: any) {
+    Object.assign(this, properties);
+  }
+
+  encode(): Buffer {
+    return Buffer.from(serialize(SOLANA_SCHEMA, this));
+  }
+
+  static decode(data: Buffer): any {
+    return deserialize(SOLANA_SCHEMA, this, data);
+  }
+
+  static decodeUnchecked(data: Buffer): any {
+    return deserializeUnchecked(SOLANA_SCHEMA, this, data);
+  }
+}
+
+// Class representing a Rust-compatible enum, since enums are only strings or
+// numbers in pure JS
+export class Enum extends Struct {
+  enum: string = '';
+  constructor(properties: any) {
+    super(properties);
+    if (Object.keys(properties).length !== 1) {
+      throw new Error('Enum can only take single value');
+    }
+    Object.keys(properties).map(key => {
+      this.enum = key;
+    });
+  }
+}
+
+export const SOLANA_SCHEMA: Map<Function, any> = new Map();

package/src/util/cluster.ts

@@ -0,0 +1,31 @@
+const endpoint = {
+  http: {
+    devnet: 'http://api.devnet.solana.com',
+    testnet: 'http://api.testnet.solana.com',
+    'mainnet-beta': 'http://api.mainnet-beta.solana.com/',
+  },
+  https: {
+    devnet: 'https://api.devnet.solana.com',
+    testnet: 'https://api.testnet.solana.com',
+    'mainnet-beta': 'https://api.mainnet-beta.solana.com/',
+  },
+};
+
+export type Cluster = 'devnet' | 'testnet' | 'mainnet-beta';
+
+/**
+ * Retrieves the RPC API URL for the specified cluster
+ */
+export function clusterApiUrl(cluster?: Cluster, tls?: boolean): string {
+  const key = tls === false ? 'http' : 'https';
+
+  if (!cluster) {
+    return endpoint[key]['devnet'];
+  }
+
+  const url = endpoint[key][cluster];
+  if (!url) {
+    throw new Error(`Unknown ${key} cluster: ${cluster}`);
+  }
+  return url;
+}

package/src/util/promise-timeout.ts

@@ -0,0 +1,14 @@
+export function promiseTimeout<T>(
+  promise: Promise<T>,
+  timeoutMs: number,
+): Promise<T | null> {
+  let timeoutId: ReturnType<typeof setTimeout>;
+  const timeoutPromise: Promise<null> = new Promise(resolve => {
+    timeoutId = setTimeout(() => resolve(null), timeoutMs);
+  });
+
+  return Promise.race([promise, timeoutPromise]).then((result: T | null) => {
+    clearTimeout(timeoutId);
+    return result;
+  });
+}

package/src/util/send-and-confirm-raw-transaction.ts

@@ -0,0 +1,46 @@
+import type {Buffer} from 'buffer';
+
+import {Connection} from '../connection';
+import type {TransactionSignature} from '../transaction';
+import type {ConfirmOptions} from '../connection';
+
+/**
+ * Send and confirm a raw transaction
+ *
+ * If `commitment` option is not specified, defaults to 'max' commitment.
+ *
+ * @param {Connection} connection
+ * @param {Buffer} rawTransaction
+ * @param {ConfirmOptions} [options]
+ * @returns {Promise<TransactionSignature>}
+ */
+export async function sendAndConfirmRawTransaction(
+  connection: Connection,
+  rawTransaction: Buffer,
+  options?: ConfirmOptions,
+): Promise<TransactionSignature> {
+  const sendOptions = options && {
+    skipPreflight: options.skipPreflight,
+    preflightCommitment: options.preflightCommitment || options.commitment,
+  };
+
+  const signature = await connection.sendRawTransaction(
+    rawTransaction,
+    sendOptions,
+  );
+
+  const status = (
+    await connection.confirmTransaction(
+      signature,
+      options && options.commitment,
+    )
+  ).value;
+
+  if (status.err) {
+    throw new Error(
+      `Raw transaction ${signature} failed (${JSON.stringify(status)})`,
+    );
+  }
+
+  return signature;
+}

package/src/util/send-and-confirm-transaction.ts

@@ -0,0 +1,50 @@
+import {Connection} from '../connection';
+import {Transaction} from '../transaction';
+import type {ConfirmOptions} from '../connection';
+import type {Signer} from '../keypair';
+import type {TransactionSignature} from '../transaction';
+
+/**
+ * Sign, send and confirm a transaction.
+ *
+ * If `commitment` option is not specified, defaults to 'max' commitment.
+ *
+ * @param {Connection} connection
+ * @param {Transaction} transaction
+ * @param {Array<Signer>} signers
+ * @param {ConfirmOptions} [options]
+ * @returns {Promise<TransactionSignature>}
+ */
+export async function sendAndConfirmTransaction(
+  connection: Connection,
+  transaction: Transaction,
+  signers: Array<Signer>,
+  options?: ConfirmOptions,
+): Promise<TransactionSignature> {
+  const sendOptions = options && {
+    skipPreflight: options.skipPreflight,
+    preflightCommitment: options.preflightCommitment || options.commitment,
+    maxRetries: options.maxRetries,
+  };
+
+  const signature = await connection.sendTransaction(
+    transaction,
+    signers,
+    sendOptions,
+  );
+
+  const status = (
+    await connection.confirmTransaction(
+      signature,
+      options && options.commitment,
+    )
+  ).value;
+
+  if (status.err) {
+    throw new Error(
+      `Transaction ${signature} failed (${JSON.stringify(status)})`,
+    );
+  }
+
+  return signature;
+}

package/src/util/shortvec-encoding.ts

@@ -0,0 +1,28 @@
+export function decodeLength(bytes: Array<number>): number {
+  let len = 0;
+  let size = 0;
+  for (;;) {
+    let elem = bytes.shift() as number;
+    len |= (elem & 0x7f) << (size * 7);
+    size += 1;
+    if ((elem & 0x80) === 0) {
+      break;
+    }
+  }
+  return len;
+}
+
+export function encodeLength(bytes: Array<number>, len: number) {
+  let rem_len = len;
+  for (;;) {
+    let elem = rem_len & 0x7f;
+    rem_len >>= 7;
+    if (rem_len == 0) {
+      bytes.push(elem);
+      break;
+    } else {
+      elem |= 0x80;
+      bytes.push(elem);
+    }
+  }
+}

package/src/util/sleep.ts

@@ -0,0 +1,4 @@
+// zzz
+export function sleep(ms: number): Promise<void> {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}

package/src/util/to-buffer.ts

@@ -0,0 +1,11 @@
+import {Buffer} from 'buffer';
+
+export const toBuffer = (arr: Buffer | Uint8Array | Array<number>): Buffer => {
+  if (Buffer.isBuffer(arr)) {
+    return arr;
+  } else if (arr instanceof Uint8Array) {
+    return Buffer.from(arr.buffer, arr.byteOffset, arr.byteLength);
+  } else {
+    return Buffer.from(arr);
+  }
+};

package/src/util/url.ts

@@ -0,0 +1,18 @@
+export function makeWebsocketUrl(endpoint: string) {
+  let url = new URL(endpoint);
+  const useHttps = url.protocol === 'https:';
+
+  url.protocol = useHttps ? 'wss:' : 'ws:';
+  url.host = '';
+
+  // Only shift the port by +1 as a convention for ws(s) only if given endpoint
+  // is explictly specifying the endpoint port (HTTP-based RPC), assuming
+  // we're directly trying to connect to solana-validator's ws listening port.
+  // When the endpoint omits the port, we're connecting to the protocol
+  // default ports: http(80) or https(443) and it's assumed we're behind a reverse
+  // proxy which manages WebSocket upgrade and backend port redirection.
+  if (url.port !== '') {
+    url.port = String(Number(url.port) + 1);
+  }
+  return url.toString();
+}

package/src/validator-info.ts

@@ -0,0 +1,106 @@
+import {Buffer} from 'buffer';
+import {
+  assert as assertType,
+  optional,
+  string,
+  type as pick,
+} from 'superstruct';
+
+import * as Layout from './layout';
+import * as shortvec from './util/shortvec-encoding';
+import {PublicKey} from './publickey';
+
+export const VALIDATOR_INFO_KEY = new PublicKey(
+  'Va1idator1nfo111111111111111111111111111111',
+);
+
+/**
+ * @internal
+ */
+type ConfigKey = {
+  publicKey: PublicKey;
+  isSigner: boolean;
+};
+
+/**
+ * Info used to identity validators.
+ */
+export type Info = {
+  /** validator name */
+  name: string;
+  /** optional, validator website */
+  website?: string;
+  /** optional, extra information the validator chose to share */
+  details?: string;
+  /** optional, used to identify validators on keybase.io */
+  keybaseUsername?: string;
+};
+
+const InfoString = pick({
+  name: string(),
+  website: optional(string()),
+  details: optional(string()),
+  keybaseUsername: optional(string()),
+});
+
+/**
+ * ValidatorInfo class
+ */
+export class ValidatorInfo {
+  /**
+   * validator public key
+   */
+  key: PublicKey;
+  /**
+   * validator information
+   */
+  info: Info;
+
+  /**
+   * Construct a valid ValidatorInfo
+   *
+   * @param key validator public key
+   * @param info validator information
+   */
+  constructor(key: PublicKey, info: Info) {
+    this.key = key;
+    this.info = info;
+  }
+
+  /**
+   * Deserialize ValidatorInfo from the config account data. Exactly two config
+   * keys are required in the data.
+   *
+   * @param buffer config account data
+   * @return null if info was not found
+   */
+  static fromConfigData(
+    buffer: Buffer | Uint8Array | Array<number>,
+  ): ValidatorInfo | null {
+    const PUBKEY_LENGTH = 32;
+
+    let byteArray = [...buffer];
+    const configKeyCount = shortvec.decodeLength(byteArray);
+    if (configKeyCount !== 2) return null;
+
+    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);
+      configKeys.push({publicKey, isSigner});
+    }
+
+    if (configKeys[0].publicKey.equals(VALIDATOR_INFO_KEY)) {
+      if (configKeys[1].isSigner) {
+        const rawInfo: any = Layout.rustString().decode(Buffer.from(byteArray));
+        const info = JSON.parse(rawInfo as string);
+        assertType(info, InfoString);
+        return new ValidatorInfo(configKeys[1].publicKey, info);
+      }
+    }
+
+    return null;
+  }
+}

package/src/vote-account.ts

@@ -0,0 +1,236 @@
+import * as BufferLayout from '@solana/buffer-layout';
+import type {Buffer} from 'buffer';
+
+import * as Layout from './layout';
+import {PublicKey} from './publickey';
+import {toBuffer} from './util/to-buffer';
+
+export const VOTE_PROGRAM_ID = new PublicKey(
+  'Vote111111111111111111111111111111111111111',
+);
+
+export type Lockout = {
+  slot: number;
+  confirmationCount: number;
+};
+
+/**
+ * History of how many credits earned by the end of each epoch
+ */
+export type EpochCredits = Readonly<{
+  epoch: number;
+  credits: number;
+  prevCredits: number;
+}>;
+
+export type AuthorizedVoter = Readonly<{
+  epoch: number;
+  authorizedVoter: PublicKey;
+}>;
+
+type AuthorizedVoterRaw = Readonly<{
+  authorizedVoter: Uint8Array;
+  epoch: number;
+}>;
+
+type PriorVoters = Readonly<{
+  buf: PriorVoterRaw[];
+  idx: number;
+  isEmpty: number;
+}>;
+
+export type PriorVoter = Readonly<{
+  authorizedPubkey: PublicKey;
+  epochOfLastAuthorizedSwitch: number;
+  targetEpoch: number;
+}>;
+
+type PriorVoterRaw = Readonly<{
+  authorizedPubkey: Uint8Array;
+  epochOfLastAuthorizedSwitch: number;
+  targetEpoch: number;
+}>;
+
+export type BlockTimestamp = Readonly<{
+  slot: number;
+  timestamp: number;
+}>;
+
+type VoteAccountData = Readonly<{
+  authorizedVoters: AuthorizedVoterRaw[];
+  authorizedWithdrawer: Uint8Array;
+  commission: number;
+  epochCredits: EpochCredits[];
+  lastTimestamp: BlockTimestamp;
+  nodePubkey: Uint8Array;
+  priorVoters: PriorVoters;
+  rootSlot: number;
+  rootSlotValid: number;
+  votes: Lockout[];
+}>;
+
+/**
+ * See https://github.com/solana-labs/solana/blob/8a12ed029cfa38d4a45400916c2463fb82bbec8c/programs/vote_api/src/vote_state.rs#L68-L88
+ *
+ * @internal
+ */
+const VoteAccountLayout = BufferLayout.struct<VoteAccountData>([
+  Layout.publicKey('nodePubkey'),
+  Layout.publicKey('authorizedWithdrawer'),
+  BufferLayout.u8('commission'),
+  BufferLayout.nu64(), // votes.length
+  BufferLayout.seq<Lockout>(
+    BufferLayout.struct([
+      BufferLayout.nu64('slot'),
+      BufferLayout.u32('confirmationCount'),
+    ]),
+    BufferLayout.offset(BufferLayout.u32(), -8),
+    'votes',
+  ),
+  BufferLayout.u8('rootSlotValid'),
+  BufferLayout.nu64('rootSlot'),
+  BufferLayout.nu64(), // authorizedVoters.length
+  BufferLayout.seq<AuthorizedVoterRaw>(
+    BufferLayout.struct([
+      BufferLayout.nu64('epoch'),
+      Layout.publicKey('authorizedVoter'),
+    ]),
+    BufferLayout.offset(BufferLayout.u32(), -8),
+    'authorizedVoters',
+  ),
+  BufferLayout.struct<PriorVoters>(
+    [
+      BufferLayout.seq(
+        BufferLayout.struct([
+          Layout.publicKey('authorizedPubkey'),
+          BufferLayout.nu64('epochOfLastAuthorizedSwitch'),
+          BufferLayout.nu64('targetEpoch'),
+        ]),
+        32,
+        'buf',
+      ),
+      BufferLayout.nu64('idx'),
+      BufferLayout.u8('isEmpty'),
+    ],
+    'priorVoters',
+  ),
+  BufferLayout.nu64(), // epochCredits.length
+  BufferLayout.seq<EpochCredits>(
+    BufferLayout.struct([
+      BufferLayout.nu64('epoch'),
+      BufferLayout.nu64('credits'),
+      BufferLayout.nu64('prevCredits'),
+    ]),
+    BufferLayout.offset(BufferLayout.u32(), -8),
+    'epochCredits',
+  ),
+  BufferLayout.struct<BlockTimestamp>(
+    [BufferLayout.nu64('slot'), BufferLayout.nu64('timestamp')],
+    'lastTimestamp',
+  ),
+]);
+
+type VoteAccountArgs = {
+  nodePubkey: PublicKey;
+  authorizedWithdrawer: PublicKey;
+  commission: number;
+  rootSlot: number | null;
+  votes: Lockout[];
+  authorizedVoters: AuthorizedVoter[];
+  priorVoters: PriorVoter[];
+  epochCredits: EpochCredits[];
+  lastTimestamp: BlockTimestamp;
+};
+
+/**
+ * VoteAccount class
+ */
+export class VoteAccount {
+  nodePubkey: PublicKey;
+  authorizedWithdrawer: PublicKey;
+  commission: number;
+  rootSlot: number | null;
+  votes: Lockout[];
+  authorizedVoters: AuthorizedVoter[];
+  priorVoters: PriorVoter[];
+  epochCredits: EpochCredits[];
+  lastTimestamp: BlockTimestamp;
+
+  /**
+   * @internal
+   */
+  constructor(args: VoteAccountArgs) {
+    this.nodePubkey = args.nodePubkey;
+    this.authorizedWithdrawer = args.authorizedWithdrawer;
+    this.commission = args.commission;
+    this.rootSlot = args.rootSlot;
+    this.votes = args.votes;
+    this.authorizedVoters = args.authorizedVoters;
+    this.priorVoters = args.priorVoters;
+    this.epochCredits = args.epochCredits;
+    this.lastTimestamp = args.lastTimestamp;
+  }
+
+  /**
+   * Deserialize VoteAccount from the account data.
+   *
+   * @param buffer account data
+   * @return VoteAccount
+   */
+  static fromAccountData(
+    buffer: Buffer | Uint8Array | Array<number>,
+  ): VoteAccount {
+    const versionOffset = 4;
+    const va = VoteAccountLayout.decode(toBuffer(buffer), versionOffset);
+
+    let rootSlot: number | null = va.rootSlot;
+    if (!va.rootSlotValid) {
+      rootSlot = null;
+    }
+
+    return new VoteAccount({
+      nodePubkey: new PublicKey(va.nodePubkey),
+      authorizedWithdrawer: new PublicKey(va.authorizedWithdrawer),
+      commission: va.commission,
+      votes: va.votes,
+      rootSlot,
+      authorizedVoters: va.authorizedVoters.map(parseAuthorizedVoter),
+      priorVoters: getPriorVoters(va.priorVoters),
+      epochCredits: va.epochCredits,
+      lastTimestamp: va.lastTimestamp,
+    });
+  }
+}
+
+function parseAuthorizedVoter({
+  authorizedVoter,
+  epoch,
+}: AuthorizedVoterRaw): AuthorizedVoter {
+  return {
+    epoch,
+    authorizedVoter: new PublicKey(authorizedVoter),
+  };
+}
+
+function parsePriorVoters({
+  authorizedPubkey,
+  epochOfLastAuthorizedSwitch,
+  targetEpoch,
+}: PriorVoterRaw): PriorVoter {
+  return {
+    authorizedPubkey: new PublicKey(authorizedPubkey),
+    epochOfLastAuthorizedSwitch,
+    targetEpoch,
+  };
+}
+
+function getPriorVoters({buf, idx, isEmpty}: PriorVoters): PriorVoter[] {
+  if (isEmpty) {
+    return [];
+  }
+
+  return [
+    ...buf.slice(idx + 1).map(parsePriorVoters),
+    ...buf.slice(0, idx).map(parsePriorVoters),
+  ];
+}