Skip to main content

Adding a New Chain

For comprehensive instructions on integrating a new blockchain into the VisualSign parser system, please refer to our GitHub Wiki:

📖 Adding a New Chain to VisualSign Parser Wiki​

The Wiki guide covers:

  • Prerequisites - Development environment setup
  • Step-by-step implementation - From module initialization to registry integration
  • Core trait implementations - Transaction and VisualSignConverter traits
  • Testing strategies - Unit tests, integration tests, and gRPC testing
  • UI integration - Ensuring proper rendering in visualsign-display
  • Best practices - Error handling, field creation, and validation

Quick Overview​

Adding a new chain involves:

  1. Initialize chain module from the visualsign-unspecified template
  2. Implement core traits for transaction parsing and visualization
  3. Write comprehensive tests for your implementation
  4. Register in the protocol buffer definitions
  5. Integrate with the parser service and test via gRPC
  6. Verify UI rendering in the display component

Why Use the Wiki?​

The Wiki documentation is:

  • Always up-to-date with the latest implementation patterns
  • Community maintained with contributions from chain developers
  • Version controlled alongside the parser codebase
  • Interactive with discussions and updates from implementers

Getting Help​

  • Check existing implementations in src/chain_parsers/
  • Open an issue on GitHub
  • Join the community discussion on the Wiki page