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

Eas endpoints #15

Merged
merged 4 commits into from
Aug 26, 2024
Merged

Eas endpoints #15

merged 4 commits into from
Aug 26, 2024

Conversation

Behzad-rabiei
Copy link
Member

@Behzad-rabiei Behzad-rabiei commented Aug 26, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new endpoint for decrypting attestation secrets.
    • Added a Data Transfer Object (DTO) for handling attestation secret decryption requests.
    • Enhanced the EasService with new methods for data encoding and recipient validation.
  • Bug Fixes

    • Improved exception handling in the authentication service to reflect unauthorized access for invalid tokens.
  • Documentation

    • Updated API documentation for new DTO and endpoint to enhance clarity for users.
  • Refactor

    • Refined method parameters for better clarity and type safety in the EasController.

Copy link

coderabbitai bot commented Aug 26, 2024

Walkthrough

The changes involve updates to the authentication and attestation handling within a NestJS application. Key modifications include refining exception handling in the AuthService, introducing a new Data Transfer Object for decrypting attestation secrets, and enhancing the EasController and EasService with new methods and improved parameter handling. Additionally, adjustments were made to the LitService for better membership and session signature processing.

Changes

Files Change Summary
src/auth/auth.service.spec.ts Updated exception handling to expect UnauthorizedException instead of BadRequestException.
src/auth/auth.service.ts Changed exception thrown on token validation failure from BadRequestException to UnauthorizedException.
src/eas/dto/decrypt-attestation-secret.dto.ts Introduced DecryptAttestationSecretDto class with properties siweJwt and chainId, including validation and API documentation decorators.
src/eas/eas.controller.ts Added decryptSecret method for decrypting attestation secrets and refined the revoke method parameter handling.
src/eas/eas.service.ts Made encodeAttestationData public, added decodettestationData method, and renamed revokeable to checkAttestar. Introduced checkRecipient.
src/lit/lit.service.ts Modified the returnValueTest object and adjusted the order of operations in the decryptFromJson method for improved logic flow.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EasController
    participant EasService
    participant LitService

    User->>EasController: POST /:uid/decrypt-attestation-secret
    EasController->>EasService: decryptSecret(decryptAttestationSecretDto)
    EasService->>LitService: decryptFromJson()
    LitService->>EasService: return decrypted secret
    EasService-->>EasController: return secret to controller
    EasController-->>User: return decrypted secret
Loading

🐰 In the code, I hop with glee,
New features bloom, just wait and see!
With secrets to decrypt and tokens anew,
The paths are clearer, the flow is true.
Hooray for changes, let the code unite,
With each little hop, we take flight! ✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5d7005 and 4ba7adb.

Files selected for processing (6)
  • src/auth/auth.service.spec.ts (2 hunks)
  • src/auth/auth.service.ts (2 hunks)
  • src/eas/dto/decrypt-attestation-secret.dto.ts (1 hunks)
  • src/eas/eas.controller.ts (2 hunks)
  • src/eas/eas.service.ts (5 hunks)
  • src/lit/lit.service.ts (3 hunks)
Additional comments not posted (14)
src/eas/dto/decrypt-attestation-secret.dto.ts (2)

7-16: LGTM!

The siweJwt property is correctly decorated for validation and API documentation.

The code changes are approved.


17-24: LGTM!

The chainId property is correctly decorated for validation and API documentation.

The code changes are approved.

src/auth/auth.service.ts (2)

1-1: LGTM!

The import statement is correctly updated to reflect the new exception type.

The code changes are approved.


33-33: LGTM!

The exception type is correctly updated to UnauthorizedException, improving the clarity of error handling.

The code changes are approved.

src/auth/auth.service.spec.ts (2)

10-10: LGTM!

The import statement is correctly updated to reflect the new exception type.

The code changes are approved.


85-85: LGTM!

The test case is correctly updated to expect an UnauthorizedException, aligning with the updated behavior of the AuthService.

The code changes are approved.

src/eas/eas.controller.ts (2)

65-83: LGTM! But correct the spelling of getAttestaion.

The change to use @Param('uid') uid: string improves clarity and type safety. The function is correctly implemented. However, the spelling of getAttestaion should be corrected to getAttestation.

Apply this diff to correct the spelling:

- const attestation = await this.easService.getAttestaion(chainId, uid)
+ const attestation = await this.easService.getAttestation(chainId, uid)

The code changes are approved.


92-118: LGTM! But correct the spelling of decodettestationData.

The function is correctly implemented. However, the spelling of decodettestationData should be corrected to decodeAttestationData.

Apply this diff to correct the spelling:

- const decodedData = this.easService.decodettestationData(
+ const decodedData = this.easService.decodeAttestationData(

The code changes are approved.

src/eas/eas.service.ts (4)

Line range hint 74-78: LGTM!

The change to make the function public is appropriate if it needs to be accessed outside the class. The function is correctly implemented.

The code changes are approved.


83-86: LGTM! But correct the spelling of decodettestationData.

The function is correctly implemented. However, the spelling of decodettestationData should be corrected to decodeAttestationData.

Apply this diff to correct the spelling:

- decodettestationData(data: string): SchemaDecodedItem[] {
+ decodeAttestationData(data: string): SchemaDecodedItem[] {

The code changes are approved.


Line range hint 105-113: LGTM! But correct the spelling of attesation.

The function is correctly implemented. However, the spelling of attesation should be corrected to attestation.

Apply this diff to correct the spelling:

- `We aren't attester of this attesation`
+ `We aren't attester of this attestation`

The code changes are approved.


115-118: LGTM! But correct the spelling of attesation.

The function is correctly implemented. However, the spelling of attesation should be corrected to attestation.

Apply this diff to correct the spelling:

- `You aren't recipient of this attesation`
+ `You aren't recipient of this attestation`

The code changes are approved.

src/lit/lit.service.ts (2)

147-149: LGTM!

The change to update the key property from an empty string to 'isMember' likely indicates a shift in the criteria used for evaluating membership status. The function is correctly implemented.

The code changes are approved.


239-241: LGTM!

The change to move the call to getSessionSigsViaAuthSig(chainId) below the check for this.litNodeClient ensures that the connection is established before attempting to retrieve session signatures. The function is correctly implemented.

The code changes are approved.

@Behzad-rabiei Behzad-rabiei merged commit e383f70 into main Aug 26, 2024
13 checks passed
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.

1 participant