feat: add encodeRegistryCid, encodeRegistryValue, decodeRegistryValue, decodeRegistryCid

This commit is contained in:
Derrick Hammer 2023-09-03 20:21:35 -04:00
parent 7dc8067e95
commit 7ce52cbff7
Signed by: pcfreak30
GPG Key ID: C997C339BE476FF2
1 changed files with 86 additions and 5 deletions

View File

@ -1,10 +1,12 @@
import { ErrTuple } from "#types.js"; import { ErrTuple } from "#types.js";
import type { CID } from "@lumeweb/libportal";
import { import {
decodeCid as decodeCidPortal, decodeCid as decodeCidPortal,
encodeCid as encodeCidPortal, encodeCid as encodeCidPortal,
} from "@lumeweb/libportal"; } from "@lumeweb/libportal";
import { addContextToErr } from "#err.js"; import { addContextToErr } from "#err.js";
import type { CID } from "@lumeweb/libportal"; import { CID_HASH_TYPES, CID_TYPES, REGISTRY_TYPES } from "@lumeweb/libs5";
import { concatBytes } from "@noble/hashes/utils";
export function encodeCid( export function encodeCid(
hash: Uint8Array, hash: Uint8Array,
@ -12,21 +14,21 @@ export function encodeCid(
type?: number, type?: number,
hashType?: number, hashType?: number,
raw?: boolean, raw?: boolean,
): ErrTuple<string>; ): ErrTuple<string | Uint8Array>;
export function encodeCid( export function encodeCid(
hash: string, hash: string,
size: bigint, size: bigint,
type?: number, type?: number,
hashType?: number, hashType?: number,
raw?: boolean, raw?: boolean,
): ErrTuple<string>; ): ErrTuple<string | Uint8Array>;
export function encodeCid( export function encodeCid(
hash: any, hash: any,
size: bigint, size: bigint,
type?: number, type?: number,
hashType?: number, hashType?: number,
raw: boolean = false, raw: boolean = false,
): ErrTuple<string> { ): ErrTuple<string | Uint8Array> {
try { try {
return [encodeCidPortal(hash, size, type, hashType, raw), null]; return [encodeCidPortal(hash, size, type, hashType, raw), null];
} catch (e) { } catch (e) {
@ -34,7 +36,7 @@ export function encodeCid(
} }
} }
export function decodeCid(cid: string): ErrTuple<CID> { export function decodeCid(cid: string | Uint8Array): ErrTuple<CID> {
try { try {
return [decodeCidPortal(cid), null]; return [decodeCidPortal(cid), null];
} catch (e) { } catch (e) {
@ -51,4 +53,83 @@ export function verifyCid(cid: string): boolean {
} }
} }
export function encodeRegistryCid(
hash: Uint8Array,
size?: bigint,
type?: number,
hashType?: number,
raw?: boolean,
): ErrTuple<string | Uint8Array>;
export function encodeRegistryCid(
hash: string,
size?: bigint,
type?: number,
hashType?: number,
raw?: boolean,
): ErrTuple<string | Uint8Array>;
export function encodeRegistryCid(
hash: any,
size = BigInt(0),
type = CID_TYPES.RESOLVER,
hashType = CID_HASH_TYPES.ED25519,
raw: boolean = false,
): ErrTuple<string | Uint8Array> {
return encodeCid(hash, size, type, hashType, raw);
}
export function encodeRegistryValue(
cid: CID | string,
type: number = REGISTRY_TYPES.CID,
hashType = CID_HASH_TYPES.BLAKE3,
): ErrTuple<Uint8Array> {
if (typeof cid === "string") {
let err;
[cid, err] = decodeCid(cid);
if (err) {
return [new Uint8Array(), err];
}
}
const [ret, err] = encodeCid(
cid.hash,
cid.size,
CID_TYPES.RESOLVER,
CID_HASH_TYPES.BLAKE3,
true,
);
if (err) {
return [new Uint8Array(), err];
}
return [
concatBytes(Uint8Array.from([REGISTRY_TYPES.CID]), ret as Uint8Array),
null,
];
}
export function decodeRegistryValue(hash: Uint8Array): ErrTuple<CID> {
if (!Object.values(REGISTRY_TYPES).includes(hash[0])) {
return [null, "invalid registry type"];
}
hash = hash.slice(1);
return decodeCid(hash);
}
export function decodeRegistryCid(cid: string | Uint8Array): ErrTuple<CID> {
const [ret, err] = decodeCid(cid);
if (err) {
return [null, err];
}
if (ret.type !== CID_TYPES.RESOLVER) {
return [null, "not a valid registry cid"];
}
return [cid, null];
}
export type { CID } from "@lumeweb/libportal"; export type { CID } from "@lumeweb/libportal";