Skip to content

Commit 3f7ea28

Browse files
authored
Merge pull request #314 from Mainnet-ops/docs/update-readme
docs: update README org references from SmartDropLabs to Mainnet-ops
2 parents d7153dd + dbd1f56 commit 3f7ea28

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SmartDrop (frontend)
22

3-
This repository is the **Next.js web app** for SmartDrop, hosted under [**SmartDropLabs/smartdrop-frontend**](https://github.com/SmartDropLabs/smartdrop-frontend). Soroban contracts live in [**smartdrop-contracts**](https://github.com/SmartDropLabs/smartdrop-contracts); the API and indexing service lives in [**smartdrop-backend**](https://github.com/SmartDropLabs/smartdrop-backend).
3+
This repository is the **Next.js web app** for SmartDrop, hosted under [**Mainnet-ops/smartdrop-frontend**](https://github.com/Mainnet-ops/smartdrop-frontend). Soroban contracts live in [**smartdrop-contracts**](https://github.com/Mainnet-ops/smartdrop-contracts); the API and indexing service lives in [**smartdrop-backend**](https://github.com/Mainnet-ops/smartdrop-backend).
44

55
**SmartDrop** is a liquidity-oriented airdrop experiment on **Stellar**: participants lock **Stellar assets** in **Soroban** farming pools and accrue **airdrop credits** over time instead of passive "click to claim" drops. The goal is to reward people who materially back a project early while discouraging purely extractive behavior.
66

@@ -10,19 +10,19 @@ This repository is the **Next.js web app** for SmartDrop, hosted under [**SmartD
1010

1111
At a high level, SmartDrop has two layers:
1212

13-
1. **Smart contracts (Soroban / Rust)** — developed in [**smartdrop-contracts**](https://github.com/SmartDropLabs/smartdrop-contracts)
13+
1. **Smart contracts (Soroban / Rust)** — developed in [**smartdrop-contracts**](https://github.com/Mainnet-ops/smartdrop-contracts)
1414
- A **factory** registers or deploys isolated **farming pool** instances per campaign.
1515
- Each pool accepts a configurable **staking asset** (classic asset + trustline and/or Soroban token contract, depending on your design). Participants **lock** balances, **earn credits** from elapsed time × amount × rate multipliers, can opt into **boost** rules, and **unlock** when policy allows.
1616

1717
2. **Web app (this repo)**
18-
A Chakra UI + Tailwind CSS front end with **Freighter** for wallet connection and Stellar network settings in `src/config/`. The **Farm** flow is wired to **Soroban RPC** (`invoke`, simulation, transaction submission); dashboard numbers reflect live contract state where a factory is configured, and fall back to clear "not available" states otherwise. Off-chain pages (**Prices**, **Airdrops**, **Webhooks**, **Alerts**) call [**smartdrop-backend**](https://github.com/SmartDropLabs/smartdrop-backend) directly over REST — see `src/lib/backend.ts` and `NEXT_PUBLIC_BACKEND_API_URL` below.
18+
A Chakra UI + Tailwind CSS front end with **Freighter** for wallet connection and Stellar network settings in `src/config/`. The **Farm** flow is wired to **Soroban RPC** (`invoke`, simulation, transaction submission); dashboard numbers reflect live contract state where a factory is configured, and fall back to clear "not available" states otherwise. Off-chain pages (**Prices**, **Airdrops**, **Webhooks**, **Alerts**) call [**smartdrop-backend**](https://github.com/Mainnet-ops/smartdrop-backend) directly over REST — see `src/lib/backend.ts` and `NEXT_PUBLIC_BACKEND_API_URL` below.
1919

2020
### Pages
2121

2222
| Route | Talks to | Auth |
2323
|---|---|---|
2424
| `/` | Soroban RPC ||
25-
| `/farm`, `/farm/[poolId]` | Soroban RPC + Freighter | Wallet |
25+
| `/farm`, `/farm/[poolId]` | Soroban RPC + Freighter | Wallet (shows total credits badge when connected) |
2626
| `/history` | Soroban RPC (Horizon) + Freighter | Wallet |
2727
| `/leaderboard` | Soroban RPC ||
2828
| `/contributors` | Static, GitHub API–sourced at build time ||
@@ -99,19 +99,19 @@ Workflow: [`.github/workflows/deploy-github-pages.yml`](./.github/workflows/depl
9999

100100
**One-time setup (required):**
101101

102-
1. Open **`https://github.com/SmartDropLabs/smartdrop-frontend/settings/pages`**
102+
1. Open **`https://github.com/Mainnet-ops/smartdrop-frontend/settings/pages`**
103103
2. **Build and deployment → Source:** choose **Deploy from a branch** (not "GitHub Actions").
104104
3. **Branch:** `gh-pages`, folder **`/ (root)`**, then **Save**.
105105
4. Wait 1–2 minutes after the workflow turns green (**Actions** tab).
106106

107-
**Link:** **`https://smartdroplabs.github.io/smartdrop-frontend/`**
107+
**Link:** **`https://mainnet-ops.github.io/smartdrop-frontend/`**
108108

109109
Local preview with the same asset paths: `BASE_PATH=/smartdrop-frontend npm run build` and `npx serve out` → open **`http://localhost:3000/smartdrop-frontend/`**.
110110

111111
### Vercel
112112

113113
1. Sign in at [vercel.com](https://vercel.com) and click **Add New… → Project**.
114-
2. **Import** `SmartDropLabs/smartdrop-frontend` (or your fork). Leave the root directory as the repo root (where `package.json` lives).
114+
2. **Import** `Mainnet-ops/smartdrop-frontend` (or your fork). Leave the root directory as the repo root (where `package.json` lives).
115115
3. Vercel should detect **Next.js**. `vercel.json` runs **`npm ci`** + **`npm run build`**; **`.npmrc`** enables `legacy-peer-deps` so Chakra + React resolve like your lockfile. The app is a **static export** (`next.config.ts`): no Node server, only HTML/JS/CSS.
116116
4. Under **Environment Variables**, add any optional `NEXT_PUBLIC_*` values from above (defaults work for testnet without them).
117117
5. In **Settings → General**, set **Node.js** to **20.x** (see `.nvmrc` / `package.json` `engines`).
@@ -156,13 +156,13 @@ npm run dev # frontend only — on-chain pages work, backend pages show
156156
npm run dev:stack # frontend + smartdrop-backend + an in-memory Redis, all in one command
157157
```
158158

159-
`dev:stack` (`scripts/dev-stack.sh`) expects [`smartdrop-backend`](https://github.com/SmartDropLabs/smartdrop-backend) cloned as a sibling directory (`../smartdrop-backend`), or point it elsewhere with `SMARTDROP_BACKEND_DIR=/path npm run dev:stack`. It needs no Docker or system Redis install — the first run installs a small in-memory Redis under `~/.smartdrop-dev/` and reuses it on every subsequent run, along with a persisted admin API key (printed on startup, needed for `/alerts`). Ctrl+C stops all three processes; logs land in `~/.smartdrop-dev/logs/`.
159+
`dev:stack` (`scripts/dev-stack.sh`) expects [`smartdrop-backend`](https://github.com/Mainnet-ops/smartdrop-backend) cloned as a sibling directory (`../smartdrop-backend`), or point it elsewhere with `SMARTDROP_BACKEND_DIR=/path npm run dev:stack`. It needs no Docker or system Redis install — the first run installs a small in-memory Redis under `~/.smartdrop-dev/` and reuses it on every subsequent run, along with a persisted admin API key (printed on startup, needed for `/alerts`). Ctrl+C stops all three processes; logs land in `~/.smartdrop-dev/logs/`.
160160

161161
Open [http://localhost:3000](http://localhost:3000). Production: `npm run build` / `npm start`.
162162

163163
### Soroban contracts
164164

165-
See the [**smartdrop-contracts**](https://github.com/SmartDropLabs/smartdrop-contracts) repository. Use the official **Stellar / Soroban** CLI and Rust toolchain to scaffold, test, and deploy; then connect the UI via RPC and Freighter-signed transactions.
165+
See the [**smartdrop-contracts**](https://github.com/Mainnet-ops/smartdrop-contracts) repository. Use the official **Stellar / Soroban** CLI and Rust toolchain to scaffold, test, and deploy; then connect the UI via RPC and Freighter-signed transactions.
166166

167167
**Never commit** signing keys or sponsor secrets.
168168

@@ -186,12 +186,13 @@ This codebase is **not** presented as audited production infrastructure. Pool ec
186186
| **Boost & donations** | Wire boosts to explicit token transfer rules in contracts. |
187187
| **Frontend** | Continue migrating layout/responsive styling to Tailwind. |
188188
| **Horizon + Soroban** | Optional account balance reads via Horizon alongside contract state. |
189+
| **Credits visibility** | Total credits badge on farm page header — users no longer need to navigate home to see their balance. |
189190

190191
---
191192

192193
## Contributors
193194

194-
SmartDrop is built by the SmartDropLabs org across three repos: this frontend, [`smartdrop-backend`](https://github.com/SmartDropLabs/smartdrop-backend), and [`smartdrop-contracts`](https://github.com/SmartDropLabs/smartdrop-contracts). See **[`CONTRIBUTORS.md`](./CONTRIBUTORS.md)** or the in-app [`/contributors`](https://smartdroplabs.github.io/smartdrop-frontend/contributors) page for the full list, sourced directly from each repo's GitHub contributors API.
195+
SmartDrop is built by the Mainnet-ops org across three repos: this frontend, [`smartdrop-backend`](https://github.com/Mainnet-ops/smartdrop-backend), and [`smartdrop-contracts`](https://github.com/Mainnet-ops/smartdrop-contracts). See **[`CONTRIBUTORS.md`](./CONTRIBUTORS.md)** or the in-app [`/contributors`](https://mainnet-ops.github.io/smartdrop-frontend/contributors) page for the full list, sourced directly from each repo's GitHub contributors API.
195196

196197
---
197198

0 commit comments

Comments
 (0)