Update main with latest development

.gitignore

@@ -24,4 +24,7 @@ dist
 .env.test.local
 .env.production.local
 
-.vscode
+.vscode
+
+.DS_Store
+out

.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "require": "./node_modules/hardhat/register.js",
+  "timeout": 40000,
+  "_": ["test/**/*.ts"]
+}

.npmrc

@@ -0,0 +1,11 @@
+# Security settings
+minimum-release-age=1440
+audit-level=moderate
+ignore-scripts=true
+package-manager-strict=true
+
+# Registry configurations
+@appliedblockchain:registry=https://npm.pkg.github.com
+@tokenysolutions:registry=https://npm.pkg.github.com
+@onchain-id:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

DEPLOY.md

@@ -24,7 +24,7 @@ SILENTDATA_CHAIN_ID=<silent_data_chain_id>
 ### 2. Compile Contracts
 
 ```bash
-pnpm compile
+pnpm compile:all
 ```
 
 ### 3. Deploy to Silent Data
@@ -50,7 +50,7 @@ pnpm install
 ### 2. Compile Contracts
 
 ```bash
-pnpm compile
+pnpm compile:all
 ```
 
 ### 3. Run Local Hardhat Node

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Applied Blockchain Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

README.md

@@ -6,7 +6,7 @@ The rapid growth of decentralised finance highlights a critical tension between
 
 **An unopinionated implementation**
 
-To achieve a truly unopinionated implementation, cryptographic details should be abstracted away from the Solidity interface. This ensures that different cryptographic approaches can be swapped without altering the contract’s external behaviour. Furthermore, logic around permissions and visibility controls should be programmable using standard Solidity constructs, avoiding proprietary libraries or custom extensions. The UCEF approach preserves the ERC-20 standard’s simplicity and composability while enabling flexible privacy rules that can adapt to evolving security requirements and compliance needs.
+To achieve a truly unopinionated implementation, cryptographic details should be abstracted away from the Solidity interface. This ensures that different cryptographic approaches can be swapped without altering the contract's external behaviour. Furthermore, logic around permissions and visibility controls should be programmable using standard Solidity constructs, avoiding proprietary libraries or custom extensions. The UCEF approach preserves the ERC-20 standard's simplicity and composability while enabling flexible privacy rules that can adapt to evolving security requirements and compliance needs.
 
 ## ***Features***
 
@@ -44,3 +44,7 @@ A range of examples are available at: [contracts/examples/](contracts/examples/)
 ## **Adopted By**
 <a href="https://silentdata.com/"><img src="https://github.com/user-attachments/assets/36ea4772-23c8-4c7a-ad2e-e3d6ee40ef9a" alt="Light Silent Data Logo" width="300"/></a>
 
+## **License**
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

UCEF3643.md

@@ -0,0 +1,181 @@
+# UCEF3643 Testing and Deployment Guide
+
+This guide provides comprehensive instructions for testing and deploying the UCEF3643 token implementation.
+
+## Prerequisites
+
+- Node.js (v14 or higher)
+- pnpm (recommended) or npm
+- Hardhat
+- Access to Silent Data credentials (for Silent Data deployment)
+
+## Project Structure
+
+The UCEF3643 implementation is located in the `packages/ucef-3643` directory, The root directory includes:
+- Test fixtures
+- Deployment script (scripts/deploy-suite.ts)
+- Ignition module (ignition/modules/UCEF3643.ts)
+
+## Testing
+
+### Running Tests
+
+1. Install dependencies:
+```bash
+pnpm install
+```
+
+2. Compile contracts:
+```bash
+pnpm compile:all
+```
+
+3. Run all tests:
+```bash
+pnpm test
+```
+
+4. Run specific test file:
+```bash
+pnpm test -- test/UCEF3643.test.ts
+```
+
+
+## Deployment
+
+### Local Development
+
+1. Start local Hardhat node:
+```bash
+pnpm chain
+```
+
+2. Configure environment:
+Create a `.env` file in the root directory:
+```env
+PRIVATE_KEY=<deployer_private_key>
+```
+
+3. Deploy using Ignition:
+```bash
+pnpm deploy:module UCEF3643
+```
+
+### Silent Data Deployment
+
+1. Configure environment:
+Create a `.env` file with Silent Data credentials:
+```env
+PRIVATE_KEY=<deployer_private_key>
+SILENTDATA_RPC_URL=<silent_data_rpc_url>
+SILENTDATA_CHAIN_ID=<silent_data_chain_id>
+```
+
+2. Deploy to Silent Data:
+```bash
+pnpm deploy:module UCEF3643 silentdata
+```
+
+### Available Modules
+| Module Name | Description |
+|------------|-------------|
+| UCEF3643 | Basic UCEF3643 token deployment without initialization |
+| UCEF3643Init | UCEF3643 token deployment with mock registry/compliance and initialization |
+| UCEF3643Proxy | UCEF3643 token deployment with proxy pattern for upgradability |
+
+
+### Deployment Script
+
+The deployment script (`scripts/deploy-suite.ts`) deploys the complete UCEF3643 suite including:
+- ClaimTopicsRegistry
+- TrustedIssuersRegistry
+- IdentityRegistryStorage
+- IdentityRegistry
+- ModularCompliance
+- TREXImplementationAuthority
+- Token implementation
+
+To use the deployment script:
+```bash
+pnpm script deploy-basic-suite
+```
+
+To use the deployment script with Silent Data network:
+```bash
+pnpm script deploy-basic-suite silentdata
+```
+
+The script will output the deployment addresses to the a file `DeploymentOutput.json` in the `out` directory. It's possible to export the private keys of the accounts by prepending the `EXPORT_PRIVATE_KEYS` environment variable to `true`.
+
+```bash
+EXPORT_PRIVATE_KEYS=true pnpm script deploy-basic-suite
+```
+
+## Contract Features
+
+The UCEF3643 implementation includes:
+- ERC-3643 compliance
+- Identity verification
+- Compliance checks
+- Token freezing capabilities
+- Transfer restrictions
+- Agent management
+
+## Troubleshooting
+
+If you encounter issues:
+
+1. Clean build artifacts:
+```bash
+pnpm clean:all
+```
+
+2. Recompile contracts:
+```bash
+pnpm compile:all
+```
+
+3. Verify environment configuration
+4. Check network connectivity
+5. Ensure sufficient funds for deployment
+
+It's possible to compile each package individually:
+
+Compile root contracts:
+```bash
+pnpm compile
+```
+
+Compile UCEF package contracts:
+```bash
+pnpm ucef compile
+```
+
+Compile UCEF3643 package contracts:
+```bash
+pnpm ucef-3643 compile
+```
+
+## Important Notes
+
+- Always test thoroughly on local network before deployment
+- Keep private keys and API credentials secure
+- Back up deployment addresses and transaction hashes
+- Monitor gas prices for optimal deployment timing
+- Ensure all required contracts are properly deployed in the correct order
+
+## Development Workflow
+
+1. Make changes to contracts
+2. Run tests to verify changes
+3. Deploy to local network for testing
+4. Deploy to testnet if required
+5. Deploy to production network
+
+## Security Considerations
+
+- Verify all contract interactions
+- Implement proper access controls
+- Test all security-critical functions
+- Review compliance requirements
+- Monitor for potential vulnerabilities

contracts/examples/UCEFCustom.sol

@@ -1,8 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import "../token/UCEF.sol";
-import "../extensions/UCEFOwned.sol";
+import {UCEF} from "@appliedblockchain/ucef/contracts/UCEF.sol";
 
 contract UCEFCustom is UCEF {
     address public regulator;

contracts/examples/UCEFOnlyOwner.sol

@@ -1,9 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import "../extensions/UCEFOwned.sol";
+import {UCEFOwned} from "@appliedblockchain/ucef/contracts/UCEFOwned.sol";
+
 contract UCEFOnlyOwner is UCEFOwned {
-    constructor() UCEF("UCEFOnlyOwner", "uOOT") {}
+    constructor() UCEFOwned("UCEFOnlyOwner", "uOOT") {}
 
     function mint(address account, uint256 amount) public {
         _mint(account, amount);

contracts/examples/UCEFOnlyOwnerAndRegulator.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import "../extensions/UCEFRegulated.sol";
+import {UCEFRegulated} from "@appliedblockchain/ucef/contracts/UCEFRegulated.sol";
 
 contract UCEFOnlyOwnerAndRegulator is UCEFRegulated {
 
-    constructor() UCEF('UCEFOnlyOwnerAndRegulator', 'uOOT') UCEFRegulated(msg.sender) {}
+    constructor() UCEFRegulated(msg.sender, 'UCEFOnlyOwnerAndRegulator', 'uOOT') {}
 
     function mint(address account, uint256 amount) public {
         _mint(account, amount);

contracts/examples/UCEFOnlyOwnerSharable.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import "../extensions/UCEFSharable.sol";
+import {UCEFSharable} from "@appliedblockchain/ucef/contracts/UCEFSharable.sol";
 
 contract UCEFOnlyOwnerSharable is UCEFSharable {
 
-    constructor() UCEF('UCEFOnlyOwnerSharable', 'uOOT') UCEFSharable(msg.sender) {}
+    constructor() UCEFSharable(msg.sender, 'UCEFOnlyOwnerSharable', 'uOOT') {}
 
     function mint(address account, uint256 amount) public {
         _mint(account, amount);

contracts/examples/UCEFOnlyOwnerWithPermit.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import "../extensions/UCEFOwned.sol";
-import "../extensions/UCEFPermit.sol";
+import {UCEFOwned, UCEF} from "@appliedblockchain/ucef/contracts/UCEFOwned.sol";
+import {UCEFPermit} from "@appliedblockchain/ucef/contracts/extensions/UCEFPermit.sol";
 
 contract UCEFOnlyOwnerWithPermit is UCEFOwned, UCEFPermit {
-    constructor() UCEF("UCEFOnlyOwner", "uOOT") UCEFPermit("UCEFOnlyOwner") {}
+    constructor() UCEFOwned("UCEFOnlyOwner", "uOOT") UCEFPermit("UCEFOnlyOwner") {}
 
     function mint(address account, uint256 amount) public {
         _mint(account, amount);