The official web interface for the Aegis RWA Protocol. Built with Next.js, this dashboard provides a seamless UI for administrators to mint compliant Real-World Assets and for investors to manage their portfolios.
- Node.js (v18+)
- Freighter Wallet Browser Extension
- Clone the repository and install dependencies:
npm install- Run the development server:
npm run dev
- Open http://localhost:3000 in your browser.
Tip
Having issues? Check our Troubleshooting Guide for solutions to common Node, Freighter, and Next.js setup problems.
Frontend contributors can run the full dashboard UI without a live Soroban RPC endpoint or deployed contracts. Set NEXT_PUBLIC_MOCK_MODE="true" in .env.local to activate the built-in mock SDK provider.
cp .env.example .env.local
# then set NEXT_PUBLIC_MOCK_MODE="true" in .env.local
npm run devAn amber warning banner is shown on every page when mock mode is active. See docs/mock-mode.md for full setup instructions, fixture data reference, and safety warnings.
We welcome frontend contributions! Check CONTRIBUTING.md for our branching strategies and tailwind styling rules. Look for // TODO: comments in the codebase for easy wins.
New to the project? Read the Contributor Experience Review for known onboarding friction, setup pitfalls, and documentation gaps to watch out for — plus the prioritized follow-up issues that will make contributing smoother.
All PRs that modify application behavior must include testing evidence — see docs/testing-evidence-requirement.md for the full policy and .github/pull_request_template.md for the checklist rendered in every new pull request.
Please review the Release Readiness Review before considering any release to production or testnet. It outlines current security flaws, limitations, and UX gaps.
Contributors paid through the GrantFox evaluation process should read the Payment-Period Conduct Note. It covers self-review before merge, screenshot and test-output expectations, and the rules around repeated submissions and complaints during evaluation windows.
When reviewing a GrantFox-submitted PR, use the Reviewer Checklist to verify implementation correctness, accessibility, test coverage, and acceptance criteria before approval.
Before opening a pull request, run the complete verification command:
This runs build, lint, and typecheck () locally to catch issues before CI. See the Testing & Evidence PR Requirement for what to include in your PR.
Before working on a GrantFox-tagged issue, review the Contributor Payment Guide. It covers evaluation criteria, required artifacts (screenshots and tests), and professional conduct expectations.
Before submitting a PR, review Low-Effort PR Examples for guidance on what GrantFox evaluators look for — including screenshot requirements, test coverage expectations, and CI standards.
The dashboard now includes a normalized transaction history view at /transactions. See docs/transaction-history.md for model details, supported operation types, fixture coverage, and current data source limitations.
Role-aware route guards protect admin, issuer, investor, and read-only sections. See docs/route-access.md for route mapping, guard states, SDK assumptions, and mock wallet fixtures.
Value-moving forms submit under a content-derived idempotency key, so a double-click, a remount, or a retry after a lost response cannot produce two transactions. See docs/form-idempotency.md for the key format, guard decisions, TTLs, and the limits of a client-side guard.
Failures from the Aegis SDK are classified into typed categories and mapped to concrete recovery actions (retry with backoff, reconnect the wallet, check the explorer, correct the form). See docs/sdk-error-recovery.md for the category model, side-effect risk rules, retry policies, and compliance wording assumptions.