Consider renaming RPC schemes

[franciszekjob]

Feature Request

Some RPC models and schemes are named differently than in spec https://github.com/starkware-libs/starknet-specs/tree/master/api.

Examples of potential changes:

• PendingStarknetBlockWithReceipts -> PendingBlockWithReceipts
• EstimatedFee -> FeeEstimate
• FunctionInvocation -> FunctionCall

[harsha-mangena]

@franciszekjob, Can I pick this issue?

[franciszekjob]

Hi, I think it's going to be better to pick it once #1316 is completed, which I'm currently working on 👍

[harsha-mangena]

Sure, Thank You @franciszekjob !

[Mitish98]

I am applying to this issue via OnlyDust platform.

[ddoktorski]

@Mitish98 Currently, we do not sponsor this issue nor any other issues through OnlyDust.

[franciszekjob]

Hey @harsha-mangena, #1316 has been closed, so you're welcome to pick this issue! 😄

[harsha-mangena]

@franciszekjob, Thanks for letting me know!!

[ScottyDavies]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I have experience with RPC APIs and blockchain technology, particularly with StarkNet. My background includes working on integrating and customizing RPC models, making me well-suited to address discrepancies between existing implementations and spec updates

How I plan on tackling this issue

To approach this problem, you can follow these steps:

Review Spec: i will compare the existing RPC models with the StarkNet spec to identify discrepancies.

Update Names: Modify the names in the codebase to match the spec (e.g., PendingStarknetBlockWithReceipts to PendingBlockWithReceipts).

Test Changes: Ensure that the updated names work correctly by running existing tests and creating new ones if necessary.

Documentation: Update any related documentation to reflect the new names and ensure clarity for users.

Deploy: Roll out the updated models to the development or staging environment, then to production after verification.

[franciszekjob]

Hey @ScottyDavies, I assigned you to this issue 👍

[ScottyDavies]

okay, I will start working on it immediately.

[jcampos2907]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Im self taught in python, rust, js, sql

[Ndifreke000]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a python developer and a block chain developer with multiple contributions with different projects worked on and problem solving skills.

How I plan on tackling this issue

I would audit the current API structure, using Python to build automated tests to identify inconsistencies in RPC schemes and model names. I’d propose naming conventions aligned with StarkNet and collaborate with the community to implement changes incrementally. To ensure accuracy, I’d create unit tests and documentation for the new API models, establishing a framework for future updates

[georgegoldman]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

back end developer skilled in Object oriented programming in python, experience in database models and ORM (SQLAlchemy)

How I plan on tackling this issue

simply change the name and reflect the change to all related files.

[Gerson2102]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm Gerson from Dojo Coding community. I have contributed to many projects, you guys can check my OD profile here: https://app.onlydust.com/u/Gerson2102

How I plan on tackling this issue

I will start by understanding what ia have to do. Setting up the project. Doing my own research. If I'm stuck I will ask for help. I'll make a PR and wait for your feedback.

[Gerson2102]

Hello. In this issue, I already knwo where is the rpc to start changing some of the names of the schemes. They're in starknet_py/net/schemas/rpc/ right?

One thing that I dont understand, is how to know the new correct names. I checked the resoruces on the issue but still dont get it. I dont know if somebody could help me here with that. I think that's the only thing that is not clear to me. @franciszekjob

And btw, do you guys have a telegram group or something like that?

[Gerson2102]

@ddoktorski @kkawula

[franciszekjob]

@georgegoldman Look up to Starknet API spec as reference when changing names.

Yes, here is the link to TG group link https://t.me/starknetpy

[franciszekjob]

Temporarily closing this issue as it will introduce many breaking changes which we don't need ATM.