Uh oh!
There was an error while loading. Please reload this page.
feat: make cdp env vars optional in next templates - #468
Merged
Conversation
✅ Heimdall Review Status
|
CarsonRoscoe
marked this pull request as ready for review
February 27, 2025 17:11
CarsonRoscoeforce-pushed
the
fix/ts-cli-optional-env-vars
branch
from
February 27, 2025 19:16
785443f to
fb1add6CompareCarsonRoscoeforce-pushed
the
fix/ts-cli-optional-env-vars
branch
from
February 28, 2025 16:27
fb1add6 to
92af3c8Compare0xRAG
reviewed
Feb 28, 2025
Uh oh!
There was an error while loading. Please reload this page.
0xRAG
reviewed
Feb 28, 2025
Comment on lines
+115
to
+116
| const canUseCdpApi = process.env.CDP_API_KEY_NAME && process.env.CDP_API_KEY_PRIVATE_KEY; | ||
| if (canUseCdpApi) { |
Contributor
There was a problem hiding this comment.
not blocking, but this feels like a smell to me. It seems like logic that should live in the CLI if possible, and not in the produced code. WDYT?
ContributorAuthor
There was a problem hiding this comment.
Limitation of the cli at this moment. I have a backlog ticket to refactor it to use a proper templating engine, which would give me the flexibility to handle this appropriately.
I'm hoping to prioritize that refactor early next week so I can clean up any branching logic in the routes
0xRAG
approved these changes
Feb 28, 2025
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What changed?
The CLI commands for scaffolding a next application made the CDP env vars a requirement. This PR makes them optional for every scenario other than the CDP Wallet Provider case.
Why was this change implemented?
While we should encourage users to use CDP and it's a better dev experience to quickly have a faucet running, that should not be forced upon users. If they chose a network that the CDP faucet does not support, and decided not to seek out the CDP keys for that reason, they should not encounter runtime errors because we forced in the
CdpApiActionProviderinto their stack by default.However, we still want the fluid devx. We still want the .env file to guide users to the CDP dashboard, and we want them to still receive the
CdpApiActionProviderby default if they do.This PR attempts to strike a balance between creating a nice devx, and giving builders flexibility out of the gate.
Checklist
How has it been tested?
Notes to reviewers