NethermindEth/starknet.go

Specific return type for BlockWithTxs and BlockWithTxHashes methods

Open

#355 opened on Sep 22, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (140 forks)auto 404
help wanted

Repository metrics

Stars
 (177 stars)
PR merge metrics
 (PR metrics pending)

Description

In https://github.com/NethermindEth/starknet.go/pull/354 a new type for blocks with only transaction hashes was created as requested on #347.

However, BlockWithTxs and BlockWithTxHashes methods still have as return type interface{} as these can return either a Block or a Pending Block in both cases. The idea is to replace interface{} with an specific type and do something similar as in TransactionByHash method (see here) with adaptTransaction

Contributor guide

Research direction
Study the `TransactionByHash` method and its `adaptTransaction` function in `rpc/transaction.go` to understand how specific types are returned. Then apply the same pattern to `BlockWithTxs` and `BlockWithTxHashes` methods: define a new type that can hold both block and pending block variants, similar to how `Transaction` type is used. Look at the existing block types in the codebase and create an adapted block type if needed.
Tech stack
go
Domain
backendapi
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoType assertion in Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75