Skip to main content

SDK operation map

The same byte-level contract is available through native TypeScript and Go operations.

generation

OperationFunctionInputOutputPurpose
Create seedcreateSeedsource: ByteSource, sink: AsyncByteSink, signal: AbortSignalPromise<SeedInfo>Hash source blocks into raw digest bytes.

inspection

OperationFunctionInputOutputPurpose
Inspect or hash seedinspectSeedseed: ByteSource, signal: AbortSignalPromise<SeedInfo>Compute seed hash and inspect structural length.

verification

OperationFunctionInputOutputPurpose
Verify seedverifySeedseed: ByteSource, expected: Digest, signal: AbortSignalPromise<SeedInfo>Authenticate complete seed bytes with expected hash.
Verify with source sizeverifySeedForSourceSizeseed: ByteSource, expectedSeedHash: Digest, sourceSize: bigint, signal: AbortSignalPromise<SeedInfo>Bind digest count to trusted source size.
Verify complete sourceverifySourcesource: ByteSource, seed: ByteSource, signal: AbortSignalPromise<VerifyInfo>Compare source blocks against the authenticated seed.

blocks

OperationFunctionInputOutputPurpose
Read block hashreadBlockHashseed: RandomAccessSeed, seedSize: bigint, blockIndex: bigint, signal: AbortSignalPromise<Digest>Read one digest at a checked index.
Find digest membershipfindBlockHashseed: ByteSource, expectedSeedHash: Digest, sourceSize: bigint, blockHash: Digest, signal: AbortSignalPromise<BlockMatches>Scan a trusted seed for matching digests.

files

OperationFunctionInputOutputPurpose
File create and verifycreateSeedFilesourcePath: string, seedPath: string, options: CreateSeedFileOptions, signal: AbortSignalPromise<SeedInfo>Use path adapters around the streaming core.

Compare SDKs

Keep the same capability model while showing each language’s real contract.

OperationTypeScriptGo
Create seedcreateSeed
Promise<SeedInfo>
CreateSeed
(SeedInfo, error)
Inspect or hash seedinspectSeed
Promise<SeedInfo>
InspectSeed
(SeedInfo, error)
Verify seedverifySeed
Promise<SeedInfo>
VerifySeed
(SeedInfo, error)
Verify with source sizeverifySeedForSourceSize
Promise<SeedInfo>
VerifySeedForSourceSize
(SeedInfo, error)
Verify complete sourceverifySource
Promise<VerifyInfo>
VerifySource
(VerifyInfo, error)
Read block hashreadBlockHash
Promise<Digest>
ReadBlockHash
(Digest, error)
Find digest membershipfindBlockHash
Promise<BlockMatches>
FindBlockHash
(BlockMatches, error)
File create and verifycreateSeedFile
Promise<SeedInfo>
CreateSeedFile
(info SeedInfo, err error)