@agoric/portfolio-api 0.2.0 → 0.2.1-upgrade-23-dev-bd79330.0.bd79330

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

@@ -0,0 +1,213 @@
+/**
+ * @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 { Address, TypedDataDomain, TypedDataToPrimitiveTypes } from 'abitype';
+import type { TypedDataDefinition } from 'viem';
+import type { TypedDataParameter } from '@agoric/orchestration/src/utils/abitype.js';
+import { type Witness, type getPermitWitnessTransferFromData, type getPermitBatchWitnessTransferFromData } from '@agoric/orchestration/src/utils/permit2.js';
+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";
+}, {
+    readonly name: "chainId";
+    readonly type: "uint256";
+}, {
+    readonly name: "verifyingContract";
+    readonly type: "address";
+}];
+declare const YmaxStandaloneDomainBase: {
+    readonly name: "Ymax";
+    readonly version: "1";
+};
+export type YmaxFullDomain = typeof YmaxStandaloneDomainBase & {
+    chainId: bigint;
+    verifyingContract: Address;
+};
+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: "portfolio";
+        readonly type: "uint256";
+    }];
+    readonly SetTargetAllocation: readonly [{
+        readonly name: "allocations";
+        readonly type: "Allocation[]";
+    }, {
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+    readonly Deposit: readonly [{
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+    /**
+     * Withdraw funds from a portfolio to the source EVM account.
+     * The signer of the message must match the portfolio's source EVM account
+     * The destination chain is determined from the domain info (chainId).
+     * - token: ERC-20 token contract address (must be USDC contract on the destination chain)
+     */
+    readonly Withdraw: readonly [{
+        readonly name: "withdraw";
+        readonly type: "Asset";
+    }, {
+        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";
+    }];
+    readonly Asset: [{
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        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>, Extract<keyof YmaxWitnessOperationTypes<T>, string>>;
+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 YmaxWitnessData<T extends OperationTypeNames> = TypedDataToPrimitiveTypes<YmaxWitnessTypes<T>>[YmaxWitnessTypeParam<T>['type']];
+type YmaxStandaloneData<T extends OperationTypeNames> = TypedDataToPrimitiveTypes<YmaxStandaloneTypes<T>>[T];
+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: "portfolio";
+        readonly type: "uint256";
+    }];
+    readonly SetTargetAllocation: readonly [{
+        readonly name: "allocations";
+        readonly type: "Allocation[]";
+    }, {
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+    readonly Deposit: readonly [{
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+    /**
+     * Withdraw funds from a portfolio to the source EVM account.
+     * The signer of the message must match the portfolio's source EVM account
+     * The destination chain is determined from the domain info (chainId).
+     * - token: ERC-20 token contract address (must be USDC contract on the destination chain)
+     */
+    readonly Withdraw: readonly [{
+        readonly name: "withdraw";
+        readonly type: "Asset";
+    }, {
+        readonly name: "portfolio";
+        readonly type: "uint256";
+    }];
+}[K]; } & {
+    readonly Allocation: readonly [{
+        readonly name: "instrument";
+        readonly type: "string";
+    }, {
+        readonly name: "portion";
+        readonly type: "uint256";
+    }];
+    readonly Asset: [{
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+};
+export declare const getYmaxWitness: <T extends OperationTypeNames>(operation: T, data: NoInfer<YmaxWitnessData<T>>) => Witness<YmaxWitnessTypes<T>, YmaxWitnessTypeParam<T>>;
+export declare const getYmaxStandaloneDomain: (chainId: bigint | number, verifyingContract: Address) => YmaxFullDomain;
+export declare const getYmaxStandaloneOperationData: <T extends OperationTypeNames>(data: NoInfer<YmaxStandaloneData<T>>, operation: T, chainId: bigint | number, verifyingContract: Address) => TypedDataDefinition<YmaxStandaloneTypes<T>, T, T> & {
+    domain: YmaxFullDomain;
+};
+export type YmaxStandaloneOperationData<T extends OperationTypeNames = OperationTypeNames> = ReturnType<typeof getYmaxStandaloneOperationData<T>>;
+export type YmaxPermitWitnessTransferFromData<T extends OperationTypeNames = OperationTypeNames> = ReturnType<typeof getPermitWitnessTransferFromData<YmaxWitnessTypes<T>, YmaxWitnessTypeParam<T>>>;
+export type YmaxPermitBatchWitnessTransferFromData<T extends OperationTypeNames = OperationTypeNames> = ReturnType<typeof getPermitBatchWitnessTransferFromData<YmaxWitnessTypes<T>, YmaxWitnessTypeParam<T>>>;
+export declare function validateYmaxDomainBase(domain: TypedDataDomain): asserts domain is typeof YmaxStandaloneDomainBase;
+export declare function validateYmaxDomain(domain: TypedDataDomain, validContractAddresses?: Record<number | string, Address> | undefined): asserts domain is YmaxFullDomain;
+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,EACV,OAAO,EAEP,eAAe,EACf,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAEhD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,gCAAgC,EACrC,KAAK,qCAAqC,EAG3C,MAAM,4CAA4C,CAAC;AAEpD,QAAA,MAAM,gBAAgB,SAAS,CAAC;AAChC,QAAA,MAAM,mBAAmB,MAAM,CAAC;AAIhC,QAAA,MAAM,0BAA0B;;;;;;;;;;;;EAKS,CAAC;AAE1C,QAAA,MAAM,wBAAwB;;;CAGM,CAAC;AACrC,MAAM,MAAM,cAAc,GAAG,OAAO,wBAAwB,GAAG;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AASF,QAAA,MAAM,yBAAyB,IAA6C,CAAC;AAE7E;;;GAGG;AACH,QAAA,MAAM,6BAA6B;;;;;;EAGM,CAAC;AAE1C;;GAEG;AACH,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;IAQlB;;;;;OAKG;;;;;;;;CAEyB,CAAC;AAC/B,KAAK,cAAc,GAAG,OAAO,cAAc,CAAC;AAC5C,MAAM,MAAM,kBAAkB,GAAG,MAAM,cAAc,CAAC;AAEtD,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;CAMO,CAAC;AAE/B;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,yBAAyB,CACtD,OAAO,iBAAiB,CACzB,CAAC,YAAY,CAAC,CAAC;AAQhB;;;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;AACF,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,kBAAkB,CACpB,oBAAoB,CAAC,CAAC,CAAC,EACvB,OAAO,CAAC,MAAM,yBAAyB,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CACpD,CAAC;AAcF,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;AAE1E,KAAK,eAAe,CAAC,CAAC,SAAS,kBAAkB,IAAI,yBAAyB,CAC5E,gBAAgB,CAAC,CAAC,CAAC,CACpB,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AACnC,KAAK,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,IAClD,yBAAyB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AA8BvD,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,kBAAkB,EAChE,WAAW,CAAC,QAGT,CAAC;;;;;;;;;;;;;;;;;;;;IAzIJ;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;CAqI6C,CAAC;AAEnD,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,kBAAkB,EACzD,WAAW,CAAC,EACZ,MAAM,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAChC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAKpD,CAAC;AAEJ,eAAO,MAAM,uBAAuB,GAClC,SAAS,MAAM,GAAG,MAAM,EACxB,mBAAmB,OAAO,KACzB,cAID,CAAC;AAEH,eAAO,MAAM,8BAA8B,GAAI,CAAC,SAAS,kBAAkB,EACzE,MAAM,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,EACpC,WAAW,CAAC,EACZ,SAAS,MAAM,GAAG,MAAM,EACxB,mBAAmB,OAAO,KACzB,mBAAmB,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG;IACrD,MAAM,EAAE,cAAc,CAAC;CAYxB,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,oBAAoB,CAAC,CAAC,CAAC,CACxB,CACF,CAAC;AAEF,MAAM,MAAM,sCAAsC,CAChD,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,UAAU,CACZ,OAAO,qCAAqC,CAC1C,gBAAgB,CAAC,CAAC,CAAC,EACnB,oBAAoB,CAAC,CAAC,CAAC,CACxB,CACF,CAAC;AAEF,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,MAAM,IAAI,OAAO,wBAAwB,CAWnD;AAED,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,eAAe,EACvB,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GACpE,OAAO,CAAC,MAAM,IAAI,cAAc,CAsBlC;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;;;;;;CAqB1E,CAAC"}

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

@@ -0,0 +1,355 @@
+/**
+ * @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 { Fail, q } from '@endo/errors';
+;                                                                                    
+import {
+               
+                                        
+                                             
+  makeWitness,
+  TokenPermissionsComponents,
+} from '@agoric/orchestration/src/utils/permit2.js';
+
+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' },
+  { name: 'chainId', type: 'uint256' },
+  { name: 'verifyingContract', type: 'address' },
+]                                        ;
+
+const YmaxStandaloneDomainBase = {
+  name: YMAX_DOMAIN_NAME,
+  version: YMAX_DOMAIN_VERSION,
+}                                   ;
+;                                                               
+                  
+                             
+  
+
+// A param to designate the portfolio in operations by its `portfolioId`
+const PortfolioIdParam = {
+  name: 'portfolio',
+  type: 'uint256',
+}                                      ;
+
+// XXX: Remove
+const SharedPortfolioTypeParams = []                                        ;
+
+/**
+ * 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' },
+]                                        ;
+
+/**
+ * The set of portfolio operations supported by EVM Wallets, and their associated params
+ */
+const OperationTypes = {
+  OpenPortfolio: [{ name: 'allocations', type: 'Allocation[]' }],
+  Rebalance: [PortfolioIdParam],
+  SetTargetAllocation: [
+    { name: 'allocations', type: 'Allocation[]' },
+    PortfolioIdParam,
+  ],
+  Deposit: [PortfolioIdParam],
+  /**
+   * Withdraw funds from a portfolio to the source EVM account.
+   * The signer of the message must match the portfolio's source EVM account
+   * The destination chain is determined from the domain info (chainId).
+   * - token: ERC-20 token contract address (must be USDC contract on the destination chain)
+   */
+  Withdraw: [{ name: 'withdraw', type: 'Asset' }, PortfolioIdParam],
+}                             ;
+;                                           
+;                                                     
+
+const OperationSubTypes = {
+  Allocation: [
+    { name: 'instrument', type: 'string' },
+    { name: 'portion', type: 'uint256' },
+  ],
+  Asset: TokenPermissionsComponents,
+}                             ;
+
+/**
+ * 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)
+ */
+;                                                        
+                          
+                
+;                                   
+                   
+                                          
+     
+              
+                             
+
+/**
+ * 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 =                               (operation   ) =>
+  `${YMAX_DOMAIN_NAME}V${YMAX_DOMAIN_VERSION}${operation}`         ;
+;                                                                   
+                                  
+  
+const getYmaxWitnessFieldName =                               (operation   ) =>
+  `${YMAX_WITNESS_FIELD_NAME_PREFIX}${operation}`         ;
+;                                                                    
+                                   
+  
+;                                
+                                                    
+                       
+                          
+                                                     
+  
+
+/**
+ * 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 =                               (
+  operation   ,
+                         ) => ({
+  name: getYmaxWitnessFieldName(operation),
+  type: getYmaxWitnessTypeName(operation)                                   ,
+});
+
+// TODO: Filter operation types to only those needed for witness/standalone
+;                              
+                                                    
+     
+                                       
+                         
+                                        
+    
+  
+;                                                                         
+                                                          
+;                                 
+                                                    
+     
+             
+                         
+                                        
+                                            
+    
+  
+;                                                                            
+                                   
+                                
+                                                      
+      
+
+;                                                            
+                                                                          
+
+;                                                                              
+                     
+                                   
+;                                                      
+                                                       
+
+const getYmaxOperationAndSubTypes = (
+                   
+                                          
+  
+  operation   ,
+  params   ,
+) =>
+  ({
+    [operation]: params,
+    ...OperationSubTypes,
+  })                                                            ;
+
+const getYmaxWitnessTypes =                               (operation   ) =>
+  getYmaxOperationAndSubTypes(getYmaxWitnessTypeName(operation), [
+    ...OperationTypes[operation],
+    ...SharedPortfolioTypeParams,
+  ])                                           ;
+
+const getYmaxStandaloneTypes =                               (operation   ) =>
+  ({
+    EIP712Domain: StandaloneDomainTypeParams,
+    ...getYmaxOperationAndSubTypes(operation, [
+      ...OperationTypes[operation],
+      ...SharedPortfolioTypeParams,
+      ...PortfolioStandaloneTypeParams,
+    ]),
+  })                                              ;
+
+export const getYmaxOperationTypes =                               (
+  operation   ,
+) =>
+  getYmaxOperationAndSubTypes(operation, OperationTypes[operation])     
+                                
+                                                  ;
+
+export const getYmaxWitness =                               (
+  operation   ,
+  data                             ,
+                                                       ) =>
+  makeWitness                                              (
+    data,
+    getYmaxWitnessTypes(operation),
+    getYmaxWitnessTypeParam(operation),
+  );
+
+export const getYmaxStandaloneDomain = (
+  chainId                 ,
+  verifyingContract         ,
+                ) => ({
+  ...YmaxStandaloneDomainBase,
+  chainId: BigInt(chainId),
+  verifyingContract,
+});
+
+export const getYmaxStandaloneOperationData =                               (
+  data                                ,
+  operation   ,
+  chainId                 ,
+  verifyingContract         ,
+                                                        
+                         
+) => {
+  const types = getYmaxStandaloneTypes(operation);
+
+  return {
+    domain: getYmaxStandaloneDomain(chainId, verifyingContract),
+    types,
+    primaryType: operation,
+    message: data                                                        ,
+  }                                                         
+                           
+   ;
+};
+
+;                                       
+                                                    
+                                                         
+
+;                                             
+                                                    
+               
+                                          
+                        
+                           
+   
+  
+
+;                                                  
+                                                    
+               
+                                               
+                        
+                           
+   
+  
+
+export function validateYmaxDomainBase(
+  domain                 ,
+)                                                    {
+  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})`,
+    );
+  }
+}
+
+export function validateYmaxDomain(
+  domain                 ,
+  validContractAddresses                                               ,
+)                                   {
+  const baseDomain = domain;
+  validateYmaxDomainBase(baseDomain);
+
+  typeof domain.chainId === 'bigint' || Fail`Chain ID expected to be a BigInt`;
+
+  if (validContractAddresses) {
+    const chainIdStr = String(domain.chainId);
+
+    chainIdStr in validContractAddresses ||
+      Fail`Unknown chain ID in Ymax domain: ${q(domain.chainId)}`;
+
+    domain.verifyingContract === validContractAddresses[chainIdStr] ||
+      Fail`Invalid verifying contract for chain ID ${q(domain.chainId)}: ${q(
+        domain.verifyingContract,
+      )} (expected ${q(validContractAddresses[chainIdStr])})`;
+  } else {
+    (domain.chainId !== undefined && domain.verifyingContract !== undefined) ||
+      Fail`Ymax domain must include chainId and verifyingContract`;
+  }
+
+  // XXX: check no extra fields?
+}
+
+export function validateYmaxOperationTypeName                              (
+  typeName        ,
+)                        {
+  if (!(typeName in OperationTypes)) {
+    throw new Error(
+      `Unknown Ymax operation type: ${typeName} (expected one of ${Object.keys(OperationTypes).join(', ')})`,
+    );
+  }
+}
+
+export const splitWitnessFieldType =                               (
+  fieldName                                                                ,
+) => {
+  const match =
+    fieldName.startsWith(YMAX_DOMAIN_NAME) &&
+    fieldName.substring(YMAX_DOMAIN_NAME.length).match(/^V(\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,
+  }                          ;
+
+  validateYmaxDomainBase(domain);
+  validateYmaxOperationTypeName   (operation);
+
+  return {
+    domain,
+    primaryType: operation,
+  };
+};

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

@@ -0,0 +1,54 @@
+/**
+ * @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 { AbiParameterToPrimitiveType, Address, TypedDataDomain } from 'abitype';
+import type { hashStruct, isHex, recoverTypedDataAddress, validateTypedData } from 'viem/utils';
+import { encodeType, type WithSignature } from '@agoric/orchestration/src/utils/viem.js';
+import { type PermitWitnessTransferFromInputComponents } from '@agoric/orchestration/src/utils/permit2.js';
+import { type OperationTypeNames, type YmaxStandaloneOperationData, type YmaxPermitWitnessTransferFromData, type YmaxOperationType, type YmaxFullDomain } from './eip712-messages.js';
+export type YmaxOperationDetails<T extends OperationTypeNames = OperationTypeNames> = {
+    [P in T]: {
+        operation: P;
+        domain: YmaxFullDomain;
+        data: YmaxOperationType<P>;
+    };
+}[T];
+export type PermitWitnessTransferFromPayload = AbiParameterToPrimitiveType<{
+    type: 'tuple';
+    components: typeof PermitWitnessTransferFromInputComponents;
+}>;
+export type PermitDetails = {
+    chainId: NonNullable<TypedDataDomain['chainId']>;
+    token: Address;
+    amount: bigint;
+    spender: Address;
+    permit2Payload: Omit<PermitWitnessTransferFromPayload, 'transferDetails'>;
+};
+export type FullMessageDetails<T extends OperationTypeNames = OperationTypeNames> = YmaxOperationDetails<T> & {
+    permitDetails?: PermitDetails;
+    evmWalletAddress: Address;
+    nonce: bigint;
+    deadline: bigint;
+};
+/**
+ * EVM Message handler utils that depend on 'viem' utils for their
+ * implementation. Since on-chain we cannot directly import from 'viem',
+ * use a maker pattern to create these utils.
+ */
+export declare const makeEVMHandlerUtils: (viemUtils: {
+    isHex: typeof isHex;
+    hashStruct: typeof hashStruct;
+    recoverTypedDataAddress: typeof recoverTypedDataAddress;
+    validateTypedData: typeof validateTypedData;
+    encodeType: typeof encodeType;
+}) => {
+    extractOperationDetailsFromStandaloneData: <T extends OperationTypeNames>(data: YmaxStandaloneOperationData<T>, validContractAddresses?: Record<number | string, Address>) => YmaxOperationDetails<T>;
+    extractOperationDetailsFromPermit2WitnessData: <T extends OperationTypeNames>(data: YmaxPermitWitnessTransferFromData<T>) => YmaxOperationDetails<T>;
+    extractPermitDetails: <T extends OperationTypeNames>(data: YmaxPermitWitnessTransferFromData<T>, owner: Address, signature: WithSignature<object>["signature"]) => PermitDetails;
+    extractOperationDetailsFromSignedData: <T extends OperationTypeNames = "Withdraw" | "Deposit" | "Rebalance" | "OpenPortfolio" | "SetTargetAllocation">(signedData: WithSignature<YmaxPermitWitnessTransferFromData<T> | YmaxStandaloneOperationData<T>>, validStandaloneContractAddresses?: Record<number | string, Address>) => 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,EACV,2BAA2B,EAC3B,OAAO,EACP,eAAe,EAChB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EACV,UAAU,EACV,KAAK,EACL,uBAAuB,EAEvB,iBAAiB,EAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,UAAU,EACV,KAAK,aAAa,EACnB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAIL,KAAK,wCAAwC,EAC9C,MAAM,4CAA4C,CAAC;AACpD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,iCAAiC,EACtC,KAAK,iBAAiB,EAKtB,KAAK,cAAc,EACpB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C;KACD,CAAC,IAAI,CAAC,GAAG;QACR,SAAS,EAAE,CAAC,CAAC;QACb,MAAM,EAAE,cAAc,CAAC;QACvB,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;KAC5B;CACF,CAAC,CAAC,CAAC,CAAC;AAEL,MAAM,MAAM,gCAAgC,GAAG,2BAA2B,CAAC;IACzE,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,OAAO,wCAAwC,CAAC;CAC7D,CAAC,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IACjD,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,IAAI,CAAC,gCAAgC,EAAE,iBAAiB,CAAC,CAAC;CAC3E,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,oBAAoB,CAAC,CAAC,CAAC,GAAG;IAC5B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,WAAW;IAC7C,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,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;gDAqBG,CAAC,SAAS,kBAAkB,QAEtB,2BAA2B,CAAC,CAAC,CAAC,2BACX,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,KACxD,oBAAoB,CAAC,CAAC,CAAC;oDA6BxB,CAAC,SAAS,kBAAkB,QAEtB,iCAAiC,CAAC,CAAC,CAAC,KACzC,oBAAoB,CAAC,CAAC,CAAC;2BAmCI,CAAC,SAAS,kBAAkB,QAClD,iCAAiC,CAAC,CAAC,CAAC,SACnC,OAAO,aACH,aAAa,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,KAC5C,aAAa;4CAiDd,CAAC,SAAS,kBAAkB,+FAEhB,aAAa,CACvB,iCAAiC,CAAC,CAAC,CAAC,GAAG,2BAA2B,CAAC,CAAC,CAAC,CACtE,qCACkC,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,KAClE,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;CAoDlC,CAAC"}