@solana/web3.js 1.78.0 → 2.0.0-development

package/src/publickey.ts

@@ -1,259 +0,0 @@
-import BN from 'bn.js';
-import bs58 from 'bs58';
-import {Buffer} from 'buffer';
-import {sha256} from '@noble/hashes/sha256';
-
-import {isOnCurve} from './utils/ed25519';
-import {Struct, SOLANA_SCHEMA} from './utils/borsh-schema';
-import {toBuffer} from './utils/to-buffer';
-
-/**
- * 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
- */
-export type PublicKeyInitData =
-  | number
-  | string
-  | Uint8Array
-  | Array<number>
-  | PublicKeyData;
-
-/**
- * JSON object representation of PublicKey class
- */
-export type PublicKeyData = {
-  /** @internal */
-  _bn: BN;
-};
-
-function isPublicKeyData(value: PublicKeyInitData): value is PublicKeyData {
-  return (value as PublicKeyData)._bn !== undefined;
-}
-
-// local counter used by PublicKey.unique()
-let uniquePublicKeyCounter = 1;
-
-/**
- * A public key
- */
-export class PublicKey extends Struct {
-  /** @internal */
-  _bn: BN;
-
-  /**
-   * Create a new PublicKey object
-   * @param value ed25519 public key as buffer or base-58 encoded string
-   */
-  constructor(value: PublicKeyInitData) {
-    super({});
-    if (isPublicKeyData(value)) {
-      this._bn = value._bn;
-    } else {
-      if (typeof value === 'string') {
-        // assume base 58 encoding by default
-        const decoded = bs58.decode(value);
-        if (decoded.length != PUBLIC_KEY_LENGTH) {
-          throw new Error(`Invalid public key input`);
-        }
-        this._bn = new BN(decoded);
-      } else {
-        this._bn = new BN(value);
-      }
-
-      if (this._bn.byteLength() > PUBLIC_KEY_LENGTH) {
-        throw new Error(`Invalid public key input`);
-      }
-    }
-  }
-
-  /**
-   * Returns a unique PublicKey for tests and benchmarks using a counter
-   */
-  static unique(): PublicKey {
-    const key = new PublicKey(uniquePublicKeyCounter);
-    uniquePublicKeyCounter += 1;
-    return new PublicKey(key.toBuffer());
-  }
-
-  /**
-   * Default public key value. The base58-encoded string representation is all ones (as seen below)
-   * The underlying BN number is 32 bytes that are all zeros
-   */
-  static default: PublicKey = new PublicKey('11111111111111111111111111111111');
-
-  /**
-   * Checks if two publicKeys are equal
-   */
-  equals(publicKey: PublicKey): boolean {
-    return this._bn.eq(publicKey._bn);
-  }
-
-  /**
-   * Return the base-58 representation of the public key
-   */
-  toBase58(): string {
-    return bs58.encode(this.toBytes());
-  }
-
-  toJSON(): string {
-    return this.toBase58();
-  }
-
-  /**
-   * Return the byte array representation of the public key in big endian
-   */
-  toBytes(): Uint8Array {
-    const buf = this.toBuffer();
-    return new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
-  }
-
-  /**
-   * Return the Buffer representation of the public key in big endian
-   */
-  toBuffer(): Buffer {
-    const b = this._bn.toArrayLike(Buffer);
-    if (b.length === PUBLIC_KEY_LENGTH) {
-      return b;
-    }
-
-    const zeroPad = Buffer.alloc(32);
-    b.copy(zeroPad, 32 - b.length);
-    return zeroPad;
-  }
-
-  get [Symbol.toStringTag](): string {
-    return `PublicKey(${this.toString()})`;
-  }
-
-  /**
-   * Return the base-58 representation of the public key
-   */
-  toString(): string {
-    return this.toBase58();
-  }
-
-  /**
-   * Derive a public key from another key, a seed, and a program ID.
-   * The program ID will also serve as the owner of the public key, giving
-   * it permission to write data to the account.
-   */
-  /* eslint-disable require-await */
-  static async createWithSeed(
-    fromPublicKey: PublicKey,
-    seed: string,
-    programId: PublicKey,
-  ): Promise<PublicKey> {
-    const buffer = Buffer.concat([
-      fromPublicKey.toBuffer(),
-      Buffer.from(seed),
-      programId.toBuffer(),
-    ]);
-    const publicKeyBytes = sha256(buffer);
-    return new PublicKey(publicKeyBytes);
-  }
-
-  /**
-   * Derive a program address from seeds and a program ID.
-   */
-  /* eslint-disable require-await */
-  static createProgramAddressSync(
-    seeds: Array<Buffer | Uint8Array>,
-    programId: PublicKey,
-  ): PublicKey {
-    let buffer = Buffer.alloc(0);
-    seeds.forEach(function (seed) {
-      if (seed.length > MAX_SEED_LENGTH) {
-        throw new TypeError(`Max seed length exceeded`);
-      }
-      buffer = Buffer.concat([buffer, toBuffer(seed)]);
-    });
-    buffer = Buffer.concat([
-      buffer,
-      programId.toBuffer(),
-      Buffer.from('ProgramDerivedAddress'),
-    ]);
-    const publicKeyBytes = sha256(buffer);
-    if (isOnCurve(publicKeyBytes)) {
-      throw new Error(`Invalid seeds, address must fall off the curve`);
-    }
-    return new PublicKey(publicKeyBytes);
-  }
-
-  /**
-   * Async version of createProgramAddressSync
-   * For backwards compatibility
-   *
-   * @deprecated Use {@link createProgramAddressSync} instead
-   */
-  /* eslint-disable require-await */
-  static async createProgramAddress(
-    seeds: Array<Buffer | Uint8Array>,
-    programId: PublicKey,
-  ): Promise<PublicKey> {
-    return this.createProgramAddressSync(seeds, programId);
-  }
-
-  /**
-   * Find a valid program address
-   *
-   * Valid program addresses must fall off the ed25519 curve.  This function
-   * 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] {
-    let nonce = 255;
-    let address;
-    while (nonce != 0) {
-      try {
-        const seedsWithNonce = seeds.concat(Buffer.from([nonce]));
-        address = this.createProgramAddressSync(seedsWithNonce, programId);
-      } catch (err) {
-        if (err instanceof TypeError) {
-          throw err;
-        }
-        nonce--;
-        continue;
-      }
-      return [address, nonce];
-    }
-    throw new Error(`Unable to find a viable program address nonce`);
-  }
-
-  /**
-   * Async version of findProgramAddressSync
-   * For backwards compatibility
-   *
-   * @deprecated Use {@link findProgramAddressSync} instead
-   */
-  static async findProgramAddress(
-    seeds: Array<Buffer | Uint8Array>,
-    programId: PublicKey,
-  ): Promise<[PublicKey, number]> {
-    return this.findProgramAddressSync(seeds, programId);
-  }
-
-  /**
-   * Check that a pubkey is on the ed25519 curve.
-   */
-  static isOnCurve(pubkeyData: PublicKeyInitData): boolean {
-    const pubkey = new PublicKey(pubkeyData);
-    return isOnCurve(pubkey.toBytes());
-  }
-}
-
-SOLANA_SCHEMA.set(PublicKey, {
-  kind: 'struct',
-  fields: [['_bn', 'u256']],
-});

package/src/rpc-websocket-factory.ts

@@ -1,4 +0,0 @@
-import {ICommonWebSocketFactory} from 'rpc-websockets/dist/lib/client/client.types';
-import WebsocketFactory from 'rpc-websockets/dist/lib/client/websocket';
-
-export default WebsocketFactory as ICommonWebSocketFactory;

package/src/rpc-websocket.ts

@@ -1,79 +0,0 @@
-import RpcWebSocketCommonClient from 'rpc-websockets/dist/lib/client';
-import RpcWebSocketBrowserFactory from 'rpc-websockets/dist/lib/client/websocket.browser';
-import {
-  ICommonWebSocket,
-  IWSClientAdditionalOptions,
-  NodeWebSocketType,
-  NodeWebSocketTypeOptions,
-} from 'rpc-websockets/dist/lib/client/client.types';
-
-import createRpc from './rpc-websocket-factory';
-
-interface IHasReadyState {
-  readyState: WebSocket['readyState'];
-}
-
-export default class RpcWebSocketClient extends RpcWebSocketCommonClient {
-  private underlyingSocket: IHasReadyState | undefined;
-  constructor(
-    address?: string,
-    options?: IWSClientAdditionalOptions & NodeWebSocketTypeOptions,
-    generate_request_id?: (
-      method: string,
-      params: object | Array<any>,
-    ) => number,
-  ) {
-    const webSocketFactory = (url: string) => {
-      const rpc = createRpc(url, {
-        autoconnect: true,
-        max_reconnects: 5,
-        reconnect: true,
-        reconnect_interval: 1000,
-        ...options,
-      });
-      if ('socket' in rpc) {
-        this.underlyingSocket = (
-          rpc as ReturnType<typeof RpcWebSocketBrowserFactory>
-        ).socket;
-      } else {
-        this.underlyingSocket = rpc as NodeWebSocketType;
-      }
-      return rpc as ICommonWebSocket;
-    };
-    super(webSocketFactory, address, options, generate_request_id);
-  }
-  call(
-    ...args: Parameters<RpcWebSocketCommonClient['call']>
-  ): ReturnType<RpcWebSocketCommonClient['call']> {
-    const readyState = this.underlyingSocket?.readyState;
-    if (readyState === 1 /* WebSocket.OPEN */) {
-      return super.call(...args);
-    }
-    return Promise.reject(
-      new Error(
-        'Tried to call a JSON-RPC method `' +
-          args[0] +
-          '` but the socket was not `CONNECTING` or `OPEN` (`readyState` was ' +
-          readyState +
-          ')',
-      ),
-    );
-  }
-  notify(
-    ...args: Parameters<RpcWebSocketCommonClient['notify']>
-  ): ReturnType<RpcWebSocketCommonClient['notify']> {
-    const readyState = this.underlyingSocket?.readyState;
-    if (readyState === 1 /* WebSocket.OPEN */) {
-      return super.notify(...args);
-    }
-    return Promise.reject(
-      new Error(
-        'Tried to send a JSON-RPC notification `' +
-          args[0] +
-          '` but the socket was not `CONNECTING` or `OPEN` (`readyState` was ' +
-          readyState +
-          ')',
-      ),
-    );
-  }
-}

package/src/sysvar.ts

@@ -1,37 +0,0 @@
-import {PublicKey} from './publickey';
-
-export const SYSVAR_CLOCK_PUBKEY = new PublicKey(
-  'SysvarC1ock11111111111111111111111111111111',
-);
-
-export const SYSVAR_EPOCH_SCHEDULE_PUBKEY = new PublicKey(
-  'SysvarEpochSchedu1e111111111111111111111111',
-);
-
-export const SYSVAR_INSTRUCTIONS_PUBKEY = new PublicKey(
-  'Sysvar1nstructions1111111111111111111111111',
-);
-
-export const SYSVAR_RECENT_BLOCKHASHES_PUBKEY = new PublicKey(
-  'SysvarRecentB1ockHashes11111111111111111111',
-);
-
-export const SYSVAR_RENT_PUBKEY = new PublicKey(
-  'SysvarRent111111111111111111111111111111111',
-);
-
-export const SYSVAR_REWARDS_PUBKEY = new PublicKey(
-  'SysvarRewards111111111111111111111111111111',
-);
-
-export const SYSVAR_SLOT_HASHES_PUBKEY = new PublicKey(
-  'SysvarS1otHashes111111111111111111111111111',
-);
-
-export const SYSVAR_SLOT_HISTORY_PUBKEY = new PublicKey(
-  'SysvarS1otHistory11111111111111111111111111',
-);
-
-export const SYSVAR_STAKE_HISTORY_PUBKEY = new PublicKey(
-  'SysvarStakeHistory1111111111111111111111111',
-);

package/src/timing.ts

@@ -1,23 +0,0 @@
-// TODO: These constants should be removed in favor of reading them out of a
-// Syscall account
-
-/**
- * @internal
- */
-export const NUM_TICKS_PER_SECOND = 160;
-
-/**
- * @internal
- */
-export const DEFAULT_TICKS_PER_SLOT = 64;
-
-/**
- * @internal
- */
-export const NUM_SLOTS_PER_SECOND =
-  NUM_TICKS_PER_SECOND / DEFAULT_TICKS_PER_SLOT;
-
-/**
- * @internal
- */
-export const MS_PER_SLOT = 1000 / NUM_SLOTS_PER_SECOND;

package/src/transaction/constants.ts

@@ -1,12 +0,0 @@
-/**
- * Maximum over-the-wire size of a Transaction
- *
- * 1280 is IPv6 minimum MTU
- * 40 bytes is the size of the IPv6 header
- * 8 bytes is the size of the fragment header
- */
-export const PACKET_DATA_SIZE = 1280 - 40 - 8;
-
-export const VERSION_PREFIX_MASK = 0x7f;
-
-export const SIGNATURE_LENGTH_IN_BYTES = 64;

package/src/transaction/expiry-custom-errors.ts

@@ -1,48 +0,0 @@
-export class TransactionExpiredBlockheightExceededError extends Error {
-  signature: string;
-
-  constructor(signature: string) {
-    super(`Signature ${signature} has expired: block height exceeded.`);
-    this.signature = signature;
-  }
-}
-
-Object.defineProperty(
-  TransactionExpiredBlockheightExceededError.prototype,
-  'name',
-  {
-    value: 'TransactionExpiredBlockheightExceededError',
-  },
-);
-
-export class TransactionExpiredTimeoutError extends Error {
-  signature: string;
-
-  constructor(signature: string, timeoutSeconds: number) {
-    super(
-      `Transaction was not confirmed in ${timeoutSeconds.toFixed(
-        2,
-      )} seconds. It is ` +
-        'unknown if it succeeded or failed. Check signature ' +
-        `${signature} using the Solana Explorer or CLI tools.`,
-    );
-    this.signature = signature;
-  }
-}
-
-Object.defineProperty(TransactionExpiredTimeoutError.prototype, 'name', {
-  value: 'TransactionExpiredTimeoutError',
-});
-
-export class TransactionExpiredNonceInvalidError extends Error {
-  signature: string;
-
-  constructor(signature: string) {
-    super(`Signature ${signature} has expired: the nonce is no longer valid.`);
-    this.signature = signature;
-  }
-}
-
-Object.defineProperty(TransactionExpiredNonceInvalidError.prototype, 'name', {
-  value: 'TransactionExpiredNonceInvalidError',
-});

package/src/transaction/index.ts

@@ -1,5 +0,0 @@
-export * from './constants';
-export * from './expiry-custom-errors';
-export * from './legacy';
-export * from './message';
-export * from './versioned';