Merge branch 'master' into CIP-123-Metadata

Author: rphair

.github/CIP-TEMPLATE.md

@@ -7,22 +7,21 @@ Authors:
     - John Doe <[email protected]>
 Implementors: []
 Discussions:
-    - https://github.com/cardano-foundation/cips/pulls/?
+    - https://github.com/cardano-foundation/CIPs/pull/?
 Created: YYYY-MM-DD
 License: CC-BY-4.0
 ---
 
 <!-- Existing categories:
 
-- Meta                   | For meta-CIPs which typically serves another category or group of categories.
-- Reward-Sharing Schemes | For CIPs discussing the reward & incentive mechanisms of the protocol.
-- Wallets                | For standardisation across wallets (hardware, full-node or light).
-- Tokens                 | About tokens (fungible or non-fungible) and minting policies in general.
-- Metadata               | For proposals around metadata (on-chain or off-chain).
-- Tools                  | A broad category for ecosystem tools not falling into any other category.
-- Plutus                 | Changes or additions to Plutus
-- Ledger                 | For proposals regarding the Cardano ledger
-- Catalyst               | For proposals affecting Project Catalyst / the Jörmungandr project
+- Meta     | For meta-CIPs which typically serves another category or group of categories.
+- Wallets  | For standardisation across wallets (hardware, full-node or light).
+- Tokens   | About tokens (fungible or non-fungible) and minting policies in general.
+- Metadata | For proposals around metadata (on-chain or off-chain).
+- Tools    | A broad category for ecosystem tools not falling into any other category.
+- Plutus   | Changes or additions to Plutus
+- Ledger   | For proposals regarding the Cardano ledger (including Reward Sharing Schemes)
+- Catalyst | For proposals affecting Project Catalyst / the Jörmungandr project
 
 -->
 
@@ -33,7 +32,7 @@ License: CC-BY-4.0
 <!-- A clear explanation that introduces the reason for a proposal, its use cases and stakeholders. If the CIP changes an established design then it must outline design issues that motivate a rework. For complex proposals, authors must write a Cardano Problem Statement (CPS) as defined in CIP-9999 and link to it as the `Motivation`. -->
 
 ## Specification
-<!-- The technical specification should describe the proposed improvement in sufficient technical detail. In particular, it should provide enough information that an implementation can be performed solely on the basis of the design in the CIP. This is necessary to facilitate multiple, interoperable implementations. -->
+<!-- The technical specification should describe the proposed improvement in sufficient technical detail. In particular, it should provide enough information that an implementation can be performed solely on the basis of the design in the CIP. This is necessary to facilitate multiple, interoperable implementations. This must include how the CIP should be versioned, if not covered under an optional Versioning main heading. If a proposal defines structure of on-chain data it must include a CDDL schema in its specification.-->
 
 ## Rationale: how does this CIP achieve its goals?
 <!-- The rationale fleshes out the specification by describing what motivated the design and what led to particular design decisions. It should describe alternate designs considered and related work. The rationale should provide evidence of consensus within the community and discuss significant objections or concerns raised during the discussion.
@@ -47,10 +46,12 @@ It must also explain how the proposal affects the backward compatibility of exis
 <!-- Describes what are the acceptance criteria whereby a proposal becomes 'Active' -->
 
 ### Implementation Plan
-<!-- A plan to meet those criteria. Or `N/A` if not applicable. -->
+<!-- A plan to meet those criteria or `N/A` if an implementation plan is not applicable. -->
+
+<!-- OPTIONAL SECTIONS: see CIP-0001 > Document > Structure table -->
 
 ## Copyright
-<!-- The CIP must be explicitly licensed under acceptable copyright terms. -->
+<!-- The CIP must be explicitly licensed under acceptable copyright terms.  Uncomment the one you wish to use (delete the other one) and ensure it matches the License field in the header: -->
 
-[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
-[Apache-2.0]: http://www.apache.org/licenses/LICENSE-2.0
+<!-- This CIP is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). -->
+<!-- This CIP is licensed under [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0). -->

.github/CPS-TEMPLATE.md

@@ -7,21 +7,21 @@ Authors:
     - John Doe <[email protected]>
 Proposed Solutions: []
 Discussions:
-    - https://github.com/cardano-foundation/cips/pulls/?
+    - https://github.com/cardano-foundation/CIPs/pull/?
 Created: YYYY-MM-DD
+License: CC-BY-4.0
 ---
 
 <!-- Existing categories:
 
-- Meta                   | For meta-CIPs which typically serves another category or group of categories.
-- Reward-Sharing Schemes | For CIPs discussing the reward & incentive mechanisms of the protocol.
-- Wallets                | For standardisation across wallets (hardware, full-node or light).
-- Tokens                 | About tokens (fungible or non-fungible) and minting policies in general.
-- Metadata               | For proposals around metadata (on-chain or off-chain).
-- Tools                  | A broad category for ecosystem tools not falling into any other category.
-- Plutus                 | Changes or additions to Plutus
-- Ledger                 | For proposals regarding the Cardano ledger
-- Catalyst               | For proposals affecting Project Catalyst / the Jörmungandr project
+- Meta     | For meta-CIPs which typically serves another category or group of categories.
+- Wallets  | For standardisation across wallets (hardware, full-node or light).
+- Tokens   | About tokens (fungible or non-fungible) and minting policies in general.
+- Metadata | For proposals around metadata (on-chain or off-chain).
+- Tools    | A broad category for ecosystem tools not falling into any other category.
+- Plutus   | Changes or additions to Plutus
+- Ledger   | For proposals regarding the Cardano ledger (including Reward Sharing Schemes)
+- Catalyst | For proposals affecting Project Catalyst / the Jörmungandr project
 
 -->
 
@@ -43,3 +43,11 @@ Finally, goals may also serve as evaluation metrics to assess how good a propose
 
 ## Open Questions
 <!-- A set of questions to which any proposed solution should find an answer. Questions should help guide solutions design by highlighting some foreseen vulnerabilities or design flaws. Solutions in the form of CIP should thereby include these questions as part of their 'Rationale' section and provide an argued answer to each. -->
+
+<!-- OPTIONAL SECTIONS: see CIP-9999 > Specification > CPS > Structure table -->
+
+## Copyright
+<!-- The CPS must be explicitly licensed under acceptable copyright terms.  Uncomment the one you wish to use (delete the other one) and ensure it matches the License field in the header: -->
+
+<!-- This CPS is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). -->
+<!-- This CPS is licensed under [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0). -->

.github/workflows/cip10-validation.yaml

@@ -0,0 +1,30 @@
+name: CIP-10 - Validate Registry JSON on Pull Request
+
+on:
+  pull_request:
+    paths:
+      - 'CIP-0010/registry.json'
+
+jobs:
+  approve: # Pre-approval step
+    runs-on: ubuntu-latest
+    steps:
+    - name: Approve
+      run: echo For security reasons, all pull requests need to be approved first before running any automated CI.
+
+  validate-json:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '21'
+
+    - name: Install dependencies
+      run: npm install ajv-cli
+
+    - name: Validate JSON against schema
+      run: npx ajv validate -s CIP-0010/registry.schema.json -d CIP-0010/registry.json  > /dev/null