test: faucetTools.fundFaucet

- adds helper to fund agoric faucet with interchain tokens
- allows callers to request `OSMO`, `ATOM`, etc, via `provisionSmartWallet`

multichain-testing/test/auto-stake-it.test.ts

@@ -1,11 +1,8 @@
 import anyTest from '@endo/ses-ava/prepare-endo.js';
-import type { ExecutionContext, TestFn } from 'ava';
+import type { TestFn } from 'ava';
 import starshipChainInfo from '../starship-chain-info.js';
 import { makeDoOffer } from '../tools/e2e-tools.js';
-import {
-  createFundedWalletAndClient,
-  makeIBCTransferMsg,
-} from '../tools/ibc-transfer.js';
+import { makeFundAndTransfer } from '../tools/ibc-transfer.js';
 import { makeQueryClient } from '../tools/query.js';
 import type { SetupContextWithWallets } from './support.js';
 import { chainConfig, commonSetup } from './support.js';
@@ -37,53 +34,6 @@ test.after(async t => {
   deleteTestKeys(accounts);
 });
 
-const makeFundAndTransfer = (t: ExecutionContext<SetupContextWithWallets>) => {
-  const { retryUntilCondition, useChain } = t.context;
-  return async (chainName: string, agoricAddr: string, amount = 100n) => {
-    const { staking } = useChain(chainName).chainInfo.chain;
-    const denom = staking?.staking_tokens?.[0].denom;
-    if (!denom) throw Error(`no denom for ${chainName}`);
-
-    const { client, address, wallet } = await createFundedWalletAndClient(
-      t,
-      chainName,
-      useChain,
-    );
-    const balancesResult = await retryUntilCondition(
-      () => client.getAllBalances(address),
-      coins => !!coins?.length,
-      `Faucet balances found for ${address}`,
-    );
-
-    console.log('Balances:', balancesResult);
-
-    const transferArgs = makeIBCTransferMsg(
-      { denom, value: amount },
-      { address: agoricAddr, chainName: 'agoric' },
-      { address: address, chainName },
-      Date.now(),
-      useChain,
-    );
-    console.log('Transfer Args:', transferArgs);
-    // TODO #9200 `sendIbcTokens` does not support `memo`
-    // @ts-expect-error spread argument for concise code
-    const txRes = await client.sendIbcTokens(...transferArgs);
-    if (txRes && txRes.code !== 0) {
-      console.error(txRes);
-      throw Error(`failed to ibc transfer funds to ${chainName}`);
-    }
-    const { events: _events, ...txRest } = txRes;
-    console.log(txRest);
-    t.is(txRes.code, 0, `Transaction succeeded`);
-    t.log(`Funds transferred to ${agoricAddr}`);
-    return {
-      client,
-      address,
-      wallet,
-    };
-  };
-};
-
 const autoStakeItScenario = test.macro({
   title: (_, chainName: string) => `auto-stake-it on ${chainName}`,
   exec: async (t, chainName: string) => {
@@ -96,7 +46,11 @@ const autoStakeItScenario = test.macro({
       useChain,
     } = t.context;
 
-    const fundAndTransfer = makeFundAndTransfer(t);
+    const fundAndTransfer = makeFundAndTransfer(
+      t,
+      retryUntilCondition,
+      useChain,
+    );
 
     // 2. Find 'stakingDenom' denom on agoric
     const remoteChainInfo = starshipChainInfo[chainName];

multichain-testing/test/support.ts

@@ -19,6 +19,7 @@ import { makeHermes } from '../tools/hermes-tools.js';
 import { makeNobleTools } from '../tools/noble-tools.js';
 import { makeAssetInfo } from '../tools/asset-info.js';
 import starshipChainInfo from '../starship-chain-info.js';
+import { makeFaucetTools } from '../tools/faucet-tools.js';
 
 export const FAUCET_POUR = 10_000n * 1_000_000n;
 
@@ -84,6 +85,12 @@ export const commonSetup = async (t: ExecutionContext) => {
   const nobleTools = makeNobleTools(childProcess);
   const assetInfo = makeAssetInfo(starshipChainInfo);
   const chainInfo = withChainCapabilities(starshipChainInfo);
+  const faucetTools = makeFaucetTools(
+    t,
+    tools.agd,
+    retryUntilCondition,
+    useChain,
+  );
 
   /**
    * Starts a contract if instance not found. Takes care of installing
@@ -135,6 +142,7 @@ export const commonSetup = async (t: ExecutionContext) => {
     startContract,
     assetInfo,
     chainInfo,
+    faucetTools,
   };
 };
 

multichain-testing/tools/agd-lib.js

@@ -164,6 +164,19 @@ export const makeAgd = ({ execFileSync }) => {
             },
           ).toString();
         },
+        /** @param {string} name key name in keyring */
+        showAddress: name => {
+          return execFileSync(
+            kubectlBinary,
+            [...binaryArgs, 'keys', 'show', name, '-a', ...keyringArgs],
+            {
+              encoding: 'utf-8',
+              stdio: ['pipe', 'pipe', 'ignore'],
+            },
+          )
+            .toString()
+            .trim();
+        },
         /** @param {string} name */
         delete: name => {
           return exec([...keyringArgs, 'keys', 'delete', name, '-y'], {
@@ -181,7 +194,7 @@ export const makeAgd = ({ execFileSync }) => {
   return make();
 };
 
-/** @typedef {ReturnType<makeAgd>} Agd */
+/** @typedef {ReturnType<typeof makeAgd>} Agd */
 
 /** @param {{ execFileSync: typeof import('child_process').execFileSync, log: typeof console.log }} powers */
 export const makeCopyFiles = (

multichain-testing/tools/e2e-tools.js

@@ -144,7 +144,11 @@ export const provisionSmartWallet = async (
   // TODO: skip this query if balances is {}
   const vbankEntries = await q.queryData('published.agoricNames.vbankAsset');
   const byName = Object.fromEntries(
-    vbankEntries.map(([_denom, info]) => [info.issuerName, info]),
+    vbankEntries.map(([denom, info]) => {
+      /// XXX better way to filter out old ATOM denom?
+      if (denom === 'ibc/toyatom') return [undefined, undefined];
+      return [info.issuerName, info];
+    }),
   );
   progress({ send: balances, to: address });
 
@@ -543,6 +547,7 @@ export const makeE2ETools = async (
     /** @param {string} name */
     deleteKey: async name => agd.keys.delete(name),
     copyFiles,
+    agd,
   };
 };
 

multichain-testing/tools/faucet-tools.ts

@@ -0,0 +1,39 @@
+import type { ExecutionContext } from 'ava';
+import type { Denom } from '@agoric/orchestration';
+import { makeFundAndTransfer } from './ibc-transfer.js';
+import type { MultichainRegistry } from './registry.js';
+import type { RetryUntilCondition } from './sleep.js';
+import type { AgdTools } from './agd-tools.js';
+
+type ChainName = string;
+
+// 90% of default faucet pour
+const DEFAULT_QTY = (10_000_000_000n * 9n) / 10n;
+
+/**
+ * Determines the agoric `faucet` address and sends funds to it.
+ *
+ * Allows use of brands like OSMO, ATOM, etc. with `provisionSmartWallet`.
+ */
+export const makeFaucetTools = (
+  t: ExecutionContext,
+  agd: AgdTools['agd'],
+  retryUntilCondition: RetryUntilCondition,
+  useChain: MultichainRegistry['useChain'],
+) => {
+  const fundAndTransfer = makeFundAndTransfer(t, retryUntilCondition, useChain);
+  return {
+    /**
+     * @param assets denom on the issuing chain
+     * @param [qty] number of tokens
+     */
+    fundFaucet: async (assets: [ChainName, Denom][], qty = DEFAULT_QTY) => {
+      const faucetAddr = agd.keys.showAddress('faucet');
+      console.log(`Faucet address: ${faucetAddr}`);
+
+      for (const [chainName, denom] of assets) {
+        await fundAndTransfer(chainName, faucetAddr, qty, denom);
+      }
+    },
+  };
+};

multichain-testing/tools/ibc-transfer.ts

@@ -16,6 +16,7 @@ import { MsgTransfer } from '@agoric/cosmic-proto/ibc/applications/transfer/v1/t
 import { createWallet } from './wallet.js';
 import chainInfo from '../starship-chain-info.js';
 import type { MultichainRegistry } from './registry.js';
+import type { RetryUntilCondition } from './sleep.js';
 
 interface MakeFeeObjectArgs {
   denom?: string;
@@ -118,14 +119,15 @@ export const makeIBCTransferMsg = (
 };
 
 export const createFundedWalletAndClient = async (
-  t: ExecutionContext,
+  log: (...args: unknown[]) => void,
   chainName: string,
   useChain: MultichainRegistry['useChain'],
+  mnemonic?: string,
 ) => {
   const { chain, creditFromFaucet, getRpcEndpoint } = useChain(chainName);
-  const wallet = await createWallet(chain.bech32_prefix);
+  const wallet = await createWallet(chain.bech32_prefix, mnemonic);
   const address = (await wallet.getAccounts())[0].address;
-  t.log(`Requesting faucet funds for ${address}`);
+  log(`Requesting faucet funds for ${address}`);
   await creditFromFaucet(address);
   // TODO use telescope generated rpc client from @agoric/cosmic-proto
   // https://github.com/Agoric/agoric-sdk/issues/9200
@@ -135,3 +137,57 @@ export const createFundedWalletAndClient = async (
   );
   return { client, wallet, address };
 };
+
+export const makeFundAndTransfer = (
+  t: ExecutionContext,
+  retryUntilCondition: RetryUntilCondition,
+  useChain: MultichainRegistry['useChain'],
+) => {
+  return async (
+    chainName: string,
+    agoricAddr: string,
+    amount = 100n,
+    denom?: string,
+  ) => {
+    const { staking } = useChain(chainName).chainInfo.chain;
+    const denomToTransfer = denom || staking?.staking_tokens?.[0].denom;
+    if (!denomToTransfer) throw Error(`no denom for ${chainName}`);
+
+    const { client, address, wallet } = await createFundedWalletAndClient(
+      t.log,
+      chainName,
+      useChain,
+    );
+    const balancesResult = await retryUntilCondition(
+      () => client.getAllBalances(address),
+      coins => !!coins?.length,
+      `Faucet balances found for ${address}`,
+    );
+    console.log('Balances:', balancesResult);
+
+    const transferArgs = makeIBCTransferMsg(
+      { denom: denomToTransfer, value: amount },
+      { address: agoricAddr, chainName: 'agoric' },
+      { address: address, chainName },
+      Date.now(),
+      useChain,
+    );
+    console.log('Transfer Args:', transferArgs);
+    // TODO #9200 `sendIbcTokens` does not support `memo`
+    // @ts-expect-error spread argument for concise code
+    const txRes = await client.sendIbcTokens(...transferArgs);
+    if (txRes && txRes.code !== 0) {
+      console.error(txRes);
+      throw Error(`failed to ibc transfer funds to ${chainName}`);
+    }
+    const { events: _events, ...txRest } = txRes;
+    console.log(txRest);
+    t.is(txRes.code, 0, `Transaction succeeded`);
+    t.log(`Funds transferred to ${agoricAddr}`);
+    return {
+      client,
+      address,
+      wallet,
+    };
+  };
+};

multichain-testing/tools/sleep.ts

@@ -75,3 +75,5 @@ export const makeRetryUntilCondition = (defaultOptions: RetryOptions = {}) => {
       ...options,
     });
 };
+
+export type RetryUntilCondition = ReturnType<typeof makeRetryUntilCondition>;