feat(rpc): v0.8

[Trantorian1]

Is there an existing issue?

• I have searched the existing issues

Motivation

This issues represents an effort at documenting the necessary steps, changes and progress towards implementing v0.8.0-rc0 of the starknet rpc specs, including most notably the websocket api: this is similar to the Ethereum RPC subscription extension of the RPC spec provided by geth.

Functionality

RPC clients will be able to:

• subscribe to information through a websocket connection
• receive up-to-date information as soon as it is available without making a new RPC call
• unsubscribe (close the websocket stream) when the information is no longer needed

Request

The following methods would have to be implemented

• feat(starknet_getMessageStatus) #414 (underway)
• feat(starknet_getStorageProof) #415
• feat(starknet_subscribeNewHeads) #336
• feat(starknet_subscribeEvents) #337
• feat(starknet_subscribeTransactionStatus) #338
• feat(starknet_subscribePendingTransactions) #339
• feat(starknet_subscriptionReorg) #416 (underway)
• feat(starknet_unsubscribe) #340

Considerations

Warning

Potential DOS vectors:

• Opening a large number of websocket connections
• Holding all websocket connections indefinitely
• Aggressively disconnecting and re-connecting

DOS mitigation

• feat(ws): set max number of websocket connections #341
• feat(ws): set max websocket connection duration #342
• feat(ws): websocket connection cooldown time #343

Existing infrastructure

MiddleWareLayer already implements logic for counting websocket connections and disconnections as part of RpcMetrics. The rpc server also natively handles websockets, but additional logic will have to be added to route those calls to the actual method implementations.

Are you willing to help with this request?

Yes!