@parity/product-deploy 0.10.0-rc.0 → 0.10.0-rc.2

package/docs/telemetry.md

@@ -4,8 +4,13 @@ Telemetry is **off by default for external users**. It is enabled automatically
 
 ## Opt in / opt out
 
-- `BULLETIN_DEPLOY_TELEMETRY=1`: explicit opt-in
-- `BULLETIN_DEPLOY_TELEMETRY=0`: force off
+Telemetry is **off by default** for external users. It is only enabled automatically when running in a known Parity/internal context (see detection signals below), or via explicit opt-in.
+
+- `BULLETIN_DEPLOY_TELEMETRY=1`: explicit opt-in — also overrides `DO_NOT_TRACK`
+- `BULLETIN_DEPLOY_TELEMETRY=0` or `BULLETIN_DEPLOY_TELEMETRY=off`: force off
+- `DO_NOT_TRACK=1`: telemetry is disabled (standard EFF Do Not Track convention); overridden only by an explicit `BULLETIN_DEPLOY_TELEMETRY=1`
+
+Precedence (highest to lowest): explicit opt-out → explicit opt-in → DO_NOT_TRACK → internal context detection → default off.
 
 Internal detection signals are OR'd together:
 
@@ -32,7 +37,7 @@ BULLETIN_DEPLOY_HOST_APP=<your-app-name>
 BULLETIN_DEPLOY_HOST_APP_VERSION=<your-app-version>
 ```
 
-`BULLETIN_DEPLOY_HOST_APP_VERSION` is optional but recommended — it populates `deploy.host_app_version` on every span, enabling version-correlated triage in the dashboard.
+`BULLETIN_DEPLOY_HOST_APP_VERSION` is optional but recommended — it populates `deploy.host_app_version` on every span, enabling version-correlated triage in your Sentry dashboard.
 
 That makes `bulletin-deploy` reuse the existing Sentry client instead of calling its own `Sentry.init()`.
 
@@ -49,14 +54,8 @@ Use `--tag` or `DEPLOY_TAG` to separate test and benchmark traffic from real dep
 Examples:
 
 ```bash
-bulletin-deploy --tag e2e-ci-pr ./build my-app.dot
+bulletin-deploy --tag ci-smoke ./build my-app.dot
 DEPLOY_TAG=load-test bulletin-deploy ./build my-app.dot
 ```
 
-Common tags in this repo:
-
-- `e2e-ci-pr`
-- `e2e-ci-nightly`
-- `e2e-local-smoke`
-- `e2e-local-pr`
-- `e2e-local-nightly`
+Use any label that distinguishes a class of deploy — for example, separating CI smoke runs, nightly runs, and load tests from real user traffic so they can be filtered apart in telemetry.

package/docs/testing.md

@@ -1,5 +1,7 @@
 # Testing
 
+> Contributor reference. The offline suite runs anywhere; everything past it needs testnet access — see [E2E test setup](./e2e-bootstrap.md) for the one-time chain setup.
+
 The repo has three practical test layers: offline unit tests, live-testnet E2E coverage, and GitHub Actions matrices that exercise the shipped reusable workflow.
 
 ## Offline tests

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parity/product-deploy",
-  "version": "0.10.0-rc.0",
+  "version": "0.10.0-rc.2",
   "private": false,
   "repository": {
     "type": "git",
@@ -41,6 +41,7 @@
     "docs",
     "assets",
     "patches",
+    "DEPLOYMENT.md",
     "tools/release-retry-wrapper.mjs"
   ],
   "scripts": {
@@ -48,7 +49,7 @@
     "refresh-environments": "node scripts/refresh-environments.mjs",
     "postinstall": "patch-package || true",
     "prepare": "npm run build",
-    "test": "npm run build && node --test test/test.js test/cli-help.test.js test/helpers/e2e-helpers.test.js test/environments.test.js test/refresh-environments.test.js test/chunk-sharing-report.test.js test/product-manifest.test.js test/cache-savings-totals.test.js test/error-pattern-signature.test.js test/exit-codes.test.js test/probe-env-health.test.js test/e2e-chain-calls.test.js test/auth-config.test.js test/whoami.test.js test/login.test.js test/logout.test.js test/auth-resolve.test.js test/storage-signer.test.js test/spinner.test.js test/sss-allowance.test.js test/sss-allowance-cache.test.js test/dotns-transfer.test.js test/deploy-actors.test.js test/transfer-command.test.js test/dotns-register-fee.test.js && npm run test:vendor",
+    "test": "npm run build && node --test test/test.js test/cli-help.test.js test/helpers/e2e-helpers.test.js test/environments.test.js test/refresh-environments.test.js test/chunk-sharing-report.test.js test/product-manifest.test.js test/cache-savings-totals.test.js test/error-pattern-signature.test.js test/exit-codes.test.js test/probe-env-health.test.js test/e2e-chain-calls.test.js test/auth-config.test.js test/whoami.test.js test/login.test.js test/logout.test.js test/auth-resolve.test.js test/storage-signer.test.js test/spinner.test.js test/sss-allowance.test.js test/sss-allowance-cache.test.js test/dotns-transfer.test.js test/deploy-actors.test.js test/transfer-command.test.js test/dotns-register-fee.test.js test/deploy-label-ordering.test.js test/benign-teardown.test.js && npm run test:vendor",
     "test:e2e": "npm run build && node --test test/e2e.test.js",
     "test:e2e:smoke": "bash scripts/e2e-pass.sh smoke",
     "test:e2e:pr": "bash scripts/e2e-pass.sh pr",
@@ -62,7 +63,7 @@
     "@noble/hashes": "^1.7.2",
     "@parity/product-sdk-address": "^0.1.1",
     "@parity/product-sdk-keys": "^0.3.0",
-    "@parity/product-sdk-terminal": "^0.3.1",
+    "@parity/product-sdk-terminal": "^0.4.0",
     "@parity/product-sdk-tx": "^0.2.4",
     "@polkadot-api/metadata-builders": "^0.14.2",
     "@polkadot-api/substrate-bindings": "^0.20.2",

package/dist/auth-C-Pel0AT.d.ts

@@ -1,235 +0,0 @@
-import { UserSession, TerminalAdapter } from '@parity/product-sdk-terminal';
-import { PolkadotSigner } from 'polkadot-api';
-
-/**
- * RFC-0010 resource allocation — thin wrapper over product-sdk-terminal's
- * host-runner facet. Lifted from playground-cli `src/utils/allowances/host.ts`
- * (issue #411).
- *
- * `@parity/product-sdk-terminal/host` exports `requestResourceAllocation(session,
- * adapter, resources, options?)` which handles:
- *   - sending the AP request to the paired mobile wallet
- *   - the `onExisting` policy (default auto-picks "Ignore" unless all requested
- *     resources are already slot-table cached, then "Increase")
- *   - caching granted key material to disk as `{appId}_AllowanceKeys.json`
- *     (the same file our storage-signer reads — verified compat-stable in PR #855)
- *
- * Wire format (SCALE-derived, mirrors host-papp's
- * `dist/sso/sessionManager/scale/resourceAllocation.d.ts`):
- *   request  → { callingProductId, resources: AllocatableResource[], onExisting }
- *   response → AllocationOutcome[] (one per resource, in order)
- *
- * The mobile app handles `hostRequestResourceAllocation` in
- * `AllowanceHostCalls.kt` and routes the user through an approval UI.
- */
-
-/**
- * Structural mirror of host-papp's `ApAllocatableResource` codec type. We
- * declare it locally because host-papp's package root doesn't re-export the
- * codec types yet — when it does (and product-sdk-terminal threads them
- * through) this can be replaced with a direct import.
- *
- *   StatementStoreAllowance — write to the SSS (host_chat, allowance ring).
- *   BulletInAllowance       — write to Bulletin (TransactionStorage.store).
- *   SmartContractAllowance  — PGAS sponsoring for Revive contract calls.
- *                             The `value` is the derivation index of the
- *                             product account (0 for the default account).
- *   AutoSigning             — surrender the product-account signing key to
- *                             the host so it can sign on the user's behalf
- *                             without per-call prompts. Not used today.
- *
- * NOTE: host-api v0.8 renamed this variant to 'BulletinAllowance', but the
- * SSO resource-allocation codec (host-papp, which this path reaches via
- * product-sdk-terminal) retains the old 'BulletInAllowance' spelling as of
- * host-papp 0.8.5 / terminal 0.3.1. Ours must match the SSO codec — the
- * _SDK_COMPAT_PIN below fails the build if the SDK's spelling ever changes.
- */
-type AllocatableResource = {
-    tag: "StatementStoreAllowance";
-    value: undefined;
-} | {
-    tag: "BulletInAllowance";
-    value: undefined;
-} | {
-    tag: "SmartContractAllowance";
-    value: number;
-} | {
-    tag: "AutoSigning";
-    value: undefined;
-};
-/**
- * Outcome of one allocation. We don't read the inner `Allocated` payload
- * (allowance slot keys, derivation secrets) — the host stores them and uses
- * them transparently on subsequent calls. We just need the tag to know
- * whether the allocation succeeded.
- */
-type AllocationOutcome = {
-    tag: "Allocated";
-    value: unknown;
-} | {
-    tag: "Rejected";
-    value: undefined;
-} | {
-    tag: "NotAvailable";
-    value: undefined;
-};
-/** Tag-only view, handy for downstream code that doesn't care about payloads. */
-type ResourceTag = AllocatableResource["tag"];
-type OnExistingAllowancePolicy = "Ignore" | "Increase";
-/**
- * Default mobile-granted resource set for a CLI product account: write access
- * to the statement store + Bulletin, plus PGAS sponsoring for the default
- * (index 0) product account.
- */
-declare const DEFAULT_RESOURCES: AllocatableResource[];
-/**
- * Send a `host_request_resource_allocation` request over the user's active
- * session. The host (mobile wallet) prompts the user to approve and returns
- * one outcome per requested resource in order. Granted key material is cached
- * to disk by the terminal facet (`{appId}_AllowanceKeys.json`) so subsequent
- * calls (and the storage-signer reader) find it without a second wallet prompt.
- *
- * Throws on transport-level failures (Statement Store unreachable, encryption
- * error, etc.). Per-resource refusals are reported as `Rejected`/`NotAvailable`
- * outcomes — callers inspect the array to decide whether to proceed.
- *
- * `onExisting` is pinned to "Ignore": return existing cached keys if any, else
- * allocate a new slot. Auto-pick would give "Increase" when all slot-table
- * resources are already cached, which re-prompts the user unnecessarily.
- */
-declare function requestResourceAllocation(session: UserSession, adapter: TerminalAdapter, resources?: AllocatableResource[], onExisting?: OnExistingAllowancePolicy): Promise<AllocationOutcome[]>;
-interface AllocationSummary {
-    granted: AllocatableResource[];
-    rejected: AllocatableResource[];
-    unavailable: AllocatableResource[];
-}
-/**
- * Bucket allocation outcomes by tag. Order-sensitive: `outcomes[i]` maps to
- * `resources[i]`. Outcomes without a matching resource are silently dropped.
- */
-declare function summarizeOutcomes(outcomes: AllocationOutcome[], resources: AllocatableResource[]): AllocationSummary;
-
-/**
- * Per-product configuration injected into `createAuthClient`. Lifting the
- * sign-in glue out of playground-cli (issue #411) means the env-specific
- * constants playground hard-coded in its `config.ts` (DAPP_ID, product id,
- * metadata URL, People-chain endpoints) become consumer-supplied so the same
- * package serves `playground` and `dot` (and future products) unchanged.
- */
-interface AuthConfig {
-    /** The dApp identity string. Scopes the on-disk session namespace
-     *  (`~/.polkadot-apps/${dappId}_*`) and the SSO pairing — each product
-     *  gets its own, independently-revocable session. */
-    dappId: string;
-    /** Product id used to derive the product account (`/product/{productId}/{index}`). */
-    productId: string;
-    /** Derivation index of the product account (0 = default). */
-    derivationIndex: number;
-    /** Wallet-facing app name shown on the Sign-In screen (sent inline at pairing). */
-    hostName: string;
-    /** Host app version sent inline at pairing. */
-    hostVersion: string;
-    /** People-parachain RPC endpoints the terminal adapter connects to. */
-    peopleEndpoints: string[];
-}
-
-/**
- * The three addresses we surface from a paired session.
- *
- * - `rootAddress` — SS58 of `session.rootAccountId`, the `rootUserAccountId`
- *   the mobile app sent over the SSO handshake (bare-mnemonic sr25519 root on
- *   current mobile builds). Keyed by `Resources.Consumers` on the People
- *   parachain, so it's the right input for `lookupUsername`.
- * - `productAddress` — SS58 of the product account derived via
- *   `product/{productId}/{index}` from `rootAccountId`. This is what actually
- *   signs on-chain transactions from the CLI.
- * - `productH160` — the same product pubkey as a 20-byte EVM address (Revive /
- *   contracts view). Derived from the SAME pubkey as `productAddress`.
- */
-interface SessionAddresses {
-    rootAddress: string;
-    productAddress: string;
-    productH160: `0x${string}`;
-}
-type ConnectResult = {
-    kind: "existing";
-    address: string;
-    addresses: SessionAddresses;
-} | {
-    kind: "qr";
-    qrCode: string;
-    login: LoginHandle;
-};
-type LoginStatus = {
-    step: "waiting";
-} | {
-    step: "paired";
-} | {
-    step: "pending";
-    stage: string;
-} | {
-    step: "success";
-    address: string;
-    addresses: SessionAddresses;
-} | {
-    step: "error";
-    message: string;
-};
-interface LoginHandle {
-    adapter: TerminalAdapter;
-    /** The authenticate() promise — already running since connect(). */
-    authPromise: ReturnType<TerminalAdapter["sso"]["authenticate"]>;
-}
-/**
- * A session signer bundle — the signer plus an explicit `destroy()` that tears
- * down the long-lived adapter the signer depends on. Callers MUST invoke
- * `destroy()` once done — the WebSocket keeps the event loop alive.
- *
- * `adapter` is exposed so callers that need to send a host request (e.g.
- * `requestResourceAllocation`) can pass it without creating a second WebSocket.
- */
-interface SessionHandle {
-    address: string;
-    addresses: SessionAddresses;
-    signer: PolkadotSigner;
-    userSession: UserSession;
-    adapter: TerminalAdapter;
-    destroy(): void;
-}
-type LogoutStatus = {
-    step: "disconnecting";
-    address: string;
-} | {
-    step: "success";
-    address: string;
-} | {
-    step: "partial";
-    address: string;
-    reason: string;
-} | {
-    step: "error";
-    message: string;
-};
-interface LogoutHandle {
-    adapter: TerminalAdapter;
-    address: string;
-    session: UserSession;
-}
-/** The product-bound auth surface returned by `createAuthClient`. */
-interface AuthClient {
-    connect(): Promise<ConnectResult>;
-    waitForLogin(handle: LoginHandle, onStatus: (status: LoginStatus) => void): Promise<SessionHandle | null>;
-    getSessionSigner(): Promise<SessionHandle | null>;
-    findSession(): Promise<LogoutHandle | null>;
-    waitForLogout(handle: LogoutHandle, onStatus: (status: LogoutStatus) => void): Promise<void>;
-    requestAllocation(session: UserSession, adapter: TerminalAdapter, resources?: AllocatableResource[], onExisting?: OnExistingAllowancePolicy): Promise<AllocationOutcome[]>;
-    clearLocalAppStorage(dir?: string): Promise<void>;
-}
-/**
- * Build an auth client bound to a product's `AuthConfig`. All adapter creation,
- * address derivation, and session-storage scoping read from `config`, so the
- * same code serves any product.
- */
-declare function createAuthClient(config: AuthConfig): AuthClient;
-
-export { type AllocatableResource as A, type ConnectResult as C, DEFAULT_RESOURCES as D, type LoginHandle as L, type OnExistingAllowancePolicy as O, type ResourceTag as R, type SessionAddresses as S, type AllocationOutcome as a, type AllocationSummary as b, type AuthClient as c, type AuthConfig as d, type LoginStatus as e, type LogoutHandle as f, type LogoutStatus as g, type SessionHandle as h, createAuthClient as i, requestResourceAllocation as r, summarizeOutcomes as s };