Skip to content
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.

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

refactor: ked -> sad, ident -> proto #312

Merged
merged 2 commits into from
Feb 18, 2025

Conversation

kentbull
Copy link
Collaborator

@kentbull kentbull commented Feb 18, 2025

Aligns with KERIpy naming usage of the "sad" self-addressing data label and "proto" protocol label. The "ked" label was overused compared to KERIpy.

This PR slightly refactors the Serder class to set properties in the constructor and removes the .ked property for now.

@kentbull kentbull requested review from lenkan and 2byrds February 18, 2025 05:03
Aligns with KERIpy naming usage of the "sad" self-addressing data label and "proto" protocol label. The "ked" label was overused compared to KERIpy.
Copy link

codecov bot commented Feb 18, 2025

Codecov Report

Attention: Patch coverage is 71.42857% with 24 lines in your changes missing coverage. Please review.

Project coverage is 83.64%. Comparing base (dbffa56) to head (dfb3c7d).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
src/keri/core/prefixer.ts 48.00% 11 Missing and 2 partials ⚠️
src/keri/core/serder.ts 67.85% 9 Missing ⚠️
src/keri/app/controller.ts 50.00% 1 Missing ⚠️
src/keri/core/eventing.ts 92.30% 1 Missing ⚠️

❌ Your patch status has failed because the patch coverage (70.73%) is below the target coverage (75.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #312      +/-   ##
==========================================
- Coverage   83.70%   83.64%   -0.06%     
==========================================
  Files          48       48              
  Lines        4270     4267       -3     
  Branches     1054     1067      +13     
==========================================
- Hits         3574     3569       -5     
- Misses        666      668       +2     
  Partials       30       30              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lenkan
Copy link
Collaborator

lenkan commented Feb 18, 2025

Out of curiosity, how did you come to the conclusion that ked was overused compared to keripy?

I did a search in the code, and it seems like ?erder.ked is used much more than ?erder.sad. Most uses of .sad seems to be in the tests.

@iFergal
Copy link
Contributor

iFergal commented Feb 18, 2025

I personally always use ked in keripy/keria

@kentbull
Copy link
Collaborator Author

@lenkan

how did you come to the conclusion that ked was overused compared to keripy?

It was just visual inspection. sad is more generalized to the Serder base class in KERIpy, ked is specific to SerderKERI.

@lenkan
Copy link
Collaborator

lenkan commented Feb 18, 2025

It was just visual inspection. sad is more generalized to the Serder base class in KERIpy, ked is specific to SerderKERI.

Fair enough. So because the Serder in signify-ts is not specific to keri, it makes more sense to use the generic term serializable attribute dictionary rather than key event dictionary ?

@kentbull
Copy link
Collaborator Author

Yes, those were my thoughts. I do plan to reintroduce .ked with SerderKERI as I add a full CESR parser to SignifyTS. So if we end up wanting to use it then it will be here soon enough 😄

@kentbull kentbull merged commit f59a9ba into WebOfTrust:main Feb 18, 2025
7 of 8 checks passed
@kentbull kentbull deleted the naming-cleanup-2 branch February 18, 2025 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants