tip5xx

Tip5 hash (https://eprint.iacr.org/2023/107) implementation in C++

Requirements

C++ Implementation

• CMake 3.15 or higher
• C++17 compliant compiler
• For testing: Internet connection (to fetch Google Test and CLI11)

Rust Sample

• Rust 1.85 or higher
• Internet connection (to fetch dependencies)

Building

C++ Implementation

cmake -B build
cmake --build build

To run tests:

cd build && ctest --output-on-failure

Rust Implementation

cd samples/tip5-rust
cargo build

Build Options

CMake Options

• BUILD_TESTING=ON/OFF: Enable/disable building tests (default: ON)
• BUILD_SAMPLES=ON/OFF: Enable/disable building sample applications (default: ON)
• ENABLE_COVERAGE=ON/OFF: Enable code coverage reporting (default: OFF)
• ENABLE_SANITIZER=ON/OFF: Enable Address Sanitizer (default: OFF)

Usage

As a C++ Library

#include <tip5xx/tip5xx.hpp>

// Create digests
tip5xx::BFieldElement elements1[] = {
    tip5xx::BFieldElement::new_element(1),   // decimal
    tip5xx::BFieldElement::new_element(2),
    tip5xx::BFieldElement::new_element(3),
    tip5xx::BFieldElement::new_element(4),
    tip5xx::BFieldElement::new_element(5)
};
tip5xx::Digest digest1(elements1);

tip5xx::BFieldElement elements2[] = {
    tip5xx::BFieldElement::new_element(0x6), // hexadecimal
    tip5xx::BFieldElement::new_element(0x7),
    tip5xx::BFieldElement::new_element(0x8),
    tip5xx::BFieldElement::new_element(0x9),
    tip5xx::BFieldElement::new_element(0xa)
};
tip5xx::Digest digest2(elements2);

// Hash pair of digests
auto result = tip5xx::Tip5::hash_pair(digest1, digest2);

// Hash variable length array of digests
std::vector<tip5xx::BFieldElement> varlen;
varlen.insert(varlen.end(), digest1.begin(), digest1.end());
varlen.insert(varlen.end(), digest2.begin(), digest2.end());
auto varlen_result = tip5xx::Tip5::hash_varlen(varlen);

Sample Applications

Both C++ and Rust implementations provide similar command-line interfaces supporting pair and variable-length hashing modes.

C++ Sample

cd build/samples/tip5-cpp

# Pair mode with different number formats
./tip5 "(0x1,0x2,0x3,0x4,0x5)" "(0x6,0x7,0x8,0x9,0xa)"     # hexadecimal
./tip5 "(1,2,3,4,5)" "(6,7,8,9,10)"                         # decimal

# Variable-length mode with mixed formats
./tip5 -m varlen "(1,2,3,4,5)" "(6,7,8,9,10)" "(11,12,13,14,15)"

# Show help and options
./tip5 --help

Options for C++ implementation:

• -m, --mode <mode>: Hashing mode ('pair' or 'varlen')
  • pair: Takes exactly 2 digests (default mode)
  • varlen: Takes 2 or more digests
• Each digest must be in format (n1,n2,n3,n4,n5) where each number can be:
  • Hexadecimal: Numbers with 0x prefix (e.g., 0x1F)
  • Decimal: Plain numbers (e.g., 42)

Rust Sample

cd samples/tip5-rust

# Pair mode with different number formats
cargo run -- "(0x1,0x2,0x3,0x4,0x5)" "(0x6,0x7,0x8,0x9,0xa)"     # hexadecimal
cargo run -- "(1,2,3,4,5)" "(6,7,8,9,10)"                         # decimal

# Variable-length mode with mixed formats
cargo run -- -m varlen "(1,2,3,4,5)" "(6,7,8,9,10)" "(11,12,13,14,15)"

# Show help and options
cargo run -- --help

Options for Rust implementation:

• -m, --mode <mode>: Hashing mode ('pair' or 'varlen')
  • pair: Takes exactly 2 digests (default mode)
  • varlen: Takes 2 or more digests
• Each digest must be in format (n1,n2,n3,n4,n5) where each number can be:
  • Hexadecimal: Numbers with 0x prefix (e.g., 0x1F)
  • Decimal: Plain numbers (e.g., 42)

Note: Hex format requires the 0x prefix and even number of digits.

License

See the LICENSE file for details.

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request