Skip to content

docs: add compile-time constants tutorial and tested example - #13

Open
jusungxpark wants to merge 1 commit into
fleet-sdk:masterfrom
jusungxpark:bounty/compile-time-constants
Open

docs: add compile-time constants tutorial and tested example#13
jusungxpark wants to merge 1 commit into
fleet-sdk:masterfrom
jusungxpark:bounty/compile-time-constants

Conversation

@jusungxpark

Copy link
Copy Markdown

Adds a focused compile-time constants tutorial for milestone 9 of #8. It explains a typed compiler map using an offline time-lock example, shows the generated ErgoTree/address and output candidate, and distinguishes fixed parameters from box/context data. The chapter explicitly describes the anyone-can-spend condition and the limits of the offline example.

Includes an isolated, version-pinned runnable example and five compiler/builder checks. The documentation snippet and displayed output are checked against the executed example. Developed with AI assistance.

Validation: cd examples/compile-time-constants && npm ci && npm start && npm test (five passing tests). VitePress 1.4.3 production build passed.

The published milestone reward is 125 SigUSD; confirmation of current availability and payout terms was requested in the issue.

@socket-security

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Added@​fleet-sdk/​compiler@​0.12.0711006785100
Added@​fleet-sdk/​serializer@​0.11.0781007284100
Added@​fleet-sdk/​core@​0.12.0771009984100

View full report

@socket-security

Copy link
Copy Markdown

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action Severity Alert  (click "▶" to expand/collapse)
Warn High
Obfuscated code: npm @noble/hashes is 90.0% likely obfuscated

Confidence: 0.90

Location: Package overview

From: examples/compile-time-constants/package-lock.jsonnpm/@fleet-sdk/core@0.12.0npm/@fleet-sdk/serializer@0.11.0npm/@fleet-sdk/compiler@0.12.0npm/@noble/hashes@1.8.0

ℹ Read more on: This package | This alert | What is obfuscated code?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support@socket.dev.

Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/@noble/hashes@1.8.0. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn High
Obfuscated code: npm @noble/hashes is 90.0% likely obfuscated

Confidence: 0.90

Location: Package overview

From: examples/compile-time-constants/package-lock.jsonnpm/@fleet-sdk/core@0.12.0npm/@fleet-sdk/serializer@0.11.0npm/@fleet-sdk/compiler@0.12.0npm/@noble/hashes@1.8.0

ℹ Read more on: This package | This alert | What is obfuscated code?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support@socket.dev.

Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/@noble/hashes@1.8.0. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

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.

1 participant