@canvas-js/signed-cid - npm Package Compare versions

Comparing version 0.6.0-alpha2 to 0.6.0-alpha3

package.json

		{
		"name": "@canvas-js/signed-cid",
		"version": "0.6.0-alpha2",
		"version": "0.6.0-alpha3",
		"author": "Canvas Technologies, Inc. (https://canvas.xyz)",
		@@ -5,0 +5,0 @@ "type": "module",

README.md

		# @canvas-js/signed-cid

		This package implements a tiny signed data format for IPLD values. Any CID can be signed, and the resulting `Signature` can be passed around as an independent value on its own.
		This package implements a tiny signed data format for IPLD values. Any [CID](https://docs.ipfs.tech/concepts/content-addressing/) can be signed, and the resulting `Signature` can be passed around as an independent value on its own.

		@@ -18,7 +18,7 @@ ```ts

		The signature signs the bytes of the CID, which carries metadata about the encoding format and hashing algorithm, plus the hash of the encoded value itself. This allows `Signature` values to be redistributed via different codecs without breaking signature validation.
		The signature signs the raw bytes of the CID, which carries metadata about the encoding format and hashing algorithm, plus the hash of the encoded value itself. This allows values and their signatures to be re-encoded with different codecs without breaking validation.

		`ed25519` and `secp256k1` signatures are supported, using the audited [`@noble/curves`](https://github.com/paulmillr/noble-curves) library. `secp256k1` public keys are always compressed.

		Only the `dag-json` and `dag-cbor` IPLD codecs are included by default, but others can be used by implementing the `Codec` interface. Similarly, only `sha2-256`, `blake3-256`, and `blake3-128` multihash digests are included by default, but other can be used by implementing the `Digest` interface.
		Only the `dag-json` and `dag-cbor` IPLD codecs are included by default, but others can be used by implementing the [`Codec`](#codec) interface. Similarly, only `sha2-256`, `blake3-256`, and `blake3-128` multihash digests are included by default, but other can be used by implementing the [`Digest`](#digest) interface.

		@@ -46,2 +46,25 @@ ## Usage

		We can see a detailed breakdown of the CID in the signature with the CID explorer tool [here](https://cid.ipfs.tech/#bafyreibqke43yd2rqll4nwlrbfjfqferamxp3sdia36a6awqvcae3cmm7a). The prefix bytes of the CID tell us that it carries the sha2-256 hash of a dag-cbor value, and that the hash digest is `0x305139BC0F5182D7C6D9710952581491032EFDC86806FC0F02D0A8804D898CF8`.

		We can check this by encoding and hashing the value ourselves:

		```ts
		import { encode } from "@ipld/dag-cbor"

		const value = encode({ foo: "hello world", bar: [1, 2, 3] })
		console.log(value)
		// Uint8Array(25) [
		// 162, 99, 98, 97, 114, 131, 1,
		// 2, 3, 99, 102, 111, 111, 107,
		// 104, 101, 108, 108, 111, 32, 119,
		// 111, 114, 108, 100
		// ]

		const hash = crypto.createHash("sha256").update(value).digest()
		console.log(hash)
		// <Buffer 30 51 39 bc 0f 51 82 d7 c6 d9 71 09 52 58 14 91 03 2e fd c8 68 06 fc 0f 02 d0 a8 80 4d 89 8c f8>
		```

		Again, signatures always sign the raw bytes of the entire CID, not just the hash digest.

		## API
		@@ -66,3 +89,3 @@
		declare function verifySignature(
		{ type, publicKey, signature, cid }: Signature,
		signature: Signature,
		value: any,
		@@ -75,7 +98,14 @@ options: { codecs?: Codec[]; digests?: Digest[] } = {}

		`Codec` and `Digest` are similar to some existing interfaces in the JavaScript IPLD ecosystem, but are defined the way they are here to support synchronous zero-copy streaming encoders.

		#### Digest

		```ts
		type Digest = { name: string; code: number; digest: (iter: Iterable<Uint8Array>) => Uint8Array }
		```

		#### Codec

		```ts
		type Codec = { name: string; code: number; encode: (value: any) => Iterable<Uint8Array> }
		```

		`Codec` and `Digest` are similar to some existing interfaces in the JavaScript IPLD ecosystem, but are defined the way they are here to support synchronous zero-copy streaming encoders.

@canvas-js/signed-cid - npm Package Compare versions

Improved metrics