v1.0.0-rc1

Important note

This is a release candidate for v1.0.0 and it includes both v0 and v1 endpoints. The release candidate tag will be dropped from Sidecar on Friday, October 16th, 2020. After that date v0 endpoints are considered deprecated and will be removed in the next major release. To learn more about migrating to the new endpoints check out the migration guide here.

API noteworthy

• Configurable logging with options exposed through environment variables (#270, #300)

v0.18.1

Bug fix

Fixes an internal issue accidentally introduced to the /blocks endpoint in v0.18.0. The v1 BlocksService was using ensureMeta when it was not supposed to.

v0.18.0

Upgrade priority: High

Bug fix

This release includes an updated version of polkadot-js that should fix issues with decoding events on Sidecar instances that have made historic queries across runtime versions. (fixes: #290, possibly helps: #253, the fix itself: polkadot-js/api#2621)

API updates:

• (May be breaking for some users)/blocks response update: Unsigned extrinsics and inherents will have null for nonce and tip, while
  paysFee will always be false. Previously the latter two fields were 0, while
  paysFee was often true. (#274)
• New endpoint: /pallets/{palletId}/storage/{storageItemId} (#278)

v0.17.0

Breaking changes for runtimes with the new RewardDestination enum:

• In kusama 2023 and polkadot 23, RewardDestination is now represented as { “Staked”: null } instead of simply ”Staked”. This change comes from how polkadot-js represents enums and is not a breaking change at the substrate layer. This change effects releases back to v0.15.0. (#259)

New endpoints:

• /transaction/material (previously tx/artifacts),
• /transaction/fee-estimate ( previously /tx/fee-estimate)
• /accounts/{accountId}/staking-info (previously /staking/{accountId}) (#248)
• /accounts/{accountId}/balance-info (previously /balance/{accountId}) (#248)
• pallets/staking/progress (previously /staking-info`) (#248)
• /accounts/{accountId}/vesting-info (previously /vesting/{accountId}) (#248)
• / is completely reworked and now dynamically lists all endpoints and links to docs. (#273)

Endpoint modifications:

• extrinsicDocs and eventDocs query params added to the /blocks/{ {blockId}, head } endpoint. (#260)
• finalized query param added to the /blocks/head endpoint. (#272)

*Consult the README.md to learn more about all new paths. No endpoints have been removed, we have just added endpoints as we prepare for a v1.0.0.beta release. Look out for more details on the API transition process in the coming weeks.

Internal:

• ensureMeta deprecated (#279)
• Docs UI framework added (#239)
• Templates for github issues (#223)
• Various dep bumps (#283, #264)

v0.16.0

High upgrade priority due to new types:

• Polkadot: 23
• Kusama: 2023
• Westend: 43

API noteworthy:

• Support for new types (#247, #252)
• Add at field to /runtime/spec (#245)
• Implement /runtime/metadata (#242)
• Implement /blocks (#250, #247, #251) N.B. While the URI will likely not break between now and v1.0.0, it is likely there may be breaking changes to the response. Note: this is different than the /block endpoint (no s), which is still available.

Internal updates:

• Prepare v0 endpoints for deprecation. We will announce an official time line for when we will cease support soon, but for now it is ok to continue use. (#241)
• Deprecate ensureMeta (#247)

v0.15.0

Both this release (v0.15.0) and the previous release (v0.14.0) should work with polkadot v0.8.23.

• New /transaction/dry-run endpoint. See README.md and here for more info. (#236, #240)
• Slight optimizations to the /block endpoint. (#233)

v0.14.0

• Add node endpoints for version, transaction pool, and network information (#226)
• Add runtime endpoints for version and Wasm code (#228)
• Add staking payouts endpoint for claimed and unclaimed staking rewards of a stash address (#217)

v0.13.0

This release is approved for Polkadot version 22 (the version of the upcoming runtime upgrade).

Api noteworthy

• Enhanced transaction error messages. These are non-breaking changes as they only add fields to the response. (#202)
• noMeta query param for tx/artifacts that allows the user to specify that they do not need the metadata. This is useful if endpoint response time is a concern and the user already has the metadata. With no query param input the endpoint signature remains unchanged. (#222)

Other

• Increased test coverage of services.
• Internal updates to the response normalization engine. (#154)
• Updated sample docker setup. (#191)
• Bump dependencies. (#219, #211, #206)
• Updated openapi proposal. (#209)

v0.12.0

• Breaking change to /block response by removing newArgs field and updating the args field in extrinsics (#186). We recommend phasing out the use of newArgs and upgrading to this version as soon as possible in order to be ready for subsequent version bumps that may be mandatory.
• Internal refactor of services and additional unit tests (#171, #181, #184)

v0.11.3

• API bump for Polkadot runtime 15
• More unit testing