Add full monorepo: virtual-banker, backend, frontend, docs, scripts, deployment
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
64
docs/DOCUMENTATION_AND_TEST_FIXES.md
Normal file
64
docs/DOCUMENTATION_AND_TEST_FIXES.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Documentation and Test Fixes
|
||||
|
||||
**Date**: 2025-12-24
|
||||
**Status**: ✅ Fixed
|
||||
|
||||
---
|
||||
|
||||
## ✅ Fixed Issues
|
||||
|
||||
### 1. Documentation Tag Mismatches
|
||||
|
||||
The `@return` tags in documentation didn't match the actual return parameter names after renaming.
|
||||
|
||||
#### TransactionMirror.sol
|
||||
**Error**: `@return tx` but parameter is `mirroredTx`
|
||||
**Fix**: Updated to `@return mirroredTx`
|
||||
|
||||
#### OraclePriceFeed.sol
|
||||
**Error**: `@return needsUpdate` but parameter is `updateNeeded`
|
||||
**Fix**: Updated to `@return updateNeeded`
|
||||
|
||||
#### PriceFeedKeeper.sol
|
||||
**Error**: `@return needsUpdate` but parameter is `updateNeeded`
|
||||
**Fix**: Updated to `@return updateNeeded`
|
||||
|
||||
---
|
||||
|
||||
### 2. Test Event Reference Error
|
||||
|
||||
**Error**: `Member "ValueTransferDeclared" not found in type(contract CompliantUSDT)`
|
||||
|
||||
**Issue**: The event `ValueTransferDeclared` is defined in `LegallyCompliantBase`, not directly in `CompliantUSDT`. Even though `CompliantUSDT` inherits from it, the test needs to reference it through the base contract.
|
||||
|
||||
**Fix**:
|
||||
1. Added import for `LegallyCompliantBase`
|
||||
2. Changed event reference from `CompliantUSDT.ValueTransferDeclared` to `LegallyCompliantBase.ValueTransferDeclared`
|
||||
|
||||
```solidity
|
||||
// Before
|
||||
emit CompliantUSDT.ValueTransferDeclared(...);
|
||||
|
||||
// After
|
||||
emit LegallyCompliantBase.ValueTransferDeclared(...);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 Files Modified
|
||||
|
||||
1. `contracts/mirror/TransactionMirror.sol` - Fixed `@return` tag
|
||||
2. `contracts/reserve/OraclePriceFeed.sol` - Fixed `@return` tag
|
||||
3. `contracts/reserve/PriceFeedKeeper.sol` - Fixed `@return` tag
|
||||
4. `test/compliance/CompliantUSDTTest.t.sol` - Fixed event reference and added import
|
||||
|
||||
---
|
||||
|
||||
## ✅ Verification
|
||||
|
||||
All documentation tags now match their return parameters, and the test should compile successfully.
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-12-24
|
||||
|
||||
Reference in New Issue
Block a user