Merge pull request #409 from paritytech/chore/summit-descriptor-support

Prepare direct clients for Summit descriptors

Author: UtkarshBhardwaj007

.changeset/summit-w3s.md

@@ -0,0 +1,5 @@
+---
+"playground-cli": patch
+---
+
+Prepare direct chain clients for Summit descriptors when the active environment is switched.

DEPLOY.MD

@@ -36,6 +36,8 @@ Expected: a `0x…` address. If it prints `(empty)`, the CDM `DEPLOY_DOC.md` isn
 
 **b.** Flip the network switch in `src/config.ts`:
 
+Update `ACTIVE_TESTNET_ENV`: `"paseo-next-v2"` -> `"summit"`.
+
 ```ts
 export const ACTIVE_TESTNET_ENV: Env = "summit";   // was "paseo-next-v2"
 ```

src/commands/contract.ts

@@ -44,8 +44,6 @@ import {
     resolveQueryOrigin,
 } from "@parity/cdm-env";
 import { createContractFromClient } from "@parity/product-sdk-contracts";
-import { paseo_asset_hub } from "@parity/product-sdk-descriptors/paseo-asset-hub";
-import { paseo_bulletin } from "@parity/product-sdk-descriptors/paseo-bulletin";
 import { DEFAULT_MNEMONIC as PAD_DEFAULT_MNEMONIC } from "@parity/polkadot-app-deploy";
 import { Command, Option } from "commander";
 import { createClient, type HexString, type SS58String } from "polkadot-api";
@@ -61,6 +59,7 @@ import {
     wrapSignerWithEvents,
     type SigningEvent,
 } from "../utils/deploy/signingProxy.js";
+import { getAssetHubDescriptor, getBulletinDescriptor } from "../utils/descriptors.js";
 import { onProcessShutdown } from "../utils/process-guard.js";
 import { resolveSigner, type ResolvedSigner, type SignerOptions } from "../utils/signer.js";
 import { runContractDeployWithUI } from "./contractDeployUi.js";
@@ -366,6 +365,9 @@ function asCdmAssetHubDescriptor(d: unknown): PipelineChainClient["descriptors"]
 async function createContractChainClient(
     target: ContractDeployTarget,
 ): Promise<ContractChainClient> {
+    const cfg = getChainConfig();
+    const assetHubDescriptor = getAssetHubDescriptor(cfg.env);
+    const bulletinDescriptor = getBulletinDescriptor(cfg.env);
     const raw = {
         assetHub: createClient(getWsProvider([target.assethubUrl])),
         bulletin: createClient(
@@ -388,12 +390,12 @@ async function createContractChainClient(
     }
 
     return {
-        assetHub: asCdmAssetHubApi(raw.assetHub.getTypedApi(paseo_asset_hub)),
-        bulletin: raw.bulletin.getTypedApi(paseo_bulletin),
+        assetHub: asCdmAssetHubApi(raw.assetHub.getTypedApi(assetHubDescriptor)),
+        bulletin: raw.bulletin.getTypedApi(bulletinDescriptor),
         raw,
         descriptors: {
-            assetHub: asCdmAssetHubDescriptor(paseo_asset_hub),
-            bulletin: paseo_bulletin,
+            assetHub: asCdmAssetHubDescriptor(assetHubDescriptor),
+            bulletin: bulletinDescriptor,
         },
         destroy,
     };

src/config.test.ts

@@ -42,11 +42,12 @@ import { CONFIGS, DEFAULT_ENV, getPgasAssetId, type ChainConfig, type Env } from
 const { doc } = await loadEnvironments();
 
 describe("getPgasAssetId", () => {
-    it("returns the paseo-next-v2 PGAS asset id by default", () => {
-        expect(getPgasAssetId("paseo-next-v2")).toBe(2_000_000_000);
+    it("returns the active PGAS asset id by default", () => {
+        expect(getPgasAssetId()).toBe(2_000_000_000);
     });
 
     it("returns a number for every wired env", () => {
+        expect(typeof getPgasAssetId("paseo-next-v2")).toBe("number");
         expect(typeof getPgasAssetId("summit")).toBe("number");
     });
 });

src/utils/account/drip.test.ts

@@ -23,6 +23,7 @@
  */
 
 import { describe, it, expect, vi, beforeEach } from "vitest";
+import { getTokenSymbol } from "../../config.js";
 
 const mockSubmitAndWatch = vi
     .fn<(tx: unknown, signer: unknown, options?: unknown) => Promise<unknown>>()
@@ -46,6 +47,7 @@ const DEV_FUNDER = "5DfhGyQdFobKM8NsWvEeAKk5EQQgYe9AydgJ7rMB6E1EqRzV";
 const ONE_PAS = 10_000_000_000n;
 const SOURCE_BUFFER = ONE_PAS;
 const FUNDER_REQUIRED = DRIP_AMOUNT + SOURCE_BUFFER;
+const TOKEN_SYMBOL = getTokenSymbol();
 // Plenty of headroom so the preflight balance check passes in tests that
 // expect the transfer to fire.
 const FUNDER_HEALTHY = FUNDER_REQUIRED * 100n;
@@ -181,14 +183,14 @@ describe("dripToProductAccount", () => {
 
 describe("formatPas", () => {
     it("renders whole amounts without a fraction", () => {
-        expect(formatPas(0n)).toBe("0 PAS");
-        expect(formatPas(ONE_PAS)).toBe("1 PAS");
-        expect(formatPas(DRIP_CAP)).toBe("10 PAS");
+        expect(formatPas(0n)).toBe(`0 ${TOKEN_SYMBOL}`);
+        expect(formatPas(ONE_PAS)).toBe(`1 ${TOKEN_SYMBOL}`);
+        expect(formatPas(DRIP_CAP)).toBe(`10 ${TOKEN_SYMBOL}`);
     });
 
     it("trims trailing zeros and caps at 4 fractional digits", () => {
-        expect(formatPas(ONE_PAS + ONE_PAS / 2n)).toBe("1.5 PAS");
-        // 0.123456 PAS (1_234_560_000 planck at 10 decimals) -> truncated to 4 dp
-        expect(formatPas(1_234_560_000n)).toBe("0.1234 PAS");
+        expect(formatPas(ONE_PAS + ONE_PAS / 2n)).toBe(`1.5 ${TOKEN_SYMBOL}`);
+        // 0.123456 token units (1_234_560_000 planck at 10 decimals) -> truncated to 4 dp
+        expect(formatPas(1_234_560_000n)).toBe(`0.1234 ${TOKEN_SYMBOL}`);
     });
 });

src/utils/connection.test.ts

@@ -14,7 +14,7 @@
 // limitations under the License.
 
 import { describe, it, expect, vi, beforeEach } from "vitest";
-import { getNetworkLabel } from "../config.js";
+import { DEFAULT_ENV, getNetworkLabel } from "../config.js";
 
 const mockCreateClient = vi.fn();
 const mockGetWsProvider = vi.fn();
@@ -41,10 +41,31 @@ vi.mock("@parity/product-sdk-descriptors/paseo-individuality", () => ({
     paseo_individuality: { genesis: "0xpeople" },
 }));
 
+vi.mock("@parity/product-sdk-descriptors/summit-asset-hub", () => ({
+    summit_asset_hub: { genesis: "0xsummit-asset" },
+}));
+
+vi.mock("@parity/product-sdk-descriptors/summit-bulletin", () => ({
+    summit_bulletin: { genesis: "0xsummit-bulletin" },
+}));
+
+vi.mock("@parity/product-sdk-descriptors/summit-individuality", () => ({
+    summit_individuality: { genesis: "0xsummit-people" },
+}));
+
 // Re-import after each test to reset the singleton
 let getConnection: typeof import("./connection.js").getConnection;
 let destroyConnection: typeof import("./connection.js").destroyConnection;
 
+const expectedActiveDescriptors =
+    DEFAULT_ENV === "summit"
+        ? [
+              { genesis: "0xsummit-asset" },
+              { genesis: "0xsummit-bulletin" },
+              { genesis: "0xsummit-people" },
+          ]
+        : [{ genesis: "0xasset" }, { genesis: "0xbulletin" }, { genesis: "0xpeople" }];
+
 beforeEach(async () => {
     vi.resetModules();
     mockCreateClient.mockReset();
@@ -62,10 +83,13 @@ beforeEach(async () => {
 });
 
 describe("getConnection", () => {
-    it("creates direct clients for the three Paseo chains", async () => {
+    it("creates direct clients with descriptors for the active chains", async () => {
         await getConnection();
         expect(mockCreateClient).toHaveBeenCalledTimes(3);
         expect(mockGetTypedApi).toHaveBeenCalledTimes(3);
+        expect(mockGetTypedApi.mock.calls.map(([descriptor]) => descriptor)).toEqual(
+            expectedActiveDescriptors,
+        );
     });
 
     it("returns the same client on subsequent calls (singleton)", async () => {

src/utils/connection.ts

@@ -20,26 +20,24 @@ import {
     type TypedApi,
 } from "polkadot-api";
 import { getWsProvider } from "polkadot-api/ws";
-import { paseo_bulletin as bulletin } from "@parity/product-sdk-descriptors/paseo-bulletin";
-import { paseo_individuality as individuality } from "@parity/product-sdk-descriptors/paseo-individuality";
-import { paseo_asset_hub } from "@parity/product-sdk-descriptors/paseo-asset-hub";
 import { getChainConfig, getNetworkLabel } from "../config.js";
+import {
+    getAssetHubDescriptor,
+    getBulletinDescriptor,
+    getIndividualityDescriptor,
+    type AssetHubDescriptor,
+    type BulletinDescriptor,
+    type IndividualityDescriptor,
+} from "./descriptors.js";
 
-// The chain DESCRIPTORS are intentionally the `paseo_*` ones for EVERY env,
-// including summit — only the RPC URLs are env-driven (via getChainConfig). This
-// mirrors `@parity/cdm-env`, whose `DEPLOY_CHAIN_DESCRIPTORS`/`ASSET_HUB_DESCRIPTORS`
-// also map `w3s` (summit) → `paseo_asset_hub`/`paseo_bulletin`; the deploy engine
-// `@parity/polkadot-app-deploy` is descriptor-free (live `getUnsafeApi()`). PAPI
-// typed calls decode by structural type IDs, so this holds as long as summit's
-// runtime shapes match paseo's (they do today — same testnet family). Dedicated
-// `summit-*` descriptors DO exist in `@parity/product-sdk-descriptors` as an escape
-// hatch if the runtimes ever diverge; switching to them before they're needed would
-// DIVERGE from the engine. See CLAUDE.md → "Adding a network / Summit".
+// The public type name remains `PaseoClient` for compatibility with the rest of
+// the codebase, but runtime descriptor selection follows the active env. When
+// DEFAULT_ENV is summit, direct PAPI reads use product-sdk's summit descriptors.
 
 type PaseoChains = {
-    assetHub: typeof paseo_asset_hub;
-    bulletin: typeof bulletin;
-    individuality: typeof individuality;
+    assetHub: AssetHubDescriptor;
+    bulletin: BulletinDescriptor;
+    individuality: IndividualityDescriptor;
 };
 
 export type PaseoClient = {
@@ -65,6 +63,11 @@ function typedApi<T extends ChainDefinition>(raw: PolkadotClient, descriptor: T)
 
 async function connectPaseo(): Promise<PaseoClient> {
     const cfg = getChainConfig();
+    const descriptors = {
+        assetHub: getAssetHubDescriptor(cfg.env),
+        bulletin: getBulletinDescriptor(cfg.env),
+        individuality: getIndividualityDescriptor(cfg.env),
+    };
     const raw = {
         assetHub: createRawClient([cfg.assetHubRpc]),
         bulletin: createRawClient([cfg.bulletinRpc, ...cfg.bulletinRpcFallbacks]),
@@ -73,9 +76,9 @@ async function connectPaseo(): Promise<PaseoClient> {
 
     let destroyed = false;
     return {
-        assetHub: typedApi(raw.assetHub, paseo_asset_hub),
-        bulletin: typedApi(raw.bulletin, bulletin),
-        individuality: typedApi(raw.individuality, individuality),
+        assetHub: typedApi(raw.assetHub, descriptors.assetHub),
+        bulletin: typedApi(raw.bulletin, descriptors.bulletin),
+        individuality: typedApi(raw.individuality, descriptors.individuality),
         raw,
         destroy() {
             if (destroyed) return;

src/utils/deploy/bulletinAuthContext.test.ts

@@ -14,6 +14,7 @@
 // limitations under the License.
 
 import { beforeEach, describe, expect, it, vi } from "vitest";
+import { DEFAULT_ENV } from "../../config.js";
 
 const { createClientMock, getWsProviderMock, destroyMock, getTypedApiMock } = vi.hoisted(() => ({
     createClientMock: vi.fn(),
@@ -25,9 +26,15 @@ const { createClientMock, getWsProviderMock, destroyMock, getTypedApiMock } = vi
 vi.mock("polkadot-api", () => ({ createClient: createClientMock }));
 vi.mock("polkadot-api/ws", () => ({ getWsProvider: getWsProviderMock }));
 vi.mock("@parity/product-sdk-descriptors/paseo-bulletin", () => ({ paseo_bulletin: {} }));
+vi.mock("@parity/product-sdk-descriptors/summit-bulletin", () => ({
+    summit_bulletin: { genesis: "0xsummit-bulletin" },
+}));
 
 import { createBulletinAuthContext } from "./bulletinAuthContext.js";
 
+const expectedActiveBulletinDescriptor =
+    DEFAULT_ENV === "summit" ? { genesis: "0xsummit-bulletin" } : {};
+
 beforeEach(() => {
     createClientMock.mockReset();
     getWsProviderMock.mockReset();
@@ -43,6 +50,7 @@ describe("createBulletinAuthContext", () => {
 
         expect(ctx).not.toBeNull();
         expect(ctx?.bulletinApi).toEqual({ marker: "bulletin-api" });
+        expect(getTypedApiMock).toHaveBeenCalledWith(expectedActiveBulletinDescriptor);
         expect(destroyMock).not.toHaveBeenCalled();
         ctx?.destroy();
         expect(destroyMock).toHaveBeenCalledTimes(1);

src/utils/deploy/bulletinAuthContext.ts

@@ -31,11 +31,11 @@
 
 import { createClient } from "polkadot-api";
 import { getWsProvider } from "polkadot-api/ws";
-import { paseo_bulletin as bulletin } from "@parity/product-sdk-descriptors/paseo-bulletin";
 import type { CloudStorageApi } from "@parity/product-sdk-cloud-storage";
 import { asCloudStorageApi } from "../allowances/bulletin.js";
 import { getChainConfig, type Env } from "../../config.js";
 import { BULLETIN_WS_HEARTBEAT_MS } from "../bulletinWs.js";
+import { getBulletinDescriptor } from "../descriptors.js";
 
 export interface BulletinAuthContext {
     bulletinApi: CloudStorageApi;
@@ -59,7 +59,7 @@ export function createBulletinAuthContext(env: Env | undefined): BulletinAuthCon
             }),
         );
         return {
-            bulletinApi: asCloudStorageApi(client.getTypedApi(bulletin)),
+            bulletinApi: asCloudStorageApi(client.getTypedApi(getBulletinDescriptor(cfg.env))),
             destroy: () => client.destroy(),
         };
     } catch {

src/utils/deploy/playground.ts

@@ -36,12 +36,12 @@ import { readFileSync, readdirSync, statSync } from "node:fs";
 import { join } from "node:path";
 import { createClient } from "polkadot-api";
 import { getWsProvider } from "polkadot-api/ws";
-import { paseo_bulletin as bulletin } from "@parity/product-sdk-descriptors/paseo-bulletin";
 import { calculateCid } from "@parity/product-sdk-cloud-storage";
 import { submitAndWatch, withRetry } from "@parity/product-sdk-tx";
 import { getRegistryContract } from "../registry.js";
 import { getConnection } from "../connection.js";
 import { getChainConfig, type Env } from "../../config.js";
+import { getBulletinDescriptor } from "../descriptors.js";
 import { captureWarning, withSpan, errorMessage } from "../../telemetry.js";
 import {
     asCloudStorageApi,
@@ -353,7 +353,7 @@ export async function publishToPlayground(
                 }),
             );
             try {
-                const bulletinApi = bulletinClient.getTypedApi(bulletin);
+                const bulletinApi = bulletinClient.getTypedApi(getBulletinDescriptor(cfg.env));
                 const cid = (await calculateCid(metadataBytes)).toString();
                 const storeTx = bulletinApi.tx.TransactionStorage.store({ data: metadataBytes });
                 let storageSigner = await getBulletinAllowanceSigner({