Skip to content

Commit 4faeac5

Browse files
authored
CIP-0034 | Adjust preamble and structure w.r.t CIP-0001 (cardano-foundation#690)
* first draft remediation of CIP-0034 * remove redundant line meeting up Status in header
1 parent 6b5a276 commit 4faeac5

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

CIP-0034/README.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
---
22
CIP: 34
33
Title: Chain ID Registry
4-
Authors: Sebastien Guillemot <[email protected]>
5-
Comments-URI: No comments
6-
Status: Draft
7-
Type: Informational
4+
Status: Proposed
5+
Category: Tools
6+
Authors:
7+
- Sebastien Guillemot <[email protected]>
8+
Implementors: []
9+
Discussions:
10+
- https://github.com/cardano-foundation/CIPs/pull/158
11+
- https://github.com/cardano-foundation/CIPs/pull/332
12+
- https://github.com/cardano-foundation/CIPs/pull/412
813
Created: 2021-11-24
914
License: CC-BY-4.0
1015
---
@@ -13,17 +18,13 @@ License: CC-BY-4.0
1318

1419
Currently Cardano has two easily-usable networks: "mainnet" and "testnet". However, in the future, we expect more networks to exist and so we need some way to refer to these networks to be able to write better multi-network applications and systems.
1520

16-
## Terminology
17-
18-
### Existing network IDs
21+
## Motivation: why is this CIP necessary?
1922

2023
Cardano currently has three ways to refer to a network:
2124
- The "network ID" included in every address and also optionally present in the transaction body. This only stores 16 possibilities (4 bits)
2225
- The "network magic" used for Byron addresses and in the handshake with other nodes in the network layer. This is a random 32-bit number
2326
- The genesis block hash (a 28-byte number)
2427

25-
## Motivation
26-
2728
Blockchains can have multiple deployments of the same codebase. For example:
2829

2930
1. Test networks where the base asset has no value (so devs can test at no cost)
@@ -54,15 +55,21 @@ When representing these networks in a human-readable string, the following forma
5455
cip34:NetworkId-NetworkMagic
5556
```
5657

57-
# Rationale
58+
# Rationale: how does this CIP achieve its goals?
5859

5960
We pick this format for the following reason:
6061
- The network ID is too small to be used by itself. You can see from [chainlist](https://chainlist.org/) that 16 possibilities is too few
6162
- The genesis hash is too long and user-unfriendly to be used.
6263

63-
# Reference implementation
64+
## Path to Active
65+
66+
### Acceptance Criteria
67+
68+
- [ ] There are at least two (from different providers) wallets, libraries, CLI packages, or other tools which use this standard for network identification.
69+
70+
### Implementation Plan
6471

65-
[CIP34-JS](https://www.npmjs.com/package/@dcspark/cip34-js)
72+
- [x] Develop and publish reference implementation: [CIP34-JS](https://www.npmjs.com/package/@dcspark/cip34-js)
6673

6774
## Copyright
6875

0 commit comments

Comments
 (0)