Deprecate `/transaction-confirmation` endpoint #1973

iamacook · 2024-09-27T15:02:52Z

Summary

Resolves #1927

Currently, the /transaction-confirmation returns a TransactionInfo-like entity for the client to render details about swaps and TWAPs. We equally have the /preview endpoint that returns a TransactionInfo entity.

This adds swap and staking test coverage to the /preview endpoint to ensure usage of it can replace the /transaction-confirmation one (migrated from the latter's suite), fixing any found issues.

Changes

Decode staking transaction data instead of using dataDecoded (because of batches).
Correct types for /preview endpoint.
Add swap/staking test coverage to /preview endpoint.
Update other tests according.

coveralls · 2024-09-27T15:10:28Z

Pull Request Test Coverage Report for Build 11106369405

Details

40 of 40 (100.0%) changed or added relevant lines in 6 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+1.1%) to 91.988%

Totals
Change from base Build 11105212077:	1.1%
Covered Lines:	8482
Relevant Lines:	8886

💛 - Coveralls

iamacook · 2024-09-30T07:21:06Z

src/routes/transactions/helpers/kiln-native-staking.helper.ts

+  public findDepositTransaction(args: {
    chainId: string;
    to?: `0x${string}`;
    data: `0x${string}`;
-  }): Promise<{ to: `0x${string}`; data: `0x${string}` } | null> {
-    return this.findNativeStakingTransaction({
-      signature: KilnNativeStakingHelper.VALIDATORS_EXIT_SIGNATURE,
-      ...args,
-    });
+    value: string;
+  }): { to?: `0x${string}`; data: `0x${string}`; value: string } | null {
+    const selector = toFunctionSelector(
+      KilnNativeStakingHelper.DEPOSIT_SIGNATURE,
+    );
+    return this.transactionFinder.findTransaction(
+      (transaction) => transaction.data.startsWith(selector),
+      args,
+    );
  }

-  public async findWithdrawTransaction(args: {
+  public findValidatorsExitTransaction(args: {
    chainId: string;
    to?: `0x${string}`;
    data: `0x${string}`;
-  }): Promise<{ to: `0x${string}`; data: `0x${string}` } | null> {
-    return this.findNativeStakingTransaction({
-      signature: KilnNativeStakingHelper.WITHDRAW_SIGNATURE,
-      ...args,
-    });
+    value: string;
+  }): { to?: `0x${string}`; data: `0x${string}`; value: string } | null {
+    const selector = toFunctionSelector(
+      KilnNativeStakingHelper.VALIDATORS_EXIT_SIGNATURE,
+    );
+    return this.transactionFinder.findTransaction(
+      (transaction) => transaction.data.startsWith(selector),
+      args,
+    );
  }

-  private async findNativeStakingTransaction(args: {
-    signature: string;
+  public findWithdrawTransaction(args: {
    chainId: string;
    to?: `0x${string}`;
    data: `0x${string}`;
-  }): Promise<{ to: `0x${string}`; data: `0x${string}` } | null> {
-    const transaction = this.transactionFinder.findTransaction(
-      (transaction) =>
-        transaction.data.startsWith(toFunctionSelector(args.signature)),
+    value: string;
+  }): { to?: `0x${string}`; data: `0x${string}`; value: string } | null {
+    const selector = toFunctionSelector(
+      KilnNativeStakingHelper.WITHDRAW_SIGNATURE,
+    );
+    return this.transactionFinder.findTransaction(
+      (transaction) => transaction.data.startsWith(selector),
      args,
    );


When writing the tests, I realised we also check the deployment when mapping and fallback to a "standard" transaction there. This is therefore unnecessary, and now covered by tests.

iamacook · 2024-09-30T07:22:24Z

src/routes/transactions/mappers/common/native-staking.mapper.ts

-        args.dataDecoded,
-      );
+    const publicKeys = this.kilnNativeStakingHelper.splitPublicKeys(
+      this.kilnDecoder.decodeValidatorsExit(args.data)!.parameters[0].value,


There is a TODO added to the KilnDecoder to simplify this after deprecating the /transaction-confirmations endpoint.

iamacook · 2024-09-30T07:24:05Z

src/routes/transactions/mappers/common/native-staking.mapper.ts

-      return [];
+  }): Promise<Array<`0x${string}`> | null> {
+    if (!args.txHash) {
+      return null;


I have looked through the client codebase and this will not affect the current implementation. The validators are only mapped on exit transactions, when we know the values.

hectorgomezv · 2024-10-04T13:41:27Z

...outes/transactions/__tests__/controllers/preview-transaction.transactions.controller.spec.ts

@@ -364,4 +414,3299 @@ describe('Preview transaction - Transactions Controller (Unit)', () => {
        },
      });
  });
+
+  describe('CoW Swap', () => {


Very nit: what do you think about splitting these transactions preview tests by the provider (CowSwap, Kiln, Safe) into several files?

Split in 3a2c239.

src/routes/transactions/mappers/common/native-staking.mapper.ts

iamacook · 2024-10-07T09:34:37Z

At the request of QA, I'm marking this as a draft until the multichain feature is released.

Adds swap and staking test coverage to the `/preview` endpoint to ensure usage of it can replace the `/transaction-confirmation` one (migrated from the latter's suite), fixing any found issues: - Decode staking transaction data instead of using `dataDecoded` (because of batches). - Correct types for `/preview` endpoint. - Add swap/staking test coverage to `/preview` endpoint. - Update other tests according.

Add swap and staking tests to preview endpoint

95fa5e8

iamacook self-assigned this Sep 27, 2024

iamacook added 3 commits September 27, 2024 17:39

Add full test coverage for swaps

3ebbc07

Add full test coverage for TWAPs

6be590a

Add full test coverage for staking

74a6ecd

iamacook commented Sep 30, 2024

View reviewed changes

iamacook changed the title ~~Add swap and staking tests to preview endpoint~~ Deprecate /transaction-confirmation endpoint Sep 30, 2024

Mark endpoint as deprecated

6167981

iamacook marked this pull request as ready for review September 30, 2024 07:35

iamacook requested a review from a team as a code owner September 30, 2024 07:35

iamacook linked an issue Sep 30, 2024 that may be closed by this pull request

Investigate using mappers for transaction-confirmation endpoint #1927

Closed

iamacook added 2 commits September 30, 2024 14:39

Merge branch 'main' into preview-tests

5a102fb

Remove unnecessary argument

739ab63

hectorgomezv approved these changes Oct 4, 2024

View reviewed changes

iamacook added 2 commits October 7, 2024 11:08

Split tests

3a2c239

Merge branch 'main' into preview-tests

2736e96

iamacook marked this pull request as draft October 7, 2024 09:34

iamacook added 2 commits October 7, 2024 11:40

Merge branch 'main' into preview-tests

c0ebb20

Fix formatting

33fe960

iamacook marked this pull request as ready for review October 8, 2024 08:06

hectorgomezv self-requested a review October 8, 2024 08:39

hectorgomezv approved these changes Oct 8, 2024

View reviewed changes

liliya-soroka mentioned this pull request Oct 8, 2024

Refactor: unify confirmations in the transaction flow safe-global/safe-wallet-monorepo#4177

Merged

3 tasks

iamacook merged commit 8321909 into main Oct 8, 2024
21 of 22 checks passed

iamacook deleted the preview-tests branch October 8, 2024 10:11

iamacook mentioned this pull request Oct 8, 2024

Migrate from /transaction-confirmation to /preview endpoint safe-global/safe-wallet-monorepo#4331

Closed

katspaugh mentioned this pull request Jan 15, 2025

Refactor(Tx decoding): use transaction preview endpoint safe-global/safe-wallet-monorepo#4783

Merged

iamacook mentioned this pull request Jan 20, 2025

Remove transaction confirmation view endpoint #2276

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `/transaction-confirmation` endpoint #1973

Deprecate `/transaction-confirmation` endpoint #1973

iamacook commented Sep 27, 2024 •

edited

Loading

coveralls commented Sep 27, 2024 •

edited

Loading

iamacook Sep 30, 2024

iamacook Sep 30, 2024

iamacook Sep 30, 2024 •

edited

Loading

hectorgomezv Oct 4, 2024

iamacook Oct 7, 2024

iamacook commented Oct 7, 2024

Deprecate /transaction-confirmation endpoint #1973

Deprecate /transaction-confirmation endpoint #1973

Conversation

iamacook commented Sep 27, 2024 • edited Loading

Summary

Changes

coveralls commented Sep 27, 2024 • edited Loading

Pull Request Test Coverage Report for Build 11106369405

Details

💛 - Coveralls

iamacook Sep 30, 2024

Choose a reason for hiding this comment

iamacook Sep 30, 2024

Choose a reason for hiding this comment

iamacook Sep 30, 2024 • edited Loading

Choose a reason for hiding this comment

hectorgomezv Oct 4, 2024

Choose a reason for hiding this comment

iamacook Oct 7, 2024

Choose a reason for hiding this comment

iamacook commented Oct 7, 2024

Deprecate `/transaction-confirmation` endpoint #1973

Deprecate `/transaction-confirmation` endpoint #1973

iamacook commented Sep 27, 2024 •

edited

Loading

coveralls commented Sep 27, 2024 •

edited

Loading

iamacook Sep 30, 2024 •

edited

Loading