CHANGELOG.md 145 KiB
Newer Older
Zeke Mostov's avatar
Zeke Mostov committed
# Changelog

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.

## [17.4.0](https://github.com/paritytech/substrate-api-sidecar/compare/v17.3.5..v17.4.0) (2024-01-24)

### Features

- feat: add decoded XCM data in blocks endpoint ([#1364](https://github.com/paritytech/substrate-api-sidecar/pull/1364)) ([555817c](https://github.com/paritytech/substrate-api-sidecar/commit/555817c888c5d4b124d1d891404472c436a4a812))

### Fix

- fix: generated a custom key for the cache in blocks endpoint ([#1381](https://github.com/paritytech/substrate-api-sidecar/pull/1381)) ([17cbd2c](https://github.com/paritytech/substrate-api-sidecar/commit/17cbd2cd6af98a826ee5f64d2868e014a3249bdb))

### Docs

- docs: correct the /transaction/material docs for metadata ([#1377](https://github.com/paritytech/substrate-api-sidecar/pull/1377)) ([ca163c7](https://github.com/paritytech/substrate-api-sidecar/commit/ca163c74e485c13b0d084d8ce8c004e3c92ee592))

### Chore

- chore(deps): bump Swatinem/rust-cache from 2.7.1 to 2.7.2 ([#1380](https://github.com/paritytech/substrate-api-sidecar/pull/1380)) ([8eca817](https://github.com/paritytech/substrate-api-sidecar/commit/8eca8172dbbac90e4c8ea0f6a89716710a6b91cf))
- chore(deps): bump Swatinem/rust-cache from 2.7.2 to 2.7.3 ([#1382](https://github.com/paritytech/substrate-api-sidecar/pull/1382)) ([792d5bb](https://github.com/paritytech/substrate-api-sidecar/commit/792d5bb4b4d84d8c5ac598771b21a1a1ec4d00d8))
- chore(deps): bump actions/cache from 3 to 4 ([#1383](https://github.com/paritytech/substrate-api-sidecar/pull/1383)) ([95987f5](https://github.com/paritytech/substrate-api-sidecar/commit/95987f55645463b43570ba8879f807d29162b02a))

## Compatibility

Tested against:
- Polkadot v10500
- Kusama v10500
- Westend v10500

## [17.3.5](https://github.com/paritytech/substrate-api-sidecar/compare/v17.3.4..v17.3.5) (2024-01-10)

### Fix

- fix: changed how claimed variable is set in staking-payouts ([#1378](https://github.com/paritytech/substrate-api-sidecar/pull/1378)) ([0560806](https://github.com/paritytech/substrate-api-sidecar/commit/056080636e11ceea2364e59bb769bea1be3429a4))

### Perf

- perf: add additional high load benchmarks for /blocks ([#1372](https://github.com/paritytech/substrate-api-sidecar/pull/1372)) ([c3d9d01](https://github.com/paritytech/substrate-api-sidecar/commit/c3d9d012762f5c93fca3d274fa08388d70296737))

### Docs

- docs: update node compatibility ([#1373](https://github.com/paritytech/substrate-api-sidecar/pull/1373)) ([51353c0](https://github.com/paritytech/substrate-api-sidecar/commit/51353c0eee1ced554c8d8c9a0067af69b8e2574c))

### Chore

- chore(deps): bump follow-redirects from 1.15.2 to 1.15.4 in /docs ([#1376](https://github.com/paritytech/substrate-api-sidecar/pull/1376)) ([b2aab7d](https://github.com/paritytech/substrate-api-sidecar/commit/b2aab7dd5ae93b1270e8baba4e2ac7e0c8d3e8ed))

## Compatibility

Tested against:
- Polkadot v10500
- Kusama v10500
- Westend v10500

## [17.3.4](https://github.com/paritytech/substrate-api-sidecar/compare/v17.3.3..v17.3.4) (2024-01-05)

### Fix

- fix: ensure statemine, and statemint are still supported ([#1374](https://github.com/paritytech/substrate-api-sidecar/pull/1374)) ([ca5079a](https://github.com/paritytech/substrate-api-sidecar/commit/ca5079a037b8911c6c6d0f8900f0ef6beec369f9))

### Chore

- chore(pjs): update polkadot-js, and fix staking ledger types ([#1371](https://github.com/paritytech/substrate-api-sidecar/pull/1371)) ([ceea8eb](https://github.com/paritytech/substrate-api-sidecar/commit/ceea8ebad59581118b061846c01ed0a80db78ae9))

## Compatibility

Tested against:
- Polkadot v10500
- Kusama v10500
- Westend v10500

## [17.3.3](https://github.com/paritytech/substrate-api-sidecar/compare/v17.3.2..v17.3.3) (2023-12-21)

**NOTE** This release focuses on improving the performance of the tool resolving a regression where `blocks` were overwhelmed with transactions. The `noFees` query parameter focuses on removing fee info for the blocks if the user does not intend on needing fees. For more general cases where fees are necessary we have increased the performance of querying `/blocks` while also calculating fees. This was done with 2 cases: ensuring `transactionPaidFee`, and `ExtrinsicSuccess` or `ExtrinsicFailure` info is used to its fullest so we can avoid making any additional rpc calls, as well as ensuring the extrinsic's are called concurrently.
### Perf

- perf: transactionPaidFee event optimization ([#1367](https://github.com/paritytech/substrate-api-sidecar/pull/1367)) ([2883249](https://github.com/paritytech/substrate-api-sidecar/commit/288324918b7445fce8be6c4606c41058c66cdf69)) 
- perf: add concurrency to fee calls ([#1368](https://github.com/paritytech/substrate-api-sidecar/pull/1368)) ([0980d1e](https://github.com/paritytech/substrate-api-sidecar/commit/0980d1e0766f1e416883c8e68ebcf04ca8ecd2fc))

### Fix

- fix: add finalizedKey query param to /blocks/{blockId} ([#1362](https://github.com/paritytech/substrate-api-sidecar/pull/1362)) ([ecd1518](https://github.com/paritytech/substrate-api-sidecar/commit/ecd1518a1e7f6b4465e90cd7ff8f6fd7a115b88b))
- fix: added query to calc fees ([#1366](https://github.com/paritytech/substrate-api-sidecar/pull/1366)) ([203a257](https://github.com/paritytech/substrate-api-sidecar/commit/203a257bea3c150ac09d7b7fa956d68e524969bc))
    NOTE: this added the noFees={bool} query param to specify whether to retrieve or not the fees information of the block for the `/blocks/*` endpoint

### Test

-  test(e2e): replace tests pointing to deprecated pallets ([#1363](https://github.com/paritytech/substrate-api-sidecar/pull/1363)) ([2a38b2e](https://github.com/paritytech/substrate-api-sidecar/commit/2a38b2e652bf621bf6cc450ce5fdacf5656d9c8c))

## Compatibility

Tested against:
- Polkadot v10400
- Kusama v10400
- Westend v10400

## [17.3.2](https://github.com/paritytech/substrate-api-sidecar/compare/v17.3.1..v17.3.2) (2023-11-26)

### Fix

- fix: add override types for asset hub conversation pallet ([#1354](https://github.com/paritytech/substrate-api-sidecar/pull/1354)) ([21e016d](https://github.com/paritytech/substrate-api-sidecar/commit/21e016d990ab0edd6cc322dc073ab576552a1320))

### Test

- test: add test for frozen deprecation in runtime ([#1353](https://github.com/paritytech/substrate-api-sidecar/pull/1353)) ([1a249a3](https://github.com/paritytech/substrate-api-sidecar/commit/1a249a3fcca5df21a85a035d49c422b265bdc2e4))

### CI

- ci: fixing gitspiegel trigger workflow ([bdb9271](https://github.com/paritytech/substrate-api-sidecar/commit/bdb9271565192ec106febee4788e888976040190))
- ci: switch e2e-tests endpoints ([#1350](https://github.com/paritytech/substrate-api-sidecar/pull/1350)) ([644b475](https://github.com/paritytech/substrate-api-sidecar/commit/644b475daf95997901430d3cc6de43cd5befe3b4))
- ci: adding gitspiegel-trigger workflow ([#1348](https://github.com/paritytech/substrate-api-sidecar/pull/1348)) ([87f47a5](https://github.com/paritytech/substrate-api-sidecar/commit/87f47a59860b43cd8797cfaf351d130572a4a207))

## Compatibility

Tested against:
- Polkadot v10300
- Kusama v10300
- Westend v10300

## [17.3.1](https://github.com/paritytech/substrate-api-sidecar/compare/v17.3.0..v17.3.1) (2023-10-30)

### Fix

- fix: bifrost type issue & small fixes in tests ([#1345](https://github.com/paritytech/substrate-api-sidecar/pull/1345)) ([567170b](https://github.com/paritytech/substrate-api-sidecar/commit/567170b7d3d8cbb53cca07c467447ba99bb24b52))

### Chore

- chore(deps): bump actions/setup-node from 3 to 4 ([#1343](https://github.com/paritytech/substrate-api-sidecar/pull/1343)) ([8fa49aa](https://github.com/paritytech/substrate-api-sidecar/commit/8fa49aaa93cfdad36fe8126262409832033bba89))
- chore(deps): bump Swatinem/rust-cache from 2.7.0 to 2.7.1 ([#1344](https://github.com/paritytech/substrate-api-sidecar/pull/1344)) ([47a47da](https://github.com/paritytech/substrate-api-sidecar/commit/47a47daaa6987836a10aea53bcd02aef453408c4))

## Compatibility

Tested against:
- Polkadot v10200
- Kusama v10200
- Westend v10200

## [17.3.0](https://github.com/paritytech/substrate-api-sidecar/compare/v17.2.0..v17.3.0) (2023-10-23)

### Features

- feat: add pool-assets endpoints ([#1338](https://github.com/paritytech/substrate-api-sidecar/pull/1338)) ([02c4a3f](https://github.com/paritytech/substrate-api-sidecar/commit/02c4a3fa9556029840bd00dd842ad7fb89afd1b6))
- feat: add blocks raw extrinsics endpoint ([#1334](https://github.com/paritytech/substrate-api-sidecar/pull/1334)) ([f486aa9](https://github.com/paritytech/substrate-api-sidecar/commit/f486aa94bd86b21d460aaf2285dda1c535cfb969))

The following endpoints are now available:
- `/blocks/:blockId/extrinsics-raw`
- `/pallets/pool-assets/{assetId}/asset-info`
- `/accounts/{accountId}/pool-asset-balances`
- `/accounts/{accountId}/pool-asset-approvals`

### Chore

- chore(yarn): bump yarn ([#1341](https://github.com/paritytech/substrate-api-sidecar/pull/1341)) ([052aaa1](https://github.com/paritytech/substrate-api-sidecar/commit/052aaa1269758c4c1fec9a383e81fe345a53c32d))
- chore(deps): update polkadot-js deps ([#1339](https://github.com/paritytech/substrate-api-sidecar/pull/1339)) ([2978d1a](https://github.com/paritytech/substrate-api-sidecar/commit/2978d1a0b3e07f81eb5c6ab3e6bf120fc96c38e2))
- chore: bump Swatinem/rust-cache from 2.6.2 to 2.7.0 ([#1332](https://github.com/paritytech/substrate-api-sidecar/pull/1332)) ([2d1d82d](https://github.com/paritytech/substrate-api-sidecar/commit/2d1d82de5cdb684a7e4ec19939892a521a949509))
- chore: bump postcss from 8.4.14 to 8.4.31 in /docs ([#1337](https://github.com/paritytech/substrate-api-sidecar/pull/1337)) ([39d016a](https://github.com/paritytech/substrate-api-sidecar/commit/39d016a6317f91078bf76b9c17ed8817150c5cde))
- chore(deps): bump @babel/traverse from 7.22.11 to 7.23.2 ([#1340](https://github.com/paritytech/substrate-api-sidecar/pull/1340)) ([b59bb90](https://github.com/paritytech/substrate-api-sidecar/commit/b59bb900791e57dbc7ba240581d656e6b1329b74))

### Docs

- docs: fix regex under the pattern keyword ([#1335](https://github.com/paritytech/substrate-api-sidecar/pull/1335)) ([fbdca75](https://github.com/paritytech/substrate-api-sidecar/commit/fbdca75b970e3955878206e6ad94ace58796cabf))

## Compatibility

Tested against:
- Polkadot v10200
- Kusama v10200
- Westend v10200
## [17.2.0](https://github.com/paritytech/substrate-api-sidecar/compare/v17.1.2..v17.2.0) (2023-09-11)

### Features

- feat: add asset-conversion endpoints ([#1324](https://github.com/paritytech/substrate-api-sidecar/pull/1324)) ([242aa09](https://github.com/paritytech/substrate-api-sidecar/commit/242aa095d9884a88d2c6467ed6cc04f25114cb0e))
- feat: add pallets/foreign-assets endpoint ([#1314](https://github.com/paritytech/substrate-api-sidecar/pull/1314)) ([450c6ea](https://github.com/paritytech/substrate-api-sidecar/commit/450c6eada4fec2e3d09579798f048b4b2b533262))

### Bug Fixes

- fix: docker-compose.yml ([#1321](https://github.com/paritytech/substrate-api-sidecar/pull/1321)) ([5c9de90](https://github.com/paritytech/substrate-api-sidecar/commit/5c9de905cf65932c301fd51a5a37ee4a2df73af0))

### CI

- ci: add semantic title check, and cleanup actions ([#1325](https://github.com/paritytech/substrate-api-sidecar/pull/1325)) ([7098710](https://github.com/paritytech/substrate-api-sidecar/commit/7098710b74c5261a2c98ffbbca57dc811789a5e8)) Contribute by: [benxiao](https://github.com/benxiao)
- ci: use buildah image defined in gitlab group vars ([#1327](https://github.com/paritytech/substrate-api-sidecar/pull/1327)) ([37344bf](https://github.com/paritytech/substrate-api-sidecar/commit/37344bfabccbd2f2830bce18e0618600c367f5ae))

### Chore

- chore(yarn): bump yarn ([#1320](https://github.com/paritytech/substrate-api-sidecar/pull/1320)) ([e744f8d](https://github.com/paritytech/substrate-api-sidecar/commit/e744f8dc2ac27e3542c6997ff23f4d65b04e319b))
- chore: bump Swatinem/rust-cache from 2.6.1 to 2.6.2 ([#1319](https://github.com/paritytech/substrate-api-sidecar/pull/1319)) ([f2bd4de](https://github.com/paritytech/substrate-api-sidecar/commit/f2bd4de7a0f63558127f4d495308f6ef5520b7f6))
- chore: bump actions/checkout from 3 to 4 ([#1326](https://github.com/paritytech/substrate-api-sidecar/pull/1326)) ([f9f9ad0](https://github.com/paritytech/substrate-api-sidecar/commit/f9f9ad05576c10562edc5ee5172b6fd1d523dfc1))

### Test

- test(fix-dev): update appropriate type packages ([#1318](https://github.com/paritytech/substrate-api-sidecar/pull/1318)) ([d0b2959](https://github.com/paritytech/substrate-api-sidecar/commit/d0b29596ca243f948d4b1357d42a113baadedf58))
- test(calc): add test for calc_payout ([#1317](https://github.com/paritytech/substrate-api-sidecar/pull/1317)) ([b105cd3](https://github.com/paritytech/substrate-api-sidecar/commit/b105cd30e7bf7bc4efd62c2a19ead989e28e3a3e))

### Docs

Loading full blame...