requestNetwork feat: add domain and statement support to LitProtocolCipherProvider

Problem

When lit session expires Lit SDK will try to refresh it by calling a callback function we implement in the Request Network SDK. This callback function was using the params passed to the getSessionSignatures function which makes them only available in the function scope. That caused the undefined issues when the callback function was called afterwards.

Fixes https://github.com/RequestNetwork/web-components/issues/327

Changes

Domain and Statement params are now a attributes of the LitProtocolCipherProvider so making it available on the class global scope. That should fix the undefined issue when the callback function is called for refreshing the session.

Summary by CodeRabbit

New Features
- You can now configure optional domain and statement parameters at provider initialization, streamlining session signature operations.
Tests
- Updated test scenarios confirm that the enhanced parameter configuration functions consistently across sessions.

Feb 04 '25 18:02 rodrigopavezi

Walkthrough

This pull request introduces two new optional properties, domain and statement, in the LitProtocolCipherProvider class. The constructor is updated to accept these parameters, and the getSessionSignatures method is refactored to use the instance properties instead of receiving them as arguments. Similarly, the tests in the index.test.ts file are updated to pass these parameters through the constructor for the LitProvider class, ensuring consistency and simplifying method calls by removing redundant parameters.

Changes

File	Change Summary
packages/lit-protocol-cipher/src/...-cipher-provider.ts	- Added private optional properties `domain` and `statement` - Updated constructor to accept the new parameters - Modified `getSessionSignatures` to use instance properties rather than method arguments
packages/lit-protocol-cipher/test/...index.test.ts	- Updated constructor call in `LitProvider` to include `mockDomain` and `mockStatement` - Refactored test cases to utilize instance properties instead of declaring and passing parameters directly in method calls

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Provider as LitProtocolCipherProvider / LitProvider
    participant Signer

    Client->>Provider: Instantiate (litClient, config, chain, domain, statement)
    Client->>Provider: Call getSessionSignatures(signer, walletAddress)
    Provider->>Provider: Retrieve domain & statement from instance properties
    Provider->>Signer: Create and send SIWE message for signing
    Signer-->>Provider: Return signature
    Provider-->>Client: Return signature response

Suggested reviewers

alexandre-abrioux
sstefdev
MantisClone
aimensahnoun

[!TIP]

🌐 Web search-backed reviews and chat

We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.

You can disable this feature by setting web_search: false in the knowledge_base settings.

Please share any feedback in the Discord discussion.

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 20d4f1a16307db5a47370a5eff55a3d2872ecbcc and ed922676060bf0c42953263852854846848cec7d.

📒 Files selected for processing (2)

packages/lit-protocol-cipher/src/lit-protocol-cipher-provider.ts (4 hunks)
packages/lit-protocol-cipher/test/index.test.ts (6 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build-and-test

🔇 Additional comments (7)

packages/lit-protocol-cipher/src/lit-protocol-cipher-provider.ts (3)

53-61: LGTM! Well-documented properties.

The new private optional properties are well-defined and properly documented.

68-80: LGTM! Constructor properly initialized.

The constructor correctly handles the new optional parameters and assigns them to class properties.

128-167: LGTM! Method refactored to use class properties.

The refactoring improves session expiration handling by using class-level properties instead of function parameters. This ensures the parameters are available when the session needs to be refreshed.

Let's verify that all calls to getSessionSignatures have been updated to match the new signature:

✅ Verification successful

LGTM! All calls to getSessionSignatures have been updated to use the new two-parameter signature.

The shell script search for invocations with an extra parameter produced no output, confirming that there are no instances remaining with the old three-parameter signature.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Search for any remaining calls with the old signature that might have been missed
rg "getSessionSignatures$[^)]*,[^)]*,[^)]*$" --type ts
Length of output: 58
packages/lit-protocol-cipher/test/index.test.ts (4)

46-48: LGTM! Test setup properly configured.

The test setup correctly defines mock values and initializes the provider with the new optional parameters.

Also applies to: 77-83

194-221: LGTM! Test case properly updated.

The test case correctly verifies that the constructor-provided domain and statement are used in the SIWE message creation.

223-256: LGTM! Edge case properly tested.

The test case effectively verifies that the provider works correctly when domain and statement are not provided.

258-295: LGTM! Custom parameters properly tested.

The test case thoroughly verifies that custom domain and statement values are correctly used in the SIWE message creation.

✨ Finishing Touches

[ ] 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

Feb 04 '25 18:02 coderabbitai[bot]

@coderabbitai review

Feb 04 '25 18:02 rodrigopavezi

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Feb 04 '25 18:02 coderabbitai[bot]

feat: add domain and statement support to LitProtocolCipherProvider

Problem

Changes

Summary by CodeRabbit

Walkthrough

Changes

Sequence Diagram(s)

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

CodeRabbit Configuration File (`.coderabbit.yaml`)