Skip to main content

Class: MetadataApi

Constructors

constructor

new MetadataApi(): MetadataApi

Returns

MetadataApi

Properties

appDataHexToCid

appDataHexToCid: (appDataHex: string) => Promise<string> = appDataHexToCid

Type declaration

▸ (appDataHex): Promise<string>

Parameters
NameType
appDataHexstring
Returns

Promise<string>

Deprecated

AppData is not longer stored on IPFS nor it's derived from IPFS content hashes

Defined in

api/index.ts:22


appDataHexToCidLegacy

appDataHexToCidLegacy: (appDataHex: string) => Promise<string> = appDataHexToCidLegacy

Type declaration

▸ (appDataHex): Promise<string>

Parameters
NameType
appDataHexstring
Returns

Promise<string>

Deprecated

AppData is not longer stored on IPFS nor it's derived from IPFS content hashes

Defined in

api/index.ts:32


appDataToCid

appDataToCid: (appData: AnyAppDataDocVersion) => Promise<IpfsHashInfo>(fullAppData: string) => Promise<IpfsHashInfo | void> = appDataToCid

Type declaration

▸ (appData): Promise<IpfsHashInfo>

Calculates appDataHex without publishing file to IPFS

Parameters
NameTypeDescription
appDataAnyAppDataDocVersionJSON document which will be stringified in a deterministic way to calculate the IPFS hash
Returns

Promise<IpfsHashInfo>

Deprecated

AppData is not longer stored on IPFS nor it's derived from IPFS content hashes

This method is intended to quickly generate the appDataHex independent of IPFS upload/pinning

▸ (fullAppData): Promise<IpfsHashInfo | void>

Calculates appDataHex without publishing file to IPFS

Parameters
NameTypeDescription
fullAppDatastringJSON string with the full appData document
Returns

Promise<IpfsHashInfo | void>

Deprecated

AppData is not longer stored on IPFS nor it's derived from IPFS content hashes

This method is intended to quickly generate the appDataHex independent of IPFS upload/pinning

Defined in

api/index.ts:21


appDataToCidLegacy

appDataToCidLegacy: (appData: AnyAppDataDocVersion) => Promise<IpfsHashInfo | void>(fullAppData: string) => Promise<IpfsHashInfo | void> = appDataToCidLegacy

Type declaration

▸ (appData): Promise<IpfsHashInfo | void>

Calculates appDataHex without publishing file to IPFS

This method is intended to quickly generate the appDataHex independent of IPFS upload/pinning

Parameters
NameTypeDescription
appDataAnyAppDataDocVersionJSON document which will be stringified in a deterministic way to calculate the IPFS hash
Returns

Promise<IpfsHashInfo | void>

Deprecated

Old way of deriving th hash

▸ (fullAppData): Promise<IpfsHashInfo | void>

Calculates appDataHex without publishing file to IPFS

This method is intended to quickly generate the appDataHex independent of IPFS upload/pinning

Parameters
NameTypeDescription
fullAppDatastringJSON string with the full appData document
Returns

Promise<IpfsHashInfo | void>

Deprecated

Old way of deriving th hash

Defined in

api/index.ts:31


cidToAppDataHex

cidToAppDataHex: (cid: string) => Promise<string> = cidToAppDataHex

Type declaration

▸ (cid): Promise<string>

Parameters
NameType
cidstring
Returns

Promise<string>

Deprecated

AppData is not longer stored on IPFS nor it's derived from IPFS content hashes

Defined in

api/index.ts:23


fetchDocFromAppDataHex

fetchDocFromAppDataHex: (appDataHex: string, ipfsUri?: string) => Promise<void | AnyAppDataDocVersion> = fetchDocFromAppDataHex

Type declaration

▸ (appDataHex, ipfsUri?): Promise<void | AnyAppDataDocVersion>

Parameters
NameTypeDescription
appDataHexstringDerives the CID from the appData hex, and fetches and parses the document from IPFS
ipfsUri?stringURL of the IPFS gateway to use for the fetch
Returns

Promise<void | AnyAppDataDocVersion>

a parsed AppData document

Deprecated

AppData is not longer stored on IPFS nor it's derived from IPFS content hashes

Defined in

api/index.ts:27


fetchDocFromAppDataHexLegacy

fetchDocFromAppDataHexLegacy: (appDataHex: string, ipfsUri?: string) => Promise<void | AnyAppDataDocVersion> = fetchDocFromAppDataHexLegacy

Type declaration

▸ (appDataHex, ipfsUri?): Promise<void | AnyAppDataDocVersion>

Fetches the document from IPFS using the appData hex

Parameters
NameType
appDataHexstring
ipfsUri?string
Returns

Promise<void | AnyAppDataDocVersion>

Deprecated

AppData is not longer stored on IPFS nor it's derived from IPFS content hashes

Defined in

api/index.ts:33


fetchDocFromCid

fetchDocFromCid: (cid: string, ipfsUri: string) => Promise<AnyAppDataDocVersion> = fetchDocFromCid

Type declaration

▸ (cid, ipfsUri?): Promise<AnyAppDataDocVersion>

Parameters
NameTypeDefault value
cidstringundefined
ipfsUristringDEFAULT_IPFS_READ_URI
Returns

Promise<AnyAppDataDocVersion>

Deprecated

AppData is not longer stored on IPFS nor it's derived from IPFS content hashes

Defined in

api/index.ts:26


generateAppDataDoc

generateAppDataDoc: (params?: Partial<Omit<AppDataRootSchema, "version">>) => Promise<LatestAppDataDocVersion> = generateAppDataDoc

Type declaration

▸ (params?): Promise<LatestAppDataDocVersion>

Creates an appData document using the latest specification of the format

Without params creates a default minimum appData doc Optionally creates metadata docs

Example of result: { "appCode": "CoW Swap", "environment": "local", "metadata": { "quote": { "slippageBips": 50 }, "orderClass": { "orderClass": "market" } }, "version": "1.2.0" }

Parameters
NameType
params?Partial<Omit<AppDataRootSchema, "version">>
Returns

Promise<LatestAppDataDocVersion>

Defined in

api/index.ts:15


getAppDataSchema

getAppDataSchema: (version: string) => Promise<AnyAppDataDocVersion> = getAppDataSchema

Type declaration

▸ (version): Promise<AnyAppDataDocVersion>

Wrapper around @cowprotocol/app-data getAppDataSchema

Returns the appData schema for given version, if any Throws CowError when version doesn't exist

Parameters
NameType
versionstring
Returns

Promise<AnyAppDataDocVersion>

Defined in

api/index.ts:14


uploadMetadataDocToIpfsLegacy

uploadMetadataDocToIpfsLegacy: (appDataDoc: AnyAppDataDocVersion, ipfsConfig: Ipfs) => Promise<IpfsUploadResult | void> = uploadMetadataDocToIpfsLegacy

Type declaration

▸ (appDataDoc, ipfsConfig): Promise<IpfsUploadResult | void>

Uploads a appDocument to IPFS

Parameters
NameTypeDescription
appDataDocAnyAppDataDocVersionDocument to upload
ipfsConfigIpfskeys to access the IPFS API
Returns

Promise<IpfsUploadResult | void>

the IPFS CID v0 of the content

Deprecated

Pinata IPFS automatically pins the uploaded document using some implicity encoding and hashing algorithm. This method is not used anymore to make it more explicit these parameters and therefore less depednent on the default impleemntation of Pinata

Defined in

api/index.ts:30


validateAppDataDoc

validateAppDataDoc: (appDataDoc: AnyAppDataDocVersion) => Promise<ValidationResult> = validateAppDataDoc

Type declaration

▸ (appDataDoc): Promise<ValidationResult>

Parameters
NameType
appDataDocAnyAppDataDocVersion
Returns

Promise<ValidationResult>

Defined in

api/index.ts:16