How recallnet/js-recall works
File Structure Components
• Top-Level Directories:
• apps – contains end-user applications such as the “portal” (primary web app) and “faucet” (token distribution tool).
• packages – includes shared libraries such as the core SDK, UI component library, smart contracts, blockchain-related utilities, address/BigInt manipulation utilities, and configuration packages.
• .changeset, .cursor, GitHub config directories, and various configuration files (ESLint, Prettier, TypeScript config) that support monorepo-level consistency and CI/CD.
• This structure indicates that each app uses a combination of these packages to deliver its functionality, while the packages themselves are developed and maintained centrally.
Key Components & Their Relationships
• Applications:
• Portal App: The main web application, using UI components, hooks, and utility libraries for frontend operations.
• Faucet App: A specialized interface (likely for token requests) integrating similar shared components.
• Shared Packages:
• SDK & SDKX: They form the core of the business logic and provide the API client interfaces (for example, connecting to blockchain systems or managing Recall’s entities).
• UI Library: Provides a set of reusable React components (buttons, dialogs, etc.) that both apps use to maintain consistent styling and behavior.
• Contracts & Chains: Likely provide smart contract interfaces and chain-specific configurations for interacting with blockchain networks.
• Other Utilities: Address-utils, BigInt-utils, FVM, etc. add domain-specific functionality and are reused across applications.
• Development & Configuration:
• Tools like Turborepo orchestrate builds, pnpm workspaces manage package dependencies, and the shared ESLint/TypeScript configurations ensure style and type consistency.
• Cursor and other IDE-specific configuration files indicate optimized workflows for development and team collaboration.