starknet_subscribeTransactionStatus websocket method #2210

pnowosie · 2024-10-11T10:03:02Z

Comments:

In the meantime this PR was in review @IronGauntlets added utils/check.go (Add IsNil() #2340)
I renamed utils/check.go to utils/nil.go because of this suggestion

codecov · 2024-10-11T10:08:05Z

Codecov Report

Attention: Patch coverage is 80.00000% with 18 lines in your changes missing coverage. Please review.

Project coverage is 73.90%. Comparing base (eb1f2ca) to head (2d073dd).

Files with missing lines	Patch %	Lines
rpc/subscriptions.go	76.92%	13 Missing and 5 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2210      +/-   ##
==========================================
- Coverage   74.33%   73.90%   -0.43%     
==========================================
  Files         110      110              
  Lines       11531    11614      +83     
==========================================
+ Hits         8571     8583      +12     
- Misses       2290     2363      +73     
+ Partials      670      668       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

rpc/handlers.go

weiihann · 2024-10-25T11:34:03Z

rpc/events.go

+	return err
+}
+
+func (h *Handler) SubscribeTxnStatus(ctx context.Context, txHash felt.Felt, _ *BlockID) (*SubscriptionID, *jsonrpc.Error) {


As per the specs, we also need to support historical blocks. Or is it not possible?

It's not possible. I added a comment explaining this.

maybe we should return error in this case? otherwise users will be confused why it's behaving differently from other possible impl.

jsonrpc/server.go

kirugan · 2024-12-16T10:36:11Z

rpc/events.go

@@ -9,11 +9,20 @@ import (
 	"github.com/NethermindEth/juno/jsonrpc"
 )

+const (
+	MaxBlocksBack        = 1024


There is new constant introduced in Aneeque's PR maxBlocksBack in rpc/handlers.go. If both of them related consider to reuse existing one

kirugan · 2024-12-16T10:38:52Z

rpc/events.go

+	}
+
+	id := h.idgen()
+	subscriptionCtx, subscriptionCtxCancel := context.WithCancel(ctx)


do you need to call defer subscriptionCtxCancel() ?

It's called by sub.unsubscribe()

kirugan · 2024-12-16T10:42:55Z

rpc/events.go

+		}()
+
+		if err := h.sendTxnStatus(sub.conn, wrapResult(lastKnownStatus), id); err != nil {
+			h.log.Warnw("Error while sending Txn status", "txHash", txHash)


maybe correct severity would be Error instead of Warnw ? Also please add "err", err as last arguments

kirugan · 2024-12-16T10:43:18Z

rpc/events.go

+			case <-headerSub.Recv():
+				lastKnownStatus, rpcErr = h.TransactionStatus(subscriptionCtx, txHash)
+				if rpcErr != nil {
+					h.log.Warnw("Failed to get Tx status", "txHash", txHash, "rpcErr", rpcErr)


same question: maybe it should be an error ?

kirugan · 2024-12-16T10:43:52Z

rpc/events.go

+				}
+
+				// Stop when final status reached and notified
+				if isFinal(lastSendStatus) {


is it according to the spec ?

It's not in written the spec.
I remember we are talking about the final statuses (=no next status in diagram)
I cannot recall why - if it was me who deducted that the subscription should be dropped in this case or it was in the group conversation 🤔

utils/check.go

kirugan · 2024-12-16T10:45:51Z

rpc/handlers.go

@@ -512,7 +523,7 @@ func (h *Handler) MethodsV0_7() ([]jsonrpc.Method, string) { //nolint: funlen
 			Handler: h.SpecVersionV0_7,
 		},
 		{
-			Name:    "juno_subscribeNewHeads",
+			Name:    "starknet_subscribeNewHeads",


why do you need to update starknet_subscribeNewHeads in this PR ?

I'll revert 👍 - I based on Han's PR - and then reverted when Anique's PR get merged

IronGauntlets · 2024-12-16T14:01:19Z

rpc/events.go

Can you please move SubscribeTxnStatus to subscription.go?

IronGauntlets · 2024-12-16T14:01:36Z

rpc/events_test.go

Please move the following test to subscription_test.go

IronGauntlets · 2024-12-16T14:04:14Z

rpc/events.go

+
+// sendHeader creates a request and sends it to the client
+func (h *Handler) sendTxnStatus(w jsonrpc.Conn, status *NewTransactionStatus, id uint64) error {
+	resp, err := json.Marshal(jsonrpc.Request{


Please. use SubscriptionResponse struct instead of jsonrpc.Request

IronGauntlets · 2024-12-16T14:07:18Z

rpc/events.go

+	h.subscriptions[id] = sub
+	h.mu.Unlock()
+
+	statusSub := h.txnStatus.Subscribe()


No one is sending on this subscription nor is anyone reading from it so why is this required?

Good catch 👍

IronGauntlets · 2024-12-16T14:18:36Z

rpc/events.go

+			select {
+			case <-subscriptionCtx.Done():
+				return
+			case <-headerSub.Recv():


HeaderSub is not enough to get all of the transaction status in particular AcceptedOnL1 since that is updated in a separate go routine.

So header Recv here is more than a timer tick than taking the Tx status.
In other words:

I'm getting the current status of Tx (the way rpc method does)

I should check it again in a while to send an eventual update

I can wait some arbitrary time period

I can wait until next block which more likely brings some changes (but not in all cases as you mentioned)

I'm getting the current status of Tx (the way rpc method does)

pnowosie force-pushed the pnowosie/2209-subscribe-tx-status-ws branch 2 times, most recently from c5eb695 to abfec15 Compare October 22, 2024 12:07

pnowosie marked this pull request as ready for review October 23, 2024 11:02

pnowosie requested review from rianhughes and kirugan October 23, 2024 11:02

pnowosie force-pushed the pnowosie/2209-subscribe-tx-status-ws branch from dae4ff2 to bffd2bf Compare October 23, 2024 12:13

weiihann reviewed Oct 25, 2024

View reviewed changes

rpc/handlers.go Outdated Show resolved Hide resolved

weiihann reviewed Oct 25, 2024

View reviewed changes

pnowosie force-pushed the pnowosie/2209-subscribe-tx-status-ws branch from 0ce1ae2 to b170da1 Compare October 29, 2024 12:12

pnowosie force-pushed the pnowosie/2209-subscribe-tx-status-ws branch from b170da1 to b617595 Compare November 13, 2024 12:59

pnowosie force-pushed the pnowosie/2209-subscribe-tx-status-ws branch 4 times, most recently from 6b842a7 to e65a8a4 Compare December 13, 2024 13:53

kirugan reviewed Dec 16, 2024

View reviewed changes

jsonrpc/server.go Outdated Show resolved Hide resolved

kirugan reviewed Dec 16, 2024

View reviewed changes

utils/check.go Outdated Show resolved Hide resolved

kirugan reviewed Dec 16, 2024

View reviewed changes

pnowosie force-pushed the pnowosie/2209-subscribe-tx-status-ws branch 2 times, most recently from bd4e154 to a552376 Compare December 16, 2024 12:21

IronGauntlets reviewed Dec 16, 2024

View reviewed changes

rpc/events.go

Copy link

Contributor

IronGauntlets Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please move SubscribeTxnStatus to subscription.go?

IronGauntlets reviewed Dec 16, 2024

View reviewed changes

rpc/events_test.go Outdated

Copy link

Contributor

IronGauntlets Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move the following test to subscription_test.go

pnowosie reacted with thumbs up emoji

IronGauntlets reviewed Dec 16, 2024

View reviewed changes

pnowosie force-pushed the pnowosie/2209-subscribe-tx-status-ws branch from a552376 to 5150b5f Compare December 17, 2024 10:01

pnowosie requested review from IronGauntlets and kirugan December 17, 2024 10:01

pnowosie force-pushed the pnowosie/2209-subscribe-tx-status-ws branch 4 times, most recently from 713b244 to 2d073dd Compare December 23, 2024 10:04

pnowosie and others added 2 commits December 24, 2024 18:47

starknet_subscribeTransactionStatus websocket method

7b638db

Add L1Feed in blockchain

20c0587

IronGauntlets force-pushed the pnowosie/2209-subscribe-tx-status-ws branch from 2d073dd to 20c0587 Compare December 25, 2024 21:57

wip: Add SubscribeTransactionStatus

4b94556

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

starknet_subscribeTransactionStatus websocket method #2210

starknet_subscribeTransactionStatus websocket method #2210

pnowosie commented Oct 11, 2024 •

edited

Loading

codecov bot commented Oct 11, 2024 •

edited

Loading

weiihann Oct 25, 2024

pnowosie Oct 29, 2024

kirugan Dec 16, 2024

kirugan Dec 16, 2024

kirugan Dec 16, 2024

pnowosie Dec 16, 2024

kirugan Dec 16, 2024

kirugan Dec 16, 2024

kirugan Dec 16, 2024

pnowosie Dec 16, 2024 •

edited

Loading

kirugan Dec 16, 2024

pnowosie Dec 16, 2024

IronGauntlets Dec 16, 2024

IronGauntlets Dec 16, 2024

IronGauntlets Dec 16, 2024

IronGauntlets Dec 16, 2024

pnowosie Dec 17, 2024

IronGauntlets Dec 16, 2024

pnowosie Dec 17, 2024

starknet_subscribeTransactionStatus websocket method #2210

Are you sure you want to change the base?

starknet_subscribeTransactionStatus websocket method #2210

Conversation

pnowosie commented Oct 11, 2024 • edited Loading

codecov bot commented Oct 11, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pnowosie Dec 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pnowosie commented Oct 11, 2024 •

edited

Loading

codecov bot commented Oct 11, 2024 •

edited

Loading

pnowosie Dec 16, 2024 •

edited

Loading