paritytech / paritytech/banana_split

Find a better-compressing encoding

Open
#31 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
353
Forks
67
PR merge metrics
No merged PRs in 30d

Description

Currently we the maximal size of the QR code limits the maximal size of allowed text rather heavily.
There are two ways this can be improved:
a) it makes sense to compress the original text -- and compression should work efficiently enough on both natural text and ascii-based serializations like armored GPG exports.
b) the actual way of recording the shard into QR code might need tweaking -- since used QR alphabet (see here) and shard's serialization mode should allow better storage efficiency.

It goes without saying that BananaSplit should retain backwards compatibility indefinitely, so in addition to this new serialization format all previous ones should be supported as well.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the current shard serialization and QR-code encoding entry points, then review how existing formats are identified and read. Compare the proposed compression and encoding approaches for natural text and armored GPG exports. Done means a defined improved format while retaining support for every previous serialization format.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cryptography
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.