Skip to content

Commit 34d39a9

Browse files
Bootstrap Superfluid config and deployments
Why: Establish the network configuration and deterministic deploy caches so wrapper discovery/creation is reliable and repeatable. Centralize Superfluid core (resolver, host, CFAv1, factory) and SEND v1 addresses in config/superfluid.ts. Add a deployments scaffold (deployments/wrapper.*.json) for idempotent runs and future scripts. Also improve repo hygiene for tracked docs and dotenv handling. Details: - config/superfluid.ts: per-network addresses for Base mainnet, Base Sepolia, local fork; wrapper metadata (name/symbol/decimals) - deployments: persistent cache of wrapper addresses - ABIs referenced via scripts/abis helpers (used by wrapper/rewards) - Hardhat + viem based flows - .gitignore: stop ignoring docs/; ignore .env* but keep .env.sample tracked Test plan: - bunx hardhat compile (succeeds) - bunx hardhat run scripts/wrapper/create.ts --network anvil (writes/reads deployments/wrapper.845337.json) - bunx hardhat run scripts/wrapper/create.ts --network base|sepolia (read-only discovery path) - git status shows no stray docs changes; .env.sample remains tracked
1 parent 6c12f52 commit 34d39a9

File tree

8 files changed

+524
-1754
lines changed

8 files changed

+524
-1754
lines changed

.gitignore

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,11 @@ broadcast/
88
/broadcast/*/31337/
99
/broadcast/**/dry-run/
1010

11-
# Docs
12-
docs/
13-
1411
# Dotenv file
15-
.env
12+
.env*
13+
!.env.sample
1614

1715
node_modules
18-
.env
1916

2017
# Hardhat files
2118
/cache

PLAN.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

README.md

Lines changed: 9 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,13 @@
11
# Super Send – SuperToken Wrapper (backend-only)
22

3-
This repository orchestrates a Superfluid-based SuperToken wrapper around the existing SEND v1 token. No lockbox/v1 token contracts live here; they remain in `~/Documents/Send/send-token-upgrade`. End users never hold or interact with the wrapper; it is for backend flows only.
3+
This repository orchestrates a Superfluid-based SuperToken wrapper
4+
(SENDx) around the existing SEND v1 token for backend-only flows using
5+
official Superfluid contracts/ABIs and viem via Hardhat. End users do not
6+
hold or interact with the wrapper directly.
47

5-
Addresses (per network)
6-
- SEND v1 (underlying)
7-
- Base mainnet (8453): 0xEab49138BA2Ea6dd776220fE26b7b8E446638956
8-
- Base Sepolia (84532): 0xBbB542c66a7DD7BA6893C9630B30358D610FF3ee
9-
- Local Base mainnet (845337): 0xEab49138BA2Ea6dd776220fE26b7b8E446638956
10-
- Superfluid core
11-
- Base mainnet: Resolver 0x6a214c324553F96F04eFBDd66908685525Da0E0d, Host 0x4C073B3baB6d8826b8C5b229f3cfdC1eC6E47E74, CFAv1 0x19ba78B9cDB05A877718841c574325fdB53601bb, SuperTokenFactory 0xe20B9a38E0c96F61d1bA6b42a61512D56Fea1Eb3
12-
- Base Sepolia: Resolver 0x21d4E9fbB9DB742E6ef4f29d189a7C18B0b59136, Host 0x109412E3C84f0539b43d39dB691B08c90f58dC7c, CFAv1 0x6836F23d6171D74Ef62FcF776655aBcD2bcd62Ef, SuperTokenFactory 0x7447E94Dfe3d804a9f46Bf12838d467c912C8F6C
8+
Docs by feature:
9+
- Platform/environment: docs/platform.md
10+
- Wrapper: docs/wrapper.md
11+
- Rewards: docs/rewards.md
1312

14-
Requirements
15-
- .env: EOA_DEPLOYER, ETHERSCAN_API_KEY
16-
- Bun + Node, Hardhat, Anvil for local Base fork
17-
18-
Scripts and flows
19-
- Tests (Base fork):
20-
```sh
21-
bun run test
22-
```
23-
- Local deploy orchestration (placeholder until PR4 adds wrapper script):
24-
```sh
25-
./bin/anvil-deploy
26-
```
27-
- Wrapper address persistence
28-
- deployments/wrapper.{chainId}.json
29-
30-
Environment flags (for later PRs)
31-
- CREATE_WRAPPER=true: force creating the wrapper on the fork
32-
- SEND_HOLDER=0x...: address to impersonate for upgrade/downgrade test
33-
- RUN_CFA_SMOKE=true: run optional CFA lifecycle smoke test
34-
35-
References (Rule 3: mirror official examples; no custom Solidity)
36-
- SuperTokenFactory: https://docs.superfluid.finance/superfluid/protocol-developers/supertokens/supertokenfactory
37-
- ISuperToken: https://github.com/superfluid-finance/protocol-monorepo/blob/dev/packages/ethereum-contracts/contracts/interfaces/superfluid/ISuperToken.sol
38-
- CFAv1: https://docs.superfluid.finance/superfluid/developers/constant-flow-agreement-cfa
39-
- Hardhat + Viem: https://github.com/NomicFoundation/hardhat-viem
13+
For warp.dev terminal guidance and command recipes, see WARP.md.

0 commit comments

Comments
 (0)