Skip to content
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

📝 docs: organize config.mts #108

Merged
merged 2 commits into from
Sep 20, 2023

Conversation

Sabnock01
Copy link
Contributor

  • Organizes the actions in alphabetical order (viem.sh also uses alphabetical ordering of actions)
  • Creates and adds missing pages to index (will implement those once this is merged; plenty of empty pages already exist)
  • Fixes a typo in the sidebar for simulateWithdrawERC20

Let me know if we prefer another name to the General category under Utilities for functions like resolveL1OpStackContractAddress.

@vercel
Copy link

vercel bot commented Sep 18, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
op-viem-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 20, 2023 5:16am

@Sabnock01
Copy link
Contributor Author

Decided writeOpStackL1 and resolveL1OpStackContractAddressshould be included in this PR.

@wilsoncusack
Copy link
Collaborator

Thanks for this! I was unsure if we wanted to expose writeOpStackL1, I think it is not currently exported. Got some feedback the name was confusing and there was some debate if this function is worth having (I currently think it probably is). Any thoughts @Sabnock01 ?

text: 'General',
items: [
{
text: 'resolveL1OpStackContractAddress',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is internal and we don't need to export

@Sabnock01
Copy link
Contributor Author

Sabnock01 commented Sep 19, 2023

Thanks for this! I was unsure if we wanted to expose writeOpStackL1, I think it is not currently exported. Got some feedback the name was confusing and there was some debate if this function is worth having (I currently think it probably is). Any thoughts @Sabnock01 ?

I am fine with exporting writeOpStackL1 and leaving resolveL1OpStackContractAddress as internal.

wilsoncusack
wilsoncusack previously approved these changes Sep 19, 2023
@wilsoncusack
Copy link
Collaborator

Thanks for this! I was unsure if we wanted to expose writeOpStackL1, I think it is not currently exported. Got some feedback the name was confusing and there was some debate if this function is worth having (I currently think it probably is). Any thoughts @Sabnock01 ?

I am fine with exporting writeOpStackL1 and leaving resolveL1OpStackContractAddress ad internal.

ok, let's do that then. I also wonder if writeOpStackL1Contract might be a more clear naming.

@Sabnock01
Copy link
Contributor Author

Thanks for this! I was unsure if we wanted to expose writeOpStackL1, I think it is not currently exported. Got some feedback the name was confusing and there was some debate if this function is worth having (I currently think it probably is). Any thoughts @Sabnock01 ?

I am fine with exporting writeOpStackL1 and leaving resolveL1OpStackContractAddress ad internal.

ok, let's do that then. I also wonder if writeOpStackL1Contract might be a more clear naming.

I think it is. Want to rename to both writeOpStackL1Contract and writeOpStackL2Contract?

@wilsoncusack
Copy link
Collaborator

@Sabnock01 I am open to this but let's make it a different PR. Maybe this one can just be the reorg and we can punt on writeOpStackL1 and plan to not have docs or export resolve...

@wilsoncusack wilsoncusack merged commit 548c233 into base-org:main Sep 20, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants