centurymetadata 0.2
Encrypt, send, retrieve and decrypt centurymetadata.org files
License: MIT
Requires Python: >=3.8

# centurymetadata.org: Long-term Bitcoin Metadata Storage

## About

*Century Metadata* is a project to provide storage for small amounts
of auxiliary data.  As an example, this is useful for Bitcoin wallets,
which can be restored from 12 seed words, but cannot know about more
complex funds without additional data.  On restore, your wallet would attempt to
fetch this data from [https://centurymetadata.org](https://centurymetadata.org) or a mirror.

We are currently in alpha, seeking feedback.

## File Format

The file format is designed to be self-explanatory and use standard,
long-lived primitives as much as possible.  Every file contains a
preamble, followed by 8192 bytes.  The preamble describes the data
format which follows:

```
centurymetadata v0\0SIG[64]|WRITER[33]|READER[33]|GEN[8]|AES[8054]

SIG: BIP-340 SHA256(TAG|TAG|WRITER|READER|GEN|AES)
WRITER, READER: secp256k1 x-only keys
TAG: SHA256("centurymetadata v0"[18])
AESKEY: SHA256(EC Diffie-Hellman of WRITER,READER)
AES: CTR mode (starting 0, nonce 0) using AESKEY of DATA
DATA: gzip([TITLE\0CONTENTS\0]+), padded with 0 bytes to 8054\0
```

The data itself is a series of NUL-separated title, contents pairs.
Obviously this cannot be validated on the production server, but the
test server (which only allows known keys) will check the file is
compliant.

## Usage with Bitcoin

The BIP 32 path recommended for centurymetadata is `0x44315441'`
(`DATA`), with `/0'` as the writer key,
`/1'` as the reader key.  Of course, others can also send data
to your reader key, but you know that the record from your own writer
key can be trusted. 

The types of records accepted are as follows:

* Title: `bitcoin psbt`, Body: base64-encoded PSBT
* Title: `bitcoin transaction` Body: hex-encoded transaction
* Title: `bitcoin miniscript` Body: miniscript string

## API

The test API endpoint can be found at [testapi.centurymetadata.org](https://testapi.centurymetadata.org/api/v0).

### Entry Creation: POST /api/v0/authorize/{READER}/{WRITER}/{AUTHTOKEN}

You need to get an *AUTHTOKEN* for each new entry.  There can only be
one entry for any *READER*/*WRITER* pair, but once the entry is
authorized it can be updated by the writer at any time.

### Entry Update: POST /api/v0/update

Updates a previously authorized writer/reader entry.  The
`Content-Type: application/x-centurymetadata` should contain a valid
centurymetadata file.

### Entries Depth: GET /api/v0/fetchdepth

Since we bundle records by reader prefix (e.g. all readers starting with `42a3` might be bundled together), you need to know how long the prefix is: it starts as an empty prefix and increases by one hex digit as we grow, so bundles are always a reasonable size.

Returns a JSON object with member `depth` containing how many hex digits of reader to use for `fetchbundle`.

### Retrieiving Entries: GET /api/v0/fetchbundle/{READERPREFIX}

This returns the given bundle, as `Content-Type: application/x-centurymetadata`, consisting of multiple back-to-back
century metadata files.

## Tools

There is an experimental Python package to encode and decode
centurymetadata files in the [GitHub repository](https://github.com/rustyrussell/centurymetadata)

## Roadmap

I'm committed to maintaining this service for at least 5 years
as a trial.  After that if it's proven useful I would like to
spin it into a real not-for-profit foundation to provide as much
certainty on continuity as possible.

## How Much?

There will never be a charge for ratelimited updates or retrievals;
the idea is to charge a small cost for the creation of new entries to
cover ongoing running costs.  We may also accept donations.

## Who?

Rusty Russell started this as a side project; my original problem was
how to give someone timelocked bitcoin, but realized there was a large
related class of problems for someone to solve.

## Feedback

Advice, suggestions, kudos, blame: hosting is on [GitHub](https://github.com/rustyrussell/centurymetadata), and you can reach us on [Twitter](https://twitter.com/centurymetadata), or send
[me email](mailto:rusty@rustcorp.com.au) or other contact as listed on 
[my personal site](https://rusty.ozlabs.org).