feat: add bot filter by feature

.changeset/wicked-timers-sing.md

@@ -0,0 +1,8 @@
+---
+"@ledgerhq/live-common": minor
+"@ledgerhq/coin-framework": minor
+"@ledgerhq/coin-bitcoin": patch
+"@ledgerhq/coin-cosmos": patch
+---
+
+Bot feature : Add filter for features

.github/workflows/bot-nonreg-nitrogen.yml

@@ -35,3 +35,4 @@ jobs:
           BOT_ENVIRONMENT: production
           # We don't run these currencies daily because fees are expensive
           BOT_DISABLED_CURRENCIES: bitcoin,ethereum,qtum,decred,cardano,axelar,cosmos,secret_network,avalanche_c_chain,bsc,filecoin,tron,cronos,fantom,boba,telos_evm,polygon_zk_evm,polkadot
+          BOT_FILTER_FEATURES: send

.github/workflows/bot-nonreg-oxygen.yml

@@ -35,3 +35,4 @@ jobs:
           BOT_ENVIRONMENT: production
           # We only run these currencies on a weekly basis because fees are expensive
           BOT_FILTER_CURRENCIES: qtum,decred,cardano,axelar,cosmos,secret_network,avalanche_c_chain,bsc,filecoin,tron,cronos,fantom,boba,telos_evm,polygon_zk_evm,polkadot
+          BOT_FILTER_FEATURES: send

.github/workflows/bot-testing-nitrogen.yml

@@ -9,6 +9,9 @@ on:
       currencies:
         description: currency ids to test, separated with commas (,)
         required: false
+      features:
+        description: features to test(send,sendMax,tokens,staking)
+        required: false
       speculos_websocket:
         description: check to use speculos with Websocket
         type: boolean
@@ -48,4 +51,5 @@ jobs:
           BOT_ENVIRONMENT: testing
           BOT_FILTER_FAMILIES: ${{github.event.inputs.families}}
           BOT_FILTER_CURRENCIES: ${{github.event.inputs.currencies}}
+          BOT_FILTER_FEATURES: ${{github.event.inputs.features}}
           SPECULOS_USE_WEBSOCKET: ${{inputs.speculos_websocket}}

libs/coin-framework/src/bot/types.ts

@@ -78,6 +78,8 @@ export type TransactionRes<T extends TransactionCommon> = {
 export type MutationSpec<T extends TransactionCommon> = {
   // Name what this mutation is doing
   name: string;
+  // related feature to test
+  feature?: MutationFeatureType;
   // The maximum number of times to execute this mutation for a given test run
   maxRun: number;
   // Express the transaction to be done
@@ -118,7 +120,7 @@ export type AppSpec<T extends TransactionCommon> = {
   testTimeout?: number;
   // how much should we retry scan accounts if an error occurs
   scanAccountsRetries?: number;
-  // if define, will run the mutations {multipleRuns} times in order to cover 2 txs in the same run and detect possible issues at the "second tx time"
+  // if defined, will run the mutations {multipleRuns} times in order to cover 2 txs in the same run and detect possible issues at the "second tx time"
   multipleRuns?: number;
   // if the nano app depends on an app, name of this app
   dependency?: string | undefined;
@@ -266,3 +268,5 @@ export type FlowDesc<T extends TransactionCommon> = {
   steps: Array<Step<T>>;
   fallback?: (arg0: DeviceActionArg<T, State<T>>) => Step<T> | null | undefined;
 };
+
+export type MutationFeatureType = "send" | "sendMax" | "tokens" | "staking";

libs/coin-modules/coin-bitcoin/src/specs.ts

@@ -109,6 +109,7 @@ const bitcoinLikeMutations = ({
 }: Arg = {}): MutationSpec<Transaction>[] => [
   {
     name: "move ~50%",
+    feature: "send",
     maxRun: 1,
     transaction: ({ account, siblings, bridge, maxSpendable }) => {
       invariant(maxSpendable.gt(minimalAmount), "balance is too low");
@@ -282,6 +283,7 @@ const bitcoinLikeMutations = ({
   },
   {
     name: "send max",
+    feature: "sendMax",
     maxRun: 1,
     transaction: ({ account, siblings, bridge, maxSpendable }) => {
       invariant(maxSpendable.gt(minimalAmount), "balance is too low");

libs/coin-modules/coin-cosmos/src/specs.ts

@@ -117,7 +117,8 @@ function cosmosLikeMutations(minimalTransactionAmount: BigNumber): MutationSpec<
   return [
     {
       name: "send some",
-      maxRun: 2,
+      feature: "send",
+      maxRun: 1,
       testDestination: genericTestDestination,
       test: ({ account, accountBeforeTransaction, operation }) => {
         expect(account.balance.toString()).toBe(
@@ -148,6 +149,7 @@ function cosmosLikeMutations(minimalTransactionAmount: BigNumber): MutationSpec<
     },
     {
       name: "send max",
+      feature: "sendMax",
       maxRun: 1,
       testDestination: genericTestDestination,
       transaction: ({ account, siblings, bridge, maxSpendable }) => {
@@ -381,6 +383,7 @@ function cosmosLikeMutations(minimalTransactionAmount: BigNumber): MutationSpec<
     },
     {
       name: "claim rewards",
+      feature: "staking",
       maxRun: 1,
       transaction: ({ account, bridge, maxSpendable }) => {
         const { cosmosResources } = account as CosmosAccount;

libs/ledger-live-common/src/bot/cli.ts

@@ -8,10 +8,16 @@ const {
   BOT_FILTER_FAMILIES,
   BOT_DISABLED_CURRENCIES,
   BOT_DISABLED_FAMILIES,
+  BOT_FILTER_FEATURES,
 } = process.env;
 
 const arg: Partial<{
-  filter: Partial<{ currencies: string[]; families: string[]; mutation: string }>;
+  filter: Partial<{
+    currencies: string[];
+    families: string[];
+    mutation: string;
+    features: string[];
+  }>;
   disabled: Partial<{ currencies: string[]; families: string[] }>;
 }> = {};
 
@@ -34,4 +40,8 @@ if (BOT_DISABLED_FAMILIES) {
   arg.disabled.families = BOT_DISABLED_FAMILIES.split(",");
 }
 
+if (BOT_FILTER_FEATURES) {
+  arg.filter.features = BOT_FILTER_FEATURES.split(",");
+}
+
 bot(arg);

libs/ledger-live-common/src/bot/index.test.ts

@@ -15,6 +15,21 @@ describe("getSpecs", () => {
     expect(specs.every(spec => spec.currency.family === "bitcoin")).toEqual(true);
   });
 
+  it("should filter by feature correctly", () => {
+    setSupportedCurrencies(["bitcoin"]);
+    const specs = getSpecs({ disabled: {}, filter: { features: ["send"] } });
+    expect(specs[0].mutations.length).toBeGreaterThan(0);
+    expect(specs[0].mutations.every(spec => spec.feature === "send")).toEqual(true);
+  });
+
+  it("should filter multiple features correctly", () => {
+    setSupportedCurrencies(["bitcoin"]);
+    const currentFilter = ["send", "sendMax"];
+    const specs = getSpecs({ disabled: {}, filter: { features: currentFilter } });
+    expect(specs[0].mutations.length).toBeGreaterThan(0);
+    expect(specs[0].mutations.every(spec => currentFilter.includes(spec.feature))).toEqual(true);
+  });
+
   it("should disable currencies correctly", () => {
     setSupportedCurrencies(["bitcoin", "ethereum", "digibyte"]);
     const specs = getSpecs({ disabled: { currencies: ["digibyte"] }, filter: {} });

libs/ledger-live-common/src/bot/index.ts

@@ -35,7 +35,12 @@ import { sha256 } from "../crypto";
 import { getDefaultAccountName } from "@ledgerhq/live-wallet/accountName";
 
 type Arg = Partial<{
-  filter: Partial<{ currencies: string[]; families: string[]; mutation: string }>;
+  filter: Partial<{
+    currencies: string[];
+    families: string[];
+    mutation: string;
+    features: string[];
+  }>;
   disabled: Partial<{ currencies: string[]; families: string[] }>;
 }>;
 const usd = getFiatCurrencyByTicker("USD");
@@ -105,6 +110,7 @@ export function getSpecs({ disabled, filter }) {
   const filteredCurrencies = filter?.currencies || [];
   const filteredFamilies = filter?.families || [];
   const filteredMutation = filter?.mutation;
+  const filteredFeatures = filter.features || [];
   let disabledCurrencies = disabled?.currencies || [];
   let disabledFamilies = disabled?.families || [];
 
@@ -155,6 +161,13 @@ export function getSpecs({ disabled, filter }) {
         };
       }
 
+      if (filteredFeatures) {
+        spec = {
+          ...spec,
+          mutations: spec.mutations.filter(m => filteredFeatures.includes(m.feature)),
+        };
+      }
+
       specs.push(spec);
     }
   }

tools/actions/composites/bot/action.yml

@@ -10,6 +10,9 @@ inputs:
   BOT_FILTER_CURRENCIES:
     description: "currencies to filter on"
     required: false
+  BOT_FILTER_FEATURES:
+    description: "features to filter on"
+    required: false
   BOT_DISABLED_FAMILIES:
     description: "disabled families"
     required: false
@@ -74,6 +77,7 @@ runs:
         GITHUB_WORKFLOW: ${{ github.workflow }}
         BOT_FILTER_FAMILIES: ${{ inputs.BOT_FILTER_FAMILIES }}
         BOT_FILTER_CURRENCIES: ${{ inputs.BOT_FILTER_CURRENCIES }}
+        BOT_FILTER_FEATURES: ${{ inputs.BOT_FILTER_FEATURES }}
         BOT_DISABLED_FAMILIES: ${{ inputs.BOT_DISABLED_FAMILIES }}
         BOT_DISABLED_CURRENCIES: ${{ inputs.BOT_DISABLED_CURRENCIES }}
         SHOW_LEGACY_NEW_ACCOUNT: ${{ inputs.SHOW_LEGACY_NEW_ACCOUNT }}