Develop

.cursor/rules/clean-up.mdc

@@ -0,0 +1,62 @@
+---
+description: Rules for cleaning up test files while maintaining functionality
+globs: 
+---
+ ---
+description: Rules for cleaning up test files while maintaining functionality
+globs:
+  - "src/__tests__/**/*.test.tsx"
+  - "src/__tests__/**/*.test.ts"
+---
+# Test Clean-up Rules
+
+Core Rule: Clean up tests while maintaining their effectiveness and readability.
+
+## Component Mocking Rules
+
+1. Avoid Mocking Child Components Unless Necessary
+   - Only mock components that are complex or have external dependencies
+   - Test with actual components when possible for better integration testing
+   - Exception: Mock components that cause test instability or are irrelevant to the test
+
+2. Mock Management
+   - Keep all mocks in a centralized object/constant for easy maintenance
+   - Group related mocks together (e.g., all hook mocks in one object)
+   - Document mock values that represent specific states (e.g., "Future date", "Past date")
+
+## Element Selection Rules
+
+1. Prefer Semantic Queries
+   - Use `getByRole` for interactive elements (buttons, inputs)
+   - Use `getByText` for text content and error messages
+   - Use `getByLabelText` for form controls with labels
+   - Only use `getByTestId` as a last resort
+
+2. Type Safety
+   - Properly type HTML elements when accessing properties
+   - Use type assertions only when TypeScript can't infer the type
+   - Example: `(element as HTMLInputElement).value`
+
+
+## Test Organization Rules
+
+1. Setup Functions
+   - Create reusable setup functions for common test scenarios
+   - Allow overrides for test-specific requirements
+   - Document the purpose of setup function parameters
+
+2. Test Structure
+   - Group related tests together
+   - Use clear, descriptive test names
+   - Follow the Arrange-Act-Assert pattern
+
+
+## Post Cleanup
+1. Run tests
+   -Ensure that the tests are passing by running the tests after the cleanup and the cleanup doesnt leave the tests broken
+## Decision Process
+Before cleaning up tests, ask:
+1. "Will this change make the tests more maintainable?"
+2. "Does this preserve the test's original intent?"
+3. "Is the cleanup making the test more readable?"
+4. "Are we maintaining proper test coverage?"

.cursor/rules/test-changes.mdc

@@ -0,0 +1,61 @@
+---
+description: Rules for handling test changes and verifying test status
+globs: 
+---
+---
+description: Rules for handling test changes and verifying test status
+globs:
+  - "src/__tests__/**/*.test.tsx"
+  - "src/__tests__/**/*.test.ts"
+---
+
+# Test Changes Rules
+
+Core Rule: Never consider a prompt complete until all tests are passing and the test file is clean.
+
+## Test Verification Process
+
+1. After ANY edit to test files:
+   - Run the tests immediately
+   - If tests fail, analyze the failures and fix them
+   - Continue this process until all tests pass
+   - Only then move to the cleanup phase
+
+2. For Test Modifications:
+   - Run tests before making changes to establish baseline
+   - Make the necessary changes
+   - Run tests again to verify changes
+   - If tests fail, fix and repeat
+   - Once passing, perform cleanup
+   - Document any unexpected test behavior
+
+3. For New Tests:
+   - Add the test
+   - Run the full test suite
+   - Verify both new and existing tests pass
+   - Fix any failures before moving on
+   - Once passing, perform cleanup
+
+## Test Cleanup Process
+
+1. After Tests Pass:
+   - Review and apply clean-up rules from clean-up.mdc
+   - Focus on improving:
+     - Component mocking strategy
+     - Element selection methods
+     - Asynchronous testing patterns
+     - Test organization and structure
+   - Run tests again after cleanup to ensure no regressions
+
+2. Cleanup Priorities:
+   - Replace non-semantic selectors with semantic ones
+   - Consolidate and organize mocks
+   - Improve type safety
+   - Enhance test readability
+   - Remove redundant or unnecessary code
+   - Add missing documentation
+
+## Decision Process
+Always ask: 
+1. "Have I run the tests and confirmed they all pass?" before moving to cleanup
+2. "Have I followed all clean-up rules thoroughly?" before considering the task complete 

.cursor/rules/test-placement.mdc

@@ -0,0 +1,45 @@
+---
+description: Rules for determining which test file a test should belong to
+globs: 
+---
+---
+description: Rules for determining which test file a test should belong to
+globs:
+  - "src/__tests__/**/*.test.tsx"
+  - "src/__tests__/**/*.test.ts"
+---
+
+# Test Placement Rules
+
+Core Rule: Tests belong in the test file of the component that CONTROLS the behavior/logic, not necessarily where the rendered output appears.
+
+## Rules for Different Test Types
+
+1. Conditional Rendering Tests
+   - Identify which component contains the IF/ELSE or conditional logic
+   - Place the test in that component's test file, even if it's testing what appears/doesn't appear elsewhere
+   - Example: If App.tsx decides when to show MobileScreen, the test belongs in App.test.tsx
+
+2. Feature/Behavior Tests
+   - Place tests with the component that implements the behavior
+   - Example: If Header.tsx implements mobile hiding with !isMobile, the "doesn't show on mobile" test belongs in Header.test.tsx
+
+3. Integration/Flow Tests
+   - Place tests with the highest-level component that orchestrates the flow
+   - Example: If a page component controls the flow between different states/views, put the flow tests there
+
+4. Context/Provider Tests
+   - Tests for how context affects rendering belong with the component using the context
+   - Tests for context logic itself belong with the context provider tests
+
+5. External Dependencies
+   - DO NOT test the behavior of external library functions/hooks
+   - Focus on testing your code's interaction with these dependencies
+   - Mock only the minimum required response from external dependencies
+   - Example: For hooks like useContractRead from external libraries, don't test their internal behavior
+   - Exception: You may test your wrapper/adapter around external dependencies if you've created one
+
+## Decision Process
+Always ask: 
+1. "Which component is making the decision?" - That's where the test belongs
+2. "Is this testing our code or an external dependency?" - Focus on our code

.env.example

@@ -1,14 +1,24 @@
+## PUBLIC ##
 NEXT_PUBLIC_VAULT_ADDRESSES=""
 NEXT_PUBLIC_ENVIRONMENT=""
 NEXT_PUBLIC_RPC_URL_MAINNET=""
 NEXT_PUBLIC_RPC_URL_SEPOLIA=""
-NEXT_PUBLIC_RPC_URL_DEVNET=""
-NEXT_PUBLIC_RPC_URL_JUNO_DEVNET=""
 NEXT_PUBLIC_FOSSIL_API_URL=""
 NEXT_PUBLIC_WS_URL=""
+
+## SECRETS ##
 FOSSIL_API_KEY=""
 FOSSIL_DB_URL=""
 PORT=
 NEXT_PUBLIC_FOSSIL_USE_MOCK_PRICING_DATA=true
-# ⬇️⬇️⬇️ This env var is used only in the devenv. Doesn't need to be set in prod
+ALCHEMY_API_KEY=""
+# DEMO
+DEMO_ACCOUNT_ADDRESS=""
+DEMO_PRIVATE_KEY=""
+
+# ⬇️⬇️⬇️ MANDATORY FOR DEVELOPMENT ENVIRONMENT - NOT NEEDED IN PRODUCTION
 JUNO_DOCKER_HOST=
+NEXT_PUBLIC_RPC_URL_DEVNET=""
+NEXT_PUBLIC_RPC_URL_JUNO_DEVNET=""
+
+

.github/workflows/deploy_pitchlake_ui.yaml

@@ -14,12 +14,9 @@ env:
   NODE_ENV: production
   PORT: ${{vars.PORT}}
   NEXT_PUBLIC_VAULT_ADDRESSES: ${{vars.VAULT_ADDRESSES}}
-  NEXT_PUBLIC_API_URL: ${{vars.API_URL}}
   NEXT_PUBLIC_ENVIRONMENT: ${{vars.ENVIRONMENT}}
   NEXT_PUBLIC_RPC_URL_MAINNET: ${{secrets.RPC_URL_MAINNET}}
   NEXT_PUBLIC_RPC_URL_SEPOLIA: ${{secrets.RPC_URL_SEPOLIA}}
-  NEXT_PUBLIC_RPC_URL_DEVNET: ${{secrets.RPC_URL_DEVNET}}
-  NEXT_PUBLIC_RPC_URL_JUNO_DEVNET: ${{vars.RPC_URL_JUNO_DEVNET}}
   NEXT_PUBLIC_WS_URL: ${{vars.WS_URL}}
   FOSSIL_API_KEY: ${{secrets.FOSSIL_API_KEY}}
   FOSSIL_DB_URL: ${{secrets.FOSSIL_DB_URL}}
@@ -73,12 +70,9 @@ jobs:
             --platform=linux/amd64 \
             --build-arg PORT=${{ env.PORT }} \
             --build-arg NEXT_PUBLIC_VAULT_ADDRESSES=${{ env.NEXT_PUBLIC_VAULT_ADDRESSES }} \
-            --build-arg NEXT_PUBLIC_API_URL=${{ env.NEXT_PUBLIC_API_URL }} \
             --build-arg NEXT_PUBLIC_ENVIRONMENT=${{ env.NEXT_PUBLIC_ENVIRONMENT }} \
             --build-arg NEXT_PUBLIC_RPC_URL_MAINNET=${{ env.NEXT_PUBLIC_RPC_URL_MAINNET }} \
             --build-arg NEXT_PUBLIC_RPC_URL_SEPOLIA=${{ env.NEXT_PUBLIC_RPC_URL_SEPOLIA }} \
-            --build-arg NEXT_PUBLIC_RPC_URL_DEVNET=${{ env.NEXT_PUBLIC_RPC_URL_DEVNET }} \
-            --build-arg NEXT_PUBLIC_RPC_URL_JUNO_DEVNET=${{ env.NEXT_PUBLIC_RPC_URL_JUNO_DEVNET }} \
             --build-arg NEXT_PUBLIC_WS_URL=${{ env.NEXT_PUBLIC_WS_URL }} \
             --build-arg FOSSIL_API_KEY=${{ env.FOSSIL_API_KEY }} \
             --build-arg FOSSIL_DB_URL=${{ env.FOSSIL_DB_URL }} \