-
Notifications
You must be signed in to change notification settings - Fork 486
Add initDevMode function with environment variable support #1133
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
Draft
Copilot
wants to merge
3
commits into
mainnet
Choose a base branch
from
copilot/set-test-consensus-heights-flag
base: mainnet
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| import { | ||
| initDevMode as initDevModeWasm, | ||
| } from "@provablehq/wasm/%%NETWORK%%.js"; | ||
|
|
||
| export { | ||
| Address, | ||
| Authorization, | ||
|
|
@@ -51,3 +55,50 @@ export { | |
| getOrInitConsensusVersionTestHeights, | ||
| verifyFunctionExecution, | ||
| } from "@provablehq/wasm/%%NETWORK%%.js"; | ||
|
|
||
| /** | ||
| * Initialize development mode by setting consensus version heights to [0..ConsensusVersion::latest()]. | ||
| * | ||
| * This function automatically sets up development consensus heights without requiring | ||
| * manual specification of the number of consensus versions. It should be called before | ||
| * initializing the thread pool when working with a local development network. | ||
| * | ||
| * @returns An array of block heights at which each consensus version applies. | ||
| * | ||
| * @example | ||
| * import { initDevMode, initThreadPool } from "@provablehq/sdk"; | ||
| * | ||
| * // Initialize dev mode before the thread pool | ||
| * initDevMode(); | ||
| * await initThreadPool(); | ||
| */ | ||
| export function initDevMode(): number[] { | ||
| return initDevModeWasm(); | ||
| } | ||
|
|
||
| /** | ||
| * Check if the ALEO_NETWORK environment variable is set to "local" and if so, | ||
| * automatically call initDevMode() to set up development consensus heights. | ||
| * | ||
| * This function is useful for Node.js applications that want to automatically | ||
| * detect when running against a local development network. | ||
| * | ||
| * @returns An array of block heights if dev mode was initialized, undefined otherwise. | ||
| * | ||
| * @example | ||
| * import { maybeInitDevMode, initThreadPool } from "@provablehq/sdk"; | ||
| * | ||
| * // Automatically initialize dev mode if ALEO_NETWORK=local | ||
| * maybeInitDevMode(); | ||
| * await initThreadPool(); | ||
| */ | ||
| export function maybeInitDevMode(): number[] | undefined { | ||
| try { | ||
| if (typeof process !== 'undefined' && process.env?.ALEO_NETWORK === 'local') { | ||
| return initDevModeWasm(); | ||
| } | ||
| } catch { | ||
| // Ignore errors when process is not available (e.g., in browsers) | ||
| } | ||
| return undefined; | ||
| } | ||
|
Comment on lines
+95
to
+104
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This process detection is inane. Node.ts already runs all node related code, so anything that is set by default can be set there. |
||
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
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.
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.
This extra wrapper doesn't add much, the wasm method itself is sufficient and can be exported directly.