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.

Sign up for GitHub

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

Jump to bottom

New reference doc for Custom RPC V2 #4654

Merged
merged 11 commits into from
Jun 7, 2024
Merged

New reference doc for Custom RPC V2 #4654

merged 11 commits into from
Jun 7, 2024

Conversation

kianenigma
Copy link
Contributor

@kianenigma kianenigma commented May 31, 2024 •
edited
Loading

Thanks for @xlc for the original seed info, I've just fixed it up a bit and added example links.

I've moved the comparison between eth-rpc-api and frontier outside, as it is opinionation. I think the content there was good but should live in the README of the corresponding repos. No strong opinion, happy either way.

@kianenigma kianenigma added R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation. labels May 31, 2024
@kianenigma kianenigma requested a review from a team as a code owner May 31, 2024 04:02
@kianenigma kianenigma mentioned this pull request May 31, 2024
Closed
@kianenigma kianenigma requested a review from liamaharon May 31, 2024 05:33
@kianenigma @bkchr
Update docs/sdk/src/reference_docs/custom_runtime_api_rpc.rs
1ebba68 
Co-authored-by: Bastian Köcher <git@kchr.de>
@paritytech-review-bot paritytech-review-bot bot requested a review from a team June 1, 2024 02:06
@kianenigma kianenigma requested a review from bkchr June 7, 2024 07:11
michalkucharczyk
michalkucharczyk reviewed Jun 7, 2024
View reviewed changes
docs/sdk/src/reference_docs/custom_runtime_api_rpc.rs Outdated
//!
//! ## Background
//!
//! Polkadot-SDK offers the ability to query and subscribe storages directly. However what it did
Copy link
Contributor

Choose a reason for hiding this comment

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

would be nice to have some links here.

michalkucharczyk
michalkucharczyk reviewed Jun 7, 2024
View reviewed changes
docs/sdk/src/reference_docs/custom_runtime_api_rpc.rs Outdated
//!
//! As noted, this is already enough to make this API usable via `state_call`.
//!
//! ## Create a new custom RPC
Copy link
Contributor

@michalkucharczyk michalkucharczyk Jun 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe those two sections:

## Create a new custom RPC
## Add a new RPC to the node

should be placed under one root section (legacy) as they are dependent on each other (IIUC).

@kianenigma @gpestana
Apply suggestions from code review
5eb51b7 
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
kianenigma

This comment was marked as off-topic.

Sign in to view

@kianenigma kianenigma enabled auto-merge June 7, 2024 10:59
@kianenigma
Copy link
Contributor Author

bot fmt

@command-bot
Copy link

command-bot bot commented Jun 7, 2024 •
edited
Loading

@kianenigma https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6421580 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 13-61340be9-6b24-459f-9f86-3328829d3a62 to cancel this command or bot cancel to cancel all commands in this pull request.

@command-bot
Copy link

command-bot bot commented Jun 7, 2024

@kianenigma Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6421580 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6421580/artifacts/download.

@kianenigma kianenigma added this pull request to the merge queue Jun 7, 2024
Merged via the queue into master with commit d783ca9 Jun 7, 2024
156 of 157 checks passed
@kianenigma kianenigma deleted the custom-rpc branch June 7, 2024 12:12
ordian added a commit that referenced this pull request Jun 13, 2024
@ordian
merge master and resolve conflicts
dff960c 
* master: (29 commits)
  Append overlay optimization. (#1223)
  finalization: Skip tree route calculation if no forks present (#4721)
  Remove unncessary call remove_from_peers_set (#4742)
  add pov-recovery unit tests and support for elastic scaling (#4733)
  approval-voting: Add no shows debug information (#4726)
  Revamp the Readme of the parachain template (#4713)
  Update README.md to move the PSVM link under a "Tooling" section under the "Releases" section (#4734)
  frame/proc-macro: Refactor code for better readability (#4712)
  Contracts:  update wasmi to 0.32 (#3679)
  Backport style changes from P<>K bridge to R<>W bridge (#4732)
  New reference doc for Custom RPC V2 (#4654)
  Frame Pallets: Clean a lot of test setups (#4642)
  Fix occupied core handling (#4691)
  statement-distribution: Fix false warning (#4727)
  Update the README to include a link to the Polkadot SDK Version Manager (#4718)
  Cleanup PVF artifact by cache limit and stale time (#4662)
  Update link to a latest polkadot release (#4711)
  [CI] Delete cargo-deny config (#4677)
  fix build on MacOS: bump secp256k1 and secp256k1-sys to patched versions (#4709)
  Unify dependency aliases (#4633)
  ...
TarekkMA pushed a commit to moonbeam-foundation/polkadot-sdk that referenced this pull request Aug 2, 2024
@kianenigma @xlc
@bkchr @gpestana @TarekkMA
New reference doc for Custom RPC V2 (paritytech#4654)
7a2e8ce 
Thanks for @xlc for the original seed info, I've just fixed it up a bit
and added example links.

I've moved the comparison between eth-rpc-api and frontier outside, as
it is opinionation. I think the content there was good but should live
in the README of the corresponding repos. No strong opinion, happy
either way.

---------

Co-authored-by: Bryan Chen <xlchen1291@gmail.com>
Co-authored-by: Bastian Köcher <git@kchr.de>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: command-bot <>
This was referenced Aug 21, 2024
Closed
Closed
sfffaaa pushed a commit to peaqnetwork/polkadot-sdk that referenced this pull request Dec 27, 2024
@kianenigma @xlc
@bkchr @gpestana
New reference doc for Custom RPC V2 (paritytech#4654)
1e7612b 
Thanks for @xlc for the original seed info, I've just fixed it up a bit
and added example links.

I've moved the comparison between eth-rpc-api and frontier outside, as
it is opinionation. I think the content there was good but should live
in the README of the corresponding repos. No strong opinion, happy
either way.

---------

Co-authored-by: Bryan Chen <xlchen1291@gmail.com>
Co-authored-by: Bastian Köcher <git@kchr.de>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: command-bot <>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lexnv lexnv lexnv approved these changes

@bkchr bkchr bkchr approved these changes

@michalkucharczyk michalkucharczyk michalkucharczyk approved these changes

@gpestana gpestana gpestana approved these changes

@liamaharon liamaharon Awaiting requested review from liamaharon

Assignees
No one assigned
Labels
R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@kianenigma @gpestana @michalkucharczyk @bkchr @lexnv @xlc