TEMPORARY add dist/ to PR for use with gitpkg

.gitignore

@@ -1,6 +1,5 @@
 .nyc_output
 build
-dist
 coverage
 package-lock.json
 node_modules

dist/LICENSE-APACHE

@@ -0,0 +1,13 @@
+Copyright 2020 Protocol Labs
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

dist/LICENSE-MIT

@@ -0,0 +1,7 @@
+Copyright 2020 Protocol Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

dist/README.md

@@ -0,0 +1,198 @@
+# multiformats
+
+This library defines common interfaces and low level building blocks for varios inter-related multiformat technologies (multicodec, multihash, multibase,
+and CID). They can be used to implement custom custom base
+encoders / decoders / codecs, codec encoders /decoders and multihash hashers that comply to the interface that layers above assume.
+
+Library provides implementations for most basics and many others can be found in linked repositories.
+
+## Interfaces
+
+```js
+import { CID } from 'multiformats/cid'
+import * as json from 'multiformats/codecs/json'
+import { sha256 } from 'multiformats/hashes/sha2'
+
+const bytes = json.encode({ hello: 'world' })
+
+const hash = await sha256.digest(bytes)
+const cid = CID.create(1, json.code, hash)
+//> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+```
+
+### Creating Blocks
+
+```js
+import Block from 'multiformats/block'
+import * as codec from '@ipld/dag-cbor'
+import { sha256 as hasher } from 'multiformats/hashes/sha2'
+
+const value = { hello: 'world' }
+
+// encode a block
+let block = await Block.encode({ value, codec, hasher })
+
+block.value // { hello: 'world' }
+block.bytes // Uint8Array
+block.cid   // CID() w/ sha2-256 hash address and dag-cbor codec
+
+// you can also decode blocks from their binary state
+block = await Block.decode({ bytes: block.bytes, codec, hasher })
+
+// if you have the cid you can also verify the hash on decode
+block = await Block.create({ bytes: block.bytes, cid: block.cid, codec, hasher })
+```
+
+### Multibase Encoders / Decoders / Codecs
+
+CIDs can be serialized to string representation using multibase encoders that
+implement [`MultibaseEncoder`](https://github.com/multiformats/js-multiformats/blob/master/src/bases/interface.ts) interface. Library
+provides quite a few implementations that can be imported:
+
+```js
+import { base64 } from "multiformats/bases/base64"
+cid.toString(base64.encoder)
+//> 'mAYAEEiCTojlxqRTl6svwqNJRVM2jCcPBxy+7mRTUfGDzy2gViA'
+```
+
+Parsing CID string serialized CIDs requires multibase decoder that implements
+[`MultibaseDecoder`](https://github.com/multiformats/js-multiformats/blob/master/src/bases/interface.ts) interface. Library provides a
+decoder for every encoder it provides:
+
+```js
+CID.parse('mAYAEEiCTojlxqRTl6svwqNJRVM2jCcPBxy+7mRTUfGDzy2gViA', base64.decoder)
+//> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+```
+
+Dual of multibase encoder & decoder is defined as multibase codec and it exposes
+them as `encoder` and `decoder` properties. For added convenience codecs also
+implement `MultibaseEncoder` and `MultibaseDecoder` interfaces so they could be
+used as either or both:
+
+
+```js
+cid.toString(base64)
+CID.parse(cid.toString(base64), base64)
+```
+
+**Note:** CID implementation comes bundled with `base32` and `base58btc`
+multibase codecs so that CIDs can be base serialized to (version specific)
+default base encoding and parsed without having to supply base encoders/decoders:
+
+```js
+const v1 = CID.parse('bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
+v1.toString()
+//> 'bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea'
+
+const v0 = CID.parse('QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n')
+v0.toString()
+//> 'QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n'
+v0.toV1().toString()
+//> 'bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku'
+```
+
+### Multicodec Encoders / Decoders / Codecs
+
+Library defines [`BlockEncoder`, `BlockDecoder` and `BlockCodec` interfaces](https://github.com/multiformats/js-multiformats/blob/master/src/codecs/interface.ts)
+and utility function to take care of the boilerplate when implementing them:
+
+```js
+import { codec } from 'multiformats/codecs/codec'
+
+const json = codec({
+  name: 'json',
+  // As per multiformats table
+  // https://github.com/multiformats/multicodec/blob/master/table.csv#L113
+  code: 0x0200,
+  encode: json => new TextEncoder().encode(JSON.stringify(json)),
+  decode: bytes => JSON.parse(new TextDecoder().decode(bytes))
+})
+```
+
+Just like with multibase, here codecs are duals of `encoder` and `decoder` parts,
+but they also implement both interfaces for convenience:
+
+```js
+const hello = json.encoder.encode({ hello: 'world' })
+json.decode(b1)
+//> { hello: 'world' }
+```
+
+### Multihash Hashers
+
+This library defines [`MultihashHasher` and `MultihashDigest` interfaces](https://github.com/multiformats/js-multiformats/blob/master/src/hashes/interface.ts)
+and convinient function for implementing them:
+
+```js
+import * as hasher from 'multiformats/hashes/hasher')
+
+const sha256 = hasher.from({
+  // As per multiformats table
+  // https://github.com/multiformats/multicodec/blob/master/table.csv#L9
+  name: 'sha2-256',
+  code: 0x12,
+
+  encode: (input) => new Uint8Array(crypto.createHash('sha256').update(input).digest())
+})
+
+const hash = await sha256.digest(json.encode({ hello: 'world' }))
+CID.create(1, json.code, hash)
+
+//> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+```
+
+
+
+# Implementations
+
+By default, no base encodings (other than base32 & base58btc), hash functions,
+or codec implementations are included exposed by `multiformats`, you need to
+import the ones you need yourself.
+
+## Multibase codecs
+
+| bases | import | repo |
+ --- | --- | --- |
+`base16` | `multiformats/bases/base16` | [multiformats/js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/bases) |
+`base32`, `base32pad`, `base32hex`, `base32hexpad`, `base32z` | `multiformats/bases/base32` | [multiformats/js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/bases) |
+`base64`, `base64pad`, `base64url`, `base64urlpad` | `multiformats/bases/base64` | [multiformats/js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/bases) |
+`base58btc`, `base58flick4` | `multiformats/bases/base58` | [multiformats/js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/bases) |
+
+## Multihash hashers
+
+| hashes | import | repo |
+| --- | --- | --- |
+| `sha2-256`, `sha2-512` | `multiformats/hashes/sha2` | [multiformats/js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/src/hashes) |
+| `sha3-224`, `sha3-256`, `sha3-384`,`sha3-512`, `shake-128`, `shake-256`, `keccak-224`, `keccak-256`, `keccak-384`, `keccak-512` | `@multiformats/sha3` | [multiformats/js-sha3](https://github.com/multiformats/js-sha3) |
+| `identity` | `multiformats/hashes/identity` | [multiformats/js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/src/hashes/identity.js) |
+| `murmur3-128`, `murmur3-32` | `@multiformats/murmur3` | [multiformats/js-murmur3](https://github.com/multiformats/js-murmur3) |
+| `blake2b-*`, `blake2s-*` | `@multiformats/blake2` | [multiformats/js-blake2](https://github.com/multiformats/js-blake2) |
+
+## Codec Implementations (multicodec)
+
+| codec | import | repo |
+| --- | --- | --- |
+| `raw` | `multiformats/codecs/raw` | [multiformats/js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/src/codecs) |
+| `json` | `multiformats/codecs/json` | [multiformats/js-multiformats](https://github.com/multiformats/js-multiformats/tree/master/src/codecs) |
+| `dag-cbor` | `@ipld/dag-cbor` | [ipld/js-dag-cbor](https://github.com/ipld/js-dag-cbor) |
+| `dag-json` | `@ipld/dag-json` | [ipld/js-dag-json](https://github.com/ipld/js-dag-json) |
+| `dag-pb` | `@ipld/dag-pb` | [ipld/js-dag-pb](https://github.com/ipld/js-dag-pb) |
+| `dag-jose` | `dag-jose`| [ceramicnetwork/js-dag-jose](https://github.com/ceramicnetwork/js-dag-jose) |
+
+
+## TypeScript support
+
+This project is distributed with type definitions for TypeScript. 
+
+[A bug in TypeScript < 4.2](https://github.com/microsoft/TypeScript/issues/41258) causes typechecking errors in these type definitions when compiling a project that uses them. This is fixed in [TypeScript v4.2](https://github.com/microsoft/TypeScript/releases/tag/v4.2.2) so please upgrade if you hit that issue.
+
+## License
+
+Licensed under either of
+
+ * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

dist/cjs/browser-test/fixtures/invalid-multihash.js

@@ -0,0 +1,48 @@
+'use strict';
+
+var invalid = [
+  {
+    code: 0,
+    size: 32,
+    hex: '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33',
+    message: 'Incorrect length'
+  },
+  {
+    code: 17,
+    size: 21,
+    hex: '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33',
+    message: 'Incorrect length'
+  },
+  {
+    code: 17,
+    size: 20,
+    hex: '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a',
+    message: 'Incorrect length'
+  },
+  {
+    code: 17,
+    size: 20,
+    hex: '',
+    message: 'Could not decode varint'
+  },
+  {
+    code: 49,
+    size: 20,
+    hex: '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33',
+    message: 'Incorrect length'
+  },
+  {
+    code: 18,
+    size: 32,
+    hex: '2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7',
+    message: 'Incorrect length'
+  },
+  {
+    code: 18,
+    size: 32,
+    hex: '1220ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad0000',
+    message: 'Incorrect length'
+  }
+];
+
+module.exports = invalid;