@agoric/portfolio-api 0.1.1-dev-9fca75b.0.9fca75b → 0.1.1-dev-192500d.0.192500d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/portfolio-api",
-  "version": "0.1.1-dev-9fca75b.0.9fca75b",
+  "version": "0.1.1-dev-192500d.0.192500d",
   "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-9fca75b.0.9fca75b",
+    "@agoric/orchestration": "0.1.1-dev-192500d.0.192500d",
     "@endo/common": "^1.2.13"
   },
   "devDependencies": {
-    "@agoric/internal": "0.3.3-dev-9fca75b.0.9fca75b",
+    "@agoric/internal": "0.3.3-dev-192500d.0.192500d",
     "@types/js-yaml": "^4",
     "ajv": "^6.12.6",
     "ava": "^5.3.0",
@@ -64,5 +64,5 @@
   "engines": {
     "node": "^20.9 || ^22.11"
   },
-  "gitHead": "9fca75b18acc53a00245b7377d787b93107f02b3"
+  "gitHead": "192500d7a565f6b43c468a28996d24375e4ff5c7"
 }

package/src/instruments.d.ts

@@ -2,8 +2,13 @@
  * Mnemonic IDs for supported financial instruments in which a portfolio can use
  * assets to take a position.
  *
- * Treat these identifers as opaque strings. There are separate data structures
- * to map them to functional interfaces for interoperation.
+ * 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 {

package/src/instruments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["instruments.js"],"names":[],"mappings":";;;;;;;2BAOU,CAAC,OAAO,YAAY,EAAE,MAAM,OAAO,YAAY,CAAC"}
+{"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

@@ -2,8 +2,13 @@
  * Mnemonic IDs for supported financial instruments in which a portfolio can use
  * assets to take a position.
  *
- * Treat these identifers as opaque strings. There are separate data structures
- * to map them to functional interfaces for interoperation.
+ * 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]}
  */

package/src/main.d.ts

@@ -1,5 +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.js

@@ -1,6 +1,7 @@
 export * from './constants.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/type-guards.d.ts

@@ -1,10 +1,18 @@
-import type { InterChainAccountRef, LocalChainAccountRef } from './types.js';
+import type { InstrumentId } from './instruments.js';
+import type { LocalChainAccountRef, InterChainAccountRef } from './types.js';
 /**
- * Does it match the pattern, without regard to supported chains.
+ * 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;
 /**
- * Does it match the pattern, without regard to supported chains.
+ * 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;
 //# sourceMappingURL=type-guards.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,sBAAsB,GACjC,KAAK,MAAM,KACV,GAAG,IAAI,oBAA2C,CAAC;AAGtD;;GAEG;AACH,eAAO,MAAM,sBAAsB,GACjC,KAAK,MAAM,KACV,GAAG,IAAI,oBAA2C,CAAC"}
+{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE7E;;;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"}

package/src/type-guards.ts

@@ -1,7 +1,9 @@
-import type { InterChainAccountRef, LocalChainAccountRef } from './types.js';
+import type { InstrumentId } from './instruments.js';
+import type { LocalChainAccountRef, InterChainAccountRef } from './types.js';
 
 /**
- * Does it match the pattern, without regard to supported chains.
+ * Without regard to supported chains, is the input plausibly a
+ * LocalChainAccountRef (i.e., does it start with `+`)?
  */
 export const isLocalChainAccountRef = (
   ref: string,
@@ -9,9 +11,18 @@ export const isLocalChainAccountRef = (
 harden(isLocalChainAccountRef);
 
 /**
- * Does it match the pattern, without regard to supported chains.
+ * Without regard to supported chains, is the input plausibly an
+ * InterChainAccountRef (i.e., does it start with `@`)?
  */
 export const isInterChainAccountRef = (
   ref: string,
 ): ref is InterChainAccountRef => 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: string): ref is InstrumentId =>
+  !!ref.match(/^[a-z]/i);
+harden(isInstrumentId);