Skip to content
InterfaceDescription
MetadataDataSetInternal-
MetadataPieceInternal-
Type AliasDescription
ClaimTokenResponse-
ClaimTokenResponseError-
ClaimTokensOptions-
MetadataArrayThe metadata array is a tuple of two arrays: the keys and the values. Return type from the getAllDataSetMetadata function.
MetadataEntry-
MetadataObject-
VariableDescription
CAP_IPNI_IPFS-
CAP_IPNI_PEER_ID-
CAP_IPNI_PIECE-
CAP_LOCATION-
CAP_MAX_PIECE_SIZE-
CAP_MIN_PIECE_SIZE-
CAP_MIN_PROVING_PERIOD-
CAP_PAYMENT_TOKEN-
CAP_SERVICE_URL-
CAP_STORAGE_PRICE-
LOCKUP_PERIOD-
METADATA_LIMITS-
RETRY_CONSTANTS-
SIZE_CONSTANTSData size constants
TIME_CONSTANTSTime and size constants
FunctionDescription
asReadableStreamConvert AsyncIterable or ReadableStream to ReadableStream
asyncIterableToReadableStreamConvert AsyncIterable to ReadableStream with broad browser compatibility. Provides fallback for environments where ReadableStream.from() is not available.
capabilitiesListToObjectConvert capability arrays to object map
claimTokens-
clientFromTransportCreate a Viem public client from a transport configuration
createPieceUrl-
createPieceUrlPDP-
datasetMetadataObjectToEntryConvert a dataset metadata object to an array of metadata entries to be signed.
decodeAddressCapabilityMatches the behavior of address(uint160(BigEndian.decode(values[i])))
decodePDPCapabilitiesDecode PDP capabilities from keys/values arrays into a PDPOffering object. Based on Curio’s capabilitiesToOffering function.
decodePDPError-
encodePDPCapabilities-
fallbackRandIndex-
fallbackRandU256-
formatBalance-
formatFraction-
isAsyncIterableType guard to check if a value is an AsyncIterable
isReadableStreamType guard to check if a value is a ReadableStream
metadataArrayToObject-
pieceMetadataObjectToEntryConvert a dataset metadata object to an array of metadata entries to be signed.
randIndexProvides a random index into an array of supplied length (0 <= index < length)
randU256-
transportFromTransportConfigCreate a Viem public client from a transport configuration
uint8ArrayToAsyncIterableConvert Uint8Array to async iterable with optimal chunk size.