Files
start-os/sdk/base/lib/s9pk/merkleArchive/directoryContents.ts
Aiden McClelland f2142f0bb3 add documentation for ai agents (#3115)
* add documentation for ai agents

* docs: consolidate CLAUDE.md and CONTRIBUTING.md, add style guidelines

- Refactor CLAUDE.md to reference CONTRIBUTING.md for build/test/format info
- Expand CONTRIBUTING.md with comprehensive build targets, env vars, and testing
- Add code style guidelines section with conventional commits
- Standardize SDK prettier config to use single quotes (matching web)
- Add project-level Claude Code settings to disable co-author attribution

* style(sdk): apply prettier with single quotes

Run prettier across sdk/base and sdk/package to apply the
standardized quote style (single quotes matching web).

* docs: add USER.md for per-developer TODO filtering

- Add agents/USER.md to .gitignore (contains user identifier)
- Document session startup flow in CLAUDE.md:
  - Create USER.md if missing, prompting for identifier
  - Filter TODOs by @username tags
  - Offer relevant TODOs on session start

* docs: add i18n documentation task to agent TODOs

* docs: document i18n ID patterns in core/

Add agents/i18n-patterns.md covering rust-i18n setup, translation file
format, t!() macro usage, key naming conventions, and locale selection.
Remove completed TODO item and add reference in CLAUDE.md.

* chore: clarify that all builds work on any OS with Docker
2026-02-06 00:10:16 +01:00

81 lines
2.3 KiB
TypeScript

import { ArrayBufferReader, Entry } from '.'
import { blake3 } from '@noble/hashes/blake3'
import { serializeVarint } from './varint'
import { FileContents } from './fileContents'
import { compare } from '..'
export class DirectoryContents {
static readonly headerSize =
8 + // position: u64 BE
8 // size: u64 BE
private constructor(readonly contents: { [name: string]: Entry }) {}
static async deserialize(
source: Blob,
header: ArrayBufferReader,
sighash: Uint8Array,
maxSize: bigint,
): Promise<DirectoryContents> {
const position = header.nextU64()
const size = header.nextU64()
if (size > maxSize) {
throw new Error('size is greater than signed')
}
const tocReader = new ArrayBufferReader(
await source
.slice(Number(position), Number(position + size))
.arrayBuffer(),
)
const len = tocReader.nextVarint()
const entries: { [name: string]: Entry } = {}
for (let i = 0; i < len; i++) {
const name = tocReader.nextVarstring()
const entry = await Entry.deserialize(source, tocReader)
entries[name] = entry
}
const res = new DirectoryContents(entries)
if (!compare(res.sighash(), sighash)) {
throw new Error('hash sum does not match')
}
return res
}
sighash(): Uint8Array {
const hasher = blake3.create({})
const names = Object.keys(this.contents).sort()
hasher.update(new Uint8Array(serializeVarint(names.length)))
for (const name of names) {
const entry = this.contents[name]
const nameBuf = new TextEncoder().encode(name)
hasher.update(new Uint8Array(serializeVarint(nameBuf.length)))
hasher.update(nameBuf)
hasher.update(new Uint8Array(entry.hash))
const sizeBuf = new Uint8Array(8)
new DataView(sizeBuf.buffer).setBigUint64(0, entry.size)
hasher.update(sizeBuf)
hasher.update(new Uint8Array([0]))
}
return hasher.digest()
}
getPath(path: string[]): Entry | null {
if (path.length === 0) {
return null
}
const next = this.contents[path[0]]
const rest = path.slice(1)
if (next === undefined) {
return null
}
if (rest.length === 0) {
return next
}
if (next.contents instanceof DirectoryContents) {
return next.contents.getPath(rest)
}
return null
}
}