feat: allow read-only operations with wallet addr #284
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FilOzzy
added
team/filecoin-pin
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds view-only authentication mode to allow read-only operations (checking balances and status) without requiring signing capabilities. The implementation introduces a new --view-address CLI option that configures an address-only signer for querying operations.
- Adds
ReadOnlyConfigtype andreadOnlyflag to support authentication using only a wallet address - Introduces
--view-addressCLI option with environment variable support - Tightens authentication validation to ensure the four modes (standard, session-key, read-only, signer) remain mutually exclusive
- Updates test mocks and adds read-only mode test coverage
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| src/utils/cli-options.ts | Adds --view-address CLI option with documentation |
| src/utils/cli-auth.ts | Implements parsing logic to convert viewAddress to walletAddress + readOnly config |
| src/core/synapse/index.ts | Adds ReadOnlyConfig type, type guard, validation, and initialization logic using AddressOnlySigner |
| src/index-types.ts | Exports new ReadOnlyConfig type for public API |
| src/test/unit/synapse-service.test.ts | Adds test coverage for read-only mode initialization |
| src/test/unit/import.test.ts | Updates mock error message to include view-address option |
| src/test/unit/data-set.test.ts | Updates mock error message to include view-address option |
| src/test/unit/add.test.ts | Updates mock error message to include view-address option |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add view-only auth path (--view-address / walletAddress + readOnly) that wires to AddressOnlySigner so balances/status can be inspected without signing.
Tighten auth parsing/validation to keep modes mutually exclusive and update messaging to mention view-only mode.
Refresh tests/mocks for the new option.