Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description for test vectors #69

Merged
merged 3 commits into from
Jun 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Multibase test vectors
======================

This directory contains test vectors that should be used by every implementation to check if it correctly implements the Base encoding as specified by Multibase.

| Filename | String to encode | Description
| -------- | ---------------- | -----------
| `basic.csv` | `yes mani !` | Basic case
| `leading_zero.csv` | `\x00yes mani !` | Leading zero byte
| `two_leading_zeros.csv` | `\x00\x00yes mani !` | Two leading zero bytes (leading zeros are a source of bugs, hence there are two test vectors for them)
| `case_insensitivity.csv` | `hello world` | Differently cased than expected, must decode without errors
File renamed without changes.
File renamed without changes.
File renamed without changes.
23 changes: 0 additions & 23 deletions tests/test1.csv

This file was deleted.

23 changes: 0 additions & 23 deletions tests/test3.csv

This file was deleted.

File renamed without changes.