@parity/product-sdk-descriptors 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -7
- package/chains/kusama-asset-hub/.papi/polkadot-api.json +1 -1
- package/chains/kusama-asset-hub/generated/dist/common-types.d.ts +440 -1096
- package/chains/kusama-asset-hub/generated/dist/descriptors-DgSoa2t9.js +25 -0
- package/chains/kusama-asset-hub/generated/dist/index.js +4 -4
- package/chains/kusama-asset-hub/generated/dist/kusama_asset_hub.d.ts +304 -496
- package/chains/kusama-asset-hub/generated/dist/kusama_asset_hub_metadata-DMsyqc9c.js +3 -0
- package/chains/kusama-asset-hub/generated/dist/metadataTypes-c7k6GZcy.js +3 -0
- package/chains/kusama-asset-hub/generated/dist/metadataTypes.d.ts +1 -1
- package/chains/paseo-asset-hub/.papi/polkadot-api.json +1 -1
- package/chains/paseo-asset-hub/generated/dist/common-types.d.ts +7 -2
- package/chains/paseo-asset-hub/generated/dist/index.js +2 -2
- package/chains/paseo-asset-hub/generated/dist/paseo_asset_hub.d.ts +7 -2
- package/chains/{previewnet-asset-hub/generated/dist/previewnet_asset_hub_metadata-UA_IAYkc.js → paseo-asset-hub/generated/dist/paseo_asset_hub_metadata-DKsZwRQC.js} +1 -1
- package/chains/paseo-individuality/.papi/polkadot-api.json +1 -1
- package/chains/paseo-individuality/generated/dist/common-types.d.ts +235 -148
- package/chains/paseo-individuality/generated/dist/descriptors-CrbK0sgs.js +25 -0
- package/chains/paseo-individuality/generated/dist/index.js +4 -4
- package/chains/paseo-individuality/generated/dist/metadataTypes-4wzPDBw3.js +3 -0
- package/chains/paseo-individuality/generated/dist/metadataTypes.d.ts +1 -1
- package/chains/paseo-individuality/generated/dist/paseo_individuality.d.ts +192 -69
- package/chains/paseo-individuality/generated/dist/paseo_individuality_metadata-CzMl_OiD.js +3 -0
- package/chains/polkadot-asset-hub/.papi/polkadot-api.json +1 -1
- package/chains/polkadot-asset-hub/generated/dist/common-types.d.ts +401 -1017
- package/chains/polkadot-asset-hub/generated/dist/descriptors-CoscEQ9e.js +25 -0
- package/chains/polkadot-asset-hub/generated/dist/index.js +4 -4
- package/chains/polkadot-asset-hub/generated/dist/metadataTypes-Dk55glaU.js +3 -0
- package/chains/polkadot-asset-hub/generated/dist/metadataTypes.d.ts +1 -1
- package/chains/polkadot-asset-hub/generated/dist/polkadot_asset_hub.d.ts +301 -485
- package/chains/polkadot-asset-hub/generated/dist/polkadot_asset_hub_metadata-BEYst3UH.js +3 -0
- package/package.json +1 -13
- package/chains/kusama-asset-hub/generated/dist/descriptors-DYyEriME.js +0 -25
- package/chains/kusama-asset-hub/generated/dist/kusama_asset_hub_metadata-C4kQ8RaO.js +0 -3
- package/chains/kusama-asset-hub/generated/dist/metadataTypes-DU1nurc8.js +0 -3
- package/chains/paseo-asset-hub/generated/dist/paseo_asset_hub_metadata-UA_IAYkc.js +0 -3
- package/chains/paseo-individuality/generated/dist/descriptors-B1XZ3XJy.js +0 -25
- package/chains/paseo-individuality/generated/dist/metadataTypes-BaUy_4gO.js +0 -3
- package/chains/paseo-individuality/generated/dist/paseo_individuality_metadata-Bfu1vCrE.js +0 -3
- package/chains/polkadot-asset-hub/generated/dist/descriptors-BLVA_gBo.js +0 -25
- package/chains/polkadot-asset-hub/generated/dist/metadataTypes-BAQsZ8u3.js +0 -3
- package/chains/polkadot-asset-hub/generated/dist/polkadot_asset_hub_metadata-CQQZadL1.js +0 -3
- package/chains/previewnet-asset-hub/.papi/polkadot-api.json +0 -12
- package/chains/previewnet-asset-hub/generated/dist/common-types.d.ts +0 -16923
- package/chains/previewnet-asset-hub/generated/dist/common.d.ts +0 -1
- package/chains/previewnet-asset-hub/generated/dist/descriptors-uhwNzCA5.js +0 -25
- package/chains/previewnet-asset-hub/generated/dist/descriptors.d.ts +0 -1
- package/chains/previewnet-asset-hub/generated/dist/index.d.ts +0 -10
- package/chains/previewnet-asset-hub/generated/dist/index.js +0 -116
- package/chains/previewnet-asset-hub/generated/dist/metadataTypes-C_2YPTST.js +0 -3
- package/chains/previewnet-asset-hub/generated/dist/metadataTypes.d.ts +0 -2
- package/chains/previewnet-asset-hub/generated/dist/previewnet_asset_hub.d.ts +0 -16362
- package/chains/previewnet-asset-hub/generated/dist/previewnet_asset_hub_metadata.d.ts +0 -2
- package/chains/previewnet-bulletin/.papi/polkadot-api.json +0 -12
- package/chains/previewnet-bulletin/generated/dist/common-types.d.ts +0 -4440
- package/chains/previewnet-bulletin/generated/dist/common.d.ts +0 -1
- package/chains/previewnet-bulletin/generated/dist/descriptors-h6xJR9O2.js +0 -25
- package/chains/previewnet-bulletin/generated/dist/descriptors.d.ts +0 -1
- package/chains/previewnet-bulletin/generated/dist/index.d.ts +0 -10
- package/chains/previewnet-bulletin/generated/dist/index.js +0 -88
- package/chains/previewnet-bulletin/generated/dist/metadataTypes-BOa_7XZY.js +0 -3
- package/chains/previewnet-bulletin/generated/dist/metadataTypes.d.ts +0 -2
- package/chains/previewnet-bulletin/generated/dist/previewnet_bulletin.d.ts +0 -3833
- package/chains/previewnet-bulletin/generated/dist/previewnet_bulletin_metadata-BaLIpmxp.js +0 -3
- package/chains/previewnet-bulletin/generated/dist/previewnet_bulletin_metadata.d.ts +0 -2
- package/chains/previewnet-individuality/.papi/polkadot-api.json +0 -12
- package/chains/previewnet-individuality/generated/dist/common-types.d.ts +0 -11260
- package/chains/previewnet-individuality/generated/dist/common.d.ts +0 -1
- package/chains/previewnet-individuality/generated/dist/descriptors-CDoklESi.js +0 -25
- package/chains/previewnet-individuality/generated/dist/descriptors.d.ts +0 -1
- package/chains/previewnet-individuality/generated/dist/index.d.ts +0 -10
- package/chains/previewnet-individuality/generated/dist/index.js +0 -88
- package/chains/previewnet-individuality/generated/dist/metadataTypes-BaUy_4gO.js +0 -3
- package/chains/previewnet-individuality/generated/dist/metadataTypes.d.ts +0 -2
- package/chains/previewnet-individuality/generated/dist/previewnet_individuality.d.ts +0 -10696
- package/chains/previewnet-individuality/generated/dist/previewnet_individuality_metadata-Bfu1vCrE.js +0 -3
- package/chains/previewnet-individuality/generated/dist/previewnet_individuality_metadata.d.ts +0 -2
package/README.md
CHANGED
|
@@ -9,15 +9,8 @@ PAPI-generated chain descriptors for the Polkadot ecosystem. These provide fully
|
|
|
9
9
|
| Polkadot Asset Hub | `@parity/product-sdk-descriptors/polkadot-asset-hub` | Production |
|
|
10
10
|
| Kusama Asset Hub | `@parity/product-sdk-descriptors/kusama-asset-hub` | Production |
|
|
11
11
|
| Paseo Asset Hub | `@parity/product-sdk-descriptors/paseo-asset-hub` | Testnet |
|
|
12
|
-
| Previewnet Asset Hub | `@parity/product-sdk-descriptors/previewnet-asset-hub` | Dev (zombienet) |
|
|
13
12
|
| Paseo Bulletin | `@parity/product-sdk-descriptors/paseo-bulletin` | Testnet |
|
|
14
|
-
| Previewnet Bulletin | `@parity/product-sdk-descriptors/previewnet-bulletin` | Dev (zombienet) |
|
|
15
13
|
| Paseo Individuality | `@parity/product-sdk-descriptors/paseo-individuality` | Testnet |
|
|
16
|
-
| Previewnet Individuality | `@parity/product-sdk-descriptors/previewnet-individuality` | Dev (zombienet) |
|
|
17
|
-
|
|
18
|
-
Bulletin and individuality ship a separate descriptor per environment so that
|
|
19
|
-
`descriptor.genesis` matches the live chain instance. The underlying runtime is
|
|
20
|
-
shared today (all Paseo runtime), but the chain instances are distinct deployments.
|
|
21
14
|
|
|
22
15
|
## Usage
|
|
23
16
|
|
|
@@ -83,3 +76,22 @@ pnpm build
|
|
|
83
76
|
```
|
|
84
77
|
|
|
85
78
|
5. Run `pnpm generate` to fetch metadata and generate descriptors
|
|
79
|
+
|
|
80
|
+
## Detecting Drift
|
|
81
|
+
|
|
82
|
+
PAPI's bundled type bindings are a frozen snapshot at the moment `pnpm generate` last ran. When a chain runtime upgrades, the bundled descriptors go stale — PAPI then either errors with `Incompatible runtime entry RuntimeCall(...)` or silently mis-decodes a subscription so it never emits an event.
|
|
83
|
+
|
|
84
|
+
The [`product-sdk: Descriptors drift`](../../../.github/workflows/product-sdk-descriptors-drift.yml) workflow catches this before E2E does. It runs daily, connects to each chain's RPC via `papi update --skip-codegen`, and compares the live `codeHash` and `genesis` against what's pinned in `chains/*/.papi/polkadot-api.json`.
|
|
85
|
+
|
|
86
|
+
On drift it opens (or updates in place) a single tracking issue labeled `descriptors-drift`. On a fully-clean run it closes the issue.
|
|
87
|
+
|
|
88
|
+
### What to do when the auto-issue fires
|
|
89
|
+
|
|
90
|
+
1. `cd packages/descriptors`
|
|
91
|
+
2. `pnpm generate` — fetches fresh metadata from every chain RPC and rewrites `chains/*/.papi/polkadot-api.json` + the `.scale` metadata blobs
|
|
92
|
+
3. `pnpm build` — regenerates the TypeScript bindings under `chains/*/generated/dist/`
|
|
93
|
+
4. `git diff packages/descriptors/` — verify nothing else changed unexpectedly
|
|
94
|
+
5. `pnpm changeset` — add a `@parity/product-sdk-descriptors: patch` entry (or `minor` if the runtime added new pallets or changed decode shape)
|
|
95
|
+
6. Open a PR. Run `pnpm test:e2e` against the regenerated bindings before merging — drift sometimes hides a real consumer-side break (e.g. a pallet rename)
|
|
96
|
+
|
|
97
|
+
The workflow will close the tracking issue automatically on the next scheduled run once every chain is clean.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"chain": "kusama_asset_hub",
|
|
7
7
|
"metadata": "../../.papi/metadata/kusama_asset_hub.scale",
|
|
8
8
|
"genesis": "0x48239ef607d7928874027a43a67689209727dfb3d3dc5e5b03a39bdc2eda771a",
|
|
9
|
-
"codeHash": "
|
|
9
|
+
"codeHash": "0x75086dc1a829e7a39bef2398d082e29adb23511defe35fd26a829798af49942b"
|
|
10
10
|
}
|
|
11
11
|
}
|
|
12
12
|
}
|