Beta boe - #71
Closed
manishdex25 wants to merge 2 commits into
Closed
Conversation
* feat: implement ObligationEscrow and related factories - Added ObligationEscrow contract for managing title custody and status lifecycle. - Introduced ObligationEscrowFactory for deploying upgradeable ObligationEscrow instances. - Created ObligationRegistryFactory to deploy ObligationToken proxies linked to the ObligationEscrowFactory. - Defined interfaces and error handling for ObligationEscrow and its factory. - Updated hardhat configuration to include new compiler settings and output selection. - Added utility functions for computing ObligationEscrow addresses. * feat: add Obligation contracts and tests - Added ObligationEscrow, ObligationEscrowFactory, ObligationToken, and ObligationRegistryFactory contracts. - Implemented tests for ObligationEscrow and ObligationEscrowFactory, covering lifecycle and ownership functionalities. - Updated package.json to include new contract files. - Created fixture files for deploying Obligation contracts in tests. * refactor: rename ObligationToken to TradeTrustObligationToken and update related contracts - Replaced all instances of ObligationToken with TradeTrustObligationToken across contracts and tests. - Updated the ObligationRegistryFactory to deploy TradeTrustObligationToken proxies. - Removed the obsolete ObligationToken contract and its associated interface and errors. - Adjusted test files and fixtures to reflect the new token name and ensure compatibility. * refactor: replace TradeTrustObligationToken with TrustVCToken across contracts and tests - Renamed TradeTrustObligationToken to TrustVCToken in relevant contracts and interfaces. - Updated ObligationRegistryFactory to deploy TrustVCToken proxies instead of TradeTrustObligationToken. - Removed the obsolete TradeTrustObligationToken contract and its associated interface and errors. - Adjusted test files and fixtures to reflect the new token name and ensure compatibility. * refactor: update interface support and clean up code in ObligationEscrow and TrustVCToken - Removed the ITitleEscrow interface import from ObligationEscrow and updated the supportsInterface function to reflect this change. - Modified the _setBeneficiary function to use an empty string instead of "0x" when setting the nominee. - Updated the burnFromEscrow function in TrustVCToken to pass the remark parameter correctly during the registry transfer. - Cleaned up related tests by removing the check for ITitleEscrow interface support. * refactor: update ObligationEscrow and ObligationEscrowFactory for improved functionality - Refactored the ObligationEscrow contract to utilize a new constructor pattern and introduced a private _setStatus function for status transitions. - Updated the ObligationEscrowFactory to deploy non-upgradeable clones instead of upgradeable beacons, simplifying the deployment process. - Removed the obsolete ObligationRegistryFactory contract and its associated tests, streamlining the codebase. - Adjusted related tests to reflect changes in the factory and escrow implementations, ensuring compatibility with the new structure. - Updated .gitignore to exclude new dependency files. * refactor: enhance deployObligationEscrowFactoryFixture to support multiple signer types - Updated the deployObligationEscrowFactoryFixture function to accept both SignerWithAddress and Signer types for the deployer parameter, improving flexibility in testing scenarios. * refactor: replace enums with const objects for Status and TerminationReason in tests - Updated the ObligationEscrow and TrustVCToken test files to replace enum declarations with const objects for Status and TerminationReason, enhancing type safety and consistency. - Simplified the deployObligationEscrowFactoryFixture function signature for improved readability. * chore: retrigger CI after PR title conventional-commit fix Co-authored-by: Cursor <cursoragent@cursor.com> * chore: remove obsolete configuration and scenario files - Deleted remix.config.json and scenario.json as they are no longer needed, streamlining the project structure. * Update contracts/ObligationEscrow.sol Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update test/ObligationEscrowFactory.test.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * chore: retrigger failed jobs * fix: correct documentation and variable names in ObligationEscrow and tests - Updated the documentation comment in ObligationEscrow to fix the formatting of the `@notice` tag. - Renamed `fakeRegistryAddress` to `registryAddress` in the test file for clarity and consistency. - Adjusted the initialization calls in tests to use the updated `registryAddress` variable, ensuring accurate contract behavior during tests. * chore: update package version and add beta branch for releases - Bumped the package version to 5.5.2-beta.1 in package.json. - Added a new beta-boe branch to the release workflow for managing beta releases. * Update contracts/ObligationEscrow.sol Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * feat: enhance Hardhat configuration for output selection - Updated the Hardhat configuration to include additional output selections: `abi`, `evm.bytecode`, and `evm.deployedBytecode`, alongside `storageLayout`, improving the build output for contract deployments. * Update hardhat.config.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * refactor: simplify Hardhat configuration by removing unnecessary compiler settings * Update hardhat.config.ts Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * docs: update README to reflect changes in TradeTrust documentation - Revised the description to include Electronic Title Records (ETR) and Obligation Titles (BoE). - Added detailed sections for TrustVCToken and Obligation Escrow, including usage examples and status lifecycle. - Enhanced the Table of Contents for better navigation. --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* feat: implement ObligationEscrow and related factories - Added ObligationEscrow contract for managing title custody and status lifecycle. - Introduced ObligationEscrowFactory for deploying upgradeable ObligationEscrow instances. - Created ObligationRegistryFactory to deploy ObligationToken proxies linked to the ObligationEscrowFactory. - Defined interfaces and error handling for ObligationEscrow and its factory. - Updated hardhat configuration to include new compiler settings and output selection. - Added utility functions for computing ObligationEscrow addresses. * feat: add Obligation contracts and tests - Added ObligationEscrow, ObligationEscrowFactory, ObligationToken, and ObligationRegistryFactory contracts. - Implemented tests for ObligationEscrow and ObligationEscrowFactory, covering lifecycle and ownership functionalities. - Updated package.json to include new contract files. - Created fixture files for deploying Obligation contracts in tests. * refactor: rename ObligationToken to TradeTrustObligationToken and update related contracts - Replaced all instances of ObligationToken with TradeTrustObligationToken across contracts and tests. - Updated the ObligationRegistryFactory to deploy TradeTrustObligationToken proxies. - Removed the obsolete ObligationToken contract and its associated interface and errors. - Adjusted test files and fixtures to reflect the new token name and ensure compatibility. * refactor: replace TradeTrustObligationToken with TrustVCToken across contracts and tests - Renamed TradeTrustObligationToken to TrustVCToken in relevant contracts and interfaces. - Updated ObligationRegistryFactory to deploy TrustVCToken proxies instead of TradeTrustObligationToken. - Removed the obsolete TradeTrustObligationToken contract and its associated interface and errors. - Adjusted test files and fixtures to reflect the new token name and ensure compatibility. * refactor: update interface support and clean up code in ObligationEscrow and TrustVCToken - Removed the ITitleEscrow interface import from ObligationEscrow and updated the supportsInterface function to reflect this change. - Modified the _setBeneficiary function to use an empty string instead of "0x" when setting the nominee. - Updated the burnFromEscrow function in TrustVCToken to pass the remark parameter correctly during the registry transfer. - Cleaned up related tests by removing the check for ITitleEscrow interface support. * refactor: update ObligationEscrow and ObligationEscrowFactory for improved functionality - Refactored the ObligationEscrow contract to utilize a new constructor pattern and introduced a private _setStatus function for status transitions. - Updated the ObligationEscrowFactory to deploy non-upgradeable clones instead of upgradeable beacons, simplifying the deployment process. - Removed the obsolete ObligationRegistryFactory contract and its associated tests, streamlining the codebase. - Adjusted related tests to reflect changes in the factory and escrow implementations, ensuring compatibility with the new structure. - Updated .gitignore to exclude new dependency files. * refactor: enhance deployObligationEscrowFactoryFixture to support multiple signer types - Updated the deployObligationEscrowFactoryFixture function to accept both SignerWithAddress and Signer types for the deployer parameter, improving flexibility in testing scenarios. * refactor: replace enums with const objects for Status and TerminationReason in tests - Updated the ObligationEscrow and TrustVCToken test files to replace enum declarations with const objects for Status and TerminationReason, enhancing type safety and consistency. - Simplified the deployObligationEscrowFactoryFixture function signature for improved readability. * chore: retrigger CI after PR title conventional-commit fix Co-authored-by: Cursor <cursoragent@cursor.com> * chore: remove obsolete configuration and scenario files - Deleted remix.config.json and scenario.json as they are no longer needed, streamlining the project structure. * Update contracts/ObligationEscrow.sol Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update test/ObligationEscrowFactory.test.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * chore: retrigger failed jobs * fix: correct documentation and variable names in ObligationEscrow and tests - Updated the documentation comment in ObligationEscrow to fix the formatting of the `@notice` tag. - Renamed `fakeRegistryAddress` to `registryAddress` in the test file for clarity and consistency. - Adjusted the initialization calls in tests to use the updated `registryAddress` variable, ensuring accurate contract behavior during tests. * chore: update package version and add beta branch for releases - Bumped the package version to 5.5.2-beta.1 in package.json. - Added a new beta-boe branch to the release workflow for managing beta releases. * Update contracts/ObligationEscrow.sol Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * feat: enhance Hardhat configuration for output selection - Updated the Hardhat configuration to include additional output selections: `abi`, `evm.bytecode`, and `evm.deployedBytecode`, alongside `storageLayout`, improving the build output for contract deployments. * Update hardhat.config.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * refactor: simplify Hardhat configuration by removing unnecessary compiler settings * Update hardhat.config.ts Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * docs: update README to reflect changes in TradeTrust documentation - Revised the description to include Electronic Title Records (ETR) and Obligation Titles (BoE). - Added detailed sections for TrustVCToken and Obligation Escrow, including usage examples and status lifecycle. - Enhanced the Table of Contents for better navigation. * chore: update GitHub Actions workflow for release process - Upgraded actions/checkout and actions/setup-node to version 4 for improved performance. - Changed the semantic release step to run npm script directly instead of using the semantic-release-action. - Removed the output step for new release version as it is no longer needed. * Update .github/workflows/release.yml Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * chore: retrigger checks --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (26)
📝 WalkthroughWalkthroughAdds the ChangesObligation title stack
Estimated code review effort: 5 (Critical) | ~120 minutes Sequence Diagram(s)sequenceDiagram
participant TrustVCToken
participant ObligationEscrowFactory
participant ObligationEscrow
TrustVCToken->>ObligationEscrowFactory: create(tokenId)
ObligationEscrowFactory->>ObligationEscrow: initialize registry and token
ObligationEscrow->>TrustVCToken: burnFromEscrow(tokenId, remark)
Possibly related PRs
Suggested labels: Suggested reviewers: ✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
What is the background of this pull request?
Changes
Issues
What are the related issues or stories?
Releases
Channels: latest
ETA: Any target release date
Summary by CodeRabbit
New Features
Documentation
Release