starknet 8.2.0 → 8.3.0

package/dist/index.js

@@ -7039,7 +7039,7 @@ var Subscription = class {
   }
 };
 
-// src/channel/ws/ws_0_8.ts
+// src/channel/ws/ws_0_9.ts
 var WebSocketChannel = class {
   /**
    * The URL of the WebSocket RPC Node.
@@ -7387,19 +7387,19 @@ var WebSocketChannel = class {
   }
   /**
    * Subscribes to new block headers.
-   * @param {SubscriptionBlockIdentifier} [blockIdentifier] - The block to start receiving notifications from. Defaults to 'latest'.
+   * @param {SubscribeNewHeadsParams} params - The parameters for the subscription.
    * @returns {Promise<Subscription<BLOCK_HEADER>>} A Promise that resolves with a `Subscription` object for new block headers.
    */
-  async subscribeNewHeads(blockIdentifier) {
+  async subscribeNewHeads(params = {}) {
     const method = "starknet_subscribeNewHeads";
-    const params = {
-      block_id: blockIdentifier ? new Block(blockIdentifier).identifier : void 0
+    const rpcParams = {
+      block_id: params.blockIdentifier ? new Block(params.blockIdentifier).identifier : void 0
     };
-    const subId = await this.sendReceive(method, params);
+    const subId = await this.sendReceive(method, rpcParams);
     const subscription = new Subscription({
       channel: this,
       method,
-      params,
+      params: rpcParams,
       id: subId,
       maxBufferSize: this.maxBufferSize
     });
@@ -7408,23 +7408,22 @@ var WebSocketChannel = class {
   }
   /**
    * Subscribes to events matching a given filter.
-   * @param {BigNumberish} [fromAddress] - The contract address to filter by.
-   * @param {string[][]} [keys] - The event keys to filter by.
-   * @param {SubscriptionBlockIdentifier} [blockIdentifier] - The block to start receiving notifications from. Defaults to 'latest'.
+   * @param {SubscribeEventsParams} params - The parameters for the subscription.
    * @returns {Promise<Subscription<EMITTED_EVENT>>} A Promise that resolves with a `Subscription` object for the specified events.
    */
-  async subscribeEvents(fromAddress, keys, blockIdentifier) {
+  async subscribeEvents(params = {}) {
     const method = "starknet_subscribeEvents";
-    const params = {
-      from_address: fromAddress !== void 0 ? toHex(fromAddress) : void 0,
-      keys,
-      block_id: blockIdentifier ? new Block(blockIdentifier).identifier : void 0
+    const rpcParams = {
+      from_address: params.fromAddress !== void 0 ? toHex(params.fromAddress) : void 0,
+      keys: params.keys,
+      block_id: params.blockIdentifier ? new Block(params.blockIdentifier).identifier : void 0,
+      finality_status: params.finalityStatus
     };
-    const subId = await this.sendReceive(method, params);
+    const subId = await this.sendReceive(method, rpcParams);
     const subscription = new Subscription({
       channel: this,
       method,
-      params,
+      params: rpcParams,
       id: subId,
       maxBufferSize: this.maxBufferSize
     });
@@ -7433,21 +7432,20 @@ var WebSocketChannel = class {
   }
   /**
    * Subscribes to status updates for a specific transaction.
-   * @param {BigNumberish} transactionHash - The hash of the transaction to monitor.
-   * @param {SubscriptionBlockIdentifier} [blockIdentifier] - The block context. Not typically required.
+   * @param {SubscribeTransactionStatusParams} params - The parameters for the subscription.
    * @returns {Promise<Subscription<NEW_TXN_STATUS>>} A Promise that resolves with a `Subscription` object for the transaction's status.
    */
-  async subscribeTransactionStatus(transactionHash, blockIdentifier) {
+  async subscribeTransactionStatus(params) {
     const method = "starknet_subscribeTransactionStatus";
-    const params = {
-      transaction_hash: toHex(transactionHash),
-      block_id: blockIdentifier ? new Block(blockIdentifier).identifier : void 0
+    const rpcParams = {
+      transaction_hash: toHex(params.transactionHash),
+      block_id: params.blockIdentifier ? new Block(params.blockIdentifier).identifier : void 0
     };
-    const subId = await this.sendReceive(method, params);
+    const subId = await this.sendReceive(method, rpcParams);
     const subscription = new Subscription({
       channel: this,
       method,
-      params,
+      params: rpcParams,
       id: subId,
       maxBufferSize: this.maxBufferSize
     });
@@ -7455,22 +7453,43 @@ var WebSocketChannel = class {
     return subscription;
   }
   /**
-   * Subscribes to pending transactions.
-   * @param {boolean} [transactionDetails] - If `true`, the full transaction details are included. Defaults to `false` (hash only).
-   * @param {BigNumberish[]} [senderAddress] - An array of sender addresses to filter by.
-   * @returns {Promise<Subscription<TXN_HASH | TXN_WITH_HASH>>} A Promise that resolves with a `Subscription` object for pending transactions.
+   * Subscribes to new transaction receipts.
+   * @param {SubscribeNewTransactionReceiptsParams} params - The parameters for the subscription.
+   * @returns {Promise<Subscription<NewTransactionReceiptsEvent['result']>>} A Promise that resolves with a `Subscription` object for new transaction receipts.
    */
-  async subscribePendingTransaction(transactionDetails, senderAddress) {
-    const method = "starknet_subscribePendingTransactions";
-    const params = {
-      transaction_details: transactionDetails,
-      sender_address: senderAddress && bigNumberishArrayToHexadecimalStringArray(senderAddress)
+  async subscribeNewTransactionReceipts(params = {}) {
+    const method = "starknet_subscribeNewTransactionReceipts";
+    const rpcParams = {
+      finality_status: params.finalityStatus,
+      sender_address: params.senderAddress && bigNumberishArrayToHexadecimalStringArray(params.senderAddress)
+    };
+    const subId = await this.sendReceive(method, rpcParams);
+    const subscription = new Subscription({
+      channel: this,
+      method,
+      params: rpcParams,
+      id: subId,
+      maxBufferSize: this.maxBufferSize
+    });
+    this.activeSubscriptions.set(subId, subscription);
+    return subscription;
+  }
+  /**
+   * Subscribes to new transactions.
+   * @param {SubscribeNewTransactionsParams} params - The parameters for the subscription.
+   * @returns {Promise<Subscription<NewTransactionEvent['result']>>} A Promise that resolves with a `Subscription` object for new transactions.
+   */
+  async subscribeNewTransactions(params = {}) {
+    const method = "starknet_subscribeNewTransactions";
+    const rpcParams = {
+      finality_status: params.finalityStatus,
+      sender_address: params.senderAddress && bigNumberishArrayToHexadecimalStringArray(params.senderAddress)
     };
-    const subId = await this.sendReceive(method, params);
+    const subId = await this.sendReceive(method, rpcParams);
     const subscription = new Subscription({
       channel: this,
       method,
-      params,
+      params: rpcParams,
       id: subId,
       maxBufferSize: this.maxBufferSize
     });