@solana/web3.js 1.17.1 → 1.18.1

package/lib/index.d.ts

@@ -121,6 +121,36 @@ declare module '@solana/web3.js' {
 
   export const BPF_LOADER_DEPRECATED_PROGRAM_ID: PublicKey;
 
+  /**
+   * 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 */
+    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,
+    );
+    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.
    */
@@ -651,22 +681,6 @@ declare module '@solana/web3.js' {
     blockHeight?: number;
     transactionCount?: 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;
-  };
   /**
    * Leader schedule
    * (see https://docs.solana.com/terminology#leader-schedule)
@@ -1682,11 +1696,22 @@ declare module '@solana/web3.js' {
       commitment?: Commitment,
     ): 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>;
     /**
      * Simulate a transaction

package/lib/index.esm.js

@@ -2342,6 +2342,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(this, "slotsPerEpoch", void 0);
+
+    _defineProperty(this, "leaderScheduleSlotOffset", void 0);
+
+    _defineProperty(this, "warmup", void 0);
+
+    _defineProperty(this, "firstNormalEpoch", void 0);
+
+    _defineProperty(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
 
@@ -2507,11 +2608,6 @@ const GetEpochInfoResult = type({
   blockHeight: optional(number()),
   transactionCount: optional(number())
 });
-/**
- * Epoch schedule
- * (see https://docs.solana.com/terminology#epoch)
- */
-
 const GetEpochScheduleResult = type({
   slotsPerEpoch: number(),
   leaderScheduleSlotOffset: number(),
@@ -4044,7 +4140,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
@@ -4460,12 +4557,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 = create(unsafeRes, RequestAirdropRpcResult);
 
     if ('error' in res) {
@@ -6509,5 +6617,5 @@ function clusterApiUrl(cluster, tls) {
 
 const LAMPORTS_PER_SOL = 1000000000;
 
-export { Account, Authorized, BLOCKHASH_CACHE_TIMEOUT_MS, BPF_LOADER_DEPRECATED_PROGRAM_ID, BPF_LOADER_PROGRAM_ID, BpfLoader, Connection, Enum, FeeCalculatorLayout, Keypair, LAMPORTS_PER_SOL, Loader, Lockup, MAX_SEED_LENGTH, Message, NONCE_ACCOUNT_LENGTH, NonceAccount, PACKET_DATA_SIZE, PublicKey, SOLANA_SCHEMA, STAKE_CONFIG_ID, STAKE_INSTRUCTION_LAYOUTS, SYSTEM_INSTRUCTION_LAYOUTS, SYSVAR_CLOCK_PUBKEY, SYSVAR_INSTRUCTIONS_PUBKEY, SYSVAR_RECENT_BLOCKHASHES_PUBKEY, SYSVAR_RENT_PUBKEY, SYSVAR_REWARDS_PUBKEY, SYSVAR_STAKE_HISTORY_PUBKEY, Secp256k1Program, StakeAuthorizationLayout, StakeInstruction, StakeProgram, Struct, SystemInstruction, SystemProgram, Transaction, TransactionInstruction, VALIDATOR_INFO_KEY, VOTE_PROGRAM_ID, ValidatorInfo, VoteAccount, clusterApiUrl, sendAndConfirmRawTransaction, sendAndConfirmTransaction };
+export { Account, Authorized, BLOCKHASH_CACHE_TIMEOUT_MS, BPF_LOADER_DEPRECATED_PROGRAM_ID, BPF_LOADER_PROGRAM_ID, BpfLoader, Connection, Enum, EpochSchedule, FeeCalculatorLayout, Keypair, LAMPORTS_PER_SOL, Loader, Lockup, MAX_SEED_LENGTH, Message, NONCE_ACCOUNT_LENGTH, NonceAccount, PACKET_DATA_SIZE, PublicKey, SOLANA_SCHEMA, STAKE_CONFIG_ID, STAKE_INSTRUCTION_LAYOUTS, SYSTEM_INSTRUCTION_LAYOUTS, SYSVAR_CLOCK_PUBKEY, SYSVAR_INSTRUCTIONS_PUBKEY, SYSVAR_RECENT_BLOCKHASHES_PUBKEY, SYSVAR_RENT_PUBKEY, SYSVAR_REWARDS_PUBKEY, SYSVAR_STAKE_HISTORY_PUBKEY, Secp256k1Program, StakeAuthorizationLayout, StakeInstruction, StakeProgram, Struct, SystemInstruction, SystemProgram, Transaction, TransactionInstruction, VALIDATOR_INFO_KEY, VOTE_PROGRAM_ID, ValidatorInfo, VoteAccount, clusterApiUrl, sendAndConfirmRawTransaction, sendAndConfirmTransaction };
 //# sourceMappingURL=index.esm.js.map