Merge pull request #18 from core-coin/update/v3-01

V3
core-coin · Oct 31, 2023 · 2bab618 · 2bab618
2 parents 5586790 + d004b25
commit 2bab618
Show file tree

Hide file tree

Showing 49 changed files with 1,090 additions and 292 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -2,7 +2,7 @@ blank_issues_enabled: false
 contact_links:
   - name: Community Discussion
     url: https://coretalk.space/tags/cip
-    about: Share your CIP comments in Talk \#CIP
+    about: Share your CIP comments in Core Talk — CIP
   - name: Security Bugs
     url: https://dev.coreblockchain.net/report-bug/
     about: Please report security vulnerabilities here.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ You can begin by opening your proposal under the [issues section of this reposit
 
 ### Review
 
-- [What is CIP](/docs/what-is-cip)
+- [What is a CIP](/docs/what-is-cip)
 - [CIP rationale](/docs/cip-rationale)
 - [CIP categories](/docs/cip-categories)
 - [CIP workflow](/docs/cip-workflow)
@@ -17,8 +17,12 @@ You can begin by opening your proposal under the [issues section of this reposit
 
 ### How to start
 
-1. Review the template [cip-0](https://github.com/core-coin/cip/blob/master/cip/docs/cip-0.md)
-2. [Create a CIP in the Online Editor](https://github.com/core-coin/cip/new/master?filename=cip/cip-0.md&message=CIP%20Proposal&description=CIP%20Proposal%20Draft&value=---%0Acip%3A%20%0Atitle%3A%20%0Aauthor%3A%20%0Alang%3A%20en-US%0Atag%3A%20draft%0Acategory%3A%20%0Adate%3A%202022-12-01%0A---%0A%3C%21--Introduction--%3E%0A%0A%3C%21--truncate--%3E%0A%0A%23%23%20Abstract%0A%0A%0A%0A%23%23%20Motivation%0A%0A%0A%0A%23%23%20Specification%0A%0A%0A%0A%23%23%20Rationale%0A%0A%0A%0A%23%23%20Backwards%20Compatibility%0A%0A%0A%0A%23%23%20Test%20Cases%0A%0A%0A%0A%23%23%20Implementation%0A%0A%0A%0A%23%23%20Security%20Considerations%0A%0A%0A%0A%23%23%20Copyright%0A%0ACopyright%20and%20related%20rights%20waived%20via%20%5BCC0%5D%28https%3A%2F%2Fcreativecommons.org%2Fpublicdomain%2Fzero%2F1.0%2F%29.%0A)
+Begin by contributing to the [issues section of this repository](https://github.com/core-coin/cip/issues/new/choose). Once done, you'll be able to draft a CIP using the associated issue number (if available).
+
+**Next steps:**
+
+1. Review the template [cip-0](/docs/cip-0.md)
+2. [Create a CIP in the Online Editor](https://github.com/core-coin/cip/new/master?filename=cip/cip-0.md&message=CIP%20Proposal&description=CIP%20Proposal%20Draft&value=---%0Acip%3A%20%0Atitle%3A%20%0Adescription%3A%20%0Akeywords%3A%20%5B%5D%0Aauthor%3A%20%0Alang%3A%20en-US%0Atags%3A%20%5Bdraft%5D%0Acategories%3A%20%5B%5D%0Adate%3A%202022-12-01%0Adiscussions-to%3A%20%0A---%0A%3C%21--Introduction--%3E%0A%0A%3C%21--truncate--%3E%0A%0A%23%23%20Abstract%0A%0A%0A%0A%23%23%20Motivation%0A%0A%0A%0A%23%23%20Specification%0A%0A%0A%0A%23%23%20Rationale%0A%0A%0A%0A%23%23%20Backwards%20Compatibility%0A%0A%0A%0A%23%23%20Test%20Cases%0A%0A%0A%0A%23%23%20Implementation%0A%0A%0A%0A%23%23%20Security%20Considerations%0A%0A%0A%0A%23%23%20Copyright%0A%0ACopyright%20and%20related%20rights%20waived%20via%20%5BCC0%5D%28https%3A%2F%2Fcreativecommons.org%2Fpublicdomain%2Fzero%2F1.0%2F%29.%0A)
 
 Or
 
@@ -50,11 +54,3 @@ CIPs are categorized into various types, each with its own list:
 
 - [Core ◆ Talk](https://coretalk.space/tags/cip)
 - [GH Issues](https://github.com/core-coin/cip/issues)
-
-## License of the content
-
-[CC0 “No Rights Reserved”](https://creativecommons.org/share-your-work/public-domain/cc0/)
-
-## License of the app
-
-[CORE License](LICENSE)
diff --git a/cip/cbc/.gitkeep b/cip/cbc/.gitkeep
diff --git a/cip/cip-100.md → cip/cbc/cip-100.md b/cip/cip-100.md → cip/cbc/cip-100.md
@@ -1,12 +1,13 @@
 ---
 cip: 100
 title: ICAN
+description: International Crypto Account Number
+keywords: [cip, cip-100, ican, international, crypto, account, number]
 author: Rastislav Vašička (@[email protected])
 lang: en-US
-tag: final
-category: cbc
+tags: [final]
+categories: [cbc]
 date: 2022-01-02
-star: true
 ---
 We are introducing a standard for crypto addresses — ICAN — with HRP and checksum, similar to what we are all using for current financial transactions. ICAN stands for International Crypto Account Number.
 Only hexadecimal characters are used to minimize the size of the address in the Blockchain storage.

diff --git a/cip/cip-20.md → cip/cbc/cip-20.md b/cip/cip-20.md → cip/cbc/cip-20.md
@@ -1,12 +1,13 @@
 ---
 cip: 20
 title: Token Standard
+description: A standard interface for tokens.
+keywords: [cip, cip-20, token, standard]
 author: Mojtaba
 lang: en-US
-tag: final
-category: cbc
+tags: [final]
+categories: [cbc]
 date: 2022-05-28
-star: true
 ---
 A standard interface for tokens.
 
@@ -27,6 +28,7 @@ A standard interface allows any tokens on Core to be re-used by other applicatio
 #### Methods
 
 **NOTES**:
+
 - The following specifications use syntax from Ylem `0.8.4` (or above).
 - Callers MUST handle `false` from `returns (bool success)`. They MUST NOT assume that `false` is never returned!
 

diff --git a/cip/core/.gitkeep b/cip/core/.gitkeep
diff --git a/cip/cip-98.md → cip/core/cip-98.md b/cip/cip-98.md → cip/core/cip-98.md
@@ -1,10 +1,12 @@
 ---
 cip: 98
 title: Core Cryptography Scheme
+description: The cryptography scheme employed in the Core Blockchain.
+keywords: [cip, cip-98, cryptography, scheme, core, blockchain]
 author: Dmitry (@todesstile)
 lang: en-US
-tag: final
-category: core
+tags: [final]
+categories: [core]
 date: 2022-06-16
 ---
 This standard details the cryptography scheme employed in the Core Blockchain.
@@ -45,22 +47,22 @@ If the most significant bit of the last byte (little endian) of the private key
 
 Given that the `privateKey` is represented by `byte[57]`, the overarching scheme can be elucidated as follows:
 
-```
+```go
 if (privateKey[56] & 0x80 == 0x00) {
-         // Most significant bit of the last byte equals 0, process as usual:
-         output = SHAKE256(privateKey, 114)
-         left = output[0:57]
-         right = output[57:114]
-         // ....
+        // Most significant bit of the last byte equals 0, process as usual:
+        output = SHAKE256(privateKey, 114)
+        left = output[0:57]
+        right = output[57:114]
+        // ....
 } else {
-         // Most significant bit of the last byte equals 1:
-         scalar = privateKey
-         scalar[0] &= 0xfc
-         scalar[56] = 0
-         scalar[55] |= 0x80
-         left = scalar
-         right = scalar
-         // then proceed as usual
+        // Most significant bit of the last byte equals 1:
+        scalar = privateKey
+        scalar[0] &= 0xfc
+        scalar[56] = 0
+        scalar[55] |= 0x80
+        left = scalar
+        right = scalar
+        // then proceed as usual
 }
 ```
 

diff --git a/cip/cip-99.md → cip/core/cip-99.md b/cip/cip-99.md → cip/core/cip-99.md
@@ -1,10 +1,12 @@
 ---
 cip: 99
 title: Core HD-Wallet Scheme
+description: The HD-wallet derivation scheme for Core Coin.
+keywords: [cip, cip-99, hd-wallet, scheme, core, coin]
 author: Dmitry (@todesstile)
 lang: en-US
-tag: final
-category: core
+tags: [final]
+categories: [core]
 date: 2022-06-16
 ---
 This standard outlines the HD-wallet derivation scheme for Core Coin.
@@ -39,15 +41,15 @@ An extended key is represented by a [114]byte array. It is derived from `chainco
 
 The master key forms the root of the HD-derivation tree. It can be derived from mnemonics using a slightly modified version of the BIP39 scheme. You should adhere to this scheme until obtaining the seed (BIP39 Seed). The master key can then be derived as:
 
-```
+```go
 chain = H(seed, "mnemonicforthechain")
 key = H(seed, "mnemonicforthekey")
 masterKey = chain || key
 ```
 
 For enhanced security, you should:
 
-```
+```txt
 set the most significant bit of the last byte to 1 (masterKey[113] |= 0x80)
 set the most significant bit of the next-to-last byte to 1 (masterKey[112] |= 0x80)
 clear the second significant bit of the next-to-last byte (masterKey[112] &= 0xbf)
@@ -61,35 +63,35 @@ You can always generate `pubKey` from `privKey`. This operation will be denoted
 
 Child chaincode generation varies between usual and hardened keys. For a usual key:
 
-```
+```go
 pubKey = private2public(privKey)
 childChain = H(0x03 || pubKey || i , chain), where i < 2^31
 ```
 
 For a hardened key:
 
-```
+```go
 childChain = H(0x01 || privKey || i , chain), where i >= 2^31
 ```
 
 ### Child Pair Generation: Private Key to Private Key
 
 Child private key generation also differs between usual and hardened keys. For a usual key:
 
-```
+```go
 pubKey = private2public(privKey)
 template = H(0x02 || pubKey || i , chain), where i < 2^31
 ```
 
 For a hardened key:
 
-```
+```go
 template = H(0x00 || privKey || i , chain), where i >= 2^31
 ```
 
 Next, nullify the top 4 bytes and the last 2 bits of the template for security reasons, resulting in the `clampedTemplate = clamp(template)`. Then, the child `privKey` can be computed as:
 
-```
+```go
 childPrivKey = privKey + clampedTemplate
 ```
 
@@ -105,14 +107,14 @@ It is impossible to generate a child public key from a hardened public key, whic
 
 However, usual child public keys can be derived from a usual parent public key. First, calculate the `clampedTemplate` as described above:
 
-```
+```go
 template = H(0x02 || publicKey || i , chain), where i < 2^31
 template -> clampedTemplate
 ```
 
 Next, compute a point on Ed448 corresponding to the `clampedTemplate` and add it to the `publicKey` using point addition for Ed448:
 
-```
+```go
 point = private2public(clampedTemplate)
 childPublicKey = publicKey +++ point
 ```

diff --git a/cip/informational/.gitkeep b/cip/informational/.gitkeep
diff --git a/cip/interface/.gitkeep b/cip/interface/.gitkeep
diff --git a/cip/meta/.gitkeep b/cip/meta/.gitkeep
diff --git a/cip/networking/.gitkeep b/cip/networking/.gitkeep
diff --git a/docs/cip-0.md b/docs/cip-0.md
@@ -1,14 +1,30 @@
 ---
+title: CIP-0 example
+description: CIP-0 example template
+author: Core Foundation
+comment: false
+date: 2022-01-01
+sidebar_position: 7
+---
+**Frontmatter:**
+
+```yaml
+---
 cip: 0
 title: CIP-0 example
+description: CIP-0 example template
+keywords: [cip, cip-0, example, template]
 author: Author (@[email protected])
 lang: en-US
-tag: draft
-category: example
+tags: [draft]
+categories: [example]
 date: 2022-01-01
-sidebar_position: 7
+discussions-to: <URL>
+requires: <CIP number(s)> # Only required when you reference an CIP in the `Specification` section. Otherwise, remove this field.
 ---
-> This is the suggested template for new CIPs. Note that a CIP number will be assigned by an editor. When opening a pull request to submit your CIP, please use an abbreviated title in the filename, `cip-ID.md`, where "ID" is the CIP ID. The title should be 44 characters or fewer.
+```
+
+> This is the suggested template for new CIPs. Note that a CIP number will be assigned by an editor. When opening a pull request to submit your CIP, please, use an abbreviated title in the filename, `cip-ID.md`, where "ID" is the CIP ID. The title should be 44 characters or fewer.
 
 > Provide a simplified and layperson-accessible explanation of the CIP.
 
@@ -44,7 +60,7 @@ sidebar_position: 7
 
 ## Security Considerations
 
-> All CIPs must contain a section discussing the security implications and considerations relevant to the proposed change. This section should provide details important for security discussions, highlight potential risks, and be referenced throughout the lifecycle of the proposal. CIP submissions lacking the "Security Considerations" section will be rejected. A CIP cannot proceed to "Final" status without a Security Considerations discussion deemed satisfactory by the reviewers.
+> All CIPs must contain a section discussing the security implications and considerations relevant to the proposed change. This section should provide details important for security discussions, highlight potential risks, and be referenced throughout the lifecycle of the proposal. CIP submissions lacking the "Security Considerations" section will be rejected. A CIP cannot proceed to the "Final" status without a Security Considerations discussion deemed satisfactory by the reviewers.
 
 ## Copyright
 

diff --git a/docs/cip-categories.md b/docs/cip-categories.md
@@ -1,12 +1,7 @@
 ---
 title: CIP Categories
-isOriginal: true
 author: Core Foundation
 date: 2022-01-01
-category:
-  - tutorial
-tag:
-  - tutorial
 comment: false
 sidebar_position: 4
 ---

diff --git a/docs/cip-editors.md b/docs/cip-editors.md
@@ -1,12 +1,7 @@
 ---
 title: CIP Editors
-isOriginal: true
 author: Core Foundation
 date: 2022-01-01
-category:
-  - tutorial
-tag:
-  - tutorial
 comment: false
 sidebar_position: 6
 ---

diff --git a/docs/cip-rationale.md b/docs/cip-rationale.md
@@ -1,12 +1,7 @@
 ---
 title: CIP Rationale
-isOriginal: true
 author: Core Foundation
 date: 2022-01-01
-category:
-  - tutorial
-tag:
-  - tutorial
 comment: false
 sidebar_position: 3
 ---

diff --git a/docs/cip-workflow.md b/docs/cip-workflow.md
@@ -1,12 +1,7 @@
 ---
 title: CIP Work Flow
-isOriginal: true
 author: Core Foundation
 date: 2022-01-01
-category:
-  - tutorial
-tag:
-  - tutorial
 comment: false
 sidebar_position: 5
 ---
@@ -53,11 +48,11 @@ Every stage transition requires the CIP author's request and subsequent approval
 - **Deferred**: For core CIPs postponed for an upcoming hard fork.
 - **Rejected**: Either a fundamentally flawed CIP or a Core CIP declined by Core Devs.
 - **Active**: Similar to Final, but can undergo updates without changing the CIP number.
-- **Superseded**: A once-final CIP no longer represents the zenith. Another "Final" CIP references the outdated one.
+- **Superseeded**: A once-final CIP no longer represents the zenith. Another "Final" CIP references the outdated one.
 
 ## Pillars of a Successful CIP
 
-Each CIP should encapsulate
+Each CIP should encapsulate:
 
 - **Preamble**: RFC 822 headers detailing CIP metadata.
 - **Simple Summary**: An easy-to-understand synopsis.

diff --git a/docs/cip.md b/docs/cip.md
@@ -1,12 +1,7 @@
 ---
 title: Core Improvement Proposals
-isOriginal: true
 author: Core Foundation
 date: 2022-01-01
-category:
-  - tutorial
-tag:
-  - tutorial
 comment: false
 sidebar_position: 1
 ---
@@ -20,7 +15,7 @@ You can begin by opening your proposal under the [issues section of this reposit
 
 ### Review
 
-- [What is CIP](/docs/what-is-cip)
+- [What is a CIP](/docs/what-is-cip)
 - [CIP rationale](/docs/cip-rationale)
 - [CIP categories](/docs/cip-categories)
 - [CIP workflow](/docs/cip-workflow)
@@ -29,8 +24,12 @@ You can begin by opening your proposal under the [issues section of this reposit
 
 ### How to start
 
-1. Review the template [cip-0](https://github.com/core-coin/cip/blob/master/cip/docs/cip-0.md)
-2. [Create a CIP in the Online Editor](https://github.com/core-coin/cip/new/master?filename=cip/cip-0.md&message=CIP%20Proposal&description=CIP%20Proposal%20Draft&value=---%0Acip%3A%20%0Atitle%3A%20%0Aauthor%3A%20%0Alang%3A%20en-US%0Atag%3A%20draft%0Acategory%3A%20%0Adate%3A%202022-12-01%0A---%0A%3C%21--Introduction--%3E%0A%0A%3C%21--truncate--%3E%0A%0A%23%23%20Abstract%0A%0A%0A%0A%23%23%20Motivation%0A%0A%0A%0A%23%23%20Specification%0A%0A%0A%0A%23%23%20Rationale%0A%0A%0A%0A%23%23%20Backwards%20Compatibility%0A%0A%0A%0A%23%23%20Test%20Cases%0A%0A%0A%0A%23%23%20Implementation%0A%0A%0A%0A%23%23%20Security%20Considerations%0A%0A%0A%0A%23%23%20Copyright%0A%0ACopyright%20and%20related%20rights%20waived%20via%20%5BCC0%5D%28https%3A%2F%2Fcreativecommons.org%2Fpublicdomain%2Fzero%2F1.0%2F%29.%0A)
+Begin by contributing to the [issues section of this repository](https://github.com/core-coin/cip/issues/new/choose). Once done, you'll be able to draft a CIP using the associated issue number (if available).
+
+**Next steps:**
+
+1. Review the template [cip-0](/docs/cip-0.md)
+2. [Create a CIP in the Online Editor](https://github.com/core-coin/cip/new/master?filename=cip/cip-0.md&message=CIP%20Proposal&description=CIP%20Proposal%20Draft&value=---%0Acip%3A%20%0Atitle%3A%20%0Adescription%3A%20%0Akeywords%3A%20%5B%5D%0Aauthor%3A%20%0Alang%3A%20en-US%0Atags%3A%20%5Bdraft%5D%0Acategories%3A%20%5B%5D%0Adate%3A%202022-12-01%0Adiscussions-to%3A%20%0A---%0A%3C%21--Introduction--%3E%0A%0A%3C%21--truncate--%3E%0A%0A%23%23%20Abstract%0A%0A%0A%0A%23%23%20Motivation%0A%0A%0A%0A%23%23%20Specification%0A%0A%0A%0A%23%23%20Rationale%0A%0A%0A%0A%23%23%20Backwards%20Compatibility%0A%0A%0A%0A%23%23%20Test%20Cases%0A%0A%0A%0A%23%23%20Implementation%0A%0A%0A%0A%23%23%20Security%20Considerations%0A%0A%0A%0A%23%23%20Copyright%0A%0ACopyright%20and%20related%20rights%20waived%20via%20%5BCC0%5D%28https%3A%2F%2Fcreativecommons.org%2Fpublicdomain%2Fzero%2F1.0%2F%29.%0A)
 
 Or
 

diff --git a/docs/what-is-cip.md b/docs/what-is-cip.md
@@ -1,12 +1,7 @@
 ---
 title: What is a CIP
-isOriginal: true
 author: Core Foundation
 date: 2022-01-01
-category:
-  - tutorial
-tag:
-  - tutorial
 comment: false
 sidebar_position: 2
 ---