@atcute/cid 1.0.0

package/LICENSE

@@ -0,0 +1,17 @@
+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.

package/README.md

@@ -0,0 +1,14 @@
+# @atcute/cid
+
+create and parse AT Protocol-blessed CIDv1 format
+
+```ts
+const parsed = parse('bafyreihffx5a2e7k5uwrmmgofbvzujc5cmw5h4espouwuxt3liqoflx3ee');
+//    ^? { version: 1, code: 113, digest: { ... }, bytes: Uint8Array(36) }
+
+// Creating a CID containing CBOR data
+const cid = await create(0x71, buffer);
+
+// Serializing CID into string
+format(cid); // -> bafyrei...
+```

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @module
+ * Bare minimum implementation for creating, parsing, and formatting
+ * AT Protocol-blessed CIDv1 format.
+ *
+ * As specified by AT Protocol, the blessed format is:
+ * - Multibase: `base32` (b)
+ * - Multicodec: `dag-cbor` (0x71) for record, `raw` (0x55) for blobs
+ * - Multihash: `sha-256` (0x12)
+ */
+/**
+ * Raw digest information
+ */
+export interface Digest {
+    code: number;
+    size: number;
+    digest: Uint8Array;
+    bytes: Uint8Array;
+}
+/**
+ * CID information
+ */
+export interface CID {
+    version: number;
+    code: number;
+    digest: Digest;
+    bytes: Uint8Array;
+}
+/**
+ * Information regarding CID buffer being inspected
+ */
+export interface InspectedCID {
+    version: number;
+    codec: number;
+    multihashCode: number;
+    digestSize: number;
+    multihashSize: number;
+    size: number;
+}
+/**
+ * Parse a CID string
+ */
+export declare const parse: (cid: string) => CID;
+/**
+ * Provides information regarding the CID buffer
+ */
+export declare const inspect: (initialBytes: Uint8Array) => InspectedCID;
+/**
+ * Decode the first CID contained, and return the remainder.
+ * @param bytes Buffer to decode
+ * @returns A tuple containing the first CID in the buffer, and the remainder
+ */
+export declare const decodeFirst: (bytes: Uint8Array) => [cid: CID, remainder: Uint8Array];
+/**
+ * Decodes a CID buffer
+ */
+export declare const decode: (bytes: Uint8Array) => CID;
+/**
+ * Creates a CID
+ */
+export declare const create: (code: number, input: Uint8Array) => Promise<CID>;
+/**
+ * Serialize CID into a string
+ */
+export declare const format: (cid: CID) => string;

package/dist/index.js

@@ -0,0 +1,133 @@
+/**
+ * @module
+ * Bare minimum implementation for creating, parsing, and formatting
+ * AT Protocol-blessed CIDv1 format.
+ *
+ * As specified by AT Protocol, the blessed format is:
+ * - Multibase: `base32` (b)
+ * - Multicodec: `dag-cbor` (0x71) for record, `raw` (0x55) for blobs
+ * - Multihash: `sha-256` (0x12)
+ */
+import * as base32 from '@atcute/base32';
+import * as varint from '@atcute/varint';
+/**
+ * Parse a CID string
+ */
+export const parse = (cid) => {
+    if (cid[0] !== 'b') {
+        throw new Error(`only base32 cidv1 is supported`);
+    }
+    const bytes = base32.decode(cid.slice(1));
+    return decode(bytes);
+};
+/**
+ * Provides information regarding the CID buffer
+ */
+export const inspect = (initialBytes) => {
+    let offset = 0;
+    const next = () => {
+        const [i, length] = varint.decode(initialBytes.subarray(offset));
+        offset += length;
+        return i;
+    };
+    let version = next();
+    let codec = 0x70; // dag-pb
+    if (version === 18) {
+        // CIDv0
+        version = 0;
+        offset = 0;
+    }
+    else {
+        codec = next();
+    }
+    if (version !== 1) {
+        throw new RangeError(`only cidv1 is supported`);
+    }
+    const prefixSize = offset;
+    const multihashCode = next();
+    const digestSize = next();
+    const size = offset + digestSize;
+    const multihashSize = size - prefixSize;
+    return { version, codec, multihashCode, digestSize, multihashSize, size };
+};
+/**
+ * Decode the first CID contained, and return the remainder.
+ * @param bytes Buffer to decode
+ * @returns A tuple containing the first CID in the buffer, and the remainder
+ */
+export const decodeFirst = (bytes) => {
+    const specs = inspect(bytes);
+    const prefixSize = specs.size - specs.multihashSize;
+    const multihashBytes = bytes.subarray(prefixSize, prefixSize + specs.multihashSize);
+    if (multihashBytes.byteLength !== specs.multihashSize) {
+        throw new RangeError('incorrect cid length');
+    }
+    const digestBytes = multihashBytes.subarray(specs.multihashSize - specs.digestSize);
+    const digest = {
+        code: specs.multihashCode,
+        size: specs.multihashSize,
+        digest: digestBytes,
+        bytes: multihashBytes,
+    };
+    const cid = {
+        version: 1,
+        code: specs.codec,
+        digest: digest,
+        bytes: encodeCID(1, specs.codec, digest.bytes),
+    };
+    return [cid, bytes.subarray(specs.size)];
+};
+/**
+ * Decodes a CID buffer
+ */
+export const decode = (bytes) => {
+    const [cid, remainder] = decodeFirst(bytes);
+    if (remainder.length !== 0) {
+        throw new Error(`incorrect cid length`);
+    }
+    return cid;
+};
+/**
+ * Creates a CID
+ */
+export const create = async (code, input) => {
+    const digest = createDigest(0x12, new Uint8Array(await crypto.subtle.digest('sha-256', input)));
+    const bytes = encodeCID(1, code, digest.bytes);
+    return {
+        version: 1,
+        code: code,
+        digest: digest,
+        bytes: bytes,
+    };
+};
+/**
+ * Serialize CID into a string
+ */
+export const format = (cid) => {
+    return 'b' + base32.encode(cid.bytes);
+};
+const createDigest = (code, digest) => {
+    const size = digest.byteLength;
+    const sizeOffset = varint.encodingLength(code);
+    const digestOffset = sizeOffset + varint.encodingLength(size);
+    const bytes = new Uint8Array(digestOffset + size);
+    varint.encode(code, bytes, 0);
+    varint.encode(size, bytes, sizeOffset);
+    bytes.set(digest, digestOffset);
+    return {
+        code: code,
+        size: size,
+        digest: digest,
+        bytes: bytes,
+    };
+};
+const encodeCID = (version, code, multihash) => {
+    const codeOffset = varint.encodingLength(version);
+    const hashOffset = codeOffset + varint.encodingLength(code);
+    const bytes = new Uint8Array(hashOffset + multihash.byteLength);
+    varint.encode(version, bytes, 0);
+    varint.encode(code, bytes, codeOffset);
+    bytes.set(multihash, hashOffset);
+    return bytes;
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,MAAM,MAAM,gBAAgB,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,gBAAgB,CAAC;AAkCzC;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,GAAW,EAAO,EAAE;IACzC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,YAAwB,EAAgB,EAAE;IACjE,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,MAAM,IAAI,GAAG,GAAW,EAAE;QACzB,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,MAAM,IAAI,MAAM,CAAC;QACjB,OAAO,CAAC,CAAC;IACV,CAAC,CAAC;IAEF,IAAI,OAAO,GAAG,IAAI,EAAE,CAAC;IACrB,IAAI,KAAK,GAAG,IAAI,CAAC,CAAC,SAAS;IAC3B,IAAK,OAAkB,KAAK,EAAE,EAAE,CAAC;QAChC,QAAQ;QACR,OAAO,GAAG,CAAC,CAAC;QACZ,MAAM,GAAG,CAAC,CAAC;IACZ,CAAC;SAAM,CAAC;QACP,KAAK,GAAG,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,UAAU,CAAC,yBAAyB,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC;IAC1B,MAAM,aAAa,GAAG,IAAI,EAAE,CAAC;IAC7B,MAAM,UAAU,GAAG,IAAI,EAAE,CAAC;IAC1B,MAAM,IAAI,GAAG,MAAM,GAAG,UAAU,CAAC;IACjC,MAAM,aAAa,GAAG,IAAI,GAAG,UAAU,CAAC;IAExC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;AAC3E,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAiB,EAAqC,EAAE;IACnF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC;IACpD,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;IAEpF,IAAI,cAAc,CAAC,UAAU,KAAK,KAAK,CAAC,aAAa,EAAE,CAAC;QACvD,MAAM,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAEpF,MAAM,MAAM,GAAW;QACtB,IAAI,EAAE,KAAK,CAAC,aAAa;QACzB,IAAI,EAAE,KAAK,CAAC,aAAa;QACzB,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,cAAc;KACrB,CAAC;IAEF,MAAM,GAAG,GAAQ;QAChB,OAAO,EAAE,CAAC;QACV,IAAI,EAAE,KAAK,CAAC,KAAK;QACjB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;KAC9C,CAAC;IAEF,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAiB,EAAO,EAAE;IAChD,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EAAE,IAAY,EAAE,KAAiB,EAAgB,EAAE;IAC7E,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,UAAU,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChG,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IAE/C,OAAO;QACN,OAAO,EAAE,CAAC;QACV,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;KACZ,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,GAAQ,EAAU,EAAE;IAC1C,OAAO,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,MAAkB,EAAU,EAAE;IACjE,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC;IAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAE9D,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAClD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAC9B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACvC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAEhC,OAAO;QACN,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;KACZ,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,OAAe,EAAE,IAAY,EAAE,SAAqB,EAAc,EAAE;IACtF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAClD,MAAM,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAE5D,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IAChE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACjC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACvC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEjC,OAAO,KAAK,CAAC;AACd,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "type": "module",
+  "name": "@atcute/cid",
+  "version": "1.0.0",
+  "description": "create and parse AT Protocol-blessed CIDv1 format",
+  "license": "MIT",
+  "repository": {
+    "url": "https://codeberg.org/mary-ext/atcute"
+  },
+  "files": [
+    "dist/"
+  ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "sideEffects": false,
+  "devDependencies": {
+    "@types/bun": "^1.1.6"
+  },
+  "dependencies": {
+    "@atcute/base32": "^1.0.0",
+    "@atcute/varint": "^1.0.0"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "test": "bun test --coverage",
+    "prepublish": "rm -rf dist; pnpm run build"
+  }
+}