doc: Update READMEs to reflect the Base deployment - #316
Merged
Conversation
The root README still described the repo as hosting on optimism and listed folders that have since moved or been removed. Rewrite the overview around Base, drop the empty `likecoin` folder, mark `likenft` as the legacy optimism-era contracts and document the folders added since, `likecoin3`, `likecollective-indexer`, `likecollective-staking-position-image`, `op-2-base`, `cosmos-delegation`, `nft-tools` and `abi`. Correct a few facts while at it: - `veLikeReward` is legacy after rotation, per likecoin3/velike.md, so the reward pools now point there instead of being listed as live - `likecollective-indexer` indexes LikeCollective and LikeStakePosition, it has no veLike binding - only base and baseSepolia carry the full stack, the other chains in ignition only have the Likecoin ERC20 - `ENV=likeco` is not a valid env, the deploy note now uses `likeco-base` - contract deployment runs from `likecoin3` with create2, not from `likenft`
There was a problem hiding this comment.
Pull request overview
Updates repository documentation to reflect the Base deployment and the current repo structure, replacing outdated Optimism-era descriptions and adding guidance for contract/service development and deployment.
Changes:
- Rewrite root README to document Base live contracts, current folder structure, and local/dev workflows (contracts, ABIs, make targets, CI).
- Add a real project description to
likenft-indexer/README.md. - Clarify
deploy/README.mdscope (services vs contracts) and update deployment procedure/env examples for the Base-era setup.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Reframes repo overview around Base, updates folder map, local workflow notes, and contract/dev references. |
| likenft-indexer/README.md | Adds a concrete description of what the indexer does and how it’s configured. |
| deploy/README.md | Updates deployment notes to point to likecoin3/Ignition/CREATE2 and refreshes env/runbook details. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+18
to
+19
| `BookNFT` is not deployed directly, each book is a beacon proxy created through | ||
| `LikeProtocol`. |
Comment on lines
+135
to
+137
| > Both clean targets match volumes by the `likecoin-30` compose project prefix, | ||
| > so they only work when the repo is checked out into a `likecoin-3.0` | ||
| > directory. Under any other directory name they silently match nothing. |
Comment on lines
+141
to
+143
| For respective frontend, `likenft-migration`, `likecoin-migration` and | ||
| `migration-admin`, please navigate to respective folder and follow instruction | ||
| there. |
Comment on lines
+5
to
+8
| transfer memos without hitting the chain directly. It ingests EVM events, keeps | ||
| the NFT state in postgres and exposes it through an api. The chain and contract | ||
| address come from `ETH_NETWORK_EVENT_RPC_URL` and | ||
| `ETH_LIKE_PROTOCOL_CONTRACT_ADDRESS`, see `.env.example`. |
Comment on lines
+50
to
+51
| The `helm/{env}` value files and their Makefile are gitignored rather than | ||
| committed, see `.gitignore`, they provide helper and default for illustration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The root README still described the repo as hosting on optimism and listed folders that have since moved or been removed. Rewrite the overview around Base, drop the empty
likecoinfolder, marklikenftas the legacy optimism-era contracts and document the folders added since,likecoin3,likecollective-indexer,likecollective-staking-position-image,op-2-base,cosmos-delegation,nft-toolsandabi.Correct a few facts while at it:
veLikeRewardis legacy after rotation, per likecoin3/velike.md, so the reward pools now point there instead of being listed as livelikecollective-indexerindexes LikeCollective and LikeStakePosition, it has no veLike bindingENV=likecois not a valid env, the deploy note now useslikeco-baselikecoin3with create2, not fromlikenft