-
Notifications
You must be signed in to change notification settings - Fork 34
Check SCSpecType is a superset of SCValType #314
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: SCSpecType Superset | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| check: | ||
| runs-on: ubuntu-slim | ||
| steps: | ||
| - uses: actions/checkout@v7 | ||
|
|
||
| - uses: actions/setup-node@v7 | ||
| with: | ||
| node-version: lts/* | ||
|
|
||
| - run: node .scripts/check-scspectype-superset.ts |
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 |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| // Every SCValType that can appear at a contract function boundary must be | ||
| // expressible in a contract spec, so SCSpecType needs a counterpart for it. | ||
| // The names line up by prefix: SCV_U32 -> SC_SPEC_TYPE_U32. | ||
|
|
||
| import { readFileSync } from "node:fs"; | ||
|
|
||
| // SCValType variants that cannot cross a contract function boundary, and so | ||
| // intentionally have no SCSpecType counterpart. | ||
| const EXCLUDED = [ | ||
| "CONTRACT_INSTANCE", | ||
| "LEDGER_KEY_CONTRACT_INSTANCE", | ||
| "LEDGER_KEY_NONCE", | ||
| ]; | ||
|
|
||
| const spec = readFileSync("Stellar-contract-spec.x", "utf8"); | ||
| const val = readFileSync("Stellar-contract.x", "utf8").match(/\bSCV_\w+/g) ?? []; | ||
|
|
||
| const missing = [...new Set(val.map((name) => name.slice("SCV_".length)))] | ||
| .filter((name) => !EXCLUDED.includes(name)) | ||
| .filter((name) => !new RegExp(`\\bSC_SPEC_TYPE_${name}\\b`).test(spec)); | ||
|
|
||
| if (missing.length > 0) { | ||
| console.log(` | ||
| SCValType variants with no SCSpecType counterpart: ${missing.map((n) => "SCV_" + n).join(", ")} | ||
|
|
||
| SCSpecType must be a superset of SCValType so that every value type usable at a | ||
| contract function boundary can be captured in a contract spec. Either add the | ||
| missing SCSpecType variant, or, if the value cannot cross a contract boundary, | ||
| add it to EXCLUDED in this script.`); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| console.log("SCSpecType covers every SCValType variant."); | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.