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

feat(rpc): add standardize RPC endpoints #1508

Merged
merged 1 commit into from
Nov 9, 2023
Merged

feat(rpc): add standardize RPC endpoints #1508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

### Added

- Host JSON-RPC on `/rpc/v0_x` in addition to the existing `/rpc/v0.x` endpoints. This applies to all supported JSON-RPC versions.

### Changed

- RPC errors now only include the root cause if white-listed as non-sensitive
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,9 +245,9 @@ You can interact with Starknet using the JSON-RPC API. Pathfinder supports the o
Currently pathfinder supports `v0.3`, `v0.4`, and `v0.5` versions of the Starknet JSON-RPC specification.
The `path` of the URL used to access the JSON-RPC server determines which version of the API is served:

- the `v0.3.0` API is exposed on the `/rpc/v0.3` path
- the `v0.4.0` API is exposed on the `/` and `/rpc/v0.4` path
- the `v0.5.0` API is exposed on the `/rpc/v0.5` path
- the `v0.3.0` API is exposed on the `/rpc/v0.3` and `/rpc/v0_3` path
- the `v0.4.0` API is exposed on the `/`, `/rpc/v0.4` and `/rpc/v0_4` path
- the `v0.5.0` API is exposed on the `/rpc/v0.5` and `/rpc/v0_5` path
- the pathfinder extension API is exposed on `/rpc/pathfinder/v0.1`

Note that the pathfinder extension is versioned separately from the Starknet specification itself.
Expand Down
18 changes: 18 additions & 0 deletions crates/rpc/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,13 @@ impl RpcServer {
.route("/", get(empty_body).post(rpc_handler))
.with_state(default_router)
.route("/rpc/v0.3", post(rpc_handler))
.route("/rpc/v0_3", post(rpc_handler))
.with_state(v03_routes)
.route("/rpc/v0.4", post(rpc_handler))
.route("/rpc/v0_4", post(rpc_handler))
.with_state(v04_routes)
.route("/rpc/v0.5", post(rpc_handler))
.route("/rpc/v0_5", post(rpc_handler))
.with_state(v05_routes)
.route("/rpc/pathfinder/v0.1", post(rpc_handler))
.with_state(pathfinder_routes);
Expand Down Expand Up @@ -830,17 +833,32 @@ mod tests {
#[case::v05_trace("/rpc/v0.5", "v05/starknet_trace_api_openrpc.json", &[])]
#[case::v05_write("/rpc/v0.5", "v05/starknet_write_api.json", &[])]
#[case::v05_pathfinder("/rpc/v0.5", "pathfinder_rpc_api.json", &["pathfinder_version"])]
#[case::v0_5_api ("/rpc/v0_5", "v05/starknet_api_openrpc.json", &[])]
#[case::v0_5_trace("/rpc/v0_5", "v05/starknet_trace_api_openrpc.json", &[])]
#[case::v0_5_write("/rpc/v0_5", "v05/starknet_write_api.json", &[])]
#[case::v0_5_pathfinder("/rpc/v0_5", "pathfinder_rpc_api.json", &["pathfinder_version"])]

#[case::v04_api ("/rpc/v0.4", "v04/starknet_api_openrpc.json", &[])]
#[case::v04_trace("/rpc/v0.4", "v04/starknet_trace_api_openrpc.json", &[])]
#[case::v04_write("/rpc/v0.4", "v04/starknet_write_api.json", &[])]
#[case::v04_pathfinder("/rpc/v0.4", "pathfinder_rpc_api.json", &["pathfinder_version"])]
#[case::v0_4_api ("/rpc/v0_4", "v04/starknet_api_openrpc.json", &[])]
#[case::v0_4_trace("/rpc/v0_4", "v04/starknet_trace_api_openrpc.json", &[])]
#[case::v0_4_write("/rpc/v0_4", "v04/starknet_write_api.json", &[])]
#[case::v0_4_pathfinder("/rpc/v0_4", "pathfinder_rpc_api.json", &["pathfinder_version"])]

#[case::v03_api ("/rpc/v0.3", "v03/starknet_api_openrpc.json", &[])]
#[case::v03_trace("/rpc/v0.3", "v03/starknet_trace_api_openrpc.json",
&["starknet_traceTransaction", "starknet_traceBlockTransactions"])]
#[case::v03_write ("/rpc/v0.3", "v03/starknet_write_api.json", &[])]
#[case::v03_pathfinder("/rpc/v0.3", "pathfinder_rpc_api.json", &["pathfinder_version"])]
#[case::pathfinder("/rpc/pathfinder/v0.1", "pathfinder_rpc_api.json", &[])]
#[case::v0_3_api ("/rpc/v0_3", "v03/starknet_api_openrpc.json", &[])]
#[case::v0_3_trace("/rpc/v0_3", "v03/starknet_trace_api_openrpc.json",
&["starknet_traceTransaction", "starknet_traceBlockTransactions"])]
#[case::v0_3_write ("/rpc/v0_3", "v03/starknet_write_api.json", &[])]
#[case::v0_3_pathfinder("/rpc/v0_3", "pathfinder_rpc_api.json", &["pathfinder_version"])]

#[case::pathfinder("/rpc/pathfinder/v0.1", "pathfinder_rpc_api.json", &[])]

#[tokio::test]
Expand Down