chore: export CombinedInvitationMakers, MakeCombineInvitationMakers t…

…ypes
Agoric · Oct 4, 2024 · 5863286 · 5863286
1 parent 8e0742e
commit 5863286
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/packages/orchestration/src/exos/combine-invitation-makers.js b/packages/orchestration/src/exos/combine-invitation-makers.js
@@ -13,6 +13,11 @@ import { getMethodNames } from '@agoric/internal';
 // TODO use a helper from Endo https://github.com/endojs/endo/issues/2448
 /**
  * Takes two or more InvitationMaker exos and combines them into a new one.
+ * Combine with `publicTopics` to form a {@link ContinuingOfferResult} that can
+ * be returned to a smart-wallet client.
+ *
+ * Useful for writing your own invitationMakers while preserving
+ * platform-provided ones like `Delegate`, `Transfer`, `Send`.
  *
  * @param {Zone} zone
  * @param {import('@endo/patterns').InterfaceGuard[]} interfaceGuards
@@ -51,3 +56,4 @@ export const prepareCombineInvitationMakers = (zone, ...interfaceGuards) => {
 };
 
 /** @typedef {ReturnType<typeof prepareCombineInvitationMakers>} MakeCombineInvitationMakers */
+/** @typedef {ReturnType<MakeCombineInvitationMakers>} CombinedInvitationMakers */
diff --git a/packages/orchestration/src/types.ts b/packages/orchestration/src/types.ts
@@ -4,6 +4,7 @@ export type * from './chain-info.js';
 export type * from './cosmos-api.js';
 export type * from './ethereum-api.js';
 export type * from './exos/chain-hub.js';
+export type * from './exos/combine-invitation-makers.js';
 export type * from './exos/cosmos-interchain-service.js';
 export type * from './exos/exo-interfaces.js';
 export type * from './exos/ica-account-kit.js';