refactor: monorepo workspaces migration #565

MiguelLZPF · 2025-08-14T12:28:58Z

Description

This pull request introduces significant improvements to the project’s monorepo structure, documentation, and CI/CD workflows. The main changes include reorganizing the repository to use npm workspaces, updating the documentation to reflect the new structure and commands, and splitting the test and publishing workflows for better modularity and efficiency. Additionally, configuration and formatting files were added or updated to standardize development practices.

Monorepo & Workspace Structure

Refactored the project into a true npm monorepo with clear separation of packages (core logic) and apps (applications), including new folders for ATS and Mass Payout modules. The documentation now explains the structure and workspace commands. [1] [2] [3] [4]

Documentation Updates

Expanded the README.md to include a workspace overview, available npm commands, build/test instructions, and details on the new CI workflows and environment setup. [1] [2] [3] [4] [5]

CI/CD Workflow Improvements

Split the previous monolithic test workflow into targeted workflows: .github/workflows/ats.test.yml for ATS, .github/workflows/mp.test.yml for Mass Payout, and updated .github/workflows/all.publish.yml for publishing. These workflows now trigger only when relevant files change, improving CI efficiency. [1] [2] [3] [4] [5] [6]

Configuration and Formatting

Added .prettierignore and .vscode/settings.json to enforce consistent code formatting across the repo, especially for Solidity and TypeScript files. Updated .github/dependabot.yaml for consistency in quoting and dependency update rules. [1] [2] [3]

Developer Tooling

Updated Husky hooks to use npm scripts for commit message linting and pre-commit actions, improving consistency in local development. [1] [2]

Type of change

Run all automated tests. Deploy the dApp and test the creation of bonds and equities.

Node version:

20
22
24

Checklist

Signed-off-by: Miguel_LZPF <[email protected]>

…e in compliance and identity contracts Signed-off-by: Miguel_LZPF <[email protected]>

…omponents Signed-off-by: Miguel_LZPF <[email protected]>

Signed-off-by: Miguel_LZPF <[email protected]>

…n scripts Signed-off-by: Miguel_LZPF <[email protected]>

Signed-off-by: Miguel_LZPF <[email protected]>

hedera-eng-infrastructure · 2025-08-14T12:29:19Z

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

✅ license/snyk check is complete. No issues have been found. (View Details)

Signed-off-by: Miguel_LZPF <[email protected]>

…rkspaces-migration Signed-off-by: Miguel_LZPF <[email protected]>

…e validation Signed-off-by: Miguel_LZPF <[email protected]>

…workflows Signed-off-by: Miguel_LZPF <[email protected]>

Signed-off-by: Miguel_LZPF <[email protected]>

…igration guide Signed-off-by: Miguel_LZPF <[email protected]>

Signed-off-by: Mario Francia <[email protected]>

- Changed "setup" script from "npm install" to "npm ci" for consistent installs. - Added "ats:setup" script to run "npm ci" followed by "ats:build". - Enhanced "ats:clean" script to include a message after cleaning. - Updated "ats:start" script to run "npm ci" before building and starting. - Improved "clean:deps" script to preserve package-lock.json and added a full clean option. Signed-off-by: Miguel_LZPF <[email protected]>

…identityRegistryId Signed-off-by: Mario Francia <[email protected]>

Signed-off-by: Mario Francia <[email protected]>

…ross modules Signed-off-by: Mario Francia <[email protected]>

Signed-off-by: Miguel_LZPF <[email protected]>

…port for JSON formats Signed-off-by: Miguel_LZPF <[email protected]>

Signed-off-by: Miguel_LZPF <[email protected]>

…tting scripts Signed-off-by: Miguel_LZPF <[email protected]>

Signed-off-by: Miguel_LZPF <[email protected]>

pathornteng

LGTM

nathanklick

No review performed as the PR is too large for a proper review. Rubber stamp approval only.

apps/ats/web/src/components/BaseMultiStyleConfiguration.ts

Signed-off-by: Miguel_LZPF <[email protected]> Signed-off-by: Mario Francia <[email protected]> Co-authored-by: Mario Francia <[email protected]> (cherry picked from commit 818a530) Signed-off-by: Mario Francia <[email protected]> # Conflicts: # .github/workflows/all.publish.yml # .prettierignore # .vscode/settings.json # README.md # apps/ats/web/src/components/BaseMultiStyleConfiguration.ts # apps/ats/web/src/theme/components/PanelTabs.ts # apps/ats/web/src/views/CreateBond/Components/__tests__/PreviousStepButton.test.tsx # apps/ats/web/src/views/CreateEquity/Components/__tests__/PreviousStepButton.test.tsx # contracts/contracts/layer_1/ERC3643/ERC3643.sol # contracts/contracts/layer_1/ERC3643/ERC3643Facet.sol # contracts/contracts/layer_1/interfaces/ERC3643/IERC3643Basic.sol # contracts/contracts/layer_2/bond/BondStorageWrapper.sol # contracts/contracts/layer_2/equity/EquityStorageWrapper.sol # contracts/contracts/layer_3/security/SecurityStorageWrapper.sol # contracts/contracts/layer_3/transferAndLock/TransferAndLockStorageWrapper.sol # contracts/contracts/test/testTimeTravel/facetsTimeTravel/ERC3643TimeTravel.sol # docs/dev-monorepo-migration.md # package-lock.json # package.json # packages/ats/contracts/contracts/layer_0/bond/BondStorageWrapper.sol # packages/ats/contracts/contracts/layer_0/equity/EquityStorageWrapper.sol # packages/ats/contracts/contracts/layer_0/security/SecurityStorageWrapper.sol # packages/ats/contracts/contracts/layer_0/transferAndLock/TransferAndLockStorageWrapper.sol # packages/ats/contracts/contracts/layer_1/ERC3643/ERC3643.sol # packages/ats/contracts/contracts/layer_1/ERC3643/ERC3643Facet.sol # packages/ats/contracts/contracts/layer_1/ERC3643/ERC3643Management.sol # packages/ats/contracts/contracts/layer_1/ERC3643/ERC3643ManagementFacet.sol # packages/ats/contracts/contracts/layer_1/interfaces/ERC3643/IERC3643Basic.sol # packages/ats/contracts/contracts/layer_1/interfaces/ERC3643/IERC3643Management.sol # packages/ats/contracts/contracts/layer_2/bond/BondStorageWrapper.sol # packages/ats/contracts/contracts/layer_2/equity/EquityStorageWrapper.sol # packages/ats/contracts/contracts/layer_3/security/SecurityStorageWrapper.sol # packages/ats/contracts/contracts/layer_3/transferAndLock/TransferAndLockStorageWrapper.sol # packages/ats/contracts/contracts/test/testTimeTravel/facetsTimeTravel/BondUSAReadTimeTravel.sol # packages/ats/contracts/contracts/test/testTimeTravel/facetsTimeTravel/ERC3643TimeTravel.sol # packages/ats/contracts/contracts/test/testTimeTravel/interfaces/ITimeTravelStorageWrapper.sol # packages/ats/contracts/contracts/test/testTimeTravel/timeTravel/TimeTravelStorageWrapper.sol # packages/ats/contracts/package.json # packages/ats/contracts/scripts/extractMethods.ts # packages/ats/contracts/scripts/selector.ts # packages/ats/sdk/__tests__/fixtures/cap/CapFixture.ts # packages/ats/sdk/package.json # packages/ats/sdk/src/port/in/security/agent/Agent.ts # packages/ats/sdk/src/port/in/security/balance/Balance.ts # packages/ats/sdk/src/port/in/security/compliance/Compliance.ts # packages/ats/sdk/src/port/in/security/controlList/ControlList.ts # packages/ats/sdk/src/port/in/security/freeze/Freeze.ts # packages/ats/sdk/src/port/in/security/hold/Hold.ts # packages/ats/sdk/src/port/in/security/identity/Identity.ts # packages/ats/sdk/src/port/in/security/info/Info.ts # packages/ats/sdk/src/port/in/security/issue/Issue.ts # packages/ats/sdk/src/port/in/security/lock/Lock.ts # packages/ats/sdk/src/port/in/security/pause/Pause.ts # packages/ats/sdk/src/port/in/security/protectedPartitions/ProtectedPartitions.ts # packages/ats/sdk/src/port/in/security/recovery/Recovery.ts # packages/ats/sdk/src/port/in/security/redeem/Redeem.ts # packages/ats/sdk/src/port/in/security/supply/Supply.ts # packages/ats/sdk/src/port/in/security/tokenMetadata/TokenMetadata.ts # packages/ats/sdk/src/port/in/security/transfer/Transfer.ts # web/src/views/CreateBond/Components/__tests__/PreviousStepButton.test.tsx # web/src/views/CreateEquity/Components/__tests__/PreviousStepButton.test.tsx

MiguelLZPF added 11 commits August 14, 2025 11:18

feat: add mass payout application and related root configurations

fa9e33e

Signed-off-by: Miguel_LZPF <[email protected]>

refactor: move contracts to new folder structure

06ba826

Signed-off-by: Miguel_LZPF <[email protected]>

refactor: move sdk to new folder structure

abfe963

Signed-off-by: Miguel_LZPF <[email protected]>

refactor: move web to new folder structure

9778116

Signed-off-by: Miguel_LZPF <[email protected]>

feat: test and fix build

6220351

Signed-off-by: Miguel_LZPF <[email protected]>

refactor: clean install and format

99be19e

Signed-off-by: Miguel_LZPF <[email protected]>

refactor: reorganize error declarations and improve function structur…

159e10a

…e in compliance and identity contracts Signed-off-by: Miguel_LZPF <[email protected]>

refactor: remove unused imports and improve type definitions across c…

4d92534

…omponents Signed-off-by: Miguel_LZPF <[email protected]>

fix: sdk build and linter issues

a684dff

Signed-off-by: Miguel_LZPF <[email protected]>

refactor: improve type safety in SDKConnection and update package.jso…

ce503b2

…n scripts Signed-off-by: Miguel_LZPF <[email protected]>

fix: import

73cef7c

Signed-off-by: Miguel_LZPF <[email protected]>

MiguelLZPF self-assigned this Aug 14, 2025

MiguelLZPF added 7 commits August 14, 2025 14:33

fix: use monorepo's files to fix build

f7aba67

Signed-off-by: Miguel_LZPF <[email protected]>

fix: web test mocks

5fa136f

Signed-off-by: Miguel_LZPF <[email protected]>

Merge remote-tracking branch 'origin/main' into refactor/BBND-1075-wo…

fe22222

…rkspaces-migration Signed-off-by: Miguel_LZPF <[email protected]>

chore: add commitlint and pre-commit hooks for improved commit messag…

315a70c

…e validation Signed-off-by: Miguel_LZPF <[email protected]>

chore: update pull request template and add ATS and Mass Payout test …

b328e39

…workflows Signed-off-by: Miguel_LZPF <[email protected]>

test: add update command for web tests in package.json

790c216

Signed-off-by: Miguel_LZPF <[email protected]>

docs: update documentation for monorepo structure and commands, add m…

890d688

…igration guide Signed-off-by: Miguel_LZPF <[email protected]>

MiguelLZPF added Dependencies Changes that update dependency files Refactor Documentation Changes that add or update documentation, such as README files, or other non-functional content labels Aug 18, 2025

MiguelLZPF marked this pull request as ready for review August 18, 2025 07:07

MiguelLZPF requested review from a team as code owners August 18, 2025 07:07

themariofrancia and others added 5 commits August 18, 2025 10:28

chore: added winston

0c20d35

Signed-off-by: Mario Francia <[email protected]>

chore: remove unused files

27b80ea

Signed-off-by: Mario Francia <[email protected]>

refactor: rename compliance and identityRegistry to complianceId and …

92059de

…identityRegistryId Signed-off-by: Mario Francia <[email protected]>

refactor: rename compliance and identityRegistry in Bond module

4f00940

Signed-off-by: Mario Francia <[email protected]>

themariofrancia previously approved these changes Aug 19, 2025

View reviewed changes

MiguelLZPF changed the title ~~Refactor/BBND-1075-workspaces-migration~~ refactor: monorepo workspaces migration Aug 19, 2025

jaime-iobermudez previously approved these changes Aug 19, 2025

View reviewed changes

feat: generate VC file and save to disk

4ed0970

Signed-off-by: Mario Francia <[email protected]>

themariofrancia dismissed stale reviews from jaime-iobermudez and themself via 4ed0970 August 19, 2025 07:07

themariofrancia and others added 6 commits August 19, 2025 09:07

feat: add identityRegistryId to BondFixture

a5eedc6

Signed-off-by: Mario Francia <[email protected]>

refactor: simplify handling of complianceId and identityRegistryId ac…

4ec22f3

…ross modules Signed-off-by: Mario Francia <[email protected]>

feat: add missing npm scripts and reorder by project and module

9e981a2

Signed-off-by: Miguel_LZPF <[email protected]>

feat: enhance VS Code settings for Prettier configuration and add sup…

136a1d8

…port for JSON formats Signed-off-by: Miguel_LZPF <[email protected]>

fix: add Apache License 2.0 header to missing files

fb6ff24

Signed-off-by: Miguel_LZPF <[email protected]>

chore: update package versions to 1.16.0 & be more sprecific on forma…

23ca08b

…tting scripts Signed-off-by: Miguel_LZPF <[email protected]>

MiguelLZPF requested review from jaime-iobermudez and themariofrancia August 19, 2025 10:38

fix: update publish commands in GitHub Actions workflow

7038ea1

Signed-off-by: Miguel_LZPF <[email protected]>

jaime-iobermudez approved these changes Aug 19, 2025

View reviewed changes

themariofrancia approved these changes Aug 19, 2025

View reviewed changes

pathornteng approved these changes Aug 21, 2025

View reviewed changes

nadineloepfe approved these changes Aug 21, 2025

View reviewed changes

JeffreyDallas approved these changes Aug 22, 2025

View reviewed changes

nathanklick approved these changes Aug 26, 2025

View reviewed changes

jsync-swirlds reviewed Aug 26, 2025

View reviewed changes

apps/ats/web/src/components/BaseMultiStyleConfiguration.ts Show resolved Hide resolved

MiguelLZPF merged commit 818a530 into main Aug 27, 2025
9 checks passed

iobroberto deleted the refactor/BBND-1075-workspaces-migration branch September 19, 2025 11:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: monorepo workspaces migration #565

refactor: monorepo workspaces migration #565

Uh oh!

MiguelLZPF commented Aug 14, 2025 •

edited

Loading

Uh oh!

hedera-eng-infrastructure commented Aug 14, 2025 •

edited

Loading

Uh oh!

pathornteng left a comment

Uh oh!

nathanklick left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

refactor: monorepo workspaces migration #565

refactor: monorepo workspaces migration #565

Uh oh!

Conversation

MiguelLZPF commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Checklist

Uh oh!

hedera-eng-infrastructure commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎉 Snyk checks have passed. No issues have been found so far.

Uh oh!

pathornteng left a comment

Choose a reason for hiding this comment

Uh oh!

nathanklick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

MiguelLZPF commented Aug 14, 2025 •

edited

Loading

hedera-eng-infrastructure commented Aug 14, 2025 •

edited

Loading