@solana/web3.js 1.18.1 → 1.19.1

package/module.flow.js

@@ -107,7 +107,7 @@ declare module "@solana/web3.js" {
 
   /**
    * An account key pair (public and secret keys).
-   * @deprecated since v1.10.0, please use {@link Keypair} instead.
+   * @deprecated [object Object],[object Object],[object Object]
    */
   declare export class Account {
     /**
@@ -137,9 +137,7 @@ declare module "@solana/web3.js" {
   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
+   * [object Object],[object Object],[object Object]
    */
   declare export class EpochSchedule {
     /**
@@ -230,8 +228,7 @@ declare module "@solana/web3.js" {
    */
   declare export class Keypair {
     /**
-     * Create a new keypair instance.
-     * Generate random keypair if no {@link Ed25519Keypair} is provided.
+     * [object Object],[object Object],[object Object]
      * @param keypair ed25519 keypair
      */
     constructor(keypair?: Ed25519Keypair): this;
@@ -242,11 +239,7 @@ declare module "@solana/web3.js" {
     static generate(): Keypair;
 
     /**
-     * Create a keypair from a raw secret key byte array.
-     *
-     * This method should only be used to recreate a keypair from a previously
-     * generated secret key. Generating keypairs from a random seed should be done
-     * with the {@link Keypair.fromSeed} method.
+     * [object Object],[object Object],[object Object]
      * @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
@@ -700,6 +693,28 @@ declare module "@solana/web3.js" {
     ...
   };
 
+  /**
+   * Options for getSignaturesForAddress
+   */
+  declare export type SignaturesForAddressOptions = {
+    /**
+     * Start searching backwards from this transaction signature.
+     * @remark If not provided the search starts from the highest max confirmed block.
+     */
+    before?: TransactionSignature,
+
+    /**
+     * Search until this transaction signature is reached, if found before `limit`.
+     */
+    until?: TransactionSignature,
+
+    /**
+     * Maximum transaction signatures to return (between 1 and 1,000, default: 1,000).
+     */
+    limit?: number,
+    ...
+  };
+
   /**
    * RPC Response with extra contextual information
    */
@@ -2255,7 +2270,7 @@ account: AccountInfo<Buffer | ParsedAccountData>,...
 
     /**
      * Fetch the current total currency supply of the cluster in lamports
-     * @deprecated Deprecated since v1.2.8. Please use {@link getSupply} instead.
+     * @deprecated [object Object],[object Object],[object Object]
      */
     getTotalSupply(commitment?: Commitment): Promise<number>;
 
@@ -2370,7 +2385,7 @@ feeCalculator: FeeCalculator,...
     /**
      * Fetch a list of Transactions and transaction statuses from the cluster
      * for a confirmed block.
-     * @deprecated Deprecated since v1.13.0. Please use {@link getBlock} instead.
+     * @deprecated [object Object],[object Object],[object Object]
      */
     getConfirmedBlock(
       slot: number,
@@ -2412,7 +2427,7 @@ feeCalculator: FeeCalculator,...
     /**
      * Fetch a list of all the confirmed signatures for transactions involving an address
      * within a specified slot range. Max range allowed is 10,000 slots.
-     * @deprecated Deprecated since v1.3. Please use {@link getConfirmedSignaturesForAddress2} instead.
+     * @deprecated [object Object],[object Object],[object Object]
      * @param address queried address
      * @param startSlot start slot, inclusive
      * @param endSlot end slot, inclusive
@@ -2435,6 +2450,18 @@ feeCalculator: FeeCalculator,...
       commitment?: Finality
     ): Promise<Array<ConfirmedSignatureInfo>>;
 
+    /**
+     * Returns confirmed signatures for transactions involving an
+     * address backwards in time from the provided signature or most recent confirmed block
+     * @param address queried address
+     * @param options
+     */
+    getSignaturesForAddress(
+      address: PublicKey,
+      options?: SignaturesForAddressOptions,
+      commitment?: Finality
+    ): Promise<Array<ConfirmedSignatureInfo>>;
+
     /**
      * Fetch the contents of a Nonce account from the cluster, return with context
      */
@@ -2573,8 +2600,7 @@ feeCalculator: FeeCalculator,...
     removeSlotChangeListener(id: number): Promise<void>;
 
     /**
-     * Register a callback to be invoked upon slot updates. {@link SlotUpdate}'s
-     * may be useful to track live progress of a cluster.
+     * [object Object],[object Object],[object Object]
      * @param callback Function to invoke whenever the slot updates
      * @return subscription id
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/web3.js",
-  "version": "1.18.1",
+  "version": "1.19.1",
   "description": "Solana Javascript API",
   "keywords": [
     "api",
@@ -96,13 +96,13 @@
     "http-server": "^0.12.3",
     "mocha": "^8.2.1",
     "mocha-headless-chrome": "^3.1.0",
-    "mockttp": "^1.1.0",
+    "mockttp": "^2.0.1",
     "mz": "^2.7.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "prettier": "^2.3.0",
     "rimraf": "3.0.2",
-    "rollup": "2.51.0",
+    "rollup": "2.51.2",
     "rollup-plugin-dts": "^3.0.1",
     "rollup-plugin-node-polyfills": "^0.2.1",
     "rollup-plugin-terser": "^7.0.2",
@@ -111,8 +111,8 @@
     "start-server-and-test": "^1.12.0",
     "ts-node": "^10.0.0",
     "tslib": "^2.1.0",
-    "typedoc": "^0.20.31",
-    "typescript": "^4.1.5"
+    "typedoc": "^0.21.0-beta.2",
+    "typescript": "^4.3.2"
   },
   "scripts": {
     "build": "npm run clean; cross-env NODE_ENV=production rollup -c; npm run type:gen; npm run flow:gen; npm run flow:check",

package/src/connection.ts

@@ -127,6 +127,21 @@ export type ConfirmedSignaturesForAddress2Options = {
   limit?: number;
 };
 
+/**
+ * Options for getSignaturesForAddress
+ */
+export type SignaturesForAddressOptions = {
+  /**
+   * Start searching backwards from this transaction signature.
+   * @remark If not provided the search starts from the highest max confirmed block.
+   */
+  before?: TransactionSignature;
+  /** Search until this transaction signature is reached, if found before `limit`. */
+  until?: TransactionSignature;
+  /** Maximum transaction signatures to return (between 1 and 1,000, default: 1,000). */
+  limit?: number;
+};
+
 /**
  * RPC Response with extra contextual information
  */
@@ -1060,6 +1075,21 @@ const GetConfirmedSignaturesForAddress2RpcResult = jsonRpcResult(
   ),
 );
 
+/**
+ * Expected JSON RPC response for the "getSignaturesForAddress" message
+ */
+const GetSignaturesForAddressRpcResult = jsonRpcResult(
+  array(
+    pick({
+      signature: string(),
+      slot: number(),
+      err: TransactionErrorResult,
+      memo: nullable(string()),
+      blockTime: optional(nullable(number())),
+    }),
+  ),
+);
+
 /***
  * Expected JSON RPC response for the "accountNotification" message
  */
@@ -3205,6 +3235,35 @@ export class Connection {
     return res.result;
   }
 
+  /**
+   * Returns confirmed signatures for transactions involving an
+   * address backwards in time from the provided signature or most recent confirmed block
+   *
+   *
+   * @param address queried address
+   * @param options
+   */
+  async getSignaturesForAddress(
+    address: PublicKey,
+    options?: SignaturesForAddressOptions,
+    commitment?: Finality,
+  ): Promise<Array<ConfirmedSignatureInfo>> {
+    const args = this._buildArgsAtLeastConfirmed(
+      [address.toBase58()],
+      commitment,
+      undefined,
+      options,
+    );
+    const unsafeRes = await this._rpcRequest('getSignaturesForAddress', args);
+    const res = create(unsafeRes, GetSignaturesForAddressRpcResult);
+    if ('error' in res) {
+      throw new Error(
+        'failed to get signatures for address: ' + res.error.message,
+      );
+    }
+    return res.result;
+  }
+
   /**
    * Fetch the contents of a Nonce account from the cluster, return with context
    */