Skip to content

feat: high-level did helper api #881

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
merged 78 commits into from
Jul 24, 2024
Merged

feat: high-level did helper api #881

merged 78 commits into from
Jul 24, 2024

Conversation

rflechtner
Copy link
Contributor

@rflechtner rflechtner commented Jul 17, 2024 •
edited
Loading

fixes https://github.com/KILTprotocol/ticket/issues/3359

Adds a high-level did api for simplifying the most common DID management operations.

How to test:

Currently covered by integration- and unit tests; I'd suggest we release a beta after merging this to develop.

Checklist:

  • I have verified that the code works
  • I have verified that the code is easy to understand
    • If not, I have left a well-balanced amount of inline comments
  • I have left the code in a better state
  • I have documented the changes (where applicable)
    • Either PR or Ticket to update the Docs
    • Link the PR/Ticket here

@rflechtner rflechtner mentioned this pull request Jul 17, 2024
Closed
rflechtner and others added 29 commits July 17, 2024 12:51
@rflechtner
feat: create DID signers from signers or keypairs
22f79cc
@abdulmth @rflechtner
feat: transact first draft
d29002f
@rflechtner
feat: transact full-featured implementation
24eddba
@rflechtner
test: first unit test stub
70fa620
@rflechtner
test: commenting out require cycle that broke tests (REVERT ME)
90b9119
@rflechtner
test: some fixes to did helper tests
e90d302
@abdulmth @rflechtner
fix: checkresult
90d5ebe
@abdulmth @rflechtner
feat: createDid draft
8479b2c
@rflechtner
chore: add didNonce parameter
36b0cb5
@rflechtner
refactor: deduplicate transact logic
bb7fe33
@rflechtner
refactor: make createDid synchronous
ab417f7
@abdulmth @rflechtner
feat: draft set verification method
d91af94
@rflechtner
refactor: reorganize code
c1c6169
@abdulmth @rflechtner
fix: setVerificationMethod
23be55a
@abdulmth @rflechtner
feat: add service methods
0bbe3bf
@rflechtner
feat: implement claimWeb3Name
101ae79
@rflechtner
feat: implement releaseWeb3Name
44bf049
@rflechtner
fix: module error matching
a21b675
@rflechtner
test: integration tests for w3n helpers
07e0096
@rflechtner
test: add unit tests for addService & removeService
89b434b
@rflechtner
test: run service unit tests for fragment- and full ids
c207032
@rflechtner
fix: export service did helpers
2a3fa57
@rflechtner
test: service did helpers integration tests
f098ec1
@rflechtner
fix: setVerificationMethod extrinsics and logic (#878)
ec0978b 
* fix: make sure existing keyAgreement VMs are replaced
* fix: use correct extrinsic for assertionMethod
@abdulmth @rflechtner
feat: removeVM
7a55e99
@abdulmth @rflechtner
fix: documentation
ed974a3
@rflechtner
fix: export removeVerificationMethod
bc59831
@rflechtner
test: add verificationMethods unit tests
409e2d4
@rflechtner
fix: add x25519 to allowed public key 'type' values
c07e3ea
abdulmth and others added 22 commits July 22, 2024 09:43
@abdulmth
fix: transaction result serialization
385f66a
@abdulmth
fix: asFailed
f1eea0a
@abdulmth
Refactor checkResult() (#886)
8a9d808
@rflechtner
feat: generateKeypair helper
52e5f37
@rflechtner
refactor!: switch to using multikey encoding
035db97
@rflechtner
test: fix tests
2c26b02
@rflechtner
fix: add missing implementation on getSignersForKeypair
9f0819b
@rflechtner
test: use generateKeypair in did helpers integration tests
b00ada1
@abdulmth @rflechtner
Update packages/sdk-js/src/DidHelpers/checkResult.ts
e8c0654 
Co-authored-by: Raphael Flechtner <39338561+rflechtner@users.noreply.github.com>
@abdulmth
chore: improvement
1762a29
@abdulmth
feat: implement toJSON for root
975886d
@abdulmth
fix: lint
4b2718f
@rflechtner
chore: remove duplicated code
f473255
@abdulmth
fix: transaction result serialization (#888)
8de9ded
@rflechtner
chore: no magic numbers
fb44a82
@rflechtner
docs: improve docstrings
d69481d
@rflechtner
docs: streamline typings and add overload docstrings for en/decodeMul…
1bdf0d8 
…tibaseKeypair
@abdulmth
feat!: add generate keypair helper (#887)
57e6d8e
@rflechtner
refactor!: align issuer/holder interfaces (#889)
8b8c538 
* refactor: move did helpers interfaces to types
* refactor: make sure issuer/holder functions can work with did helpers
* chore: nitpicks
* refactor!: move issuer options use them on lower-level issue too
* test: fix unit tests
@abdulmth @rflechtner
fix: unsigned submittable (#890)
51e16da 
* fix: unsigned submittable
* fix: import
* fix: tests
* fix: merge issues
* fix: addressFromRandom
* chore: move test to integration
* fix: lint
* chore: use return in extractSubmitter

---------

Co-authored-by: Raphael Flechtner <raphael@kilt.io>
@rflechtner
fix: can't import utils in types
a25c05a
@rflechtner
fix: bundle tests
465e54b
@rflechtner rflechtner marked this pull request as ready for review July 24, 2024 12:08
@rflechtner
Copy link
Contributor Author

@Dudleyneedham & @ntn-x2 The Did helper implementation is now completed and all issues we found have been fixed. This PR gives you a chance to skim over the aggregated changes; I would would merge this to develop shortly and start preparing a beta release from there.
Things I would tackle via PRs to develop:

  • rewrite bundle tests to use the DidHelpers; this is equally a documentation- and a test task, as we'd write the bundle tests such that they run through everything that can be done with DidHelpers to provide code examples for Chris to work with in updating the docs
  • finalise the set of functions exported from sdk-js; we talked about adding CType stuff, and we considered removing the signAndSubmit.

@rflechtner
Copy link
Contributor Author

@Dudleyneedham & @ntn-x2 I'm not expecting a thorough review here, but you may want to skim over it and check that you are happy with the high-level changes

Dudleyneedham
Dudleyneedham approved these changes Jul 24, 2024
View reviewed changes
Copy link
Member

@Dudleyneedham Dudleyneedham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I personally would like to see some clean up in the future. There are some internal code that are messy. Due to time constraints I would consider this debt we have accumulated.

Secondly, after using and showing it to people it feels way better and more simple.

Great job guys.

Don't forget we need to expose the CType in the SDK js

@rflechtner rflechtner merged commit 21d05ab into develop Jul 24, 2024
18 checks passed
@rflechtner rflechtner deleted the rf-did-helpers branch July 24, 2024 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Dudleyneedham Dudleyneedham Dudleyneedham approved these changes

@ntn-x2 ntn-x2 Awaiting requested review from ntn-x2

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rflechtner @Dudleyneedham @abdulmth