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

Fix CI and spec versions #182

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Conversation

FabijanC
Copy link
Contributor

@FabijanC FabijanC commented Dec 6, 2023

  • Fixes the CI
  • Unifies references to starknet_api_openrpc.json:
    • There were both ./api/starknet_api_openrpc.json and ./starknet_api_openrpc.json references; changed it to only use the former
    • In fact, validation was failing because of invalid refererences
  • Addresses the TODO in validate.js
    • No longer dependent on the cwd (e.g. works in both project root and in api/)
  • Closes Mismatched versions in specification files #181
    • As suggested in the issue I am using the package.json version as the source of truth.
    • This is open for discussion. I can change the name in package.json to maybe reflect the whole repository, not just the validation tooling (e.g. "name": "starknet_specs" instead of "name": "openrpc_scripts").
    • Alternatively, another source of truth can be used (e.g. env var or env file)
    • Changed "name": "openrpc_scripts" to "name": "starknet_specs" so that it reflects the whole repository, not just the validation tooling

Now that validation has been fixed, when running it locally, a validation error is reported in api/starknet_trace_api_openrpc.json:

[
  {
    "keyword": "additionalProperties",
    "dataPath": ".components.errors['TXN_HASH_NOT_FOUND']",
    "schemaPath": "#/additionalProperties",
    "params": {
      "additionalProperty": "$ref"
    },
    "message": "should NOT have additional properties"
  }
]

This change is Reviewable

@ArielElp ArielElp self-requested a review December 7, 2023 07:58
Copy link
Collaborator

@ArielElp ArielElp left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 5 of 5 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @FabijanC)

@FabijanC FabijanC marked this pull request as draft December 7, 2023 12:25
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.

Mismatched versions in specification files
2 participants