fix client package (#1027)

.changeset/dull-papayas-tap.md

@@ -0,0 +1,5 @@
+---
+'@penumbra-zone/bech32m': patch
+---
+
+dependency version bump

.changeset/lovely-days-lick.md

@@ -0,0 +1,5 @@
+---
+'@penumbra-zone/client': minor
+---
+
+add createPraxTransport export, change interface name

apps/extension/src/content-scripts/injected-penumbra-global.ts

@@ -3,25 +3,20 @@
  * mainworld global that allows pages to detect installed providers and connect
  * to them.
  *
- * The global is identified by `Symbol.for('penumbra')` and consists
- * of a record with string keys referring to `PenumbraProvider` objects that
- * contain a simple api. The identifiers on this record should be unique and
- * correspond to an id in a manifest, and providers should provide a link to
- * the manifest in their record entry.
- *
+ * The global is identified by `Symbol.for('penumbra')` and consists of a record
+ * with string keys referring to `PenumbraInjection` objects that contain a
+ * simple api. The identifiers on this record should be unique and correspond to
+ * an id in a manifest, and providers should provide a link to the manifest in
+ * their record entry.
  *
  * The global is frozen to prevent mutation, but you should consider that the
  * global and everything on it is only as trustable as the scripts running on
- * the page - imports, includes, and packages your webapp depends on could all
- * mutate or preempt the global. User-agent injections like userscripts or
- * other content scripts could interfere or intercept connections.
+ * the page. Imports, includes, and packages your webapp depends on could all
+ * mutate or preempt the global. User-agent injections like userscripts or other
+ * content scripts could interfere or intercept connections.
  */
 
-import {
-  PenumbraProvider,
-  PenumbraRequestFailure,
-  PenumbraSymbol,
-} from '@penumbra-zone/client/global';
+import { PenumbraInjection, PenumbraRequestFailure, PenumbraSymbol } from '@penumbra-zone/client';
 import { isPraxFailureMessageEvent, isPraxPortMessageEvent, PraxMessage } from './message-event';
 
 import { PraxConnection } from '../message/prax';
@@ -93,7 +88,7 @@ const postRequest = () => {
 };
 
 // the actual object we attach to the global record, frozen
-const praxProvider: PenumbraProvider = Object.freeze({
+const praxProvider: PenumbraInjection = Object.freeze({
   manifest: `${PRAX_ORIGIN}/manifest.json`,
   connect: () => connection.promise,
   isConnected: () => connection.state,

apps/minifront/src/clients.ts

@@ -1,4 +1,4 @@
-import { createPraxClient } from '@penumbra-zone/client';
+import { createPraxClient } from '@penumbra-zone/client/prax';
 import { ViewService } from '@buf/penumbra-zone_penumbra.connectrpc_es/penumbra/view/v1/view_connect';
 import { SimulationService } from '@buf/penumbra-zone_penumbra.connectrpc_es/penumbra/core/component/dex/v1/dex_connect';
 import { CustodyService } from '@buf/penumbra-zone_penumbra.connectrpc_es/penumbra/custody/v1/custody_connect';

apps/minifront/src/components/dashboard/assets-table/index.tsx

@@ -11,7 +11,7 @@ import {
   TableRow,
 } from '@penumbra-zone/ui/components/ui/table';
 import { ValueViewComponent } from '@penumbra-zone/ui/components/ui/tx/view/value';
-import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client';
+import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client/prax';
 import { EquivalentValues } from './equivalent-values';
 import { Fragment } from 'react';
 

apps/minifront/src/components/extension-not-connected.tsx

@@ -8,9 +8,9 @@ import {
   requestPraxConnection,
   throwIfPraxNotAvailable,
   throwIfPraxNotInstalled,
-} from '@penumbra-zone/client';
+} from '@penumbra-zone/client/prax';
 import { useState } from 'react';
-import { PenumbraRequestFailure } from '@penumbra-zone/client/global';
+import { PenumbraRequestFailure } from '@penumbra-zone/client';
 
 const handleErr = (e: unknown) => {
   if (e instanceof Error && e.cause) {

apps/minifront/src/components/layout.tsx

@@ -5,7 +5,11 @@ import { Toaster } from '@penumbra-zone/ui/components/ui/toaster';
 import { ExtensionNotConnected } from './extension-not-connected';
 import { ExtensionNotInstalled } from './extension-not-installed';
 import { Footer } from './footer/footer';
-import { isPraxConnected, isPraxConnectedTimeout, isPraxAvailable } from '@penumbra-zone/client';
+import {
+  isPraxConnected,
+  isPraxConnectedTimeout,
+  isPraxAvailable,
+} from '@penumbra-zone/client/prax';
 import '@penumbra-zone/ui/styles/globals.css';
 import { getChainId } from '../fetchers/chain-id';
 import { useEffect, useState } from 'react';

apps/minifront/src/components/send/send-form/index.tsx

@@ -7,7 +7,7 @@ import { LoaderFunction, useLoaderData } from 'react-router-dom';
 import { getBalances } from '../../../fetchers/balances';
 import { useMemo } from 'react';
 import { penumbraAddrValidation } from '../helpers';
-import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client';
+import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client/prax';
 import InputToken from '../../shared/input-token';
 import { useRefreshFee } from './use-refresh-fee';
 import { GasFee } from '../../shared/gas-fee';

apps/minifront/src/components/shared/error-boundary.tsx

@@ -1,5 +1,5 @@
 import { isRouteErrorResponse, useRouteError } from 'react-router-dom';
-import { PraxNotConnectedError } from '@penumbra-zone/client';
+import { PraxNotConnectedError } from '@penumbra-zone/client/prax';
 import { ExtensionNotConnected } from '../extension-not-connected';
 import { NotFound } from '../not-found';
 import { ExtensionUnavailable } from '../extension-unavailable';

apps/minifront/src/components/staking/layout.tsx

@@ -1,6 +1,6 @@
 import { useEffect } from 'react';
 import { AllSlices, useStore } from '../../state';
-import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client';
+import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client/prax';
 import { Card, CardContent, CardHeader, CardTitle } from '@penumbra-zone/ui/components/ui/card';
 import { Header } from './account/header';
 import { Delegations } from './account/delegations';

apps/minifront/src/components/swap/dutch-auction/dutch-auction-loader.ts

@@ -1,4 +1,4 @@
-import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client';
+import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client/prax';
 import { getSwappableBalancesResponses } from '../helpers';
 import { useStore } from '../../../state';
 import { getAllAssets } from '../../../fetchers/assets';

apps/minifront/src/components/swap/swap/swap-loader.tsx

@@ -1,6 +1,6 @@
 import { LoaderFunction } from 'react-router-dom';
 import { useStore } from '../../../state';
-import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client';
+import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client/prax';
 import {
   BalancesResponse,
   SwapRecord,

apps/minifront/src/components/tx-details/index.tsx

@@ -6,7 +6,7 @@ import { EduPanel } from '../shared/edu-panels/content';
 import { LoaderFunction, useLoaderData, useRouteError } from 'react-router-dom';
 import { getTxInfoByHash } from '../../fetchers/tx-info-by-hash';
 import { TransactionInfo } from '@buf/penumbra-zone_penumbra.bufbuild_es/penumbra/view/v1/view_pb';
-import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client';
+import { throwIfPraxNotConnectedTimeout } from '@penumbra-zone/client/prax';
 import { RestrictMaxWidth } from '../shared/restrict-max-width';
 
 export interface TxDetailsLoaderResult {

packages/client/package.json

@@ -5,23 +5,29 @@
   "description": "Package for connecting to any Penumbra extension, including Prax.",
   "type": "module",
   "scripts": {
-    "build": "tsc && vite build",
-    "clean": "rm -rfv dist",
-    "lint": "eslint \"**/*.ts*\""
+    "build": "tsc",
+    "clean": "rm -rfv dist package penumbra-zone-client-*.tgz",
+    "lint": "eslint \"**/*.ts*\"",
+    "prebuild": "$npm_execpath run clean",
+    "prepack": "$npm_execpath run build"
   },
+  "files": [
+    "dist"
+  ],
   "exports": {
-    ".": "./src/prax.ts",
-    "./global": "./src/global.ts",
-    "./get-port": "./src/get-port.ts"
+    ".": "./src/index.ts",
+    "./prax": "./src/prax.ts"
   },
   "publishConfig": {
-    "files": [
-      "dist"
-    ],
     "exports": {
-      ".": "./dist/prax.js",
-      "./global": "./dist/global.js",
-      "./get-port": "./dist/get-port.js"
+      ".": {
+        "import": "./dist/index.js",
+        "types": "./dist/index.d.ts"
+      },
+      "./*": {
+        "import": "./dist/*.js",
+        "types": "./dist/*.d.ts"
+      }
     }
   },
   "dependencies": {

packages/client/src/global.ts → packages/client/src/index.ts

@@ -5,7 +5,7 @@ export enum PenumbraRequestFailure {
 
 export const PenumbraSymbol = Symbol.for('penumbra');
 
-export interface PenumbraProvider {
+export interface PenumbraInjection {
   readonly connect: () => Promise<MessagePort>;
   readonly request: () => Promise<void>;
   readonly isConnected: () => boolean | undefined;
@@ -14,6 +14,6 @@ export interface PenumbraProvider {
 
 declare global {
   interface Window {
-    readonly [PenumbraSymbol]?: undefined | Readonly<Record<string, PenumbraProvider>>;
+    readonly [PenumbraSymbol]?: undefined | Readonly<Record<string, PenumbraInjection>>;
   }
 }

packages/client/src/prax.ts

@@ -8,7 +8,7 @@ import type { JsonValue, ServiceType } from '@bufbuild/protobuf';
 import type { Transport } from '@connectrpc/connect';
 import { createPromiseClient } from '@connectrpc/connect';
 import { createChannelTransport } from '@penumbra-zone/transport-dom/create';
-import { PenumbraSymbol } from './global';
+import { PenumbraSymbol } from '.';
 import { jsonOptions } from '@penumbra-zone/protobuf';
 
 const prax_id = 'lkpmkhpnhknhmibgnmmhdhgdilepfghe';
@@ -83,11 +83,14 @@ export const throwIfPraxNotInstalled = async () => {
   if (!isInstalled) throw new PraxNotInstalledError('Prax not installed');
 };
 
-let praxTransport: Transport | undefined;
-export const createPraxClient = <T extends ServiceType>(serviceType: T) => {
-  praxTransport ??= createChannelTransport({
+export const createPraxTransport = () =>
+  createChannelTransport({
     jsonOptions,
     getPort: getPraxPort,
   });
+
+let praxTransport: Transport | undefined;
+export const createPraxClient = <T extends ServiceType>(serviceType: T) => {
+  praxTransport ??= createPraxTransport();
   return createPromiseClient(serviceType, praxTransport);
 };

packages/client/tsconfig.json

@@ -1,8 +1,9 @@
 {
   "extends": "tsconfig/base.json",
-  "exclude": ["node_modules"],
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"],
   "compilerOptions": {
     "outDir": "dist",
-    "noEmit": true
+    "noEmit": false
   }
 }