Skip to content

chore: deprecate substrate-api-sidecar in favor of polkadot-rest-api#1951

Merged
Imod7 merged 9 commits into
masterfrom
domi-deprecation-announcement
Apr 27, 2026
Merged

chore: deprecate substrate-api-sidecar in favor of polkadot-rest-api#1951
Imod7 merged 9 commits into
masterfrom
domi-deprecation-announcement

Conversation

@Imod7
Copy link
Copy Markdown
Contributor

@Imod7 Imod7 commented Apr 23, 2026

Description

Deprecating substrate-api-sidecar in favor of polkadot-rest-api.

Tasks

  • Add deprecation message to README.md
  • Add startup log warning in src/App.ts
  • Add deprecation entry to CHANGELOG.md for the next release
  • Add deprecation banner to Dockerfile.README.md
  • Add top-of-page deprecation banner to the API docs (docs & docsv2)
  • Add a top banner with deprecation note in the github issue templates (feature-request.md and report-bug.md)

Out of scope for this PR

This PR contains only file edits inside the repository. Two further actions remain to fully publish the deprecation, both of which require platform credentials and cannot be performed in source control:

  • npm registry deprecation: a maintainer with publish rights on @substrate/api-sidecar must run
    npm deprecate @substrate/api-sidecar@"*" "Deprecated in favor of polkadot-rest-api (Rust rewrite, 1:1 API-compatible). Migrate: https://github.com/paritytech/polkadot-rest-api".
  • Docker Hub Overview update: an admin on parity/substrate-api-sidecar must paste the deprecation
    banner into the Docker Hub Overview field manually. The repo has no auto-sync action, so the
    Dockerfile.README.md change in this PR does not propagate.

@Imod7 Imod7 requested a review from a team as a code owner April 23, 2026 11:38
Copy link
Copy Markdown
Contributor

@filvecchiato filvecchiato left a comment

Choose a reason for hiding this comment

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

Just a comment otherwise good to go

Comment thread README.md Outdated

**`substrate-api-sidecar` is deprecated in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api).**

`polkadot-rest-api` is a ground-up Rust rewrite built on [`subxt`](https://github.com/paritytech/subxt), with 1:1 API compatibility, stable memory under sustained load, significantly lower latency and higher throughput, and native SCALE decoding via `parity-scale-codec`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is it worth metioning the /v1 in the endpoints?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I mentioned it right after the API compatibility in a parenthesis. Wdyt? Is it enough to get users attention?

Comment thread README.md Outdated
@Imod7 Imod7 changed the title Add deprecation message in README chore: deprecate substrate-api-sidecar in favor of polkadot-rest-api Apr 23, 2026
@Imod7 Imod7 requested a review from a team as a code owner April 27, 2026 08:14
Imod7 added 2 commits April 27, 2026 14:03
- CoretimeAssignmentProvider pallet was removed from the relay chain runtime in polkadot-sdk PR 10184
@Imod7 Imod7 merged commit 79785f0 into master Apr 27, 2026
16 checks passed
@Imod7 Imod7 deleted the domi-deprecation-announcement branch April 27, 2026 12:37
@Imod7 Imod7 mentioned this pull request Apr 28, 2026
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