web5-js icon indicating copy to clipboard operation
web5-js copied to clipboard

`@web5/agent` DWN + Web5 RPC Clients

Open LiranCohen opened this issue 4 months ago • 3 comments

WIP waiting on agent refactoring this is based on.

  • organize rpc clients into agent/prototyping/clients until they have a permanent home
  • copy JsonRpcSocket class from @web5/dwn-server, using isomorphic-ws to allow for isomorphic socket client.
  • create WebSocketDwnRpcClient and WebSocketWeb5RpcClient to support web5 requests over sockets.

LiranCohen avatar Feb 29 '24 03:02 LiranCohen

TBDocs Report

🛑 Errors: 0 ⚠️ Warnings: 7

@web5/api

  • Project entry file: packages/api/src/index.ts
📄 File: ./packages/api/src/record.ts
⚠️ extractor:typedoc:missing-docs: Record.tags (GetSignature) does not have any documentation.

@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
📄 File: ./packages/credentials/src/verifiable-credential.ts
⚠️ extractor:typedoc:missing-docs: CredentialSchema.__type.id (Property) does not have any documentation.
⚠️ extractor:typedoc:missing-docs: CredentialSchema.__type.type (Property) does not have any documentation.

TBDocs Report Updated at 2024-04-30T15:21:47Z 308f325

github-actions[bot] avatar Apr 01 '24 21:04 github-actions[bot]

Codecov Report

Merging #433 (35f19db) into main (c8e6fa8) will increase coverage by 0.24%. Report is 2 commits behind head on main. The diff coverage is 86.96%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #433      +/-   ##
==========================================
+ Coverage   90.55%   90.80%   +0.24%     
==========================================
  Files         112      116       +4     
  Lines       29085    29383     +298     
  Branches     2078     2150      +72     
==========================================
+ Hits        26338    26680     +342     
+ Misses       2712     2668      -44     
  Partials       35       35              
Components Coverage Δ
agent 79.90% <86.96%> (+1.07%) :arrow_up:
api 97.89% <ø> (+<0.01%) :arrow_up:
common 98.68% <ø> (ø)
credentials 95.21% <ø> (ø)
crypto 93.81% <ø> (ø)
dids 97.65% <ø> (ø)
identity-agent 96.70% <ø> (ø)
crypto-aws-kms 100.00% <ø> (ø)
proxy-agent 96.70% <ø> (ø)
user-agent 96.70% <ø> (ø)

codecov-commenter avatar Apr 01 '24 21:04 codecov-commenter

🦋 Changeset detected

Latest commit: 308f3256d423e204efe55950cf258d30921734eb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@web5/agent Patch
@web5/identity-agent Patch
@web5/proxy-agent Patch
@web5/user-agent Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

changeset-bot[bot] avatar Apr 05 '24 13:04 changeset-bot[bot]

Thanks @shamilovtim!

Only real comment is that the transportProtocols method seems possibly superfluous (are we worried someone would import HTTPWeb5RpcClient and try to use it to do something that's not HTTP?)

Yeah I agree this pattern is a little weird, it was already there before the socket stuff, so I just kept it for the sake of not introducing too much change, but I feel like this should likely take on a different pattern at some point.

LiranCohen avatar Apr 30 '24 19:04 LiranCohen