Skip to main content
Version: Next

Interface: HypercertStorageInterface

The interface for the Hypercert storage layer.

Implemented by​

Properties​

getData​

• getData: (cidOrIpfsUri: string) => Promise<unknown>

Type declaration​

▸ (cidOrIpfsUri): Promise<unknown>

Retrieves arbitrary data from IPFS.

Parameters​
NameTypeDescription
cidOrIpfsUristringThe CID or IPFS URI of the data to retrieve.
Returns​

Promise<unknown>

A Promise that resolves to the retrieved data.

Defined in​

sdk/src/types/client.ts:98


getMetadata​

• getMetadata: (cidOrIpfsUri: string) => Promise<HypercertMetadata>

Type declaration​

▸ (cidOrIpfsUri): Promise<HypercertMetadata>

Retrieves the metadata for a Hypercert evaluation.

Parameters​
NameTypeDescription
cidOrIpfsUristringThe CID or IPFS URI of the metadata to retrieve.
Returns​

Promise<HypercertMetadata>

A Promise that resolves to the retrieved metadata.

Defined in​

sdk/src/types/client.ts:84


storeData​

• storeData: (data: unknown) => Promise<CIDString>

Type declaration​

▸ (data): Promise<CIDString>

Stores arbitrary data on IPFS.

Parameters​
NameTypeDescription
dataunknownThe data to store.
Returns​

Promise<CIDString>

A Promise that resolves to the CID of the stored data.

Defined in​

sdk/src/types/client.ts:91


storeMetadata​

• storeMetadata: (metadata: HypercertMetadata) => Promise<CIDString>

Type declaration​

▸ (metadata): Promise<CIDString>

Stores the metadata for a Hypercert evaluation.

Parameters​
NameTypeDescription
metadataHypercertMetadataThe metadata to store.
Returns​

Promise<CIDString>

A Promise that resolves to the CID of the stored metadata.

Defined in​

sdk/src/types/client.ts:77