diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..de7725c4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,129 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement on Telegram at +**https://t.me/+DOylgFv1jyJlNzM0**. + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index daa2b8a4..40b08e7c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -204,7 +204,7 @@ Frontend runs on: `http://localhost:3000` - `npm run lint` - Run ESLint **Environment Variables:** -Create a `.env.local` file in the `frontend` directory if needed for API endpoints or other configuration. +Copy [`frontend/.env.example`](../frontend/.env.example) to `frontend/.env.local` and adjust as needed. The `.env.example` file documents every `NEXT_PUBLIC_*` variable the application reads, with sensible testnet defaults. --- diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 621020ea..0198547e 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -230,8 +230,15 @@ To run the full stack end-to-end, set the following secrets. See [`backend/.env. ### Frontend | Variable | Purpose | -|---|---| +|---|---|---| | `NEXT_PUBLIC_API_URL` | Base URL of the backend API (e.g. `http://localhost:3001/v1`) | -| `NEXT_PUBLIC_STREAMING_CONTRACT` | Contract address displayed in the Settings page | -| `NEXT_PUBLIC_STELLAR_NETWORK` | `TESTNET` or `MAINNET` — must match the backend value | | `NEXT_PUBLIC_APP_VERSION` | Displayed in Settings; optional, defaults to `1.0.0` | +| `NEXT_PUBLIC_STELLAR_NETWORK` | `TESTNET` or `MAINNET` — must match the backend value | +| `NEXT_PUBLIC_STELLAR_EXPERT_URL` | Base URL for Stellar Expert explorer links (e.g. `https://stellar.expert/explorer/testnet`) | +| `NEXT_PUBLIC_SOROBAN_RPC_URL` | Soroban RPC endpoint (e.g. `https://soroban-testnet.stellar.org`) | +| `NEXT_PUBLIC_NETWORK_PASSPHRASE` | Stellar network passphrase (e.g. `Test SDF Network ; September 2015`) | +| `NEXT_PUBLIC_STREAM_CONTRACT_ID` | Soroban stream contract ID used by the Soroban client | +| `NEXT_PUBLIC_STREAMING_CONTRACT` | Contract address displayed in the Settings page | +| `NEXT_PUBLIC_USDC_ADDRESS` | USDC token contract address (testnet default provided) | +| `NEXT_PUBLIC_EURC_ADDRESS` | EURC token contract address (testnet default provided) | +| `NEXT_PUBLIC_XLM_ADDRESS` | XLM token contract address (testnet default provided) | diff --git a/frontend/.env.example b/frontend/.env.example new file mode 100644 index 00000000..3f854d28 --- /dev/null +++ b/frontend/.env.example @@ -0,0 +1,39 @@ +# ── Backend API ────────────────────────────────────────────────────────────── +# Base URL of the FlowFi backend API (used by all data-fetching hooks). +# Defaults to http://localhost:3001/v1 in local dev. +NEXT_PUBLIC_API_URL=http://localhost:3001/v1 + +# ── App Info ───────────────────────────────────────────────────────────────── +# Application version string displayed on the Settings page. +# Optional; defaults to "1.0.0" if unset. +NEXT_PUBLIC_APP_VERSION=1.0.0 + +# ── Stellar Network ────────────────────────────────────────────────────────── +# Set to TESTNET or MAINNET. Controls wallet behaviour and which Soroban +# endpoints are used. Must match the backend STELLAR_NETWORK value. +NEXT_PUBLIC_STELLAR_NETWORK=TESTNET + +# ── Stellar Expert Explorer ────────────────────────────────────────────────── +# Base URL for Stellar Expert block explorer links (transaction details, etc.). +NEXT_PUBLIC_STELLAR_EXPERT_URL=https://stellar.expert/explorer/testnet + +# ── Soroban / Smart Contracts ──────────────────────────────────────────────── +# RPC endpoint for Soroban contract interactions. +NEXT_PUBLIC_SOROBAN_RPC_URL=https://soroban-testnet.stellar.org + +# Network passphrase required by the Stellar SDK. +NEXT_PUBLIC_NETWORK_PASSPHRASE=Test SDF Network ; September 2015 + +# Deployed FlowFi stream contract ID (Soroban). +# Used by the Soroban client to invoke contract methods. +NEXT_PUBLIC_STREAM_CONTRACT_ID=CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFCT4 + +# Contract address displayed on the Settings page (may differ from stream ID). +NEXT_PUBLIC_STREAMING_CONTRACT=CDV4K...7ZQY + +# ── Token Contract Addresses (Testnet) ─────────────────────────────────────── +# Soroban token contract addresses used by the application. +# Replace with MAINNET addresses when deploying to production. +NEXT_PUBLIC_USDC_ADDRESS=CBIELTK6YBZJU5UP2WWQEUCYKLPU6AUNZ2BQ4WWFEIE3USCIHMXQDAMA +NEXT_PUBLIC_EURC_ADDRESS=CCWAMYJME4YOIUNAKVYEBYOG5I65QMKEX2NMN4OJAPXRPIF24ONPSHY +NEXT_PUBLIC_XLM_ADDRESS=CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIXF47ZG2FB2RMQQVU2HHGCN diff --git a/frontend/.gitignore b/frontend/.gitignore index c25376d4..193edd49 100644 --- a/frontend/.gitignore +++ b/frontend/.gitignore @@ -33,6 +33,7 @@ yarn-error.log* # env files (can opt-in for committing if needed) .env* +!.env.example # vercel .vercel