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

feat(cli/docs): introduce devnet quickstart guide #1080

Merged
merged 8 commits into from
May 22, 2024
Merged

Conversation

idea404
Copy link
Contributor

@idea404 idea404 commented May 21, 2024

Introduces scaffolding hello-world-template to CLI as default (and using --template flag) and the quickstart page to the docs

task: https://app.asana.com/0/1206208509925075/1207372351528365/f

@idea404 idea404 marked this pull request as ready for review May 21, 2024 13:50
Copy link

Docs preview complete 🚀 see it here: https://omni-o7i2r5uac-omni-engineering.vercel.app

@idea404 idea404 changed the title Idea404/hello-world feat(cli/docs): introduce devnet quickstart guide May 21, 2024
cli/cmd/develop.go Outdated Show resolved Hide resolved
docs/site/docs/develop/quickstart/quickstart.md Outdated Show resolved Hide resolved
Comment on lines 98 to 100
omni_evm: 0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82
mock_op: 0xa513E6E4b8f2a923D98304ec87F64353C4D5C853
mock_arb: 0xa513E6E4b8f2a923D98304ec87F64353C4D5C853
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe worth getting these to be same across each chain - what are we doing differently on omnievm

Copy link
Contributor

Choose a reason for hiding this comment

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

At some point we could also show devs how to use our create3 factories here

Copy link
Contributor

Choose a reason for hiding this comment

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

What would be the usecase?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll use a different anvil key as the default, this is nonce+predeploy related

Copy link
Contributor

Choose a reason for hiding this comment

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

Use case would be so devs can get consistent addrs across chain - using create3 would show them how they could

Copy link

Docs preview complete 🚀 see it here: https://omni-eszlsupjo-omni-engineering.vercel.app

Copy link

Docs preview complete 🚀 see it here: https://omni-popio8ynj-omni-engineering.vercel.app

Copy link

Docs preview complete 🚀 see it here: https://omni-5eqizs0gh-omni-engineering.vercel.app

Copy link

Docs preview complete 🚀 see it here: https://omni-h0w11jrx4-omni-engineering.vercel.app

cli/cmd/flags.go Outdated
@@ -24,6 +24,10 @@ func bindAVSAddress(cmd *cobra.Command, addr *string) {
cmd.Flags().StringVar(addr, "avs-address", *addr, "Optional address of the Omni AVS contract")
}

func bindDeveloperForgeProjectConfig(cmd *cobra.Command, cfg *developerForgeProjectConfig) {
cmd.Flags().StringVar(&cfg.templateURL, "template", "https://github.com/omni-network/hello-world-template.git", "URL of the forge template to use")
Copy link
Contributor

Choose a reason for hiding this comment

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

This works - that way they can use any template they like. But we could also just use the name of it, and try to fetch https://github.com/omni-network/{template}.git

Copy link

Docs preview complete 🚀 see it here: https://omni-nw2s5pzlq-omni-engineering.vercel.app

@@ -70,3 +87,21 @@ func checkForgeInstalled() bool {

return err == nil // If there is no error, forge is installed.
}

// sanitizeInput validates and sanitizes the input to prevent command injection.
func sanitizeInput(input string) (string, error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to do this? They're running this on their own machine.

Also if we are askibng for urls shouldnt' ths allow :

Copy link
Contributor Author

Choose a reason for hiding this comment

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

true that was me fighting the pre-commit runner without questioning it

Copy link

Docs preview complete 🚀 see it here: https://omni-kw3gy2n4o-omni-engineering.vercel.app

@idea404 idea404 merged commit fdc49c4 into main May 22, 2024
13 checks passed
@idea404 idea404 deleted the idea404/hello-world branch May 22, 2024 09:40
idea404 added a commit that referenced this pull request May 22, 2024
bumps buildinfo version two versions higher as the there has been an
intermediate release (static portal addresses for CLI) and current
version includes new scaffolding functionality (seen in #1080)

task: https://app.asana.com/0/1206208509925075/1207372351528365/f
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.

3 participants