configurable custody service

Author: turbocrime

.changeset/slick-bugs-admire.md

@@ -0,0 +1,5 @@
+---
+'@penumbra-zone/services': major
+---
+
+custody context now requires the host to provide a complete implementation

packages/services/package.json

@@ -23,20 +23,25 @@
       "types": "./dist/ctx/*.d.ts",
       "default": "./dist/ctx/*.js"
     },
+    "./validation/*": {
+      "types": "./dist/validation/*.d.ts",
+      "default": "./dist/validation/*.js"
+    },
     "./*": {
       "types": "./dist/*/index.d.ts",
       "default": "./dist/*/index.js"
     }
   },
+  "dependencies": {
+    "@penumbra-zone/keys": "workspace:*"
+  },
   "devDependencies": {
     "@bufbuild/protobuf": "^1.10.0",
     "@connectrpc/connect": "^1.6.1",
     "@penumbra-zone/bech32m": "workspace:*",
-    "@penumbra-zone/crypto-web": "workspace:*",
     "@penumbra-zone/getters": "workspace:*",
     "@penumbra-zone/protobuf": "workspace:*",
     "@penumbra-zone/storage": "workspace:*",
-    "@penumbra-zone/transport-dom": "workspace:*",
     "@penumbra-zone/types": "workspace:*",
     "@penumbra-zone/wasm": "workspace:*",
     "@types/chrome": "^0.0.268"
@@ -45,11 +50,8 @@
     "@bufbuild/protobuf": "^1.10.0",
     "@connectrpc/connect": "^1.6.1",
     "@penumbra-zone/bech32m": "workspace:*",
-    "@penumbra-zone/crypto-web": "workspace:*",
     "@penumbra-zone/getters": "workspace:*",
     "@penumbra-zone/protobuf": "workspace:*",
-    "@penumbra-zone/storage": "workspace:*",
-    "@penumbra-zone/transport-dom": "workspace:*",
     "@penumbra-zone/types": "workspace:*",
     "@penumbra-zone/wasm": "workspace:*"
   }

packages/services/src/ctx/approver.ts

@@ -0,0 +1,14 @@
+import { Code, ConnectError, createContextKey } from '@connectrpc/connect';
+import {
+  AuthorizationData,
+  TransactionPlan,
+} from '@penumbra-zone/protobuf/penumbra/core/transaction/v1/transaction_pb';
+
+/** Authorizes a transaction plan. */
+export const authorizePlanCtx = createContextKey<
+  (plan: TransactionPlan, signal: AbortSignal) => Promise<AuthorizationData>
+>(
+  /** A stub implementation that always throws an error. */
+  () => Promise.reject(new ConnectError('Default plan authorization stub', Code.Unimplemented)),
+  { description: 'Authorizes a transaction plan' },
+);

packages/services/src/ctx/authorize-plan.ts

@@ -1,5 +1,7 @@
 import { ContextKey, createContextKey, Client } from '@connectrpc/connect';
 import type { CustodyService } from '@penumbra-zone/protobuf';
 
-export const custodyClientCtx: ContextKey<Client<typeof CustodyService> | undefined> =
-  createContextKey(undefined);
+export const custodyClientCtx: ContextKey<Client<typeof CustodyService>> = createContextKey(
+  null as never,
+  { description: 'View service may call the custody service for authorizations' },
+);

packages/services/src/ctx/custody-client.ts

@@ -1,6 +1,8 @@
 import { Code, ConnectError, createContextKey } from '@connectrpc/connect';
 import { FullViewingKey } from '@penumbra-zone/protobuf/penumbra/core/keys/v1/keys_pb';
 
-export const fvkCtx = createContextKey<() => Promise<FullViewingKey>>(() =>
-  Promise.reject(new ConnectError('No full viewing key available', Code.FailedPrecondition)),
+export const fvkCtx = createContextKey<() => Promise<FullViewingKey>>(
+  /** A stub implementation that always throws an error. */
+  () => Promise.reject(new ConnectError('Default full viewing key stub', Code.Unimplemented)),
+  { description: 'View service requires a full viewing key' },
 );

packages/services/src/ctx/full-viewing-key.ts

@@ -3,9 +3,9 @@
  *  portable service implementations, should eventually be refactored.
  */
 
-import { ConnectError, createContextKey } from '@connectrpc/connect';
+import { createContextKey } from '@connectrpc/connect';
 import type { ServicesInterface } from '@penumbra-zone/types/services';
 
-export const servicesCtx = createContextKey<() => Promise<ServicesInterface>>(() =>
-  Promise.reject(new ConnectError('No prax services interface available')),
-);
+export const servicesCtx = createContextKey<() => Promise<ServicesInterface>>(null as never, {
+  description: 'A random collection of interfaces',
+});

packages/services/src/ctx/prax.ts

@@ -1,5 +1,7 @@
 import { ContextKey, createContextKey, Client } from '@connectrpc/connect';
 import type { StakeService } from '@penumbra-zone/protobuf';
 
-export const stakeClientCtx: ContextKey<Client<typeof StakeService> | undefined> =
-  createContextKey(undefined);
+export const stakeClientCtx: ContextKey<Client<typeof StakeService>> = createContextKey(
+  null as never,
+  { description: 'View service may call the stake service for delegation info' },
+);

packages/services/src/ctx/spend-key.ts

@@ -0,0 +1,12 @@
+import { PartialMessage } from '@bufbuild/protobuf';
+import { createContextKey, ConnectError, Code } from '@connectrpc/connect';
+import { TransactionPlan } from '@penumbra-zone/protobuf/penumbra/core/transaction/v1/transaction_pb';
+
+/** Validates a transaction plan. */
+export const validatePlanCtx = createContextKey<
+  (plan?: PartialMessage<TransactionPlan>, signal?: AbortSignal) => Promise<TransactionPlan>
+>(
+  /** A stub implementation that always throws an error. */
+  () => Promise.reject(new ConnectError('Default plan validation stub', Code.Unimplemented)),
+  { description: 'Validates a transaction plan.' },
+);