-
Notifications
You must be signed in to change notification settings - Fork 22
Documentation of deployment history #305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: v3-outline
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
mkflow27
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the graphics that are added. They certainly provide helpful visual information about what contract version are the most current one. What do you think about:
- Adding a reference link to the deployments repo so that readers can navigate there easily?
- somehow linking or at least making it clear what the relationship between factory and pool is? As a reader I know that V3 ReClamm Pool V2 is the latest Reclamm pool, but the factory that deploys this pool is also relevant for me if I want to make sure I know the right contract to create the pool from, right?
# Conflicts: # docs/developer-reference/contracts/buffer-router-api.md # docs/developer-reference/contracts/composite-liquidity-router-api.md
We also have the contract registry, which lets you look up the current standard factory for "WeightedPool," (or one for a particular version), which is an on-chain way to do that (which a UI could also call).
See the comment above, plus it is pretty much always Factory, by convention. I can add comments and more explanation, vs. just having the raw images. |
I used to maintain this manually (Excalidraw), but there are so many things to track now! There's now an easy way to generate a diagram of whatever subset of deployments we want; here I have V3 pools and routers. We can also do V2, mix V2 and V3, etc.
This is an example; see the generator in PR #336 in the deployments repo.