feat: issue and revoke command

[RishabhS7]

Commit Description: feat/issue-revoke

Overview

This commit adds the issue and revoke commands for document store operations in the TrustVC CLI. These commands allow users to issue and revoke document hashes in deployed document store contracts on various blockchain networks.

Files Added

Source Files

• src/commands/document-store/issue.ts (145 lines): Implements the document-store issue command
• src/commands/document-store/revoke.ts (146 lines): Implements the document-store revoke command

Test Files

• tests/commands/document-store/issue.test.ts (677 lines): Comprehensive test suite for the issue command
• tests/commands/document-store/revoke.test.ts (677 lines): Comprehensive test suite for the revoke command

Features Implemented

Document Store Issue Command

• Purpose: Issues a document hash to a deployed document store contract
• Usage: trustvc document-store issue
• Functionality:
  • Extracts document information from TT/JSON files
  • Supports multiple wallet authentication methods (encrypted wallet, private key file, direct key, environment variable)
  • Performs dry run confirmation for supported networks (Ethereum, Polygon)
  • Handles gas estimation and EIP-1559 gas parameters
  • Displays transaction details and explorer links
  • Supports all configured networks (Ethereum, Polygon, XDC, Stability, Astron)

Document Store Revoke Command

• Purpose: Revokes a document hash from a deployed document store contract
• Usage: trustvc document-store revoke
• Functionality:
  • Same core features as issue command
  • Uses documentStoreRevoke function from @trustvc/trustvc
  • Handles overloaded contract methods (revoke(bytes32))

Technical Details

Command Structure

Both commands follow the established CLI pattern:

• Interactive prompts for user input
• Wallet selection with multiple authentication options
• Network selection with dry run confirmation
• Transaction execution with gas management
• Comprehensive error handling and logging

Dependencies

• Uses @trustvc/trustvc library functions: documentStoreIssue, documentStoreRevoke
• Integrates with existing CLI utilities for wallet management, network handling, and transaction processing
• Leverages ethers.js for blockchain interactions

Testing

• Comprehensive test coverage for all user flows
• Mocks for external dependencies (@trustvc/trustvc, signale, ethers)
• Tests for different wallet authentication methods
• Error handling and edge case coverage
• Network compatibility testing

Usage Examples

# Issue a document hash
trustvc document-store issue

# Revoke a document hash
trustvc document-store revoke

Both commands will prompt for:

• Document file path
• Wallet authentication
• Confirmation (with dry run for supported networks)

Summary by CodeRabbit

Release Notes

• New Features

  • New CLI command to issue a hash to a blockchain-based document store, supporting multiple wallet input methods and dynamic gas configuration
  • New CLI command to revoke a hash from a blockchain document store with multi-wallet support and gas fee optimization
  • Both commands include interactive dry-run verification and provide transaction details upon completion

• Tests

  • Added comprehensive test coverage for new issue and revoke commands

[coderabbitai]

📝 Walkthrough

Walkthrough

Two new CLI command modules for blockchain document store operations are introduced: one for issuing document hashes and one for revoking them. Both include wallet-aware flows with dry-run support and conditional gas estimation. Comprehensive test suites accompany both commands with extensive mocking of dependencies.

Changes

Cohort / File(s)	Summary
Document Store Commands src/commands/document-store/issue.ts, src/commands/document-store/revoke.ts	New CLI commands for issuing and revoking hashes on blockchain document stores. Both feature user prompting, wallet selection, dry-run confirmation, EIP-1559 and legacy gas handling, transaction execution, and detailed result logging.
Command Tests tests/commands/document-store/issue.test.ts, tests/commands/document-store/revoke.test.ts	Comprehensive test suites covering promptForInputs, token operations (issueToken/revokeToken), and handler flows. Extensive mocking of wallet utilities, blockchain interactions, document retrieval, and user prompts across all supported networks.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI as Handler
    participant Input as promptForInputs
    participant Wallet as Wallet Utils
    participant DryRun as DryRun Flow
    participant DocStore as Document Store
    participant Blockchain as Blockchain Network
    participant Display as Result Display

    User->>CLI: Execute issue/revoke command
    CLI->>Input: Request user inputs
    Input->>User: Prompt for document & wallet info
    User-->>Input: Provide inputs
    Input->>Wallet: Request wallet/signer
    Wallet-->>Input: Return signer
    Input-->>CLI: Return command payload
    
    CLI->>DryRun: Perform dry-run with confirmation
    DryRun->>DocStore: Connect to document store
    DocStore->>DocStore: Populate transaction
    DryRun->>User: Request confirmation
    User-->>DryRun: Confirm
    DryRun-->>CLI: Transaction ready
    
    CLI->>DocStore: Check if gas estimation supported
    alt EIP-1559 Supported
        CLI->>Blockchain: Fetch gas fees (maxFeePerGas, maxPriorityFeePerGas)
        Blockchain-->>CLI: Return gas parameters
        CLI->>DocStore: Execute with EIP-1559 parameters
    else Legacy Mode
        CLI->>DocStore: Execute standard transaction
    end
    
    DocStore->>Blockchain: Send transaction
    Blockchain-->>DocStore: Transaction hash
    DocStore->>Blockchain: Wait for confirmation
    Blockchain-->>DocStore: Confirmed
    
    CLI->>Display: Show transaction details & link
    Display->>User: Display results

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Poem

🐰 Hoppy blockchain tales I weave,
With hashes issued, none to grieve,
And revoke commands, swift and bright,
Gas-aware wallets, tested right! ✨📜

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[tradetrustimda]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀