requestNetwork icon indicating copy to clipboard operation
requestNetwork copied to clipboard

feat: add lit protocol provider and capacity credits delegation

Open rodrigopavezi opened this issue 1 year ago • 1 comments

Description of the changes

Implemented #1468

rodrigopavezi avatar Oct 24 '24 19:10 rodrigopavezi

Walkthrough

The changes in this pull request introduce new encryption formats and enhance the existing functionality of the Request Network SDK by integrating the Lit Protocol. Key modifications include the addition of the KMSMultiFormat and related classes for KMS encryption, updates to the RequestNetwork and HttpRequestNetwork classes to support a new cipherProvider parameter, and the introduction of methods for handling capacity delegation authorization signatures. Additionally, new packages for EPK and Lit Protocol ciphers are created, along with their corresponding configurations and documentation.

Changes

File Change Summary
packages/multi-format/src/encryption/encryption-format.ts Added KMSMultiFormat to encryptionFormats.
packages/multi-format/src/encryption/kms-format.ts Introduced KMSMultiFormat class for KMS encryption handling.
packages/request-client.js/src/api/request-network.ts Updated RequestNetwork constructor to include optional cipherProvider.
packages/request-client.js/src/http-data-access.ts Added getLitCapacityDelegationAuthSig method to HttpDataAccess.
packages/request-client.js/src/http-request-network.ts Updated HttpRequestNetwork constructor to include cipherProvider.
packages/request-node/package.json Added dependencies for Lit Protocol.
packages/request-node/src/request/getLitCapacityDelegationAuthSig.ts Introduced GetLitCapacityDelegationAuthSigHandler class for handling authorization signatures.
packages/request-node/src/requestNode.ts Added route for getLitCapacityDelegationAuthSig endpoint.
packages/smart-contracts/package.json Updated TypeChain dependencies.
packages/transaction-manager/README.md Updated documentation to reflect changes in decryption provider.
packages/transaction-manager/src/channel-parser.ts Added optional cipherProvider parameter to ChannelParser constructor.
packages/transaction-manager/src/transaction-manager.ts Updated TransactionManager constructor to include cipherProvider.
packages/transaction-manager/src/transactions-factory.ts Updated methods to handle multiple cipher providers.
packages/transaction-manager/src/transactions-parser.ts Added optional cipherProvider parameter to TransactionsParser constructor.
packages/types/package.json Added dependency for Lit Protocol types.
packages/types/src/data-access-types.ts Added getLitCapacityDelegationAuthSig method to IDataAccess interface.
packages/types/src/encryption-types.ts Added KMS method to encryption types.
packages/types/src/epk-provider-types.ts Introduced IEpkProvider interface for EPK providers.
packages/types/src/index.ts Added exports for EpkProviderTypes and CipherProviderTypes.
packages/types/src/multi-format-types.ts Added KMS_ENCRYPTED to prefix enum.
packages/utils/src/encryption.ts Enhanced documentation for encrypt and decrypt functions.
README.md Updated to include new packages for EPK and Lit Protocol ciphers.
packages/epk-cipher/... Introduced EPK cipher package with configurations, README, and tests.
packages/lit-protocol-cipher/... Introduced Lit Protocol cipher package with configurations, README, and tests.

Assessment against linked issues

Objective Addressed Explanation
Add Lit Protocol to the SDK (#1468)

[!WARNING]

Rate limit exceeded

@rodrigopavezi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 5f864849349e49c41fbacbb572ccee00f9dc7a53 and ce0d955f06d8a645751ae6f8b6a069556fecdb83.


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5f864849349e49c41fbacbb572ccee00f9dc7a53 and ce0d955f06d8a645751ae6f8b6a069556fecdb83.

📒 Files selected for processing (1)
  • packages/transaction-manager/test/unit/transactions-parser.test.ts (7 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/transaction-manager/test/unit/transactions-parser.test.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Oct 24 '24 19:10 coderabbitai[bot]

✅ Approved pending fix to the Usage section in Lit-provider package.

aimensahnoun avatar Nov 25 '24 20:11 aimensahnoun