feat!: makeOsmosisSwap() using getDenomOn

packages/orchestration/src/cosmos-api.ts

@@ -62,19 +62,22 @@ export type CosmosAssetInfo = {
   name: string;
   display: string;
   symbol: string;
-  denom_units: Array<{ denom: Denom; exponent: number }>;
-  traces?: Array<{
-    type: 'ibc';
-    counterparty: {
-      chain_name: string;
-      base_denom: Denom;
-      channel_id: IBCChannelID;
-    };
-    chain: {
-      channel_id: IBCChannelID;
-      path: string;
-    };
-  }>;
+  denom_units: Array<{ denom: Denom; exponent: number; aliases?: string[] }>;
+  traces?: Array<
+    | {
+        type: 'ibc';
+        counterparty: {
+          chain_name: string;
+          base_denom: Denom;
+          channel_id: IBCChannelID;
+        };
+        chain: {
+          channel_id: IBCChannelID;
+          path: string;
+        };
+      }
+    | ({ type: 'additional-mintage' } & Record<string, unknown>)
+  >;
 } & Record<string, unknown>;
 
 /**

packages/orchestration/src/examples/sendAnywhere.contract.js

@@ -1,8 +1,6 @@
 import { makeStateRecord } from '@agoric/async-flow';
 import { AmountShape } from '@agoric/ertp';
 import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
-import { Fail } from '@endo/errors';
-import { E } from '@endo/far';
 import { M } from '@endo/patterns';
 import { withOrchestration } from '../utils/start-helper.js';
 import * as flows from './sendAnywhere.flows.js';
@@ -50,7 +48,7 @@ const contract = async (
   zcf,
   privateArgs,
   zone,
-  { chainHub, orchestrateAll, vowTools, zoeTools },
+  { chainHub, orchestrateAll, zoeTools },
 ) => {
   const contractState = makeStateRecord(
     /** @type {{ account: OrchestrationAccount<any> | undefined }} */ {
@@ -60,27 +58,11 @@ const contract = async (
 
   const creatorFacet = prepareChainHubAdmin(zone, chainHub);
 
-  // TODO should be a provided helper
-  /** @type {(brand: Brand) => Vow<VBankAssetDetail>} */
-  const findBrandInVBank = vowTools.retriable(
-    zone,
-    'findBrandInVBank',
-    /** @param {Brand} brand */
-    async brand => {
-      const { agoricNames } = privateArgs;
-      const assets = await E(E(agoricNames).lookup('vbankAsset')).values();
-      const it = assets.find(a => a.brand === brand);
-      it || Fail`brand ${brand} not in agoricNames.vbankAsset`;
-      return it;
-    },
-  );
-
   // orchestrate uses the names on orchestrationFns to do a "prepare" of the associated behavior
   const orchFns = orchestrateAll(flows, {
     zcf,
     contractState,
     localTransfer: zoeTools.localTransfer,
-    findBrandInVBank,
   });
 
   const publicFacet = zone.exo(

packages/orchestration/src/examples/sendAnywhere.flows.js

@@ -1,8 +1,8 @@
+import { NonNullish } from '@agoric/internal';
 import { M, mustMatch } from '@endo/patterns';
 
 /**
  * @import {GuestOf} from '@agoric/async-flow';
- * @import {VBankAssetDetail} from '@agoric/vats/tools/board-utils.js';
  * @import {ZoeTools} from '../utils/zoe-tools.js';
  * @import {Orchestrator, LocalAccountMethods, OrchestrationAccountI, OrchestrationFlow} from '../types.js';
  */
@@ -18,13 +18,12 @@ const { entries } = Object;
  * @param {object} ctx
  * @param {{ localAccount?: OrchestrationAccountI & LocalAccountMethods }} ctx.contractState
  * @param {GuestOf<ZoeTools['localTransfer']>} ctx.localTransfer
- * @param {(brand: Brand) => Promise<VBankAssetDetail>} ctx.findBrandInVBank
  * @param {ZCFSeat} seat
  * @param {{ chainName: string; destAddr: string }} offerArgs
  */
 export async function sendIt(
   orch,
-  { contractState, localTransfer, findBrandInVBank },
+  { contractState, localTransfer },
   seat,
   offerArgs,
 ) {
@@ -33,7 +32,12 @@ export async function sendIt(
   // NOTE the proposal shape ensures that the `give` is a single asset
   const { give } = seat.getProposal();
   const [[_kw, amt]] = entries(give);
-  const { denom } = await findBrandInVBank(amt.brand);
+  const agoric = await orch.getChain('agoric');
+  const assets = await agoric.getVBankAssetInfo();
+  const { denom } = NonNullish(
+    assets.find(a => a.brand === amt.brand),
+    `${amt.brand} not registered in vbank`,
+  );
   const chain = await orch.getChain(chainName);
 
   if (!contractState.localAccount) {

packages/orchestration/src/examples/swapExample.contract.js

@@ -1,65 +1,17 @@
 import { StorageNodeShape } from '@agoric/internal';
 import { TimerServiceShape } from '@agoric/time';
 import { M } from '@endo/patterns';
-import { orcUtils } from '../utils/orc.js';
+import { assertIssuerKeywords } from '@agoric/zoe/src/contractSupport/zoeHelpers.js';
+import { E } from '@endo/far';
 import { withOrchestration } from '../utils/start-helper.js';
+import * as flows from './swapExample.flows.js';
+import fetchedChainInfo from '../fetched-chain-info.js';
 
 /**
- * @import {LocalTransfer} from '../utils/zoe-tools.js';
- * @import {Orchestrator, CosmosValidatorAddress, OrchestrationFlow} from '../types.js'
- * @import {TimerService} from '@agoric/time';
- * @import {LocalChain} from '@agoric/vats/src/localchain.js';
- * @import {Remote} from '@agoric/internal';
- * @import {CosmosInterchainService} from '../exos/cosmos-interchain-service.js';
- * @import {NameHub} from '@agoric/vats';
  * @import {Zone} from '@agoric/zone';
  * @import {OrchestrationTools} from '../utils/start-helper.js';
  */
 
-/**
- * @satisfies {OrchestrationFlow}
- * @param {Orchestrator} orch
- * @param {object} ctx
- * @param {LocalTransfer} ctx.localTransfer
- * @param {ZCFSeat} seat
- * @param {object} offerArgs
- * @param {Amount<'nat'>} offerArgs.staked
- * @param {CosmosValidatorAddress} offerArgs.validator
- */
-const stakeAndSwapFn = async (orch, { localTransfer }, seat, offerArgs) => {
-  const { give } = seat.getProposal();
-
-  const omni = await orch.getChain('omniflixhub');
-  const agoric = await orch.getChain('agoric');
-
-  const [omniAccount, localAccount] = await Promise.all([
-    omni.makeAccount(),
-    agoric.makeAccount(),
-  ]);
-
-  const omniAddress = omniAccount.getAddress();
-
-  // deposit funds from user seat to LocalChainAccount
-  await localTransfer(seat, localAccount, give);
-  seat.exit();
-
-  // build swap instructions with orcUtils library
-  const transferMsg = orcUtils.makeOsmosisSwap({
-    destChain: 'omniflixhub',
-    destAddress: omniAddress,
-    amountIn: give.Stable,
-    brandOut: /** @type {any} */ ('FIXME'),
-    slippage: 0.03,
-  });
-
-  try {
-    await localAccount.transferSteps(give.Stable, transferMsg);
-    await omniAccount.delegate(offerArgs.validator, offerArgs.staked);
-  } catch (e) {
-    console.error(e);
-  }
-};
-
 /** @type {ContractMeta<typeof start>} */
 export const meta = {
   privateArgsShape: {
@@ -86,32 +38,45 @@ export const makeNatAmountShape = (brand, min) =>
 /**
  * Orchestration contract to be wrapped by withOrchestration for Zoe
  *
- * @param {ZCF} zcf
- * @param {{
- *   agoricNames: Remote<NameHub>;
- *   localchain: Remote<LocalChain>;
- *   orchestrationService: Remote<CosmosInterchainService>;
- *   storageNode: Remote<StorageNode>;
- *   timerService: Remote<TimerService>;
+ * @param {ZCF<{ baseDenom: string; baseName: string }>} zcf
+ * @param {import('../utils/start-helper.js').OrchestrationPowers & {
  *   marshaller: Marshaller;
  * }} privateArgs
  * @param {Zone} zone
  * @param {OrchestrationTools} tools
  */
-const contract = async (zcf, privateArgs, zone, { orchestrate, zoeTools }) => {
-  const { brands } = zcf.getTerms();
+const contract = async (
+  zcf,
+  privateArgs,
+  zone,
+  { zoeTools, orchestrateAll, chainHub },
+) => {
+  assertIssuerKeywords(zcf, ['Stable', 'Out']);
+  const { brands, baseDenom, baseName } = zcf.getTerms();
 
-  /** deprecated historical example */
-  const swapAndStakeHandler = orchestrate(
-    'LSTTia',
-    { zcf, localTransfer: zoeTools.localTransfer },
-    stakeAndSwapFn,
-  );
+  const handlers = orchestrateAll(flows, {
+    zcf,
+    localTransfer: zoeTools.localTransfer,
+    brandOut: brands.Out,
+  });
+
+  const assets = await E(
+    E(privateArgs.agoricNames).lookup('vbankAsset'),
+  ).values();
+  const info = assets.find(a => a.brand === brands.Out);
+  for (const chainName of ['agoric', 'omniflixhub']) {
+    chainHub.registerChain(chainName, fetchedChainInfo[chainName]);
+  }
+  chainHub.registerAsset(info.denom, {
+    baseDenom,
+    baseName,
+    chainName: 'agoric',
+  });
 
   const publicFacet = zone.exo('publicFacet', undefined, {
     makeSwapAndStakeInvitation() {
       return zcf.makeInvitation(
-        swapAndStakeHandler,
+        handlers.swapAndStake,
         'Swap for TIA and stake',
         undefined,
         harden({

packages/orchestration/src/examples/swapExample.flows.js

@@ -0,0 +1,58 @@
+import { orcUtils } from '../utils/orc.js';
+
+/**
+ * @import {LocalTransfer} from '../utils/zoe-tools.js';
+ * @import {Orchestrator, CosmosValidatorAddress, OrchestrationFlow} from '../types.js'
+ */
+/**
+ * @satisfies {OrchestrationFlow}
+ * @param {Orchestrator} orch
+ * @param {object} ctx
+ * @param {LocalTransfer} ctx.localTransfer
+ * @param {Brand} ctx.brandOut
+ * @param {ZCFSeat} seat
+ * @param {object} offerArgs
+ * @param {Amount<'nat'>} offerArgs.staked
+ * @param {CosmosValidatorAddress} offerArgs.validator
+ */
+export const swapAndStake = async (
+  orch,
+  { localTransfer, brandOut },
+  seat,
+  offerArgs,
+) => {
+  const { give } = seat.getProposal();
+
+  const omni = await orch.getChain('omniflixhub');
+  const agoric = await orch.getChain('agoric');
+
+  const [omniAccount, localAccount] = await Promise.all([
+    omni.makeAccount(),
+    agoric.makeAccount(),
+  ]);
+
+  const omniAddress = omniAccount.getAddress();
+
+  // deposit funds from user seat to LocalChainAccount
+  await localTransfer(seat, localAccount, give);
+  seat.exit();
+
+  // build swap instructions with orcUtils library
+  const transferMsg = await orcUtils.makeOsmosisSwap(
+    {
+      destChain: 'omniflixhub',
+      destAddress: omniAddress,
+      amountIn: give.Stable,
+      brandOut,
+      slippage: 0.03,
+    },
+    orch,
+  );
+
+  try {
+    await localAccount.transferSteps(give.Stable, transferMsg);
+    await omniAccount.delegate(offerArgs.validator, offerArgs.staked);
+  } catch (e) {
+    console.error(e);
+  }
+};