Operator Guide
UFX Protocol Guidelines
This guide outlines the on-chain workflows and the exact actions to call at each step of the protocol lifecycle. Use it to operate the system safely and consistently.
1. System Setup
Deploy Facets
Deploy each facet contract (AccessControl, Governance, RFQ, etc.) and record their addresses.
Admin Console: Facet Upgrades → Deploy Facet.
Add Facets to Diamond
Attach facet selectors using diamondCut and optionally initialize.
Admin Console: Facet Upgrades → Add Facet.
Initialize Roles
Ensure AccessControl is initialized and the admin has privileges.
Admin Console: Access Control → Grant Role.
2. Fund Setup Workflow
Register Fund
Register a fund with issuer, transfer agent, and NAV oracle.
Role Panel: Issuer → Register Fund.
Set Compliance Policy
Define eligibility limits, max exposure, and residency rules.
Role Panel: Compliance Officer → Set Policy.
Publish NAV
Push NAV per share updates to enable price validation.
Role Panel: Oracle → Publish NAV.
3. Investor Onboarding
Upsert Identity
Create or update identity records and residency metadata.
Role Panel: Identity Provider → Upsert Identity.
Issue Credential
Issue KYC credentials to the investor address.
Role Panel: Identity Provider → Issue Credential.
Bind KYC
Attach the credential to the investor for compliance checks.
Role Panel: Compliance Officer → Bind KYC.
4. Trading Lifecycle
Create RFQ
Investors request quotes for a fund and quantity.
Role Panel: Investor → Create RFQ.
Submit Quote
Market makers submit firm quotes with price + validity.
Role Panel: Market Maker → Submit Quote.
Accept Quote
Investor accepts a quote, creating an escrow position.
Role Panel: Investor → Accept Quote.
5. Settlement & Registry
Escrow Settlement
Settlement module moves tokens and distributes fees.
Triggered by protocol after quote acceptance.
Registry Update
Transfer agents confirm registry updates after settlement.
Role Panel: Transfer Agent → Mark Processed.
Fee Withdrawal
Fee collector withdraws protocol fees to the recipient.
Role Panel: Fee Collector → Withdraw Fees.
6. Governance & Controls
Pause / Unpause
Emergency controls to stop trading or resume operations.
Admin Console → Pause / Unpause.
System Parameters
Update NAV age, RFQ limits, and settlement timeout.
Admin Console → Governance + RFQ panels.
Role Management
Grant or revoke operational roles using AccessControl.
Admin Console → Access Control.