Skip to content

#new transaction acceleration data flow (frontend/backend) #72

@Dargon789

Description

@Dargon789

Reviewer's Guide

This PR refactors the asset synchronization script into a promise-driven, modular implementation with environment-based configuration, enhances transaction acceleration flows in the frontend to use a new dedicated endpoint and improved retry/filter logic, introduces a new acceleration lookup endpoint and indexing optimizations in the backend (along with raising express payload limits to 10 MB), and adjusts CI/CD workflows and a minor UI partner update.

Sequence diagram for new transaction acceleration data flow (frontend/backend)

sequenceDiagram
  participant F as "Frontend (TransactionComponent)"
  participant S as "ServicesApiService"
  participant B as "Backend API"
  participant R as "AccelerationRepository"

  F->>S: getAccelerationDataForTxid$(txid)
  S->>B: GET /services/accelerator/accelerations/:txid
  B->>R: $getAccelerationInfoForTxid(txid)
  R-->>B: Acceleration data or null
  B-->>S: Acceleration data or 404
  S-->>F: Acceleration data or null
  F->>F: Update acceleration info, handle retry/filter logic
Loading

Class diagram for new and updated backend acceleration API and repository

classDiagram
  class AccelerationRoutes {
    +initRoutes(app: Application): void
    -$getAcceleratorAcceleration(req: Request, res: Response): Promise<void>
    ...
  }
  class AccelerationRepository {
    +$getAccelerationInfoForTxid(txid: string): Promise<PublicAcceleration | null>
    +$getAccelerationInfo(poolSlug: string | null, height: number | null, interval: string | null): Promise<PublicAcceleration[]>
    ...
  }
  AccelerationRoutes --> AccelerationRepository: uses
Loading

Class diagram for updated ServicesApiService (frontend)

classDiagram
  class ServicesApiService {
    +getAccelerationDataForTxid$(txid: string)
    +getAllAccelerationHistory$(params, limit?, findTxid?): Observable<Acceleration[]>
    ...
  }
Loading

File-Level Changes

Change Details Files
sync-assets.js rewritten for modular utilities, async/await, and env-based config
  • Replaced callbacks with promise utilities (httpsRequest, downloadFile)
  • Centralized config from environment and JSON file
  • Unified download logic into processFileItem and fetchGitHubContents
  • Replaced fsSync/fs.promises calls, ensured directories dynamically
  • Retained Liquid asset flow via downloadLiquidAssets
frontend/sync-assets.js
Transaction/tracker components updated to use new acceleration endpoint and logic
  • Switched from getAllAccelerationHistory$ to getAccelerationDataForTxid$ when appropriate
  • Introduced filter to drop null results and refined retry with timer
  • Added network and blockHeight guards around accelerator calls
  • Changed fetchAcceleration$ to emit heights instead of hashes
frontend/src/app/components/transaction/transaction.component.ts
frontend/src/app/components/tracker/tracker.component.ts
frontend/src/app/services/services-api.service.ts
Backend adds /accelerations/:txid endpoint, indexing rules, and body parser limit
  • New repository method $getAccelerationInfoForTxid and route GET /accelerations/:txid
  • ChainTips limits block indexing by config.MEMPOOL.INDEXING_BLOCKS_AMOUNT and enriches cached orphans
  • BlocksRepository.$getBlock gains skipMemoryCache flag
  • Express body parsers (urlencoded, text, json) now use 10 MB limit
backend/src/repositories/AccelerationRepository.ts
backend/src/api/acceleration/acceleration.routes.ts
backend/src/api/chain-tips.ts
backend/src/repositories/BlocksRepository.ts
backend/src/api/blocks.ts
backend/src/index.ts
CI/CD workflows adjusted for tagging logic and toolchain pinning
  • on-tag workflow now tags only non-dash refs and renamed job
  • ci.yml updates rust-toolchain action version
  • improved naming in docker tag step
.github/workflows/on-tag.yml
.github/workflows/ci.yml
About component partner link updated
  • Replaced Citadel link and SVG with Nirvati entries
frontend/src/app/components/about/about.component.html

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Originally posted by @sourcery-ai[bot] in #69 (comment)

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdependenciesPull requests that update a dependency filedocumentationImprovements or additions to documentationduplicateThis issue or pull request already existsenhancementNew feature or requestgood first issueGood for newcomersinvalidThis doesn't seem rightjavascriptPull requests that update javascript codequestionFurther information is requested

Projects

Status

Backlog

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions