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

package/src/portfolio-constants.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @file Constants and configuration for portfolio contract deployment
+ *
+ * This module exports domain knowledge about portfolio contract deployment,
+ * including wallet store keys, control addresses, and contract names.
+ */
+/**
+ * Wallet store key where the contract control facet is delivered
+ * @type {string}
+ */
+export const YMAX_CONTROL_WALLET_KEY: string;
+/**
+ * Known portfolio contract names in agoricNames.instance
+ * @type {readonly ['ymax0', 'ymax1']}
+ */
+export const PORTFOLIO_CONTRACT_NAMES: readonly ["ymax0", "ymax1"];
+/**
+ * Control account addresses per contract and network
+ * Source: https://www.mintscan.io/agoric/proposals/111 (for ymax0/main)
+ *
+ * @type {{
+ *   ymax0: {
+ *     main: string;
+ *     devnet: string;
+ *   };
+ *   ymax1: {
+ *     main: string;
+ *     devnet: string;
+ *   };
+ * }}
+ */
+export const CONTROL_ADDRESSES: {
+    ymax0: {
+        main: string;
+        devnet: string;
+    };
+    ymax1: {
+        main: string;
+        devnet: string;
+    };
+};
+export function getControlAddress(contractName: (typeof PORTFOLIO_CONTRACT_NAMES)[number], network: "main" | "devnet"): string;
+export function isPortfolioContract(name: string): name is "ymax0" | "ymax1";
+//# sourceMappingURL=portfolio-constants.d.ts.map

package/src/portfolio-constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"portfolio-constants.d.ts","sourceRoot":"","sources":["portfolio-constants.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;GAGG;AACH,sCAFU,MAAM,CAEqC;AAErD;;;GAGG;AACH,uCAFU,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAKlC;AAEH;;;;;;;;;;;;;;GAcG;AACH,gCAXU;IACL,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAWF;AAUK,gDALI,CAAA,OAAO,wBAAwB,EAAC,MAAM,CAAC,WACvC,MAAM,GAAG,QAAQ,GACf,MAAM,CAclB;AAQM,0CAHI,MAAM,6BAOhB"}

package/src/portfolio-constants.js

@@ -0,0 +1,80 @@
+/**
+ * @file Constants and configuration for portfolio contract deployment
+ *
+ * This module exports domain knowledge about portfolio contract deployment,
+ * including wallet store keys, control addresses, and contract names.
+ */
+
+/**
+ * Wallet store key where the contract control facet is delivered
+ * @type {string}
+ */
+export const YMAX_CONTROL_WALLET_KEY = 'ymaxControl';
+
+/**
+ * Known portfolio contract names in agoricNames.instance
+ * @type {readonly ['ymax0', 'ymax1']}
+ */
+export const PORTFOLIO_CONTRACT_NAMES = /** @type {const} */ ([
+  'ymax0',
+  'ymax1',
+]);
+
+/**
+ * Control account addresses per contract and network
+ * Source: https://www.mintscan.io/agoric/proposals/111 (for ymax0/main)
+ *
+ * @type {{
+ *   ymax0: {
+ *     main: string;
+ *     devnet: string;
+ *   };
+ *   ymax1: {
+ *     main: string;
+ *     devnet: string;
+ *   };
+ * }}
+ */
+export const CONTROL_ADDRESSES = {
+  ymax0: {
+    main: 'agoric1e80twfutmrm3wrk3fysjcnef4j82mq8dn6nmcq',
+    devnet: 'agoric10utru593dspjwfewcgdak8lvp9tkz0xttvcnxv',
+  },
+  ymax1: {
+    main: 'agoric18dx5f8ck5xy2dgkgeyp2w478dztxv3z2mnz928',
+    devnet: 'agoric1awsr6hpn4t44jfrrnf5xr70mz4zrg5glvft6sl',
+  },
+};
+
+/**
+ * Get the control address for a contract on a specific network
+ *
+ * @param {typeof PORTFOLIO_CONTRACT_NAMES[number]} contractName
+ * @param {'main' | 'devnet'} network
+ * @returns {string} The control account address
+ * @throws {Error} If contract or network is invalid
+ */
+export const getControlAddress = (contractName, network) => {
+  if (!PORTFOLIO_CONTRACT_NAMES.includes(contractName)) {
+    throw new Error(
+      `Invalid contract name: ${contractName}. Must be one of: ${PORTFOLIO_CONTRACT_NAMES.join(', ')}`,
+    );
+  }
+  if (network !== 'main' && network !== 'devnet') {
+    throw new Error(`Invalid network: ${network}. Must be 'main' or 'devnet'`);
+  }
+
+  return CONTROL_ADDRESSES[contractName][network];
+};
+
+/**
+ * Validate that a contract name is a known portfolio contract
+ *
+ * @param {string} name
+ * @returns {name is typeof PORTFOLIO_CONTRACT_NAMES[number]}
+ */
+export const isPortfolioContract = name => {
+  return PORTFOLIO_CONTRACT_NAMES.includes(
+    /** @type {typeof PORTFOLIO_CONTRACT_NAMES[number]} */ (name),
+  );
+};

package/src/resolver.d.ts

@@ -0,0 +1,159 @@
+/**
+ * Statuses for published transactions. Exhaustive state machine transitions:
+ *   - setup -> pending (when transaction information is assembled and sent)
+ *   - pending -> success (when cross-chain operation completes successfully)
+ *   - pending -> failed (when operation fails or times out)
+ */
+export type TxStatus = (typeof TxStatus)[keyof typeof TxStatus];
+export namespace TxStatus {
+    let SETUP: "setup";
+    let PENDING: "pending";
+    let SUCCESS: "success";
+    let FAILED: "failed";
+}
+/**
+ * Tx types for published transactions
+ */
+export type TxType = Readonly<(typeof TxType)[keyof typeof TxType]>;
+/**
+ * Tx types for published transactions
+ *
+ * @enum {Readonly<(typeof TxType)[keyof typeof TxType]>}
+ */
+export const TxType: import("@agoric/internal").KeyMirrorResult<{
+    CCTP_TO_EVM: null;
+    GMP: null;
+    ROUTED_GMP: null;
+    CCTP_TO_AGORIC: null;
+    IBC_FROM_AGORIC: null;
+    IBC_FROM_REMOTE: null;
+    MAKE_ACCOUNT: null;
+    /**
+     * Placeholder for ProgressTracker protocols not yet recognized by the
+     * resolver client, just so they can be published to vstorage, but not
+     * processed any further.  If these appear, it means the resolver client
+     * source code needs to be updated.
+     */
+    UNKNOWN: null;
+}>;
+/**
+ * Adapt orchestration TrafficEntry to the portfolio's PublishedTx type.
+ * - Rename 'dst' to 'dest' for consistency with portfolio-contract.
+ * - Add optional 'amount' property.
+ */
+export type PublishedTrafficTxDetails = Partial<Omit<TrafficEntry, "dst">> & {
+    type: TxType & ("IBC_FROM_AGORIC" | "IBC_FROM_REMOTE");
+    dest?: TrafficEntry["dst"];
+    amount?: bigint;
+};
+/**
+ * Represents a transaction published in vstorage at
+ * `published.${contractInstance}.pendingTxs.tx${number}`
+ * with its type, optional amount, destination, and status.
+ */
+export type PublishedPortfolioTxDetails = {
+    /**
+     * - The type of
+     * transaction (CCTP_TO_EVM, GMP, CCTP_TO_AGORIC, or MAKE_ACCOUNT)
+     */
+    type: Exclude<TxType, PublishedTrafficTxDetails["type"] | "ROUTED_GMP">;
+    /**
+     * - Optional transaction amount as a bigint, currently in micro-USDC (6 decimal fixed-point)
+     */
+    amount?: bigint | undefined;
+    /**
+     * - The destination account
+     * identifier for the transaction
+     */
+    destinationAddress?: `${string}:${string}:${string}` | undefined;
+    /**
+     * - The source LCA address initiating the
+     * transaction (required for GMP and MAKE_ACCOUNT transactions)
+     */
+    sourceAddress?: `${string}:${string}:${string}` | undefined;
+    /**
+     * - The expected address of the EVM smart
+     * wallet to be created (only for type "MAKE_ACCOUNT")
+     */
+    expectedAddr?: `0x${string}` | undefined;
+    /**
+     * - The address of the EVM smart wallet
+     * factory contract responsible for creating the smart wallet (only for type
+     * "MAKE_ACCOUNT")
+     */
+    factoryAddr?: `0x${string}` | undefined;
+};
+/**
+ * Core debugging details that every pending ROUTED_GMP transaction publish
+ */
+export type RoutedGMPTxBaseDetails = {
+    /**
+     * - The 4-byte function selector of the process instruction function
+     */
+    instructionSelector: `0x${string}`;
+    /**
+     * - The routed instruction type
+     */
+    instructionType: SupportedInstructions;
+    /**
+     * - The EVM address corresponding to the source LCA address
+     */
+    expectedRemoteTargetAddress: HexAddress;
+};
+/**
+ * Specialized case of a transaction published in vstorage at
+ * `published.${contractInstance}.pendingTxs.tx${number}`
+ * for the ROUTED_GMP type.
+ */
+export type PublishedRoutedGMPTxDetails = {
+    /**
+     * - The type of transaction, always "ROUTED_GMP"
+     */
+    type: TxType & ("ROUTED_GMP");
+    /**
+     * - The router account handling this transaction
+     */
+    destinationAddress: AccountId;
+    /**
+     * - The source LCA address initiating the
+     * transaction (either portfolio or contract)
+     */
+    sourceAddress: AccountId;
+    /**
+     * - Flag indicating that the initial transaction registration is incomplete and awaiting payloadHash and details update
+     */
+    incomplete?: true | undefined;
+    /**
+     * - The hash of the GMP Payload
+     */
+    payloadHash?: `0x${string}` | undefined;
+    /**
+     * - Debugging details
+     */
+    details?: (RoutedGMPTxBaseDetails & Record<string, PureData>) | undefined;
+};
+export type PublishedTxBase = {
+    /**
+     * - The type of transaction (CCTP_TO_EVM, GMP, CCTP_TO_AGORIC, or MAKE_ACCOUNT)
+     */
+    type: TxType;
+    /**
+     * - Current status of the transaction (pending, success, or failed)
+     */
+    status: TxStatus;
+    /**
+     * - Optional reason for failure (only present when status is 'failed')
+     */
+    rejectionReason?: string | undefined;
+    /**
+     * - DEPRECATED in favor of {@link import ('./types.js').FlowStep['phases']}. Optional ID of the next transaction in a sequence
+     */
+    nextTxId?: `tx${number}` | undefined;
+};
+export type PublishedTx = PublishedTxBase & (PublishedTrafficTxDetails | PublishedPortfolioTxDetails | PublishedRoutedGMPTxDetails);
+import type { TrafficEntry } from '@agoric/orchestration';
+import type { SupportedInstructions } from '@aglocal/portfolio-contract/src/interfaces/orch-router.js';
+import type { HexAddress } from '@agoric/orchestration';
+import type { AccountId } from '@agoric/orchestration';
+import type { PureData } from '@endo/pass-style';
+//# sourceMappingURL=resolver.d.ts.map

package/src/resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.d.ts","sourceRoot":"","sources":["resolver.js"],"names":[],"mappings":";;;;;;uBAeU,CAAC,OAAO,QAAQ,EAAE,MAAM,OAAO,QAAQ,CAAC;;;;;;;;;;qBAaxC,QAAQ,CAAC,CAAC,OAAO,MAAM,EAAE,MAAM,OAAO,MAAM,CAAC,CAAC;AAHxD;;;;GAIG;AACH;;;;;;;;IAQE;;;;;OAKG;;GAEF;;;;;;wCAIU,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,GAAG;IAC7C,IAAI,EAAE,MAAM,GAAG,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;;;;;;;;;;;UAYU,OAAO,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAkBjE,KAAK,MAAM,EAAE;;;;qBACb,qBAAqB;;;;iCACrB,UAAU;;;;;;;;;;;UASV,MAAM,GAAG,CAAC,YAAY,CAAC;;;;wBACvB,SAAS;;;;;mBACT,SAAS;;;;;;;;;;;;;;;;;;UAUT,MAAM;;;;YACN,QAAQ;;;;;;;;;;0BAMT,eAAe,GAAG,CAAC,yBAAyB,GAAG,2BAA2B,GAAG,2BAA2B,CAAC;kCA7GhE,uBAAuB;2CAErC,2DAA2D;gCAF7C,uBAAuB;+BAAvB,uBAAuB;8BADlD,kBAAkB"}

package/src/resolver.js

@@ -0,0 +1,115 @@
+import { keyMirror } from '@agoric/internal';
+
+/**
+ * @import {PureData} from '@endo/pass-style';
+ * @import {AccountId, HexAddress, TrafficEntry} from '@agoric/orchestration';
+ * @import {TxId} from './types.js';
+ * @import {SupportedInstructions} from '@aglocal/portfolio-contract/src/interfaces/orch-router.js';
+ */
+
+/**
+ * Statuses for published transactions. Exhaustive state machine transitions:
+ *   - setup -> pending (when transaction information is assembled and sent)
+ *   - pending -> success (when cross-chain operation completes successfully)
+ *   - pending -> failed (when operation fails or times out)
+ *
+ * @enum {(typeof TxStatus)[keyof typeof TxStatus]}
+ */
+export const TxStatus = /** @type {const} */ ({
+  SETUP: 'setup',
+  PENDING: 'pending',
+  SUCCESS: 'success',
+  FAILED: 'failed',
+});
+harden(TxStatus);
+
+/**
+ * Tx types for published transactions
+ *
+ * @enum {Readonly<(typeof TxType)[keyof typeof TxType]>}
+ */
+export const TxType = keyMirror({
+  CCTP_TO_EVM: null,
+  GMP: null,
+  ROUTED_GMP: null,
+  CCTP_TO_AGORIC: null,
+  IBC_FROM_AGORIC: null,
+  IBC_FROM_REMOTE: null,
+  MAKE_ACCOUNT: null,
+  /**
+   * Placeholder for ProgressTracker protocols not yet recognized by the
+   * resolver client, just so they can be published to vstorage, but not
+   * processed any further.  If these appear, it means the resolver client
+   * source code needs to be updated.
+   */
+  UNKNOWN: null,
+});
+harden(TxType);
+
+/**
+ * @typedef {Partial<Omit<TrafficEntry, 'dst'>> & {
+ *   type: TxType & ('IBC_FROM_AGORIC' | 'IBC_FROM_REMOTE');
+ *   dest?: TrafficEntry['dst']
+ *   amount?: bigint;
+ * }} PublishedTrafficTxDetails
+ * Adapt orchestration TrafficEntry to the portfolio's PublishedTx type.
+ * - Rename 'dst' to 'dest' for consistency with portfolio-contract.
+ * - Add optional 'amount' property.
+ */
+
+/**
+ * Represents a transaction published in vstorage at
+ * `published.${contractInstance}.pendingTxs.tx${number}`
+ * with its type, optional amount, destination, and status.
+ *
+ * @typedef {object} PublishedPortfolioTxDetails
+ * @property {Exclude<TxType, PublishedTrafficTxDetails['type'] | 'ROUTED_GMP'>} type - The type of
+ * transaction (CCTP_TO_EVM, GMP, CCTP_TO_AGORIC, or MAKE_ACCOUNT)
+ * @property {bigint} [amount] - Optional transaction amount as a bigint, currently in micro-USDC (6 decimal fixed-point)
+ * @property {AccountId} [destinationAddress] - The destination account
+ * identifier for the transaction
+ * @property {AccountId} [sourceAddress] - The source LCA address initiating the
+ * transaction (required for GMP and MAKE_ACCOUNT transactions)
+ * @property {HexAddress} [expectedAddr] - The expected address of the EVM smart
+ * wallet to be created (only for type "MAKE_ACCOUNT")
+ * @property {HexAddress} [factoryAddr] - The address of the EVM smart wallet
+ * factory contract responsible for creating the smart wallet (only for type
+ * "MAKE_ACCOUNT")
+ */
+
+/**
+ * Core debugging details that every pending ROUTED_GMP transaction publish
+ *
+ * @typedef {object} RoutedGMPTxBaseDetails
+ * @property {`0x${string}`} instructionSelector - The 4-byte function selector of the process instruction function
+ * @property {SupportedInstructions} instructionType - The routed instruction type
+ * @property {HexAddress} expectedRemoteTargetAddress - The EVM address corresponding to the source LCA address
+ */
+
+/**
+ * Specialized case of a transaction published in vstorage at
+ * `published.${contractInstance}.pendingTxs.tx${number}`
+ * for the ROUTED_GMP type.
+ *
+ * @typedef {object} PublishedRoutedGMPTxDetails
+ * @property {TxType & ('ROUTED_GMP')} type - The type of transaction, always "ROUTED_GMP"
+ * @property {AccountId} destinationAddress - The router account handling this transaction
+ * @property {AccountId} sourceAddress - The source LCA address initiating the
+ * transaction (either portfolio or contract)
+ * @property {true} [incomplete] - Flag indicating that the initial transaction registration is incomplete and awaiting payloadHash and details update
+ * @property {`0x${string}`} [payloadHash] - The hash of the GMP Payload
+ * @property {RoutedGMPTxBaseDetails & Record<string, PureData>} [details] - Debugging details
+ */
+
+// eslint-disable-next-line @agoric/group-jsdoc-imports
+/**
+ * @typedef {object} PublishedTxBase
+ * @property {TxType} type - The type of transaction (CCTP_TO_EVM, GMP, CCTP_TO_AGORIC, or MAKE_ACCOUNT)
+ * @property {TxStatus} status - Current status of the transaction (pending, success, or failed)
+ * @property {string} [rejectionReason] - Optional reason for failure (only present when status is 'failed')
+ * @property {TxId} [nextTxId] - DEPRECATED in favor of {@link import('./types.js').FlowStep['phases']}. Optional ID of the next transaction in a sequence
+ */
+
+/**
+ * @typedef {PublishedTxBase & (PublishedTrafficTxDetails | PublishedPortfolioTxDetails | PublishedRoutedGMPTxDetails)} PublishedTx
+ */

package/src/type-guards.d.ts

@@ -0,0 +1,39 @@
+import type { BeefyInstrumentId, ERC4626InstrumentId } from '@aglocal/portfolio-contract/src/type-guards.js';
+import type { InstrumentId } from './instruments.js';
+import type { DepositFromChainRef, LocalChainAccountRef, InterChainAccountRef, WithdrawToChainRef } from './types.js';
+/**
+ * Without regard to supported chains, is the input plausibly a
+ * DepositFromChainRef (i.e., does it start with `+`)?
+ */
+export declare const isDepositFromChainRef: (ref: string) => ref is DepositFromChainRef;
+/**
+ * Without regard to supported chains, is the input plausibly a
+ * LocalChainAccountRef (i.e., does it start with `+`)?
+ */
+export declare const isLocalChainAccountRef: (ref: string) => ref is LocalChainAccountRef;
+/**
+ * Without regard to supported chains, is the input plausibly an
+ * InterChainAccountRef (i.e., does it start with `@`)?
+ */
+export declare const isInterChainAccountRef: (ref: string) => ref is InterChainAccountRef;
+/**
+ * Without regard to supported chains, is the input plausibly an InstrumentId
+ * (i.e., does it start with an ASCII letter)?
+ */
+export declare const isInstrumentId: (ref: string) => ref is InstrumentId;
+/**
+ * Without regard to supported chains, is the input plausibly a
+ * WithdrawToChainRef (i.e., does it start with `-`)?
+ */
+export declare const isWithdrawToChainRef: (ref: string) => ref is WithdrawToChainRef;
+/**
+ * Is the input an ERC-4626 InstrumentId
+ * (i.e., does it start with 'ERC4626_')?
+ */
+export declare const isERC4626InstrumentId: (ref: string) => ref is ERC4626InstrumentId;
+/**
+ * Is the input an Beefy InstrumentId
+ * (i.e., does it start with 'Beefy_')?
+ */
+export declare const isBeefyInstrumentId: (ref: string) => ref is BeefyInstrumentId;
+//# sourceMappingURL=type-guards.d.ts.map

package/src/type-guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,gDAAgD,CAAC;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAChC,KAAK,MAAM,KACV,GAAG,IAAI,mBAA0C,CAAC;AAGrD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GACjC,KAAK,MAAM,KACV,GAAG,IAAI,oBAA2C,CAAC;AAGtD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GACjC,KAAK,MAAM,KACV,GAAG,IAAI,oBAA2C,CAAC;AAGtD;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,KAAG,GAAG,IAAI,YAC5B,CAAC;AAGzB;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAAI,KAAK,MAAM,KAAG,GAAG,IAAI,kBACrC,CAAC;AAGtB;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAChC,KAAK,MAAM,KACV,GAAG,IAAI,mBAAiD,CAAC;AAG5D;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,KAAK,MAAM,KAAG,GAAG,IAAI,iBAC/B,CAAC"}

package/src/type-guards.js

@@ -0,0 +1,71 @@
+             
+                    
+                      
+                                                        
+                                                     
+             
+                      
+                       
+                       
+                     
+                    
+
+/**
+ * Without regard to supported chains, is the input plausibly a
+ * DepositFromChainRef (i.e., does it start with `+`)?
+ */
+export const isDepositFromChainRef = (
+  ref        ,
+                            ) => ref.startsWith('+');
+harden(isDepositFromChainRef);
+
+/**
+ * Without regard to supported chains, is the input plausibly a
+ * LocalChainAccountRef (i.e., does it start with `+`)?
+ */
+export const isLocalChainAccountRef = (
+  ref        ,
+                             ) => ref.startsWith('+');
+harden(isLocalChainAccountRef);
+
+/**
+ * Without regard to supported chains, is the input plausibly an
+ * InterChainAccountRef (i.e., does it start with `@`)?
+ */
+export const isInterChainAccountRef = (
+  ref        ,
+                             ) => ref.startsWith('@');
+harden(isInterChainAccountRef);
+
+/**
+ * Without regard to supported chains, is the input plausibly an InstrumentId
+ * (i.e., does it start with an ASCII letter)?
+ */
+export const isInstrumentId = (ref        )                      =>
+  !!ref.match(/^[a-z]/i);
+harden(isInstrumentId);
+
+/**
+ * Without regard to supported chains, is the input plausibly a
+ * WithdrawToChainRef (i.e., does it start with `-`)?
+ */
+export const isWithdrawToChainRef = (ref        )                            =>
+  ref.startsWith('-');
+harden(isWithdrawToChainRef);
+
+/**
+ * Is the input an ERC-4626 InstrumentId
+ * (i.e., does it start with 'ERC4626_')?
+ */
+export const isERC4626InstrumentId = (
+  ref        ,
+                            ) => ref.startsWith('ERC4626_');
+harden(isERC4626InstrumentId);
+
+/**
+ * Is the input an Beefy InstrumentId
+ * (i.e., does it start with 'Beefy_')?
+ */
+export const isBeefyInstrumentId = (ref        )                           =>
+  ref.startsWith('Beefy_');
+harden(isBeefyInstrumentId);