Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/doc rpc #83

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Feature/doc rpc #83

wants to merge 3 commits into from

Conversation

arnaubennassar
Copy link
Contributor

Description

The file can be rendered here

@arnaubennassar arnaubennassar changed the base branch from main to develop September 17, 2024 16:03
@arnaubennassar arnaubennassar self-assigned this Sep 17, 2024
Copy link

sonarcloud bot commented Sep 17, 2024

"methods": [
{
"name": "bridge_l1InfoTreeIndexForBridge",
"summary": "Gets the smalles L1 info tree index in which a given bridge is includded",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"summary": "Gets the smalles L1 info tree index in which a given bridge is includded",
"summary": "Gets the smallest L1 info tree index in which a given bridge is included",

"examples": [
{
"name": "example",
"description": "",
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we remove if empty?

},
{
"name": "bridge_injectedInfoAfterIndex",
"summary": "Gets the smalles L1 info tree index in which a given bridge is includded",
Copy link
Contributor

Choose a reason for hiding this comment

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

Same summary as previous?

"result": {
"$ref": "#/components/contentDescriptors/L1InfoTreeLeaf"
},
"examples": [ ]
Copy link
Contributor

Choose a reason for hiding this comment

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

should provide example?

"examples": [ ]
},
{
"name": "bridge_claimProof",
Copy link
Contributor

Choose a reason for hiding this comment

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

why claimProof and not getProof or just proof? Looks like too specific

},
"Metadata": {
"title": "metadata",
"description": "Extra data includded in the bridge",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"description": "Extra data includded in the bridge",
"description": "Extra data included in the bridge",

}
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

New line

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants