@dotdm/env 1.0.0 → 1.0.1-dev.1778555844

package/dist/index.d.ts

@@ -1,73 +1,130 @@
 export { DEFAULT_NODE_URL, REGISTRY_ADDRESS } from '@dotdm/utils';
 import * as polkadot_api from 'polkadot-api';
 import { PolkadotClient, TypedApi } from 'polkadot-api';
-import { ChainClient } from '@polkadot-apps/chain-client';
-import { paseo_asset_hub } from '@polkadot-apps/descriptors/paseo-asset-hub';
-import { bulletin } from '@polkadot-apps/descriptors/bulletin';
+import { polkadot_asset_hub } from '@parity/product-sdk-descriptors/polkadot-asset-hub';
+import { paseo_asset_hub } from '@parity/product-sdk-descriptors/paseo-asset-hub';
+import { previewnet_asset_hub } from '@parity/product-sdk-descriptors/previewnet-asset-hub';
+import { paseo_bulletin } from '@parity/product-sdk-descriptors/paseo-bulletin';
+import { previewnet_bulletin } from '@parity/product-sdk-descriptors/previewnet-bulletin';
 export { ss58Address } from '@polkadot-labs/hdkd-helpers';
 
 interface ChainFaucet {
     label: string;
     url: string;
 }
+type ProductSdkEnvironment = "paseo" | "previewnet";
 interface ChainPreset {
     assethubUrl: string;
     bulletinUrl: string;
     ipfsGatewayUrl: string;
-    faucets?: ChainFaucet[];
+    registryAddress?: string;
+    productSdkEnvironment?: ProductSdkEnvironment;
+    faucets?: readonly ChainFaucet[];
 }
-declare const KNOWN_CHAINS: Record<string, ChainPreset>;
+declare const KNOWN_CHAINS: {
+    readonly polkadot: {
+        readonly assethubUrl: "wss://polkadot-asset-hub-rpc.polkadot.io";
+        readonly bulletinUrl: "wss://polkadot-bulletin-rpc.polkadot.io";
+        readonly ipfsGatewayUrl: "https://polkadot-bulletin-rpc.polkadot.io/ipfs";
+        readonly registryAddress: "0xae344f7f0f91d3a2176032af2990abcc7606c7d4";
+    };
+    readonly paseo: {
+        readonly assethubUrl: "wss://asset-hub-paseo-rpc.n.dwellir.com";
+        readonly bulletinUrl: "wss://paseo-bulletin-rpc.polkadot.io";
+        readonly ipfsGatewayUrl: "https://paseo-ipfs.polkadot.io/ipfs";
+        readonly registryAddress: "0xae344f7f0f91d3a2176032af2990abcc7606c7d4";
+        readonly productSdkEnvironment: "paseo";
+        readonly faucets: readonly [{
+            readonly label: "Asset Hub";
+            readonly url: "https://faucet.polkadot.io/";
+        }, {
+            readonly label: "Bulletin";
+            readonly url: "https://paritytech.github.io/polkadot-bulletin-chain/authorizations?tab=faucet";
+        }];
+    };
+    readonly "preview-net": {
+        readonly assethubUrl: "wss://previewnet.substrate.dev/asset-hub";
+        readonly bulletinUrl: "wss://paseo-bulletin-rpc.polkadot.io";
+        readonly ipfsGatewayUrl: "https://paseo-ipfs.polkadot.io/ipfs";
+        readonly registryAddress: "0x5c7b23d386ff622c7f7a4e7a95d5c7a67b10a00d";
+        readonly productSdkEnvironment: "previewnet";
+    };
+    readonly local: {
+        readonly assethubUrl: "ws://127.0.0.1:10020";
+        readonly bulletinUrl: "ws://127.0.0.1:10030";
+        readonly ipfsGatewayUrl: "http://127.0.0.1:8283/ipfs";
+        readonly registryAddress: "0xae344f7f0f91d3a2176032af2990abcc7606c7d4";
+    };
+};
 type KnownChainName = keyof typeof KNOWN_CHAINS;
+declare function isKnownChainPreset(name: string): boolean;
 declare function getChainPreset(name: string): ChainPreset;
 
+type CdmDeployAssetHubDescriptor = typeof paseo_asset_hub | typeof previewnet_asset_hub;
+type CdmAssetHubDescriptor = CdmDeployAssetHubDescriptor | typeof polkadot_asset_hub;
+type CdmBulletinDescriptor = typeof paseo_bulletin | typeof previewnet_bulletin;
+type CdmDeployAssetHubApi = TypedApi<CdmDeployAssetHubDescriptor>;
+type CdmAssetHubApi = TypedApi<CdmAssetHubDescriptor>;
+type CdmBulletinApi = TypedApi<CdmBulletinDescriptor>;
 /**
  * Shape of a CDM chain client — both Asset Hub and Bulletin connected
- * under one `ChainClient` managed by `@polkadot-apps/chain-client`.
+ * under one chain-client-shaped object.
  *
- * Uses `@polkadot-apps/descriptors` for the chain descriptors so the
+ * Uses `@parity/product-sdk-descriptors` for the chain descriptors so the
  * resulting `TypedApi` types line up natively with `ContractDeployer`,
- * `MetadataPublisher`, and the @polkadot-apps batch/bulletin helpers
- * (no casts required). We pin AssetHub to the Paseo flavor — it's the
- * primary test target, and the pallet surface matches Polkadot/Kusama
- * AssetHub at the queries/txs we use.
+ * `MetadataPublisher`, and the product-sdk batch/bulletin helpers. TEMPORARY_PATCH! Preview-net
+ * currently uses its own Asset Hub descriptor and Paseo's Bulletin descriptor
+ * because CDM stores preview-net metadata on Paseo Bulletin.
  */
-type CdmChainClient = ChainClient<{
-    assetHub: typeof paseo_asset_hub;
-    bulletin: typeof bulletin;
-}>;
+type CdmChainClient = {
+    assetHub: CdmDeployAssetHubApi;
+    bulletin: CdmBulletinApi;
+    raw: {
+        assetHub: PolkadotClient;
+        bulletin: PolkadotClient;
+    };
+    destroy: () => void;
+};
 /** Asset-Hub-only variant for callers that don't need Bulletin (e.g., `install`). */
-type CdmAssetHubClient = ChainClient<{
-    assetHub: typeof paseo_asset_hub;
-}>;
+type CdmAssetHubClient = {
+    assetHub: CdmAssetHubApi;
+    raw: {
+        assetHub: PolkadotClient;
+    };
+    destroy: () => void;
+};
 interface AssetHubConnection {
     client: PolkadotClient;
-    api: TypedApi<typeof paseo_asset_hub>;
+    api: CdmAssetHubApi;
 }
 interface BulletinConnection {
     client: PolkadotClient;
-    api: TypedApi<typeof bulletin>;
+    api: CdmBulletinApi;
 }
 interface CdmChainEndpoints {
     assethubUrl: string;
     bulletinUrl: string;
+    chainName?: string;
 }
 /**
- * Connect to both Asset Hub and Bulletin using `@polkadot-apps/chain-client`.
+ * Connect to both Asset Hub and Bulletin over direct WebSocket RPC.
  *
- * Accepts either a known chain name (`"polkadot"`, `"paseo"`, `"local"`,
- * `"preview-net"`) resolved through `getChainPreset`, or explicit URLs.
+ * Accepts either a supported deploy chain name (`"paseo"`, `"preview-net"`,
+ * `"local"`) resolved through `getChainPreset`, or explicit URLs. Polkadot
+ * remains available for Asset-Hub-only install reads, but product-sdk does
+ * not publish a Polkadot Bulletin descriptor yet.
  *
- * The returned `ChainClient` manages both connections — one `.destroy()`
- * call tears everything down. `chain-client` caches by genesis-hash
- * fingerprint, so repeated calls with the same descriptor set share a
- * single instance.
+ * The returned object matches product-sdk's `ChainClient` shape closely enough
+ * for callers to pass either one into CDM APIs. CDM builds this locally because
+ * product-sdk's published chain-client is host-provider-only and ignores RPC
+ * URLs, while the CLI must keep working as a standalone process.
  */
 declare function createCdmChainClient(arg: string | CdmChainEndpoints): Promise<CdmChainClient>;
 /**
  * Connect to Asset Hub only (no Bulletin). Used by commands that don't
  * publish metadata — e.g., `install`, `account map`, `deploy-registry`.
  */
-declare function createCdmAssetHubClient(assethubUrl: string): Promise<CdmAssetHubClient>;
+declare function createCdmAssetHubClient(assethubUrl: string, chainName?: string): Promise<CdmAssetHubClient>;
 interface IpfsGateway {
     fetch: (cid: string) => Promise<Response>;
 }
@@ -76,11 +133,9 @@ interface IpfsGateway {
  * by CID. Unrelated to chain-client; kept here alongside the chain-connection
  * factory for convenience.
  *
- * `@polkadot-apps/bulletin` offers gateway helpers (`getGateway`, `fetchBytes`,
- * `fetchJson`), but those key off a fixed `Environment` enum
- * (polkadot/kusama/paseo) and don't yet cover CDM's custom networks
- * (local, preview-net). Keep this thin wrapper until CDM can map its
- * `KNOWN_CHAINS` onto that enum.
+ * Product SDK's Bulletin read helpers go through the host preimage
+ * subscription and do not cover CDM's custom gateway URLs (local,
+ * preview-net). Keep this thin wrapper for install flows.
  */
 declare function connectIpfsGateway(url: string): IpfsGateway;
 
@@ -100,4 +155,4 @@ declare function prepareSignerFromMnemonic(mnemonic: string): polkadot_api.Polka
  */
 declare function prepareSignerFromSuri(suri: string): polkadot_api.PolkadotSigner;
 
-export { type AssetHubConnection, type BulletinConnection, type CdmAssetHubClient, type CdmChainClient, type CdmChainEndpoints, type ChainFaucet, type ChainPreset, type IpfsGateway, KNOWN_CHAINS, type KnownChainName, connectIpfsGateway, createCdmAssetHubClient, createCdmChainClient, getChainPreset, prepareSigner, prepareSignerFromMnemonic, prepareSignerFromSuri };
+export { type AssetHubConnection, type BulletinConnection, type CdmAssetHubApi, type CdmAssetHubClient, type CdmBulletinApi, type CdmChainClient, type CdmChainEndpoints, type CdmDeployAssetHubApi, type ChainFaucet, type ChainPreset, type IpfsGateway, type KnownChainName, type ProductSdkEnvironment, connectIpfsGateway, createCdmAssetHubClient, createCdmChainClient, getChainPreset, isKnownChainPreset, prepareSigner, prepareSignerFromMnemonic, prepareSignerFromSuri };

package/dist/index.js

@@ -1,14 +1,20 @@
 // src/known_chains.ts
+import { BULLETIN_RPCS } from "@parity/product-sdk-host";
+import { REGISTRY_ADDRESS } from "@dotdm/utils";
+var PREVIEW_NET_REGISTRY_ADDRESS = "0x5c7b23d386ff622c7f7a4e7a95d5c7a67b10a00d";
 var KNOWN_CHAINS = {
   polkadot: {
     assethubUrl: "wss://polkadot-asset-hub-rpc.polkadot.io",
     bulletinUrl: "wss://polkadot-bulletin-rpc.polkadot.io",
-    ipfsGatewayUrl: "https://polkadot-bulletin-rpc.polkadot.io/ipfs"
+    ipfsGatewayUrl: "https://polkadot-bulletin-rpc.polkadot.io/ipfs",
+    registryAddress: REGISTRY_ADDRESS
   },
   paseo: {
     assethubUrl: "wss://asset-hub-paseo-rpc.n.dwellir.com",
-    bulletinUrl: "wss://paseo-bulletin-rpc.polkadot.io",
+    bulletinUrl: BULLETIN_RPCS.paseo[0],
     ipfsGatewayUrl: "https://paseo-ipfs.polkadot.io/ipfs",
+    registryAddress: REGISTRY_ADDRESS,
+    productSdkEnvironment: "paseo",
     faucets: [
       { label: "Asset Hub", url: "https://faucet.polkadot.io/" },
       {
@@ -19,17 +25,34 @@ var KNOWN_CHAINS = {
   },
   "preview-net": {
     assethubUrl: "wss://previewnet.substrate.dev/asset-hub",
-    bulletinUrl: "wss://previewnet.substrate.dev/bulletin",
-    ipfsGatewayUrl: "https://previewnet.substrate.dev/ipfs/"
+    // TEMPORARY_PATCH! Preview-net's IPFS gateway does not currently serve Bulletin CIDs,
+    // so CDM stores preview-net metadata on Paseo Bulletin for now.
+    bulletinUrl: BULLETIN_RPCS.paseo[0],
+    ipfsGatewayUrl: "https://paseo-ipfs.polkadot.io/ipfs",
+    registryAddress: PREVIEW_NET_REGISTRY_ADDRESS,
+    productSdkEnvironment: "previewnet"
   },
   local: {
     assethubUrl: "ws://127.0.0.1:10020",
     bulletinUrl: "ws://127.0.0.1:10030",
-    ipfsGatewayUrl: "http://127.0.0.1:8283/ipfs"
+    ipfsGatewayUrl: "http://127.0.0.1:8283/ipfs",
+    registryAddress: REGISTRY_ADDRESS
   }
 };
+function normalizeChainName(name) {
+  if (name === "previewnet") return "preview-net";
+  if (name === "preview-net" || name === "paseo" || name === "polkadot" || name === "local") {
+    return name;
+  }
+  if (name === "custom") return "custom";
+}
+function isKnownChainPreset(name) {
+  const normalized = normalizeChainName(name);
+  return normalized !== void 0 && normalized !== "custom";
+}
 function getChainPreset(name) {
-  const preset = KNOWN_CHAINS[name];
+  const normalized = normalizeChainName(name);
+  const preset = normalized && normalized !== "custom" ? KNOWN_CHAINS[normalized] : void 0;
   if (!preset) {
     const valid = Object.keys(KNOWN_CHAINS).join(", ");
     throw new Error(`Unknown chain "${name}". Valid names: ${valid}`);
@@ -38,39 +61,97 @@ function getChainPreset(name) {
 }
 
 // src/index.ts
-import { DEFAULT_NODE_URL, REGISTRY_ADDRESS } from "@dotdm/utils";
+import { DEFAULT_NODE_URL, REGISTRY_ADDRESS as REGISTRY_ADDRESS2 } from "@dotdm/utils";
 
 // src/connection.ts
-import { createChainClient } from "@polkadot-apps/chain-client";
-import { paseo_asset_hub } from "@polkadot-apps/descriptors/paseo-asset-hub";
-import { bulletin } from "@polkadot-apps/descriptors/bulletin";
+import {
+  createClient
+} from "polkadot-api";
+import { getWsProvider } from "polkadot-api/ws";
+import { polkadot_asset_hub } from "@parity/product-sdk-descriptors/polkadot-asset-hub";
+import { paseo_asset_hub } from "@parity/product-sdk-descriptors/paseo-asset-hub";
+import { previewnet_asset_hub } from "@parity/product-sdk-descriptors/previewnet-asset-hub";
+import { paseo_bulletin } from "@parity/product-sdk-descriptors/paseo-bulletin";
+var DEPLOY_CHAIN_DESCRIPTORS = {
+  paseo: { assetHub: paseo_asset_hub, bulletin: paseo_bulletin },
+  "preview-net": { assetHub: previewnet_asset_hub, bulletin: paseo_bulletin },
+  local: { assetHub: paseo_asset_hub, bulletin: paseo_bulletin }
+};
+var ASSET_HUB_DESCRIPTORS = {
+  polkadot: polkadot_asset_hub,
+  paseo: paseo_asset_hub,
+  "preview-net": previewnet_asset_hub,
+  local: paseo_asset_hub
+};
+function resolveExplicitChainName(chainName) {
+  const normalized = normalizeChainName(chainName);
+  if (!normalized) {
+    throw new Error(
+      `Unknown chain "${chainName}". Valid names: polkadot, paseo, preview-net, local, custom`
+    );
+  }
+  return normalized;
+}
+function resolveAssetHubDescriptors(chainName) {
+  const normalized = chainName ? resolveExplicitChainName(chainName) : void 0;
+  return ASSET_HUB_DESCRIPTORS[normalized && normalized !== "custom" ? normalized : "paseo"];
+}
+function resolveDeployDescriptors(chainName) {
+  const normalized = chainName ? resolveExplicitChainName(chainName) : void 0;
+  const descriptorChain = normalized && normalized !== "custom" ? normalized : "paseo";
+  if (descriptorChain === "polkadot") {
+    throw new Error(
+      'CDM deploy connections are only available for "paseo", "preview-net", and "local"; product-sdk does not publish a Polkadot Bulletin descriptor yet.'
+    );
+  }
+  return DEPLOY_CHAIN_DESCRIPTORS[descriptorChain];
+}
 async function createCdmChainClient(arg) {
   const endpoints = typeof arg === "string" ? {
     assethubUrl: getChainPreset(arg).assethubUrl,
-    bulletinUrl: getChainPreset(arg).bulletinUrl
+    bulletinUrl: getChainPreset(arg).bulletinUrl,
+    chainName: arg
   } : arg;
-  return createChainClient({
-    chains: { assetHub: paseo_asset_hub, bulletin },
-    rpcs: {
-      assetHub: [endpoints.assethubUrl],
-      bulletin: [endpoints.bulletinUrl]
-    }
+  return createDirectChainClient(resolveDeployDescriptors(endpoints.chainName), {
+    assetHub: endpoints.assethubUrl,
+    bulletin: endpoints.bulletinUrl
   });
 }
-async function createCdmAssetHubClient(assethubUrl) {
-  return createChainClient({
-    chains: { assetHub: paseo_asset_hub },
-    rpcs: { assetHub: [assethubUrl] }
-  });
+async function createCdmAssetHubClient(assethubUrl, chainName) {
+  return createDirectChainClient(
+    { assetHub: resolveAssetHubDescriptors(chainName) },
+    { assetHub: assethubUrl }
+  );
+}
+function joinGatewayUrl(url, cid) {
+  return `${url.replace(/\/+$/, "")}/${cid.replace(/^\/+/, "")}`;
 }
 function connectIpfsGateway(url) {
   return {
-    fetch: (cid) => globalThis.fetch(`${url}/${cid}`, { signal: AbortSignal.timeout(15e3) }).then((r) => {
+    fetch: (cid) => globalThis.fetch(joinGatewayUrl(url, cid), { signal: AbortSignal.timeout(15e3) }).then((r) => {
       if (!r.ok) throw new Error(`IPFS fetch failed: ${r.statusText}`);
       return r;
     })
   };
 }
+function createDirectChainClient(chains, rpcs) {
+  const apis = {};
+  const raw = {};
+  for (const name of Object.keys(chains)) {
+    const client = createClient(getWsProvider(rpcs[name]));
+    raw[name] = client;
+    apis[name] = client.getTypedApi(chains[name]);
+  }
+  return {
+    ...apis,
+    raw,
+    destroy() {
+      for (const client of Object.values(raw)) {
+        client.destroy();
+      }
+    }
+  };
+}
 
 // src/signer.ts
 import { getPolkadotSigner } from "polkadot-api/signer";
@@ -103,12 +184,12 @@ function prepareSignerFromSuri(suri) {
 }
 export {
   DEFAULT_NODE_URL,
-  KNOWN_CHAINS,
-  REGISTRY_ADDRESS,
+  REGISTRY_ADDRESS2 as REGISTRY_ADDRESS,
   connectIpfsGateway,
   createCdmAssetHubClient,
   createCdmChainClient,
   getChainPreset,
+  isKnownChainPreset,
   prepareSigner,
   prepareSignerFromMnemonic,
   prepareSignerFromSuri,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotdm/env",
-  "version": "1.0.0",
+  "version": "1.0.1-dev.1778555844",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -17,11 +17,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@polkadot-apps/chain-client": "^2.0.4",
-    "@polkadot-apps/descriptors": "^1.0.1",
+    "@parity/product-sdk-descriptors": "^0.3.0",
+    "@parity/product-sdk-host": "^0.2.1",
     "@polkadot-labs/hdkd": "^0.0.26",
     "@polkadot-labs/hdkd-helpers": "^0.0.27",
-    "polkadot-api": "^1.23.3",
+    "polkadot-api": "^2.1.2",
     "smoldot": "^2.0.40",
     "@dotdm/utils": "0.3.1"
   },