@solana/web3.js 1.17.1 → 1.18.1

package/lib/index.cjs.js

@@ -2380,6 +2380,107 @@ class AgentManager {
 
 }
 
+const MINIMUM_SLOT_PER_EPOCH = 32; // Returns the number of trailing zeros in the binary representation of self.
+
+function trailingZeros(n) {
+  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) {
+  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
+ */
+
+
+class EpochSchedule {
+  /** The maximum number of slots in each epoch */
+
+  /** The number of slots before beginning of an epoch to calculate a leader schedule for that epoch */
+
+  /** Indicates whether epochs start short and grow */
+
+  /** The first epoch with `slotsPerEpoch` slots */
+
+  /** The first slot of `firstNormalEpoch` */
+  constructor(slotsPerEpoch, leaderScheduleSlotOffset, warmup, firstNormalEpoch, firstNormalSlot) {
+    _defineProperty__default['default'](this, "slotsPerEpoch", void 0);
+
+    _defineProperty__default['default'](this, "leaderScheduleSlotOffset", void 0);
+
+    _defineProperty__default['default'](this, "warmup", void 0);
+
+    _defineProperty__default['default'](this, "firstNormalEpoch", void 0);
+
+    _defineProperty__default['default'](this, "firstNormalSlot", void 0);
+
+    this.slotsPerEpoch = slotsPerEpoch;
+    this.leaderScheduleSlotOffset = leaderScheduleSlotOffset;
+    this.warmup = warmup;
+    this.firstNormalEpoch = firstNormalEpoch;
+    this.firstNormalSlot = firstNormalSlot;
+  }
+
+  getEpoch(slot) {
+    return this.getEpochAndSlotIndex(slot)[0];
+  }
+
+  getEpochAndSlotIndex(slot) {
+    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) {
+    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) {
+    return this.getFirstSlotInEpoch(epoch) + this.getSlotsInEpoch(epoch) - 1;
+  }
+
+  getSlotsInEpoch(epoch) {
+    if (epoch < this.firstNormalEpoch) {
+      return Math.pow(2, epoch + trailingZeros(MINIMUM_SLOT_PER_EPOCH));
+    } else {
+      return this.slotsPerEpoch;
+    }
+  }
+
+}
+
 // TODO: These constants should be removed in favor of reading them out of a
 // Syscall account
 
@@ -2545,11 +2646,6 @@ const GetEpochInfoResult = superstruct.type({
   blockHeight: superstruct.optional(superstruct.number()),
   transactionCount: superstruct.optional(superstruct.number())
 });
-/**
- * Epoch schedule
- * (see https://docs.solana.com/terminology#epoch)
- */
-
 const GetEpochScheduleResult = superstruct.type({
   slotsPerEpoch: superstruct.number(),
   leaderScheduleSlotOffset: superstruct.number(),
@@ -4082,7 +4178,8 @@ class Connection {
       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);
   }
   /**
    * Fetch the leader schedule for the current epoch
@@ -4498,12 +4595,23 @@ 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, amount) {
-    const unsafeRes = await this._rpcRequest('requestAirdrop', [to.toBase58(), amount]);
+  async requestAirdrop(to, lamports) {
+    const unsafeRes = await this._rpcRequest('requestAirdrop', [to.toBase58(), lamports]);
     const res = superstruct.create(unsafeRes, RequestAirdropRpcResult);
 
     if ('error' in res) {
@@ -6555,6 +6663,7 @@ exports.BPF_LOADER_PROGRAM_ID = BPF_LOADER_PROGRAM_ID;
 exports.BpfLoader = BpfLoader;
 exports.Connection = Connection;
 exports.Enum = Enum;
+exports.EpochSchedule = EpochSchedule;
 exports.FeeCalculatorLayout = FeeCalculatorLayout;
 exports.Keypair = Keypair;
 exports.LAMPORTS_PER_SOL = LAMPORTS_PER_SOL;