@agoric/portfolio-api 0.1.1-dev-d57b08e.0.d57b08e → 0.1.1-dev-2ae3f1f.0.2ae3f1f

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/portfolio-api",
-  "version": "0.1.1-dev-d57b08e.0.d57b08e",
+  "version": "0.1.1-dev-2ae3f1f.0.2ae3f1f",
   "description": "API for Portfolio management",
   "type": "module",
   "files": [
@@ -27,11 +27,11 @@
     "generate:ymax-machine": "npx tsx scripts/gen-ymax-machine.mts"
   },
   "dependencies": {
-    "@agoric/orchestration": "0.1.1-dev-d57b08e.0.d57b08e",
+    "@agoric/orchestration": "0.1.1-dev-2ae3f1f.0.2ae3f1f",
     "@endo/common": "^1.2.13"
   },
   "devDependencies": {
-    "@agoric/internal": "0.3.3-dev-d57b08e.0.d57b08e",
+    "@agoric/internal": "0.3.3-dev-2ae3f1f.0.2ae3f1f",
     "@types/js-yaml": "^4",
     "ajv": "^6.12.6",
     "ava": "^5.3.0",
@@ -64,5 +64,5 @@
   "engines": {
     "node": "^20.9 || ^22.11"
   },
-  "gitHead": "d57b08e6945269499ff15845f664405099f0f39b"
+  "gitHead": "2ae3f1fb1423324b633432fe7149a26bcaadd843"
 }

package/src/evm-wallet/eip712-messages.d.ts

@@ -0,0 +1,152 @@
+/**
+ * @file Portfolio operations are either in a permit2 witness or standalone,
+ * in either case, following EIP-712
+ *
+ * The fields included in the operation differ based on which way they're submitted.
+ * In the wrapped case, we don't want to repeat stuff from the permit envelope.
+ * {@link OperationTypes}
+ *
+ * Currently all types and helpers are built around a hard-coded Ymax product
+ * name but with some effort this could be parametrizable
+ */
+import type { TypedDataDomain, TypedDataToPrimitiveTypes } from 'abitype';
+import type { TypedDataDefinition } from 'viem';
+import type { TypedDataParameter } from '@agoric/orchestration/src/utils/abitype.ts';
+import { type Witness, type getPermitWitnessTransferFromData, type getPermitBatchWitnessTransferFromData } from '@agoric/orchestration/src/utils/permit2.ts';
+declare const YMAX_DOMAIN_NAME = "Ymax";
+declare const YMAX_DOMAIN_VERSION = "1";
+declare const StandaloneDomainTypeParams: [{
+    readonly name: "name";
+    readonly type: "string";
+}, {
+    readonly name: "version";
+    readonly type: "string";
+}];
+declare const YmaxStandaloneDomain: {
+    readonly name: "Ymax";
+    readonly version: "1";
+};
+declare const SharedPortfolioTypeParams: [];
+/**
+ * Fields included in Permit data that we don't want duplicated in witness data,
+ * so only included in standalone typed data.
+ */
+declare const PortfolioStandaloneTypeParams: [{
+    readonly name: "nonce";
+    readonly type: "uint256";
+}, {
+    readonly name: "deadline";
+    readonly type: "uint256";
+}];
+/**
+ * The set of portfolio operations supported by EVM Wallets, and their associated params
+ */
+declare const OperationTypes: {
+    readonly OpenPortfolio: readonly [{
+        readonly name: "allocations";
+        readonly type: "Allocation[]";
+    }];
+    readonly Rebalance: readonly [{
+        readonly name: "allocations";
+        readonly type: "Allocation[]";
+    }, {
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+    readonly Deposit: readonly [{
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+};
+type OperationTypes = typeof OperationTypes;
+export type OperationTypeNames = keyof OperationTypes;
+declare const OperationSubTypes: {
+    readonly Allocation: readonly [{
+        readonly name: "instrument";
+        readonly type: "string";
+    }, {
+        readonly name: "portion";
+        readonly type: "uint256";
+    }];
+};
+/**
+ * Target allocation for portfolio positions.
+ * Uses 'portion' (not 'basisPoints') to allow flexible ratios.
+ * The denominator is implicitly the sum of all portions.
+ *
+ * Examples:
+ * - [{instrument: 'A', portion: 60}, {instrument: 'B', portion: 40}] => 60:40 ratio
+ * - [{instrument: 'A', portion: 6}, {instrument: 'B', portion: 4}] => 6:4 ratio (same as 60:40)
+ */
+export type TargetAllocation = TypedDataToPrimitiveTypes<typeof OperationSubTypes>['Allocation'];
+/**
+ * In the wrapped case, the domain is fixed by permit2, so we can't choose name/version there.
+ * so we put the ymax-specifc domain name and version in the type name.
+ */
+declare const getYmaxWitnessTypeName: <T extends OperationTypeNames>(operation: T) => `YmaxV1${T}`;
+type YmaxWitnessTypeName<T extends OperationTypeNames> = ReturnType<typeof getYmaxWitnessTypeName<T>>;
+declare const getYmaxWitnessFieldName: <T extends OperationTypeNames>(operation: T) => `ymax${T}`;
+type YmaxWitnessFieldName<T extends OperationTypeNames> = ReturnType<typeof getYmaxWitnessFieldName<T>>;
+export type YmaxWitnessTypeParam<T extends OperationTypeNames = OperationTypeNames> = TypedDataParameter<YmaxWitnessFieldName<T>, YmaxWitnessTypeName<T>>;
+type YmaxWitnessOperationTypes<T extends OperationTypeNames = OperationTypeNames> = {
+    [K in T as YmaxWitnessTypeName<K>]: [
+        ...OperationTypes[K],
+        ...typeof SharedPortfolioTypeParams
+    ];
+};
+type YmaxWitnessTypes<T extends OperationTypeNames = OperationTypeNames> = YmaxWitnessOperationTypes<T> & typeof OperationSubTypes;
+type YmaxStandaloneOperationTypes<T extends OperationTypeNames = OperationTypeNames> = {
+    [K in T]: [
+        ...OperationTypes[K],
+        ...typeof SharedPortfolioTypeParams,
+        ...typeof PortfolioStandaloneTypeParams
+    ];
+};
+type YmaxStandaloneTypes<T extends OperationTypeNames = OperationTypeNames> = YmaxStandaloneOperationTypes<T> & typeof OperationSubTypes & {
+    EIP712Domain: typeof StandaloneDomainTypeParams;
+};
+export type YmaxOperationType<T extends OperationTypeNames> = TypedDataToPrimitiveTypes<OperationTypes & typeof OperationSubTypes>[T];
+type YmaxWitnessMappedTypeParam<T extends OperationTypeNames> = TypedDataParameter<YmaxWitnessFieldName<T>, Extract<keyof YmaxWitnessOperationTypes<T>, string>>;
+export declare const getYmaxOperationTypes: <T extends OperationTypeNames>(operation: T) => { [K in T]: {
+    readonly OpenPortfolio: readonly [{
+        readonly name: "allocations";
+        readonly type: "Allocation[]";
+    }];
+    readonly Rebalance: readonly [{
+        readonly name: "allocations";
+        readonly type: "Allocation[]";
+    }, {
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+    readonly Deposit: readonly [{
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+}[K]; } & {
+    readonly Allocation: readonly [{
+        readonly name: "instrument";
+        readonly type: "string";
+    }, {
+        readonly name: "portion";
+        readonly type: "uint256";
+    }];
+};
+export declare const getYmaxWitness: <T extends OperationTypeNames>(operation: T, data: NoInfer<TypedDataToPrimitiveTypes<YmaxWitnessTypes>[YmaxWitnessTypeName<T>]>) => Witness<YmaxWitnessTypes<T>, YmaxWitnessMappedTypeParam<T>>;
+export declare const getYmaxStandaloneOperationData: <T extends OperationTypeNames>(data: NoInfer<TypedDataToPrimitiveTypes<YmaxStandaloneTypes>[T]>, operation: T) => TypedDataDefinition<YmaxStandaloneTypes<T>, T, T> & {
+    domain: typeof YmaxStandaloneDomain;
+};
+export type YmaxStandaloneOperationData<T extends OperationTypeNames = OperationTypeNames> = ReturnType<typeof getYmaxStandaloneOperationData<T>>;
+export type YmaxPermitWitnessTransferFromData<T extends OperationTypeNames = OperationTypeNames> = ReturnType<typeof getPermitWitnessTransferFromData<YmaxWitnessTypes<T>, YmaxWitnessMappedTypeParam<T>>>;
+export type YmaxPermitBatchWitnessTransferFromData<T extends OperationTypeNames = OperationTypeNames> = ReturnType<typeof getPermitBatchWitnessTransferFromData<YmaxWitnessTypes<T>, YmaxWitnessMappedTypeParam<T>>>;
+export declare function validateYmaxDomain(domain: TypedDataDomain): asserts domain is typeof YmaxStandaloneDomain;
+export declare function validateYmaxOperationTypeName<T extends OperationTypeNames>(typeName: string): asserts typeName is T;
+export declare const splitWitnessFieldType: <T extends OperationTypeNames>(fieldName: `${typeof YMAX_DOMAIN_NAME}V${typeof YMAX_DOMAIN_VERSION}${T}`) => {
+    domain: {
+        readonly name: "Ymax";
+        readonly version: "1";
+    };
+    primaryType: T;
+};
+export {};
+//# sourceMappingURL=eip712-messages.d.ts.map

package/src/evm-wallet/eip712-messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eip712-messages.d.ts","sourceRoot":"","sources":["eip712-messages.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAEV,eAAe,EACf,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,gCAAgC,EACrC,KAAK,qCAAqC,EAE3C,MAAM,4CAA4C,CAAC;AAEpD,QAAA,MAAM,gBAAgB,SAAS,CAAC;AAChC,QAAA,MAAM,mBAAmB,MAAM,CAAC;AAIhC,QAAA,MAAM,0BAA0B;;;;;;EAGS,CAAC;AAE1C,QAAA,MAAM,oBAAoB;;;CAGU,CAAC;AASrC,QAAA,MAAM,yBAAyB,IAA6C,CAAC;AAE7E;;;GAGG;AACH,QAAA,MAAM,6BAA6B;;;;;;EAGM,CAAC;AAE1C;;GAEG;AACH,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;CAIU,CAAC;AAC/B,KAAK,cAAc,GAAG,OAAO,cAAc,CAAC;AAC5C,MAAM,MAAM,kBAAkB,GAAG,MAAM,cAAc,CAAC;AAEtD,QAAA,MAAM,iBAAiB;;;;;;;;CAKO,CAAC;AAE/B;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,yBAAyB,CACtD,OAAO,iBAAiB,CACzB,CAAC,YAAY,CAAC,CAAC;AAEhB;;;GAGG;AACH,QAAA,MAAM,sBAAsB,GAAI,CAAC,SAAS,kBAAkB,EAAE,WAAW,CAAC,iBACP,CAAC;AACpE,KAAK,mBAAmB,CAAC,CAAC,SAAS,kBAAkB,IAAI,UAAU,CACjE,OAAO,sBAAsB,CAAC,CAAC,CAAC,CACjC,CAAC;AACF,QAAA,MAAM,uBAAuB,GAAI,CAAC,SAAS,kBAAkB,EAAE,WAAW,CAAC,eACjB,CAAC;AAC3D,KAAK,oBAAoB,CAAC,CAAC,SAAS,kBAAkB,IAAI,UAAU,CAClE,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAClC,CAAC;AAYF,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;AAGxE,KAAK,yBAAyB,CAC5B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C;KACD,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,CAAC,CAAC,GAAG;QAClC,GAAG,cAAc,CAAC,CAAC,CAAC;QACpB,GAAG,OAAO,yBAAyB;KACpC;CACF,CAAC;AACF,KAAK,gBAAgB,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IACrE,yBAAyB,CAAC,CAAC,CAAC,GAAG,OAAO,iBAAiB,CAAC;AAC1D,KAAK,4BAA4B,CAC/B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C;KACD,CAAC,IAAI,CAAC,GAAG;QACR,GAAG,cAAc,CAAC,CAAC,CAAC;QACpB,GAAG,OAAO,yBAAyB;QACnC,GAAG,OAAO,6BAA6B;KACxC;CACF,CAAC;AACF,KAAK,mBAAmB,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IACxE,4BAA4B,CAAC,CAAC,CAAC,GAC7B,OAAO,iBAAiB,GAAG;IACzB,YAAY,EAAE,OAAO,0BAA0B,CAAC;CACjD,CAAC;AAEN,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,kBAAkB,IACxD,yBAAyB,CAAC,cAAc,GAAG,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAI1E,KAAK,0BAA0B,CAAC,CAAC,SAAS,kBAAkB,IAC1D,kBAAkB,CAChB,oBAAoB,CAAC,CAAC,CAAC,EACvB,OAAO,CAAC,MAAM,yBAAyB,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CACpD,CAAC;AAsBJ,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,kBAAkB,EAChE,WAAW,CAAC,QAMT,CAAC;;;;;;;;;;;;;;;;;;;;;;;;CAC4C,CAAC;AAEnD,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,kBAAkB,EACzD,WAAW,CAAC,EACZ,MAAM,OAAO,CACX,yBAAyB,CAAC,gBAAgB,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CACpE,KACA,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAO1D,CAAC;AAEJ,eAAO,MAAM,8BAA8B,GAAI,CAAC,SAAS,kBAAkB,EACzE,MAAM,OAAO,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,EAChE,WAAW,CAAC,KACX,mBAAmB,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG;IACrD,MAAM,EAAE,OAAO,oBAAoB,CAAC;CAWrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,UAAU,CAAC,OAAO,8BAA8B,CAAC,CAAC,CAAC,CAAC,CAAC;AAEzD,MAAM,MAAM,iCAAiC,CAC3C,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,UAAU,CACZ,OAAO,gCAAgC,CACrC,gBAAgB,CAAC,CAAC,CAAC,EACnB,0BAA0B,CAAC,CAAC,CAAC,CAC9B,CACF,CAAC;AAEF,MAAM,MAAM,sCAAsC,CAChD,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,UAAU,CACZ,OAAO,qCAAqC,CAC1C,gBAAgB,CAAC,CAAC,CAAC,EACnB,0BAA0B,CAAC,CAAC,CAAC,CAC9B,CACF,CAAC;AAEF,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,MAAM,IAAI,OAAO,oBAAoB,CAY/C;AAED,wBAAgB,6BAA6B,CAAC,CAAC,SAAS,kBAAkB,EACxE,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,QAAQ,IAAI,CAAC,CAMvB;AAED,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,kBAAkB,EAChE,WAAW,GAAG,OAAO,gBAAgB,IAAI,OAAO,mBAAmB,GAAG,CAAC,EAAE;;;;;;CAmB1E,CAAC"}

package/src/evm-wallet/eip712-messages.ts

@@ -0,0 +1,286 @@
+/**
+ * @file Portfolio operations are either in a permit2 witness or standalone,
+ * in either case, following EIP-712
+ *
+ * The fields included in the operation differ based on which way they're submitted.
+ * In the wrapped case, we don't want to repeat stuff from the permit envelope.
+ * {@link OperationTypes}
+ *
+ * Currently all types and helpers are built around a hard-coded Ymax product
+ * name but with some effort this could be parametrizable
+ */
+
+import type {
+  TypedData,
+  TypedDataDomain,
+  TypedDataToPrimitiveTypes,
+} from 'abitype';
+import type { TypedDataDefinition } from 'viem';
+import type { TypedDataParameter } from '@agoric/orchestration/src/utils/abitype.ts';
+import {
+  type Witness,
+  type getPermitWitnessTransferFromData,
+  type getPermitBatchWitnessTransferFromData,
+  makeWitness,
+} from '@agoric/orchestration/src/utils/permit2.ts';
+
+const YMAX_DOMAIN_NAME = 'Ymax';
+const YMAX_DOMAIN_VERSION = '1';
+
+const YMAX_WITNESS_FIELD_NAME_PREFIX = 'ymax';
+
+const StandaloneDomainTypeParams = [
+  { name: 'name', type: 'string' },
+  { name: 'version', type: 'string' },
+] as const satisfies TypedDataParameter[];
+
+const YmaxStandaloneDomain = {
+  name: YMAX_DOMAIN_NAME,
+  version: YMAX_DOMAIN_VERSION,
+} as const satisfies TypedDataDomain;
+
+// A param to designate the portfolio in operations by its `portfolioId`
+const PortfolioIdParam = {
+  name: 'portfolio',
+  type: 'uint256',
+} as const satisfies TypedDataParameter;
+
+// XXX: Remove
+const SharedPortfolioTypeParams = [] as const satisfies TypedDataParameter[];
+
+/**
+ * Fields included in Permit data that we don't want duplicated in witness data,
+ * so only included in standalone typed data.
+ */
+const PortfolioStandaloneTypeParams = [
+  { name: 'nonce', type: 'uint256' },
+  { name: 'deadline', type: 'uint256' },
+] as const satisfies TypedDataParameter[];
+
+/**
+ * The set of portfolio operations supported by EVM Wallets, and their associated params
+ */
+const OperationTypes = {
+  OpenPortfolio: [{ name: 'allocations', type: 'Allocation[]' }],
+  Rebalance: [{ name: 'allocations', type: 'Allocation[]' }, PortfolioIdParam],
+  Deposit: [PortfolioIdParam],
+} as const satisfies TypedData;
+type OperationTypes = typeof OperationTypes;
+export type OperationTypeNames = keyof OperationTypes;
+
+const OperationSubTypes = {
+  Allocation: [
+    { name: 'instrument', type: 'string' },
+    { name: 'portion', type: 'uint256' },
+  ],
+} as const satisfies TypedData;
+
+/**
+ * Target allocation for portfolio positions.
+ * Uses 'portion' (not 'basisPoints') to allow flexible ratios.
+ * The denominator is implicitly the sum of all portions.
+ *
+ * Examples:
+ * - [{instrument: 'A', portion: 60}, {instrument: 'B', portion: 40}] => 60:40 ratio
+ * - [{instrument: 'A', portion: 6}, {instrument: 'B', portion: 4}] => 6:4 ratio (same as 60:40)
+ */
+export type TargetAllocation = TypedDataToPrimitiveTypes<
+  typeof OperationSubTypes
+>['Allocation'];
+
+/**
+ * In the wrapped case, the domain is fixed by permit2, so we can't choose name/version there.
+ * so we put the ymax-specifc domain name and version in the type name.
+ */
+const getYmaxWitnessTypeName = <T extends OperationTypeNames>(operation: T) =>
+  `${YMAX_DOMAIN_NAME}V${YMAX_DOMAIN_VERSION}${operation}` as const;
+type YmaxWitnessTypeName<T extends OperationTypeNames> = ReturnType<
+  typeof getYmaxWitnessTypeName<T>
+>;
+const getYmaxWitnessFieldName = <T extends OperationTypeNames>(operation: T) =>
+  `${YMAX_WITNESS_FIELD_NAME_PREFIX}${operation}` as const;
+type YmaxWitnessFieldName<T extends OperationTypeNames> = ReturnType<
+  typeof getYmaxWitnessFieldName<T>
+>;
+
+/**
+ * showing a field named "witness" in the wallet signing UI is... boring
+ * so let's put something more relevant like the @{link OperationTypes}: Deposit etc.
+ */
+const getYmaxWitnessTypeParam = <T extends OperationTypeNames>(
+  operation: T,
+): YmaxWitnessTypeParam<T> => ({
+  name: getYmaxWitnessFieldName(operation),
+  type: getYmaxWitnessTypeName(operation),
+});
+export type YmaxWitnessTypeParam<
+  T extends OperationTypeNames = OperationTypeNames,
+> = TypedDataParameter<YmaxWitnessFieldName<T>, YmaxWitnessTypeName<T>>;
+
+// TODO: Filter operation types to only those needed for witness/standalone
+type YmaxWitnessOperationTypes<
+  T extends OperationTypeNames = OperationTypeNames,
+> = {
+  [K in T as YmaxWitnessTypeName<K>]: [
+    ...OperationTypes[K],
+    ...typeof SharedPortfolioTypeParams,
+  ];
+};
+type YmaxWitnessTypes<T extends OperationTypeNames = OperationTypeNames> =
+  YmaxWitnessOperationTypes<T> & typeof OperationSubTypes;
+type YmaxStandaloneOperationTypes<
+  T extends OperationTypeNames = OperationTypeNames,
+> = {
+  [K in T]: [
+    ...OperationTypes[K],
+    ...typeof SharedPortfolioTypeParams,
+    ...typeof PortfolioStandaloneTypeParams,
+  ];
+};
+type YmaxStandaloneTypes<T extends OperationTypeNames = OperationTypeNames> =
+  YmaxStandaloneOperationTypes<T> &
+    typeof OperationSubTypes & {
+      EIP712Domain: typeof StandaloneDomainTypeParams;
+    };
+
+export type YmaxOperationType<T extends OperationTypeNames> =
+  TypedDataToPrimitiveTypes<OperationTypes & typeof OperationSubTypes>[T];
+
+// Hack to satisfy TypeScript limitations with generic inference in complex types
+// Equivalent to `YmaxWitnessTypeParam`
+type YmaxWitnessMappedTypeParam<T extends OperationTypeNames> =
+  TypedDataParameter<
+    YmaxWitnessFieldName<T>,
+    Extract<keyof YmaxWitnessOperationTypes<T>, string>
+  >;
+
+const getYmaxWitnessTypes = <T extends OperationTypeNames>(operation: T) =>
+  ({
+    [getYmaxWitnessTypeName(operation)]: [
+      ...OperationTypes[operation],
+      ...SharedPortfolioTypeParams,
+    ],
+    ...OperationSubTypes,
+  }) as YmaxWitnessTypes<T> satisfies TypedData;
+
+const getYmaxStandaloneTypes = <T extends OperationTypeNames>(operation: T) =>
+  ({
+    EIP712Domain: StandaloneDomainTypeParams,
+    [operation]: [
+      ...OperationTypes[operation],
+      ...SharedPortfolioTypeParams,
+      ...PortfolioStandaloneTypeParams,
+    ],
+    ...OperationSubTypes,
+  }) as YmaxStandaloneTypes<T> satisfies TypedData;
+
+export const getYmaxOperationTypes = <T extends OperationTypeNames>(
+  operation: T,
+) =>
+  ({
+    [operation]: OperationTypes[operation],
+    ...OperationSubTypes,
+  }) as {
+    [K in T]: OperationTypes[K];
+  } & typeof OperationSubTypes satisfies TypedData;
+
+export const getYmaxWitness = <T extends OperationTypeNames>(
+  operation: T,
+  data: NoInfer<
+    TypedDataToPrimitiveTypes<YmaxWitnessTypes>[YmaxWitnessTypeName<T>]
+  >,
+): Witness<YmaxWitnessTypes<T>, YmaxWitnessMappedTypeParam<T>> =>
+  // @ts-expect-error some generic inference issue I suppose?
+  makeWitness(
+    // @ts-expect-error some generic inference issue I suppose?
+    data,
+    getYmaxWitnessTypes(operation),
+    getYmaxWitnessTypeParam(operation),
+  );
+
+export const getYmaxStandaloneOperationData = <T extends OperationTypeNames>(
+  data: NoInfer<TypedDataToPrimitiveTypes<YmaxStandaloneTypes>[T]>,
+  operation: T,
+): TypedDataDefinition<YmaxStandaloneTypes<T>, T, T> & {
+  domain: typeof YmaxStandaloneDomain;
+} => {
+  const types = getYmaxStandaloneTypes(operation);
+
+  // @ts-expect-error some generic inference issue I suppose?
+  return {
+    domain: YmaxStandaloneDomain,
+    types,
+    primaryType: operation,
+    message: data,
+  };
+};
+
+export type YmaxStandaloneOperationData<
+  T extends OperationTypeNames = OperationTypeNames,
+> = ReturnType<typeof getYmaxStandaloneOperationData<T>>;
+
+export type YmaxPermitWitnessTransferFromData<
+  T extends OperationTypeNames = OperationTypeNames,
+> = ReturnType<
+  typeof getPermitWitnessTransferFromData<
+    YmaxWitnessTypes<T>,
+    YmaxWitnessMappedTypeParam<T>
+  >
+>;
+
+export type YmaxPermitBatchWitnessTransferFromData<
+  T extends OperationTypeNames = OperationTypeNames,
+> = ReturnType<
+  typeof getPermitBatchWitnessTransferFromData<
+    YmaxWitnessTypes<T>,
+    YmaxWitnessMappedTypeParam<T>
+  >
+>;
+
+export function validateYmaxDomain(
+  domain: TypedDataDomain,
+): asserts domain is typeof YmaxStandaloneDomain {
+  if (domain.name !== YMAX_DOMAIN_NAME) {
+    throw new Error(
+      `Invalid Ymax domain name: ${domain.name} (expected ${YMAX_DOMAIN_NAME})`,
+    );
+  }
+  if (domain.version !== YMAX_DOMAIN_VERSION) {
+    throw new Error(
+      `Invalid Ymax domain version: ${domain.version} (expected ${YMAX_DOMAIN_VERSION})`,
+    );
+  }
+  // XXX: check no extra fields?
+}
+
+export function validateYmaxOperationTypeName<T extends OperationTypeNames>(
+  typeName: string,
+): asserts typeName is T {
+  if (!(typeName in OperationTypes)) {
+    throw new Error(
+      `Unknown Ymax operation type: ${typeName} (expected one of ${Object.keys(OperationTypes).join(', ')})`,
+    );
+  }
+}
+
+export const splitWitnessFieldType = <T extends OperationTypeNames>(
+  fieldName: `${typeof YMAX_DOMAIN_NAME}V${typeof YMAX_DOMAIN_VERSION}${T}`,
+) => {
+  const match = fieldName.match(/^YmaxV(\d+)(\w+)$/u);
+  if (!match) {
+    throw new Error(`Invalid witness field type name: ${fieldName}`);
+  }
+  const [, version, operation] = match;
+  const domain = {
+    name: YMAX_DOMAIN_NAME,
+    version,
+  } satisfies TypedDataDomain;
+
+  validateYmaxDomain(domain);
+  validateYmaxOperationTypeName<T>(operation);
+
+  return {
+    domain,
+    primaryType: operation,
+  };
+};

package/src/evm-wallet/message-handler-helpers.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @file Helpers to handle portfolio EIP-712 messages, extracting operation and
+ * deposit permit details, as well as verifying the signature.
+ *
+ * The viem runtime dependency is expected as a power to make this usable both
+ * on chain and in off-chain services.
+ */
+import type { Address, TypedDataDomain } from 'abitype';
+import type { Hex } from 'viem';
+import type { hashStruct, recoverTypedDataAddress, validateTypedData } from 'viem/utils';
+import { encodeType, type WithSignature } from '@agoric/orchestration/src/utils/viem.ts';
+import { type PermitTransferFrom } from '@agoric/orchestration/src/utils/permit2.ts';
+import { type OperationTypeNames, type YmaxStandaloneOperationData, type YmaxPermitWitnessTransferFromData, type YmaxOperationType } from './eip712-messages.ts';
+export type YmaxOperationDetails<T extends OperationTypeNames> = {
+    [P in T]: {
+        operation: P;
+        data: YmaxOperationType<P>;
+    };
+}[T];
+export type PermitDataPayload = {
+    chainId: NonNullable<TypedDataDomain['chainId']>;
+    permit: PermitTransferFrom;
+    witness: Hex;
+    witnessTypeString: string;
+};
+export type FullMessageDetails<T extends OperationTypeNames = OperationTypeNames> = YmaxOperationDetails<T> & {
+    permit?: WithSignature<PermitDataPayload>;
+    evmWalletAddress: Address;
+    nonce: bigint;
+    deadline: bigint;
+};
+export declare const makeEVMHandlerUtils: (powers: {
+    hashStruct: typeof hashStruct;
+    recoverTypedDataAddress: typeof recoverTypedDataAddress;
+    validateTypedData: typeof validateTypedData;
+    encodeType: typeof encodeType;
+}) => {
+    extractOperationDetailsFromStandaloneData: <T extends OperationTypeNames>(data: YmaxStandaloneOperationData<T>) => YmaxOperationDetails<T>;
+    extractOperationDetailsFromPermit2WitnessData: <T extends OperationTypeNames>(data: YmaxPermitWitnessTransferFromData<T>) => YmaxOperationDetails<T>;
+    extractPermitData: <T extends OperationTypeNames>(data: YmaxPermitWitnessTransferFromData<T>) => PermitDataPayload;
+    extractOperationDetailsFromSignedData: <T extends OperationTypeNames = "Deposit" | "Rebalance" | "OpenPortfolio">(signedData: WithSignature<YmaxPermitWitnessTransferFromData<T> | YmaxStandaloneOperationData<T>>) => Promise<FullMessageDetails<T>>;
+};
+//# sourceMappingURL=message-handler-helpers.d.ts.map

package/src/evm-wallet/message-handler-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-handler-helpers.d.ts","sourceRoot":"","sources":["message-handler-helpers.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,KAAK,EACV,UAAU,EACV,uBAAuB,EAEvB,iBAAiB,EAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,UAAU,EACV,KAAK,aAAa,EACnB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAIL,KAAK,kBAAkB,EACxB,MAAM,4CAA4C,CAAC;AACpD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,iCAAiC,EACtC,KAAK,iBAAiB,EAKvB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,kBAAkB,IAAI;KAC9D,CAAC,IAAI,CAAC,GAAG;QACR,SAAS,EAAE,CAAC,CAAC;QACb,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;KAC5B;CACF,CAAC,CAAC,CAAC,CAAC;AAEL,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IACjD,MAAM,EAAE,kBAAkB,CAAC;IAC3B,OAAO,EAAE,GAAG,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,oBAAoB,CAAC,CAAC,CAAC,GAAG;IAC5B,MAAM,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAC1C,gBAAgB,EAAE,OAAO,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,QAAQ;IAC1C,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9B,uBAAuB,EAAE,OAAO,uBAAuB,CAAC;IACxD,iBAAiB,EAAE,OAAO,iBAAiB,CAAC;IAC5C,UAAU,EAAE,OAAO,UAAU,CAAC;CAC/B;gDAUG,CAAC,SAAS,kBAAkB,QAEtB,2BAA2B,CAAC,CAAC,CAAC,KACnC,oBAAoB,CAAC,CAAC,CAAC;oDA2BxB,CAAC,SAAS,kBAAkB,QAEtB,iCAAiC,CAAC,CAAC,CAAC,KACzC,oBAAoB,CAAC,CAAC,CAAC;wBAwBC,CAAC,SAAS,kBAAkB,QAC/C,iCAAiC,CAAC,CAAC,CAAC,KACzC,iBAAiB;4CAkClB,CAAC,SAAS,kBAAkB,0DAEhB,aAAa,CACvB,iCAAiC,CAAC,CAAC,CAAC,GAAG,2BAA2B,CAAC,CAAC,CAAC,CACtE,KACA,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;CAiDlC,CAAC"}

package/src/evm-wallet/message-handler-helpers.ts

@@ -0,0 +1,223 @@
+/**
+ * @file Helpers to handle portfolio EIP-712 messages, extracting operation and
+ * deposit permit details, as well as verifying the signature.
+ *
+ * The viem runtime dependency is expected as a power to make this usable both
+ * on chain and in off-chain services.
+ */
+
+import type { Address, TypedDataDomain } from 'abitype';
+import type { Hex } from 'viem';
+import type {
+  hashStruct,
+  recoverTypedDataAddress,
+  RecoverTypedDataAddressParameters,
+  validateTypedData,
+} from 'viem/utils';
+import {
+  encodeType,
+  type WithSignature,
+} from '@agoric/orchestration/src/utils/viem.ts';
+import {
+  extractWitnessFieldFromTypes,
+  isPermit2MessageType,
+  makeWitnessTypeStringExtractor,
+  type PermitTransferFrom,
+} from '@agoric/orchestration/src/utils/permit2.ts';
+import {
+  type OperationTypeNames,
+  type YmaxStandaloneOperationData,
+  type YmaxPermitWitnessTransferFromData,
+  type YmaxOperationType,
+  splitWitnessFieldType,
+  validateYmaxDomain,
+  validateYmaxOperationTypeName,
+  getYmaxOperationTypes,
+} from './eip712-messages.ts';
+
+export type YmaxOperationDetails<T extends OperationTypeNames> = {
+  [P in T]: {
+    operation: P;
+    data: YmaxOperationType<P>;
+  };
+}[T];
+
+export type PermitDataPayload = {
+  chainId: NonNullable<TypedDataDomain['chainId']>;
+  permit: PermitTransferFrom;
+  witness: Hex;
+  witnessTypeString: string;
+};
+
+export type FullMessageDetails<
+  T extends OperationTypeNames = OperationTypeNames,
+> = YmaxOperationDetails<T> & {
+  permit?: WithSignature<PermitDataPayload>;
+  evmWalletAddress: Address;
+  nonce: bigint;
+  deadline: bigint;
+};
+
+export const makeEVMHandlerUtils = (powers: {
+  hashStruct: typeof hashStruct;
+  recoverTypedDataAddress: typeof recoverTypedDataAddress;
+  validateTypedData: typeof validateTypedData;
+  encodeType: typeof encodeType;
+}) => {
+  const { hashStruct, recoverTypedDataAddress, validateTypedData, encodeType } =
+    powers;
+  /**
+   * Extract operation type name and data from an EIP-712 standalone Ymax typed data
+   *
+   * @param data - The EIP-712 typed data of a standalone message
+   * @returns The operation type name and associated data
+   */
+  const extractOperationDetailsFromStandaloneData = <
+    T extends OperationTypeNames,
+  >(
+    data: YmaxStandaloneOperationData<T>,
+  ): YmaxOperationDetails<T> => {
+    // @ts-expect-error generic/union type compatibility
+    const standaloneData: YmaxStandaloneOperationData = data;
+
+    validateYmaxDomain(standaloneData.domain);
+    validateYmaxOperationTypeName<T>(standaloneData.primaryType);
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { nonce, deadline, ..._operationData } = standaloneData.message;
+    const operationData = _operationData as YmaxOperationType<T>;
+    const operation = standaloneData.primaryType;
+    // @ts-expect-error inference issue
+    validateTypedData({
+      types: getYmaxOperationTypes(operation),
+      message: operationData,
+      primaryType: operation,
+    });
+    return { operation, data: operationData };
+  };
+
+  /**
+   * Extract operation type name and data from an EIP-712 Permit2 witness typed data.
+   *
+   * @param data - The EIP-712 typed data of a Permit2 witness message
+   * @returns The operation type name and associated data
+   */
+  const extractOperationDetailsFromPermit2WitnessData = <
+    T extends OperationTypeNames,
+  >(
+    data: YmaxPermitWitnessTransferFromData<T>,
+  ): YmaxOperationDetails<T> => {
+    // @ts-expect-error generic/union type compatibility
+    const permitData: YmaxPermitWitnessTransferFromData = data;
+
+    const witnessField = extractWitnessFieldFromTypes(permitData.types);
+    const witnessData = permitData.message[
+      witnessField.name
+    ] as YmaxOperationType<T>;
+    const operation = splitWitnessFieldType(witnessField.type).primaryType as T;
+    // @ts-expect-error inference issue
+    validateTypedData({
+      types: getYmaxOperationTypes(operation),
+      message: witnessData,
+      primaryType: operation,
+    });
+    return { operation, data: witnessData };
+  };
+
+  /**
+   * Extract the data that can be used as partial arguments to permit2's
+   * permitWitnessTransferFrom
+   *
+   * @param data permit2 message with witness data to summarize
+   */
+  const extractPermitData = <T extends OperationTypeNames>(
+    data: YmaxPermitWitnessTransferFromData<T>,
+  ): PermitDataPayload => {
+    const witnessTypeStringExtractor = makeWitnessTypeStringExtractor({
+      encodeType,
+    });
+    // @ts-expect-error generic/union type compatibility
+    const permitData: YmaxPermitWitnessTransferFromData = data;
+
+    const witnessField = extractWitnessFieldFromTypes(permitData.types);
+    const { [witnessField.name]: witnessData, ...permit } = permitData.message;
+    const witness = hashStruct({
+      primaryType: witnessField.type,
+      types: permitData.types,
+      data: witnessData,
+    });
+    const witnessTypeString = witnessTypeStringExtractor(permitData.types);
+
+    const payload = {
+      chainId: permitData.domain!.chainId!,
+      permit,
+      witness,
+      witnessTypeString,
+    };
+
+    return payload;
+  };
+
+  /**
+   * Extract all details sufficient to handle any EIP-712 portfolio message,
+   * optionally with permit data.
+   *
+   * @param signedData
+   * @returns
+   */
+  const extractOperationDetailsFromSignedData = async <
+    T extends OperationTypeNames = OperationTypeNames,
+  >(
+    signedData: WithSignature<
+      YmaxPermitWitnessTransferFromData<T> | YmaxStandaloneOperationData<T>
+    >,
+  ): Promise<FullMessageDetails<T>> => {
+    const tokenOwner = await recoverTypedDataAddress(
+      signedData as RecoverTypedDataAddressParameters,
+    );
+    const { nonce, deadline } = (
+      signedData as unknown as
+        | YmaxPermitWitnessTransferFromData
+        | YmaxStandaloneOperationData
+    ).message;
+
+    if (isPermit2MessageType(signedData.primaryType)) {
+      const permit2Data =
+        signedData as unknown as YmaxPermitWitnessTransferFromData<T>;
+
+      const permitPayload = {
+        ...extractPermitData(permit2Data),
+        signature: signedData.signature,
+      };
+      const operationDetails =
+        extractOperationDetailsFromPermit2WitnessData(permit2Data);
+
+      return {
+        ...operationDetails,
+        permit: permitPayload,
+        evmWalletAddress: tokenOwner,
+        nonce,
+        deadline,
+      };
+    } else {
+      const standaloneData =
+        signedData as unknown as YmaxStandaloneOperationData<T>;
+      const operationDetails =
+        extractOperationDetailsFromStandaloneData(standaloneData);
+
+      return {
+        ...operationDetails,
+        evmWalletAddress: tokenOwner,
+        nonce,
+        deadline,
+      };
+    }
+  };
+
+  return {
+    extractOperationDetailsFromStandaloneData,
+    extractOperationDetailsFromPermit2WitnessData,
+    extractPermitData,
+    extractOperationDetailsFromSignedData,
+  };
+};