Skip to content

Commit 8d7aa1e

Browse files
authored
CIP-0095 | Misspelling of DeprecatedCertificate (#875)
* Correcting a typo in implementation details for error types for CIP-0095 Minor wording improvements to the standard committed alongside. * CIP-0095 | Reordered the newly introduced DRep data types to make their dependency clearer The ordering now matches the order in CIP-0105. Also updated the first paragraph to a more expressive wording.
1 parent 76d0698 commit 8d7aa1e

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

CIP-0095/README.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ For the many contributors to this proposal, see [Acknowledgements](#acknowledgem
4444
## Motivation: why is this CIP necessary?
4545

4646
CIP-1694 introduces many new concepts, entities and actors to Cardano;
47-
describing their implementation at the ledger level. Yet, for most ecosystem
48-
participants low level details are abstracted away by tooling. Creating a need
49-
for such tooling, to allow the utilization of new ledger features. This
50-
specification allows for creation of web-based tools for the utilization of
51-
CIP-1694's governance features.
47+
describing their implementation at the ledger level. This creates the need for
48+
new tooling with respect to governance. For the average ecosystem participant,
49+
the details should be abstracted away, enabling them to leverage the new ledger
50+
features more effectively. This specification allows for creation of web-based
51+
tools for the utilization of CIP-1694's governance features.
5252

5353
Whilst CIP-30 facilitated the launch of dApp development on Cardano, it's
5454
functionality is limited in scope. It was written well before the emergence of
@@ -123,24 +123,24 @@ extending the API (as a plain integer, without padding). For example:
123123

124124
#### CIP-95 Data Types
125125

126-
#### DRepID
126+
##### PubDRepKey
127127

128128
```ts
129-
type DRepID = string;
129+
type PubDRepKey = string;
130130
```
131131

132-
A hex-encoded string representing a registered DRep's ID which is a Blake2b-224
133-
hash digest of a 32 byte Ed25519 public key, as described in
134-
[CIP-1694 Registered DReps](https://github.com/cardano-foundation/CIPs/blob/430f64d3e86dd67903a6bf1e611c06e5343072f3/CIP-1694/README.md#registered-dreps).
132+
A hex-encoded string representing 32 byte Ed25519 DRep public key, as described
133+
in [CIP-0105 | Conway Era Key Chains for HD Wallets](https://github.com/cardano-foundation/CIPs/blob/master/CIP-0105/README.md).
135134

136-
##### PubDRepKey
135+
#### DRepID
137136

138137
```ts
139-
type PubDRepKey = string;
138+
type DRepID = string;
140139
```
141140

142-
A hex-encoded string representing 32 byte Ed25519 DRep public key, as described
143-
in [CIP-0105 | Conway Era Key Chains for HD Wallets](https://github.com/cardano-foundation/CIPs/blob/master/CIP-0105/README.md).
141+
A hex-encoded string representing a registered DRep's ID which is a Blake2b-224
142+
hash digest of the above mentioned 32 byte Ed25519 public key, as described in
143+
[CIP-1694 Registered DReps](https://github.com/cardano-foundation/CIPs/blob/430f64d3e86dd67903a6bf1e611c06e5343072f3/CIP-1694/README.md#registered-dreps).
144144

145145
##### PubStakeKey
146146

@@ -154,7 +154,7 @@ credential.
154154
### Error Types
155155

156156
For the methods described in
157-
[Governance Extension API](#governance-extension-api), we inherent APIError,
157+
[Governance Extension API](#governance-extension-api), we inherit APIError,
158158
DataSignError and TxSignError from
159159
[CIP-30's Error Types](https://github.com/cardano-foundation/CIPs/tree/master/CIP-0030#error-types).
160160

@@ -195,13 +195,13 @@ type APIError {
195195

196196
We repurpose this error type from CIP-30, extending it's functionality. We
197197
extend the `ProofGeneration` error code to also include cases where DRep secret
198-
key is not available. We also add one new error code `DepreciatedCertificate`.
198+
key is not available. We also add one new error code `DeprecatedCertificate`.
199199

200200
```ts
201201
TxSignErrorCode = {
202202
ProofGeneration: 1,
203203
UserDeclined: 2,
204-
DepreciatedCertificate: 3,
204+
DeprecatedCertificate: 3,
205205
};
206206
type TxSignError = {
207207
code: TxSignErrorCode;
@@ -213,8 +213,8 @@ type TxSignError = {
213213
unable to sign the transaction. This is because the wallet does have some of
214214
the private keys required.
215215
- `UserDeclined` - User declined to sign the transaction.
216-
- `DepreciatedCertificate` - Returned regardless of user consent if the
217-
transaction contains a depreciated certificate.
216+
- `DeprecatedCertificate` - Returned regardless of user consent if the
217+
transaction contains a deprecated certificate.
218218

219219
#### [DataSignError](https://github.com/cardano-foundation/CIPs/tree/master/CIP-0030#datasignerror)
220220

@@ -381,8 +381,8 @@ should be able to be recognized by supporting wallets.
381381
382382
##### Unsupported Inspection
383383
384-
In the Conway ledger era two certificate types are depreciated `genesis_key_delegation` and `move_instantaneous_rewards_cert`.
385-
If the wallet receives a transaction containing a depreciated certificate it should return a `TxSignError` with an error code of `DepreciatedCertificate`.
384+
In the Conway ledger era two certificate types are deprecated `genesis_key_delegation` and `move_instantaneous_rewards_cert`.
385+
If the wallet receives a transaction containing a deprecated certificate it should return a `TxSignError` with an error code of `DeprecatedCertificate`.
386386
387387
| Index | Unsupported Pre-Conway Certificates |
388388
| ----- | ----------------------------------- |
@@ -411,7 +411,7 @@ endpoint before building the final transaction.
411411
| `APIError` | `AccountChange` | `true` or `false` | Returned if wallet has changed account, meaning connection should be reestablished. |
412412
| `TxSignError` | `ProofGeneration` | `false` | Returned if user has accepted transaction to sign, but the wallet is unable to sign because it does not have the required key(s). |
413413
| `TxSignError` | `UserDeclined` | `true` or `false` | Returned if user has declined to sign the transaction. |
414-
| `TxSignError` | `DepreciatedCertificate` | `true` or `false` | Returned regardless of user consent if the transaction contains a depreciated certificate. |
414+
| `TxSignError` | `DeprecatedCertificate` | `true` or `false` | Returned regardless of user consent if the transaction contains a deprecated certificate. |
415415
<!-- prettier-ignore-stop -->
416416
417417
If `partialSign` is `true`, the wallet only tries to sign what it can. If
@@ -556,7 +556,7 @@ wallet has already been made via
556556
3. **Inspect and Sign:** The app passes the transaction to the wallet via
557557
`.signTx()`. The wallet inspects the content of the transaction, informing
558558
the user of the client app's intension. If the user confirms that they are
559-
happy to sign, the wallet returns the appropriate witnesses, of payment key
559+
willing to sign, the wallet returns the appropriate witnesses, of payment key
560560
and stake key.
561561
4. **Submit:** The app will add the provided witnesses into the transaction body
562562
and then pass the witnessed transaction back to the wallet for submission via
@@ -635,7 +635,7 @@ CIP-1694; Ada holders and DReps, this decision was three fold. Primarily, this
635635
is to allow these groups to utilize a web-based client to participate in
636636
Cardano's governance. These groups are likely less comfortable utilizing
637637
command-line interfaces than other groups, thus making alternatives from them is
638-
a priority. Secondly, the other types of actor (constitution committee member
638+
a priority. Secondly, the other types of actor (constitutional committee members
639639
and SPOs) are identified by different credentials than Ada holders and DReps,
640640
making their integration in this specification more complex. These alternative
641641
credentials are unlikely to be stored within standard wallet software which may
@@ -666,7 +666,7 @@ cold key setup. Hot and cold keys are not suited for standard light wallets.
666666
667667
Genesis key delegation and move instantaneous reward certificates (see in
668668
[Shelley spec](https://github.com/IntersectMBO/cardano-ledger/blob/0738804155245062f05e2f355fadd1d16f04cd56/shelley-ma/shelley-ma-test/cddl-files/shelley-ma.cddl#L117#L118))
669-
are not supported here because they have been depreciated in the Conway ledger
669+
are not supported here because they have been deprecated in the Conway ledger
670670
era. Furthermore, due to the lack of accessibility (require access to genesis
671671
keys) for these certificates it is extremely unlikely any CIP-30 implementations
672672
supported these.

0 commit comments

Comments
 (0)