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

Update Web5 agent and API packages to latest crypto and dids versions #445

Merged
merged 72 commits into from
Mar 29, 2024

Conversation

frankhinek
Copy link
Contributor

@frankhinek frankhinek commented Mar 12, 2024

Summary

This PR will:

  • Refactor @web5/agent, @web5/user-agent, @web5/proxy-agent, @web5/identity-agent, and @web5/api to use the latest releases of @web5/common, @web5/crypto, and @web5/dids.
  • Update @tbd54566975/dwn-sdk-js dependency to v0.2.18 in the agent package.
  • Removes @tbd54566975/dwn-sdk-js as a dependency from the api package so that the DWN SDK versions can no longer diverge. All DWN related functionality now comes from agent package.
  • Bump agent, user-agent, proxy-agent and identity-agent to v0.3.0
  • Bump api to v0.9.0
  • Bump dwn-server dev dependency version to v0.1.11

Fixes #317
Fixes #440

@frankhinek frankhinek self-assigned this Mar 12, 2024
@frankhinek frankhinek added package: api @web5/api pacakge package: agent @web5/agent package labels Mar 12, 2024
@frankhinek frankhinek added this to the @web5/api 0.9 milestone Mar 12, 2024
Copy link
Contributor

github-actions bot commented Mar 12, 2024

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 4

@web5/api

  • Project entry file: packages/api/src/index.ts

@web5/crypto

  • Project entry file: packages/crypto/src/index.ts

@web5/crypto-aws-kms

  • Project entry file: packages/crypto-aws-kms/src/index.ts
📄 File: ./packages/crypto-aws-kms/src/ecdsa.ts
⚠️ extractor:typedoc:missing-docs: EcdsaAlgorithm (Class) does not have any documentation.
📄 File: ./packages/crypto-aws-kms/src/key-manager.ts
⚠️ extractor:typedoc:missing-docs: AwsKeyManager (Class) does not have any documentation.
📄 File: ./packages/crypto-aws-kms/src/utils.ts
⚠️ extractor:typedoc:missing-docs: getKeySpec (CallSignature) does not have any documentation.
🔀 Misc.
⚠️ extractor:typedoc:invalid-link: Failed to resolve link to "@web5/crypto#Secp256k1.adjustSignatureToLowS | here" in comment for EcdsaAlgorithm.sign. You may have wanted "@web5/crypto!Secp256k1.adjustSignatureToLowS | here"

@web5/dids

  • Project entry file: packages/dids/src/index.ts

@web5/credentials

  • Project entry file: packages/credentials/src/index.ts

TBDocs Report Updated at 2024-03-29T18:58:58Z 69ae3a1

Copy link

codecov bot commented Mar 15, 2024

Codecov Report

Merging #445 (d987909) into main (91d52aa) will decrease coverage by 2.85%.
The diff coverage is 78.99%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #445      +/-   ##
==========================================
- Coverage   93.37%   90.53%   -2.85%     
==========================================
  Files          80      112      +32     
  Lines       23955    29028    +5073     
  Branches     1924     2076     +152     
==========================================
+ Hits        22369    26281    +3912     
- Misses       1541     2712    +1171     
+ Partials       45       35      -10     
Components Coverage Δ
agent 78.86% <78.99%> (-9.86%) ⬇️
api 97.89% <ø> (+0.77%) ⬆️
common 98.68% <ø> (ø)
credentials 94.69% <ø> (ø)
crypto 93.81% <ø> (ø)
dids 97.65% <ø> (ø)
identity-agent 96.70% <ø> (+39.88%) ⬆️
crypto-aws-kms 100.00% <ø> (ø)
proxy-agent 96.70% <ø> (+38.27%) ⬆️
user-agent 96.70% <ø> (+41.48%) ⬆️

packages/agent/src/dwn-api.ts Outdated Show resolved Hide resolved
packages/agent/src/dwn-api.ts Outdated Show resolved Hide resolved
packages/agent/src/sync-api.ts Outdated Show resolved Hide resolved
packages/dev-env/docker-compose.yaml Outdated Show resolved Hide resolved
Copy link
Member

@LiranCohen LiranCohen left a comment

Choose a reason for hiding this comment

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

I meant to leave a comment and request changes in the previous review.

I looked over the files I'm more familiar with and found some small comments/copy-pasta, but otherwise everything looks great!

Also the version of the dev-env container. Other than that mostly relying on tests!

But this is a great effort!!

@frankhinek frankhinek requested a review from LiranCohen March 18, 2024 22:54
@shamilovtim
Copy link
Contributor

I am not seeing this inheritDoc JSDoc stuff pull through with documentation in my editor:
Screenshot 2024-03-21 at 7 17 08 PM

tenant?: string;
}

export interface DidMethodCreateOptions<TKeyManager> {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this default to a KeyManager like all of the other interfaces do?

*/
private _agent?: Web5PlatformAgent;

private _didMethods: Map<string, DidMethodApi> = new Map();
Copy link
Contributor

Choose a reason for hiding this comment

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

Trying to figure out how to use this. If two methods are declared here what does it do? Maybe a comment for all of the params would help understand what to do with all of them

frankhinek and others added 25 commits March 29, 2024 14:49
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
@frankhinek frankhinek merged commit c11b5ff into main Mar 29, 2024
9 of 10 checks passed
@frankhinek frankhinek deleted the agent-crypto-dids branch March 29, 2024 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: agent @web5/agent package package: api @web5/api pacakge
Projects
None yet
6 participants