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

Update to CCF Specification 1.0 #7

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

fxamacker
Copy link
Member

@fxamacker fxamacker commented Oct 22, 2024

This PR updates CCF Specs to version 1.0 and matches the deployed version of CCF Codec.

Primarily, this PR adds new Cadence types and other updates to match changes in Cadence:

Other changes in this PR:

  • Update copyright for Flow Foundation.
  • Added "Version: 1.0.0" and removed "Revision".
  • Removed "Status: RC3" and "Status of this Document".
  • Update "Scope" to highlight some scope-related items earlier:
    • Some requirements are explicitly defined as optional.
    • CCF-based formats or protocols MUST specify when optional requirements are used.
    • "Deterministic CCF Encoding Requirements" is optional so individual formats and protocols MUST specify when to use it (as previously stated deeper in this document).

Note

Scope of specs hasn't changed because the added text only highlights what is stated deeper inside the document.

Changes:
- Update copyright for Flow Foundation.
- Removed "Status: RC3"
- Added "Version: 1.0.0" and removed "Revision".
- Update "Scope" to highlight some scope-related items earlier:
  - Some requirements are explicitly defined as optional.
  - CCF-based formats or protocols MUST specify when optional
requirements are used.
  - "Deterministic CCF Encoding Requirements" is optional so
    individual formats and protocols MUST specify when to use it
    (as previously stated deeper in this document).
@fxamacker fxamacker added the documentation Improvements or additions to documentation label Oct 22, 2024
@fxamacker fxamacker self-assigned this Oct 22, 2024
This update corresponds to Cadence PR 3107:
onflow/cadence#3107

This change does not affect CCF Codec because it 
was already implemented and deployed in the codec.
Copy link
Member

@turbolent turbolent left a comment

Choose a reason for hiding this comment

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

Nice!

This update corresponds to Cadence PR 3131:
onflow/cadence#3131

This change does not affect CCF Codec because it 
was already implemented and deployed in the codec.
@fxamacker fxamacker changed the title Update copyright and scope in ccf_specs.md Update to CCF Specification 1.0 Oct 23, 2024
This update corresponds to Cadence PR 2523 and subsequent changes to inclusiverange and inclusiverange-type:
onflow/cadence#2523

This change does not affect CCF Codec because it 
was already implemented and deployed in CCF codec.
This update corresponds to Cadence PR 3139:
onflow/cadence#3139

This change does not affect CCF Codec because it 
was already implemented and deployed in CCF codec.
This change does not affect CCF Codec because it 
was already implemented and deployed in CCF codec.
This change does not affect CCF Codec because it 
was already removed (deprecated) and deployed in CCF codec.
Copy link
Member

@turbolent turbolent left a comment

Choose a reason for hiding this comment

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

Great work! Thank you for bringing this up-to-date 👏

@turbolent turbolent requested review from SupunS and removed request for ramtinms November 15, 2024 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants