@solana/web3.js 1.77.3 → 1.78.1

package/lib/index.d.ts

@@ -3,7 +3,6 @@ declare module "@solana/web3.js" {
 import { Buffer } from 'buffer';
 import { Agent } from 'http';
 import { Agent as Agent$1 } from 'https';
-import * as nodeFetch from 'node-fetch';
 
 export class Struct {
     constructor(properties: any);
@@ -169,7 +168,8 @@ export class EpochSchedule {
     getSlotsInEpoch(epoch: number): number;
 }
 
-export function export_default(input: nodeFetch.RequestInfo, init?: nodeFetch.RequestInit): Promise<nodeFetch.Response>;
+export const _default: typeof fetch;
+//# sourceMappingURL=fetch-impl.d.ts.map
 
 /**
  * Calculator for transaction fees.
@@ -232,11 +232,13 @@ export class Keypair {
      * Create a new keypair instance.
      * Generate random keypair if no {@link Ed25519Keypair} is provided.
      *
-     * @param keypair ed25519 keypair
+     * @param {Ed25519Keypair} keypair ed25519 keypair
      */
     constructor(keypair?: Ed25519Keypair);
     /**
      * Generate a new random keypair
+     *
+     * @returns {Keypair} Keypair
      */
     static generate(): Keypair;
     /**
@@ -249,7 +251,9 @@ export class Keypair {
      * @throws error if the provided secret key is invalid and validation is not skipped.
      *
      * @param secretKey secret key byte array
-     * @param options: skip secret key validation
+     * @param options skip secret key validation
+     *
+     * @returns {Keypair} Keypair
      */
     static fromSecretKey(secretKey: Uint8Array, options?: {
         skipValidation?: boolean;
@@ -258,14 +262,19 @@ export class Keypair {
      * Generate a keypair from a 32 byte seed.
      *
      * @param seed seed byte array
+     *
+     * @returns {Keypair} Keypair
      */
     static fromSeed(seed: Uint8Array): Keypair;
     /**
      * The public key for this keypair
+     *
+     * @returns {PublicKey} PublicKey
      */
     get publicKey(): PublicKey;
     /**
      * The raw secret key for this keypair
+     * @returns {Uint8Array} Secret key in an array of Uint8 bytes
      */
     get secretKey(): Uint8Array;
 }
@@ -1576,6 +1585,8 @@ export class Transaction {
     signatures: Array<SignaturePubkeyPair>;
     /**
      * The first (payer) Transaction signature
+     *
+     * @returns {Buffer | null} Buffer of payer's signature
      */
     get signature(): Buffer | null;
     /**
@@ -1616,6 +1627,8 @@ export class Transaction {
     constructor(opts?: TransactionCtorFields_DEPRECATED);
     /**
      * Add one or more instructions to this Transaction
+     *
+     * @param {Array< Transaction | TransactionInstruction | TransactionInstructionCtorFields >} items - Instructions to add to the Transaction
      */
     add(...items: Array<Transaction | TransactionInstruction | TransactionInstructionCtorFields>): Transaction;
     /**
@@ -1628,6 +1641,10 @@ export class Transaction {
     serializeMessage(): Buffer;
     /**
      * Get the estimated fee associated with a transaction
+     *
+     * @param {Connection} connection Connection to RPC Endpoint.
+     *
+     * @returns {Promise<number | null>} The estimated fee for the transaction
      */
     getEstimatedFee(connection: Connection): Promise<number | null>;
     /**
@@ -1654,6 +1671,8 @@ export class Transaction {
      * rejected.
      *
      * The Transaction must be assigned a valid `recentBlockhash` before invoking this method
+     *
+     * @param {Array<Signer>} signers Array of signers that will sign the transaction
      */
     sign(...signers: Array<Signer>): void;
     /**
@@ -1662,30 +1681,50 @@ export class Transaction {
      * instructions.
      *
      * All the caveats from the `sign` method apply to `partialSign`
+     *
+     * @param {Array<Signer>} signers Array of signers that will sign the transaction
      */
     partialSign(...signers: Array<Signer>): void;
     /**
      * Add an externally created signature to a transaction. The public key
      * must correspond to either the fee payer or a signer account in the transaction
      * instructions.
+     *
+     * @param {PublicKey} pubkey Public key that will be added to the transaction.
+     * @param {Buffer} signature An externally created signature to add to the transaction.
      */
     addSignature(pubkey: PublicKey, signature: Buffer): void;
     /**
      * Verify signatures of a Transaction
      * Optional parameter specifies if we're expecting a fully signed Transaction or a partially signed one.
      * If no boolean is provided, we expect a fully signed Transaction by default.
+     *
+     * @param {boolean} [requireAllSignatures=true] Require a fully signed Transaction
      */
     verifySignatures(requireAllSignatures?: boolean): boolean;
     /**
      * Serialize the Transaction in the wire format.
+     *
+     * @param {Buffer} [config] Config of transaction.
+     *
+     * @returns {Buffer} Signature of transaction in wire format.
      */
     serialize(config?: SerializeConfig): Buffer;
     /**
      * Parse a wire transaction into a Transaction object.
+     *
+     * @param {Buffer | Uint8Array | Array<number>} buffer Signature of wire Transaction
+     *
+     * @returns {Transaction} Transaction associated with the signature
      */
     static from(buffer: Buffer | Uint8Array | Array<number>): Transaction;
     /**
      * Populate Transaction object from message and signatures
+     *
+     * @param {Message} message Message of transaction
+     * @param {Array<string>} signatures List of signatures to assign to the transaction
+     *
+     * @returns {Transaction} The populated Transaction
      */
     static populate(message: Message, signatures?: Array<string>): Transaction;
 }
@@ -1975,6 +2014,15 @@ type GetLatestBlockhashConfig = {
     /** The minimum slot that the request can be evaluated at */
     minContextSlot?: number;
 };
+/**
+ * Configuration object for changing `isBlockhashValid` query behavior
+ */
+type IsBlockhashValidConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+};
 /**
  * Configuration object for changing `getSlot` query behavior
  */
@@ -3052,7 +3100,7 @@ type HttpHeaders = {
 /**
  * The type of the JavaScript `fetch()` API
  */
-type FetchFn = typeof export_default;
+type FetchFn = typeof _default;
 /**
  * A callback used to augment the outgoing HTTP request
  */
@@ -3332,6 +3380,10 @@ export class Connection {
      * @return {Promise<BlockhashWithExpiryBlockHeight>}
      */
     getLatestBlockhashAndContext(commitmentOrConfig?: Commitment | GetLatestBlockhashConfig): Promise<RpcResponseAndContext<BlockhashWithExpiryBlockHeight>>;
+    /**
+     * Returns whether a blockhash is still valid or not
+     */
+    isBlockhashValid(blockhash: Blockhash, rawConfig?: IsBlockhashValidConfig): Promise<RpcResponseAndContext<boolean>>;
     /**
      * Fetch the node version
      */
@@ -3847,6 +3899,10 @@ export const SYSVAR_STAKE_HISTORY_PUBKEY: PublicKey;
 type Cluster = 'devnet' | 'testnet' | 'mainnet-beta';
 /**
  * Retrieves the RPC API URL for the specified cluster
+ * @param {Cluster} [cluster="devnet"] - The cluster name of the RPC API URL to use. Possible options: 'devnet' | 'testnet' | 'mainnet-beta'
+ * @param {boolean} [tls="http"] - Use TLS when connecting to cluster.
+ *
+ * @returns {string} URL string of the RPC endpoint
  */
 export function clusterApiUrl(cluster?: Cluster, tls?: boolean): string;