@agoric/orchestration 0.1.1-dev-e26d66b.0 → 0.1.1-dev-9b9282d.0

package/src/examples/axelar-gmp.flows.js

@@ -0,0 +1,156 @@
+/**
+ * @file Implements the orchestration flow which does the following:
+ *
+ *   - Creates an EVM account on the target chain.
+ *   - Sets up and monitors the Local Chain Account (LCA).
+ *   - Coordinates IBC-related logic through `createAndMonitorLCA()`.
+ *
+ *   For more details, see: docs/axelar-gmp/create-and-use-wallet.mmd in
+ *   orchestration package.
+ */
+
+import { Fail, makeError, q } from '@endo/errors';
+import { makeTracer, NonNullish } from '@agoric/internal';
+import { denomHash } from '../utils/denomHash.js';
+import { gmpAddresses } from '../utils/gmp.js';
+import { AxelarGMPMessageType } from '../axelar-types.js';
+
+/**
+ * @import {GuestInterface, GuestOf} from '@agoric/async-flow';
+ * @import {Orchestrator, OrchestrationFlow} from '@agoric/orchestration';
+ * @import {MakeEvmAccountKit} from './axelar-gmp-account-kit.js';
+ * @import {ChainHub} from '@agoric/orchestration/src/exos/chain-hub.js';
+ * @import {Vow} from '@agoric/vow';
+ * @import {ZCFSeat, AmountKeywordRecord} from '@agoric/zoe';
+ * @import {LocalAccountMethods} from '@agoric/orchestration';
+ * @import {AxelarGmpOutgoingMemo} from '../axelar-types.js'
+ */
+
+const trace = makeTracer('EvmFlow');
+
+/**
+ * @satisfies {OrchestrationFlow}
+ * @param {Orchestrator} orch
+ * @param {{
+ *   makeEvmAccountKit: MakeEvmAccountKit;
+ *   chainHub: GuestInterface<ChainHub>;
+ *   log: GuestOf<(msg: string) => Vow<void>>;
+ *   localTransfer: GuestOf<
+ *     (
+ *       srcSeat: ZCFSeat,
+ *       localAccount: LocalAccountMethods,
+ *       amounts: AmountKeywordRecord,
+ *     ) => Vow<void>
+ *   >;
+ *   withdrawToSeat: GuestOf<
+ *     (
+ *       localAccount: LocalAccountMethods,
+ *       destSeat: ZCFSeat,
+ *       amounts: AmountKeywordRecord,
+ *     ) => Vow<void>
+ *   >;
+ * }} ctx
+ * @param {ZCFSeat} seat
+ */
+export const createAndMonitorLCA = async (
+  orch,
+  { makeEvmAccountKit, chainHub, log, localTransfer, withdrawToSeat },
+  seat,
+) => {
+  void log('Inside createAndMonitorLCA');
+  const [agoric, remoteChain] = await Promise.all([
+    orch.getChain('agoric'),
+    orch.getChain('axelar'),
+  ]);
+  const { chainId, stakingTokens } = await remoteChain.getChainInfo();
+  const remoteDenom = stakingTokens[0].denom;
+  remoteDenom || Fail`${chainId} does not have stakingTokens in config`;
+
+  const localAccount = await agoric.makeAccount();
+  void log('localAccount created successfully');
+  const localChainAddress = await localAccount.getAddress();
+  trace('Local Chain Address:', localChainAddress);
+
+  const agoricChainId = (await agoric.getChainInfo()).chainId;
+  const { transferChannel } = await chainHub.getConnectionInfo(
+    agoricChainId,
+    chainId,
+  );
+  assert(transferChannel.counterPartyChannelId, 'unable to find sourceChannel');
+
+  const localDenom = `ibc/${denomHash({
+    denom: remoteDenom,
+    channelId: transferChannel.channelId,
+  })}`;
+
+  const assets = await agoric.getVBankAssetInfo();
+  const info = await remoteChain.getChainInfo();
+  const evmAccountKit = makeEvmAccountKit({
+    localAccount,
+    localChainAddress,
+    sourceChannel: transferChannel.counterPartyChannelId,
+    localDenom,
+    assets,
+    remoteChainInfo: info,
+  });
+  void log('tap created successfully');
+  // XXX consider storing appRegistration, so we can .revoke() or .updateTargetApp()
+  // @ts-expect-error tap.receiveUpcall: 'Vow<void> | undefined' not assignable to 'Promise<any>'
+  await localAccount.monitorTransfers(evmAccountKit.tap);
+  void log('Monitoring transfers setup successfully');
+
+  const { give } = seat.getProposal();
+  const [[_kw, amt]] = Object.entries(give);
+
+  const { denom } = NonNullish(
+    assets.find(a => a.brand === amt.brand),
+    `${amt.brand} not registered in vbank`,
+  );
+
+  await localTransfer(seat, localAccount, give);
+
+  // Factory contract address when using local dev environment
+  // TODO: pass it via terms?
+  const factoryContractAddress = '0xef8651dD30cF990A1e831224f2E0996023163A81';
+
+  /** @type {AxelarGmpOutgoingMemo} */
+  const memo = {
+    destination_chain: 'Ethereum',
+    destination_address: factoryContractAddress,
+    payload: [],
+    type: AxelarGMPMessageType.ContractCall,
+    fee: {
+      amount: '1', // TODO: Get fee amount from api
+      recipient: gmpAddresses.AXELAR_GAS,
+    },
+  };
+
+  try {
+    void log('Initiating IBC transfer');
+    await localAccount.transfer(
+      {
+        value: gmpAddresses.AXELAR_GMP,
+        encoding: 'bech32',
+        chainId,
+      },
+      {
+        denom,
+        value: amt.value,
+      },
+      { memo: JSON.stringify(memo) },
+    );
+
+    void log('Done');
+  } catch (e) {
+    await withdrawToSeat(localAccount, seat, give);
+    const errorMsg = `IBC Transfer failed ${q(e)}`;
+    seat.exit(errorMsg);
+    throw makeError(errorMsg);
+  }
+
+  seat.exit();
+  // TODO: When used from the portfolio contract, expose the `holder` facet directly
+  // to bypass Zoe and walletFactory, since smart wallet constraints don't apply there.
+  return harden({ invitationMakers: evmAccountKit.invitationMakers });
+};
+harden(createAndMonitorLCA);

package/src/exos/orchestrator.d.ts

@@ -11,7 +11,7 @@ export function prepareOrchestrator(zone: Zone, powers: {
     vowTools: VowTools;
 }): () => import("@endo/exo").Guarded<{
     getChain(chainName: string): Vow<HostInterface<Chain<any> & object>>;
-    getDenomInfo(denom: string, srcChainName: "agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon"): HostInterface<import("../orchestration-api.js").DenomInfo<"agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon", "agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon">>;
+    getDenomInfo(denom: string, srcChainName: "agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "axelar" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon"): HostInterface<import("../orchestration-api.js").DenomInfo<"agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "axelar" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon", "agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "axelar" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon">>;
     /** @type {HostOf<Orchestrator['asAmount']>} */
     asAmount: HostOf<Orchestrator["asAmount"]>;
 }>;
@@ -105,7 +105,7 @@ declare function prepareOrchestratorKit(zone: Zone, { chainHub, makeLocalChainFa
     };
     orchestrator: {
         getChain(chainName: string): Vow<HostInterface<Chain<any> & object>>;
-        getDenomInfo(denom: string, srcChainName: "agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon"): HostInterface<import("../orchestration-api.js").DenomInfo<"agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon", "agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon">>;
+        getDenomInfo(denom: string, srcChainName: "agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "axelar" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon"): HostInterface<import("../orchestration-api.js").DenomInfo<"agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "axelar" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon", "agoric" | "base" | "solana" | "celestia" | "cosmoshub" | "juno" | "neutron" | "noble" | "omniflixhub" | "osmosis" | "secretnetwork" | "stargaze" | "stride" | "umee" | "dydx" | "archway" | "axelar" | "evmos" | "haqq" | "kava" | "kujira" | "migaloo" | "nolus" | "persistence" | "pryzm" | "sei" | "shido" | "titan" | "beezee" | "carbon" | "coreum" | "crescent" | "doravota" | "dymension" | "empowerchain" | "injective" | "lava" | "nibiru" | "planq" | "provenance" | "quicksilver" | "sifchain" | "terra2" | "ethereum" | "avalanche" | "optimism" | "arbitrum" | "polygon">>;
         /** @type {HostOf<Orchestrator['asAmount']>} */
         asAmount: HostOf<Orchestrator["asAmount"]>;
     };