feat(rust): Upgrade the Catalyst Key Id to be a more general Catalyst ID which can be used both as a Key ID and a registration ID. #159

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.

Sign up for GitHub

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

Jump to bottom

Merged

stevenj merged 26 commits into main from feat/cat-kid-to-cat-id

Jan 24, 2025

Collaborator

stevenj commented Jan 19, 2025

Description

Enhances and generalizes the Catalyst Key ID to a Catlayst ID which can be used in different contexts interchangably.

Description of Changes

See docs in PR

Breaking Changes

Yes, totally different type.
Original type removed.

Please confirm the following checks

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream module

stevenj added 4 commits

January 17, 2025 15:15


          feat(docs): Enhance the catalyst rbac URI so it can be used as a gene…

d42b9a3

…ral identifier as well as a key identifier


          fix(rust): rename the kid_uri to just an id_uri to better reflect its…

e992aee

… type


          fix(rust): remove cruft

5bad43a


          feat(rust): New catalyst IdUri type to replace the more limited Kid

42a4a99

stevenj added enhancement review me F14 labels

stevenj self-assigned this

stevenj changed the title ~~Upgrade the Catalyst Key Id to be a more general Catalyst ID which can be used both as a Key ID and a registration ID.~~ feat(rust): Upgrade the Catalyst Key Id to be a more general Catalyst ID which can be used both as a Key ID and a registration ID.


          docs(docs): cleanup the project dict

5961bdd

Contributor

github-actions bot commented Jan 19, 2025

✅ Test Report | ${\color{lightgreen}Pass: 263/263}$ | ${\color{red}Fail: 0/263}$ |

Contributor

github-actions bot commented Jan 19, 2025

✅ Test Report | ${\color{lightgreen}Pass: 263/263}$ | ${\color{red}Fail: 0/263}$ |

stevenj requested review from Mr-Leshiy, apskhem, bkioshn, cong-or, neil-iohk, saibatizoku and stanislav-tkach

January 20, 2025 02:02

bkioshn reviewed

View reviewed changes

docs/src/architecture/08_concepts/rbac_id_uri/catalyst-id-uri.md Outdated Show resolved Hide resolved

docs/src/architecture/08_concepts/rbac_id_uri/catalyst-id-uri.md Outdated Show resolved Hide resolved

docs/src/architecture/08_concepts/rbac_id_uri/catalyst-id-uri.md Outdated Show resolved Hide resolved


          docs(docs): Replace <key> with a concrete valid example public key

22e0d29

Contributor

github-actions bot commented Jan 20, 2025

✅ Test Report | ${\color{lightgreen}Pass: 263/263}$ | ${\color{red}Fail: 0/263}$ |


          docs(docs): Fix documentation inconsistencies

1299f97

Contributor

github-actions bot commented Jan 20, 2025

✅ Test Report | ${\color{lightgreen}Pass: 263/263}$ | ${\color{red}Fail: 0/263}$ |

bkioshn reviewed

View reviewed changes

docs/src/architecture/08_concepts/rbac_id_uri/catalyst-id-uri.md Outdated Show resolved Hide resolved


          Update docs/src/architecture/08_concepts/rbac_id_uri/catalyst-id-uri.md

784ae1b

Co-authored-by: bkioshn <[email protected]>

stevenj added do not merge yet requires architect review labels

Contributor

github-actions bot commented Jan 20, 2025

✅ Test Report | ${\color{lightgreen}Pass: 263/263}$ | ${\color{red}Fail: 0/263}$ |


          fix(docs): Spelling issue

59a2ce4

Contributor

github-actions bot commented Jan 20, 2025

✅ Test Report | ${\color{lightgreen}Pass: 264/264}$ | ${\color{red}Fail: 0/264}$ |


          fix(rust): Fail correctly if converting from &[u8] and the data isn't…

a481394

… valid UTF8.

Mr-Leshiy previously approved these changes

View reviewed changes

Contributor

Mr-Leshiy left a comment

LGTM

Contributor

github-actions bot commented Jan 20, 2025

✅ Test Report | ${\color{lightgreen}Pass: 264/264}$ | ${\color{red}Fail: 0/264}$ |

Mr-Leshiy mentioned this pull request

Backend Tasks for Fund14 Readiness input-output-hk/catalyst-voices#1256

Closed

3 tasks

stanislav-tkach previously approved these changes

View reviewed changes

rust/catalyst-types/src/id_uri/key_rotation.rs Outdated Show resolved Hide resolved

neil-iohk reviewed

View reviewed changes

Contributor

neil-iohk left a comment

Just one item, around validation of nonce, the two separate paths have different validation behavior which could lead to inconsistent state, validation only happens during parsing, direct construction with with_specific_nonce bypasses validation and subsequent serialization would not catch invalid values.

rust/catalyst-types/src/id_uri/mod.rs Outdated Show resolved Hide resolved

stevenj added 3 commits

January 21, 2025 22:54


          docs(rust): fix comment

4435c5c


          docs(docs): add nsecs to project dictionary

70cb89d


          fix(rust): clamp a specific nonce, in case it was attempted to be set…

fc39558

… out of range.

stevenj dismissed stale reviews from stanislav-tkach and Mr-Leshiy via

fc39558

January 21, 2025 15:56


          Merge branch 'main' into feat/cat-kid-to-cat-id

74e7881

Contributor

github-actions bot commented Jan 22, 2025

✅ Test Report | ${\color{lightgreen}Pass: 273/273}$ | ${\color{red}Fail: 0/273}$ |

stevenj and others added 2 commits

January 23, 2025 14:50


          docs(rust): improve documentation of a number of public functions in …

1ab9e14

…the `IdUri` type.


          Merge branch 'main' into feat/cat-kid-to-cat-id

994d79c

stevenj requested review from Mr-Leshiy, neil-iohk and stanislav-tkach

January 23, 2025 07:53

Mr-Leshiy previously approved these changes

View reviewed changes

Contributor

Mr-Leshiy left a comment

LGTM

stevenj and others added 3 commits

January 24, 2025 16:02


          Merge branch 'main' into feat/cat-kid-to-cat-id

c8f7737


          fix(rust): Fix doc test


          Merge branch 'feat/cat-kid-to-cat-id' of github.com:input-output-hk/c…

c03ed5b

…atalyst-libs into feat/cat-kid-to-cat-id

stevenj dismissed Mr-Leshiy’s stale review via

c03ed5b

January 24, 2025 13:04


          Merge branch 'main' into feat/cat-kid-to-cat-id

c3bc9a1

Contributor

github-actions bot commented Jan 24, 2025

✅ Test Report | ${\color{lightgreen}Pass: 282/282}$ | ${\color{red}Fail: 0/282}$ |

Contributor

github-actions bot commented Jan 24, 2025

✅ Test Report | ${\color{lightgreen}Pass: 282/282}$ | ${\color{red}Fail: 0/282}$ |

stevenj merged commit aabb994 into main

22 checks passed

stevenj deleted the feat/cat-kid-to-cat-id branch

January 24, 2025 15:48

Mr-Leshiy mentioned this pull request

Role Based Access Control (RBAC) input-output-hk/catalyst-voices#1691

Closed

10 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Mr-Leshiy Mr-Leshiy left review comments

saibatizoku Awaiting requested review from saibatizoku

apskhem Awaiting requested review from apskhem

cong-or Awaiting requested review from cong-or

bkioshn Awaiting requested review from bkioshn

neil-iohk Awaiting requested review from neil-iohk

stanislav-tkach Awaiting requested review from stanislav-tkach

Labels

do not merge yet enhancement F14 requires architect review review me