refactor(orchestration,time,zoe): Avoid name convention conflict

Agoric · Dec 19, 2024 · 3d997f4 · 3d997f4
1 parent 7b7ceb9
commit 3d997f4
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 35 deletions.
diff --git a/packages/orchestration/src/examples/staking-combinations.flows.js b/packages/orchestration/src/examples/staking-combinations.flows.js
@@ -1,6 +1,6 @@
 /**
  * @import {GuestInterface} from '@agoric/async-flow';
- * @import {Orchestrator, OrchestrationFlow, AmountArg, CosmosValidatorAddress, ChainAddress, LocalAccountMethods, OrchestrationAccountI, ChainHub} from '../types.js'
+ * @import {Orchestrator, OrchestrationFlow, AmountArg, CosmosValidatorAddress, ChainAddress, LocalAccountMethods, OrchestrationAccountCommon, ChainHub} from '../types.js'
  * @import {ContinuingOfferResult, InvitationMakers} from '@agoric/smart-wallet/src/types.js';
  * @import {LocalOrchestrationAccountKit} from '../exos/local-orchestration-account.js';
  * @import {MakeCombineInvitationMakers} from '../exos/combine-invitation-makers.js';

diff --git a/packages/orchestration/src/exos/cosmos-orchestration-account.js b/packages/orchestration/src/exos/cosmos-orchestration-account.js
@@ -67,7 +67,7 @@ import { makeTimestampHelper } from '../utils/time.js';
 
 /**
  * @import {HostOf} from '@agoric/async-flow';
- * @import {AmountArg, IcaAccount, ChainAddress, CosmosValidatorAddress, ICQConnection, StakingAccountActions, StakingAccountQueries, OrchestrationAccountI, CosmosRewardsResponse, IBCConnectionInfo, IBCMsgTransferOptions, ChainHub, CosmosDelegationResponse} from '../types.js';
+ * @import {AmountArg, IcaAccount, ChainAddress, CosmosValidatorAddress, ICQConnection, StakingAccountActions, StakingAccountQueries, OrchestrationAccountCommon, CosmosRewardsResponse, IBCConnectionInfo, IBCMsgTransferOptions, ChainHub, CosmosDelegationResponse} from '../types.js';
  * @import {RecorderKit, MakeRecorderKit} from '@agoric/zoe/src/contractSupport/recorder.js';
  * @import {Coin} from '@agoric/cosmic-proto/cosmos/base/v1beta1/coin.js';
  * @import {Remote} from '@agoric/internal';
@@ -138,7 +138,7 @@ const stakingAccountQueriesMethods = {
   getRewards: M.call().returns(VowShape),
 };
 
-/** @see {OrchestrationAccountI} */
+/** @see {OrchestrationAccountCommon} */
 export const IcaAccountHolderI = M.interface('IcaAccountHolder', {
   ...orchestrationAccountMethods,
   ...stakingAccountActionsMethods,
@@ -702,7 +702,7 @@ export const prepareCosmosOrchestrationAccountKit = (
         },
       },
       holder: {
-        /** @type {HostOf<OrchestrationAccountI['asContinuingOffer']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['asContinuingOffer']>} */
         asContinuingOffer() {
           // @ts-expect-error XXX invitationMakers
           // getPublicTopics resolves promptly (same run), so we don't need a watcher
@@ -724,7 +724,7 @@ export const prepareCosmosOrchestrationAccountKit = (
             });
           });
         },
-        /** @type {HostOf<OrchestrationAccountI['getPublicTopics']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['getPublicTopics']>} */
         getPublicTopics() {
           // getStoragePath resolves promptly (same run), so we don't need a watcher
           // eslint-disable-next-line no-restricted-syntax
@@ -741,7 +741,7 @@ export const prepareCosmosOrchestrationAccountKit = (
           });
         },
 
-        /** @type {HostOf<OrchestrationAccountI['getAddress']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['getAddress']>} */
         getAddress() {
           return this.state.chainAddress;
         },
@@ -808,7 +808,7 @@ export const prepareCosmosOrchestrationAccountKit = (
             return watch(results, this.facets.withdrawRewardWatcher);
           });
         },
-        /** @type {HostOf<OrchestrationAccountI['getBalance']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['getBalance']>} */
         getBalance(denom) {
           return asVow(() => {
             const { chainAddress, icqConnection } = this.state;
@@ -827,7 +827,7 @@ export const prepareCosmosOrchestrationAccountKit = (
           });
         },
 
-        /** @type {HostOf<OrchestrationAccountI['getBalances']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['getBalances']>} */
         getBalances() {
           return asVow(() => {
             const { chainAddress, icqConnection } = this.state;
@@ -845,7 +845,7 @@ export const prepareCosmosOrchestrationAccountKit = (
           });
         },
 
-        /** @type {HostOf<OrchestrationAccountI['send']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['send']>} */
         send(toAccount, amount) {
           return asVow(() => {
             trace('send', toAccount, amount);
@@ -866,7 +866,7 @@ export const prepareCosmosOrchestrationAccountKit = (
           });
         },
 
-        /** @type {HostOf<OrchestrationAccountI['sendAll']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['sendAll']>} */
         sendAll(toAccount, amounts) {
           return asVow(() => {
             trace('sendAll', toAccount, amounts);
@@ -887,7 +887,7 @@ export const prepareCosmosOrchestrationAccountKit = (
           });
         },
 
-        /** @type {HostOf<OrchestrationAccountI['transfer']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['transfer']>} */
         transfer(destination, amount, opts) {
           trace('transfer', destination, amount, opts);
           return asVow(() => {
@@ -921,7 +921,7 @@ export const prepareCosmosOrchestrationAccountKit = (
           });
         },
 
-        /** @type {HostOf<OrchestrationAccountI['transferSteps']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['transferSteps']>} */
         transferSteps(amount, msg) {
           console.log('transferSteps got', amount, msg);
           return asVow(() => Fail`not yet implemented`);

diff --git a/packages/orchestration/src/exos/local-orchestration-account.js b/packages/orchestration/src/exos/local-orchestration-account.js
@@ -28,7 +28,7 @@ import { TransferRouteShape } from './chain-hub.js';
 /**
  * @import {HostOf} from '@agoric/async-flow';
  * @import {LocalChain, LocalChainAccount} from '@agoric/vats/src/localchain.js';
- * @import {AmountArg, ChainAddress, DenomAmount, IBCMsgTransferOptions, IBCConnectionInfo, OrchestrationAccountI, LocalAccountMethods, TransferRoute} from '@agoric/orchestration';
+ * @import {AmountArg, ChainAddress, DenomAmount, IBCMsgTransferOptions, IBCConnectionInfo, OrchestrationAccountCommon, LocalAccountMethods, TransferRoute} from '@agoric/orchestration';
  * @import {RecorderKit, MakeRecorderKit} from '@agoric/zoe/src/contractSupport/recorder.js'.
  * @import {Zone} from '@agoric/zone';
  * @import {Remote} from '@agoric/internal';
@@ -476,7 +476,7 @@ export const prepareLocalOrchestrationAccountKit = (
         },
       },
       holder: {
-        /** @type {HostOf<OrchestrationAccountI['asContinuingOffer']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['asContinuingOffer']>} */
         asContinuingOffer() {
           // @ts-expect-error XXX invitationMakers
           // getPublicTopics resolves promptly (same run), so we don't need a watcher
@@ -498,7 +498,7 @@ export const prepareLocalOrchestrationAccountKit = (
             });
           });
         },
-        /** @type {HostOf<OrchestrationAccountI['getBalance']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['getBalance']>} */
         getBalance(denomArg) {
           return asVow(() => {
             const [brand, denom] =
@@ -529,7 +529,7 @@ export const prepareLocalOrchestrationAccountKit = (
             );
           });
         },
-        /** @type {HostOf<OrchestrationAccountI['getBalances']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['getBalances']>} */
         getBalances() {
           return watch(
             E(localchain).query(
@@ -541,7 +541,7 @@ export const prepareLocalOrchestrationAccountKit = (
           );
         },
 
-        /** @type {HostOf<OrchestrationAccountI['getPublicTopics']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['getPublicTopics']>} */
         getPublicTopics() {
           // getStoragePath resolves promptly (same run), so we don't need a watcher
           // eslint-disable-next-line no-restricted-syntax
@@ -618,14 +618,14 @@ export const prepareLocalOrchestrationAccountKit = (
         executeTx(messages) {
           return watch(E(this.state.account).executeTx(messages));
         },
-        /** @type {OrchestrationAccountI['getAddress']} */
+        /** @type {OrchestrationAccountCommon['getAddress']} */
         getAddress() {
           return this.state.address;
         },
         /**
          * XXX consider using ERTP to send if it's vbank asset
          *
-         * @type {HostOf<OrchestrationAccountI['send']>}
+         * @type {HostOf<OrchestrationAccountCommon['send']>}
          */
         send(toAccount, amount) {
           return asVow(() => {
@@ -646,7 +646,7 @@ export const prepareLocalOrchestrationAccountKit = (
         /**
          * XXX consider using ERTP to send if it's vbank asset
          *
-         * @type {HostOf<OrchestrationAccountI['sendAll']>}
+         * @type {HostOf<OrchestrationAccountCommon['sendAll']>}
          */
         sendAll(toAccount, amounts) {
           return asVow(() => {
@@ -713,7 +713,7 @@ export const prepareLocalOrchestrationAccountKit = (
             return resultV;
           });
         },
-        /** @type {HostOf<OrchestrationAccountI['transferSteps']>} */
+        /** @type {HostOf<OrchestrationAccountCommon['transferSteps']>} */
         transferSteps(amount, msg) {
           return asVow(() => {
             console.log('transferSteps got', amount, msg);

diff --git a/packages/orchestration/src/exos/portfolio-holder-kit.js b/packages/orchestration/src/exos/portfolio-holder-kit.js
@@ -13,7 +13,7 @@ const { fromEntries } = Object;
  * @import {VowTools} from '@agoric/vow';
  * @import {ResolvedPublicTopic} from '@agoric/zoe/src/contractSupport/topics.js';
  * @import {Zone} from '@agoric/zone';
- * @import {OrchestrationAccount, OrchestrationAccountI, MakeCombineInvitationMakers} from '@agoric/orchestration';
+ * @import {OrchestrationAccount, OrchestrationAccountCommon, MakeCombineInvitationMakers} from '@agoric/orchestration';
  */
 
 /**

diff --git a/packages/orchestration/src/orchestration-api.ts b/packages/orchestration/src/orchestration-api.ts
@@ -69,7 +69,7 @@ export type ChainAddress = {
  *
  * The methods available depend on the chain and its capabilities.
  */
-export type OrchestrationAccount<CI extends ChainInfo> = OrchestrationAccountI &
+export type OrchestrationAccount<CI extends ChainInfo> = OrchestrationAccountCommon &
   (CI extends CosmosChainInfo
     ? CI['chainId'] extends `agoric${string}`
       ? LocalAccountMethods
@@ -160,7 +160,7 @@ export interface Orchestrator {
 /**
  * An object that supports high-level operations for an account on a remote chain.
  */
-export interface OrchestrationAccountI {
+export interface OrchestrationAccountCommon {
   /**
    * @returns the address of the account on the remote chain
    */

diff --git a/packages/orchestration/src/utils/orchestrationAccount.js b/packages/orchestration/src/utils/orchestrationAccount.js
@@ -10,11 +10,11 @@ import {
   IBCTransferOptionsShape,
 } from '../typeGuards.js';
 
-/** @import {OrchestrationAccountI} from '../orchestration-api.js'; */
+/** @import {OrchestrationAccountCommon} from '../orchestration-api.js'; */
 
 const { Vow$ } = NetworkShape; // TODO #9611
 
-/** @see {OrchestrationAccountI} */
+/** @see {OrchestrationAccountCommon} */
 export const orchestrationAccountMethods = {
   getAddress: M.call().returns(ChainAddressShape),
   getBalance: M.call(M.or(BrandShape, M.string())).returns(

diff --git a/packages/orchestration/test/fixtures/zoe-tools.flows.js b/packages/orchestration/test/fixtures/zoe-tools.flows.js
@@ -13,7 +13,7 @@ const { values } = Object;
  * @import {GuestInterface} from '@agoric/async-flow';
  * @import {AtomicProvider} from '@agoric/store/src/stores/store-utils.js';
  * @import {LocalOrchestrationAccountKit} from '../../src/exos/local-orchestration-account.js';
- * @import {Orchestrator, LocalAccountMethods, OrchestrationAccountI, OrchestrationFlow, ChainAddress} from '@agoric/orchestration';
+ * @import {Orchestrator, LocalAccountMethods, OrchestrationAccountCommon, OrchestrationFlow, ChainAddress} from '@agoric/orchestration';
  * @import {ZoeTools} from '../../src/utils/zoe-tools.js';
  */
 

diff --git a/packages/orchestration/tools/ibc-mocks.ts b/packages/orchestration/tools/ibc-mocks.ts
@@ -24,7 +24,7 @@ import { atob, btoa, decodeBase64, encodeBase64 } from '@endo/base64';
 import type { ChainAddress } from '../src/orchestration-api.js';
 import { makeQueryPacket, makeTxPacket } from '../src/utils/packet.js';
 
-interface EncoderI<T> {
+interface EncoderCommon<T> {
   encode: (message: T) => {
     finish: () => Uint8Array;
   };
@@ -45,7 +45,7 @@ const toPacket = (obj: Record<string, any>): string =>
  * @param message
  */
 export function buildMsgResponseString<T>(
-  Encoder: EncoderI<T>,
+  Encoder: EncoderCommon<T>,
   message: Partial<T>,
 ): string {
   const encodedMsg = Encoder.encode(Encoder.fromPartial(message)).finish();
@@ -90,7 +90,7 @@ export function buildMsgErrorString(
  * @param opts
  */
 export function buildQueryResponseString<T>(
-  Encoder: EncoderI<T>,
+  Encoder: EncoderCommon<T>,
   query: Partial<T>,
   opts: Omit<ResponseQuery, 'key'> = {
     value: new Uint8Array(),

diff --git a/packages/time/src/types.ts b/packages/time/src/types.ts
@@ -105,7 +105,7 @@ export type CancelToken = object;
  * schedule a single wake() call, create a repeater that will allow scheduling
  * of events at regular intervals, or remove scheduled calls.
  */
-export interface TimerServiceI {
+export interface TimerServiceCommon {
   /**
    * Retrieve the latest timestamp
    */
@@ -180,9 +180,9 @@ export interface TimerServiceI {
   getTimerBrand: () => TimerBrand;
 }
 // XXX copied from Remotable helper return type
-export type TimerService = TimerServiceI &
+export type TimerService = TimerServiceCommon &
   RemotableObject<'TimerService'> &
-  RemotableBrand<{}, TimerServiceI>;
+  RemotableBrand<{}, TimerServiceCommon>;
 
 /**
  * Read-only access to a TimeService's current time. This allows reading the

diff --git a/packages/zoe/tools/manualTimer.js b/packages/zoe/tools/manualTimer.js
@@ -5,7 +5,7 @@ import { buildManualTimer } from '@agoric/swingset-vat/tools/manual-timer.js';
 import { TimeMath } from '@agoric/time';
 
 /**
- * @import {TimerServiceI} from '@agoric/time';
+ * @import {TimerServiceCommon} from '@agoric/time';
  * @import {RemotableObject} from '@endo/pass-style';
  * @import {RemotableBrand} from '@endo/eventual-send';
  */
@@ -31,7 +31,7 @@ const nolog = (..._args) => {};
  * @property {(nTimes: number, msg?: string) => Promise<void>} tickN
  */
 
-/** @typedef {ReturnType<typeof buildManualTimer> & RemotableBrand<ManualTimerAdmin, TimerServiceI & ManualTimerAdmin> & ManualTimerAdmin} ZoeManualTimer */
+/** @typedef {ReturnType<typeof buildManualTimer> & RemotableBrand<ManualTimerAdmin, TimerServiceCommon & ManualTimerAdmin> & ManualTimerAdmin} ZoeManualTimer */
 
 /**
  * A fake TimerService, for unit tests that do not use a real