Skip to content

Commit 79785f0

Browse files
authored
chore: deprecate substrate-api-sidecar in favor of polkadot-rest-api (#1951)
* add deprecation message * remove emojis & mention v1 * add startup log warning * add deprecation note in changelog for next release * add deprecation note in dockerfile readme * update docs and docs-v2 with deprecation note * update github issue templates with deprecation note * update bifrost endpoint * fix: removed CoretimeAssignmentProvider from requiredPallets - CoretimeAssignmentProvider pallet was removed from the relay chain runtime in polkadot-sdk PR 10184
1 parent 6df8f9f commit 79785f0

14 files changed

Lines changed: 5432 additions & 5330 deletions

File tree

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ labels: Enhancement
66
assignees: ""
77
---
88

9+
> ⚠️ **`substrate-api-sidecar` is deprecated** in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api), a Rust rewrite with 1:1 API compatibility. **New features will not be added to this repository.**
10+
>
11+
> Please file your feature request against [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api/issues/new/choose) instead — that's where new development is happening.
12+
>
13+
> Migration guide: https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md
14+
915
**Proposed Change or Idea**
1016

1117
[Describe your request for a new idea/feature or improvement of an existing

.github/ISSUE_TEMPLATE/report-bug.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ labels: ""
66
assignees: ""
77
---
88

9+
> ⚠️ **`substrate-api-sidecar` is deprecated** in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api), a Rust rewrite with 1:1 API compatibility.
10+
>
11+
> **If possible, please reproduce against [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api) first** — if the bug exists there, file it [there](https://github.com/paritytech/polkadot-rest-api/issues/new/choose) so it's fixed in the actively-developed version.
12+
>
13+
> Migration guide: https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md
14+
915
**Description**
1016

1117
[Please add a clear description of the bug you are encountering, such as any

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

5+
## Unreleased
6+
7+
### ⚠️ Deprecation Notice
8+
9+
**`substrate-api-sidecar` is deprecated in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api).**
10+
11+
`polkadot-rest-api` is a ground-up Rust rewrite built on [`subxt`](https://github.com/paritytech/subxt) with 1:1 API compatibility (endpoints served under `/v1/`, e.g. `/v1/blocks/head`), stable memory under sustained load, significantly lower latency and higher throughput, and native SCALE decoding via `parity-scale-codec`. Stable v0.1.0 follows seven beta releases with partner feedback.
12+
13+
- Docker: `docker pull paritytech/polkadot-rest-api:v0.1.0`
14+
- Crate: [`polkadot-rest-api@0.1.0`](https://crates.io/crates/polkadot-rest-api)
15+
- GitHub: https://github.com/paritytech/polkadot-rest-api
16+
- Documentation: https://paritytech.github.io/polkadot-rest-api/
17+
- Migration guide: [MIGRATION.md](https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md)
18+
- Issues/feedback: https://github.com/paritytech/polkadot-rest-api/issues
19+
520
## [20.14.0](https://github.com/paritytech/substrate-api-sidecar/compare/v20.13.3..v20.14.0) (2026-02-01)
621

722
### Feat

Dockerfile.README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
## substrate-api-sidecar Docker Image
22

3+
## ⚠️ Deprecation Notice
4+
5+
**`substrate-api-sidecar` is deprecated in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api).**
6+
7+
`polkadot-rest-api` is a ground-up Rust rewrite built on [`subxt`](https://github.com/paritytech/subxt), with 1:1 API compatibility (endpoints are served under `/v1/`, e.g. `/v1/blocks/head`), stable memory under sustained load, significantly lower latency and higher throughput, and native SCALE decoding via `parity-scale-codec`.
8+
9+
**Migrate today:**
10+
- Docker: `docker pull paritytech/polkadot-rest-api:v0.1.0`
11+
- Crate: [`polkadot-rest-api@0.1.0`](https://crates.io/crates/polkadot-rest-api)
12+
- Migration guide: [MIGRATION.md](https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md)
13+
- Documentation: https://paritytech.github.io/polkadot-rest-api/
14+
- Questions/issues: https://github.com/paritytech/polkadot-rest-api/issues
15+
16+
---
17+
318
With each release, the maintainers publish a docker image to dockerhub at [parity/substrate-api-sidecar](https://hub.docker.com/r/parity/substrate-api-sidecar/tags?page=1&ordering=last_updated)
419

520
### Pull the latest release

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@
2121

2222
<br /><br />
2323

24+
## ⚠️ Deprecation Notice
25+
26+
**`substrate-api-sidecar` is deprecated in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api).**
27+
28+
`polkadot-rest-api` is a ground-up Rust rewrite built on [`subxt`](https://github.com/paritytech/subxt), with 1:1 API compatibility (endpoints are served under /v1/, e.g. /v1/blocks/head), stable memory under sustained load, significantly lower latency and higher throughput, and native SCALE decoding via `parity-scale-codec`.
29+
30+
**Migrate today:**
31+
- Docker: `docker pull paritytech/polkadot-rest-api:v0.1.0`
32+
- Crate: [`polkadot-rest-api@0.1.0`](https://crates.io/crates/polkadot-rest-api)
33+
- Migration guide: [MIGRATION.md](https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md)
34+
- Documentation: https://paritytech.github.io/polkadot-rest-api/
35+
- Questions/issues: https://github.com/paritytech/polkadot-rest-api/issues
36+
2437
## NOTICE
2538

2639
For the Asset hub migration please refer to the guide in [guides/ASSET_HUB_MIGRATION.md](guides/ASSET_HUB_MIGRATION.md)

docs-v2/dist/bundle.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs-v2/dist/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs-v2/index.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@
2020
<!-- Styles will be injected by webpack -->
2121
</head>
2222
<body>
23+
<!-- Deprecation banner (site-wide, always visible) -->
24+
<div class="deprecation-banner" role="alert" style="background: #b45309; color: #fff; padding: 12px 24px; font-size: 14px; line-height: 1.5; border-bottom: 2px solid #92400e; text-align: center; font-family: 'Inter', system-ui, sans-serif; position: relative; z-index: 10000;">
25+
<strong>⚠️ Deprecation Notice:</strong>
26+
<code style="background: rgba(0,0,0,0.25); padding: 1px 6px; border-radius: 3px;">substrate-api-sidecar</code>
27+
is deprecated in favor of
28+
<a href="https://github.com/paritytech/polkadot-rest-api" target="_blank" rel="noopener" style="color: #fff; text-decoration: underline; font-weight: 600;">polkadot-rest-api</a>
29+
— a Rust rewrite with 1:1 API compatibility.
30+
<a href="https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md" target="_blank" rel="noopener" style="color: #fff; text-decoration: underline; font-weight: 600;">Migration guide →</a>
31+
</div>
32+
2333
<!-- Loading screen -->
2434
<div id="loading-screen" class="loading-screen">
2535
<div class="loading-spinner">

docs-v2/openapi-v1.yaml

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
11
openapi: 3.0.0
22
info:
33
title: Substrate API Sidecar
4-
description: Substrate API Sidecar is a REST service that makes it easy to
5-
interact with blockchain nodes built using Substrate's FRAME framework.
4+
description: |
5+
> ⚠️ **Deprecation Notice** — `substrate-api-sidecar` is deprecated in favor of
6+
> [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api), a ground-up Rust rewrite
7+
> built on [`subxt`](https://github.com/paritytech/subxt) with 1:1 API compatibility (endpoints
8+
> served under `/v1/`, e.g. `/v1/blocks/head`), stable memory under sustained load, significantly
9+
> lower latency and higher throughput, and native SCALE decoding via `parity-scale-codec`.
10+
>
11+
> **Migrate today:** Docker `paritytech/polkadot-rest-api:v0.1.0` ·
12+
> [crate](https://crates.io/crates/polkadot-rest-api) ·
13+
> [migration guide](https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md) ·
14+
> [docs](https://paritytech.github.io/polkadot-rest-api/) ·
15+
> [issues](https://github.com/paritytech/polkadot-rest-api/issues)
16+
17+
Substrate API Sidecar is a REST service that makes it easy to interact with blockchain nodes
18+
built using Substrate's FRAME framework.
619
contact:
720
url: https://github.com/paritytech/substrate-api-sidecar
821
license:

0 commit comments

Comments
 (0)