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

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

@@ -0,0 +1,289 @@
+/**
+ * @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 {
+  encodeType,
+                     
+} from '@agoric/orchestration/src/utils/viem.js';
+import {
+  extractWitnessFieldFromTypes,
+  isPermit2MessageType,
+  makeWitnessTypeStringExtractor,
+                                                
+} from '@agoric/orchestration/src/utils/permit2.js';
+import {
+                          
+                                   
+                                         
+                         
+  splitWitnessFieldType,
+  validateYmaxDomain,
+  validateYmaxOperationTypeName,
+  getYmaxOperationTypes,
+                      
+} from './eip712-messages.js';
+
+;                                
+                                                    
+     
+             
+                 
+                           
+                               
+    
+     
+
+;                                                                           
+                
+                                                              
+   
+
+;                            
+                                                   
+                 
+                 
+                   
+                                                                            
+  
+
+;                              
+                                                    
+                               
+                                
+                            
+                
+                   
+  
+
+/**
+ * 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 const makeEVMHandlerUtils = (viemUtils   
+                      
+                                
+                                                          
+                                              
+                                
+ ) => {
+  const {
+    isHex,
+    hashStruct,
+    recoverTypedDataAddress,
+    validateTypedData,
+    encodeType,
+  } = viemUtils;
+
+  const getPermit2WitnessTypeString = makeWitnessTypeStringExtractor({
+    encodeType,
+  });
+
+  /**
+   * 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
+   * @param validContractAddresses - *Deprecated*
+   * @returns The operation type name and associated data
+   */
+  const extractOperationDetailsFromStandaloneData = (
+                                 
+    
+    data                                ,
+    validContractAddresses                                   ,
+                           ) => {
+    // @ts-expect-error generic/union type compatibility
+    const standaloneData                              = data;
+
+    const { domain } = standaloneData;
+
+    validateYmaxDomain(domain, validContractAddresses);
+    validateYmaxOperationTypeName   (standaloneData.primaryType);
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { nonce, deadline, ..._operationData } = standaloneData.message;
+    const operationData = _operationData                        ;
+    const operation = standaloneData.primaryType;
+    // @ts-expect-error inference issue
+    validateTypedData({
+      types: getYmaxOperationTypes(operation),
+      message: operationData,
+      primaryType: operation,
+    });
+    return { operation, domain, 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 = (
+                                 
+    
+    data                                      ,
+                           ) => {
+    // @ts-expect-error generic/union type compatibility
+    const permitData                                    = data;
+
+    const witnessField = extractWitnessFieldFromTypes(permitData.types);
+    const witnessData = permitData.message[
+      witnessField.name
+    ]                        ;
+    const { primaryType, domain } = splitWitnessFieldType(witnessField.type);
+    const chainId = BigInt((data.domain                   ).chainId );
+    const operation = primaryType     ;
+    // @ts-expect-error inference issue
+    validateTypedData({
+      types: getYmaxOperationTypes(operation),
+      message: witnessData,
+      primaryType: operation,
+    });
+    const spender = permitData.message.spender;
+    return {
+      operation,
+      domain: { ...domain, chainId, verifyingContract: spender },
+      data: witnessData,
+    };
+  };
+
+  /**
+   * Extract the data that can be used as partial arguments to permit2's
+   * permitWitnessTransferFrom
+   *
+   * This does not verify the signature; that is expected to be done by the caller.
+   *
+   * @param data permit2 message with witness data to summarize
+   * @param owner address of the permit2 message signer
+   * @param signature signature of the permit2 message
+   */
+  const extractPermitDetails =                               (
+    data                                      ,
+    owner         ,
+    signature                                    ,
+                 ) => {
+    // @ts-expect-error generic/union type compatibility
+    const permitData                                    = data;
+
+    if (!isHex(signature)) {
+      throw new Error(`Invalid signature format: ${signature}`);
+    }
+
+    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 = getPermit2WitnessTypeString(permitData.types);
+
+    const { spender, ...permitStruct } = permit;
+
+    const permit2Payload       
+                                       
+                       
+      = {
+      permit: permitStruct,
+      owner,
+      witness,
+      witnessTypeString,
+      signature,
+    };
+
+    const details                = {
+      chainId: permitData.domain .chainId ,
+      token: permit.permitted.token,
+      amount: permit.permitted.amount,
+      permit2Payload,
+      spender,
+    };
+
+    return details;
+  };
+
+  /**
+   * Extract all details sufficient to handle any EIP-712 portfolio message,
+   * optionally with permit data.
+   *
+   * @param signedData
+   * @param validStandaloneContractAddresses *Deprecated*
+   */
+  const extractOperationDetailsFromSignedData = async (
+                                                      
+    
+    signedData                
+                                                                           
+     ,
+    validStandaloneContractAddresses                                   ,
+                                  ) => {
+    const tokenOwner = await recoverTypedDataAddress(
+      signedData                                     ,
+    );
+    const { nonce, deadline } = (
+      signedData              
+                                           
+                                     
+    ).message;
+
+    if (isPermit2MessageType(signedData.primaryType)) {
+      const permit2Data =
+        signedData                                                   ;
+
+      const permitDetails = extractPermitDetails(
+        permit2Data,
+        tokenOwner,
+        signedData.signature,
+      );
+      const operationDetails =
+        extractOperationDetailsFromPermit2WitnessData(permit2Data);
+
+      return {
+        ...operationDetails,
+        permitDetails,
+        evmWalletAddress: tokenOwner,
+        nonce,
+        deadline,
+      };
+    } else {
+      const standaloneData =
+        signedData                                             ;
+      const operationDetails = extractOperationDetailsFromStandaloneData(
+        standaloneData,
+        validStandaloneContractAddresses,
+      );
+
+      return {
+        ...operationDetails,
+        evmWalletAddress: tokenOwner,
+        nonce,
+        deadline,
+      };
+    }
+  };
+
+  return {
+    extractOperationDetailsFromStandaloneData,
+    extractOperationDetailsFromPermit2WitnessData,
+    extractPermitDetails,
+    extractOperationDetailsFromSignedData,
+  };
+};

package/src/instruments.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Mnemonic IDs for supported financial instruments in which a portfolio can use
+ * assets to take a position.
+ *
+ * These identifiers are to be treated as opaque strings, but must not start
+ * with punctuation that could result in them being misinterpreted as any other
+ * kind of {@link AssetPlaceRef} (e.g., a `<`-prefixed {@link SeatKeyword} or
+ * `@`-prefixed {@link InterChainAccountRef}), and in fact must start with an
+ * ASCII letter unless the implementation of {@link isInstrumentId} is relaxed.
+ * There are separate data structures to map them to functional interfaces for
+ * interoperation.
+ */
+export type InstrumentId = (typeof InstrumentId)[keyof typeof InstrumentId];
+export namespace InstrumentId {
+    let Aave_Arbitrum: "Aave_Arbitrum";
+    let Aave_Avalanche: "Aave_Avalanche";
+    let Aave_Base: "Aave_Base";
+    let Aave_Ethereum: "Aave_Ethereum";
+    let Aave_Optimism: "Aave_Optimism";
+    let Beefy_compoundUsdc_Arbitrum: "Beefy_compoundUsdc_Arbitrum";
+    let Beefy_compoundUsdc_Optimism: "Beefy_compoundUsdc_Optimism";
+    let Beefy_morphoGauntletUsdc_Ethereum: "Beefy_morphoGauntletUsdc_Ethereum";
+    let Beefy_morphoSeamlessUsdc_Base: "Beefy_morphoSeamlessUsdc_Base";
+    let Beefy_morphoSmokehouseUsdc_Ethereum: "Beefy_morphoSmokehouseUsdc_Ethereum";
+    let Beefy_re7_Avalanche: "Beefy_re7_Avalanche";
+    let Compound_Arbitrum: "Compound_Arbitrum";
+    let Compound_Base: "Compound_Base";
+    let Compound_Ethereum: "Compound_Ethereum";
+    let Compound_Optimism: "Compound_Optimism";
+    let ERC4626_vaultU2_Ethereum: "ERC4626_vaultU2_Ethereum";
+    let ERC4626_morphoClearstarHighYieldUsdc_Ethereum: "ERC4626_morphoClearstarHighYieldUsdc_Ethereum";
+    let ERC4626_morphoClearstarUsdcCore_Ethereum: "ERC4626_morphoClearstarUsdcCore_Ethereum";
+    let ERC4626_morphoGauntletUsdcRwa_Ethereum: "ERC4626_morphoGauntletUsdcRwa_Ethereum";
+    let ERC4626_morphoSteakhouseHighYieldInstant_Ethereum: "ERC4626_morphoSteakhouseHighYieldInstant_Ethereum";
+    let ERC4626_morphoClearstarInstitutionalUsdc_Ethereum: "ERC4626_morphoClearstarInstitutionalUsdc_Ethereum";
+    let ERC4626_morphoClearstarUsdcReactor_Ethereum: "ERC4626_morphoClearstarUsdcReactor_Ethereum";
+    let ERC4626_morphoAlphaUsdcCore_Ethereum: "ERC4626_morphoAlphaUsdcCore_Ethereum";
+    let ERC4626_morphoResolvUsdc_Ethereum: "ERC4626_morphoResolvUsdc_Ethereum";
+    let ERC4626_morphoGauntletUsdcFrontier_Ethereum: "ERC4626_morphoGauntletUsdcFrontier_Ethereum";
+    let ERC4626_morphoHyperithmUsdcMidcurve_Ethereum: "ERC4626_morphoHyperithmUsdcMidcurve_Ethereum";
+    let ERC4626_morphoHyperithmUsdcDegen_Ethereum: "ERC4626_morphoHyperithmUsdcDegen_Ethereum";
+    let ERC4626_morphoGauntletUsdcCore_Ethereum: "ERC4626_morphoGauntletUsdcCore_Ethereum";
+    let ERC4626_morphoSteakhousePrimeUsdc_Base: "ERC4626_morphoSteakhousePrimeUsdc_Base";
+    let ERC4626_morphoSteakhouseUsdc_Base: "ERC4626_morphoSteakhouseUsdc_Base";
+    let ERC4626_morphoGauntletUsdcPrime_Base: "ERC4626_morphoGauntletUsdcPrime_Base";
+    let ERC4626_morphoSeamlessUsdcVault_Base: "ERC4626_morphoSeamlessUsdcVault_Base";
+    let ERC4626_morphoSteakhouseHighYieldUsdc_Arbitrum: "ERC4626_morphoSteakhouseHighYieldUsdc_Arbitrum";
+    let ERC4626_morphoGauntletUsdcCore_Arbitrum: "ERC4626_morphoGauntletUsdcCore_Arbitrum";
+    let ERC4626_morphoHyperithmUsdc_Arbitrum: "ERC4626_morphoHyperithmUsdc_Arbitrum";
+    let ERC4626_morphoGauntletUsdcPrime_Optimism: "ERC4626_morphoGauntletUsdcPrime_Optimism";
+    let USDN: "USDN";
+    let USDNVault: "USDNVault";
+}
+//# sourceMappingURL=instruments.d.ts.map

package/src/instruments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["instruments.js"],"names":[],"mappings":";;;;;;;;;;;;2BAYU,CAAC,OAAO,YAAY,EAAE,MAAM,OAAO,YAAY,CAAC"}

package/src/instruments.js

@@ -0,0 +1,69 @@
+/**
+ * Mnemonic IDs for supported financial instruments in which a portfolio can use
+ * assets to take a position.
+ *
+ * These identifiers are to be treated as opaque strings, but must not start
+ * with punctuation that could result in them being misinterpreted as any other
+ * kind of {@link AssetPlaceRef} (e.g., a `<`-prefixed {@link SeatKeyword} or
+ * `@`-prefixed {@link InterChainAccountRef}), and in fact must start with an
+ * ASCII letter unless the implementation of {@link isInstrumentId} is relaxed.
+ * There are separate data structures to map them to functional interfaces for
+ * interoperation.
+ *
+ * @enum {(typeof InstrumentId)[keyof typeof InstrumentId]}
+ */
+export const InstrumentId = /** @type {const} */ ({
+  Aave_Arbitrum: 'Aave_Arbitrum',
+  Aave_Avalanche: 'Aave_Avalanche',
+  Aave_Base: 'Aave_Base',
+  Aave_Ethereum: 'Aave_Ethereum',
+  Aave_Optimism: 'Aave_Optimism',
+  Beefy_compoundUsdc_Arbitrum: 'Beefy_compoundUsdc_Arbitrum',
+  Beefy_compoundUsdc_Optimism: 'Beefy_compoundUsdc_Optimism',
+  Beefy_morphoGauntletUsdc_Ethereum: 'Beefy_morphoGauntletUsdc_Ethereum',
+  Beefy_morphoSeamlessUsdc_Base: 'Beefy_morphoSeamlessUsdc_Base',
+  Beefy_morphoSmokehouseUsdc_Ethereum: 'Beefy_morphoSmokehouseUsdc_Ethereum',
+  Beefy_re7_Avalanche: 'Beefy_re7_Avalanche',
+  Compound_Arbitrum: 'Compound_Arbitrum',
+  Compound_Base: 'Compound_Base',
+  Compound_Ethereum: 'Compound_Ethereum',
+  Compound_Optimism: 'Compound_Optimism',
+  ERC4626_vaultU2_Ethereum: 'ERC4626_vaultU2_Ethereum',
+  ERC4626_morphoClearstarHighYieldUsdc_Ethereum:
+    'ERC4626_morphoClearstarHighYieldUsdc_Ethereum',
+  ERC4626_morphoClearstarUsdcCore_Ethereum:
+    'ERC4626_morphoClearstarUsdcCore_Ethereum',
+  ERC4626_morphoGauntletUsdcRwa_Ethereum:
+    'ERC4626_morphoGauntletUsdcRwa_Ethereum',
+  ERC4626_morphoSteakhouseHighYieldInstant_Ethereum:
+    'ERC4626_morphoSteakhouseHighYieldInstant_Ethereum',
+  ERC4626_morphoClearstarInstitutionalUsdc_Ethereum:
+    'ERC4626_morphoClearstarInstitutionalUsdc_Ethereum',
+  ERC4626_morphoClearstarUsdcReactor_Ethereum:
+    'ERC4626_morphoClearstarUsdcReactor_Ethereum',
+  ERC4626_morphoAlphaUsdcCore_Ethereum: 'ERC4626_morphoAlphaUsdcCore_Ethereum',
+  ERC4626_morphoResolvUsdc_Ethereum: 'ERC4626_morphoResolvUsdc_Ethereum',
+  ERC4626_morphoGauntletUsdcFrontier_Ethereum:
+    'ERC4626_morphoGauntletUsdcFrontier_Ethereum',
+  ERC4626_morphoHyperithmUsdcMidcurve_Ethereum:
+    'ERC4626_morphoHyperithmUsdcMidcurve_Ethereum',
+  ERC4626_morphoHyperithmUsdcDegen_Ethereum:
+    'ERC4626_morphoHyperithmUsdcDegen_Ethereum',
+  ERC4626_morphoGauntletUsdcCore_Ethereum:
+    'ERC4626_morphoGauntletUsdcCore_Ethereum',
+  ERC4626_morphoSteakhousePrimeUsdc_Base:
+    'ERC4626_morphoSteakhousePrimeUsdc_Base',
+  ERC4626_morphoSteakhouseUsdc_Base: 'ERC4626_morphoSteakhouseUsdc_Base',
+  ERC4626_morphoGauntletUsdcPrime_Base: 'ERC4626_morphoGauntletUsdcPrime_Base',
+  ERC4626_morphoSeamlessUsdcVault_Base: 'ERC4626_morphoSeamlessUsdcVault_Base',
+  ERC4626_morphoSteakhouseHighYieldUsdc_Arbitrum:
+    'ERC4626_morphoSteakhouseHighYieldUsdc_Arbitrum',
+  ERC4626_morphoGauntletUsdcCore_Arbitrum:
+    'ERC4626_morphoGauntletUsdcCore_Arbitrum',
+  ERC4626_morphoHyperithmUsdc_Arbitrum: 'ERC4626_morphoHyperithmUsdc_Arbitrum',
+  ERC4626_morphoGauntletUsdcPrime_Optimism:
+    'ERC4626_morphoGauntletUsdcPrime_Optimism',
+  USDN: 'USDN',
+  USDNVault: 'USDNVault',
+});
+harden(InstrumentId);

package/src/main.d.ts

@@ -0,0 +1,6 @@
+export * from "./constants.js";
+export * from "./instruments.js";
+export * from "./resolver.js";
+export * from "./type-guards.js";
+export * from "./types-index.js";
+//# sourceMappingURL=main.d.ts.map

package/src/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["main.js"],"names":[],"mappings":""}

package/src/main.js

@@ -1,2 +1,7 @@
 export * from './constants.js';
-export * from './types.js';
+export * from './instruments.js';
+export * from './resolver.js';
+export * from './type-guards.js';
+
+// eslint-disable-next-line import/export -- just types
+export * from './types-index.js';

package/src/model/generated/ymax-machine.d.ts

@@ -0,0 +1,71 @@
+/**
+ * GENERATED FILE - DO NOT EDIT.
+ * Source: ../ymax-machine.yaml
+ * To regenerate: yarn run -T tsx scripts/gen-ymax-machine.mts
+ */
+/**
+ * @typedef {object} TransitionTarget
+ * @property {string} target
+ * @property {string} [description]
+ */
+/**
+ * @typedef {object} StateNode
+ * @property {string} description
+ * @property {string} [type]
+ * @property {string} [initial]
+ * @property {Record<string, StateNode>} [states]
+ * @property {Record<string, TransitionTarget | TransitionTarget[]>} [on]
+ * @property {TransitionTarget} [onDone]
+ * @property {TransitionTarget} [onError]
+ * @property {Record<string, TransitionTarget>} [after]
+ * @property {string[]} [entry]
+ * @property {string[]} [exit]
+ * @property {string[]} [tags]
+ * @property {{ wayMachines?: string[] } & Record<string, unknown>} [meta]
+ */
+/**
+ * @typedef {object} MachineDefinition
+ * @property {string} description
+ * @property {string} [category]
+ * @property {string} initial
+ * @property {Record<string, StateNode>} states
+ */
+/**
+ * @typedef {object} YmaxSpec
+ * @property {string} [version]
+ * @property {Record<string, MachineDefinition>} machines
+ */
+/** @type {YmaxSpec} */
+export const ymaxMachine: YmaxSpec;
+export default ymaxMachine;
+export type TransitionTarget = {
+    target: string;
+    description?: string | undefined;
+};
+export type StateNode = {
+    description: string;
+    type?: string | undefined;
+    initial?: string | undefined;
+    states?: Record<string, StateNode> | undefined;
+    on?: Record<string, TransitionTarget | TransitionTarget[]> | undefined;
+    onDone?: TransitionTarget | undefined;
+    onError?: TransitionTarget | undefined;
+    after?: Record<string, TransitionTarget> | undefined;
+    entry?: string[] | undefined;
+    exit?: string[] | undefined;
+    tags?: string[] | undefined;
+    meta?: ({
+        wayMachines?: string[];
+    } & Record<string, unknown>) | undefined;
+};
+export type MachineDefinition = {
+    description: string;
+    category?: string | undefined;
+    initial: string;
+    states: Record<string, StateNode>;
+};
+export type YmaxSpec = {
+    version?: string | undefined;
+    machines: Record<string, MachineDefinition>;
+};
+//# sourceMappingURL=ymax-machine.d.ts.map

package/src/model/generated/ymax-machine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ymax-machine.d.ts","sourceRoot":"","sources":["ymax-machine.js"],"names":[],"mappings":"AACA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;;;;GAMG;AAEH;;;;GAIG;AAEH,uBAAuB;AACvB,0BADW,QAAQ,CA8tCjB;;;YAhwCY,MAAM;;;;iBAMN,MAAM;;;;;;;;;;;;sBAWU,MAAM,EAAE;;;;iBAKxB,MAAM;;aAEN,MAAM;YACN,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;;;;cAMzB,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC"}