@solana/web3.js 1.17.1 → 1.18.1

package/module.flow.js

@@ -136,6 +136,50 @@ declare module "@solana/web3.js" {
   declare export type Blockhash = string;
   declare export var BPF_LOADER_DEPRECATED_PROGRAM_ID: PublicKey;
 
+  /**
+   * Epoch schedule
+   * (see https://docs.solana.com/terminology#epoch)
+   * Can be retrieved with the {@link connection.getEpochSchedule} method
+   */
+  declare export class EpochSchedule {
+    /**
+     * The maximum number of slots in each epoch
+     */
+    slotsPerEpoch: number;
+
+    /**
+     * The number of slots before beginning of an epoch to calculate a leader schedule for that epoch
+     */
+    leaderScheduleSlotOffset: number;
+
+    /**
+     * Indicates whether epochs start short and grow
+     */
+    warmup: boolean;
+
+    /**
+     * The first epoch with `slotsPerEpoch` slots
+     */
+    firstNormalEpoch: number;
+
+    /**
+     * The first slot of `firstNormalEpoch`
+     */
+    firstNormalSlot: number;
+    constructor(
+      slotsPerEpoch: number,
+      leaderScheduleSlotOffset: number,
+      warmup: boolean,
+      firstNormalEpoch: number,
+      firstNormalSlot: number
+    ): this;
+    getEpoch(slot: number): number;
+    getEpochAndSlotIndex(slot: number): [number, number];
+    getFirstSlotInEpoch(epoch: number): number;
+    getLastSlotInEpoch(epoch: number): number;
+    getSlotsInEpoch(epoch: number): number;
+  }
+
   /**
    * Calculator for transaction fees.
    */
@@ -875,38 +919,6 @@ declare module "@solana/web3.js" {
     ...
   };
 
-  /**
-   * Epoch schedule
-   * (see https://docs.solana.com/terminology#epoch)
-   */
-  declare export type EpochSchedule = {
-    /**
-     * The maximum number of slots in each epoch
-     */
-    slotsPerEpoch: number,
-
-    /**
-     * The number of slots before beginning of an epoch to calculate a leader schedule for that epoch
-     */
-    leaderScheduleSlotOffset: number,
-
-    /**
-     * Indicates whether epochs start short and grow
-     */
-    warmup: boolean,
-
-    /**
-     * The first epoch with `slotsPerEpoch` slots
-     */
-    firstNormalEpoch: number,
-
-    /**
-     * The first slot of `firstNormalEpoch`
-     */
-    firstNormalSlot: number,
-    ...
-  };
-
   /**
    * Leader schedule
    * (see https://docs.solana.com/terminology#leader-schedule)
@@ -2440,11 +2452,22 @@ feeCalculator: FeeCalculator,...
     ): Promise<NonceAccount | null>;
 
     /**
-     * Request an allocation of lamports to the specified account
+     * Request an allocation of lamports to the specified address
+     *
+     * ```typescript
+     * import { Connection, PublicKey, LAMPORTS_PER_SOL } from "@solana/web3.js";
+     *
+     * (async () => {
+     *   const connection = new Connection("https://api.testnet.solana.com", "confirmed");
+     *   const myAddress = new PublicKey("2nr1bHFT86W9tGnyvmYW4vcHKsQB3sVQfnddasz4kExM");
+     *   const signature = await connection.requestAirdrop(myAddress, LAMPORTS_PER_SOL);
+     *   await connection.confirmTransaction(signature);
+     * })();
+     * ```
      */
     requestAirdrop(
       to: PublicKey,
-      amount: number
+      lamports: number
     ): Promise<TransactionSignature>;
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/web3.js",
-  "version": "1.17.1",
+  "version": "1.18.1",
   "description": "Solana Javascript API",
   "keywords": [
     "api",
@@ -102,7 +102,7 @@
     "nyc": "^15.1.0",
     "prettier": "^2.3.0",
     "rimraf": "3.0.2",
-    "rollup": "2.50.6",
+    "rollup": "2.51.0",
     "rollup-plugin-dts": "^3.0.1",
     "rollup-plugin-node-polyfills": "^0.2.1",
     "rollup-plugin-terser": "^7.0.2",

package/src/connection.ts

@@ -27,6 +27,7 @@ import RpcClient from 'jayson/lib/client/browser';
 import {IWSRequestParams} from 'rpc-websockets/dist/lib/client';
 
 import {AgentManager} from './agent-manager';
+import {EpochSchedule} from './epoch-schedule';
 import {NonceAccount} from './nonce-account';
 import {PublicKey} from './publickey';
 import {Signer} from './keypair';
@@ -373,23 +374,6 @@ const GetEpochInfoResult = pick({
   transactionCount: optional(number()),
 });
 
-/**
- * Epoch schedule
- * (see https://docs.solana.com/terminology#epoch)
- */
-export type EpochSchedule = {
-  /** The maximum number of slots in each epoch */
-  slotsPerEpoch: number;
-  /** The number of slots before beginning of an epoch to calculate a leader schedule for that epoch */
-  leaderScheduleSlotOffset: number;
-  /** Indicates whether epochs start short and grow */
-  warmup: boolean;
-  /** The first epoch with `slotsPerEpoch` slots */
-  firstNormalEpoch: number;
-  /** The first slot of `firstNormalEpoch` */
-  firstNormalSlot: number;
-};
-
 const GetEpochScheduleResult = pick({
   slotsPerEpoch: number(),
   leaderScheduleSlotOffset: number(),
@@ -2788,7 +2772,14 @@ export class Connection {
     if ('error' in res) {
       throw new Error('failed to get epoch schedule: ' + res.error.message);
     }
-    return res.result;
+    const epochSchedule = res.result;
+    return new EpochSchedule(
+      epochSchedule.slotsPerEpoch,
+      epochSchedule.leaderScheduleSlotOffset,
+      epochSchedule.warmup,
+      epochSchedule.firstNormalEpoch,
+      epochSchedule.firstNormalSlot,
+    );
   }
 
   /**
@@ -3257,15 +3248,26 @@ export class Connection {
   }
 
   /**
-   * Request an allocation of lamports to the specified account
+   * Request an allocation of lamports to the specified address
+   *
+   * ```typescript
+   * import { Connection, PublicKey, LAMPORTS_PER_SOL } from "@solana/web3.js";
+   *
+   * (async () => {
+   *   const connection = new Connection("https://api.testnet.solana.com", "confirmed");
+   *   const myAddress = new PublicKey("2nr1bHFT86W9tGnyvmYW4vcHKsQB3sVQfnddasz4kExM");
+   *   const signature = await connection.requestAirdrop(myAddress, LAMPORTS_PER_SOL);
+   *   await connection.confirmTransaction(signature);
+   * })();
+   * ```
    */
   async requestAirdrop(
     to: PublicKey,
-    amount: number,
+    lamports: number,
   ): Promise<TransactionSignature> {
     const unsafeRes = await this._rpcRequest('requestAirdrop', [
       to.toBase58(),
-      amount,
+      lamports,
     ]);
     const res = create(unsafeRes, RequestAirdropRpcResult);
     if ('error' in res) {

package/src/epoch-schedule.ts

@@ -0,0 +1,102 @@
+const MINIMUM_SLOT_PER_EPOCH = 32;
+
+// Returns the number of trailing zeros in the binary representation of self.
+function trailingZeros(n: number) {
+  let trailingZeros = 0;
+  while (n > 1) {
+    n /= 2;
+    trailingZeros++;
+  }
+  return trailingZeros;
+}
+
+// Returns the smallest power of two greater than or equal to n
+function nextPowerOfTwo(n: number) {
+  if (n === 0) return 1;
+  n--;
+  n |= n >> 1;
+  n |= n >> 2;
+  n |= n >> 4;
+  n |= n >> 8;
+  n |= n >> 16;
+  n |= n >> 32;
+  return n + 1;
+}
+
+/**
+ * Epoch schedule
+ * (see https://docs.solana.com/terminology#epoch)
+ * Can be retrieved with the {@link connection.getEpochSchedule} method
+ */
+export class EpochSchedule {
+  /** The maximum number of slots in each epoch */
+  public slotsPerEpoch: number;
+  /** The number of slots before beginning of an epoch to calculate a leader schedule for that epoch */
+  public leaderScheduleSlotOffset: number;
+  /** Indicates whether epochs start short and grow */
+  public warmup: boolean;
+  /** The first epoch with `slotsPerEpoch` slots */
+  public firstNormalEpoch: number;
+  /** The first slot of `firstNormalEpoch` */
+  public firstNormalSlot: number;
+
+  constructor(
+    slotsPerEpoch: number,
+    leaderScheduleSlotOffset: number,
+    warmup: boolean,
+    firstNormalEpoch: number,
+    firstNormalSlot: number,
+  ) {
+    this.slotsPerEpoch = slotsPerEpoch;
+    this.leaderScheduleSlotOffset = leaderScheduleSlotOffset;
+    this.warmup = warmup;
+    this.firstNormalEpoch = firstNormalEpoch;
+    this.firstNormalSlot = firstNormalSlot;
+  }
+
+  getEpoch(slot: number): number {
+    return this.getEpochAndSlotIndex(slot)[0];
+  }
+
+  getEpochAndSlotIndex(slot: number): [number, number] {
+    if (slot < this.firstNormalSlot) {
+      const epoch =
+        trailingZeros(nextPowerOfTwo(slot + MINIMUM_SLOT_PER_EPOCH + 1)) -
+        trailingZeros(MINIMUM_SLOT_PER_EPOCH) -
+        1;
+
+      const epochLen = this.getSlotsInEpoch(epoch);
+      const slotIndex = slot - (epochLen - MINIMUM_SLOT_PER_EPOCH);
+      return [epoch, slotIndex];
+    } else {
+      const normalSlotIndex = slot - this.firstNormalSlot;
+      const normalEpochIndex = Math.floor(normalSlotIndex / this.slotsPerEpoch);
+      const epoch = this.firstNormalEpoch + normalEpochIndex;
+      const slotIndex = normalSlotIndex % this.slotsPerEpoch;
+      return [epoch, slotIndex];
+    }
+  }
+
+  getFirstSlotInEpoch(epoch: number): number {
+    if (epoch <= this.firstNormalEpoch) {
+      return (Math.pow(2, epoch) - 1) * MINIMUM_SLOT_PER_EPOCH;
+    } else {
+      return (
+        (epoch - this.firstNormalEpoch) * this.slotsPerEpoch +
+        this.firstNormalSlot
+      );
+    }
+  }
+
+  getLastSlotInEpoch(epoch: number): number {
+    return this.getFirstSlotInEpoch(epoch) + this.getSlotsInEpoch(epoch) - 1;
+  }
+
+  getSlotsInEpoch(epoch: number) {
+    if (epoch < this.firstNormalEpoch) {
+      return Math.pow(2, epoch + trailingZeros(MINIMUM_SLOT_PER_EPOCH));
+    } else {
+      return this.slotsPerEpoch;
+    }
+  }
+}

package/src/index.ts

@@ -3,6 +3,7 @@ export * from './blockhash';
 export * from './bpf-loader-deprecated';
 export * from './bpf-loader';
 export * from './connection';
+export * from './epoch-schedule';
 export * from './fee-calculator';
 export * from './keypair';
 export * from './loader';